" tComment.vim " @Author: Thomas Link (samul AT web.de) " @License: GPL (see http://www.gnu.org/licenses/gpl.txt) " @Created: 27-Dez-2004. " @Last Change: 28-Feb-2006. " @Revision: 1.5.256 " " vimscript #1173 if &cp || exists('loaded_tcomment') finish endif let loaded_tcomment = 105 fun! 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 DefVar('g:tcommentBlankLines', 1) " Guess the file type based on syntax names always or for some fileformat only call 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 DefVar('g:tcommentGuessFileType_dsl', 'xml') call DefVar('g:tcommentGuessFileType_php', 'html') call DefVar('g:tcommentGuessFileType_html', 1) call DefVar('g:tcommentGuessFileType_tskeleton', 1) call DefVar('g:tcommentGuessFileType_vim', 1) " If you don't define these variables, TComment will use &commentstring " instead. We override the default values here in order to have a blank after " the comment marker. Block comments work only if we explicitly define the " markup. " The format for block comments is similar to normal commentstrings with the " exception that the format strings for blocks can contain a second line that " defines how "middle lines" (see :h format-comments) should be displayed. " I personally find this style rather irritating but here is an alternative " definition that does this left-handed bar thing call DefVar('g:tcommentBlockC', "/*%s */\n * ") call DefVar('g:tcommentBlockC2', "/**%s */\n * ") " call DefVar('g:tcommentBlockC', "/*%s */\n ") call DefVar('g:tcommentInlineC', "/* %s */") call DefVar('g:tcommentBlockXML', "\n ") call DefVar('g:tcommentInlineXML', "") " Currently this function just sets a variable fun! TCommentDefineType(name, commentstring) call DefVar('g:tcomment_'. a:name, a:commentstring) let s:tcommentFileTypesDirty = 1 endf fun! TCommentTypeExists(name) return exists('g:tcomment_'. a:name) endf call TCommentDefineType('ada', '-- %s' ) call TCommentDefineType('apache', '# %s' ) call TCommentDefineType('autoit', '; %s' ) call TCommentDefineType('awk', '# %s' ) call TCommentDefineType('catalog', '-- %s --' ) call TCommentDefineType('catalog_block', '--%s--\n ' ) call TCommentDefineType('cpp', '// %s' ) call TCommentDefineType('cpp_inline', g:tcommentInlineC ) call TCommentDefineType('cpp_block', g:tcommentBlockC ) call TCommentDefineType('css', '/* %s */' ) call TCommentDefineType('css_inline', g:tcommentInlineC ) call TCommentDefineType('css_block', g:tcommentBlockC ) call TCommentDefineType('c', '/* %s */' ) call TCommentDefineType('c_inline', g:tcommentInlineC ) call TCommentDefineType('c_block', g:tcommentBlockC ) call TCommentDefineType('cfg', '# %s' ) call TCommentDefineType('conf', '# %s' ) call TCommentDefineType('desktop', '# %s' ) call TCommentDefineType('docbk', '' ) call TCommentDefineType('docbk_inline', g:tcommentInlineXML) call TCommentDefineType('docbk_block', g:tcommentBlockXML ) call TCommentDefineType('dosbatch', 'rem %s' ) call TCommentDefineType('dosini', '; %s' ) call TCommentDefineType('dsl', '; %s' ) call TCommentDefineType('dylan', '// %s' ) call TCommentDefineType('eiffel', '-- %s' ) call TCommentDefineType('gtkrc', '# %s' ) call TCommentDefineType('haskell', '-- %s' ) call TCommentDefineType('haskell_block', '{-%s-}\n ' ) call TCommentDefineType('haskell_inline', '{- %s -}' ) call TCommentDefineType('html', '' ) call TCommentDefineType('html_inline', g:tcommentInlineXML) call TCommentDefineType('html_block', g:tcommentBlockXML ) call TCommentDefineType('io', '// %s' ) call TCommentDefineType('javaScript', '// %s' ) call TCommentDefineType('javaScript_inline', g:tcommentInlineC ) call TCommentDefineType('javaScript_block', g:tcommentBlockC ) call TCommentDefineType('javascript', '// %s' ) call TCommentDefineType('javascript_inline', g:tcommentInlineC ) call TCommentDefineType('javascript_block', g:tcommentBlockC ) call TCommentDefineType('java', '/* %s */' ) call TCommentDefineType('java_inline', g:tcommentInlineC ) call TCommentDefineType('java_block', g:tcommentBlockC ) call TCommentDefineType('lisp', '; %s' ) call TCommentDefineType('m4', 'dnl %s' ) call TCommentDefineType('nroff', '.\\" %s' ) call TCommentDefineType('objc', '/* %s */' ) call TCommentDefineType('objc_inline', g:tcommentInlineC ) call TCommentDefineType('objc_block', g:tcommentBlockC ) call TCommentDefineType('ocaml', '(* %s *)' ) call TCommentDefineType('ocaml_inline', '(* %s *)' ) call TCommentDefineType('ocaml_block', '(*%s*)\n ' ) call TCommentDefineType('pascal', '(* %s *)' ) call TCommentDefineType('pascal_inline', '(* %s *)' ) call TCommentDefineType('pascal_block', '(*%s*)\n ' ) call TCommentDefineType('perl', '# %s' ) call TCommentDefineType('perl_block', '=cut%s=cut' ) call TCommentDefineType('php', '// %s' ) call TCommentDefineType('php_inline', g:tcommentInlineC ) call TCommentDefineType('php_block', g:tcommentBlockC ) call TCommentDefineType('php_2_block', g:tcommentBlockC2 ) call TCommentDefineType('po', '# %s' ) call TCommentDefineType('prolog', '%% %s' ) call TCommentDefineType('readline', '# %s' ) call TCommentDefineType('ruby', '# %s' ) call TCommentDefineType('ruby_block', '=begin rdoc%s=end') call TCommentDefineType('ruby_nordoc_block', '=begin%s=end' ) call TCommentDefineType('r', '# %s' ) call TCommentDefineType('sbs', "' %s" ) call TCommentDefineType('scheme', '; %s' ) call TCommentDefineType('sed', '# %s' ) call TCommentDefineType('sgml', '' ) call TCommentDefineType('sgml_inline', g:tcommentInlineXML) call TCommentDefineType('sgml_block', g:tcommentBlockXML ) call TCommentDefineType('sh', '# %s' ) call TCommentDefineType('sql', '-- %s' ) call TCommentDefineType('spec', '# %s' ) call TCommentDefineType('sps', '* %s.' ) call TCommentDefineType('tcl', '# %s' ) call TCommentDefineType('tex', '%% %s' ) call TCommentDefineType('tpl', '' ) call TCommentDefineType('viki', '%% %s' ) call TCommentDefineType('viki_inline', '{cmt: %s}' ) call TCommentDefineType('vim', '" %s' ) call TCommentDefineType('websec', '# %s' ) call TCommentDefineType('xml', '' ) call TCommentDefineType('xml_inline', g:tcommentInlineXML) call TCommentDefineType('xml_block', g:tcommentBlockXML ) call TCommentDefineType('xslt', '' ) call TCommentDefineType('xslt_inline', g:tcommentInlineXML) call TCommentDefineType('xslt_block', g:tcommentBlockXML ) call TCommentDefineType('yaml', '# %s' ) let s:tcommentFileTypesDirty = 1 fun! DefaultValue(option) exec 'let '. a:option .' = &'. a:option exec 'set '. a:option .'&' exec 'let default = &'. a:option exec 'let &'. a:option .' = '. a:option return default endf let s:defaultComments = DefaultValue('comments') let s:defaultCommentString = DefaultValue('commentstring') let s:nullCommentString = '%s' " TComment(line1, line2, ?commentMode, ?commentAnyway, ?commentBegin, ?commentEnd) " commentMode: " G ... guess " B ... block " I ... inline " R ... right fun! TComment(beg, end, ...) " save the cursor position let co = col(".") let li = line(".") let commentMode = a:0 >= 1 ? a:1 : 'G' let commentAnyway = a:0 >= 2 ? (a:2 == '!') : 0 if commentMode ==# 'IG' let commentMode = line("'<") == line("'>") ? 'I' : 'G' endif if commentMode ==# 'R' || commentMode ==# 'I' let cstart = col("'<") if cstart == 0 let cstart = col('.') endif if commentMode ==# 'R' let commentMode = 'G' let cend = 0 else let cend = col("'>") endif else let cstart = 0 let cend = 0 endif " get the correct commentstring if a:0 >= 3 && a:3 != '' let cms = EncodeCommentPart(a:3) .'%s' if a:0 >= 4 && a:4 != '' let cms = cms . EncodeCommentPart(a:4) endif else exec GetCommentString(a:beg, a:end, commentMode) endif let cms0 = BlockGetCommentString(cms) let cms0 = escape(cms0, '\') " make whitespace optional; this conflicts with comments that require some " whitespace let cmtCheck = substitute(cms0, '\([ ]\)', '\1\\?', 'g') " turn commentstring into a search pattern let cmtCheck = SPrintF(cmtCheck, '\(\_.\{-}\)') " set commentMode and indentStr exec CommentDef(a:beg, a:end, cmtCheck, commentMode, cstart, cend) if commentAnyway let mode = 0 endif " go if commentMode ==# 'B' " We want a comment block call CommentBlock(a:beg, a:end, mode, cmtCheck, cms, indentStr) else " We want commented lines " final search pattern for uncommenting let cmtCheck = escape('\V\^\(\s\{-}\)'. cmtCheck .'\$', '"/\') " final pattern for commenting let cmtReplace = escape(cms0, '"/') silent exec a:beg .','. a:end .'s/\V'. \ StartRx(cstart) . indentStr .'\zs\(\.\*\)'. EndRx(cend) .'/'. \ '\=ProcessedLine('. mode .', submatch(0), "'. cmtCheck .'", "'. cmtReplace .'")/ge' endif " reposition cursor silent exec 'norm! '. li .'G'. co .'|' endf " :line1,line2 TComment ?commentBegin ?commentEnd command! -bang -range -nargs=* TComment call TComment(, , 'G', "", ) " :line1,line2 TCommentRight ?commentBegin ?commentEnd command! -bang -range -nargs=* TCommentRight call TComment(, , 'R', "", ) " :line1,line2 TCommentBlock ?commentBegin ?commentEnd command! -bang -range -nargs=* TCommentBlock call TComment(, , 'B', "", ) " :line1,line2 TCommentInline ?commentBegin ?commentEnd command! -bang -range -nargs=* TCommentInline call TComment(, , 'I', "", ) " :line1,line2 TCommentMaybeInline ?commentBegin ?commentEnd command! -bang -range -nargs=* TCommentMaybeInline call TComment(, , 'IG', "", ) " comment text as if it were of a specific filetype fun! TCommentAs(beg, end, commentAnyway, filetype) if a:filetype =~ '_block$' let commentMode = 'B' let ft = substitute(a:filetype, '_block$', '', '') elseif a:filetype =~ '_inline$' let commentMode = 'I' let ft = substitute(a:filetype, '_inline$', '', '') else let commentMode = 'G' let ft = a:filetype endif exec GetCommentString(a:beg, a:end, commentMode, ft) let pre = substitute(cms, '%s.*$', '', '') let pre = substitute(pre, '%%', '%', 'g') let post = substitute(cms, '^.\{-}%s', '', '') let post = substitute(post, '%%', '%', 'g') call TComment(a:beg, a:end, commentMode, a:commentAnyway, pre, post) endf " :line1,line2 TCommentAs commenttype command! -bang -complete=custom,TCommentFileTypes -range -nargs=1 TCommentAs \ call TCommentAs(, , "", ) if !hasmapto(":TComment") noremap :TComment vnoremap :TCommentMaybeInline inoremap :TComment noremap __ :TComment vnoremap __ :TCommentMaybeInline endif if !hasmapto(":TComment ") noremap :TComment inoremap :TComment noremap _ :TComment endif if !hasmapto(":TCommentInline") vnoremap i :TCommentInline vnoremap _i :TCommentInline endif if !hasmapto(":TCommentRight") inoremap r :TCommentRight noremap r :TCommentRight noremap _r :TCommentRight vnoremap r :TCommentRight vnoremap _r :TCommentRight endif if !hasmapto(":TCommentBlock") noremap b :TCommentBlock noremap _b :TCommentBlock inoremap b :TCommentBlock endif if !hasmapto(":TCommentAs") noremap a :TCommentAs noremap _a :TCommentAs inoremap a :TCommentAs noremap s :TCommentAs =&ft_ noremap _s :TCommentAs =&ft_ inoremap s :TCommentAs =&ft_ endif " ---------------------------------------------------------------- " collect all variables matching ^tcomment_ fun! TCommentCollectFileTypes() if s:tcommentFileTypesDirty let t = @t try redir @t silent let redir END let g:tcommentFileTypes = substitute("\n". @t ."\n", '\n\(tcomment_\(\w\+\)\|\w\+\).\{-}\ze\n', '\n\2', 'g') let g:tcommentFileTypes = substitute(g:tcommentFileTypes, '\(\n\)\n\+', '\1', 'g') let g:tcommentFileTypes = strpart(g:tcommentFileTypes, 1, strlen(g:tcommentFileTypes) - 2) finally let @t = t endtry let g:tcommentFileTypesRx = '\V\^\('. substitute(g:tcommentFileTypes, '\n', '\\|', 'g') .'\)\(\u\.\*\)\?\$' let s:tcommentFileTypesDirty = 0 endif endf call TCommentCollectFileTypes() " return a list of filetypes for which a tcomment_{&ft} is defined fun! TCommentFileTypes(ArgLead, CmdLine, CursorPos) call TCommentCollectFileTypes() if a:ArgLead == '' return &filetype ."\n". g:tcommentFileTypes else return g:tcommentFileTypes endif endf fun! EncodeCommentPart(string) return substitute(a:string, '%', '%%', 'g') endf " GetCommentString(beg, end, commentMode, ?filetype="") " => RecordCMS fun! GetCommentString(beg, end, commentMode, ...) let ft = a:0 >= 1 ? a:1 : '' if ft != '' exec GetCustomCommentString(ft, a:commentMode) else let cms = '' let commentMode = a:commentMode endif if cms == '' if exists('b:commentstring') let cms = b:commentstring return GetCustomCommentString(&filetype, a:commentMode, cms) elseif exists('b:commentStart') && b:commentStart != '' let cms = EncodeCommentPart(b:commentStart) .' %s' if exists('b:commentEnd') && b:commentEnd != '' let cms = cms .' '. EncodeCommentPart(b:commentEnd) endif return GetCustomCommentString(&filetype, a:commentMode, cms) elseif g:tcommentGuessFileType || (exists('g:tcommentGuessFileType_'. &filetype) \ && g:tcommentGuessFileType_{&filetype} =~ '[^0]') if g:tcommentGuessFileType_{&filetype} == 1 let altFiletype = '' else let altFiletype = g:tcommentGuessFileType_{&filetype} endif return GuessFileType(a:beg, a:end, a:commentMode, altFiletype) else return GetCustomCommentString(&filetype, a:commentMode, GuessCurrentCommentString(a:commentMode)) endif endif return RecordCMS(cms, commentMode) endf " SPrintF(formatstring, ?values ...) " => string fun! SPrintF(string, ...) let n = 1 let r = '' let s = a:string while 1 let i = match(s, '%\(.\)') if i >= 0 let x = s[i + 1] let r = r . strpart(s, 0, i) let s = strpart(s, i + 2) if x == '%' let r = r.'%' else if a:0 >= n exec 'let v = a:'. n let n = n + 1 else echoerr 'Malformed format string (too many arguments required): '. a:string endif if x ==# 's' let r = r.v elseif x ==# 'S' let r = r.'"'.v.'"' else echoerr 'Malformed format string: '. a:string endif endif else return r.s endif endwh endf fun! StartRx(pos) if a:pos == 0 return '\^' else return '\%'. a:pos .'c' endif endf fun! EndRx(pos) if a:pos == 0 return '\$' else return '\%'. a:pos .'c' endif endf fun! GetIndentString(line, start) let start = a:start > 0 ? a:start - 1 : 0 return substitute(strpart(getline(a:line), start), '\V\^\s\*\zs\.\*\$', '', '') endf fun! CommentDef(beg, end, checkRx, commentMode, cstart, cend) let mdrx = '\V'. StartRx(a:cstart) .'\s\*'. a:checkRx .'\s\*'. EndRx(0) let line = getline(a:beg) if a:cstart != 0 && a:cend != 0 let line = strpart(line, 0, a:cend - 1) endif let mode = (line =~ mdrx) let it = GetIndentString(a:beg, a:cstart) let il = indent(a:beg) let n = a:beg + 1 while n <= a:end if getline(n) =~ '\S' let jl = indent(n) if jl < il let it = GetIndentString(n, a:cstart) let il = jl endif if a:commentMode ==# 'G' if !(getline(n) =~ mdrx) let mode = 0 endif endif endif let n = n + 1 endwh if a:commentMode ==# 'B' let t = @t try silent exec 'norm! '. a:beg.'G1|v'.a:end.'G$"ty' let mode = (@t =~ mdrx) finally let @t = t endtry endif return 'let indentStr="'. it .'" | let mode='. mode endf fun! ProcessedLine(mode, match, checkRx, replace) if !(a:match =~ '\S' || g:tcommentBlankLines) return a:match endif if a:mode " uncomment let rv = substitute(a:match, a:checkRx, '\1\2', '') else " comment let rv = SPrintF(a:replace, a:match) endif let rv = escape(rv, '\ ') let rv = substitute(rv, '\n', '\\\n', 'g') return rv endf fun! CommentBlock(beg, end, mode, checkRx, replace, indentStr) let t = @t try silent exec 'norm! '. a:beg.'G1|v'.a:end.'G$"td' let ms = BlockGetMiddleString(a:replace) let mx = escape(ms, '\') if a:mode " uncomment let @t = substitute(@t, '\V\^\s\*'. a:checkRx .'\$', '\1', '') if ms != '' let @t = substitute(@t, '\V\n'. a:indentStr . mx, '\n'. a:indentStr, 'g') endif let @t = substitute(@t, '^\n', '', '') let @t = substitute(@t, '\n\s*$', '', '') else " comment let cs = BlockGetCommentString(a:replace) let cs = a:indentStr . substitute(cs, '%s', '%s'. a:indentStr, '') if ms != '' let ms = a:indentStr . ms let mx = a:indentStr . mx let @t = substitute(@t, '^'. a:indentStr, '', 'g') let @t = ms . substitute(@t, '\n'. a:indentStr, '\n'. mx, 'g') endif let @t = SPrintF(cs, "\n". @t ."\n") endif silent norm! "tP finally let @t = t endtry endf " inspired by Meikel Brandmeyer's EnhancedCommentify.vim " this requires that a syntax names are prefixed by the filetype name " GuessFileType(beg, end, commentMode, ?fallbackFiletype) " => RecordCMS fun! GuessFileType(beg, end, commentMode, ...) if a:0 >= 1 && a:1 != '' exec GetCustomCommentString(a:1, a:commentMode) if cms == '' let cms = GuessCurrentCommentString(a:commentMode) endif else let commentMode = 'G' let cms = GuessCurrentCommentString(0) endif let n = a:beg while n <= a:end let m = indent(n) + 1 let le = col('$') while m < le let syntaxName = synIDattr(synID(n, m, 1), 'name') if syntaxName =~ g:tcommentFileTypesRx let ft = substitute(syntaxName, g:tcommentFileTypesRx, '\1', '') return GetCustomCommentString(ft, a:commentMode, cms) elseif syntaxName == '' || syntaxName == 'None' || syntaxName =~ '^\u\+$' || syntaxName =~ '^\u\U*$' let m = m + 1 else break endif endwh let n = n + 1 endwh return RecordCMS(cms, commentMode) endf fun! GuessCurrentCommentString(commentMode) let valid_cms = (stridx(&commentstring, '%s') != -1) if &commentstring != s:defaultCommentString && valid_cms " The &commentstring appears to have been set and to be valid return &commentstring endif if &comments != s:defaultComments " the commentstring is the default one, so we assume that it wasn't " explicitly set; we then try to reconstruct &cms from &comments let cms = ConstructFromComments(a:commentMode) if cms != s:nullCommentString return cms endif endif if valid_cms " Before &commentstring appeared not to be set. As we don't know " better we return it anyway if it is valid return &commentstring else " &commentstring is invalid. So we return the identity string. return s:nullCommentString endif endf fun! ConstructFromComments(commentMode) exec ExtractCommentsPart('') if a:commentMode == 'G' && line != '' return line .' %s' endif exec ExtractCommentsPart('s') if s != '' exec ExtractCommentsPart('e') " if a:commentMode " exec ExtractCommentsPart("m") " if m != "" " let m = "\n". m " endif " return s.'%s'.e.m " else return s.' %s '.e " endif endif if line != '' return line .' %s' else return s:nullCommentString endif endf fun! ExtractCommentsPart(key) " let key = a:key != "" ? a:key .'[^:]*' : "" let key = a:key . '[bnflrxO0-9-]*' let val = substitute(&comments, '^\(.\{-},\)\{-}'. key .':\([^,]\+\).*$', '\2', '') if val == &comments let val = '' else let val = substitute(val, '%', '%%', 'g') endif let var = a:key == '' ? 'line' : a:key return 'let '. var .'="'. escape(val, '"') .'"' endf " GetCustomCommentString(ft, commentMode, ?default="") " => RecordCMS fun! GetCustomCommentString(ft, commentMode, ...) let commentMode = a:commentMode let customComment = exists('g:tcomment_'. a:ft) if commentMode ==# 'B' && exists('g:tcomment_'. a:ft .'_block') let cms = g:tcomment_{a:ft}_block elseif commentMode ==# 'I' && exists('g:tcomment_'. a:ft .'_inline') let cms = g:tcomment_{a:ft}_inline elseif customComment let cms = g:tcomment_{a:ft} let commentMode = 'G' elseif a:0 >= 1 let cms = a:1 let commentMode = 'G' else let cms = '' let commentMode = 'G' endif return RecordCMS(cms, commentMode) endf fun! RecordCMS(cms, commentMode) return 'let cms="'. escape(a:cms, '"') .'" | let commentMode="'. a:commentMode .'"' endf fun! BlockGetCommentString(cms) return substitute(a:cms, '\n.*$', '', '') endf fun! BlockGetMiddleString(cms) let rv = substitute(a:cms, '^.\{-}\n\([^\n]*\)', '\1', '') return rv == a:cms ? '' : rv endf finish ----------------------------------------------------------------------- History 0.1 - Initial release 0.2 - Fixed uncommenting of non-aligned comments - improved support for block comments (with middle lines and indentation) - using TCommentBlock for file types that don't have block comments creates single line comments - removed the TCommentAsBlock command (TCommentAs provides its functionality) - removed g:tcommentSetCMS - the default key bindings have slightly changed 1.3 - slightly improved recognition of embedded syntax - if no commentstring is defined in whatever way, reconstruct one from &comments - The TComment... commands now have bang variants that don't act as toggles but always comment out the selected text - fixed problem with commentstrings containing backslashes - comment as visual block (allows commenting text to the right of the main text, i.e., this command doesn't work on whole lines but on the text to the right of the cursor) - enable multimode for dsl, vim filetypes - added explicit support for some other file types I ran into 1.4 - Fixed problem when &commentstring was invalid (e.g. lua) - perl_block by Kyosuke Takayama. - s mapped to :TCommentAs =&ft 1.5 - "Inline" visual comments (uses the &filetype_inline style if available; doesn't check if the filetype actually supports this kind of comments); tComment can't currently deduce inline comment styles from &comments or &commentstring (I personally hardly ever use them); default map: i or I - In visual mode: if the selection spans several lines, normal mode is selected; if the selection covers only a part of one line, inline mode is selected - Fixed problem with lines containing ^M or ^@ characters. - It's no longer necessary to call TCommentCollectFileTypes() after defining a new filetype via TCommentDefineType() - Disabled single mappings - Renamed TCommentVisualBlock to TCommentRight - FIX: Forgot 'x' in ExtractCommentsPart() (thanks to Fredrik Acosta)