m-vim_plugins/nerdcommenter
1
0
Fork 0
mirror of https://github.com/preservim/nerdcommenter.git synced 2025-11-08 18:03:46 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #376 from Houl/autoload

Browse Source 
Refactor using VIM's autoload plugin system
This commit is contained in:
Caleb Maclennan
2021-07-27 17:04:53 +03:00
committed by GitHub
parent a5d1663185 ea11ba5a79
commit dbc631adf9
2 changed files with 204 additions and 212 deletions
Download Patch File Download Diff File Expand all files Collapse all files

313
plugin/NERD_commenter.vim → autoload/nerdcommenter.vim
View File

@@ -1,31 +1,3 @@
" Section: script init stuff
if exists('loaded_nerd_comments')
finish
endif
if v:version < 700
echoerr "NERDCommenter: this plugin requires vim >= 7. DOWNLOAD IT! You'll thank me later!"
finish
endif
let loaded_nerd_comments = 1
" Function: s:InitVariable() function
" This function is used to initialise a given variable to a given value. The
" variable is only initialised if it does not exist prior
"
" Args:
" -var: the name of the var to be initialised
" -value: the value to initialise var to
"
" Returns:
" 1 if the var is set, 0 otherwise
function s:InitVariable(var, value)
if !exists(a:var)
execute 'let ' . a:var . ' = ' . "'" . a:value . "'"
return 1
endif
return 0
endfunction
" Section: space string init " Section: space string init
" When putting spaces after the left delimiter and before the right we use " When putting spaces after the left delimiter and before the right we use
" s:spaceStr for the space char. This way we can make it add anything after " s:spaceStr for the space char. This way we can make it add anything after
@@ -33,26 +5,6 @@ endfunction
let s:spaceStr = ' ' let s:spaceStr = ' '
let s:lenSpaceStr = strlen(s:spaceStr) let s:lenSpaceStr = strlen(s:spaceStr)
" Section: variable initialization
call s:InitVariable('g:NERDAllowAnyVisualDelims', 1)
call s:InitVariable('g:NERDBlockComIgnoreEmpty', 0)
call s:InitVariable('g:NERDCommentWholeLinesInVMode', 0)
call s:InitVariable('g:NERDCommentEmptyLines', 0)
call s:InitVariable('g:NERDCompactSexyComs', 0)
call s:InitVariable('g:NERDCreateDefaultMappings', 1)
call s:InitVariable('g:NERDDefaultNesting', 1)
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:NERDRPlace', '<]')
call s:InitVariable('g:NERDSpaceDelims', 0)
call s:InitVariable('g:NERDDefaultAlign', 'none')
call s:InitVariable('g:NERDTrimTrailingWhitespace', 0)
call s:InitVariable('g:NERDToggleCheckAllLines', 0)
call s:InitVariable('g:NERDDisableTabsInBlockComm', 0)
let s:NERDFileNameEscape="[]#*$%'\" ?`!&();<>\\" let s:NERDFileNameEscape="[]#*$%'\" ?`!&();<>\\"
let s:delimiterMap = { let s:delimiterMap = {
@@ -486,6 +438,7 @@ let s:delimiterMap = {
\ } \ }
let g:NERDDelimiterMap = s:delimiterMap let g:NERDDelimiterMap = s:delimiterMap
let nerdcommenter#delimiterMap = s:delimiterMap
if exists('g:NERDCustomDelimiters') if exists('g:NERDCustomDelimiters')
call extend(s:delimiterMap, g:NERDCustomDelimiters) call extend(s:delimiterMap, g:NERDCustomDelimiters)
@@ -493,22 +446,8 @@ endif
" Section: Comment mapping functions, autocommands and commands " Section: Comment mapping functions, autocommands and commands
" ============================================================================ " ============================================================================
" Section: Comment enabler autocommands
" ============================================================================
augroup NERDCommenter " Function: nerdcommenter#SetUpForNewFiletype(filetype) function
"if the user enters a buffer or reads a buffer then we gotta set up
"the comment delimiters for that new filetype
autocmd BufEnter,BufRead * :call s:SetUpForNewFiletype(&filetype, 0)
"if the filetype of a buffer changes, force the script to reset the
"delimiters for the buffer
autocmd Filetype * :call s:SetUpForNewFiletype(&filetype, 1)
augroup END
" Function: s:SetUpForNewFiletype(filetype) function
" This function is responsible for setting up buffer scoped variables for the " This function is responsible for setting up buffer scoped variables for the
" given filetype. " given filetype.
" "
@@ -517,8 +456,17 @@ augroup END
" -forceReset: 1 if the delimiters should be reset if they have already be " -forceReset: 1 if the delimiters should be reset if they have already be
" set for this buffer. " set for this buffer.
" "
function s:SetUpForNewFiletype(filetype, forceReset)
" used to avoid calculating things inside nerdcommenter#SetUpForNewFiletype
let s:last_filetype = '_force_setup_the_first_time_'
function! nerdcommenter#SetUpForNewFiletype(filetype, forceReset) abort
let filetype = a:filetype let filetype = a:filetype
if s:last_filetype == filetype
return 0
else
let s:last_filetype = filetype
endif
"for compound filetypes, if we don't know how to handle the full filetype "for compound filetypes, if we don't know how to handle the full filetype
"then break it down and use the first part that we know how to handle "then break it down and use the first part that we know how to handle
@@ -549,7 +497,7 @@ function s:SetUpForNewFiletype(filetype, forceReset)
" if g:NERD_<filetype>_alt_style is defined, use the alternate style " if g:NERD_<filetype>_alt_style is defined, use the alternate style
let b:NERDCommenterFirstInit = getbufvar(1,'NERDCommenterFirstInit') let b:NERDCommenterFirstInit = getbufvar(1,'NERDCommenterFirstInit')
if exists('g:NERDAltDelims_'.filetype) && eval('g:NERDAltDelims_'.filetype) && !b:NERDCommenterFirstInit if exists('g:NERDAltDelims_'.filetype) && eval('g:NERDAltDelims_'.filetype) && !b:NERDCommenterFirstInit
call s:SwitchToAlternativeDelimiters(0) call nerdcommenter#SwitchToAlternativeDelimiters(0)
let b:NERDCommenterFirstInit = 1 let b:NERDCommenterFirstInit = 1
endif endif
else else
@@ -558,7 +506,7 @@ function s:SetUpForNewFiletype(filetype, forceReset)
endfunction endfunction
function s:CreateDelimMapFromCms() function! s:CreateDelimMapFromCms() abort
if &filetype ==# '' && exists('g:NERDDefaultDelims') if &filetype ==# '' && exists('g:NERDDefaultDelims')
let delims = g:NERDDefaultDelims let delims = g:NERDDefaultDelims
for i in ['left', 'leftAlt', 'right', 'rightAlt'] for i in ['left', 'leftAlt', 'right', 'rightAlt']
@@ -577,7 +525,7 @@ function s:CreateDelimMapFromCms()
\ 'nestedAlt': 0} \ 'nestedAlt': 0}
endfunction endfunction
" Function: s:SwitchToAlternativeDelimiters(printMsgs) function " Function: nerdcommenter#SwitchToAlternativeDelimiters(printMsgs) function
" This function is used to swap the delimiters that are being used to the " This function is used to swap the delimiters that are being used to the
" alternative delimiters for that filetype. For example, if a c++ file is " alternative delimiters for that filetype. For example, if a c++ file is
" being edited and // comments are being used, after this function is called " being edited and // comments are being used, after this function is called
@@ -586,7 +534,9 @@ endfunction
" Args: " Args:
" -printMsgs: if this is 1 then a message is echoed to the user telling them " -printMsgs: if this is 1 then a message is echoed to the user telling them
" if this function changed the delimiters or not " if this function changed the delimiters or not
function s:SwitchToAlternativeDelimiters(printMsgs) " function nerdcommenter#SwitchToAlternativeDelimiters(printMsgs)
function! nerdcommenter#SwitchToAlternativeDelimiters(printMsgs) abort
call nerdcommenter#SetUpForNewFiletype(&filetype, 1)
if exists('*NERDCommenter_before') if exists('*NERDCommenter_before')
exe 'call NERDCommenter_before()' exe 'call NERDCommenter_before()'
endif endif
@@ -632,7 +582,7 @@ endfunction
" Function: s:AppendCommentToLine() " Function: s:AppendCommentToLine()
" This function appends comment delimiters at the EOL and places the cursor in " This function appends comment delimiters at the EOL and places the cursor in
" position to start typing the comment " position to start typing the comment
function s:AppendCommentToLine() function! s:AppendCommentToLine() abort
let left = s:Left({'space': 1}) let left = s:Left({'space': 1})
let right = s:Right({'space': 1}) let right = s:Right({'space': 1})
@@ -667,7 +617,7 @@ endfunction
" -lSide: the column number for the left most column in the region " -lSide: the column number for the left most column in the region
" -rSide: the column number for the right most column in the region " -rSide: the column number for the right most column in the region
" -forceNested: a flag indicating whether comments should be nested " -forceNested: a flag indicating whether comments should be nested
function s:CommentBlock(top, bottom, lSide, rSide, forceNested ) function! s:CommentBlock(top, bottom, lSide, rSide, forceNested) abort
" we need to create local copies of these arguments so we can modify them " we need to create local copies of these arguments so we can modify them
let top = a:top let top = a:top
let bottom = a:bottom let bottom = a:bottom
@@ -714,7 +664,7 @@ function s:CommentBlock(top, bottom, lSide, rSide, forceNested )
let switchedDelims = 0 let switchedDelims = 0
if !s:Multipart() && !g:NERDAllowAnyVisualDelims && s:AltMultipart() if !s:Multipart() && !g:NERDAllowAnyVisualDelims && s:AltMultipart()
let switchedDelims = 1 let switchedDelims = 1
call s:SwitchToAlternativeDelimiters(0) call nerdcommenter#SwitchToAlternativeDelimiters(0)
endif endif
"start the commenting from the top and keep commenting till we reach the "start the commenting from the top and keep commenting till we reach the
@@ -789,7 +739,7 @@ function s:CommentBlock(top, bottom, lSide, rSide, forceNested )
"if we switched delimiterss then we gotta go back to what they were before "if we switched delimiterss then we gotta go back to what they were before
if switchedDelims ==# 1 if switchedDelims ==# 1
call s:SwitchToAlternativeDelimiters(0) call nerdcommenter#SwitchToAlternativeDelimiters(0)
endif endif
endfunction endfunction
@@ -801,7 +751,7 @@ endfunction
" to be nested if need be " to be nested if need be
" -align: should be "left", "start", "both" or "none" " -align: should be "left", "start", "both" or "none"
" -firstLine/lastLine: the top and bottom lines to comment " -firstLine/lastLine: the top and bottom lines to comment
function s:CommentLines(forceNested, align, firstLine, lastLine) function! s:CommentLines(forceNested, align, firstLine, lastLine) abort
" we need to get the left and right indexes of the leftmost char in the " we need to get the left and right indexes of the leftmost char in the
" block of of lines and the right most char so that we can do alignment of " block of of lines and the right most char so that we can do alignment of
" the delimiters if the user has specified " the delimiters if the user has specified
@@ -867,7 +817,7 @@ endfunction
" "
" Args: " Args:
" -firstLine/lastLine: the top and bottom lines to comment " -firstLine/lastLine: the top and bottom lines to comment
function s:CommentLinesMinimal(firstLine, lastLine) function! s:CommentLinesMinimal(firstLine, lastLine) abort
"check that minimal comments can be done on this filetype "check that minimal comments can be done on this filetype
if !s:HasMultipartDelims() if !s:HasMultipartDelims()
throw 'NERDCommenter.Delimiters exception: Minimal comments can only be used for filetypes that have multipart delimiters' throw 'NERDCommenter.Delimiters exception: Minimal comments can only be used for filetypes that have multipart delimiters'
@@ -931,7 +881,7 @@ endfunction
" Args: " Args:
" -topline: the line number of the top line in the sexy comment " -topline: the line number of the top line in the sexy comment
" -bottomline: the line number of the bottom line in the sexy comment " -bottomline: the line number of the bottom line in the sexy comment
function s:CommentLinesSexy(topline, bottomline) function! s:CommentLinesSexy(topline, bottomline) abort
let left = s:GetSexyComLeft(0, 0) let left = s:GetSexyComLeft(0, 0)
let right = s:GetSexyComRight(0, 0) let right = s:GetSexyComRight(0, 0)
@@ -1065,7 +1015,7 @@ endfunction
" -forceNested: a flag indicating whether the called is requesting the comment " -forceNested: a flag indicating whether the called is requesting the comment
" to be nested if need be " to be nested if need be
" -firstLine/lastLine: the top and bottom lines to comment " -firstLine/lastLine: the top and bottom lines to comment
function s:CommentLinesToggle(forceNested, firstLine, lastLine) function! s:CommentLinesToggle(forceNested, firstLine, lastLine) abort
let currentLine = a:firstLine let currentLine = a:firstLine
let align = g:NERDDefaultAlign let align = g:NERDDefaultAlign
@@ -1125,13 +1075,13 @@ endfunction
" -bottomCol: the bottom right column for this comment " -bottomCol: the bottom right column for this comment
" -forceNested: whether the caller wants comments to be nested if the " -forceNested: whether the caller wants comments to be nested if the
" line(s) are already commented " line(s) are already commented
function s:CommentRegion(topLine, topCol, bottomLine, bottomCol, forceNested) function! s:CommentRegion(topLine, topCol, bottomLine, bottomCol, forceNested) abort
"switch delimiters (if we can) if the current set isn't multipart "switch delimiters (if we can) if the current set isn't multipart
let switchedDelims = 0 let switchedDelims = 0
if !s:Multipart() && s:AltMultipart() && !g:NERDAllowAnyVisualDelims if !s:Multipart() && s:AltMultipart() && !g:NERDAllowAnyVisualDelims
let switchedDelims = 1 let switchedDelims = 1
call s:SwitchToAlternativeDelimiters(0) call nerdcommenter#SwitchToAlternativeDelimiters(0)
endif endif
"if there is only one line in the comment then just do it "if there is only one line in the comment then just do it
@@ -1162,7 +1112,7 @@ function s:CommentRegion(topLine, topCol, bottomLine, bottomCol, forceNested)
"if we switched delimiters then we gotta go back to what they were before "if we switched delimiters then we gotta go back to what they were before
if switchedDelims ==# 1 if switchedDelims ==# 1
call s:SwitchToAlternativeDelimiters(0) call nerdcommenter#SwitchToAlternativeDelimiters(0)
endif endif
endfunction endfunction
@@ -1173,7 +1123,7 @@ endfunction
" Args: " Args:
" -firstLine: the top of the range of lines to be inverted " -firstLine: the top of the range of lines to be inverted
" -lastLine: the bottom of the range of lines to be inverted " -lastLine: the bottom of the range of lines to be inverted
function s:InvertComment(firstLine, lastLine) function! s:InvertComment(firstLine, lastLine) abort
" go thru all lines in the given range " go thru all lines in the given range
let currentLine = a:firstLine let currentLine = a:firstLine
@@ -1205,18 +1155,18 @@ function s:InvertComment(firstLine, lastLine)
endwhile endwhile
endfunction endfunction
" Function: NERDCommentIsLineCommented(lineNo) " Function: nerdcommenter#IsLineCommented(lineNo)
" Check if the line is a comment " Check if the line is a comment
" Note this function checks if the line is **completely** a comment " Note this function checks if the line is **completely** a comment
" Args: " Args:
" -lineNo: the line number of the line to check " -lineNo: the line number of the line to check
" Return: Number, 1 if the line is a comment, 0 else " Return: Number, 1 if the line is a comment, 0 else
function! NERDCommentIsLineCommented(lineNo) function! nerdcommenter#IsLineCommented(lineNo) abort
let theLine = getline(a:lineNo) let theLine = getline(a:lineNo)
return s:IsInSexyComment(a:lineNo) || s:IsCommentedFromStartOfLine(s:Left(), theLine) || s:IsCommentedFromStartOfLine(s:Left({'alt': 1}), theLine) return s:IsInSexyComment(a:lineNo) || s:IsCommentedFromStartOfLine(s:Left(), theLine) || s:IsCommentedFromStartOfLine(s:Left({'alt': 1}), theLine)
endfunction endfunction
" Function: NERDComment(mode, type) function " Function: nerdcommenter#Comment(mode, type) function
" This function is a Wrapper for the main commenting functions " This function is a Wrapper for the main commenting functions
" "
" Args: " Args:
@@ -1225,7 +1175,8 @@ endfunction
" -type: the type of commenting requested. Can be 'Sexy', 'Invert', " -type: the type of commenting requested. Can be 'Sexy', 'Invert',
" 'Minimal', 'Toggle', 'AlignLeft', 'AlignBoth', 'Comment', " 'Minimal', 'Toggle', 'AlignLeft', 'AlignBoth', 'Comment',
" 'Nested', 'ToEOL', 'Append', 'Insert', 'Uncomment', 'Yank' " 'Nested', 'ToEOL', 'Append', 'Insert', 'Uncomment', 'Yank'
function! NERDComment(mode, type) range function! nerdcommenter#Comment(mode, type) range abort
call nerdcommenter#SetUpForNewFiletype(&filetype, 1)
if exists('*NERDCommenter_before') if exists('*NERDCommenter_before')
exe 'call NERDCommenter_before()' exe 'call NERDCommenter_before()'
endif endif
@@ -1340,7 +1291,7 @@ function! NERDComment(mode, type) range
else else
normal! yy normal! yy
endif endif
execute firstLine .','. lastLine .'call NERDComment("'. a:mode .'", "Comment")' execute firstLine .','. lastLine .'call nerdcommenter#Comment("'. a:mode .'", "Comment")'
endif endif
call s:RecoverStateAfterLineComment(state) call s:RecoverStateAfterLineComment(state)
@@ -1472,7 +1423,7 @@ endfunction
" Function: s:PlaceDelimitersAndInsBetween() function " Function: s:PlaceDelimitersAndInsBetween() function
" This is function is called to place comment delimiters down and place the " This is function is called to place comment delimiters down and place the
" cursor between them " cursor between them
function s:PlaceDelimitersAndInsBetween() function! s:PlaceDelimitersAndInsBetween() abort
" get the left and right delimiters without any escape chars in them " get the left and right delimiters without any escape chars in them
let left = s:Left({'space': 1}) let left = s:Left({'space': 1})
let right = s:Right({'space': 1}) let right = s:Right({'space': 1})
@@ -1530,7 +1481,7 @@ endfunction
" -left: the left comment delimiter " -left: the left comment delimiter
" -right: the right comment delimiter " -right: the right comment delimiter
" -line: the line to remove the delimiters from " -line: the line to remove the delimiters from
function s:RemoveDelimiters(left, right, line) function! s:RemoveDelimiters(left, right, line) abort
let l:left = a:left let l:left = a:left
let l:right = a:right let l:right = a:right
@@ -1578,7 +1529,7 @@ endfunction
" "
" Return: a dict with the state prior to configuration changes " Return: a dict with the state prior to configuration changes
" "
function s:SetupStateBeforeLineComment(topLine, bottomLine) function! s:SetupStateBeforeLineComment(topLine, bottomLine) abort
let state = {'foldmethod' : &foldmethod, let state = {'foldmethod' : &foldmethod,
\'ignorecase' : &ignorecase} \'ignorecase' : &ignorecase}
@@ -1604,7 +1555,7 @@ endfunction
" Args: " Args:
" state: the top line of the visual selection to uncomment " state: the top line of the visual selection to uncomment
" bottomLine: the bottom line of the visual selection to uncomment " bottomLine: the bottom line of the visual selection to uncomment
function s:RecoverStateAfterLineComment(state) function! s:RecoverStateAfterLineComment(state) abort
if a:state['foldmethod'] !=# &foldmethod if a:state['foldmethod'] !=# &foldmethod
let &foldmethod = a:state['foldmethod'] let &foldmethod = a:state['foldmethod']
endif endif
@@ -1617,7 +1568,7 @@ endfunction
" This function removes all the trailing whitespace " This function removes all the trailing whitespace
" Args: " Args:
" -line: the target line " -line: the target line
function s:TrimTrailingWhitespace(line) function! s:TrimTrailingWhitespace(line) abort
let toReturn = substitute(a:line, '\s\+$', '', 'g') let toReturn = substitute(a:line, '\s\+$', '', 'g')
return toReturn return toReturn
endfunction endfunction
@@ -1628,7 +1579,7 @@ endfunction
" Args: " Args:
" topLine: the top line of the visual selection to uncomment " topLine: the top line of the visual selection to uncomment
" bottomLine: the bottom line of the visual selection to uncomment " bottomLine: the bottom line of the visual selection to uncomment
function s:UncommentLines(topLine, bottomLine) function! s:UncommentLines(topLine, bottomLine) abort
"make local copies of a:firstline and a:lastline and, if need be, swap "make local copies of a:firstline and a:lastline and, if need be, swap
"them around if the top line is below the bottom "them around if the top line is below the bottom
let l:firstline = a:topLine let l:firstline = a:topLine
@@ -1673,7 +1624,7 @@ endfunction
" comment spanning the given lines " comment spanning the given lines
" Args: " Args:
" -topline/bottomline: the top/bottom lines of the sexy comment " -topline/bottomline: the top/bottom lines of the sexy comment
function s:UncommentLinesSexy(topline, bottomline) function! s:UncommentLinesSexy(topline, bottomline) abort
let left = s:GetSexyComLeft(0,1) let left = s:GetSexyComLeft(0,1)
let right = s:GetSexyComRight(0,1) let right = s:GetSexyComRight(0,1)
@@ -1803,7 +1754,7 @@ endfunction
" uncomments the given line and returns the result " uncomments the given line and returns the result
" Args: " Args:
" -line: the line to uncomment " -line: the line to uncomment
function s:UncommentLineNormal(line) function! s:UncommentLineNormal(line) abort
let line = a:line let line = a:line
"get the positions of all delimiter types on the line "get the positions of all delimiter types on the line
@@ -1880,7 +1831,7 @@ endfunction
" This function is called to uncomment lines that aren't a sexy comment " This function is called to uncomment lines that aren't a sexy comment
" Args: " Args:
" -topline/bottomline: the top/bottom line numbers of the comment " -topline/bottomline: the top/bottom line numbers of the comment
function s:UncommentLinesNormal(topline, bottomline) function! s:UncommentLinesNormal(topline, bottomline) abort
let currentLine = a:topline let currentLine = a:topline
while currentLine <= a:bottomline while currentLine <= a:bottomline
let line = getline(currentLine) let line = getline(currentLine)
@@ -1895,13 +1846,13 @@ endfunction
" Function: s:AddLeftDelim(delim, theLine) " Function: s:AddLeftDelim(delim, theLine)
" Args: " Args:
function s:AddLeftDelim(delim, theLine) function! s:AddLeftDelim(delim, theLine) abort
return substitute(a:theLine, '^\([ \t]*\)', '\1' . a:delim, '') return substitute(a:theLine, '^\([ \t]*\)', '\1' . a:delim, '')
endfunction endfunction
" Function: s:AddLeftDelimAligned(delim, theLine) " Function: s:AddLeftDelimAligned(delim, theLine)
" Args: " Args:
function s:AddLeftDelimAligned(delim, theLine, alignIndx) function! s:AddLeftDelimAligned(delim, theLine, alignIndx) abort
"if the line is not long enough then bung some extra spaces on the front "if the line is not long enough then bung some extra spaces on the front
"so we can align the delimiter properly "so we can align the delimiter properly
@@ -1915,7 +1866,7 @@ endfunction
" Function: s:AddRightDelim(delim, theLine) " Function: s:AddRightDelim(delim, theLine)
" Args: " Args:
function s:AddRightDelim(delim, theLine) function! s:AddRightDelim(delim, theLine) abort
if a:delim ==# '' if a:delim ==# ''
return a:theLine return a:theLine
else else
@@ -1925,7 +1876,7 @@ endfunction
" Function: s:AddRightDelimAligned(delim, theLine, alignIndx) " Function: s:AddRightDelimAligned(delim, theLine, alignIndx)
" Args: " Args:
function s:AddRightDelimAligned(delim, theLine, alignIndx) function! s:AddRightDelimAligned(delim, theLine, alignIndx) abort
if a:delim ==# '' if a:delim ==# ''
return a:theLine return a:theLine
else else
@@ -1943,13 +1894,13 @@ endfunction
" Function: s:AltMultipart() " Function: s:AltMultipart()
" returns 1 if the alternative delimiters are multipart " returns 1 if the alternative delimiters are multipart
function s:AltMultipart() function! s:AltMultipart() abort
return b:NERDCommenterDelims['rightAlt'] !=# '' return b:NERDCommenterDelims['rightAlt'] !=# ''
endfunction endfunction
" Function: s:AltNested() " Function: s:AltNested()
" returns 1 if the alternate multipart (if any) delimiters allow nesting " returns 1 if the alternate multipart (if any) delimiters allow nesting
function s:AltNested() function! s:AltNested() abort
return b:NERDCommenterDelims['nestedAlt'] return b:NERDCommenterDelims['nestedAlt']
endfunction endfunction
@@ -1961,7 +1912,7 @@ endfunction
" -forceNested: a flag indicating whether the caller wants comments to be nested " -forceNested: a flag indicating whether the caller wants comments to be nested
" if the current line is already commented " if the current line is already commented
" -lineNum: the line number of the line to check for commentability " -lineNum: the line number of the line to check for commentability
function s:CanCommentLine(forceNested, lineNum) function! s:CanCommentLine(forceNested, lineNum) abort
let theLine = getline(a:lineNum) let theLine = getline(a:lineNum)
" make sure we don't comment lines that are just spaces or tabs or empty, " make sure we don't comment lines that are just spaces or tabs or empty,
@@ -1992,7 +1943,7 @@ endfunction
" Function: s:CanPlaceCursor(line, col) " Function: s:CanPlaceCursor(line, col)
" returns 1 if the cursor can be placed exactly in the given position " returns 1 if the cursor can be placed exactly in the given position
function s:CanPlaceCursor(line, col) function! s:CanPlaceCursor(line, col) abort
let c = col('.') let c = col('.')
let l = line('.') let l = line('.')
call cursor(a:line, a:col) call cursor(a:line, a:col)
@@ -2003,7 +1954,7 @@ endfunction
" Function: s:CanSexyCommentLines(topline, bottomline) " Function: s:CanSexyCommentLines(topline, bottomline)
" Return: 1 if the given lines can be commented sexually, 0 otherwise " Return: 1 if the given lines can be commented sexually, 0 otherwise
function s:CanSexyCommentLines(topline, bottomline) function! s:CanSexyCommentLines(topline, bottomline) abort
" see if the selected regions have any sexy comments " see if the selected regions have any sexy comments
" however, if the language allows nested comments, " however, if the language allows nested comments,
" we allow nested sexy comments " we allow nested sexy comments
@@ -2025,7 +1976,7 @@ endfunction
" "
" Args: " Args:
" -lineNum: the line number of the line to check for commentability " -lineNum: the line number of the line to check for commentability
function s:CanToggleCommentLine(forceNested, lineNum) function! s:CanToggleCommentLine(forceNested, lineNum) abort
let theLine = getline(a:lineNum) let theLine = getline(a:lineNum)
if (s:IsCommentedFromStartOfLine(s:Left(), theLine) || s:IsCommentedFromStartOfLine(s:Left({'alt': 1}), theLine)) && !a:forceNested if (s:IsCommentedFromStartOfLine(s:Left(), theLine) || s:IsCommentedFromStartOfLine(s:Left({'alt': 1}), theLine)) && !a:forceNested
return 0 return 0
@@ -2051,7 +2002,7 @@ endfunction
" "
" Args: " Args:
" -line: the line whose leading tabs will be converted " -line: the line whose leading tabs will be converted
function s:ConvertLeadingSpacesToTabs(line) function! s:ConvertLeadingSpacesToTabs(line) abort
let toReturn = a:line let toReturn = a:line
while toReturn =~# '^\t*' . s:TabSpace() . '\(.*\)$' while toReturn =~# '^\t*' . s:TabSpace() . '\(.*\)$'
let toReturn = substitute(toReturn, '^\(\t*\)' . s:TabSpace() . '\(.*\)$' , '\1\t\2' , '') let toReturn = substitute(toReturn, '^\(\t*\)' . s:TabSpace() . '\(.*\)$' , '\1\t\2' , '')
@@ -2067,7 +2018,7 @@ endfunction
" "
" Args: " Args:
" -line: the line whose leading spaces will be converted " -line: the line whose leading spaces will be converted
function s:ConvertLeadingTabsToSpaces(line) function! s:ConvertLeadingTabsToSpaces(line) abort
let toReturn = a:line let toReturn = a:line
while toReturn =~# '^\( *\)\t' while toReturn =~# '^\( *\)\t'
let toReturn = substitute(toReturn, '^\( *\)\t', '\1' . s:TabSpace() , '') let toReturn = substitute(toReturn, '^\( *\)\t', '\1' . s:TabSpace() , '')
@@ -2081,7 +2032,7 @@ endfunction
" "
" Args: " Args:
" -line: the line to convert " -line: the line to convert
function s:ConvertLeadingWhiteSpace(line) function! s:ConvertLeadingWhiteSpace(line) abort
let toReturn = a:line let toReturn = a:line
while toReturn =~# '^ *\t' while toReturn =~# '^ *\t'
let toReturn = substitute(toReturn, '^ *\zs\t\ze', s:TabSpace(), 'g') let toReturn = substitute(toReturn, '^ *\zs\t\ze', s:TabSpace(), 'g')
@@ -2103,7 +2054,7 @@ endfunction
" -searchstr: the substring to search for in str " -searchstr: the substring to search for in str
" -escChar: the escape character which, when preceding an instance of " -escChar: the escape character which, when preceding an instance of
" searchstr, will cause it not to be counted " searchstr, will cause it not to be counted
function s:CountNonESCedOccurances(str, searchstr, escChar) function! s:CountNonESCedOccurances(str, searchstr, escChar) abort
"get the index of the first occurrence of searchstr "get the index of the first occurrence of searchstr
let indx = stridx(a:str, a:searchstr) let indx = stridx(a:str, a:searchstr)
@@ -2128,7 +2079,7 @@ endfunction
" -delim: the comment delimiter to check the block for " -delim: the comment delimiter to check the block for
" -top: the top line number of the block " -top: the top line number of the block
" -bottom: the bottom line number of the block " -bottom: the bottom line number of the block
function s:DoesBlockHaveDelim(delim, top, bottom) function! s:DoesBlockHaveDelim(delim, top, bottom) abort
let currentLine = a:top let currentLine = a:top
while currentLine < a:bottom while currentLine < a:bottom
let theline = getline(currentLine) let theline = getline(currentLine)
@@ -2145,7 +2096,7 @@ endfunction
" Args: " Args:
" -top: the top line number of the block " -top: the top line number of the block
" -bottom: the bottom line number of the block " -bottom: the bottom line number of the block
function s:DoesBlockHaveMultipartDelim(top, bottom) function! s:DoesBlockHaveMultipartDelim(top, bottom) abort
if s:HasMultipartDelims() if s:HasMultipartDelims()
if s:Multipart() if s:Multipart()
return s:DoesBlockHaveDelim(s:Left(), a:top, a:bottom) || s:DoesBlockHaveDelim(s:Right(), a:top, a:bottom) return s:DoesBlockHaveDelim(s:Left(), a:top, a:bottom) || s:DoesBlockHaveDelim(s:Right(), a:top, a:bottom)
@@ -2159,7 +2110,7 @@ endfunction
" Function: s:Esc(str) " Function: s:Esc(str)
" Escapes all the tricky chars in the given string " Escapes all the tricky chars in the given string
function s:Esc(str) function! s:Esc(str) abort
let charsToEsc = '*/\."&$+[]' let charsToEsc = '*/\."&$+[]'
return escape(a:str, charsToEsc) return escape(a:str, charsToEsc)
endfunction endfunction
@@ -2171,7 +2122,7 @@ endfunction
" Args: " Args:
" -delimiter: the delimiter we are looking to find the index of " -delimiter: the delimiter we are looking to find the index of
" -line: the line we are looking for delimiter on " -line: the line we are looking for delimiter on
function s:FindDelimiterIndex(delimiter, line) function! s:FindDelimiterIndex(delimiter, line) abort
"make sure the delimiter isn't empty otherwise we go into an infinite loop. "make sure the delimiter isn't empty otherwise we go into an infinite loop.
if a:delimiter ==# '' if a:delimiter ==# ''
@@ -2228,7 +2179,7 @@ endfunction
" A string that has the top/bottom lines of the sexy comment encoded in it. " A string that has the top/bottom lines of the sexy comment encoded in it.
" The format is 'topline,bottomline'. If a:lineNum turns out not to be the " The format is 'topline,bottomline'. If a:lineNum turns out not to be the
" top/bottom/middle of a sexy comment then -1 is returned " top/bottom/middle of a sexy comment then -1 is returned
function s:FindBoundingLinesOfSexyCom(lineNum) function! s:FindBoundingLinesOfSexyCom(lineNum) abort
"find which delimiters to look for as the start/end delimiters of the comment "find which delimiters to look for as the start/end delimiters of the comment
let left = '' let left = ''
@@ -2303,7 +2254,7 @@ endfunction
" -space: specifies whether the marker is to have a space string after it " -space: specifies whether the marker is to have a space string after it
" (the space string will only be added if NERDSpaceDelims is set) " (the space string will only be added if NERDSpaceDelims is set)
" -esc: specifies whether the tricky chars in the marker are to be ESCed " -esc: specifies whether the tricky chars in the marker are to be ESCed
function s:GetSexyComMarker(space, esc) function! s:GetSexyComMarker(space, esc) abort
let sexyComMarker = b:NERDSexyComMarker let sexyComMarker = b:NERDSexyComMarker
"if there is no hardcoded marker then we find one "if there is no hardcoded marker then we find one
@@ -2348,7 +2299,7 @@ endfunction
" Returns 1 if the sexy delimeters allow nesting " Returns 1 if the sexy delimeters allow nesting
" TODO this is ugly copy&paste from the GetSexyComLeft/Right functions, " TODO this is ugly copy&paste from the GetSexyComLeft/Right functions,
" these could all be cleaned up " these could all be cleaned up
function s:SexyNested() function! s:SexyNested() abort
let lenLeft = strlen(s:Left()) let lenLeft = strlen(s:Left())
let lenLeftAlt = strlen(s:Left({'alt': 1})) let lenLeftAlt = strlen(s:Left({'alt': 1}))
@@ -2374,7 +2325,7 @@ endfunction
" -space: specifies if the delimiter has a space string on the end " -space: specifies if the delimiter has a space string on the end
" (the space string will only be added if NERDSpaceDelims is set) " (the space string will only be added if NERDSpaceDelims is set)
" -esc: specifies whether the tricky chars in the string are ESCed " -esc: specifies whether the tricky chars in the string are ESCed
function s:GetSexyComLeft(space, esc) function! s:GetSexyComLeft(space, esc) abort
let lenLeft = strlen(s:Left()) let lenLeft = strlen(s:Left())
let lenLeftAlt = strlen(s:Left({'alt': 1})) let lenLeftAlt = strlen(s:Left({'alt': 1}))
let left = '' let left = ''
@@ -2412,7 +2363,7 @@ endfunction
" (the space string will only be added if NERDSpaceDelims " (the space string will only be added if NERDSpaceDelims
" is specified for the current filetype) " is specified for the current filetype)
" -esc: specifies whether the tricky chars in the string are ESCed " -esc: specifies whether the tricky chars in the string are ESCed
function s:GetSexyComRight(space, esc) function! s:GetSexyComRight(space, esc) abort
let lenLeft = strlen(s:Left()) let lenLeft = strlen(s:Left())
let lenLeftAlt = strlen(s:Left({'alt': 1})) let lenLeftAlt = strlen(s:Left({'alt': 1}))
let right = '' let right = ''
@@ -2444,13 +2395,13 @@ endfunction
" Function: s:HasMultipartDelims() " Function: s:HasMultipartDelims()
" Returns 1 if the current filetype has at least one set of multipart delimiters " Returns 1 if the current filetype has at least one set of multipart delimiters
function s:HasMultipartDelims() function! s:HasMultipartDelims() abort
return s:Multipart() || s:AltMultipart() return s:Multipart() || s:AltMultipart()
endfunction endfunction
" Function: s:HasLeadingTabs(...) " Function: s:HasLeadingTabs(...)
" Returns 1 if any of the given strings have leading tabs " Returns 1 if any of the given strings have leading tabs
function s:HasLeadingTabs(...) function! s:HasLeadingTabs(...) abort
for s in a:000 for s in a:000
if s =~# '^\t.*' if s =~# '^\t.*'
return 1 return 1
@@ -2460,7 +2411,7 @@ function s:HasLeadingTabs(...)
endfunction endfunction
" Function: s:HasCStyleComments() " Function: s:HasCStyleComments()
" Returns 1 if the current filetype has c style comment delimiters " Returns 1 if the current filetype has c style comment delimiters
function s:HasCStyleComments() function! s:HasCStyleComments() abort
return (s:Left() ==# '/*' && s:Right() ==# '*/') || (s:Left({'alt': 1}) ==# '/*' && s:Right({'alt': 1}) ==# '*/') return (s:Left() ==# '/*' && s:Right() ==# '*/') || (s:Left({'alt': 1}) ==# '/*' && s:Right({'alt': 1}) ==# '*/')
endfunction endfunction
@@ -2470,7 +2421,7 @@ endfunction
" "
" Args: " Args:
" -lineNum: the line number of the line to check " -lineNum: the line number of the line to check
function s:IsCommentedNormOrSexy(lineNum) function! s:IsCommentedNormOrSexy(lineNum) abort
let theLine = getline(a:lineNum) let theLine = getline(a:lineNum)
"if the line is commented normally return 1 "if the line is commented normally return 1
@@ -2492,7 +2443,7 @@ endfunction
" Args: " Args:
" -line: the line that to check if commented " -line: the line that to check if commented
" -left/right: the left and right delimiters to check for " -left/right: the left and right delimiters to check for
function s:IsCommented(left, right, line) function! s:IsCommented(left, right, line) abort
"if the line isn't commented return true "if the line isn't commented return true
if s:FindDelimiterIndex(a:left, a:line) !=# -1 && (s:LastIndexOfDelim(a:right, a:line) !=# -1 || !s:Multipart()) if s:FindDelimiterIndex(a:left, a:line) !=# -1 && (s:LastIndexOfDelim(a:right, a:line) !=# -1 || !s:Multipart())
return 1 return 1
@@ -2508,7 +2459,7 @@ endfunction
" Args: " Args:
" -line: the line that to check if commented " -line: the line that to check if commented
" -left: the left delimiter to check for " -left: the left delimiter to check for
function s:IsCommentedFromStartOfLine(left, line) function! s:IsCommentedFromStartOfLine(left, line) abort
let theLine = s:ConvertLeadingTabsToSpaces(a:line) let theLine = s:ConvertLeadingTabsToSpaces(a:line)
let numSpaces = strlen(substitute(theLine, '^\( *\).*$', '\1', '')) let numSpaces = strlen(substitute(theLine, '^\( *\).*$', '\1', ''))
let delimIndx = s:FindDelimiterIndex(a:left, theLine) let delimIndx = s:FindDelimiterIndex(a:left, theLine)
@@ -2528,7 +2479,7 @@ endfunction
" 0 if the line is not commented with either set of delimiters " 0 if the line is not commented with either set of delimiters
" 1 if the line is commented with the left/right delimiter set " 1 if the line is commented with the left/right delimiter set
" 2 if the line is commented with the leftAlt/rightAlt delim set " 2 if the line is commented with the leftAlt/rightAlt delim set
function s:IsCommentedOutermost(left, right, leftAlt, rightAlt, line) function! s:IsCommentedOutermost(left, right, leftAlt, rightAlt, line) abort
"get the first positions of the left delimiters and the last positions of the "get the first positions of the left delimiters and the last positions of the
"right delimiters "right delimiters
let indxLeft = s:FindDelimiterIndex(a:left, a:line) let indxLeft = s:FindDelimiterIndex(a:left, a:line)
@@ -2575,7 +2526,7 @@ endfunction
" Returns: " Returns:
" 0 if the given delimiter is not a real delimiter (as far as we can tell) , " 0 if the given delimiter is not a real delimiter (as far as we can tell) ,
" 1 otherwise " 1 otherwise
function s:IsDelimValid(delimiter, delIndx, line) function! s:IsDelimValid(delimiter, delIndx, line) abort
"get the delimiter without the escchars "get the delimiter without the escchars
let l:delimiter = a:delimiter let l:delimiter = a:delimiter
@@ -2639,7 +2590,7 @@ endfunction
" A small function the returns 1 if the input number is even and 0 otherwise " A small function the returns 1 if the input number is even and 0 otherwise
" Args: " Args:
" -num: the number to check " -num: the number to check
function s:IsNumEven(num) function! s:IsNumEven(num) abort
return (a:num % 2) ==# 0 return (a:num % 2) ==# 0
endfunction endfunction
@@ -2651,7 +2602,7 @@ endfunction
" -str: the string to check " -str: the string to check
" -indx: the index into str that we want to check " -indx: the index into str that we want to check
" -escChar: the escape char the char at indx may be ESCed with " -escChar: the escape char the char at indx may be ESCed with
function s:IsEscaped(str, indx, escChar) function! s:IsEscaped(str, indx, escChar) abort
"initialise numEscChars to 0 and look at the char before indx "initialise numEscChars to 0 and look at the char before indx
let numEscChars = 0 let numEscChars = 0
let curIndx = a:indx-1 let curIndx = a:indx-1
@@ -2674,7 +2625,7 @@ endfunction
" Function: s:IsInSexyComment(line) " Function: s:IsInSexyComment(line)
" returns 1 if the given line number is part of a sexy comment " returns 1 if the given line number is part of a sexy comment
function s:IsInSexyComment(line) function! s:IsInSexyComment(line) abort
return !empty(s:FindBoundingLinesOfSexyCom(a:line)) return !empty(s:FindBoundingLinesOfSexyCom(a:line))
endfunction endfunction
@@ -2684,7 +2635,7 @@ endfunction
" Args: " Args:
" -topline: the line that the possible sexy comment starts on " -topline: the line that the possible sexy comment starts on
" -bottomline: the line that the possible sexy comment stops on " -bottomline: the line that the possible sexy comment stops on
function s:IsSexyComment(topline, bottomline) function! s:IsSexyComment(topline, bottomline) abort
"get the delimiter set that would be used for a sexy comment "get the delimiter set that would be used for a sexy comment
let left = '' let left = ''
@@ -2765,7 +2716,7 @@ endfunction
" Args: " Args:
" -delim: the delimiter to look for " -delim: the delimiter to look for
" -str: the string to look for delimiter in " -str: the string to look for delimiter in
function s:LastIndexOfDelim(delim, str) function! s:LastIndexOfDelim(delim, str) abort
let delim = a:delim let delim = a:delim
let lenDelim = strlen(delim) let lenDelim = strlen(delim)
@@ -2799,7 +2750,7 @@ endfunction
" Function: s:Left(...) " Function: s:Left(...)
" returns left delimiter data " returns left delimiter data
function s:Left(...) function! s:Left(...) abort
let params = a:0 ? a:1 : {} let params = a:0 ? a:1 : {}
let delim = has_key(params, 'alt') ? b:NERDCommenterDelims['leftAlt'] : b:NERDCommenterDelims['left'] let delim = has_key(params, 'alt') ? b:NERDCommenterDelims['leftAlt'] : b:NERDCommenterDelims['left']
@@ -2828,7 +2779,7 @@ endfunction
" -countEmptyLines: 1 if empty lines are to be counted in the search " -countEmptyLines: 1 if empty lines are to be counted in the search
" -topline: the top line to be checked " -topline: the top line to be checked
" -bottomline: the bottom line to be checked " -bottomline: the bottom line to be checked
function s:LeftMostIndx(countCommentedLines, countEmptyLines, topline, bottomline) function! s:LeftMostIndx(countCommentedLines, countEmptyLines, topline, bottomline) abort
" declare the left most index as an extreme value " declare the left most index as an extreme value
let leftMostIndx = 1000 let leftMostIndx = 1000
@@ -2865,7 +2816,7 @@ endfunction
" Function: s:Multipart() " Function: s:Multipart()
" returns 1 if the current delimiters are multipart " returns 1 if the current delimiters are multipart
function s:Multipart() function! s:Multipart() abort
return s:Right() !=# '' return s:Right() !=# ''
endfunction endfunction
@@ -2874,7 +2825,7 @@ endfunction
" -msg: the message to echo " -msg: the message to echo
" -typeOfMsg: 0 = warning message " -typeOfMsg: 0 = warning message
" 1 = normal message " 1 = normal message
function s:NerdEcho(msg, typeOfMsg) function! s:NerdEcho(msg, typeOfMsg) abort
if a:typeOfMsg ==# 0 if a:typeOfMsg ==# 0
echohl WarningMsg echohl WarningMsg
echom 'NERDCommenter:' . a:msg echom 'NERDCommenter:' . a:msg
@@ -2886,19 +2837,19 @@ endfunction
" Function: s:Nested() " Function: s:Nested()
" returns 1 if the current multipart (if any) delimiters allow nesting " returns 1 if the current multipart (if any) delimiters allow nesting
function s:Nested() function! s:Nested() abort
return b:NERDCommenterDelims['nested'] return b:NERDCommenterDelims['nested']
endfunction endfunction
" Function: s:NumberOfLeadingTabs(s) " Function: s:NumberOfLeadingTabs(s)
" returns the number of leading tabs in the given string " returns the number of leading tabs in the given string
function s:NumberOfLeadingTabs(s) function! s:NumberOfLeadingTabs(s) abort
return strlen(substitute(a:s, '^\(\t*\).*$', '\1', '')) return strlen(substitute(a:s, '^\(\t*\).*$', '\1', ''))
endfunction endfunction
" Function: s:NumLinesInBuf() " Function: s:NumLinesInBuf()
" Returns the number of lines in the current buffer " Returns the number of lines in the current buffer
function s:NumLinesInBuf() function! s:NumLinesInBuf() abort
return line('$') return line('$')
endfunction endfunction
@@ -2912,7 +2863,7 @@ endfunction
" -replacor1: the string to replace toReplace1 with " -replacor1: the string to replace toReplace1 with
" -replacor2: the string to replace toReplace2 with " -replacor2: the string to replace toReplace2 with
" -str: the string that the delimiters to be replaced are in " -str: the string that the delimiters to be replaced are in
function s:ReplaceDelims(toReplace1, toReplace2, replacor1, replacor2, str) function! s:ReplaceDelims(toReplace1, toReplace2, replacor1, replacor2, str) abort
let line = s:ReplaceLeftMostDelim(a:toReplace1, a:replacor1, a:str) let line = s:ReplaceLeftMostDelim(a:toReplace1, a:replacor1, a:str)
let line = s:ReplaceRightMostDelim(a:toReplace2, a:replacor2, line) let line = s:ReplaceRightMostDelim(a:toReplace2, a:replacor2, line)
return line return line
@@ -2926,7 +2877,7 @@ endfunction
" -toReplace: the delimiter in str that is to be replaced " -toReplace: the delimiter in str that is to be replaced
" -replacor: the string to replace toReplace with " -replacor: the string to replace toReplace with
" -str: the string that contains toReplace " -str: the string that contains toReplace
function s:ReplaceLeftMostDelim(toReplace, replacor, str) function! s:ReplaceLeftMostDelim(toReplace, replacor, str) abort
let toReplace = a:toReplace let toReplace = a:toReplace
let replacor = a:replacor let replacor = a:replacor
"get the left most occurrence of toReplace "get the left most occurrence of toReplace
@@ -2951,7 +2902,7 @@ endfunction
" -replacor: the string to replace toReplace with " -replacor: the string to replace toReplace with
" -str: the string that contains toReplace " -str: the string that contains toReplace
" "
function s:ReplaceRightMostDelim(toReplace, replacor, str) function! s:ReplaceRightMostDelim(toReplace, replacor, str) abort
let toReplace = a:toReplace let toReplace = a:toReplace
let replacor = a:replacor let replacor = a:replacor
let lenToReplace = strlen(toReplace) let lenToReplace = strlen(toReplace)
@@ -2972,7 +2923,7 @@ endfunction
"Sets the screen state back to what it was when s:SaveScreenState was last "Sets the screen state back to what it was when s:SaveScreenState was last
"called. "called.
" "
function s:RestoreScreenState() function! s:RestoreScreenState() abort
if !exists('t:NERDComOldTopLine') || !exists('t:NERDComOldPos') if !exists('t:NERDComOldTopLine') || !exists('t:NERDComOldPos')
throw 'NERDCommenter exception: cannot restore screen' throw 'NERDCommenter exception: cannot restore screen'
endif endif
@@ -2984,7 +2935,7 @@ endfunction
" Function: s:Right(...) " Function: s:Right(...)
" returns right delimiter data " returns right delimiter data
function s:Right(...) function! s:Right(...) abort
let params = a:0 ? a:1 : {} let params = a:0 ? a:1 : {}
let delim = has_key(params, 'alt') ? b:NERDCommenterDelims['rightAlt'] : b:NERDCommenterDelims['right'] let delim = has_key(params, 'alt') ? b:NERDCommenterDelims['rightAlt'] : b:NERDCommenterDelims['right']
@@ -3013,7 +2964,7 @@ endfunction
" -countEmptyLines: 1 if empty lines are to be counted in the search " -countEmptyLines: 1 if empty lines are to be counted in the search
" -topline: the top line to be checked " -topline: the top line to be checked
" -bottomline: the bottom line to be checked " -bottomline: the bottom line to be checked
function s:RightMostIndx(countCommentedLines, countEmptyLines, topline, bottomline) function! s:RightMostIndx(countCommentedLines, countEmptyLines, topline, bottomline) abort
let rightMostIndx = -1 let rightMostIndx = -1
" go thru the block line by line updating rightMostIndx " go thru the block line by line updating rightMostIndx
@@ -3046,7 +2997,7 @@ endfunction
"FUNCTION: s:SaveScreenState() "FUNCTION: s:SaveScreenState()
"Saves the current cursor position in the current buffer and the window "Saves the current cursor position in the current buffer and the window
"scroll position "scroll position
function s:SaveScreenState() function! s:SaveScreenState() abort
let t:NERDComOldPos = getpos('.') let t:NERDComOldPos = getpos('.')
let t:NERDComOldTopLine = line('w0') let t:NERDComOldTopLine = line('w0')
endfunction endfunction
@@ -3057,7 +3008,7 @@ endfunction
" Args: " Args:
" -line: the line to swap the delimiters in " -line: the line to swap the delimiters in
" "
function s:SwapOuterMultiPartDelimsForPlaceHolders(line) function! s:SwapOuterMultiPartDelimsForPlaceHolders(line) abort
" find out if the line is commented using normal delimiters and/or " find out if the line is commented using normal delimiters and/or
" alternate ones " alternate ones
let isCommented = s:IsCommented(s:Left(), s:Right(), a:line) let isCommented = s:IsCommented(s:Left(), s:Right(), a:line)
@@ -3085,7 +3036,7 @@ endfunction
" Args: " Args:
" -line: the line to swap the delimiters in " -line: the line to swap the delimiters in
" "
function s:SwapOuterPlaceHoldersForMultiPartDelims(line) function! s:SwapOuterPlaceHoldersForMultiPartDelims(line) abort
let left = '' let left = ''
let right = '' let right = ''
if s:Multipart() if s:Multipart()
@@ -3106,7 +3057,7 @@ endfunction
" Args: " Args:
" -line:the line to get the rel col for " -line:the line to get the rel col for
" -col: the abs col " -col: the abs col
function s:TabbedCol(line, col) function! s:TabbedCol(line, col) abort
let lineTruncated = strpart(a:line, 0, a:col) let lineTruncated = strpart(a:line, 0, a:col)
let lineSpacesToTabs = substitute(lineTruncated, s:TabSpace(), '\t', 'g') let lineSpacesToTabs = substitute(lineTruncated, s:TabSpace(), '\t', 'g')
return strlen(lineSpacesToTabs) return strlen(lineSpacesToTabs)
@@ -3114,7 +3065,7 @@ endfunction
"FUNCTION: s:TabSpace() "FUNCTION: s:TabSpace()
"returns a string of spaces equal in length to &tabstop "returns a string of spaces equal in length to &tabstop
function s:TabSpace() function! s:TabSpace() abort
let tabSpace = '' let tabSpace = ''
let spacesPerTab = &tabstop let spacesPerTab = &tabstop
while spacesPerTab > 0 while spacesPerTab > 0
@@ -3129,7 +3080,7 @@ endfunction
" Args: " Args:
" -str: the string to remove esc chars from " -str: the string to remove esc chars from
" -escChar: the escape char to be removed " -escChar: the escape char to be removed
function s:UnEsc(str, escChar) function! s:UnEsc(str, escChar) abort
return substitute(a:str, a:escChar, '', 'g') return substitute(a:str, a:escChar, '', 'g')
endfunction endfunction
@@ -3139,70 +3090,8 @@ endfunction
" Args: " Args:
" -line:the line to get the abs col for " -line:the line to get the abs col for
" -col: the col that doesn't take into account tabs " -col: the col that doesn't take into account tabs
function s:UntabbedCol(line, col) function! s:UntabbedCol(line, col) abort
let lineTruncated = strpart(a:line, 0, a:col) let lineTruncated = strpart(a:line, 0, a:col)
let lineTabsToSpaces = substitute(lineTruncated, '\t', s:TabSpace(), 'g') let lineTabsToSpaces = substitute(lineTruncated, '\t', s:TabSpace(), 'g')
return strlen(lineTabsToSpaces) return strlen(lineTabsToSpaces)
endfunction endfunction
" Section: Comment mapping and menu item setup
" ===========================================================================
" Create menu items for the specified modes. If a:combo is not empty, then
" also define mappings and show a:combo in the menu items.
function! s:CreateMaps(modes, target, desc, combo)
" Build up a map command like
" 'noremap <silent> <plug>NERDCommenterComment :call NERDComment("n", "Comment")'
let plug = '<plug>NERDCommenter' . a:target
let plug_start = 'noremap <silent> ' . plug . ' :call NERDComment("'
let plug_end = '", "' . a:target . '")<cr>'
" Build up a menu command like
" 'menu <silent> comment.Comment<Tab>\\cc <plug>NERDCommenterComment'
let menuRoot = get(['', 'comment', '&comment', '&Plugin.&comment'],
\ g:NERDMenuMode, '')
let menu_command = 'menu <silent> ' . menuRoot . '.' . escape(a:desc, ' ')
if strlen(a:combo)
let leader = exists('g:mapleader') ? g:mapleader : '\'
let menu_command .= '<Tab>' . escape(leader, '\') . a:combo
endif
let menu_command .= ' ' . (strlen(a:combo) ? plug : a:target)
" Execute the commands built above for each requested mode.
for mode in (a:modes ==# '') ? [''] : split(a:modes, '\zs')
if strlen(a:combo)
execute mode . plug_start . mode . plug_end
if g:NERDCreateDefaultMappings && !hasmapto(plug, mode)
execute mode . 'map <leader>' . a:combo . ' ' . plug
endif
endif
" Check if the user wants the menu to be displayed.
if g:NERDMenuMode !=# 0
execute mode . menu_command
endif
endfor
endfunction
call s:CreateMaps('nx', 'Comment', 'Comment', 'cc')
call s:CreateMaps('nx', 'Toggle', 'Toggle', 'c<space>')
call s:CreateMaps('nx', 'Minimal', 'Minimal', 'cm')
call s:CreateMaps('nx', 'Nested', 'Nested', 'cn')
call s:CreateMaps('n', 'ToEOL', 'To EOL', 'c$')
call s:CreateMaps('nx', 'Invert', 'Invert', 'ci')
call s:CreateMaps('nx', 'Sexy', 'Sexy', 'cs')
call s:CreateMaps('nx', 'Yank', 'Yank then comment', 'cy')
call s:CreateMaps('n', 'Append', 'Append', 'cA')
call s:CreateMaps('', ':', '-Sep-', '')
call s:CreateMaps('nx', 'AlignLeft', 'Left aligned', 'cl')
call s:CreateMaps('nx', 'AlignBoth', 'Left and right aligned', 'cb')
call s:CreateMaps('', ':', '-Sep2-', '')
call s:CreateMaps('nx', 'Uncomment', 'Uncomment', 'cu')
call s:CreateMaps('n', 'AltDelims', 'Switch Delimiters', 'ca')
call s:CreateMaps('i', 'Insert', 'Insert Comment Here', '')
call s:CreateMaps('', ':', '-Sep3-', '')
call s:CreateMaps('', ':help NERDCommenterContents<CR>', 'Help', '')
inoremap <silent> <plug>NERDCommenterInsert <SPACE><BS><ESC>:call NERDComment('i', 'insert')<CR>
" switch to/from alternative delimiters (does not use wrapper function)
nnoremap <plug>NERDCommenterAltDelims :call <SID>SwitchToAlternativeDelimiters(1)<cr>
" This is a workaround to enable lazy-loading from supported plugin managers:
" See https://github.com/preservim/nerdcommenter/issues/176
call s:SetUpForNewFiletype(&filetype, 1)

103
plugin/nerdcommenter.vim Normal file
View File

@@ -0,0 +1,103 @@
if exists('loaded_nerd_comments')
finish
endif
if v:version < 700
echoerr "NERDCommenter: this plugin requires vim >= 7. DOWNLOAD IT! You'll thank me later!"
finish
endif
let loaded_nerd_comments = 1
" Function: s:InitVariable() function
" This function is used to initialise a given variable to a given value. The
" variable is only initialised if it does not exist prior
"
" Args:
" -var: the name of the var to be initialised
" -value: the value to initialise var to
"
" Returns:
" 0
function s:InitVariable(var, value)
if !exists(a:var)
execute 'let ' . a:var . ' = ' . string(a:value)
endif
endfunction
" Section: variable initialization
call s:InitVariable('g:NERDAllowAnyVisualDelims', 1)
call s:InitVariable('g:NERDBlockComIgnoreEmpty', 0)
call s:InitVariable('g:NERDCommentWholeLinesInVMode', 0)
call s:InitVariable('g:NERDCommentEmptyLines', 0)
call s:InitVariable('g:NERDCompactSexyComs', 0)
call s:InitVariable('g:NERDCreateDefaultMappings', 1)
call s:InitVariable('g:NERDDefaultNesting', 1)
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:NERDRPlace', '<]')
call s:InitVariable('g:NERDSpaceDelims', 0)
call s:InitVariable('g:NERDDefaultAlign', 'none')
call s:InitVariable('g:NERDTrimTrailingWhitespace', 0)
call s:InitVariable('g:NERDToggleCheckAllLines', 0)
call s:InitVariable('g:NERDDisableTabsInBlockComm', 0)
" Section: Comment mapping and menu item setup
" ===========================================================================
" Create menu items for the specified modes. If a:combo is not empty, then
" also define mappings and show a:combo in the menu items.
function! s:CreateMaps(modes, target, desc, combo)
" Build up a map command like
" 'noremap <silent> <Plug>NERDCommenterComment :call nerdcommenter#Comment("n", "Comment")'
let plug = '<Plug>NERDCommenter' . a:target
let plug_start = 'noremap <silent> ' . plug . ' :call nerdcommenter#Comment("'
let plug_end = '", "' . a:target . '")<CR>'
" Build up a menu command like
" 'menu <silent> comment.Comment<Tab>\\cc <Plug>NERDCommenterComment'
let menuRoot = get(['', 'comment', '&comment', '&Plugin.&comment', '&Plugin.Nerd\ &Commenter'],
\ g:NERDMenuMode, '')
let menu_command = 'menu <silent> ' . menuRoot . '.' . escape(a:desc, ' ')
if strlen(a:combo)
let leader = exists('g:mapleader') ? g:mapleader : '\'
let menu_command .= '<Tab>' . escape(leader, '\') . a:combo
endif
let menu_command .= ' ' . (strlen(a:combo) ? plug : a:target)
" Execute the commands built above for each requested mode.
for mode in (a:modes ==# '') ? [''] : split(a:modes, '\zs')
if strlen(a:combo)
execute mode . plug_start . mode . plug_end
if g:NERDCreateDefaultMappings && !hasmapto(plug, mode)
execute mode . 'map <leader>' . a:combo . ' ' . plug
endif
endif
" Check if the user wants the menu to be displayed.
if g:NERDMenuMode !=# 0
execute mode . menu_command
endif
endfor
endfunction
call s:CreateMaps('nx', 'Comment', 'Comment', 'cc')
call s:CreateMaps('nx', 'Toggle', 'Toggle', 'c<Space>')
call s:CreateMaps('nx', 'Minimal', 'Minimal', 'cm')
call s:CreateMaps('nx', 'Nested', 'Nested', 'cn')
call s:CreateMaps('n', 'ToEOL', 'To EOL', 'c$')
call s:CreateMaps('nx', 'Invert', 'Invert', 'ci')
call s:CreateMaps('nx', 'Sexy', 'Sexy', 'cs')
call s:CreateMaps('nx', 'Yank', 'Yank then comment', 'cy')
call s:CreateMaps('n', 'Append', 'Append', 'cA')
call s:CreateMaps('', ':', '-Sep-', '')
call s:CreateMaps('nx', 'AlignLeft', 'Left aligned', 'cl')
call s:CreateMaps('nx', 'AlignBoth', 'Left and right aligned', 'cb')
call s:CreateMaps('', ':', '-Sep2-', '')
call s:CreateMaps('nx', 'Uncomment', 'Uncomment', 'cu')
call s:CreateMaps('n', 'AltDelims', 'Switch Delimiters', 'ca')
call s:CreateMaps('i', 'Insert', 'Insert Comment Here', '')
call s:CreateMaps('', ':', '-Sep3-', '')
call s:CreateMaps('', ':help NERDCommenterContents<CR>', 'Help', '')
inoremap <silent> <Plug>NERDCommenterInsert <Space><BS><Esc>:call nerdcommenter#Comment('i', "insert")<CR>
" switch to/from alternative delimiters (does not use wrapper function)
nnoremap <Plug>NERDCommenterAltDelims :call nerdcommenter#SwitchToAlternativeDelimiters(1)<CR>