From 335282e39da055c4c33628c24ff9409d2daf99c9 Mon Sep 17 00:00:00 2001 From: Andrew Radev Date: Sun, 19 Dec 2021 18:02:39 +0200 Subject: [PATCH 1/5] WIP Initial work on Vim 9 rewrite --- indent/ruby.vim | 1235 ++++++++++++++++++++++++----------------------- 1 file changed, 619 insertions(+), 616 deletions(-) diff --git a/indent/ruby.vim b/indent/ruby.vim index 4b55e409..c82333e9 100644 --- a/indent/ruby.vim +++ b/indent/ruby.vim @@ -1,67 +1,66 @@ -" Vim indent file -" Language: Ruby -" Maintainer: Andrew Radev -" Previous Maintainer: Nikolai Weibull -" URL: https://github.com/vim-ruby/vim-ruby -" Release Coordinator: Doug Kearns +vim9script -" 0. Initialization {{{1 -" ================= +# Vim indent file +# Language: Ruby +# Maintainer: Andrew Radev +# Previous Maintainer: Nikolai Weibull +# URL: https://github.com/vim-ruby/vim-ruby +# Release Coordinator: Doug Kearns -" Only load this indent file when no other was loaded. +# 0. Initialization {{{1 +# ================= + +# Only load this indent file when no other was loaded. if exists("b:did_indent") finish endif -let b:did_indent = 1 +b:did_indent = 1 if !exists('g:ruby_indent_access_modifier_style') - " Possible values: "normal", "indent", "outdent" - let g:ruby_indent_access_modifier_style = 'normal' + # Possible values: "normal", "indent", "outdent" + g:ruby_indent_access_modifier_style = 'normal' endif if !exists('g:ruby_indent_assignment_style') - " Possible values: "variable", "hanging" - let g:ruby_indent_assignment_style = 'hanging' + # Possible values: "variable", "hanging" + g:ruby_indent_assignment_style = 'hanging' endif if !exists('g:ruby_indent_block_style') - " Possible values: "expression", "do" - let g:ruby_indent_block_style = 'do' + # Possible values: "expression", "do" + g:ruby_indent_block_style = 'do' endif if !exists('g:ruby_indent_hanging_elements') - " Non-zero means hanging indents are enabled, zero means disabled - let g:ruby_indent_hanging_elements = 1 + # Non-zero means hanging indents are enabled, zero means disabled + g:ruby_indent_hanging_elements = 1 endif -setlocal nosmartindent +set nosmartindent -" Now, set up our indentation expression and keys that trigger it. -setlocal indentexpr=GetRubyIndent(v:lnum) +# Now, set up our indentation expression and keys that trigger it. +setlocal indentexpr=g:GetRubyIndent(v:lnum) setlocal indentkeys=0{,0},0),0],!^F,o,O,e,:,. setlocal indentkeys+==end,=else,=elsif,=when,=ensure,=rescue,==begin,==end setlocal indentkeys+==private,=protected,=public -" Only define the function once. +# Only define the function once. if exists("*GetRubyIndent") finish endif -let s:cpo_save = &cpo -set cpo&vim - -" 1. Variables {{{1 -" ============ +# 1. Variables {{{1 +# ============ -" Syntax group names that are strings. -let s:syng_string = +# Syntax group names that are strings. +var syng_string = \ ['String', 'Interpolation', 'InterpolationDelimiter', 'StringEscape'] -" Syntax group names that are strings or documentation. -let s:syng_stringdoc = s:syng_string + ['Documentation'] +# Syntax group names that are strings or documentation. +var syng_stringdoc = syng_string + ['Documentation'] -" Syntax group names that are or delimit strings/symbols/regexes or are comments. -let s:syng_strcom = s:syng_stringdoc + [ +# Syntax group names that are or delimit strings/symbols/regexes or are comments. +var syng_strcom = syng_stringdoc + [ \ 'Character', \ 'Comment', \ 'HeredocDelimiter', @@ -77,250 +76,128 @@ let s:syng_strcom = s:syng_stringdoc + [ \ 'SymbolDelimiter', \ ] -" Expression used to check whether we should skip a match with searchpair(). -let s:skip_expr = - \ 'index(map('.string(s:syng_strcom).',"hlID(''ruby''.v:val)"), synID(line("."),col("."),1)) >= 0' +# Expression used to check whether we should skip a match with searchpair(). +var skip_expr = + \ 'index(map(' .. string(syng_strcom) .. ',"hlID(''ruby''.v:val)"), synID(line("."),col("."),1)) >= 0' -" Regex used for words that, at the start of a line, add a level of indent. -let s:ruby_indent_keywords = - \ '^\s*\zs\<\%(module\|class\|if\|for' . - \ '\|while\|until\|else\|elsif\|case\|when\|unless\|begin\|ensure\|rescue' . - \ '\|\%(\K\k*[!?]\?\s\+\)\=def\):\@!\>' . - \ '\|\%([=,*/%+-]\|<<\|>>\|:\s\)\s*\zs' . +# Regex used for words that, at the start of a line, add a level of indent. +var ruby_indent_keywords = + \ '^\s*\zs\<\%(module\|class\|if\|for' .. + \ '\|while\|until\|else\|elsif\|case\|when\|unless\|begin\|ensure\|rescue' .. + \ '\|\%(\K\k*[!?]\?\s\+\)\=def\):\@!\>' .. + \ '\|\%([=,*/%+-]\|<<\|>>\|:\s\)\s*\zs' .. \ '\<\%(if\|for\|while\|until\|case\|unless\|begin\):\@!\>' -" Def without an end clause: def method_call(...) = -let s:ruby_endless_def = '\ +var ruby_endless_def = '\' -" Regex that defines the start-match for the 'end' keyword. -"let s:end_start_regex = '\%(^\|[^.]\)\<\%(module\|class\|def\|if\|for\|while\|until\|case\|unless\|begin\|do\)\>' -" TODO: the do here should be restricted somewhat (only at end of line)? -let s:end_start_regex = - \ '\C\%(^\s*\|[=,*/%+\-|;{]\|<<\|>>\|:\s\)\s*\zs' . - \ '\<\%(module\|class\|if\|for\|while\|until\|case\|unless\|begin' . - \ '\|\%(\K\k*[!?]\?\s\+\)\=def\):\@!\>' . +# Regex that defines the start-match for the 'end' keyword. +# let end_start_regex = '\%(^\|[^.]\)\<\%(module\|class\|def\|if\|for\|while\|until\|case\|unless\|begin\|do\)\>' +# TODO: the do here should be restricted somewhat (only at end of line)? +var end_start_regex = + \ '\C\%(^\s*\|[=,*/%+\-|;{]\|<<\|>>\|:\s\)\s*\zs' .. + \ '\<\%(module\|class\|if\|for\|while\|until\|case\|unless\|begin' .. + \ '\|\%(\K\k*[!?]\?\s\+\)\=def\):\@!\>' .. \ '\|\%(^\|[^.:@$]\)\@<=\' -" Regex that defines the middle-match for the 'end' keyword. -let s:end_middle_regex = '\<\%(ensure\|else\|\%(\%(^\|;\)\s*\)\@<=\\|when\|elsif\):\@!\>' +# Regex that defines the middle-match for the 'end' keyword. +var end_middle_regex = '\<\%(ensure\|else\|\%(\%(^\|;\)\s*\)\@<=\\|when\|elsif\):\@!\>' -" Regex that defines the end-match for the 'end' keyword. -let s:end_end_regex = '\%(^\|[^.:@$]\)\@<=\' +# Regex that defines the end-match for the 'end' keyword. +var end_end_regex = '\%(^\|[^.:@$]\)\@<=\' -" Expression used for searchpair() call for finding a match for an 'end' keyword. -function! s:EndSkipExpr() - if eval(s:skip_expr) +# Expression used for searchpair() call for finding a match for an 'end' keyword. +def EndSkipExpr(): bool + if eval(skip_expr) return 1 elseif expand('') == 'do' \ && getline(".") =~ '^\s*\<\(while\|until\|for\):\@!\>' return 1 - elseif getline('.') =~ s:ruby_endless_def + elseif getline('.') =~ ruby_endless_def return 1 elseif getline('.') =~ '\>\|:\s\)\s*\zs' . +# Regex that defines continuable keywords +var continuable_regex = + \ '\C\%(^\s*\|[=,*/%+\-|;{]\|<<\|>>\|:\s\)\s*\zs' .. \ '\<\%(if\|for\|while\|until\|unless\):\@!\>' -" Regex that defines bracket continuations -let s:bracket_continuation_regex = '%\@\|%\@= 0 -" Decho "Match: ".callback_name." indent=".indent." info=".string(indent_info) - return indent - endif - endfor - - " 2.3. Work on the previous line. {{{2 - " ------------------------------- - - " Special case: we don't need the real s:PrevNonBlankNonString for an empty - " line inside a string. And that call can be quite expensive in that - " particular situation. - let indent_callback_names = [ - \ 's:EmptyInsideString', - \ ] - - for callback_name in indent_callback_names -" Decho "Running: ".callback_name - let indent = call(function(callback_name), [indent_info]) - - if indent >= 0 -" Decho "Match: ".callback_name." indent=".indent." info=".string(indent_info) - return indent - endif - endfor - - " Previous line number - let indent_info.plnum = s:PrevNonBlankNonString(indent_info.clnum - 1) - let indent_info.pline = getline(indent_info.plnum) - - let indent_callback_names = [ - \ 's:StartOfFile', - \ 's:AfterAccessModifier', - \ 's:ContinuedLine', - \ 's:AfterBlockOpening', - \ 's:AfterHangingSplat', - \ 's:AfterUnbalancedBracket', - \ 's:AfterLeadingOperator', - \ 's:AfterEndKeyword', - \ 's:AfterIndentKeyword', - \ ] +var block_continuation_regex = '^\s*[^])}\t ].*' .. block_regex - for callback_name in indent_callback_names -" Decho "Running: ".callback_name - let indent = call(function(callback_name), [indent_info]) - - if indent >= 0 -" Decho "Match: ".callback_name." indent=".indent." info=".string(indent_info) - return indent - endif - endfor +# Regex that describes a leading operator (only a method call's dot for now) +var leading_operator_regex = '^\s*\%(&\=\.\)' - " 2.4. Work on the MSL line. {{{2 - " -------------------------- - let indent_callback_names = [ - \ 's:PreviousNotMSL', - \ 's:IndentingKeywordInMSL', - \ 's:ContinuedHangingOperator', - \ ] - - " Most Significant line based on the previous one -- in case it's a - " continuation of something above - let indent_info.plnum_msl = s:GetMSL(indent_info.plnum) - - for callback_name in indent_callback_names -" Decho "Running: ".callback_name - let indent = call(function(callback_name), [indent_info]) - - if indent >= 0 -" Decho "Match: ".callback_name." indent=".indent." info=".string(indent_info) - return indent - endif - endfor - - " }}}2 - - " By default, just return the previous line's indent -" Decho "Default case matched" - return indent(indent_info.plnum) -endfunction +# 3. Indenting Logic Callbacks {{{1 +# ============================ -" 3. Indenting Logic Callbacks {{{1 -" ============================ +def AccessModifier(cline_info: dict): number + var info = cline_info -function! s:AccessModifier(cline_info) abort - let info = a:cline_info - - " If this line is an access modifier keyword, align according to the closest - " class declaration. + # If this line is an access modifier keyword, align according to the closest + # class declaration. if g:ruby_indent_access_modifier_style == 'indent' - if s:Match(info.clnum, s:access_modifier_regex) - let class_lnum = s:FindContainingClass() + if Match(info.clnum, access_modifier_regex) + var class_lnum = FindContainingClass() if class_lnum > 0 return indent(class_lnum) + info.sw endif endif elseif g:ruby_indent_access_modifier_style == 'outdent' - if s:Match(info.clnum, s:access_modifier_regex) - let class_lnum = s:FindContainingClass() + if Match(info.clnum, access_modifier_regex) + var class_lnum = FindContainingClass() if class_lnum > 0 return indent(class_lnum) endif @@ -328,32 +205,33 @@ function! s:AccessModifier(cline_info) abort endif return -1 -endfunction +enddef -function! s:ClosingBracketOnEmptyLine(cline_info) abort - let info = a:cline_info +def ClosingBracketOnEmptyLine(cline_info: dict): number + var info = cline_info - " If we got a closing bracket on an empty line, find its match and indent - " according to it. For parentheses we indent to its column - 1, for the - " others we indent to the containing line's MSL's level. Return -1 if fail. - let col = matchend(info.cline, '^\s*[]})]') + # If we got a closing bracket on an empty line, find its match and indent + # according to it. For parentheses we indent to its column - 1, for the + # others we indent to the containing line's MSL's level. Return -1 if fail. + var col = matchend(info.cline, '^\s*[]})]') - if col > 0 && !s:IsInStringOrComment(info.clnum, col) + if col > 0 && !IsInStringOrComment(info.clnum, col) call cursor(info.clnum, col) - let closing_bracket = info.cline[col - 1] - let bracket_pair = strpart('(){}[]', stridx(')}]', closing_bracket) * 2, 2) + var closing_bracket = info.cline[col - 1] + var bracket_pair = strpart('(){}[]', stridx(')}]', closing_bracket) * 2, 2) + var ind = -1 - if searchpair(escape(bracket_pair[0], '\['), '', bracket_pair[1], 'bW', s:skip_expr) > 0 + if searchpair(escape(bracket_pair[0], '\['), '', bracket_pair[1], 'bW', skip_expr) > 0 if closing_bracket == ')' && col('.') != col('$') - 1 if g:ruby_indent_hanging_elements - let ind = virtcol('.') - 1 + ind = virtcol('.') - 1 else - let ind = indent(line('.')) + ind = indent(line('.')) end elseif g:ruby_indent_block_style == 'do' - let ind = indent(line('.')) - else " g:ruby_indent_block_style == 'expression' - let ind = indent(s:GetMSL(line('.'))) + ind = indent(line('.')) + else # g:ruby_indent_block_style == 'expression' + ind = indent(GetMSL(line('.'))) endif endif @@ -361,178 +239,182 @@ function! s:ClosingBracketOnEmptyLine(cline_info) abort endif return -1 -endfunction +enddef -function! s:BlockComment(cline_info) abort - " If we have a =begin or =end set indent to first column. - if match(a:cline_info.cline, '^\s*\%(=begin\|=end\)$') != -1 +def BlockComment(cline_info: dict): number + # If we have a =begin or =end set indent to first column. + if match(cline_info.cline, '^\s*\%(=begin\|=end\)$') != -1 return 0 endif return -1 -endfunction +enddef -function! s:DeindentingKeyword(cline_info) abort - let info = a:cline_info +def DeindentingKeyword(cline_info: dict): number + var info = cline_info - " If we have a deindenting keyword, find its match and indent to its level. - " TODO: this is messy - if s:Match(info.clnum, s:ruby_deindent_keywords) + # If we have a deindenting keyword, find its match and indent to its level. + # TODO: this is messy + if Match(info.clnum, ruby_deindent_keywords) + var ind = -1 call cursor(info.clnum, 1) - if searchpair(s:end_start_regex, s:end_middle_regex, s:end_end_regex, 'bW', - \ s:end_skip_expr) > 0 - let msl = s:GetMSL(line('.')) - let line = getline(line('.')) + if searchpair(end_start_regex, end_middle_regex, end_end_regex, 'bW', + \ EndSkipExpr) > 0 + var msl = GetMSL(line('.')) + var line = getline(line('.')) - if s:IsAssignment(line, col('.')) && + if IsAssignment(line, col('.')) && \ strpart(line, col('.') - 1, 2) !~ 'do' - " assignment to case/begin/etc, on the same line + # assignment to case/begin/etc, on the same line if g:ruby_indent_assignment_style == 'hanging' - " hanging indent - let ind = virtcol('.') - 1 + # hanging indent + ind = virtcol('.') - 1 else - " align with variable - let ind = indent(line('.')) + # align with variable + ind = indent(line('.')) endif elseif g:ruby_indent_block_style == 'do' - " align to line of the "do", not to the MSL - let ind = indent(line('.')) + # align to line of the "do", not to the MSL + ind = indent(line('.')) elseif getline(msl) =~ '=\s*\(#.*\)\=$' - " in the case of assignment to the MSL, align to the starting line, - " not to the MSL - let ind = indent(line('.')) + # in the case of assignment to the MSL, align to the starting line, + # not to the MSL + ind = indent(line('.')) else - " align to the MSL - let ind = indent(msl) + # align to the MSL + ind = indent(msl) endif endif return ind endif return -1 -endfunction +enddef -function! s:MultilineStringOrLineComment(cline_info) abort - let info = a:cline_info +def MultilineStringOrLineComment(cline_info: dict): number + var info = cline_info - " If we are in a multi-line string or line-comment, don't do anything to it. - if s:IsInStringOrDocumentation(info.clnum, matchend(info.cline, '^\s*') + 1) + # If we are in a multi-line string or line-comment, don't do anything to it. + if IsInStringOrDocumentation(info.clnum, matchend(info.cline, '^\s*') + 1) return indent(info.clnum) endif return -1 -endfunction +enddef -function! s:ClosingHeredocDelimiter(cline_info) abort - let info = a:cline_info +def ClosingHeredocDelimiter(cline_info: dict): number + var info = cline_info - " If we are at the closing delimiter of a "<<" heredoc-style string, set the - " indent to 0. + # If we are at the closing delimiter of a "<<" heredoc-style string, set the + # indent to 0. if info.cline =~ '^\k\+\s*$' - \ && s:IsInStringDelimiter(info.clnum, 1) - \ && search('\V<<'.info.cline, 'nbW') > 0 + \ && IsInStringDelimiter(info.clnum, 1) + \ && search('\V<<' .. info.cline, 'nbW') > 0 return 0 endif return -1 -endfunction +enddef -function! s:LeadingOperator(cline_info) abort - " If the current line starts with a leading operator, add a level of indent. - if s:Match(a:cline_info.clnum, s:leading_operator_regex) - return indent(s:GetMSL(a:cline_info.clnum)) + a:cline_info.sw +def LeadingOperator(cline_info: dict): number + # If the current line starts with a leading operator, add a level of indent. + if Match(cline_info.clnum, leading_operator_regex) + return indent(GetMSL(cline_info.clnum)) + cline_info.sw endif return -1 -endfunction +enddef -function! s:EmptyInsideString(pline_info) abort - " If the line is empty and inside a string (the previous line is a string, - " too), use the previous line's indent - let info = a:pline_info +def EmptyInsideString(pline_info: dict): number + # If the line is empty and inside a string (the previous line is a string, + # too), use the previous line's indent + var info = pline_info - let plnum = prevnonblank(info.clnum - 1) - let pline = getline(plnum) + var plnum = prevnonblank(info.clnum - 1) + var pline = getline(plnum) if info.cline =~ '^\s*$' - \ && s:IsInStringOrComment(plnum, 1) - \ && s:IsInStringOrComment(plnum, strlen(pline)) + \ && IsInStringOrComment(plnum, 1) + \ && IsInStringOrComment(plnum, strlen(pline)) return indent(plnum) endif return -1 -endfunction +enddef -function! s:StartOfFile(pline_info) abort - " At the start of the file use zero indent. - if a:pline_info.plnum == 0 +def StartOfFile(pline_info: dict): number + # At the start of the file use zero indent. + if pline_info.plnum == 0 return 0 endif return -1 -endfunction +enddef -function! s:AfterAccessModifier(pline_info) abort - let info = a:pline_info +def AfterAccessModifier(pline_info: dict): number + var info = pline_info if g:ruby_indent_access_modifier_style == 'indent' - " If the previous line was a private/protected keyword, add a - " level of indent. - if s:Match(info.plnum, s:indent_access_modifier_regex) + # If the previous line was a private/protected keyword, add a + # level of indent. + if Match(info.plnum, indent_access_modifier_regex) return indent(info.plnum) + info.sw endif elseif g:ruby_indent_access_modifier_style == 'outdent' - " If the previous line was a private/protected/public keyword, add - " a level of indent, since the keyword has been out-dented. - if s:Match(info.plnum, s:access_modifier_regex) + # If the previous line was a private/protected/public keyword, add + # a level of indent, since the keyword has been out-dented. + if Match(info.plnum, access_modifier_regex) return indent(info.plnum) + info.sw endif endif return -1 -endfunction - -" Example: -" -" if foo || bar || -" baz || bing -" puts "foo" -" end -" -function! s:ContinuedLine(pline_info) abort - let info = a:pline_info - - let col = s:Match(info.plnum, s:ruby_indent_keywords) - if s:Match(info.plnum, s:continuable_regex) && - \ s:Match(info.plnum, s:continuation_regex) - if col > 0 && s:IsAssignment(info.pline, col) +enddef + +# Example: +# +# if foo || bar || +# baz || bing +# puts "foo" +# end +# +def ContinuedLine(pline_info: dict): number + var info = pline_info + + var col = Match(info.plnum, ruby_indent_keywords) + if Match(info.plnum, continuable_regex) && + \ Match(info.plnum, continuation_regex) + var ind = -1 + if col > 0 && IsAssignment(info.pline, col) if g:ruby_indent_assignment_style == 'hanging' - " hanging indent - let ind = col - 1 + # hanging indent + ind = col - 1 else - " align with variable - let ind = indent(info.plnum) + # align with variable + ind = indent(info.plnum) endif else - let ind = indent(s:GetMSL(info.plnum)) + ind = indent(GetMSL(info.plnum)) endif return ind + info.sw + info.sw endif return -1 -endfunction +enddef + +def AfterBlockOpening(pline_info: dict): number + var info = pline_info -function! s:AfterBlockOpening(pline_info) abort - let info = a:pline_info + # If the previous line ended with a block opening, add a level of indent. + if Match(info.plnum, block_regex) + var ind = -1 - " If the previous line ended with a block opening, add a level of indent. - if s:Match(info.plnum, s:block_regex) if g:ruby_indent_block_style == 'do' - " don't align to the msl, align to the "do" - let ind = indent(info.plnum) + info.sw + # don't align to the msl, align to the "do" + ind = indent(info.plnum) + info.sw else - let plnum_msl = s:GetMSL(info.plnum) + var plnum_msl = GetMSL(info.plnum) if getline(plnum_msl) =~ '=\s*\(#.*\)\=$' - " in the case of assignment to the msl, align to the starting line, - " not to the msl - let ind = indent(info.plnum) + info.sw + # in the case of assignment to the msl, align to the starting line, + # not to the msl + ind = indent(info.plnum) + info.sw else - let ind = indent(plnum_msl) + info.sw + ind = indent(plnum_msl) + info.sw endif endif @@ -540,50 +422,52 @@ function! s:AfterBlockOpening(pline_info) abort endif return -1 -endfunction +enddef -function! s:AfterLeadingOperator(pline_info) abort - " If the previous line started with a leading operator, use its MSL's level - " of indent - if s:Match(a:pline_info.plnum, s:leading_operator_regex) - return indent(s:GetMSL(a:pline_info.plnum)) +def AfterLeadingOperator(pline_info: dict): number + # If the previous line started with a leading operator, use its MSL's level + # of indent + if Match(pline_info.plnum, leading_operator_regex) + return indent(GetMSL(pline_info.plnum)) endif return -1 -endfunction +enddef -function! s:AfterHangingSplat(pline_info) abort - let info = a:pline_info +def AfterHangingSplat(pline_info: dict): number + var info = pline_info - " If the previous line ended with the "*" of a splat, add a level of indent - if info.pline =~ s:splat_regex + # If the previous line ended with the "*" of a splat, add a level of indent + if info.pline =~ splat_regex return indent(info.plnum) + info.sw endif return -1 -endfunction +enddef -function! s:AfterUnbalancedBracket(pline_info) abort - let info = a:pline_info +def AfterUnbalancedBracket(pline_info: dict): number + var info = pline_info - " If the previous line contained unclosed opening brackets and we are still - " in them, find the rightmost one and add indent depending on the bracket - " type. - " - " If it contained hanging closing brackets, find the rightmost one, find its - " match and indent according to that. + # If the previous line contained unclosed opening brackets and we are still + # in them, find the rightmost one and add indent depending on the bracket + # type. + # + # If it contained hanging closing brackets, find the rightmost one, find its + # match and indent according to that. if info.pline =~ '[[({]' || info.pline =~ '[])}]\s*\%(#.*\)\=$' - let [opening, closing] = s:ExtraBrackets(info.plnum) + var brackets = ExtraBrackets(info.plnum) + var opening = brackets[0] + var closing = brackets[1] if opening.pos != -1 if !g:ruby_indent_hanging_elements return indent(info.plnum) + info.sw - elseif opening.type == '(' && searchpair('(', '', ')', 'bW', s:skip_expr) > 0 + elseif opening.type == '(' && searchpair('(', '', ')', 'bW', skip_expr) > 0 if col('.') + 1 == col('$') return indent(info.plnum) + info.sw else return virtcol('.') endif else - let nonspace = matchend(info.pline, '\S', opening.pos + 1) - 1 + var nonspace = matchend(info.pline, '\S', opening.pos + 1) - 1 return nonspace > 0 ? nonspace : indent(info.plnum) + info.sw endif elseif closing.pos != -1 @@ -591,14 +475,14 @@ function! s:AfterUnbalancedBracket(pline_info) abort normal! % if strpart(info.pline, closing.pos) =~ '^)\s*=' - " special case: the closing `) =` of an endless def - return indent(s:GetMSL(line('.'))) + # special case: the closing `) =` of an endless def + return indent(GetMSL(line('.'))) endif - if s:Match(line('.'), s:ruby_indent_keywords) + if Match(line('.'), ruby_indent_keywords) return indent('.') + info.sw else - return indent(s:GetMSL(line('.'))) + return indent(GetMSL(line('.'))) endif else call cursor(info.clnum, info.col) @@ -606,300 +490,302 @@ function! s:AfterUnbalancedBracket(pline_info) abort endif return -1 -endfunction +enddef -function! s:AfterEndKeyword(pline_info) abort - let info = a:pline_info - " If the previous line ended with an "end", match that "end"s beginning's - " indent. - let col = s:Match(info.plnum, '\%(^\|[^.:@$]\)\\s*\%(#.*\)\=$') +def AfterEndKeyword(pline_info: dict): number + var info = pline_info + # If the previous line ended with an "end", match that "end"s beginning's + # indent. + var col = Match(info.plnum, '\%(^\|[^.:@$]\)\\s*\%(#.*\)\=$') if col > 0 call cursor(info.plnum, col) - if searchpair(s:end_start_regex, '', s:end_end_regex, 'bW', - \ s:end_skip_expr) > 0 - let n = line('.') - let ind = indent('.') - let msl = s:GetMSL(n) + if searchpair(end_start_regex, '', end_end_regex, 'bW', + \ EndSkipExpr) > 0 + var n = line('.') + var ind = indent('.') + var msl = GetMSL(n) if msl != n - let ind = indent(msl) + ind = indent(msl) end return ind endif end return -1 -endfunction +enddef -function! s:AfterIndentKeyword(pline_info) abort - let info = a:pline_info - let col = s:Match(info.plnum, s:ruby_indent_keywords) +def AfterIndentKeyword(pline_info: dict): number + var info = pline_info + var col = Match(info.plnum, ruby_indent_keywords) - if col > 0 && s:Match(info.plnum, s:ruby_endless_def) <= 0 + if col > 0 && Match(info.plnum, ruby_endless_def) <= 0 call cursor(info.plnum, col) - let ind = virtcol('.') - 1 + info.sw - " TODO: make this better (we need to count them) (or, if a searchpair - " fails, we know that something is lacking an end and thus we indent a - " level - if s:Match(info.plnum, s:end_end_regex) - let ind = indent('.') - elseif s:IsAssignment(info.pline, col) + var ind = virtcol('.') - 1 + info.sw + # TODO: make this better (we need to count them) (or, if a searchpair + # fails, we know that something is lacking an end and thus we indent a + # level + if Match(info.plnum, end_end_regex) + ind = indent('.') + elseif IsAssignment(info.pline, col) if g:ruby_indent_assignment_style == 'hanging' - " hanging indent - let ind = col + info.sw - 1 + # hanging indent + ind = col + info.sw - 1 else - " align with variable - let ind = indent(info.plnum) + info.sw + # align with variable + ind = indent(info.plnum) + info.sw endif endif return ind endif return -1 -endfunction +enddef -function! s:PreviousNotMSL(msl_info) abort - let info = a:msl_info +def PreviousNotMSL(msl_info: dict): number + var info = msl_info - " If the previous line wasn't a MSL + # If the previous line wasn't a MSL if info.plnum != info.plnum_msl - " If previous line ends bracket and begins non-bracket continuation decrease indent by 1. - if s:Match(info.plnum, s:bracket_switch_continuation_regex) - " TODO (2016-10-07) Wrong/unused? How could it be "1"? + # If previous line ends bracket and begins non-bracket continuation decrease indent by 1. + if Match(info.plnum, bracket_switch_continuation_regex) + # TODO (2016-10-07) Wrong/unused? How could it be "1"? return indent(info.plnum) - 1 - " If previous line is a continuation return its indent. - elseif s:Match(info.plnum, s:non_bracket_continuation_regex) + # If previous line is a continuation return its indent. + elseif Match(info.plnum, non_bracket_continuation_regex) return indent(info.plnum) endif endif return -1 -endfunction - -function! s:IndentingKeywordInMSL(msl_info) abort - let info = a:msl_info - " If the MSL line had an indenting keyword in it, add a level of indent. - " TODO: this does not take into account contrived things such as - " module Foo; class Bar; end - let col = s:Match(info.plnum_msl, s:ruby_indent_keywords) - if col > 0 && s:Match(info.plnum_msl, s:ruby_endless_def) <= 0 - let ind = indent(info.plnum_msl) + info.sw - if s:Match(info.plnum_msl, s:end_end_regex) - let ind = ind - info.sw - elseif s:IsAssignment(getline(info.plnum_msl), col) +enddef + +def IndentingKeywordInMSL(msl_info: dict): number + var info = msl_info + # If the MSL line had an indenting keyword in it, add a level of indent. + # TODO: this does not take into account contrived things such as + # module Foo; class Bar; end + var col = Match(info.plnum_msl, ruby_indent_keywords) + if col > 0 && Match(info.plnum_msl, ruby_endless_def) <= 0 + var ind = indent(info.plnum_msl) + info.sw + if Match(info.plnum_msl, end_end_regex) + var ind = ind - info.sw + elseif IsAssignment(getline(info.plnum_msl), col) if g:ruby_indent_assignment_style == 'hanging' - " hanging indent - let ind = col + info.sw - 1 + # hanging indent + var ind = col + info.sw - 1 else - " align with variable - let ind = indent(info.plnum_msl) + info.sw + # align with variable + var ind = indent(info.plnum_msl) + info.sw endif endif return ind endif return -1 -endfunction +enddef -function! s:ContinuedHangingOperator(msl_info) abort - let info = a:msl_info +def ContinuedHangingOperator(msl_info: dict): number + var info = msl_info - " If the previous line ended with [*+/.,-=], but wasn't a block ending or a - " closing bracket, indent one extra level. - if s:Match(info.plnum_msl, s:non_bracket_continuation_regex) && !s:Match(info.plnum_msl, '^\s*\([\])}]\|end\)') + # If the previous line ended with [*+/.,-=], but wasn't a block ending or a + # closing bracket, indent one extra level. + if Match(info.plnum_msl, non_bracket_continuation_regex) && !Match(info.plnum_msl, '^\s*\([\])}]\|end\)') if info.plnum_msl == info.plnum - let ind = indent(info.plnum_msl) + info.sw + var ind = indent(info.plnum_msl) + info.sw else - let ind = indent(info.plnum_msl) + var ind = indent(info.plnum_msl) endif return ind endif return -1 -endfunction - -" 4. Auxiliary Functions {{{1 -" ====================== - -function! s:IsInRubyGroup(groups, lnum, col) abort - let ids = map(copy(a:groups), 'hlID("ruby".v:val)') - return index(ids, synID(a:lnum, a:col, 1)) >= 0 -endfunction - -" Check if the character at lnum:col is inside a string, comment, or is ascii. -function! s:IsInStringOrComment(lnum, col) abort - return s:IsInRubyGroup(s:syng_strcom, a:lnum, a:col) -endfunction - -" Check if the character at lnum:col is inside a string. -function! s:IsInString(lnum, col) abort - return s:IsInRubyGroup(s:syng_string, a:lnum, a:col) -endfunction - -" Check if the character at lnum:col is inside a string or documentation. -function! s:IsInStringOrDocumentation(lnum, col) abort - return s:IsInRubyGroup(s:syng_stringdoc, a:lnum, a:col) -endfunction - -" Check if the character at lnum:col is inside a string delimiter -function! s:IsInStringDelimiter(lnum, col) abort - return s:IsInRubyGroup( +enddef + +# 4. Auxiliary Functions {{{1 +# ====================== + +def IsInRubyGroup(groups: list, lnum: number, col: number): bool + var ids = mapnew(copy(groups), 'hlID("ruby" .. v:val)') + return index(ids, synID(lnum, col, 1)) >= 0 +enddef + +# Check if the character at lnum:col is inside a string, comment, or is ascii. +def IsInStringOrComment(lnum: number, col: number): bool + return IsInRubyGroup(syng_strcom, lnum, col) +enddef + +# Check if the character at lnum:col is inside a string. +def IsInString(lnum: number, col: number): bool + return IsInRubyGroup(syng_string, lnum, col) +enddef + +# Check if the character at lnum:col is inside a string or documentation. +def IsInStringOrDocumentation(lnum: number, col: number): bool + return IsInRubyGroup(syng_stringdoc, lnum, col) +enddef + +# Check if the character at lnum:col is inside a string delimiter +def IsInStringDelimiter(lnum: number, col: number): bool + return IsInRubyGroup( \ ['HeredocDelimiter', 'PercentStringDelimiter', 'StringDelimiter'], - \ a:lnum, a:col + \ lnum, col \ ) -endfunction +enddef -function! s:IsAssignment(str, pos) abort - return strpart(a:str, 0, a:pos - 1) =~ '=\s*$' -endfunction +def IsAssignment(str: string, pos: number): bool + return strpart(str, 0, pos - 1) =~ '=\s*$' +enddef -" Find line above 'lnum' that isn't empty, in a comment, or in a string. -function! s:PrevNonBlankNonString(lnum) abort - let in_block = 0 - let lnum = prevnonblank(a:lnum) +# Find line above 'lnum' that isn't empty, in a comment, or in a string. +def PrevNonBlankNonString(a_lnum: number): number + var in_block = 0 + var lnum = prevnonblank(a_lnum) while lnum > 0 - " Go in and out of blocks comments as necessary. - " If the line isn't empty (with opt. comment) or in a string, end search. - let line = getline(lnum) + # Go in and out of blocks comments as necessary. + # If the line isn't empty (with opt. comment) or in a string, end search. + var line = getline(lnum) if line =~ '^=begin' if in_block - let in_block = 0 + in_block = 0 else break endif elseif !in_block && line =~ '^=end' - let in_block = 1 - elseif !in_block && line !~ '^\s*#.*$' && !(s:IsInStringOrComment(lnum, 1) - \ && s:IsInStringOrComment(lnum, strlen(line))) + in_block = 1 + elseif !in_block && line !~ '^\s*#.*$' && !(IsInStringOrComment(lnum, 1) + \ && IsInStringOrComment(lnum, strlen(line))) break endif - let lnum = prevnonblank(lnum - 1) + lnum = prevnonblank(lnum - 1) endwhile return lnum -endfunction +enddef -" Find line above 'lnum' that started the continuation 'lnum' may be part of. -function! s:GetMSL(lnum) abort - " Start on the line we're at and use its indent. - let msl = a:lnum - let lnum = s:PrevNonBlankNonString(a:lnum - 1) +# Find line above 'lnum' that started the continuation 'lnum' may be part of. +def GetMSL(a_lnum: number): number + # Start on the line we're at and use its indent. + var msl = a_lnum + var lnum = PrevNonBlankNonString(a_lnum - 1) while lnum > 0 - " If we have a continuation line, or we're in a string, use line as MSL. - " Otherwise, terminate search as we have found our MSL already. - let line = getline(lnum) - - if !s:Match(msl, s:backslash_continuation_regex) && - \ s:Match(lnum, s:backslash_continuation_regex) - " If the current line doesn't end in a backslash, but the previous one - " does, look for that line's msl - " - " Example: - " foo = "bar" \ - " "baz" - " - let msl = lnum - elseif s:Match(msl, s:leading_operator_regex) - " If the current line starts with a leading operator, keep its indent - " and keep looking for an MSL. - let msl = lnum - elseif s:Match(lnum, s:splat_regex) - " If the above line looks like the "*" of a splat, use the current one's - " indentation. - " - " Example: - " Hash[* - " method_call do - " something - " + # If we have a continuation line, or we're in a string, use line as MSL. + # Otherwise, terminate search as we have found our MSL already. + var line = getline(lnum) + + # TODO number as boolean + + if !Match(msl, backslash_continuation_regex) && + \ Match(lnum, backslash_continuation_regex) + # If the current line doesn't end in a backslash, but the previous one + # does, look for that line's msl + # + # Example: + # foo = "bar" \ + # "baz" + # + msl = lnum + elseif Match(msl, leading_operator_regex) + # If the current line starts with a leading operator, keep its indent + # and keep looking for an MSL. + msl = lnum + elseif Match(lnum, splat_regex) + # If the above line looks like the "*" of a splat, use the current one's + # indentation. + # + # Example: + # Hash[* + # method_call do + # something + # return msl - elseif s:Match(lnum, s:non_bracket_continuation_regex) && - \ s:Match(msl, s:non_bracket_continuation_regex) - " If the current line is a non-bracket continuation and so is the - " previous one, keep its indent and continue looking for an MSL. - " - " Example: - " method_call one, - " two, - " three - " - let msl = lnum - elseif s:Match(lnum, s:dot_continuation_regex) && - \ (s:Match(msl, s:bracket_continuation_regex) || s:Match(msl, s:block_continuation_regex)) - " If the current line is a bracket continuation or a block-starter, but - " the previous is a dot, keep going to see if the previous line is the - " start of another continuation. - " - " Example: - " parent. - " method_call { - " three - " - let msl = lnum - elseif s:Match(lnum, s:non_bracket_continuation_regex) && - \ (s:Match(msl, s:bracket_continuation_regex) || s:Match(msl, s:block_continuation_regex)) - " If the current line is a bracket continuation or a block-starter, but - " the previous is a non-bracket one, respect the previous' indentation, - " and stop here. - " - " Example: - " method_call one, - " two { - " three - " + elseif Match(lnum, non_bracket_continuation_regex) && + \ Match(msl, non_bracket_continuation_regex) + # If the current line is a non-bracket continuation and so is the + # previous one, keep its indent and continue looking for an MSL. + # + # Example: + # method_call one, + # two, + # three + # + msl = lnum + elseif Match(lnum, dot_continuation_regex) && + \ (Match(msl, bracket_continuation_regex) || Match(msl, block_continuation_regex)) + # If the current line is a bracket continuation or a block-starter, but + # the previous is a dot, keep going to see if the previous line is the + # start of another continuation. + # + # Example: + # parent. + # method_call { + # three + # + msl = lnum + elseif Match(lnum, non_bracket_continuation_regex) && + \ (Match(msl, bracket_continuation_regex) || Match(msl, block_continuation_regex)) + # If the current line is a bracket continuation or a block-starter, but + # the previous is a non-bracket one, respect the previous' indentation, + # and stop here. + # + # Example: + # method_call one, + # two { + # three + # return lnum - elseif s:Match(lnum, s:bracket_continuation_regex) && - \ (s:Match(msl, s:bracket_continuation_regex) || s:Match(msl, s:block_continuation_regex)) - " If both lines are bracket continuations (the current may also be a - " block-starter), use the current one's and stop here - " - " Example: - " method_call( - " other_method_call( - " foo + elseif Match(lnum, bracket_continuation_regex) && + \ (Match(msl, bracket_continuation_regex) || Match(msl, block_continuation_regex)) + # If both lines are bracket continuations (the current may also be a + # block-starter), use the current one's and stop here + # + # Example: + # method_call( + # other_method_call( + # foo return msl - elseif s:Match(lnum, s:block_regex) && - \ !s:Match(msl, s:continuation_regex) && - \ !s:Match(msl, s:block_continuation_regex) - " If the previous line is a block-starter and the current one is - " mostly ordinary, use the current one as the MSL. - " - " Example: - " method_call do - " something - " something_else + elseif Match(lnum, block_regex) && + \ !Match(msl, continuation_regex) && + \ !Match(msl, block_continuation_regex) + # If the previous line is a block-starter and the current one is + # mostly ordinary, use the current one as the MSL. + # + # Example: + # method_call do + # something + # something_else return msl else - let col = match(line, s:continuation_regex) + 1 - if (col > 0 && !s:IsInStringOrComment(lnum, col)) - \ || s:IsInString(lnum, strlen(line)) - let msl = lnum + var col = match(line, continuation_regex) + 1 + if (col > 0 && !IsInStringOrComment(lnum, col)) + \ || IsInString(lnum, strlen(line)) + msl = lnum else break endif endif - let lnum = s:PrevNonBlankNonString(lnum - 1) + lnum = PrevNonBlankNonString(lnum - 1) endwhile return msl -endfunction +enddef -" Check if line 'lnum' has more opening brackets than closing ones. -function! s:ExtraBrackets(lnum) abort - let opening = {'parentheses': [], 'braces': [], 'brackets': []} - let closing = {'parentheses': [], 'braces': [], 'brackets': []} +# Check if line 'lnum' has more opening brackets than closing ones. +def ExtraBrackets(lnum: number): list> + var opening: dict>> = {'parentheses': [], 'braces': [], 'brackets': []} + var closing: dict>> = {'parentheses': [], 'braces': [], 'brackets': []} - let line = getline(a:lnum) - let pos = match(line, '[][(){}]', 0) + var line = getline(lnum) + var pos = match(line, '[][(){}]', 0) - " Save any encountered opening brackets, and remove them once a matching - " closing one has been found. If a closing bracket shows up that doesn't - " close anything, save it for later. + # Save any encountered opening brackets, and remove them once a matching + # closing one has been found. If a closing bracket shows up that doesn't + # close anything, save it for later. while pos != -1 - if !s:IsInStringOrComment(a:lnum, pos + 1) + if !IsInStringOrComment(lnum, pos + 1) if line[pos] == '(' call add(opening.parentheses, {'type': '(', 'pos': pos}) elseif line[pos] == ')' if empty(opening.parentheses) call add(closing.parentheses, {'type': ')', 'pos': pos}) else - let opening.parentheses = opening.parentheses[0:-2] + opening.parentheses = opening.parentheses[0 : -2] endif elseif line[pos] == '{' call add(opening.braces, {'type': '{', 'pos': pos}) @@ -907,7 +793,7 @@ function! s:ExtraBrackets(lnum) abort if empty(opening.braces) call add(closing.braces, {'type': '}', 'pos': pos}) else - let opening.braces = opening.braces[0:-2] + opening.braces = opening.braces[0 : -2] endif elseif line[pos] == '[' call add(opening.brackets, {'type': '[', 'pos': pos}) @@ -915,42 +801,42 @@ function! s:ExtraBrackets(lnum) abort if empty(opening.brackets) call add(closing.brackets, {'type': ']', 'pos': pos}) else - let opening.brackets = opening.brackets[0:-2] + opening.brackets = opening.brackets[0 : -2] endif endif endif - let pos = match(line, '[][(){}]', pos + 1) + pos = match(line, '[][(){}]', pos + 1) endwhile - " Find the rightmost brackets, since they're the ones that are important in - " both opening and closing cases - let rightmost_opening = {'type': '(', 'pos': -1} - let rightmost_closing = {'type': ')', 'pos': -1} + # Find the rightmost brackets, since they're the ones that are important in + # both opening and closing cases + var rightmost_opening = {'type': '(', 'pos': -1} + var rightmost_closing = {'type': ')', 'pos': -1} - for opening in opening.parentheses + opening.braces + opening.brackets - if opening.pos > rightmost_opening.pos - let rightmost_opening = opening + for local_opening in opening.parentheses + opening.braces + opening.brackets + if local_opening.pos > rightmost_opening.pos + rightmost_opening = local_opening endif endfor - for closing in closing.parentheses + closing.braces + closing.brackets - if closing.pos > rightmost_closing.pos - let rightmost_closing = closing + for local_closing in closing.parentheses + closing.braces + closing.brackets + if local_closing.pos > rightmost_closing.pos + rightmost_closing = local_closing endif endfor return [rightmost_opening, rightmost_closing] -endfunction +enddef -function! s:Match(lnum, regex) abort - let line = getline(a:lnum) - let offset = match(line, '\C'.a:regex) - let col = offset + 1 +def Match(lnum: number, regex: string): number + var line = getline(lnum) + var offset = match(line, '\C' .. regex) + var col = offset + 1 - while offset > -1 && s:IsInStringOrComment(a:lnum, col) - let offset = match(line, '\C'.a:regex, offset + 1) - let col = offset + 1 + while offset > -1 && IsInStringOrComment(lnum, col) + offset = match(line, '\C' .. regex, offset + 1) + col = offset + 1 endwhile if offset > -1 @@ -958,18 +844,18 @@ function! s:Match(lnum, regex) abort else return 0 endif -endfunction +enddef -" Locates the containing class/module's definition line, ignoring nested classes -" along the way. -" -function! s:FindContainingClass() abort - let saved_position = getpos('.') +# Locates the containing class/module's definition line, ignoring nested classes +# along the way. +# +def FindContainingClass(): number + var saved_position = getpos('.') - while searchpair(s:end_start_regex, s:end_middle_regex, s:end_end_regex, 'bW', - \ s:end_skip_expr) > 0 + while searchpair(end_start_regex, end_middle_regex, end_end_regex, 'bW', + \ EndSkipExpr) > 0 if expand('') =~# '\' - let found_lnum = line('.') + var found_lnum = line('.') call setpos('.', saved_position) return found_lnum endif @@ -977,11 +863,128 @@ function! s:FindContainingClass() abort call setpos('.', saved_position) return 0 -endfunction +enddef + +# }}}1 + +# 2. GetRubyIndent Function {{{1 +# ========================= -" }}}1 +def g:GetRubyIndent(lnum: number): number + # 2.1. Setup {{{2 + # ---------- + + var indent_info = {} + + # The value of a single shift-width + if exists('*shiftwidth') + indent_info.sw = shiftwidth() + else + indent_info.sw = &sw + endif + + # For the current line, use the first argument if given, else v:lnum + indent_info.clnum = lnum + indent_info.cline = getline(indent_info.clnum) + + # Set up variables for restoring position in file. Could use clnum here. + indent_info.col = col('.') + + # 2.2. Work on the current line {{{2 + # ----------------------------- + var indent_callback_names = [ + \ 'AccessModifier', + \ 'ClosingBracketOnEmptyLine', + \ 'BlockComment', + \ 'DeindentingKeyword', + \ 'MultilineStringOrLineComment', + \ 'ClosingHeredocDelimiter', + \ 'LeadingOperator', + \ ] + + for callback_name in indent_callback_names + # Decho "Running: ".callback_name + var indent = call(function(callback_name), [indent_info]) -let &cpo = s:cpo_save -unlet s:cpo_save + if indent >= 0 + # Decho "Match: ".callback_name." indent=".indent." info=".string(indent_info) + return indent + endif + endfor + + # 2.3. Work on the previous line. {{{2 + # ------------------------------- + + # Special case: we don't need the real PrevNonBlankNonString for an empty + # line inside a string. And that call can be quite expensive in that + # particular situation. + indent_callback_names = [ + \ 'EmptyInsideString', + \ ] + + for callback_name in indent_callback_names + # Decho "Running: ".callback_name + var indent = call(function(callback_name), [indent_info]) + + if indent >= 0 + # Decho "Match: ".callback_name." indent=".indent." info=".string(indent_info) + return indent + endif + endfor + + # Previous line number + indent_info.plnum = PrevNonBlankNonString(indent_info.clnum - 1) + indent_info.pline = getline(indent_info.plnum) + + indent_callback_names = [ + \ 'StartOfFile', + \ 'AfterAccessModifier', + \ 'ContinuedLine', + \ 'AfterBlockOpening', + \ 'AfterHangingSplat', + \ 'AfterUnbalancedBracket', + \ 'AfterLeadingOperator', + \ 'AfterEndKeyword', + \ 'AfterIndentKeyword', + \ ] + + for callback_name in indent_callback_names + # Decho "Running: ".callback_name + var indent = call(function(callback_name), [indent_info]) + + if indent >= 0 + # Decho "Match: ".callback_name." indent=".indent." info=".string(indent_info) + return indent + endif + endfor + + # 2.4. Work on the MSL line. {{{2 + # -------------------------- + indent_callback_names = [ + \ 'PreviousNotMSL', + \ 'IndentingKeywordInMSL', + \ 'ContinuedHangingOperator', + \ ] + + # Most Significant line based on the previous one -- in case it's a + # continuation of something above + indent_info.plnum_msl = GetMSL(indent_info.plnum) + + for callback_name in indent_callback_names + # Decho "Running: ".callback_name + var indent = call(function(callback_name), [indent_info]) + + if indent >= 0 + # Decho "Match: ".callback_name." indent=".indent." info=".string(indent_info) + return indent + endif + endfor + + # }}}2 + + # By default, just return the previous line's indent + # Decho "Default case matched" + return indent(indent_info.plnum) +enddef -" vim:set sw=2 sts=2 ts=8 et: +# vim:set sw=2 sts=2 ts=8 et: From 94d0e102536e6521c759f9a0a3e59599257a3b80 Mon Sep 17 00:00:00 2001 From: Andrew Radev Date: Wed, 22 Dec 2021 12:42:50 +0200 Subject: [PATCH 2/5] Fix vim9 issues --- indent/ruby.vim | 64 ++++++++++++++++++++++++++----------------------- 1 file changed, 34 insertions(+), 30 deletions(-) diff --git a/indent/ruby.vim b/indent/ruby.vim index c82333e9..3def26ce 100644 --- a/indent/ruby.vim +++ b/indent/ruby.vim @@ -189,14 +189,14 @@ def AccessModifier(cline_info: dict): number # If this line is an access modifier keyword, align according to the closest # class declaration. if g:ruby_indent_access_modifier_style == 'indent' - if Match(info.clnum, access_modifier_regex) + if IsMatch(info.clnum, access_modifier_regex) var class_lnum = FindContainingClass() if class_lnum > 0 return indent(class_lnum) + info.sw endif endif elseif g:ruby_indent_access_modifier_style == 'outdent' - if Match(info.clnum, access_modifier_regex) + if IsMatch(info.clnum, access_modifier_regex) var class_lnum = FindContainingClass() if class_lnum > 0 return indent(class_lnum) @@ -254,7 +254,7 @@ def DeindentingKeyword(cline_info: dict): number # If we have a deindenting keyword, find its match and indent to its level. # TODO: this is messy - if Match(info.clnum, ruby_deindent_keywords) + if IsMatch(info.clnum, ruby_deindent_keywords) var ind = -1 call cursor(info.clnum, 1) @@ -317,7 +317,7 @@ enddef def LeadingOperator(cline_info: dict): number # If the current line starts with a leading operator, add a level of indent. - if Match(cline_info.clnum, leading_operator_regex) + if IsMatch(cline_info.clnum, leading_operator_regex) return indent(GetMSL(cline_info.clnum)) + cline_info.sw endif return -1 @@ -353,13 +353,13 @@ def AfterAccessModifier(pline_info: dict): number if g:ruby_indent_access_modifier_style == 'indent' # If the previous line was a private/protected keyword, add a # level of indent. - if Match(info.plnum, indent_access_modifier_regex) + if IsMatch(info.plnum, indent_access_modifier_regex) return indent(info.plnum) + info.sw endif elseif g:ruby_indent_access_modifier_style == 'outdent' # If the previous line was a private/protected/public keyword, add # a level of indent, since the keyword has been out-dented. - if Match(info.plnum, access_modifier_regex) + if IsMatch(info.plnum, access_modifier_regex) return indent(info.plnum) + info.sw endif endif @@ -377,7 +377,7 @@ def ContinuedLine(pline_info: dict): number var info = pline_info var col = Match(info.plnum, ruby_indent_keywords) - if Match(info.plnum, continuable_regex) && + if IsMatch(info.plnum, continuable_regex) && \ Match(info.plnum, continuation_regex) var ind = -1 if col > 0 && IsAssignment(info.pline, col) @@ -400,7 +400,7 @@ def AfterBlockOpening(pline_info: dict): number var info = pline_info # If the previous line ended with a block opening, add a level of indent. - if Match(info.plnum, block_regex) + if IsMatch(info.plnum, block_regex) var ind = -1 if g:ruby_indent_block_style == 'do' @@ -427,7 +427,7 @@ enddef def AfterLeadingOperator(pline_info: dict): number # If the previous line started with a leading operator, use its MSL's level # of indent - if Match(pline_info.plnum, leading_operator_regex) + if IsMatch(pline_info.plnum, leading_operator_regex) return indent(GetMSL(pline_info.plnum)) endif return -1 @@ -479,7 +479,7 @@ def AfterUnbalancedBracket(pline_info: dict): number return indent(GetMSL(line('.'))) endif - if Match(line('.'), ruby_indent_keywords) + if IsMatch(line('.'), ruby_indent_keywords) return indent('.') + info.sw else return indent(GetMSL(line('.'))) @@ -523,7 +523,7 @@ def AfterIndentKeyword(pline_info: dict): number # TODO: make this better (we need to count them) (or, if a searchpair # fails, we know that something is lacking an end and thus we indent a # level - if Match(info.plnum, end_end_regex) + if IsMatch(info.plnum, end_end_regex) ind = indent('.') elseif IsAssignment(info.pline, col) if g:ruby_indent_assignment_style == 'hanging' @@ -546,11 +546,11 @@ def PreviousNotMSL(msl_info: dict): number # If the previous line wasn't a MSL if info.plnum != info.plnum_msl # If previous line ends bracket and begins non-bracket continuation decrease indent by 1. - if Match(info.plnum, bracket_switch_continuation_regex) + if IsMatch(info.plnum, bracket_switch_continuation_regex) # TODO (2016-10-07) Wrong/unused? How could it be "1"? return indent(info.plnum) - 1 # If previous line is a continuation return its indent. - elseif Match(info.plnum, non_bracket_continuation_regex) + elseif IsMatch(info.plnum, non_bracket_continuation_regex) return indent(info.plnum) endif endif @@ -566,7 +566,7 @@ def IndentingKeywordInMSL(msl_info: dict): number var col = Match(info.plnum_msl, ruby_indent_keywords) if col > 0 && Match(info.plnum_msl, ruby_endless_def) <= 0 var ind = indent(info.plnum_msl) + info.sw - if Match(info.plnum_msl, end_end_regex) + if IsMatch(info.plnum_msl, end_end_regex) var ind = ind - info.sw elseif IsAssignment(getline(info.plnum_msl), col) if g:ruby_indent_assignment_style == 'hanging' @@ -587,7 +587,7 @@ def ContinuedHangingOperator(msl_info: dict): number # If the previous line ended with [*+/.,-=], but wasn't a block ending or a # closing bracket, indent one extra level. - if Match(info.plnum_msl, non_bracket_continuation_regex) && !Match(info.plnum_msl, '^\s*\([\])}]\|end\)') + if IsMatch(info.plnum_msl, non_bracket_continuation_regex) && !IsMatch(info.plnum_msl, '^\s*\([\])}]\|end\)') if info.plnum_msl == info.plnum var ind = indent(info.plnum_msl) + info.sw else @@ -671,8 +671,8 @@ def GetMSL(a_lnum: number): number # TODO number as boolean - if !Match(msl, backslash_continuation_regex) && - \ Match(lnum, backslash_continuation_regex) + if !IsMatch(msl, backslash_continuation_regex) && + \ IsMatch(lnum, backslash_continuation_regex) # If the current line doesn't end in a backslash, but the previous one # does, look for that line's msl # @@ -681,11 +681,11 @@ def GetMSL(a_lnum: number): number # "baz" # msl = lnum - elseif Match(msl, leading_operator_regex) + elseif IsMatch(msl, leading_operator_regex) # If the current line starts with a leading operator, keep its indent # and keep looking for an MSL. msl = lnum - elseif Match(lnum, splat_regex) + elseif IsMatch(lnum, splat_regex) # If the above line looks like the "*" of a splat, use the current one's # indentation. # @@ -695,8 +695,8 @@ def GetMSL(a_lnum: number): number # something # return msl - elseif Match(lnum, non_bracket_continuation_regex) && - \ Match(msl, non_bracket_continuation_regex) + elseif IsMatch(lnum, non_bracket_continuation_regex) && + \ IsMatch(msl, non_bracket_continuation_regex) # If the current line is a non-bracket continuation and so is the # previous one, keep its indent and continue looking for an MSL. # @@ -706,8 +706,8 @@ def GetMSL(a_lnum: number): number # three # msl = lnum - elseif Match(lnum, dot_continuation_regex) && - \ (Match(msl, bracket_continuation_regex) || Match(msl, block_continuation_regex)) + elseif IsMatch(lnum, dot_continuation_regex) && + \ (IsMatch(msl, bracket_continuation_regex) || IsMatch(msl, block_continuation_regex)) # If the current line is a bracket continuation or a block-starter, but # the previous is a dot, keep going to see if the previous line is the # start of another continuation. @@ -718,8 +718,8 @@ def GetMSL(a_lnum: number): number # three # msl = lnum - elseif Match(lnum, non_bracket_continuation_regex) && - \ (Match(msl, bracket_continuation_regex) || Match(msl, block_continuation_regex)) + elseif IsMatch(lnum, non_bracket_continuation_regex) && + \ (IsMatch(msl, bracket_continuation_regex) || IsMatch(msl, block_continuation_regex)) # If the current line is a bracket continuation or a block-starter, but # the previous is a non-bracket one, respect the previous' indentation, # and stop here. @@ -730,8 +730,8 @@ def GetMSL(a_lnum: number): number # three # return lnum - elseif Match(lnum, bracket_continuation_regex) && - \ (Match(msl, bracket_continuation_regex) || Match(msl, block_continuation_regex)) + elseif IsMatch(lnum, bracket_continuation_regex) && + \ (IsMatch(msl, bracket_continuation_regex) || IsMatch(msl, block_continuation_regex)) # If both lines are bracket continuations (the current may also be a # block-starter), use the current one's and stop here # @@ -740,9 +740,9 @@ def GetMSL(a_lnum: number): number # other_method_call( # foo return msl - elseif Match(lnum, block_regex) && - \ !Match(msl, continuation_regex) && - \ !Match(msl, block_continuation_regex) + elseif IsMatch(lnum, block_regex) && + \ !IsMatch(msl, continuation_regex) && + \ !IsMatch(msl, block_continuation_regex) # If the previous line is a block-starter and the current one is # mostly ordinary, use the current one as the MSL. # @@ -846,6 +846,10 @@ def Match(lnum: number, regex: string): number endif enddef +def IsMatch(lnum: number, regex: string): bool + return Match(lnum, regex) > 0 +enddef + # Locates the containing class/module's definition line, ignoring nested classes # along the way. # From 9f49c88d96f72aa5129443884f2bbc616ab82d72 Mon Sep 17 00:00:00 2001 From: Andrew Radev Date: Wed, 22 Dec 2021 12:47:38 +0200 Subject: [PATCH 3/5] Extract vim9 logic to a separate file --- autoload/ruby_vim9.vim | 945 +++++++++++++++++++++++++++++++++++++++ indent/ruby.vim | 994 ++--------------------------------------- 2 files changed, 975 insertions(+), 964 deletions(-) create mode 100644 autoload/ruby_vim9.vim diff --git a/autoload/ruby_vim9.vim b/autoload/ruby_vim9.vim new file mode 100644 index 00000000..01f89143 --- /dev/null +++ b/autoload/ruby_vim9.vim @@ -0,0 +1,945 @@ +vim9script + +# 1. Variables {{{1 +# ============ + +# Syntax group names that are strings. +var syng_string = + \ ['String', 'Interpolation', 'InterpolationDelimiter', 'StringEscape'] + +# Syntax group names that are strings or documentation. +var syng_stringdoc = syng_string + ['Documentation'] + +# Syntax group names that are or delimit strings/symbols/regexes or are comments. +var syng_strcom = syng_stringdoc + [ + \ 'Character', + \ 'Comment', + \ 'HeredocDelimiter', + \ 'PercentRegexpDelimiter', + \ 'PercentStringDelimiter', + \ 'PercentSymbolDelimiter', + \ 'Regexp', + \ 'RegexpCharClass', + \ 'RegexpDelimiter', + \ 'RegexpEscape', + \ 'StringDelimiter', + \ 'Symbol', + \ 'SymbolDelimiter', + \ ] + +# Expression used to check whether we should skip a match with searchpair(). +var skip_expr = + \ 'index(map(' .. string(syng_strcom) .. ',"hlID(''ruby''.v:val)"), synID(line("."),col("."),1)) >= 0' + +# Regex used for words that, at the start of a line, add a level of indent. +var ruby_indent_keywords = + \ '^\s*\zs\<\%(module\|class\|if\|for' .. + \ '\|while\|until\|else\|elsif\|case\|when\|unless\|begin\|ensure\|rescue' .. + \ '\|\%(\K\k*[!?]\?\s\+\)\=def\):\@!\>' .. + \ '\|\%([=,*/%+-]\|<<\|>>\|:\s\)\s*\zs' .. + \ '\<\%(if\|for\|while\|until\|case\|unless\|begin\):\@!\>' + +# Def without an end clause: def method_call(...) = +var ruby_endless_def = '\' + +# Regex that defines the start-match for the 'end' keyword. +# let end_start_regex = '\%(^\|[^.]\)\<\%(module\|class\|def\|if\|for\|while\|until\|case\|unless\|begin\|do\)\>' +# TODO: the do here should be restricted somewhat (only at end of line)? +var end_start_regex = + \ '\C\%(^\s*\|[=,*/%+\-|;{]\|<<\|>>\|:\s\)\s*\zs' .. + \ '\<\%(module\|class\|if\|for\|while\|until\|case\|unless\|begin' .. + \ '\|\%(\K\k*[!?]\?\s\+\)\=def\):\@!\>' .. + \ '\|\%(^\|[^.:@$]\)\@<=\' + +# Regex that defines the middle-match for the 'end' keyword. +var end_middle_regex = '\<\%(ensure\|else\|\%(\%(^\|;\)\s*\)\@<=\\|when\|elsif\):\@!\>' + +# Regex that defines the end-match for the 'end' keyword. +var end_end_regex = '\%(^\|[^.:@$]\)\@<=\' + +# Expression used for searchpair() call for finding a match for an 'end' keyword. +def EndSkipExpr(): bool + if eval(skip_expr) + return 1 + elseif expand('') == 'do' + \ && getline(".") =~ '^\s*\<\(while\|until\|for\):\@!\>' + return 1 + elseif getline('.') =~ ruby_endless_def + return 1 + elseif getline('.') =~ '\>\|:\s\)\s*\zs' .. + \ '\<\%(if\|for\|while\|until\|unless\):\@!\>' + +# Regex that defines bracket continuations +var bracket_continuation_regex = '%\@\|%\@): number + var info = cline_info + + # If this line is an access modifier keyword, align according to the closest + # class declaration. + if g:ruby_indent_access_modifier_style == 'indent' + if IsMatch(info.clnum, access_modifier_regex) + var class_lnum = FindContainingClass() + if class_lnum > 0 + return indent(class_lnum) + info.sw + endif + endif + elseif g:ruby_indent_access_modifier_style == 'outdent' + if IsMatch(info.clnum, access_modifier_regex) + var class_lnum = FindContainingClass() + if class_lnum > 0 + return indent(class_lnum) + endif + endif + endif + + return -1 +enddef + +def ClosingBracketOnEmptyLine(cline_info: dict): number + var info = cline_info + + # If we got a closing bracket on an empty line, find its match and indent + # according to it. For parentheses we indent to its column - 1, for the + # others we indent to the containing line's MSL's level. Return -1 if fail. + var col = matchend(info.cline, '^\s*[]})]') + + if col > 0 && !IsInStringOrComment(info.clnum, col) + call cursor(info.clnum, col) + var closing_bracket = info.cline[col - 1] + var bracket_pair = strpart('(){}[]', stridx(')}]', closing_bracket) * 2, 2) + var ind = -1 + + if searchpair(escape(bracket_pair[0], '\['), '', bracket_pair[1], 'bW', skip_expr) > 0 + if closing_bracket == ')' && col('.') != col('$') - 1 + if g:ruby_indent_hanging_elements + ind = virtcol('.') - 1 + else + ind = indent(line('.')) + end + elseif g:ruby_indent_block_style == 'do' + ind = indent(line('.')) + else # g:ruby_indent_block_style == 'expression' + ind = indent(GetMSL(line('.'))) + endif + endif + + return ind + endif + + return -1 +enddef + +def BlockComment(cline_info: dict): number + # If we have a =begin or =end set indent to first column. + if match(cline_info.cline, '^\s*\%(=begin\|=end\)$') != -1 + return 0 + endif + return -1 +enddef + +def DeindentingKeyword(cline_info: dict): number + var info = cline_info + + # If we have a deindenting keyword, find its match and indent to its level. + # TODO: this is messy + if IsMatch(info.clnum, ruby_deindent_keywords) + var ind = -1 + call cursor(info.clnum, 1) + + if searchpair(end_start_regex, end_middle_regex, end_end_regex, 'bW', + \ EndSkipExpr) > 0 + var msl = GetMSL(line('.')) + var line = getline(line('.')) + + if IsAssignment(line, col('.')) && + \ strpart(line, col('.') - 1, 2) !~ 'do' + # assignment to case/begin/etc, on the same line + if g:ruby_indent_assignment_style == 'hanging' + # hanging indent + ind = virtcol('.') - 1 + else + # align with variable + ind = indent(line('.')) + endif + elseif g:ruby_indent_block_style == 'do' + # align to line of the "do", not to the MSL + ind = indent(line('.')) + elseif getline(msl) =~ '=\s*\(#.*\)\=$' + # in the case of assignment to the MSL, align to the starting line, + # not to the MSL + ind = indent(line('.')) + else + # align to the MSL + ind = indent(msl) + endif + endif + return ind + endif + + return -1 +enddef + +def MultilineStringOrLineComment(cline_info: dict): number + var info = cline_info + + # If we are in a multi-line string or line-comment, don't do anything to it. + if IsInStringOrDocumentation(info.clnum, matchend(info.cline, '^\s*') + 1) + return indent(info.clnum) + endif + return -1 +enddef + +def ClosingHeredocDelimiter(cline_info: dict): number + var info = cline_info + + # If we are at the closing delimiter of a "<<" heredoc-style string, set the + # indent to 0. + if info.cline =~ '^\k\+\s*$' + \ && IsInStringDelimiter(info.clnum, 1) + \ && search('\V<<' .. info.cline, 'nbW') > 0 + return 0 + endif + + return -1 +enddef + +def LeadingOperator(cline_info: dict): number + # If the current line starts with a leading operator, add a level of indent. + if IsMatch(cline_info.clnum, leading_operator_regex) + return indent(GetMSL(cline_info.clnum)) + cline_info.sw + endif + return -1 +enddef + +def EmptyInsideString(pline_info: dict): number + # If the line is empty and inside a string (the previous line is a string, + # too), use the previous line's indent + var info = pline_info + + var plnum = prevnonblank(info.clnum - 1) + var pline = getline(plnum) + + if info.cline =~ '^\s*$' + \ && IsInStringOrComment(plnum, 1) + \ && IsInStringOrComment(plnum, strlen(pline)) + return indent(plnum) + endif + return -1 +enddef + +def StartOfFile(pline_info: dict): number + # At the start of the file use zero indent. + if pline_info.plnum == 0 + return 0 + endif + return -1 +enddef + +def AfterAccessModifier(pline_info: dict): number + var info = pline_info + + if g:ruby_indent_access_modifier_style == 'indent' + # If the previous line was a private/protected keyword, add a + # level of indent. + if IsMatch(info.plnum, indent_access_modifier_regex) + return indent(info.plnum) + info.sw + endif + elseif g:ruby_indent_access_modifier_style == 'outdent' + # If the previous line was a private/protected/public keyword, add + # a level of indent, since the keyword has been out-dented. + if IsMatch(info.plnum, access_modifier_regex) + return indent(info.plnum) + info.sw + endif + endif + return -1 +enddef + +# Example: +# +# if foo || bar || +# baz || bing +# puts "foo" +# end +# +def ContinuedLine(pline_info: dict): number + var info = pline_info + + var col = Match(info.plnum, ruby_indent_keywords) + if IsMatch(info.plnum, continuable_regex) && + \ Match(info.plnum, continuation_regex) + var ind = -1 + if col > 0 && IsAssignment(info.pline, col) + if g:ruby_indent_assignment_style == 'hanging' + # hanging indent + ind = col - 1 + else + # align with variable + ind = indent(info.plnum) + endif + else + ind = indent(GetMSL(info.plnum)) + endif + return ind + info.sw + info.sw + endif + return -1 +enddef + +def AfterBlockOpening(pline_info: dict): number + var info = pline_info + + # If the previous line ended with a block opening, add a level of indent. + if IsMatch(info.plnum, block_regex) + var ind = -1 + + if g:ruby_indent_block_style == 'do' + # don't align to the msl, align to the "do" + ind = indent(info.plnum) + info.sw + else + var plnum_msl = GetMSL(info.plnum) + + if getline(plnum_msl) =~ '=\s*\(#.*\)\=$' + # in the case of assignment to the msl, align to the starting line, + # not to the msl + ind = indent(info.plnum) + info.sw + else + ind = indent(plnum_msl) + info.sw + endif + endif + + return ind + endif + + return -1 +enddef + +def AfterLeadingOperator(pline_info: dict): number + # If the previous line started with a leading operator, use its MSL's level + # of indent + if IsMatch(pline_info.plnum, leading_operator_regex) + return indent(GetMSL(pline_info.plnum)) + endif + return -1 +enddef + +def AfterHangingSplat(pline_info: dict): number + var info = pline_info + + # If the previous line ended with the "*" of a splat, add a level of indent + if info.pline =~ splat_regex + return indent(info.plnum) + info.sw + endif + return -1 +enddef + +def AfterUnbalancedBracket(pline_info: dict): number + var info = pline_info + + # If the previous line contained unclosed opening brackets and we are still + # in them, find the rightmost one and add indent depending on the bracket + # type. + # + # If it contained hanging closing brackets, find the rightmost one, find its + # match and indent according to that. + if info.pline =~ '[[({]' || info.pline =~ '[])}]\s*\%(#.*\)\=$' + var brackets = ExtraBrackets(info.plnum) + var opening = brackets[0] + var closing = brackets[1] + + if opening.pos != -1 + if !g:ruby_indent_hanging_elements + return indent(info.plnum) + info.sw + elseif opening.type == '(' && searchpair('(', '', ')', 'bW', skip_expr) > 0 + if col('.') + 1 == col('$') + return indent(info.plnum) + info.sw + else + return virtcol('.') + endif + else + var nonspace = matchend(info.pline, '\S', opening.pos + 1) - 1 + return nonspace > 0 ? nonspace : indent(info.plnum) + info.sw + endif + elseif closing.pos != -1 + call cursor(info.plnum, closing.pos + 1) + normal! % + + if strpart(info.pline, closing.pos) =~ '^)\s*=' + # special case: the closing `) =` of an endless def + return indent(GetMSL(line('.'))) + endif + + if IsMatch(line('.'), ruby_indent_keywords) + return indent('.') + info.sw + else + return indent(GetMSL(line('.'))) + endif + else + call cursor(info.clnum, info.col) + end + endif + + return -1 +enddef + +def AfterEndKeyword(pline_info: dict): number + var info = pline_info + # If the previous line ended with an "end", match that "end"s beginning's + # indent. + var col = Match(info.plnum, '\%(^\|[^.:@$]\)\\s*\%(#.*\)\=$') + if col > 0 + call cursor(info.plnum, col) + if searchpair(end_start_regex, '', end_end_regex, 'bW', + \ EndSkipExpr) > 0 + var n = line('.') + var ind = indent('.') + var msl = GetMSL(n) + if msl != n + ind = indent(msl) + end + return ind + endif + end + return -1 +enddef + +def AfterIndentKeyword(pline_info: dict): number + var info = pline_info + var col = Match(info.plnum, ruby_indent_keywords) + + if col > 0 && Match(info.plnum, ruby_endless_def) <= 0 + call cursor(info.plnum, col) + var ind = virtcol('.') - 1 + info.sw + # TODO: make this better (we need to count them) (or, if a searchpair + # fails, we know that something is lacking an end and thus we indent a + # level + if IsMatch(info.plnum, end_end_regex) + ind = indent('.') + elseif IsAssignment(info.pline, col) + if g:ruby_indent_assignment_style == 'hanging' + # hanging indent + ind = col + info.sw - 1 + else + # align with variable + ind = indent(info.plnum) + info.sw + endif + endif + return ind + endif + + return -1 +enddef + +def PreviousNotMSL(msl_info: dict): number + var info = msl_info + + # If the previous line wasn't a MSL + if info.plnum != info.plnum_msl + # If previous line ends bracket and begins non-bracket continuation decrease indent by 1. + if IsMatch(info.plnum, bracket_switch_continuation_regex) + # TODO (2016-10-07) Wrong/unused? How could it be "1"? + return indent(info.plnum) - 1 + # If previous line is a continuation return its indent. + elseif IsMatch(info.plnum, non_bracket_continuation_regex) + return indent(info.plnum) + endif + endif + + return -1 +enddef + +def IndentingKeywordInMSL(msl_info: dict): number + var info = msl_info + # If the MSL line had an indenting keyword in it, add a level of indent. + # TODO: this does not take into account contrived things such as + # module Foo; class Bar; end + var col = Match(info.plnum_msl, ruby_indent_keywords) + if col > 0 && Match(info.plnum_msl, ruby_endless_def) <= 0 + var ind = indent(info.plnum_msl) + info.sw + if IsMatch(info.plnum_msl, end_end_regex) + var ind = ind - info.sw + elseif IsAssignment(getline(info.plnum_msl), col) + if g:ruby_indent_assignment_style == 'hanging' + # hanging indent + var ind = col + info.sw - 1 + else + # align with variable + var ind = indent(info.plnum_msl) + info.sw + endif + endif + return ind + endif + return -1 +enddef + +def ContinuedHangingOperator(msl_info: dict): number + var info = msl_info + + # If the previous line ended with [*+/.,-=], but wasn't a block ending or a + # closing bracket, indent one extra level. + if IsMatch(info.plnum_msl, non_bracket_continuation_regex) && !IsMatch(info.plnum_msl, '^\s*\([\])}]\|end\)') + if info.plnum_msl == info.plnum + var ind = indent(info.plnum_msl) + info.sw + else + var ind = indent(info.plnum_msl) + endif + return ind + endif + + return -1 +enddef + +# 4. Auxiliary Functions {{{1 +# ====================== + +def IsInRubyGroup(groups: list, lnum: number, col: number): bool + var ids = mapnew(copy(groups), 'hlID("ruby" .. v:val)') + return index(ids, synID(lnum, col, 1)) >= 0 +enddef + +# Check if the character at lnum:col is inside a string, comment, or is ascii. +def IsInStringOrComment(lnum: number, col: number): bool + return IsInRubyGroup(syng_strcom, lnum, col) +enddef + +# Check if the character at lnum:col is inside a string. +def IsInString(lnum: number, col: number): bool + return IsInRubyGroup(syng_string, lnum, col) +enddef + +# Check if the character at lnum:col is inside a string or documentation. +def IsInStringOrDocumentation(lnum: number, col: number): bool + return IsInRubyGroup(syng_stringdoc, lnum, col) +enddef + +# Check if the character at lnum:col is inside a string delimiter +def IsInStringDelimiter(lnum: number, col: number): bool + return IsInRubyGroup( + \ ['HeredocDelimiter', 'PercentStringDelimiter', 'StringDelimiter'], + \ lnum, col + \ ) +enddef + +def IsAssignment(str: string, pos: number): bool + return strpart(str, 0, pos - 1) =~ '=\s*$' +enddef + +# Find line above 'lnum' that isn't empty, in a comment, or in a string. +def PrevNonBlankNonString(a_lnum: number): number + var in_block = 0 + var lnum = prevnonblank(a_lnum) + while lnum > 0 + # Go in and out of blocks comments as necessary. + # If the line isn't empty (with opt. comment) or in a string, end search. + var line = getline(lnum) + if line =~ '^=begin' + if in_block + in_block = 0 + else + break + endif + elseif !in_block && line =~ '^=end' + in_block = 1 + elseif !in_block && line !~ '^\s*#.*$' && !(IsInStringOrComment(lnum, 1) + \ && IsInStringOrComment(lnum, strlen(line))) + break + endif + lnum = prevnonblank(lnum - 1) + endwhile + return lnum +enddef + +# Find line above 'lnum' that started the continuation 'lnum' may be part of. +def GetMSL(a_lnum: number): number + # Start on the line we're at and use its indent. + var msl = a_lnum + var lnum = PrevNonBlankNonString(a_lnum - 1) + while lnum > 0 + # If we have a continuation line, or we're in a string, use line as MSL. + # Otherwise, terminate search as we have found our MSL already. + var line = getline(lnum) + + # TODO number as boolean + + if !IsMatch(msl, backslash_continuation_regex) && + \ IsMatch(lnum, backslash_continuation_regex) + # If the current line doesn't end in a backslash, but the previous one + # does, look for that line's msl + # + # Example: + # foo = "bar" \ + # "baz" + # + msl = lnum + elseif IsMatch(msl, leading_operator_regex) + # If the current line starts with a leading operator, keep its indent + # and keep looking for an MSL. + msl = lnum + elseif IsMatch(lnum, splat_regex) + # If the above line looks like the "*" of a splat, use the current one's + # indentation. + # + # Example: + # Hash[* + # method_call do + # something + # + return msl + elseif IsMatch(lnum, non_bracket_continuation_regex) && + \ IsMatch(msl, non_bracket_continuation_regex) + # If the current line is a non-bracket continuation and so is the + # previous one, keep its indent and continue looking for an MSL. + # + # Example: + # method_call one, + # two, + # three + # + msl = lnum + elseif IsMatch(lnum, dot_continuation_regex) && + \ (IsMatch(msl, bracket_continuation_regex) || IsMatch(msl, block_continuation_regex)) + # If the current line is a bracket continuation or a block-starter, but + # the previous is a dot, keep going to see if the previous line is the + # start of another continuation. + # + # Example: + # parent. + # method_call { + # three + # + msl = lnum + elseif IsMatch(lnum, non_bracket_continuation_regex) && + \ (IsMatch(msl, bracket_continuation_regex) || IsMatch(msl, block_continuation_regex)) + # If the current line is a bracket continuation or a block-starter, but + # the previous is a non-bracket one, respect the previous' indentation, + # and stop here. + # + # Example: + # method_call one, + # two { + # three + # + return lnum + elseif IsMatch(lnum, bracket_continuation_regex) && + \ (IsMatch(msl, bracket_continuation_regex) || IsMatch(msl, block_continuation_regex)) + # If both lines are bracket continuations (the current may also be a + # block-starter), use the current one's and stop here + # + # Example: + # method_call( + # other_method_call( + # foo + return msl + elseif IsMatch(lnum, block_regex) && + \ !IsMatch(msl, continuation_regex) && + \ !IsMatch(msl, block_continuation_regex) + # If the previous line is a block-starter and the current one is + # mostly ordinary, use the current one as the MSL. + # + # Example: + # method_call do + # something + # something_else + return msl + else + var col = match(line, continuation_regex) + 1 + if (col > 0 && !IsInStringOrComment(lnum, col)) + \ || IsInString(lnum, strlen(line)) + msl = lnum + else + break + endif + endif + + lnum = PrevNonBlankNonString(lnum - 1) + endwhile + return msl +enddef + +# Check if line 'lnum' has more opening brackets than closing ones. +def ExtraBrackets(lnum: number): list> + var opening: dict>> = {'parentheses': [], 'braces': [], 'brackets': []} + var closing: dict>> = {'parentheses': [], 'braces': [], 'brackets': []} + + var line = getline(lnum) + var pos = match(line, '[][(){}]', 0) + + # Save any encountered opening brackets, and remove them once a matching + # closing one has been found. If a closing bracket shows up that doesn't + # close anything, save it for later. + while pos != -1 + if !IsInStringOrComment(lnum, pos + 1) + if line[pos] == '(' + call add(opening.parentheses, {'type': '(', 'pos': pos}) + elseif line[pos] == ')' + if empty(opening.parentheses) + call add(closing.parentheses, {'type': ')', 'pos': pos}) + else + opening.parentheses = opening.parentheses[0 : -2] + endif + elseif line[pos] == '{' + call add(opening.braces, {'type': '{', 'pos': pos}) + elseif line[pos] == '}' + if empty(opening.braces) + call add(closing.braces, {'type': '}', 'pos': pos}) + else + opening.braces = opening.braces[0 : -2] + endif + elseif line[pos] == '[' + call add(opening.brackets, {'type': '[', 'pos': pos}) + elseif line[pos] == ']' + if empty(opening.brackets) + call add(closing.brackets, {'type': ']', 'pos': pos}) + else + opening.brackets = opening.brackets[0 : -2] + endif + endif + endif + + pos = match(line, '[][(){}]', pos + 1) + endwhile + + # Find the rightmost brackets, since they're the ones that are important in + # both opening and closing cases + var rightmost_opening = {'type': '(', 'pos': -1} + var rightmost_closing = {'type': ')', 'pos': -1} + + for local_opening in opening.parentheses + opening.braces + opening.brackets + if local_opening.pos > rightmost_opening.pos + rightmost_opening = local_opening + endif + endfor + + for local_closing in closing.parentheses + closing.braces + closing.brackets + if local_closing.pos > rightmost_closing.pos + rightmost_closing = local_closing + endif + endfor + + return [rightmost_opening, rightmost_closing] +enddef + +def Match(lnum: number, regex: string): number + var line = getline(lnum) + var offset = match(line, '\C' .. regex) + var col = offset + 1 + + while offset > -1 && IsInStringOrComment(lnum, col) + offset = match(line, '\C' .. regex, offset + 1) + col = offset + 1 + endwhile + + if offset > -1 + return col + else + return 0 + endif +enddef + +def IsMatch(lnum: number, regex: string): bool + return Match(lnum, regex) > 0 +enddef + +# Locates the containing class/module's definition line, ignoring nested classes +# along the way. +# +def FindContainingClass(): number + var saved_position = getpos('.') + + while searchpair(end_start_regex, end_middle_regex, end_end_regex, 'bW', + \ EndSkipExpr) > 0 + if expand('') =~# '\' + var found_lnum = line('.') + call setpos('.', saved_position) + return found_lnum + endif + endwhile + + call setpos('.', saved_position) + return 0 +enddef + +# }}}1 + +# 2. GetRubyIndent Function {{{1 +# ========================= + +def ruby_vim9#GetRubyIndent(lnum: number): number + # 2.1. Setup {{{2 + # ---------- + + var indent_info = {} + + # The value of a single shift-width + if exists('*shiftwidth') + indent_info.sw = shiftwidth() + else + indent_info.sw = &sw + endif + + # For the current line, use the first argument if given, else v:lnum + indent_info.clnum = lnum + indent_info.cline = getline(indent_info.clnum) + + # Set up variables for restoring position in file. Could use clnum here. + indent_info.col = col('.') + + # 2.2. Work on the current line {{{2 + # ----------------------------- + var indent_callback_names = [ + \ 'AccessModifier', + \ 'ClosingBracketOnEmptyLine', + \ 'BlockComment', + \ 'DeindentingKeyword', + \ 'MultilineStringOrLineComment', + \ 'ClosingHeredocDelimiter', + \ 'LeadingOperator', + \ ] + + for callback_name in indent_callback_names + # Decho "Running: ".callback_name + var indent = call(function(callback_name), [indent_info]) + + if indent >= 0 + # Decho "Match: ".callback_name." indent=".indent." info=".string(indent_info) + return indent + endif + endfor + + # 2.3. Work on the previous line. {{{2 + # ------------------------------- + + # Special case: we don't need the real PrevNonBlankNonString for an empty + # line inside a string. And that call can be quite expensive in that + # particular situation. + indent_callback_names = [ + \ 'EmptyInsideString', + \ ] + + for callback_name in indent_callback_names + # Decho "Running: ".callback_name + var indent = call(function(callback_name), [indent_info]) + + if indent >= 0 + # Decho "Match: ".callback_name." indent=".indent." info=".string(indent_info) + return indent + endif + endfor + + # Previous line number + indent_info.plnum = PrevNonBlankNonString(indent_info.clnum - 1) + indent_info.pline = getline(indent_info.plnum) + + indent_callback_names = [ + \ 'StartOfFile', + \ 'AfterAccessModifier', + \ 'ContinuedLine', + \ 'AfterBlockOpening', + \ 'AfterHangingSplat', + \ 'AfterUnbalancedBracket', + \ 'AfterLeadingOperator', + \ 'AfterEndKeyword', + \ 'AfterIndentKeyword', + \ ] + + for callback_name in indent_callback_names + # Decho "Running: ".callback_name + var indent = call(function(callback_name), [indent_info]) + + if indent >= 0 + # Decho "Match: ".callback_name." indent=".indent." info=".string(indent_info) + return indent + endif + endfor + + # 2.4. Work on the MSL line. {{{2 + # -------------------------- + indent_callback_names = [ + \ 'PreviousNotMSL', + \ 'IndentingKeywordInMSL', + \ 'ContinuedHangingOperator', + \ ] + + # Most Significant line based on the previous one -- in case it's a + # continuation of something above + indent_info.plnum_msl = GetMSL(indent_info.plnum) + + for callback_name in indent_callback_names + # Decho "Running: ".callback_name + var indent = call(function(callback_name), [indent_info]) + + if indent >= 0 + # Decho "Match: ".callback_name." indent=".indent." info=".string(indent_info) + return indent + endif + endfor + + # }}}2 + + # By default, just return the previous line's indent + # Decho "Default case matched" + return indent(indent_info.plnum) +enddef + +# vim:set sw=2 sts=2 ts=8 et: diff --git a/indent/ruby.vim b/indent/ruby.vim index 3def26ce..0454daae 100644 --- a/indent/ruby.vim +++ b/indent/ruby.vim @@ -1,994 +1,60 @@ -vim9script +" Vim indent file +" Language: Ruby +" Maintainer: Andrew Radev +" Previous Maintainer: Nikolai Weibull +" URL: https://github.com/vim-ruby/vim-ruby +" Release Coordinator: Doug Kearns -# Vim indent file -# Language: Ruby -# Maintainer: Andrew Radev -# Previous Maintainer: Nikolai Weibull -# URL: https://github.com/vim-ruby/vim-ruby -# Release Coordinator: Doug Kearns +" 0. Initialization {{{1 +" ================= -# 0. Initialization {{{1 -# ================= - -# Only load this indent file when no other was loaded. +" Only load this indent file when no other was loaded. if exists("b:did_indent") finish endif -b:did_indent = 1 +let b:did_indent = 1 if !exists('g:ruby_indent_access_modifier_style') - # Possible values: "normal", "indent", "outdent" - g:ruby_indent_access_modifier_style = 'normal' + " Possible values: "normal", "indent", "outdent" + let g:ruby_indent_access_modifier_style = 'normal' endif if !exists('g:ruby_indent_assignment_style') - # Possible values: "variable", "hanging" - g:ruby_indent_assignment_style = 'hanging' + " Possible values: "variable", "hanging" + let g:ruby_indent_assignment_style = 'hanging' endif if !exists('g:ruby_indent_block_style') - # Possible values: "expression", "do" - g:ruby_indent_block_style = 'do' + " Possible values: "expression", "do" + let g:ruby_indent_block_style = 'do' endif if !exists('g:ruby_indent_hanging_elements') - # Non-zero means hanging indents are enabled, zero means disabled - g:ruby_indent_hanging_elements = 1 + " Non-zero means hanging indents are enabled, zero means disabled + let g:ruby_indent_hanging_elements = 1 endif -set nosmartindent +setlocal nosmartindent -# Now, set up our indentation expression and keys that trigger it. -setlocal indentexpr=g:GetRubyIndent(v:lnum) +" Now, set up our indentation expression and keys that trigger it. +setlocal indentexpr=GetRubyIndent(v:lnum) setlocal indentkeys=0{,0},0),0],!^F,o,O,e,:,. setlocal indentkeys+==end,=else,=elsif,=when,=ensure,=rescue,==begin,==end setlocal indentkeys+==private,=protected,=public -# Only define the function once. +" Only define the function once. if exists("*GetRubyIndent") finish endif -# 1. Variables {{{1 -# ============ - -# Syntax group names that are strings. -var syng_string = - \ ['String', 'Interpolation', 'InterpolationDelimiter', 'StringEscape'] - -# Syntax group names that are strings or documentation. -var syng_stringdoc = syng_string + ['Documentation'] - -# Syntax group names that are or delimit strings/symbols/regexes or are comments. -var syng_strcom = syng_stringdoc + [ - \ 'Character', - \ 'Comment', - \ 'HeredocDelimiter', - \ 'PercentRegexpDelimiter', - \ 'PercentStringDelimiter', - \ 'PercentSymbolDelimiter', - \ 'Regexp', - \ 'RegexpCharClass', - \ 'RegexpDelimiter', - \ 'RegexpEscape', - \ 'StringDelimiter', - \ 'Symbol', - \ 'SymbolDelimiter', - \ ] - -# Expression used to check whether we should skip a match with searchpair(). -var skip_expr = - \ 'index(map(' .. string(syng_strcom) .. ',"hlID(''ruby''.v:val)"), synID(line("."),col("."),1)) >= 0' - -# Regex used for words that, at the start of a line, add a level of indent. -var ruby_indent_keywords = - \ '^\s*\zs\<\%(module\|class\|if\|for' .. - \ '\|while\|until\|else\|elsif\|case\|when\|unless\|begin\|ensure\|rescue' .. - \ '\|\%(\K\k*[!?]\?\s\+\)\=def\):\@!\>' .. - \ '\|\%([=,*/%+-]\|<<\|>>\|:\s\)\s*\zs' .. - \ '\<\%(if\|for\|while\|until\|case\|unless\|begin\):\@!\>' - -# Def without an end clause: def method_call(...) = -var ruby_endless_def = '\' - -# Regex that defines the start-match for the 'end' keyword. -# let end_start_regex = '\%(^\|[^.]\)\<\%(module\|class\|def\|if\|for\|while\|until\|case\|unless\|begin\|do\)\>' -# TODO: the do here should be restricted somewhat (only at end of line)? -var end_start_regex = - \ '\C\%(^\s*\|[=,*/%+\-|;{]\|<<\|>>\|:\s\)\s*\zs' .. - \ '\<\%(module\|class\|if\|for\|while\|until\|case\|unless\|begin' .. - \ '\|\%(\K\k*[!?]\?\s\+\)\=def\):\@!\>' .. - \ '\|\%(^\|[^.:@$]\)\@<=\' - -# Regex that defines the middle-match for the 'end' keyword. -var end_middle_regex = '\<\%(ensure\|else\|\%(\%(^\|;\)\s*\)\@<=\\|when\|elsif\):\@!\>' - -# Regex that defines the end-match for the 'end' keyword. -var end_end_regex = '\%(^\|[^.:@$]\)\@<=\' - -# Expression used for searchpair() call for finding a match for an 'end' keyword. -def EndSkipExpr(): bool - if eval(skip_expr) - return 1 - elseif expand('') == 'do' - \ && getline(".") =~ '^\s*\<\(while\|until\|for\):\@!\>' - return 1 - elseif getline('.') =~ ruby_endless_def - return 1 - elseif getline('.') =~ '\>\|:\s\)\s*\zs' .. - \ '\<\%(if\|for\|while\|until\|unless\):\@!\>' - -# Regex that defines bracket continuations -var bracket_continuation_regex = '%\@\|%\@): number - var info = cline_info - - # If this line is an access modifier keyword, align according to the closest - # class declaration. - if g:ruby_indent_access_modifier_style == 'indent' - if IsMatch(info.clnum, access_modifier_regex) - var class_lnum = FindContainingClass() - if class_lnum > 0 - return indent(class_lnum) + info.sw - endif - endif - elseif g:ruby_indent_access_modifier_style == 'outdent' - if IsMatch(info.clnum, access_modifier_regex) - var class_lnum = FindContainingClass() - if class_lnum > 0 - return indent(class_lnum) - endif - endif - endif - - return -1 -enddef - -def ClosingBracketOnEmptyLine(cline_info: dict): number - var info = cline_info - - # If we got a closing bracket on an empty line, find its match and indent - # according to it. For parentheses we indent to its column - 1, for the - # others we indent to the containing line's MSL's level. Return -1 if fail. - var col = matchend(info.cline, '^\s*[]})]') - - if col > 0 && !IsInStringOrComment(info.clnum, col) - call cursor(info.clnum, col) - var closing_bracket = info.cline[col - 1] - var bracket_pair = strpart('(){}[]', stridx(')}]', closing_bracket) * 2, 2) - var ind = -1 - - if searchpair(escape(bracket_pair[0], '\['), '', bracket_pair[1], 'bW', skip_expr) > 0 - if closing_bracket == ')' && col('.') != col('$') - 1 - if g:ruby_indent_hanging_elements - ind = virtcol('.') - 1 - else - ind = indent(line('.')) - end - elseif g:ruby_indent_block_style == 'do' - ind = indent(line('.')) - else # g:ruby_indent_block_style == 'expression' - ind = indent(GetMSL(line('.'))) - endif - endif - - return ind - endif - - return -1 -enddef - -def BlockComment(cline_info: dict): number - # If we have a =begin or =end set indent to first column. - if match(cline_info.cline, '^\s*\%(=begin\|=end\)$') != -1 - return 0 - endif - return -1 -enddef - -def DeindentingKeyword(cline_info: dict): number - var info = cline_info - - # If we have a deindenting keyword, find its match and indent to its level. - # TODO: this is messy - if IsMatch(info.clnum, ruby_deindent_keywords) - var ind = -1 - call cursor(info.clnum, 1) - - if searchpair(end_start_regex, end_middle_regex, end_end_regex, 'bW', - \ EndSkipExpr) > 0 - var msl = GetMSL(line('.')) - var line = getline(line('.')) - - if IsAssignment(line, col('.')) && - \ strpart(line, col('.') - 1, 2) !~ 'do' - # assignment to case/begin/etc, on the same line - if g:ruby_indent_assignment_style == 'hanging' - # hanging indent - ind = virtcol('.') - 1 - else - # align with variable - ind = indent(line('.')) - endif - elseif g:ruby_indent_block_style == 'do' - # align to line of the "do", not to the MSL - ind = indent(line('.')) - elseif getline(msl) =~ '=\s*\(#.*\)\=$' - # in the case of assignment to the MSL, align to the starting line, - # not to the MSL - ind = indent(line('.')) - else - # align to the MSL - ind = indent(msl) - endif - endif - return ind - endif - - return -1 -enddef - -def MultilineStringOrLineComment(cline_info: dict): number - var info = cline_info - - # If we are in a multi-line string or line-comment, don't do anything to it. - if IsInStringOrDocumentation(info.clnum, matchend(info.cline, '^\s*') + 1) - return indent(info.clnum) - endif - return -1 -enddef - -def ClosingHeredocDelimiter(cline_info: dict): number - var info = cline_info - - # If we are at the closing delimiter of a "<<" heredoc-style string, set the - # indent to 0. - if info.cline =~ '^\k\+\s*$' - \ && IsInStringDelimiter(info.clnum, 1) - \ && search('\V<<' .. info.cline, 'nbW') > 0 - return 0 - endif - - return -1 -enddef - -def LeadingOperator(cline_info: dict): number - # If the current line starts with a leading operator, add a level of indent. - if IsMatch(cline_info.clnum, leading_operator_regex) - return indent(GetMSL(cline_info.clnum)) + cline_info.sw - endif - return -1 -enddef - -def EmptyInsideString(pline_info: dict): number - # If the line is empty and inside a string (the previous line is a string, - # too), use the previous line's indent - var info = pline_info - - var plnum = prevnonblank(info.clnum - 1) - var pline = getline(plnum) - - if info.cline =~ '^\s*$' - \ && IsInStringOrComment(plnum, 1) - \ && IsInStringOrComment(plnum, strlen(pline)) - return indent(plnum) - endif - return -1 -enddef - -def StartOfFile(pline_info: dict): number - # At the start of the file use zero indent. - if pline_info.plnum == 0 - return 0 - endif - return -1 -enddef - -def AfterAccessModifier(pline_info: dict): number - var info = pline_info - - if g:ruby_indent_access_modifier_style == 'indent' - # If the previous line was a private/protected keyword, add a - # level of indent. - if IsMatch(info.plnum, indent_access_modifier_regex) - return indent(info.plnum) + info.sw - endif - elseif g:ruby_indent_access_modifier_style == 'outdent' - # If the previous line was a private/protected/public keyword, add - # a level of indent, since the keyword has been out-dented. - if IsMatch(info.plnum, access_modifier_regex) - return indent(info.plnum) + info.sw - endif - endif - return -1 -enddef - -# Example: -# -# if foo || bar || -# baz || bing -# puts "foo" -# end -# -def ContinuedLine(pline_info: dict): number - var info = pline_info - - var col = Match(info.plnum, ruby_indent_keywords) - if IsMatch(info.plnum, continuable_regex) && - \ Match(info.plnum, continuation_regex) - var ind = -1 - if col > 0 && IsAssignment(info.pline, col) - if g:ruby_indent_assignment_style == 'hanging' - # hanging indent - ind = col - 1 - else - # align with variable - ind = indent(info.plnum) - endif - else - ind = indent(GetMSL(info.plnum)) - endif - return ind + info.sw + info.sw - endif - return -1 -enddef - -def AfterBlockOpening(pline_info: dict): number - var info = pline_info - - # If the previous line ended with a block opening, add a level of indent. - if IsMatch(info.plnum, block_regex) - var ind = -1 - - if g:ruby_indent_block_style == 'do' - # don't align to the msl, align to the "do" - ind = indent(info.plnum) + info.sw - else - var plnum_msl = GetMSL(info.plnum) - - if getline(plnum_msl) =~ '=\s*\(#.*\)\=$' - # in the case of assignment to the msl, align to the starting line, - # not to the msl - ind = indent(info.plnum) + info.sw - else - ind = indent(plnum_msl) + info.sw - endif - endif - - return ind - endif - - return -1 -enddef - -def AfterLeadingOperator(pline_info: dict): number - # If the previous line started with a leading operator, use its MSL's level - # of indent - if IsMatch(pline_info.plnum, leading_operator_regex) - return indent(GetMSL(pline_info.plnum)) - endif - return -1 -enddef - -def AfterHangingSplat(pline_info: dict): number - var info = pline_info - - # If the previous line ended with the "*" of a splat, add a level of indent - if info.pline =~ splat_regex - return indent(info.plnum) + info.sw - endif - return -1 -enddef - -def AfterUnbalancedBracket(pline_info: dict): number - var info = pline_info - - # If the previous line contained unclosed opening brackets and we are still - # in them, find the rightmost one and add indent depending on the bracket - # type. - # - # If it contained hanging closing brackets, find the rightmost one, find its - # match and indent according to that. - if info.pline =~ '[[({]' || info.pline =~ '[])}]\s*\%(#.*\)\=$' - var brackets = ExtraBrackets(info.plnum) - var opening = brackets[0] - var closing = brackets[1] - - if opening.pos != -1 - if !g:ruby_indent_hanging_elements - return indent(info.plnum) + info.sw - elseif opening.type == '(' && searchpair('(', '', ')', 'bW', skip_expr) > 0 - if col('.') + 1 == col('$') - return indent(info.plnum) + info.sw - else - return virtcol('.') - endif - else - var nonspace = matchend(info.pline, '\S', opening.pos + 1) - 1 - return nonspace > 0 ? nonspace : indent(info.plnum) + info.sw - endif - elseif closing.pos != -1 - call cursor(info.plnum, closing.pos + 1) - normal! % - - if strpart(info.pline, closing.pos) =~ '^)\s*=' - # special case: the closing `) =` of an endless def - return indent(GetMSL(line('.'))) - endif - - if IsMatch(line('.'), ruby_indent_keywords) - return indent('.') + info.sw - else - return indent(GetMSL(line('.'))) - endif - else - call cursor(info.clnum, info.col) - end - endif - - return -1 -enddef - -def AfterEndKeyword(pline_info: dict): number - var info = pline_info - # If the previous line ended with an "end", match that "end"s beginning's - # indent. - var col = Match(info.plnum, '\%(^\|[^.:@$]\)\\s*\%(#.*\)\=$') - if col > 0 - call cursor(info.plnum, col) - if searchpair(end_start_regex, '', end_end_regex, 'bW', - \ EndSkipExpr) > 0 - var n = line('.') - var ind = indent('.') - var msl = GetMSL(n) - if msl != n - ind = indent(msl) - end - return ind - endif - end - return -1 -enddef - -def AfterIndentKeyword(pline_info: dict): number - var info = pline_info - var col = Match(info.plnum, ruby_indent_keywords) - - if col > 0 && Match(info.plnum, ruby_endless_def) <= 0 - call cursor(info.plnum, col) - var ind = virtcol('.') - 1 + info.sw - # TODO: make this better (we need to count them) (or, if a searchpair - # fails, we know that something is lacking an end and thus we indent a - # level - if IsMatch(info.plnum, end_end_regex) - ind = indent('.') - elseif IsAssignment(info.pline, col) - if g:ruby_indent_assignment_style == 'hanging' - # hanging indent - ind = col + info.sw - 1 - else - # align with variable - ind = indent(info.plnum) + info.sw - endif - endif - return ind - endif - - return -1 -enddef - -def PreviousNotMSL(msl_info: dict): number - var info = msl_info - - # If the previous line wasn't a MSL - if info.plnum != info.plnum_msl - # If previous line ends bracket and begins non-bracket continuation decrease indent by 1. - if IsMatch(info.plnum, bracket_switch_continuation_regex) - # TODO (2016-10-07) Wrong/unused? How could it be "1"? - return indent(info.plnum) - 1 - # If previous line is a continuation return its indent. - elseif IsMatch(info.plnum, non_bracket_continuation_regex) - return indent(info.plnum) - endif - endif - - return -1 -enddef - -def IndentingKeywordInMSL(msl_info: dict): number - var info = msl_info - # If the MSL line had an indenting keyword in it, add a level of indent. - # TODO: this does not take into account contrived things such as - # module Foo; class Bar; end - var col = Match(info.plnum_msl, ruby_indent_keywords) - if col > 0 && Match(info.plnum_msl, ruby_endless_def) <= 0 - var ind = indent(info.plnum_msl) + info.sw - if IsMatch(info.plnum_msl, end_end_regex) - var ind = ind - info.sw - elseif IsAssignment(getline(info.plnum_msl), col) - if g:ruby_indent_assignment_style == 'hanging' - # hanging indent - var ind = col + info.sw - 1 - else - # align with variable - var ind = indent(info.plnum_msl) + info.sw - endif - endif - return ind - endif - return -1 -enddef - -def ContinuedHangingOperator(msl_info: dict): number - var info = msl_info - - # If the previous line ended with [*+/.,-=], but wasn't a block ending or a - # closing bracket, indent one extra level. - if IsMatch(info.plnum_msl, non_bracket_continuation_regex) && !IsMatch(info.plnum_msl, '^\s*\([\])}]\|end\)') - if info.plnum_msl == info.plnum - var ind = indent(info.plnum_msl) + info.sw - else - var ind = indent(info.plnum_msl) - endif - return ind - endif - - return -1 -enddef - -# 4. Auxiliary Functions {{{1 -# ====================== - -def IsInRubyGroup(groups: list, lnum: number, col: number): bool - var ids = mapnew(copy(groups), 'hlID("ruby" .. v:val)') - return index(ids, synID(lnum, col, 1)) >= 0 -enddef - -# Check if the character at lnum:col is inside a string, comment, or is ascii. -def IsInStringOrComment(lnum: number, col: number): bool - return IsInRubyGroup(syng_strcom, lnum, col) -enddef - -# Check if the character at lnum:col is inside a string. -def IsInString(lnum: number, col: number): bool - return IsInRubyGroup(syng_string, lnum, col) -enddef - -# Check if the character at lnum:col is inside a string or documentation. -def IsInStringOrDocumentation(lnum: number, col: number): bool - return IsInRubyGroup(syng_stringdoc, lnum, col) -enddef - -# Check if the character at lnum:col is inside a string delimiter -def IsInStringDelimiter(lnum: number, col: number): bool - return IsInRubyGroup( - \ ['HeredocDelimiter', 'PercentStringDelimiter', 'StringDelimiter'], - \ lnum, col - \ ) -enddef - -def IsAssignment(str: string, pos: number): bool - return strpart(str, 0, pos - 1) =~ '=\s*$' -enddef - -# Find line above 'lnum' that isn't empty, in a comment, or in a string. -def PrevNonBlankNonString(a_lnum: number): number - var in_block = 0 - var lnum = prevnonblank(a_lnum) - while lnum > 0 - # Go in and out of blocks comments as necessary. - # If the line isn't empty (with opt. comment) or in a string, end search. - var line = getline(lnum) - if line =~ '^=begin' - if in_block - in_block = 0 - else - break - endif - elseif !in_block && line =~ '^=end' - in_block = 1 - elseif !in_block && line !~ '^\s*#.*$' && !(IsInStringOrComment(lnum, 1) - \ && IsInStringOrComment(lnum, strlen(line))) - break - endif - lnum = prevnonblank(lnum - 1) - endwhile - return lnum -enddef - -# Find line above 'lnum' that started the continuation 'lnum' may be part of. -def GetMSL(a_lnum: number): number - # Start on the line we're at and use its indent. - var msl = a_lnum - var lnum = PrevNonBlankNonString(a_lnum - 1) - while lnum > 0 - # If we have a continuation line, or we're in a string, use line as MSL. - # Otherwise, terminate search as we have found our MSL already. - var line = getline(lnum) - - # TODO number as boolean - - if !IsMatch(msl, backslash_continuation_regex) && - \ IsMatch(lnum, backslash_continuation_regex) - # If the current line doesn't end in a backslash, but the previous one - # does, look for that line's msl - # - # Example: - # foo = "bar" \ - # "baz" - # - msl = lnum - elseif IsMatch(msl, leading_operator_regex) - # If the current line starts with a leading operator, keep its indent - # and keep looking for an MSL. - msl = lnum - elseif IsMatch(lnum, splat_regex) - # If the above line looks like the "*" of a splat, use the current one's - # indentation. - # - # Example: - # Hash[* - # method_call do - # something - # - return msl - elseif IsMatch(lnum, non_bracket_continuation_regex) && - \ IsMatch(msl, non_bracket_continuation_regex) - # If the current line is a non-bracket continuation and so is the - # previous one, keep its indent and continue looking for an MSL. - # - # Example: - # method_call one, - # two, - # three - # - msl = lnum - elseif IsMatch(lnum, dot_continuation_regex) && - \ (IsMatch(msl, bracket_continuation_regex) || IsMatch(msl, block_continuation_regex)) - # If the current line is a bracket continuation or a block-starter, but - # the previous is a dot, keep going to see if the previous line is the - # start of another continuation. - # - # Example: - # parent. - # method_call { - # three - # - msl = lnum - elseif IsMatch(lnum, non_bracket_continuation_regex) && - \ (IsMatch(msl, bracket_continuation_regex) || IsMatch(msl, block_continuation_regex)) - # If the current line is a bracket continuation or a block-starter, but - # the previous is a non-bracket one, respect the previous' indentation, - # and stop here. - # - # Example: - # method_call one, - # two { - # three - # - return lnum - elseif IsMatch(lnum, bracket_continuation_regex) && - \ (IsMatch(msl, bracket_continuation_regex) || IsMatch(msl, block_continuation_regex)) - # If both lines are bracket continuations (the current may also be a - # block-starter), use the current one's and stop here - # - # Example: - # method_call( - # other_method_call( - # foo - return msl - elseif IsMatch(lnum, block_regex) && - \ !IsMatch(msl, continuation_regex) && - \ !IsMatch(msl, block_continuation_regex) - # If the previous line is a block-starter and the current one is - # mostly ordinary, use the current one as the MSL. - # - # Example: - # method_call do - # something - # something_else - return msl - else - var col = match(line, continuation_regex) + 1 - if (col > 0 && !IsInStringOrComment(lnum, col)) - \ || IsInString(lnum, strlen(line)) - msl = lnum - else - break - endif - endif - - lnum = PrevNonBlankNonString(lnum - 1) - endwhile - return msl -enddef - -# Check if line 'lnum' has more opening brackets than closing ones. -def ExtraBrackets(lnum: number): list> - var opening: dict>> = {'parentheses': [], 'braces': [], 'brackets': []} - var closing: dict>> = {'parentheses': [], 'braces': [], 'brackets': []} - - var line = getline(lnum) - var pos = match(line, '[][(){}]', 0) - - # Save any encountered opening brackets, and remove them once a matching - # closing one has been found. If a closing bracket shows up that doesn't - # close anything, save it for later. - while pos != -1 - if !IsInStringOrComment(lnum, pos + 1) - if line[pos] == '(' - call add(opening.parentheses, {'type': '(', 'pos': pos}) - elseif line[pos] == ')' - if empty(opening.parentheses) - call add(closing.parentheses, {'type': ')', 'pos': pos}) - else - opening.parentheses = opening.parentheses[0 : -2] - endif - elseif line[pos] == '{' - call add(opening.braces, {'type': '{', 'pos': pos}) - elseif line[pos] == '}' - if empty(opening.braces) - call add(closing.braces, {'type': '}', 'pos': pos}) - else - opening.braces = opening.braces[0 : -2] - endif - elseif line[pos] == '[' - call add(opening.brackets, {'type': '[', 'pos': pos}) - elseif line[pos] == ']' - if empty(opening.brackets) - call add(closing.brackets, {'type': ']', 'pos': pos}) - else - opening.brackets = opening.brackets[0 : -2] - endif - endif - endif - - pos = match(line, '[][(){}]', pos + 1) - endwhile - - # Find the rightmost brackets, since they're the ones that are important in - # both opening and closing cases - var rightmost_opening = {'type': '(', 'pos': -1} - var rightmost_closing = {'type': ')', 'pos': -1} - - for local_opening in opening.parentheses + opening.braces + opening.brackets - if local_opening.pos > rightmost_opening.pos - rightmost_opening = local_opening - endif - endfor - - for local_closing in closing.parentheses + closing.braces + closing.brackets - if local_closing.pos > rightmost_closing.pos - rightmost_closing = local_closing - endif - endfor - - return [rightmost_opening, rightmost_closing] -enddef - -def Match(lnum: number, regex: string): number - var line = getline(lnum) - var offset = match(line, '\C' .. regex) - var col = offset + 1 - - while offset > -1 && IsInStringOrComment(lnum, col) - offset = match(line, '\C' .. regex, offset + 1) - col = offset + 1 - endwhile - - if offset > -1 - return col - else - return 0 - endif -enddef - -def IsMatch(lnum: number, regex: string): bool - return Match(lnum, regex) > 0 -enddef - -# Locates the containing class/module's definition line, ignoring nested classes -# along the way. -# -def FindContainingClass(): number - var saved_position = getpos('.') - - while searchpair(end_start_regex, end_middle_regex, end_end_regex, 'bW', - \ EndSkipExpr) > 0 - if expand('') =~# '\' - var found_lnum = line('.') - call setpos('.', saved_position) - return found_lnum - endif - endwhile - - call setpos('.', saved_position) - return 0 -enddef - -# }}}1 - -# 2. GetRubyIndent Function {{{1 -# ========================= - -def g:GetRubyIndent(lnum: number): number - # 2.1. Setup {{{2 - # ---------- - - var indent_info = {} - - # The value of a single shift-width - if exists('*shiftwidth') - indent_info.sw = shiftwidth() - else - indent_info.sw = &sw - endif - - # For the current line, use the first argument if given, else v:lnum - indent_info.clnum = lnum - indent_info.cline = getline(indent_info.clnum) - - # Set up variables for restoring position in file. Could use clnum here. - indent_info.col = col('.') - - # 2.2. Work on the current line {{{2 - # ----------------------------- - var indent_callback_names = [ - \ 'AccessModifier', - \ 'ClosingBracketOnEmptyLine', - \ 'BlockComment', - \ 'DeindentingKeyword', - \ 'MultilineStringOrLineComment', - \ 'ClosingHeredocDelimiter', - \ 'LeadingOperator', - \ ] - - for callback_name in indent_callback_names - # Decho "Running: ".callback_name - var indent = call(function(callback_name), [indent_info]) - - if indent >= 0 - # Decho "Match: ".callback_name." indent=".indent." info=".string(indent_info) - return indent - endif - endfor - - # 2.3. Work on the previous line. {{{2 - # ------------------------------- - - # Special case: we don't need the real PrevNonBlankNonString for an empty - # line inside a string. And that call can be quite expensive in that - # particular situation. - indent_callback_names = [ - \ 'EmptyInsideString', - \ ] - - for callback_name in indent_callback_names - # Decho "Running: ".callback_name - var indent = call(function(callback_name), [indent_info]) - - if indent >= 0 - # Decho "Match: ".callback_name." indent=".indent." info=".string(indent_info) - return indent - endif - endfor - - # Previous line number - indent_info.plnum = PrevNonBlankNonString(indent_info.clnum - 1) - indent_info.pline = getline(indent_info.plnum) - - indent_callback_names = [ - \ 'StartOfFile', - \ 'AfterAccessModifier', - \ 'ContinuedLine', - \ 'AfterBlockOpening', - \ 'AfterHangingSplat', - \ 'AfterUnbalancedBracket', - \ 'AfterLeadingOperator', - \ 'AfterEndKeyword', - \ 'AfterIndentKeyword', - \ ] - - for callback_name in indent_callback_names - # Decho "Running: ".callback_name - var indent = call(function(callback_name), [indent_info]) - - if indent >= 0 - # Decho "Match: ".callback_name." indent=".indent." info=".string(indent_info) - return indent - endif - endfor - - # 2.4. Work on the MSL line. {{{2 - # -------------------------- - indent_callback_names = [ - \ 'PreviousNotMSL', - \ 'IndentingKeywordInMSL', - \ 'ContinuedHangingOperator', - \ ] - - # Most Significant line based on the previous one -- in case it's a - # continuation of something above - indent_info.plnum_msl = GetMSL(indent_info.plnum) - - for callback_name in indent_callback_names - # Decho "Running: ".callback_name - var indent = call(function(callback_name), [indent_info]) - - if indent >= 0 - # Decho "Match: ".callback_name." indent=".indent." info=".string(indent_info) - return indent - endif - endfor +let s:cpo_save = &cpo +set cpo&vim - # }}}2 +function! GetRubyIndent(...) abort + return ruby_vim9#GetRubyIndent(a:0 ? a:1 : v:lnum) +endfunction - # By default, just return the previous line's indent - # Decho "Default case matched" - return indent(indent_info.plnum) -enddef +let &cpo = s:cpo_save +unlet s:cpo_save -# vim:set sw=2 sts=2 ts=8 et: +" vim:set sw=2 sts=2 ts=8 et: From 68bf954b6cd68235380797368eef9850f4dfe4b5 Mon Sep 17 00:00:00 2001 From: Andrew Radev Date: Wed, 22 Dec 2021 13:18:13 +0200 Subject: [PATCH 4/5] Leftover vim9 fixes to pass the test suite --- autoload/ruby_vim9.vim | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/autoload/ruby_vim9.vim b/autoload/ruby_vim9.vim index 01f89143..0644f3ce 100644 --- a/autoload/ruby_vim9.vim +++ b/autoload/ruby_vim9.vim @@ -29,7 +29,7 @@ var syng_strcom = syng_stringdoc + [ # Expression used to check whether we should skip a match with searchpair(). var skip_expr = - \ 'index(map(' .. string(syng_strcom) .. ',"hlID(''ruby''.v:val)"), synID(line("."),col("."),1)) >= 0' + \ 'index(mapnew(' .. string(syng_strcom) .. ', "hlID(''ruby'' .. v:val)"), synID(line("."), col("."), 1)) >= 0' # Regex used for words that, at the start of a line, add a level of indent. var ruby_indent_keywords = @@ -329,7 +329,7 @@ def ContinuedLine(pline_info: dict): number var col = Match(info.plnum, ruby_indent_keywords) if IsMatch(info.plnum, continuable_regex) && - \ Match(info.plnum, continuation_regex) + \ IsMatch(info.plnum, continuation_regex) var ind = -1 if col > 0 && IsAssignment(info.pline, col) if g:ruby_indent_assignment_style == 'hanging' @@ -518,14 +518,14 @@ def IndentingKeywordInMSL(msl_info: dict): number if col > 0 && Match(info.plnum_msl, ruby_endless_def) <= 0 var ind = indent(info.plnum_msl) + info.sw if IsMatch(info.plnum_msl, end_end_regex) - var ind = ind - info.sw + ind = ind - info.sw elseif IsAssignment(getline(info.plnum_msl), col) if g:ruby_indent_assignment_style == 'hanging' # hanging indent - var ind = col + info.sw - 1 + ind = col + info.sw - 1 else # align with variable - var ind = indent(info.plnum_msl) + info.sw + ind = indent(info.plnum_msl) + info.sw endif endif return ind @@ -539,10 +539,11 @@ def ContinuedHangingOperator(msl_info: dict): number # If the previous line ended with [*+/.,-=], but wasn't a block ending or a # closing bracket, indent one extra level. if IsMatch(info.plnum_msl, non_bracket_continuation_regex) && !IsMatch(info.plnum_msl, '^\s*\([\])}]\|end\)') + var ind = -1 if info.plnum_msl == info.plnum - var ind = indent(info.plnum_msl) + info.sw + ind = indent(info.plnum_msl) + info.sw else - var ind = indent(info.plnum_msl) + ind = indent(info.plnum_msl) endif return ind endif From bd3aaa2e062e4c692363af2094af481c7fd53b14 Mon Sep 17 00:00:00 2001 From: Andrew Radev Date: Sun, 4 Jun 2023 22:43:19 +0300 Subject: [PATCH 5/5] Fix Vim9 features --- autoload/ruby_vim9.vim | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/autoload/ruby_vim9.vim b/autoload/ruby_vim9.vim index 8a30b2be..2e379862 100644 --- a/autoload/ruby_vim9.vim +++ b/autoload/ruby_vim9.vim @@ -178,7 +178,7 @@ def ClosingBracketOnEmptyLine(cline_info: dict): number ind = virtcol('.') - 1 else ind = indent(line('.')) - end + endif elseif g:ruby_indent_block_style == 'do' ind = indent(line('.')) else # g:ruby_indent_block_style == 'expression' @@ -437,7 +437,7 @@ def AfterUnbalancedBracket(pline_info: dict): number endif else call cursor(info.clnum, info.col) - end + endif endif return -1 @@ -457,10 +457,10 @@ def AfterEndKeyword(pline_info: dict): number var msl = GetMSL(n) if msl != n ind = indent(msl) - end + endif return ind endif - end + endif return -1 enddef @@ -826,7 +826,7 @@ enddef # 2. GetRubyIndent Function {{{1 # ========================= -def ruby_vim9#GetRubyIndent(lnum: number): number +export def GetRubyIndent(lnum: number): number # 2.1. Setup {{{2 # ---------- @@ -943,4 +943,6 @@ def ruby_vim9#GetRubyIndent(lnum: number): number return indent(indent_info.plnum) enddef +defcompile + # vim:set sw=2 sts=2 ts=8 et: