change version to 2.1.17

previously NERDRemoveExtraSpaces was set to 0 by default even though the
documentation stated the default as 1

doc/NERD_commenter.txt

@@ -40,9 +40,9 @@ CONTENTS                                               *NERDCommenterContents*
         4.1 Delimiter detection heuristics....|NERDComHeuristics|
         4.2 Nesting issues....................|NERDComNesting|
     5.The author..............................|NERDComAuthor|
-    6.TODO list...............................|NERDComTodo|
+    6.Changelog...............................|NERDComChangelog|
-    7.Changelog...............................|NERDComChangelog|
+    7.Credits.................................|NERDComCredits|
-    8.Credits.................................|NERDComCredits|
+    8.License.................................|NERDComLicense|
 
 ==============================================================================
 1. Intro                                                       *NERDCommenter*
@@ -89,7 +89,7 @@ line that is commented is uncommented and vice versa.
 
 
 [count],cs |NERDComSexyComment|
-Comments out the selected lines ``sexually''
+Comments out the selected lines ``sexily''
 
 
 [count],cy |NERDComYankComment|
@@ -111,8 +111,9 @@ Adds comment delimiters to the start of line and goes into insert mode between
 them.
 
 
-<C-c> |NERDComInsertComment| 
+ |NERDComInsertComment|
 Adds comment delimiters at the current cursor position and inserts between.
+Disabled by default.
 
 
 ,ca |NERDComAltDelim|
@@ -288,13 +289,19 @@ insert mode between the new delimiters.
 ------------------------------------------------------------------------------
 2.2.11 Insert comment map                               *NERDComInsertComment*
 
-Default mapping: <C-c>
+Default mapping: disabled by default.
 Change the mapping with: NERDComInInsertMap.
 Applicable modes: insert.
 
 Adds comment delimiters at the current cursor position and inserts
 between them.
 
+NOTE: prior to version 2.1.17 this was mapped to ctrl-c. To restore this
+mapping add >
+    let NERDComInsertMap='<c-c>'
+<
+to your vimrc.
+
 ------------------------------------------------------------------------------
 2.2.12 Use alternate delims map                              *NERDComAltDelim*
 
@@ -651,17 +658,17 @@ When we uncomment this line it will go back to what it was.
 ------------------------------------------------------------------------------
                                                                *NERDMapleader*
 Values: arbitrary string.
-Default: \c
+Default: ,c
 
 NERDMapleader is used to specify what all the NERD commenter key mappings
 begin with.
 
 The default key mappings will look like this: >
-    \cc
+    ,cc
-    \cu
+    ,cu
-    \ca
+    ,ca
-    \ci
+    ,ci
-    \cs
+    ,cs
     ...
 <
 However, if this line: >
@@ -839,7 +846,7 @@ will become: >
 for simplicity)
 
 ==============================================================================
-6. The author                                                  *NERDComAuthor*
+5. The author                                                  *NERDComAuthor*
 
 The author of the NERD commenter is Martyzillatron --- the half robot, half
 dinosaur bastard son of Megatron and Godzilla. He enjoys destroying
@@ -850,16 +857,44 @@ its a lonely life being the worlds premier terror machine. How would you feel
 if your face looked like a toaster and a t-rex put together? :(
 
 ==============================================================================
-7. TODO list                                                     *NERDComTodo*
+7. Changelog                                                *NERDComChangelog*
 
-Uncommenting of minimal comments needs to be more robust. Currently it is easy
+2.1.17
-to get illegal syntax when uncommenting them.
+    - fixed haskell delimiters (hackily). Thanks to Elias Pipping.
+    - add support for mailcap. Thanks to Pascal Brueckner.
+    - add support for stata. Thanks to Jerónimo Carballo.
+    - applied a patch from ewfalor to fix an error in the help file with the
+      NERDMapleader doc
+    - disable the insert mode ctrl-c mapping by default, see :help
+      NERDComInsertComment if you wish to restore it
 
+2.1.16
+    - compatibility fix for vim7.2, cheers to Ben Schmidt, David Fishburn, and
+      Erik Falor for the emails, and to JaGoTerr for posting the issue.
 
+2.1.15
+    - added pamconf support, thanks to Martin Kustermann
+    - added mason support, thanks to Indriði Einarsson
+    - added map support, thanks to Chris
+    - added bzr support, thanks to Stromnov
+    - added group support, thanks to Krzysztof A. Adamski
+    - change license to wtfpl
 
-==============================================================================
+2.1.14
-8. Changelog                                                *NERDComChangelog*
+    - added support for gitconfig, tar, nerdtree
-
+    - added support for dtrace, thanks to nicothakis for the post
+2.1.13
+    - added support for rib, pyrex/cython, liquid, services, gitcommit,
+      vimperator, and slice. Thanks to spookypeanut, Greg Jandl, Christophe
+      Benz, A Pontus, and Stromnov for emailing me and/or posting issues.
+    - set the NERDRemoveExtraSpaces option to 1 by default as the doc states
+    - other fixes: (thanks to Zhang Shuhan for all his emails and testing)
+        * made the sexy comment mapping fall back to normal commenting if sexy
+          comments arent possible for the current filetype
+        * fixed some bugs with sexy comments
+        * made the uncommenting side of toggle comments slightly more robust
+        * fixed a bug where some extra spaces werent being removed (although
+          the currect options were set)
 2.1.12
     - added support for patran and dakota, thx to Jacobo Diaz for the email
     - added support for gentoo-env-d, gentoo-init-d, gentoo-make-conf, grub,
@@ -1043,12 +1078,12 @@ to get illegal syntax when uncommenting them.
       filetypes.
     - Added '#' comments as an alternative for the asm filetype
 
-Thanks to Markus Klinik and Anders for bug reports, and again to Anders
+    Thanks to Markus Klinik and Anders for bug reports, and again to Anders
-for his patch. Thanks to John O'Shea and fREW for the filetype
+    for his patch. Thanks to John O'Shea and fREW for the filetype
-information.
+    information.
 
 ==============================================================================
-8. Credits                                                    *NERDComCredits*
+7. Credits                                                    *NERDComCredits*
 
 Thanks and respect to the following people:
 
@@ -1168,6 +1203,17 @@ Thanks to marco for suggesting NERDDefaultNesting be set by default.
 
 Thanks to Ingo Karkat for the bug reports and the bugfix patch.
 
+Thanks to Zhang Shuhan for sending me a report about spaces not being removed
+properly in some circumstances. Also, thanks for emailing me a bunch of bug
+reports about sexy/toggle comments and for testing my fixes.
+
+Thanks to tpope for the english lesson.
+
+Thanks to Ben Schmidt, David Fishburn, and Erik Falor for emailing me about an
+incompatibility with vim7.2. Thanks also to JaGoTerr for posting the issue.
+
+Thanks to Elias Pipping for sending me a bug report about haskell commenting.
+
 Not to forget! Thanks to the following people for sending me new filetypes to
 support :D
 
@@ -1217,9 +1263,25 @@ Renald Buter                        scala
 Vladimir Lomov                      asymptote
 Marco                               mrxvtrc, aap
 nicothakis                          SVNAnnotate, CVSAnnotate, SVKAnnotate,
-                                    SVNdiff, gitAnnotate, gitdiff
+                                    SVNdiff, gitAnnotate, gitdiff, dtrace
 Chen Xing                           Wikipedia
 Jacobo Diaz                         dakota, patran
 Li Jin                              gentoo-env-d, gentoo-init-d,
                                     gentoo-make-conf, grub, modconf, sudoers
+SpookeyPeanut                       rib
+Greg Jandl                          pyrex/cython
+Christophe Benz                     services, gitcommit
+A Pontus                            vimperator
+Stromnov                            slice, bzr
+Martin Kustermann                   pamconf
+Indriði Einarsson                   mason
+Chris                               map
+Krzysztof A. Adamski                group
+Pascal Brueckner                    mailcap
+Jerónimo Carballo                   stata
 
+==============================================================================
+8. License                                                    *NERDComLicense*
+
+The NERD commenter is released under the wtfpl.
+See http://sam.zoy.org/wtfpl/COPYING.

plugin/NERD_commenter.vim

@@ -1,11 +1,16 @@
-" vim global plugin that provides easy code commenting for various file types
+" ============================================================================
-" Last Change:  31 March 2008
+" File:        NERD_commenter.vim
-" Maintainer:   Martin Grenfell <martin_grenfell at msn.com>
+" Description: vim global plugin that provides easy code commenting
-let s:NERD_commenter_version = 2.1.12
+" Maintainer:  Martin Grenfell <martin_grenfell at msn dot com>
-
+" Version:     2.1.17
-" For help documentation type :help NERDCommenter. If this fails, Restart vim
+" Last Change: 27 June, 2008
-" and try again. If it sill doesnt work... the help page is at the bottom 
+" License:     This program is free software. It comes without any warranty,
-" of this file.
+"              to the extent permitted by applicable law. You can redistribute
+"              it and/or modify it under the terms of the Do What The Fuck You
+"              Want To Public License, Version 2, as published by Sam Hocevar.
+"              See http://sam.zoy.org/wtfpl/COPYING for more details.
+"
+" ============================================================================
 
 " Section: script init stuff {{{1
 if exists("loaded_nerd_comments")
@@ -59,7 +64,7 @@ call s:InitVariable("g:NERDMenuMode", 3)
 call s:InitVariable("g:NERDLPlace", "[>")
 call s:InitVariable("g:NERDUsePlaceHolders", 1)
 call s:InitVariable("g:NERDRemoveAltComs", 1)
-call s:InitVariable("g:NERDRemoveExtraSpaces", 0)
+call s:InitVariable("g:NERDRemoveExtraSpaces", 1)
 call s:InitVariable("g:NERDRPlace", "<]")
 call s:InitVariable("g:NERDShutUp", '0')
 call s:InitVariable("g:NERDSpaceDelims", 0)
@@ -72,7 +77,7 @@ call s:InitVariable("g:NERDAppendComMap", g:NERDMapleader . 'A')
 call s:InitVariable("g:NERDComAlignBothMap", g:NERDMapleader . 'b')
 call s:InitVariable("g:NERDComAlignLeftMap", g:NERDMapleader . 'l')
 call s:InitVariable("g:NERDComAlignRightMap", g:NERDMapleader . 'r')
-call s:InitVariable("g:NERDComInInsertMap", '<C-c>')
+call s:InitVariable("g:NERDComInInsertMap", '')
 call s:InitVariable("g:NERDComLineInvertMap", g:NERDMapleader . 'i')
 call s:InitVariable("g:NERDComLineMap", g:NERDMapleader . 'c')
 call s:InitVariable("g:NERDComLineNestMap", g:NERDMapleader . 'n')
@@ -200,6 +205,8 @@ function s:SetUpForNewFiletype(filetype, forceReset)
         call s:MapDelimiters('%', '')
     elseif a:filetype == "btm"
         call s:MapDelimiters('::', '')
+    elseif a:filetype == "bzr"
+        call s:MapDelimiters('', '')
     elseif a:filetype == "caos"
         call s:MapDelimiters('*', '')
     elseif a:filetype == "catalog"
@@ -290,6 +297,8 @@ function s:SetUpForNewFiletype(filetype, forceReset)
         call s:MapDelimiters('<!--','-->')
     elseif a:filetype == "dtml"
         call s:MapDelimiters('<dtml-comment>','</dtml-comment>')
+    elseif a:filetype == "dtrace"
+        call s:MapDelimiters('/*','*/')
     elseif a:filetype == "dylan"
         call s:MapDelimitersWithAlternative('//','', '/*','*/')
     elseif a:filetype == 'ebuild'
@@ -358,18 +367,24 @@ function s:SetUpForNewFiletype(filetype, forceReset)
         call s:MapDelimiters('#', '')
     elseif a:filetype == 'gitAnnotate'
         call s:MapDelimiters('', '')
+    elseif a:filetype == 'gitcommit'
+        call s:MapDelimiters('', '')
+    elseif a:filetype == 'gitconfig'
+        call s:MapDelimiters(';', '')
     elseif a:filetype == 'gitdiff'
         call s:MapDelimiters('', '')
     elseif a:filetype == "gnuplot"
         call s:MapDelimiters('#','')
     elseif a:filetype == "groovy"
         call s:MapDelimitersWithAlternative('//','', '/*','*/')
+    elseif a:filetype == "group"
+        call s:MapDelimiters('','')
     elseif a:filetype == "grub"
         call s:MapDelimiters('#', '')
     elseif a:filetype == "gtkrc"
         call s:MapDelimiters('#', '')
     elseif a:filetype == "haskell"
-        call s:MapDelimitersWithAlternative('--','', '{-', '-}') 
+        call s:MapDelimitersWithAlternative('{-','-}', '--', '--')
     elseif a:filetype == "hb"
         call s:MapDelimiters('#', '')
     elseif a:filetype == "h"
@@ -444,6 +459,8 @@ function s:SetUpForNewFiletype(filetype, forceReset)
         call s:MapDelimiters('#', '')
     elseif a:filetype == "lilypond"
         call s:MapDelimiters('%', '')
+    elseif a:filetype == "liquid"
+        call s:MapDelimiters('{%', '%}')
     elseif a:filetype == "lisp"
         call s:MapDelimitersWithAlternative(';','', '#|', '|#')
     elseif a:filetype == "lite"
@@ -470,14 +487,20 @@ function s:SetUpForNewFiletype(filetype, forceReset)
         call s:MapDelimiters('dnl ', '')
     elseif a:filetype == "mail"
         call s:MapDelimiters('> ','')
+    elseif a:filetype == "mailcap"
+        call s:MapDelimiters('#','')
     elseif a:filetype == "make"
         call s:MapDelimiters('#','')
+    elseif a:filetype == "map"
+        call s:MapDelimiters('%', '')
     elseif a:filetype == "maple"
         call s:MapDelimiters('#', '')
     elseif a:filetype == "markdown"
         call s:MapDelimiters('<!--', '-->')
     elseif a:filetype == "masm"
         call s:MapDelimiters(';', '')
+    elseif a:filetype == "mason"
+        call s:MapDelimiters('<% #', '%>')
     elseif a:filetype == "master"
         call s:MapDelimiters('$', '')
     elseif a:filetype == "matlab"
@@ -522,6 +545,8 @@ function s:SetUpForNewFiletype(filetype, forceReset)
         call s:MapDelimiters('/*', '')
     elseif a:filetype == "ncf"
         call s:MapDelimiters(';', '')
+    elseif a:filetype == "nerdtree"
+        call s:MapDelimiters('', '')
     elseif a:filetype == "netdict"
         call s:MapDelimiters('', '')
     elseif a:filetype == "netrw"
@@ -554,6 +579,8 @@ function s:SetUpForNewFiletype(filetype, forceReset)
         call s:MapDelimiters('', '')
     elseif a:filetype == "ox"
         call s:MapDelimiters('//', '')
+    elseif a:filetype == "pamconf"
+        call s:MapDelimiters('#', '')
     elseif a:filetype == "pascal"
         call s:MapDelimitersWithAlternative('{','}', '(*', '*)')
     elseif a:filetype == "passwd"
@@ -608,6 +635,8 @@ function s:SetUpForNewFiletype(filetype, forceReset)
         call s:MapDelimiters('#', '')
     elseif a:filetype == "ptcap"
         call s:MapDelimiters('#', '')
+    elseif a:filetype == "pyrex"
+        call s:MapDelimiters('#','')
     elseif a:filetype == "python"
         call s:MapDelimiters('#','')
     elseif a:filetype == "qf"
@@ -632,6 +661,8 @@ function s:SetUpForNewFiletype(filetype, forceReset)
         call s:MapDelimiters('#', '')
     elseif a:filetype == "rexx"
         call s:MapDelimiters('/*','*/')
+    elseif a:filetype == "rib"
+        call s:MapDelimiters('#','')
     elseif a:filetype == "robots"
         call s:MapDelimiters('#', '')
     elseif a:filetype == "rpl"
@@ -668,6 +699,8 @@ function s:SetUpForNewFiletype(filetype, forceReset)
         call s:MapDelimiters('#', '')
     elseif a:filetype == "selectbuf"
         call s:MapDelimiters('', '')
+    elseif a:filetype == "services"
+        call s:MapDelimiters('#', '')
     elseif a:filetype == "sgml"
         call s:MapDelimiters('<!','>')
     elseif a:filetype == "sgmldecl"
@@ -686,6 +719,8 @@ function s:SetUpForNewFiletype(filetype, forceReset)
         call s:MapDelimiters('%', '')
     elseif a:filetype == "sl"
         call s:MapDelimiters('/*','*/')
+    elseif a:filetype == "slice"
+        call s:MapDelimitersWithAlternative('//','', '/*','*/')
     elseif a:filetype == "slrnrc"
         call s:MapDelimiters('%', '')
     elseif a:filetype == "sm"
@@ -726,6 +761,8 @@ function s:SetUpForNewFiletype(filetype, forceReset)
         call s:MapDelimiters('#', '')
     elseif a:filetype == "st"
         call s:MapDelimiters('"','')
+    elseif a:filetype == "stata"
+        call s:MapDelimiters('/*','*/')
     elseif a:filetype == "stp"
         call s:MapDelimiters('--', '')
     elseif a:filetype == "strace"
@@ -752,6 +789,8 @@ function s:SetUpForNewFiletype(filetype, forceReset)
         call s:MapDelimiters(';', '')
     elseif a:filetype == "tak"
         call s:MapDelimiters('$', '')
+    elseif a:filetype == "tar"
+        call s:MapDelimiters('', '')
     elseif a:filetype == "tasm"
         call s:MapDelimiters(';', '')
     elseif a:filetype == "tcl"
@@ -804,6 +843,8 @@ function s:SetUpForNewFiletype(filetype, forceReset)
         call s:MapDelimiters('"','')
     elseif a:filetype == "viminfo"
         call s:MapDelimiters('','')
+    elseif a:filetype == "vimperator"
+        call s:MapDelimiters('"','')
     elseif a:filetype == "virata"
         call s:MapDelimiters('%', '')
     elseif a:filetype == "vo_base"
@@ -1274,12 +1315,14 @@ function s:CommentLinesSexy(topline, bottomline)
         call setline(a:topline, theLine)
 
         "comment the bottom line
+        if a:bottomline != a:topline
             let theLine = getline(a:bottomline)
             let lineHasTabs = s:HasLeadingTabs(theLine)
             if lineHasTabs
                 let theLine = s:ConvertLeadingTabsToSpaces(theLine)
             endif
             let theLine = s:SwapOutterMultiPartDelimsForPlaceHolders(theLine)
+        endif
         let theLine = s:AddRightDelim(spaceString . right, theLine)
         if lineHasTabs
             let theLine = s:ConvertLeadingSpacesToTabs(theLine)
@@ -1436,7 +1479,7 @@ function s:InvertComment(firstLine, lastLine)
 
         " if the line is commented normally, uncomment it
         if s:IsCommentedFromStartOfLine(b:left, theLine) || s:IsCommentedFromStartOfLine(b:leftAlt, theLine)
-            call s:UncommentLines(1, currentLine, currentLine)
+            call s:UncommentLines(currentLine, currentLine)
             let currentLine = currentLine + 1
 
         " check if the line is commented sexually
@@ -1506,7 +1549,7 @@ function! NERDComment(isVisual, type) range
         try
             call s:CommentLinesSexy(firstLine, lastLine)
         catch /NERDCommenter.Delimiters/
-            call s:NerdEcho("Sexy comments cannot be done with the available delimiters", 0)
+            call s:CommentLines(forceNested, 0, 0, firstLine, lastLine)
         catch /NERDCommenter.Nesting/
             call s:NerdEcho("Sexy comment aborted. Nested sexy cannot be nested", 0)
         endtry
@@ -1515,7 +1558,7 @@ function! NERDComment(isVisual, type) range
         let theLine = getline(firstLine)
 
         if s:IsInSexyComment(firstLine) || s:IsCommentedFromStartOfLine(b:left, theLine) || s:IsCommentedFromStartOfLine(b:leftAlt, theLine)
-            call s:UncommentLines(1, firstLine, lastLine)
+            call s:UncommentLines(firstLine, lastLine)
         else
             call s:CommentLinesToggle(forceNested, firstLine, lastLine)
         endif
@@ -1544,7 +1587,7 @@ function! NERDComment(isVisual, type) range
         call s:PlaceDelimitersAndInsBetween()
 
     elseif a:type == 'uncomment'
-        call s:UncommentLines(0, firstLine, lastLine)
+        call s:UncommentLines(firstLine, lastLine)
 
     elseif a:type == 'yank'
         if a:isVisual
@@ -1703,14 +1746,13 @@ function s:RemoveDelimiters(left, right, line)
     return line
 endfunction
 
-" Function: s:UncommentLines(onlyWholeLineComs, topLine, bottomLine) {{{2
+" Function: s:UncommentLines(topLine, bottomLine) {{{2
 " This function uncomments the given lines
 "
 " Args:
-" onlyWholeLineComs: should be 1 for toggle style uncommenting
 " topLine: the top line of the visual selection to uncomment
 " bottomLine: the bottom line of the visual selection to uncomment
-function s:UncommentLines(onlyWholeLineComs, topLine, bottomLine) 
+function s:UncommentLines(topLine, bottomLine)
     "make local copies of a:firstline and a:lastline and, if need be, swap
     "them around if the top line is below the bottom
     let l:firstline = a:topLine
@@ -1743,12 +1785,7 @@ function s:UncommentLines(onlyWholeLineComs, topLine, bottomLine)
 
         "no sexy com was detected so uncomment the line as normal
         else
-            let theLine = getline(currentLine)
-            if a:onlyWholeLineComs && (s:IsCommentedFromStartOfLine(b:left, theLine) || s:IsCommentedFromStartOfLine(b:leftAlt, theLine))
             call s:UncommentLinesNormal(currentLine, currentLine)
-            elseif !a:onlyWholeLineComs
-                call s:UncommentLinesNormal(currentLine, currentLine)
-            endif
             let currentLine = currentLine + 1
         endif
     endwhile
@@ -1901,16 +1938,16 @@ function s:UncommentLineNormal(line)
 
         "remove the outter most left comment delim
         if indxLeft != -1 && (indxLeft < indxLeftAlt || indxLeftAlt == -1)
-            let line = s:ReplaceLeftMostDelim(b:left, '', line)
+            let line = s:RemoveDelimiters(b:left, '', line)
         elseif indxLeftAlt != -1
-            let line = s:ReplaceLeftMostDelim(b:leftAlt, '', line)
+            let line = s:RemoveDelimiters(b:leftAlt, '', line)
         endif
 
         "remove the outter most right comment delim
         if indxRight != -1 && (indxRight < indxRightAlt || indxRightAlt == -1)
-            let line = s:ReplaceRightMostDelim(b:right, '', line)
+            let line = s:RemoveDelimiters('', b:right, line)
         elseif indxRightAlt != -1
-            let line = s:ReplaceRightMostDelim(b:rightAlt, '', line)
+            let line = s:RemoveDelimiters('', b:rightAlt, line)
         endif
     endif
 
@@ -2315,12 +2352,12 @@ function s:FindBoundingLinesOfSexyCom(lineNum)
         let theLine = getline(currentLine)
 
         "check if the current line is the top of the sexy comment
-        if theLine =~ '^[ \t]*' . left && theLine !~ '.*' . right
+        if currentLine <= a:lineNum && theLine =~ '^[ \t]*' . left && theLine !~ '.*' . right && currentLine < s:NumLinesInBuf()
             let top = currentLine
             let currentLine = a:lineNum
 
         "check if the current line is the bottom of the sexy comment
-        elseif theLine =~ '^[ \t]*' . right && theLine !~ '.*' . left
+        elseif theLine =~ '^[ \t]*' . right && theLine !~ '.*' . left && currentLine > 1
             let bottom = currentLine
 
         "the right delimiter is on the same line as the last sexyComMarker