" Vimball Archiver by Charles E. Campbell, Jr., Ph.D.
UseVimball
finish
doc/tComment.txt	[[[1
179
*tComment.txt*  tComment -- An easily extensible & universal comment plugin

Author: Thomas Link, samul AT web.de

tComment provides easy to use, file type sensible comments for Vim. It 
can handle embedded syntax.


                                                    *tComment-Installation*
Installation~
Copy the file tComment.vim to your plugin directory (~/.vim/plugins/ or 
similar). See |standard-plugin| for further details.

                                                    *tComment-uninstall*
In case you have some bash or similar, you can feed the file 
etc/tComment.lst to rm: >
    
    cd $HOME/.vim/
    rm -i `cat etc/tComment.lst`

                                                    *tComment-Usage*
Usage~
The command TComment is bound to <c-_><c-_> by default. TComment works 
like a toggle, i.e., it will comment out text that contains uncommented 
lines, and it will remove comment markup for already commented text 
(i.e. text that contains no uncommented lines).

                                                    *tComment-Key-Bindings*
Key bindings~

    <c-_><c-_>   :: :TComment
    <c-_><space> :: :TComment <QUERY COMMENT-BEGIN ?COMMENT-END>
    <c-_>b       :: :TCommentBlock
    <c-_>a       :: :TCommentAs <QUERY COMMENT TYPE>
    <c-_>s       :: :TCommentAs &filetype_<QUERY COMMENT SUBTYPE>
    <c-_>i       :: :TCommentInline
    <c-_>r       :: :TCommentRight
    <c-_>p       :: Comment the current inner paragraph

A secondary set of key maps is defined for normal mode.

    <Leader>__       :: :TComment
    <Leader>_p       :: Comment the current inner paragraph
    <Leader>_<space> :: :TComment <QUERY COMMENT-BEGIN ?COMMENT-END>
    <Leader>_i       :: :TCommentInline
    <Leader>_r       :: :TCommentRight
    <Leader>_b       :: :TCommentBlock
    <Leader>_a       :: :TCommentAs <QUERY COMMENT TYPE>
    <Leader>_s       :: :TCommentAs &filetype_<QUERY COMMENT SUBTYPE>

Keymaps are configurable via the following variables:

                                                    *g:tcommentMapLeader1*
g:tcommentMapLeader1    string (default: <c-_>)
        Prefix for the keymaps. Set to '' to disable keymaps with this 
        prefix.
                                                    *g:tcommentMapLeader2*
g:tcommentMapLeader2    string (default: <Leader>_)
        Secondary prefix. (The reason for why there are two prefixes is 
        that <c-_> appears preferable with gvim but can be difficult to 
        type on the terminal. The secondary prefix isn't used for insert 
        mode maps. Set to '' to disable keymaps with this prefix.

                                                    *tComment-commands*
Alternatively, you can type (? meaning "optional argument"):

                                                    *:TComment*
    :?<range> TComment ?commentBegin ?commentEnd
    :?<range> TComment! ?commentBegin ?commentEnd
    NOTE: If there is a visual selection that begins and ends in the same 
    line, then TCommentInline is used instead.

    NOTE: The range is optional and defaults to the current line.

                                                    *:TCommentInline*
    :?<range> TCommentInline ?commentBegin ?commentEnd
    :?<range> TCommentInline! ?commentBegin ?commentEnd
    Use the {&ft}_inline comment style.

                                                    *:TCommentBlock*
    :?<range> TCommentBlock ?commentBegin ?commentEnd
    :?<range> TCommentBlock! ?commentBegin ?commentEnd
    Comment as "block", e.g. use the {&ft}_block comment style.
    NOTE: This command is kind of crude. It doesn't indent or reformat 
    the text.

                                                    *:TCommentAs*
    :?<range> TCommentAs filetype
    :?<range> TCommentAs! filetype
    NOTE: TCommentAs requires g:tcomment_{filetype} to be defined.
    NOTE: This command supports command line completion. See 'wildmode' 
    and 'wildmenu' for how to get the most out of it.

                                                    *:TCommentRight*
    :?<range> TCommentRight
    :?<range> TCommentRight!
    NOTE: This command comments out the text to the right of the cursor. 
    If a visual selection was made (be it block-wise or not), all lines 
    are commented out at from the current cursor positon downwards.

    The bang (!) variants always comment out the selected text and don't 
    work as toggles.

                                                    *TCommentDefineType()*
    Using this command you can also use different comment styles with 
    the TCommentDefineType(name, commentstring) function. This function 
    takes two arguments:
        name :: The name is either &filetype or {&filetype}_{style}. 
            I.e., For block comments the {&filetype}_block and for 
            inline comments the {&filetype}_inline styles are used.
        comment string :: a string mostly as described in 
            'commentstring'.
    
    If you want to define, e.g., a fancy block comment style for html 
    you could do something like: >

        call TCommentDefineType("html_fancy_block", "<!--%s  -->\n  -- ")

<   The part after the newline character is used for marking "middle" 
    lines.

    This comment style could then be accessed via (this command has 
    command line completion): >

        '<,'>TCommentAs html_fancy_block

<   If you're editing a html file, this could best be done by the <c-_>s     
    key map.


Goals~
- Maintain indentation of selected text; the comment markers are left 
  aligned but the text on the right (i.e., the comment) is indented 
  like the original text

- Handle embedded syntax like php+html or html+javaScript+css; you 
  have to set g:tcommentGuessFileType_{&filetype} to 1 or to the 
  fallback file type in order to activate this feature for other file 
  types than php or html
  
  tComment deduces the correct file type from the syntax name, similar 
  to the way EnhancedCommentify.vim does it. In opposition to 
  EnhancedCommentify.vim, it matches the syntax name against a list the 
  known file types, so that it can deal with, e.g., embedded javaScript

- Easy to customize/adapt for an yet unknown syntax by setting buffer 
  local variables (b:commentStart, b:commentEnd, or b:commentstring), 
  global variables (g:tcomment_{&ft} and g:tcomment_{&ft}_block), or the 
  buffer local &commentstring option (which can be set on a vim 
  |modeline|)

- Use 'commentstring' or 'comments' as a fallback (i.e., if a filetype 
  is properly defined, TComment will automatically support it)

- Same short-cut for commenting text and for removing comment markup

- The decision whether text should be commented or uncommented is made 
  on the basis of the whole selection (not line by line); comments in 
  code that should be commented aren't uncommented as it is the case 
  with some other plugins

As of version 1.5, the following file types are explicitly defined 
(other filetypes are most likely supported through the 'commentstring' 
or 'comments' variables):

    ada, apache, autoit, catalog, cpp, css, c, cfg, conf, desktop, 
    docbk, dosbatch, dosini, dsl, dylan, eiffel, gtkrc, haskell, html, 
    io, javaScript, java, lisp, m4, nroff, objc, ocaml, pascal, perl, 
    php, prolog, ruby, r, scheme, sgml, sh, sql, spec, sps, tcl, tex, 
    tpl, viki, vim, websec, xml, xslt, yaml


Credits~
The way we check for embedded syntax was originally adapted 
from/inspired by Meikel Brandmeyer's EnhancedCommentify.vim
(vimscript #23) but has evolved since.


vim: tw=72
plugin/tComment.vim	[[[1
726
" tComment.vim -- An easily extensible & universal comment plugin 
" @Author:      Thomas Link (samul AT web.de)
" @License:     GPL (see http://www.gnu.org/licenses/gpl.txt)
" @Created:     27-Dez-2004.
" @Last Change: 2007-04-15.
" @Revision:    1.6.285
" 
" vimscript #1173

if &cp || exists('loaded_tcomment')
    finish
endif
let loaded_tcomment = 106

fun! s:DefVar(name, val)
    if !exists(a:name)
        " exec "let ". a:name ."='". a:val ."'"
        exec 'let '. a:name .'="'. escape(a:val, '"\') .'"'
    endif
endf

" If true, comment blank lines too
call s:DefVar('g:tcommentBlankLines', 1)

call s:DefVar('g:tcommentMapLeader1', '<c-_>')
call s:DefVar('g:tcommentMapLeader2', '<Leader>_')

" Guess the file type based on syntax names always or for some fileformat only
call s:DefVar('g:tcommentGuessFileType', 0)
" In php documents, the php part is usually marked as phpRegion. We thus 
" assume that the buffers default comment style isn't php but html
call s:DefVar('g:tcommentGuessFileType_dsl', 'xml')
call s:DefVar('g:tcommentGuessFileType_php', 'html')
call s:DefVar('g:tcommentGuessFileType_html', 1)
call s:DefVar('g:tcommentGuessFileType_tskelett irs default r('g:tcommefVar('g:tcommentBlankLines', 1Ignor r('gsVar('g:t rummentM  'commt out g filegion unmmentstrietype 
  is propg thck), or the 
  ntMthen TCousuao- Arid comme 
" assut 'def n ?com the 
  falhtml+adif
end -->\nplugentation of selec. Be}. 
         electwaysfun!w the following file g:tco"ext and.
" Tlugines alfstyle}. 
         php type frfal of keyk), or the 
  Set to 'tco"eexcep: If theretlugines althe 
  Sfstyle}. s&commented td.
  type of ththereo"eg filesode' aracterdf

" " web.d:hgines a-k), or t)e); commentd
  layletyntM  nrosoor embf
   e typthe buras areiArip.

 yet t n ?commen   U      *tCeo"eg fili: If there way e typxt; -e cogina frfhtmlrue, comment blank lines too}. C'g:"/*%s */\n *y_blue, comment blank lines too}. C2'g:"/**%s */\n *y_bl" ue, comment blank lines too}. C'g:"/*%s */\n     blue, comment blank lines tntEnd
C'g:"/* %s */"ar('g:tcommentBlankLines', 1oo}. XML'efineTypehtml_fa blue, comment blank lines tntEnd
XML'efineTy %s htm"mentMC commelyle typementstrijddetstrmentEmentstrf
let omment styles with 
    the TCommentDef
d do someomment blank lines t_:val ."'"var:he TCommentDef
d do". ask lines tult r('gsDirtysh
e(a:val,
let omment sr('gE:DefVaname, val)return" vimscrink lines t_:val ."'")(a:val, something like: >

    'eddmmefing mostly asTy %s'ing mostly a), something like: >

    'ents' mmefing mostl'# %s'ing mostly aa), something like: >

    'eiablemmefing mostl'; %s'ing mostly aa), something like: >

    'ewkmmefing mostly as# %s'ing mostly aa), something like: >

    ':

    mmefing most'Ty %s ht'mostly aa), something like: >

    ':

    t_{&ftmmefin'Typehtl_fa'stly aa), something like: >

    ':ppmmefing mostly as// %s'ing mostly a), something like: >

    ':ppine commmefing mnk lines tntEnd
C a), something like: >

    ':ppi_{&ftmmefinng mnk lines too}. Cy a), something like: >

    ':ssmmefing mostly as/* %s */'mostly aa), something like: >

    ':ssine commmefing mnk lines tntEnd
C a), something like: >

    ':ssi_{&ftmmefinng mnk lines too}. Cy a), something like: >

    ':mmefing mostly a as/* %s */'mostly aa), something like: >

    ':ine commmefing m mnk lines tntEnd
C a), something like: >

    ':i_{&ftmmefinng m mnk lines too}. Cy a), something like: >

    ':fgmmefing mostly as# %s'ing mostly aa), something like: >

    ':catmmefing mostly s# %s'ing mostly aa), something like: >

    'og, cppmmefing most'# %s'ing mostly aa), something like: >

    'o, cfmmefing mostly'neTy %s htm'tly aa), something like: >

    'o, cfine commmefingnk lines tntEnd
XML), something like: >

    'o, cfi_{&ftmmefinngkLines', 1oo}. XMLa), something like: >

    'o,onf, dmmefing mos'rem %s'ing mostly ), something like: >

    'o,oilimmefing mostl'; %s'ing mostly aa), something like: >

    'ar('g:efing mostly s; %s'ing mostly aa), something like: >

    'abk, mmefing mostly'// %s'ing mostly a), something like: >

    'sbatchmmefing mostl'Ty %s'ing mostly a), something like: >

    'dosinmmefing mostly'# %s'ing mostly aa), something like: >

    ' dsl, dmmefing most'Ty %s'ng mostly aa), something like: >

    ' dsl, dt_{&ftmmefin'{ypeh}\n   'tly aa), something like: >

    ' dsl, dtne commmefi'{y %s h}'mostly aa), something like: >

    'ar('g:tefing mostly'neTy %s htm'tly aa), something like: >

    ' >

 ne commmefing nk lines tntEnd
XML), something like: >

    ' >

 _{&ftmmefinng kLines', 1oo}. XMLa), something like: >

    'iommefing mostly a '// %s'ing mostly a), something like: >

    'rc, haskelmmefing m'// %s'ing mostly a), something like: >

    'rc, haskel ne commmenk lines tntEnd
C ), something like: >

    'rc, haskel _{&ftmmenk lines too}. Cy a), something like: >

    'rc, saskelmmefing m'// %s'ing mostly a), something like: >

    'rc, saskel ne commmenk lines tntEnd
C ), something like: >

    'rc, saskel _{&ftmmenk lines too}. Cy a), something like: >

    'rc, g:tefing mostly'/* %s */'mostly aa), something like: >

    'rc,  ne commmefing nk lines tntEnd
Caa), something like: >

    'rc,  _{&ftmmefinng kLines', 1oo}. Cy a), something like: >

    ' 
  g:tefing mostly'; %s'ing mostly aa), something like: >

    'm4mmefing mostly a 'dnl %s'ing mostly ), something like: >

    'javaSmmefing mostly'.\\" %s'ing mostly), something like: >

    'ipt,g:tefing mostly'/* %s */'mostly aa), something like: >

    'ipt, ne commmefing nk lines tntEnd
Caa), something like: >

    'ipt, _{&ftmmefinng kLines', 1oo}. Cy a), something like: >

    'ava, mmefing mostly'(* %s *)'mostly aa), something like: >

    'iva,  ne commmefing'(* %s *)'mostly aa), something like: >

    'iva,  _{&ftmmefinng'(*%s*)\n   'tly aa), something like: >

    'sp, m4mmefing mostl'(* %s *)'mostly aa), something like: >

    'sp, m4 ne commmefin'(* %s *)'mostly aa), something like: >

    'sp, m4 _{&ftmmefinn'(*%s*)\n   'tly aa), something like: >

    'serlmmefing mostly s# %s'ing mostly aa), something like: >

    'serl _{&ftmmefinng '=cut%s=cut'stly aa), something like: >

    'ar('g:ing mostly a '// %s'ing mostly a), something like: >

    'ar(ine commmefing mnk lines tntEnd
C a), something like: >

    'ar(i_{&ftmmefinng mnk lines too}. Cy a), something like: >

    'ar(i2i_{&ftmmefinngkLines', 1oo}. C2 a), something like: >

    'aommefing mostly a '# %s'ing mostly aa), something like: >

    'sl, pammefing mostl'%% %s'ing mostly a), something like: >

    'remo commmefing m m'# %s'ing mostly aa), something like: >

    'al, mmefing mostly s# %s'ing mostly aa), something like: >

    'al, _3mmefing mostl'### %s'ing mostly ), something like: >

    'al, __{&ftmmefinng '= is a ro, %s=end'), something like: >

    'al, _noo, __{&ftmme'= is a%s=end'stly ), something like: >

    'ammefing mostly a as# %s'ing mostly aa), something like: >

    'sbsmmefing mostly a"' %s"ing mostly aa), something like: >

    's
    mmefing mostl'; %s'ing mostly aa), something like: >

    'sedmmefing mostly as# %s'ing mostly aa), something like: >

    'p, pg:tefing mostly'neTy %s htm'tly aa), something like: >

    'p, p ne commmefing nk lines tntEnd
XML), something like: >

    'p, p _{&ftmmefinng kLines', 1oo}. XMLa), something like: >

    'shmmefing mostly a '# %s'ing mostly aa), something like: >

    ' rummefing mostly asTy %s'ing mostly a), something like: >

    ', r,mmefing mostly s# %s'ing mostly aa), something like: >

    'spsmmefing mostly as* %s.'ing mostly a), something like: >

    'tclmmefing mostly as# %s'ing mostly aa), something like: >

    'texmmefing mostly as%% %s'ing mostly a), something like: >

    'tplmmefing mostly asneTy %s htm'tly aa), something like: >

    'c, smmefing mostly s%% %s'ing mostly a), something like: >

    'c, s_3mmefing mostl'%%%%%% %s'ing most), something like: >

    'c, s_ne commmefing '{cmt: %s}'ing most), something like: >

    'c,mmmefing mostly as" %s'ing mostly aa), something like: >

    ', tex,mmefing mostl'# %s'ing mostly aa), something like: >

    'xmlmmefing mostly asneTy %s htm'tly aa), something like: >

    'x p ne commmefing  nk lines tntEnd
XML), something like: >

    'x p _{&ftmmefinng  kLines', 1oo}. XMLa), something like: >

    'pl, g:tefing mostly'neTy %s htm'tly aa), something like: >

    'pl,  ne commmefing nk lines tntEnd
XML), something like: >

    'pl,  _{&ftmmefinng kLines', 1oo}. XMLa), something like: >

    'yamlmmefing mostly s# %s'ing mostly aa),
". ask lines tult r('gsDirtysh
e(f
let loade assV 'de(buffer, val)e ."='". a:val buffer .'i= &:val buffer val)e ."='s. a:val buffer .'&' val)e ."='". a 
" assu= &:val buffer val)e ."='". a&:val buffer .'i= :val buffer val)return" 
" ass(a:val,". ask 
" assC             = loade assV 'de(ugh the 'c),". ask 
" assC      She 
  = loade assV 'de(ugh the 'ported),". asknullC      She 
     = '%s'entMthing li(End
1,df

"2,TCommentBMode,TCommentBAnyway,    :?<range> ,TCommentBlocbl" ummentBMode:
"ingG ... gdefa
"ingB ...  '<,'>"ingI ... ne com>"ingR ... align,
let omment s( is,esca, ..., val)" stml+jt the tex ommentif
d do". aco = col('.'f
d do". ali =  com('.'f
d do". aummentBMode   = a:0 >h
e ? a:1 : 'G'
d do". aummentBAnyway = a:0 >h
2 ? (a:2 == '!') : 006

fun!ummentBMode ==# 'IG'
d dod do". aummentBMode =  com("'<") ==  com("'>") ? 'I' : 'G'
d doscape(6

fun!ummentBMode ==# 'R'" 
"ummentBMode ==# 'I'
d dod do". aus loc = col("'<")
d dod doun!us loc == 006

fd dod do". aus loc = col('.'f
d dod doscape(6

f6

fun!ummentBMode ==# 'R'06

fd dod do". aummentBMode = 'G'06

fd dod do". ausca = 006

fd doelse06

fd dod do". ausca = col("'>"f
d dod doscape(6

felse06

fd do". aus loc = 0
d dod do". ausca   = 0
d doscape(6

f"   and 'wl
  
  tgh the 'porte(6

fun!a:0 >h
3 &&!a:3 != ''
d dod do". aums = loEnne bmment sPloc(a:3me .%s'e6

f6

fun!a:0 >h
4 &&!a:4 != ''
d dod dod do". aums = ums . loEnne bmment sPloc(a:4f
d dod doscape(6

felse06

fd doe ."=s:GesC      She 
 (a: is,ea:sca, ummentBMode)
d doscape(6

f". aums0 = looo}. GesC      She 
 (ums)(6

f". aums0 =  exec 'ums0me'\', val)" maks maitener pead.

   ; you're nflict Set toand for 
  atiletype
n synt val)" maitener p(6

f". aumtCyaml
= lubstitut 'ums0me'\([	 ]\)mme'\1\\?mme'g', val)" turn"k), or the 
  infall search pat    (6

f". aumtCyaml
= l:SPe 
tF(umtCyamlme'\(\_.\{-}\)m, val)" s. aummentBMode t styght (She
d doe ."=s:hing like:(a: is,ea:sca, umtCyamlmeommentBMode,Tus loc,ausca)(6

fun!ummentBAnyway
d dod do". amode = 0
d doscape(6

f"  o(6

fun!ummentBMode ==# 'B' val)
    iWementsta'
    endifader>_b d do someom ?commentEnd(a: is,ea:sca, mode,TumtCyamlmeoms,tyght (She)(6

felse06

fd do iWementst.e. text that c06

fd do ifis insearch pat    Sfsty should brte(6

f6

f". aumtCyaml
  =  exec ''\V\^\(\s\{-}\)m.aumtCyaml
.'\$mme'"/\')06

fd do ifis inpat    Sfstyhould brte(6

f6

f". aumtReplr pe=  exec 'ums0me'"/')06

fd doslt tste ."=a: is
.',:val sca .'s/\V'etype or {&fileeeeeeeee\ l:S locRx(us locme tyght (She
.'\zs\(\.\*\)m.aloEndRx(usca)
.'/'.ype or {&fileeeeeeeee\ '\=s:Promment Lcom('.amode .', lub Enha(0), "m.aumtCyaml
.'", "m.aumtReplr pe.'")/ge'
d doscape(6

f" reommentifyhe tex val)" slt tste ."=' of ! :vali .'G'.aco .'|'
d do somehe tex(Enmeom)(a:val, ':End
1,f

"2   *:TComment*
    :?<range> TCommen via (t! -posit-sed in-nargs=*   *:TCommkeepjumpso something li(<End
1>, <End
2>, 'G'efinposi>", <f-args>)l, ':End
1,f

"2   *:TComRightment*
    :?<range> TCommen via (t! -posit-sed in-nargs=*   *:TComRightmkeepjumpso something li(<End
1>, <End
2>, 'R'efinposi>", <f-args>)l, ':End
1,f

"2   *:TComlock*
    :?<range> TCommentBloc via (t! -posit-sed in-nargs=*   *:TComlock*
keepjumpso something li(<End
1>, <End
2>, 'B'efinposi>", <f-args>)l, ':End
1,f

"2   *:TComline*
    :?<range> TCommentInlin via (t! -posit-sed in-nargs=*   *:TComline*
 keepjumpso something li(<End
1>, <End
2>, 'I'efinposi>", <f-args>)l, ':End
1,f

"2   *:TComMaybeline*
    :?<range> TCommentInlin via (t! -posit-sed in-nargs=*   *:TComMaybeline*
 keepjumpso something li(<End
1>, <End
2>, 'IG'efinposi>", <f-args>)l, '
    endme shosfun!ins  ?cooents, r,ificpe
    :?<
let omment sAs( is,esca, ommentBAnyway, e
    :?)(6

fun!a:' as a fa=~ ' _{&ft$'
d dod do". aummentBMode = 'B' val)
   ". aft
= lubstitut 'a:' as a f, ' _{&ft$', '', '')(6

felseun!a:' as a fa=~ ' ne com$'
d dod do". aummentBMode = 'I' val)
   ". aft
= lubstitut 'a:' as a f, ' ne com$', '', '')(6

felse 
d dod do". aummentBMode = 'G'06

fd do". aft
= a:' as a f
d doscape(6

fe ."=s:GesC      She 
 (a: is,ea:sca, ummentBMode, et)(6

f". ap?co
= lubstitut 'ums, '%s.*$mmefin'', '')(6

f". ap?co
= lubstitut 'p?c, '%%', '%mme'g', val)". apined= lubstitut 'ums, '^.\{-}%s', '', '')(6

f". apined= lubstitut 'pine, '%%', '%mme'g', val) something li(a: is,ea:sca, ummentBMode, r:he TComAnyway, p?c, pine)(a:val, ':End
1,f

"2   *:TComAmiddle" 
 a f
 via (t! -posit-mmand he=edded ,  *:TComult r('gst-sed in-nargs=1   *:TComAmi
fileeeeeeeee\  something liAs(<End
1>, <End
2>, inposi>", <f-args>)l,un!(     *g:tcommentMapLe!= '', val)e ."='nor map <slt ts> :va     *g:tcommentMapLe.Var('gYPE>
    <<cr>' val)e ."='vnor map <slt ts> :va     *g:tcommentMapLe.Var('gYPE>
    <Maybeline*
<cr>' val)e ."='inor map <slt ts> :va     *g:tcommentMapLe.Var('gYar(o>PE>
    <<cr>' val)e ."='nor map <slt ts> :va     *g:tcommentMapLe.Vp vipPE>
    <<cr>' val)e ."='nor map :va     *g:tcommentMapLe.Vaner para  *:TComm' val)e ."='inor map :va     *g:tcommentMapLe.Vaner parar(o>PE>
    < ' val)e ."='inor map <slt ts> :va     *g:tcommentMapLe.Vrrar(o>PE>
    <Right<cr>' val)e ."='nor map <slt ts> :va     *g:tcommentMapLe.Vr PE>
    <Right<cr>' val)e ."='vnor map <slt ts> :va     *g:tcommentMapLe.ViEND>
    <Leader<cr>' val)e ."='vnor map <slt ts> :va     *g:tcommentMapLe.Vr PE>
    <Right<cr>' val)e ."='nor map :va     *g:tcommentMapLe.Vbight
    <Leade<cr>' val)e ."='inor map :va     *g:tcommentMapLe.Vbiar(o>PE>
    <Leade<cr>' val)e ."='nor map :va     *g:tcommentMapLe.VaYPE>
    <Lea' val)e ."='inor map :va     *g:tcommentMapLe.Vaiar(o>PE>
    <Lea' val)e ."='nor map :va     *g:tcommentMapLe.Vslock
    <Leadc-r>=&ft<cr>_' val)e ."='inor map :va     *g:tcommentMapLe.Vsiar(o>PE>
    <Leadc-r>=&ft<cr>_' scape(un!(     *g:tcommentMap2e!= '', val)e ."='nor map <slt ts> :va     *g:tcommentMap2e.V_YPE>
    <<cr>' val)e ."='vnor map <slt ts> :va     *g:tcommentMap2e.V_YPE>
    <Maybeline*
<cr>' val)e ."='nor map <slt ts> :va     *g:tcommentMap2e.Vp vipPE>
    <<cr>' val)e ."='nor map :va     *g:tcommentMap2e.Vaner para  *:TComm' val)e ."='vnor map <slt ts> :va     *g:tcommentMap2e.ViEND>
    <Leader<cr>' val)e ."='nor map <slt ts> :va     *g:tcommentMap2e.Vr PE>
    <Right<cr>' val)e ."='vnor map <slt ts> :va     *g:tcommentMap2e.Vr PE>
    <Right<cr>' val)e ."='nor map :va     *g:tcommentMap2e.Vbight
    <Leade<cr>' val)e ."='nor map :va     *g:tcommentMap2e.VaYPE>
    <Lea' val)e ."='nor map :va     *g:tcommentMap2e.Vslock
    <Leadc-r>=&ft<cr>_' scape(l, '----------------------------------------------------------------, '
 lon te (beb:comments Enha 
  ^ lines t_<
let omment sC lon tult r('gs()(6

fun!sk lines tult r('gsDirty06

fd do". aed= @tvim but cary
fileeeeeeeee webr @tvim but cd doslt tst". 
fileeeeeeeee webr END
d dod dod do". agk lines tult r('gsd= lubstitut '"\n". @t ."\n"me'\n\( lines t_\(\w\+\)\|\w\+\).\{-}\ze\n'me'\n\2mme'g', val)d dod do". agk lines tult r('gsd= lubstitut 'gk lines tult r('gsme'\(\n\)\n\+mme'\1mme'g', val)d dod do". agk lines tult r('gsd= ltr" In'gk lines tult r('gsme1, ltrt t'gk lines tult r('gs) - 2, val)d doffor em val)d dod do". a@ed= t
d dod doscaary
fileeeee". agk lines tult r('gsRx = '\V\^\(m.alubstitut 'gk lines tult r('gsme'\n'me'\\|mme'g',
.'\)\(\u\.\*\)\?\$'
d dod do". ask lines tult r('gsDirtysh
0"'. escape(a:val, something liC lon tult r('gs()(
")return"hes theoen explicitlcondaral &a ng), 
  global A secondar<
let omment sult r('gs(ArgentM, Cm Lcom,MC csorPos, val) something liC lon tult r('gs()(6

fun!a:ArgentM == ''
d dod doreturn" name :: T."\n". gk lines tult r('gs(6

felse06

fd doreturn"gk lines tult r('gs(6

fecape(a:val,
let loEnne bmment sPloc(mentDef
d doreturn"lubstitut 'a:mentDe, '%mme'%%mme'g', a:val, 's:GesC      She 
 ( is,esca, ommentBMode,TCname :: ="_bl" => RecordCMS,
let loGesC      She 
 ( is,esca, ommentBMode,T..., val)". aft
= a:0 >h
e ? a:1 : ''(6

fun!ft
!= ''
d dod doe ."=s:GesCdded C      She 
 (ft, r:he TComMode)
d doslse06

fd do". aums = ''
d dod do". aummentBMode = r:he TComMode
d doscape(6

fun!ums == ''
d dod doun! vimscrimentStart, b:co', val)d dod do". aums = mentStart, b:co
fileeeeeeeee wturn"l:GesCdded C      She 
 (&' as a f, r:he TComModemeoms)06

fd doelseun! vimscrimentStartS loc',
&& mentStartS loc != ''
d dod dod do". aums = loEnne bmment sPloc(mentStartS loc,
.' %s'e6

f6

fd doun! vimscrimentStartEnd')
&& mentStartEnd != ''
d dod dod dod do". aums = ums .' '. loEnne bmment sPloc(mentStartEca)(6

fd dod doscape(6

f6

feeee wturn"l:GesCdded C      She 
 (&' as a f, r:he TComModemeoms)06

fd doelseun!kelett irs default r('g" 
"( vimscrink lines t default r('g:'. &' as a f)type or {&fileeeeeeeee\ && ipt+css; you 
  have to set g:tcomme=~ '[^0]', val)d dod doun!kelett irs default r('g set g:tcomme=h
e(d dod dod dod do". aaltult  a fa= ''
d dod dod doelse06

fd dod dod do". aaltult  a fa= kelett irs default r('g set g:tcomm(6

fd dod doscape(6

f6

feeee wturn"l:Gdefault r('g(a: is,ea:sca, r:he TComModeme&' as a f, rltult  a f)06

fd doelse06

fd dod do wturn"l:GesCdded C      She 
 (&' as a f, r:he TComModemel:GdefaC commeC      She 
 (a:he TComMode)f
d dod doscape(6

fecape(6

f wturn"l:RecordCMS'ums, he TComMode)
a:val, 's:SPe 
tF(ines amentDe, ?t 'def ..., " => , b:co

let loSPe 
tF(mentDe, ..., val)". an h
e(d do". ara= ''
d do". as = r:, b:co
filearale
e(d dod do". ai =  Enha(s, '%\(.\)m, val)d doun!i >h
006

fd dod do". ax = s[i + 1]06

fd dod do". ara= r . ltr" In's, 0, i, val)d dod do". asd= ltr" In's,ty + 2, val)d dod doun!x == '%'
d dod dod dod do". ara= r.'%'
d dod dod doelse06

fd dod dod doun!a:0 >h
nype or {&fileeeeeeeeee ."='". av = r:'. nype or {&fileeeeeeeee". an h
n + 1ype or {&fileeeeeelse06

fd dod dod doeeeeechoerr 'Malines the ns althe 
  (too  EnyThis functiletype
d): :val , b:co
fileeeeeeeeed doscape(6

f6

feeeed doun!x ==# 's'ype or {&fileeeeeeeee". ara= r.vype or {&fileeeeeelseun!x ==# 'S'ype or {&fileeeeeeeee". ara= r.'"'.v .'="'. er {&fileeeeeelse06

fd dod dod doeeeeechoerr 'Malines the ns althe 
 : :val , b:co
fileeeeeeeeed doscape(6

f6

feeeescape(6

f6

felse06

fd dod do wturn"r.s
d dod doscape(6

fecawh(a:val,
let loS locRx(pos, val)un!a:pos == 006

fd do wturn"'\^'(6

felse06

fd doreturn"'\%:val pos .'c'(6

fecape(a:val,
let loEndRx(pos, val)un!a:pos == 006

fd do wturn"'\$'(6

felse06

fd doreturn"'\%:val pos .'c'(6

fecape(a:val,
let loGesIght (She 
 (s and s locm
d do". as loc = l , loc > 0 ? a:, loc - 1 : 006

freturn"lubstitut 'ltr" In'get com(a:End
)d s locm, '\V\^\s\*\zs\.\*\$', '', '')(a:val,
let lohing like:( is,esca, oyamlRxmeommentBMode,Tus loc,ausca)(6

f". amdrx = '\V'. loS locRx(a:hs locme '\s\*:val oyamlRxe '\s\*:valoEndRx(0f
d do". alinfa= ket com(a: is, val)un!a:us loc != 0 &&!a:usca != 0
d dod do". alinfa= ltr" In's and 0,!a:usca -fVard doscape(6

f". amode = (linfa=~amdrxf
d do". aied= loGesIght (She 
 (a: is,ea:cs locm
d do". aild= yght ((a: is, val)". an  = l  is
+ 1ype oarale
n <=ea:sca val)d doun!ket com(n)e=~ '\S'
d dod dod do". ajld= yght ((n, val)d dod doun!jld<ail
d dod dod dod do". aied= loGesIght (She 
 (n,ea:cs locm
d dod dod dod do". aild= jl(6

fd dod doscape(6

f6

feeeeun!a:ummentBMode ==# 'G'(6

f6

feeeed doun!!(ket com(n)e=~ mdrxf
d dod dod dod dod do". amode = 0
d doeeeeeeeed doscape(6

f6

feeeescape(6

f6

fecape(6

f6

f". an h
n + 1ype oecawh(eeeeun!a:ummentBMode ==# 'B' val)
   ". aed= @tvim but cary
fileeeeeeeeeslt tste ."=' of ! :val  is.'G1|v'.a:sca.'G$"ty'
d dod dod do". amode = (@ed=~ mdrxf
d dod doffor em val)d dod do". a@ed= t
d dod doscaary
fileecape(6

f wturn"'". ayght (She     ied .' |o". amode='.amode(a:val,
let loPromment Lcom(mode,Tmf, desoyamlRxmereplr p106

fun! (a:mf, de=~ '\S'" 
"nk lines too
call s:)06

fd doreturn"a:mf, d
d doscape(6

fun!a:mode
d doval)"  should b val)
   ". arv
= lubstitut 'a:mf, desl oyamlRxme'\1\2', '')(6

felse
d doval)" hould b val)
   ". arv
= loSPe 
tF(a:replr p,"a:mf, dard doscape(6

f". arv
=  exec 'rvme'\
')(6

f". arv
= lubstitut 'rvme'\n'me'\\\n'me'o', val) wturn"rv(a:val,
let lohing lintEnd( is,esca, mode,TuyamlRxmereplr p,tyght (She)(6

f". aed= @tvim bary
fileeeeeslt tste ."=' of ! :val  is.'G1|v'.a:sca.'G$"td' val)
   ". ams = looo}. GesMacterShe 
 (a:replr p106

f
   ". amx
=  exec 'ms, '\m, val)d doun!a:mode
d doval)val)"  should b val)
   d do". a@ed= lubstitut '@t, '\V\^\s\*:val oyamlRxe '\$mme'\1mme'', val)d dod doun!ms != ''
d dod dod dod do". a@ed= lubstitut '@t, '\V\n:val yght (She
.amxme'\n'val yght (Sheme'g', val)d dod doscape(6

f6

feeee". a@ed= lubstitut '@t, '^\n'me'mme'', val)d dod do". a@ed= lubstitut '@t, '\n\s*$'me'mme'', val)d doelse06

fd dod do" hould b val)
   d do". aus = looo}. GesC      She 
 (a:replr p106

f
   d do". aus = l yght (She
.alubstitut 'us, '%s', '%s'val yght (Sheme'', val)d dod doun!ms != ''
d dod dod dod do". ams = l yght (She
.ams
d dod dod dod do". amx = l yght (She
.amx
d dod dod dod do". a@ed= lubstitut '@t, '^'val yght (Sheme''me'g', val)d dod dod do". a@ed= ms . lubstitut '@t, '\n'val yght (Sheme'\n'vamxme'g', val)d dod doscape(6

f6

feeee". a@ed= l:SPe 
tF(us, "\n". @t ."\n"f
d dod doscape(6

f6

fslt tst of ! "tP
d doffor em val)d do". a@ed= t
d doscaary
a:val, 'as originally adapted 
from/inspired by Meikel Brandmey" you'rletype
    atiaGuess the file rereason fdile, thiname :: T."'"
, 's:Gdefault r('g( is,esca, ommentBMode,T' as a f, ?tstring'ult  a f)0" => RecordCMS,
let loGdefault r('g( is,esca, ommentBMode,T' as a f, ..., val)un!a:0 >h
1 &&!a:1
!= ''
d dod doe ."=s:GesCdded C      She 
 (a:1, r:he TComMode)
d do6

fun!ums == ''
d dod dod do". aums = loGdefaC commeC      She 
 (a:he TComMode)
d dod doscape(6

felse06

fd do". aummentBMode = 'G'06

fd do". aums = loGdefaC commeC      She 
 (0ard doscape(6

f". an  = l  isype oarale
n <=ea:sca val)d do". am d= yght ((n, + 1ype or {&". ale = col('$', val)d doarale
md<ale06

fd dod do". auess tN"'"
=auesIDattr(uesID(n,emmentme'."'"', val)d dod doun!uess tN"'"
=~agk lines tult r('gsRx val)d dod dod do". aft
= lubstitut 'uess tN"'",agk lines tult r('gsRxme'\1mme'', val)d dod dod doun! vimscrikLines', 1Ignor r('gsV'val ' as a f)t&& ipt+css; yIgnor r('gsV{l ' as a fme=~ '\<'.ft '\>'ype or {&fileeeeeeeee". amd= m + 1ype or {&fileeeeeelse06

fd dod dod doeeee wturn"l:GesCdded C      She 
 (ft, r:he TComModemeoms)06

fd doeeeed doscape(6

f6

feeeeslseun!uess tN"'"
== ''" 
"uess tN"'"
== 'None'" 
"uess tN"'"
=~ '^\u\+$'" 
"uess tN"'"
=~ '^\u\U*$'
d dod dod dod do". amd= m + 1ype or {&fileelse06

fd dod dod dobreak(6

f6

feeeescape(6

f6

fecawh(eeee6

f". an h
n + 1ype oecawh(eeee wturn"l:RecordCMS'ums, he TComMode)
a:val,
let loGdefaC commeC      She 
 (he TComMode)
d do". avalid_ums = (mentdx(ck), or the 
 , '%s')
!= -1, val)un!ck), or the 
  !=ask 
" assC      She 
  && valid_ums
d doval)" Tlugck), or the 
  ixes is falhtml+been s. aa
The cbe valid
d dod doreturn" ntStart, b:co
filescape(6

fun! ntStart, !=ask 
" assC      s
d doval)" gentation othe 
  iscomme 
" assuoand so!w ted as phpRegins asout the s
    if  followins. ;!w t   Tharyd the typtheuct! nms duces ntStart,06

fd do". aums = loCyptheuctFrd C      s(r:he TComMode)
d do6

fun!ums !=asknullC      She 
 06

fd dod do wturn"ums
d doval)scape(6

fecape(6

fun!valid_ums
d doval)" Bnameugck), or the 
  ixes ifdisis e cbe s. . As!w tt out usto the s
    ibet   !w t wturn"i aa
yway un!insiscvalid
d dod doreturn" ntStart, b:co
fileslse
d doval)" &ation othe 
  iscinvalid. So!w t wturn"ommeiht (itylthe 
 .
d doeeee wturn"l:nullC      She 
 06

fecape(a:val,
let loCyptheuctFrd C      s(he TComMode)
d dos ."=s:Exte paC      sPloc('', val)un!a:ummentBMode == 'G' && linfa!= ''
d dod doreturn"linfa.' %s'e6

fscape(6

fe ."=s:Exte paC      sPloc('s', val)un!s
!= ''
d dod doe ."=s:Exte paC      sPloc('e')06

fd do iun!a:ummentBMode06

fd do id doe ."=s:Exte paC      sPloc("m")06

fd do id doun!m
!= ""06

fd do id dod do". amd= "\n". m06

fd do id doecape(6

f6

f"oeeee wturn"l .%s'.e.m06

fd do ielse06

fd doreturn"s.' %s :ve06

fd do iscape(6

fecape(6

fun!linfa!= ''
d dod doreturn"linfa.' %s'e6

fslse06

fd doreturn"s:nullC      She 
 06

fecape(a:val,
let loExte paC      sPloc(key, val)" ". adone  = l done!= "" ? a:done.'[^:]*' : ""06

f". adone= l done. '[bnflrxO0-9-]*'
d do". aval
= lubstitut '&ation ot, '^\(.\{-},\)\{-}'vadone.':\([^,]\+\).*$'me'\2', '')(6

fun!val ==  ntStart,06

fd do". aval
= ''(6

felse06

fd do". aval
= lubstitut 't '. a%mme'%%mme'g', d doscape(6

f". avare= l done== ''"? ' comm : l don(6

f wturn"'". a'vavare        exec 't '. a:ame .'="a:val, 's:GesCdded C      She 
 (ft, ommentBMode,TC 
" ass="_bl" => RecordCMS,
let loGesCdded C      She 
 (ft, ommentBMode,T..., val)". aummentBMode   = a:ummentBMode06

f". audded C      
=  vimscrink lines t_:val et)(6

fun!ummentBMode ==# 'B' &&  vimscrink lines t_:val ete.V__{&ftm)06

fd do". aums = ables (g:tcol etnt_{&ft(6

felseun!ummentBMode ==# 'I' &&  vimscrink lines t_:val ete.V_ne comm)06

fd do". aums = ables (g:tcol etntieader>_i  elseun!udded C      06

fd do". aums = ables (g:tcol etn06

fd do". aummentBMode = 'G'06

felseun!a:0 >h
106

fd do". aums = a:106

fd do". aummentBMode = 'G'06

felse06

fd do". aums = ''
d dod do". aummentBMode = 'G'
d doscape(6

f wturn"l:RecordCMS'ums, he TComMode)
a:val,
let loRecordCMS'ums, he TComMode)
6

f wturn"'". aums      exec 'leums, ':ame .' |o". ahe TComMode     a:ummentBMode  .'="a:val,
let looo}. GesC      She 
 (ums)(6

freturn"lubstitut 'a:ums, '\n.*$', '', '')(a:val,
let looo}. GesMacterShe 
 (ums)(6

f". arv
= lubstitut 'a:ums, '^.\{-}\n\([^\n]*\)mme'\1', '')(6

f wturn"rve== a:ums"? 'm : rv(a:val,
sts('l

-----------------------------------------------------------------------
Himsory

0.1
- Ili: al
release0
0.2
- Fn fdi should brteeoennon-comment ntStart,0- impro(vimsCommentfstyle}. 
         (et toracterdf

"  t styght (affer, - u*TCom  *:TComlock*
fsty version 1.there wout html+be}. 
         cu.orgs 
*TCoerdf

" ntStart,0- for cypes eething liAsBe}. 
    t st(ck
    <Leapro(ihtmmenypementstrcomty)0- for cypeables (g:tSesCMS,-comme 
" assudonebygh 
  Shtml+slightwinc:    d

1.3,-cslightwinimpro(vime tygli: If oenedits~
The way 0- iennotation othe 
  iscg file tiommeorgv  !way, e typtheuct!l fiduces
&ntStart,0- T eething li...          sto html+bositownwards.there wout actted text an 
t t 

    The bang (!) variants always c0- on fdiproblemSet toand for he 
  Sented t
 yetackslashe,0- cmmentBeginht of tbe}. 
(as

Asrt it)

- Same shmmand comments out tmd td
me s,  but theuld then beommand ielectwa made 
f

"  t t  difficul shmmand c
omments out the tex)0- en modemassimode fsty   doent. explicit0- as~
Thf  follomsCommentfstyd as it is  version 1.Iused infa

1.4
- Fn fdiproblemSe  Th&ation othe 
  e chinvalid (End
 lua)0- serl _{&ftile,Kyosukeetakayama.0- s couldmixesThe cock
    <Leadc-r>=&ft<cr>

1.50- "Leader"nht of t         (usncedCom&' as a fine comments  ien
avail mod;eommand i yaml
if, thiname :: Tactuned, TCommeny e typ.
    NO
k), or t); types thacand i  commelyln php  ommentEnd
    Use thsiduces
&ntStart,base&ation othe 
  (  nrosoor embhard26
"v  !   Commm);  
" assu
mix: s couibases couI
- Ilnht of tmode:
if, thi  on the bspansi  v  abe it b,l of keymode is 
*nts alw;
if, thi  on the bco- Astwaysfa
" In  NOl fis and ommentEmode 
typtnts alw
- Fn fdiproblemSet tof

"  ented t
 ye^Mbase^@  The parts.0- It'  st lo   r nemmenaryd th something liC lon tult r('gs()d -->\npg filiy_blonewiname :: Ttyle                    0- Dis modimscroerdar('gYmixe 
  0- Re."'"de        Vt of Be}. 
 thCommentRight*
- FIX:_{stgo a'x'tiomExte paC      sPloc()e coanks falFredrik Acosta)0
1.60- Ignor , ruSe  ThgdefaTCommeeine styles are uiommentnames; types tha
 for ifilechoosncedComwrommenting tes are ubeca   Comme   Cals~ruSuess th
after thtoo loosnwiniommentnames; i 'commentstrinnting teedits~
TheruS
ne bycommhtml+jav   Cck
    <Leset on keepjumpsoin         .s    pdar('gp & <L>_p+javvipPE>
    <<cr>s    de done by're nfigu