summaryrefslogtreecommitdiff
path: root/runtime/indent
diff options
context:
space:
mode:
authorBram Moolenaar <Bram@vim.org>2013-06-12 21:29:15 +0200
committerBram Moolenaar <Bram@vim.org>2013-06-12 21:29:15 +0200
commitec7944aaf2d5fd67b7bd59a69d6a393424b6c8f8 (patch)
treed578871973ba7c87e0337dbe90b61d75de667100 /runtime/indent
parentcab465a6d7a7d158c99b04ddc81650b468d82227 (diff)
downloadvim-git-ec7944aaf2d5fd67b7bd59a69d6a393424b6c8f8.tar.gz
Update runtime files.
Diffstat (limited to 'runtime/indent')
-rw-r--r--runtime/indent/eruby.vim21
-rw-r--r--runtime/indent/falcon.vim455
-rw-r--r--runtime/indent/html.vim648
-rw-r--r--runtime/indent/ruby.vim321
4 files changed, 1074 insertions, 371 deletions
diff --git a/runtime/indent/eruby.vim b/runtime/indent/eruby.vim
index a4de118cc..80cab7000 100644
--- a/runtime/indent/eruby.vim
+++ b/runtime/indent/eruby.vim
@@ -1,9 +1,7 @@
" Vim indent file
" Language: eRuby
" Maintainer: Tim Pope <vimNOSPAM@tpope.org>
-" Last Change: 2010 May 28
-" URL: http://vim-ruby.rubyforge.org
-" Anon CVS: See above site
+" URL: https://github.com/vim-ruby/vim-ruby
" Release Coordinator: Doug Kearns <dougkearns@gmail.com>
if exists("b:did_indent")
@@ -50,29 +48,32 @@ function! GetErubyIndent(...)
call cursor(v:lnum,1)
let inruby = searchpair('<%','','%>','W')
call cursor(v:lnum,vcol)
- if inruby && getline(v:lnum) !~ '^<%\|^\s*-\=%>'
- let ind = GetRubyIndent()
+ if inruby && getline(v:lnum) !~ '^<%\|^\s*[-=]\=%>'
+ let ind = GetRubyIndent(v:lnum)
else
exe "let ind = ".b:eruby_subtype_indentexpr
endif
let lnum = prevnonblank(v:lnum-1)
let line = getline(lnum)
let cline = getline(v:lnum)
- if cline =~# '^\s*<%-\=\s*\%(}\|end\|else\|\%(ensure\|rescue\|elsif\|when\).\{-\}\)\s*\%(-\=%>\|$\)'
+ if cline =~# '^\s*<%[-=]\=\s*\%(}\|end\|else\|\%(ensure\|rescue\|elsif\|when\).\{-\}\)\s*\%([-=]\=%>\|$\)'
let ind = ind - &sw
endif
- if line =~# '\S\s*<%-\=\s*\%(}\|end\).\{-\}\s*\%(-\=%>\|$\)'
+ if line =~# '\S\s*<%[-=]\=\s*\%(}\|end\).\{-\}\s*\%([-=]\=%>\|$\)'
let ind = ind - &sw
endif
- if line =~# '\%({\|\<do\)\%(\s*|[^|]*|\)\=\s*-\=%>'
+ if line =~# '\%({\|\<do\)\%(\s*|[^|]*|\)\=\s*[-=]\=%>'
let ind = ind + &sw
- elseif line =~# '<%-\=\s*\%(module\|class\|def\|if\|for\|while\|until\|else\|elsif\|case\|when\|unless\|begin\|ensure\|rescue\)\>.*%>'
+ elseif line =~# '<%[-=]\=\s*\%(module\|class\|def\|if\|for\|while\|until\|else\|elsif\|case\|when\|unless\|begin\|ensure\|rescue\)\>.*%>'
let ind = ind + &sw
endif
if line =~# '^\s*<%[=#-]\=\s*$' && cline !~# '^\s*end\>'
let ind = ind + &sw
endif
- if cline =~# '^\s*-\=%>\s*$'
+ if line !~# '^\s*<%' && line =~# '%>\s*$'
+ let ind = ind - &sw
+ endif
+ if cline =~# '^\s*[-=]\=%>\s*$'
let ind = ind - &sw
endif
return ind
diff --git a/runtime/indent/falcon.vim b/runtime/indent/falcon.vim
index 46a228e8b..84b16d55f 100644
--- a/runtime/indent/falcon.vim
+++ b/runtime/indent/falcon.vim
@@ -2,13 +2,10 @@
" Language: Falcon
" Maintainer: Steven Oliver <oliver.steven@gmail.com>
" Website: https://steveno@github.com/steveno/falconpl-vim.git
-" Credits: Thanks to the ruby.vim authors, I borrow a lot!
-" Previous Maintainer: Brent A. Fulgham <bfulgham@debian.org>
-" -----------------------------------------------------------
+" Credits: This is, to a great extent, a copy n' paste of ruby.vim.
-"======================================
-" SETUP
-"======================================
+" 1. Setup {{{1
+" ============
" Only load this indent file when no other was loaded.
if exists("b:did_indent")
@@ -19,7 +16,7 @@ let b:did_indent = 1
setlocal nosmartindent
" Setup indent function and when to use it
-setlocal indentexpr=FalconGetIndent()
+setlocal indentexpr=FalconGetIndent(v:lnum)
setlocal indentkeys=0{,0},0),0],!^F,o,O,e
setlocal indentkeys+==~case,=~catch,=~default,=~elif,=~else,=~end,=~\"
@@ -31,9 +28,8 @@ endif
let s:cpo_save = &cpo
set cpo&vim
-"======================================
-" VARIABLES
-"======================================
+" 2. Variables {{{1
+" ============
" Regex of syntax group names that are strings AND comments
let s:syng_strcom = '\<falcon\%(String\|StringEscape\|Comment\)\>'
@@ -41,6 +37,31 @@ let s:syng_strcom = '\<falcon\%(String\|StringEscape\|Comment\)\>'
" Regex of syntax group names that are strings
let s:syng_string = '\<falcon\%(String\|StringEscape\)\>'
+" Regex that defines blocks.
+"
+" Note that there's a slight problem with this regex and s:continuation_regex.
+" Code like this will be matched by both:
+"
+" method_call do |(a, b)|
+"
+" The reason is that the pipe matches a hanging "|" operator.
+"
+let s:block_regex =
+ \ '\%(\<do:\@!\>\|%\@<!{\)\s*\%(|\s*(*\s*\%([*@&]\=\h\w*,\=\s*\)\%(,\s*(*\s*[*@&]\=\h\w*\s*)*\s*\)*|\)\=\s*\%(#.*\)\=$'
+
+let s:block_continuation_regex = '^\s*[^])}\t ].*'.s:block_regex
+
+" Regex that defines continuation lines.
+" TODO: this needs to deal with if ...: and so on
+let s:continuation_regex =
+ \ '\%(%\@<![({[\\.,:*/%+]\|\<and\|\<or\|\%(<%\)\@<![=-]\|\W[|&?]\|||\|&&\)\s*\%(#.*\)\=$'
+
+" Regex that defines bracket continuations
+let s:bracket_continuation_regex = '%\@<!\%([({[]\)\s*\%(#.*\)\=$'
+
+" Regex that defines continuation lines, not including (, {, or [.
+let s:non_bracket_continuation_regex = '\%([\\.,:*/%+]\|\<and\|\<or\|\%(<%\)\@<![=-]\|\W[|&?]\|||\|&&\)\s*\%(#.*\)\=$'
+
" Keywords to indent on
let s:falcon_indent_keywords = '^\s*\(case\|catch\|class\|enum\|default\|elif\|else' .
\ '\|for\|function\|if.*"[^"]*:.*"\|if \(\(:\)\@!.\)*$\|loop\|object\|select' .
@@ -49,109 +70,381 @@ let s:falcon_indent_keywords = '^\s*\(case\|catch\|class\|enum\|default\|elif\|e
" Keywords to deindent on
let s:falcon_deindent_keywords = '^\s*\(case\|catch\|default\|elif\|else\|end\)'
-"======================================
-" FUNCTIONS
-"======================================
+" 3. Functions {{{1
+" ============
-" Check if the character at lnum:col is inside a string
+" Check if the character at lnum:col is inside a string, comment, or is ascii.
function s:IsInStringOrComment(lnum, col)
return synIDattr(synID(a:lnum, a:col, 1), 'name') =~ s:syng_strcom
endfunction
-"======================================
-" INDENT ROUTINE
-"======================================
+" Check if the character at lnum:col is inside a string.
+function s:IsInString(lnum, col)
+ return synIDattr(synID(a:lnum, a:col, 1), 'name') =~ s:syng_string
+endfunction
-function FalconGetIndent()
- " Get the line to be indented
- let cline = getline(v:lnum)
+" Check if the character at lnum:col is inside a string delimiter
+function s:IsInStringDelimiter(lnum, col)
+ return synIDattr(synID(a:lnum, a:col, 1), 'name') == 'falconStringDelimiter'
+endfunction
- " Don't reindent comments on first column
- if cline =~ '^\/\/'
- return 0
- endif
+" Find line above 'lnum' that isn't empty, in a comment, or in a string.
+function s:PrevNonBlankNonString(lnum)
+ let in_block = 0
+ let 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)
+ if line =~ '^=begin'
+ if in_block
+ let 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)))
+ break
+ endif
+ let lnum = prevnonblank(lnum - 1)
+ endwhile
+ return lnum
+endfunction
+
+" Find line above 'lnum' that started the continuation 'lnum' may be part of.
+function s:GetMSL(lnum)
+ " Start on the line we're at and use its indent.
+ let msl = a:lnum
+ let msl_body = getline(msl)
+ let lnum = s: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(line, 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: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
+ "
+ 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
+ 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
+ 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
+ else
+ break
+ endif
+ endif
+
+ let msl_body = getline(msl)
+ let lnum = s:PrevNonBlankNonString(lnum - 1)
+ endwhile
+ return msl
+endfunction
+
+" Check if line 'lnum' has more opening brackets than closing ones.
+function s:ExtraBrackets(lnum)
+ let opening = {'parentheses': [], 'braces': [], 'brackets': []}
+ let closing = {'parentheses': [], 'braces': [], 'brackets': []}
+
+ let line = getline(a:lnum)
+ let 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 !s:IsInStringOrComment(a: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]
+ 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
+ let 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
+ let opening.brackets = opening.brackets[0:-2]
+ endif
+ endif
+ endif
+
+ let 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}
+
+ for opening in opening.parentheses + opening.braces + opening.brackets
+ if opening.pos > rightmost_opening.pos
+ let rightmost_opening = opening
+ endif
+ endfor
+
+ for closing in closing.parentheses + closing.braces + closing.brackets
+ if closing.pos > rightmost_closing.pos
+ let rightmost_closing = closing
+ endif
+ endfor
+
+ return [rightmost_opening, rightmost_closing]
+endfunction
+
+function s:Match(lnum, regex)
+ let col = match(getline(a:lnum), '\C'.a:regex) + 1
+ return col > 0 && !s:IsInStringOrComment(a:lnum, col) ? col : 0
+endfunction
- " Find the previous non-blank line
- let lnum = prevnonblank(v:lnum - 1)
+function s:MatchLast(lnum, regex)
+ let line = getline(a:lnum)
+ let col = match(line, '.*\zs' . a:regex)
+ while col != -1 && s:IsInStringOrComment(a:lnum, col)
+ let line = strpart(line, 0, col)
+ let col = match(line, '.*' . a:regex)
+ endwhile
+ return col + 1
+endfunction
+
+" 4. FalconGetIndent Routine {{{1
+" ============
+
+function FalconGetIndent(...)
+ " For the current line, use the first argument if given, else v:lnum
+ let clnum = a:0 ? a:1 : v:lnum
" Use zero indent at the top of the file
- if lnum == 0
+ if clnum == 0
return 0
endif
- let prevline=getline(lnum)
- let ind = indent(lnum)
- let chg = 0
+ let line = getline(clnum)
+ let ind = -1
+
+ " 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(line, '^\s*[]})]')
+ if col > 0 && !s:IsInStringOrComment(clnum, col)
+ call cursor(clnum, col)
+ let bs = strpart('(){}[]', stridx(')}]', line[col - 1]) * 2, 2)
+ if searchpair(escape(bs[0], '\['), '', bs[1], 'bW', s:skip_expr) > 0
+ if line[col-1]==')' && col('.') != col('$') - 1
+ let ind = virtcol('.') - 1
+ else
+ let ind = indent(s:GetMSL(line('.')))
+ endif
+ endif
+ return ind
+ endif
+
+ " If we have a deindenting keyword, find its match and indent to its level.
+ " TODO: this is messy
+ if s:Match(clnum, s:falcon_deindent_keywords)
+ call cursor(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 strpart(line, 0, col('.') - 1) =~ '=\s*$' &&
+ \ strpart(line, col('.') - 1, 2) !~ 'do'
+ let ind = virtcol('.') - 1
+ elseif getline(msl) =~ '=\s*\(#.*\)\=$'
+ let ind = indent(line('.'))
+ else
+ let ind = indent(msl)
+ endif
+ endif
+ return ind
+ endif
+
+ " If we are in a multi-line string or line-comment, don't do anything to it.
+ if s:IsInString(clnum, matchend(line, '^\s*') + 1)
+ return indent('.')
+ endif
+
+ " Find a non-blank, non-multi-line string line above the current line.
+ let lnum = s:PrevNonBlankNonString(clnum - 1)
- " If we are in a multi-line string or line-comment, don't do anything
- if s:IsInStringOrComment(v:lnum, matchend(cline, '^\s*') + 1 )
- return indent('.')
+ " If the line is empty and inside a string, use the previous line.
+ if line =~ '^\s*$' && lnum != prevnonblank(clnum - 1)
+ return indent(prevnonblank(clnum))
endif
- " If the start of the line equals a double quote, then indent to the
- " previous lines first double quote
- if cline =~? '^\s*"'
- let chg = chg + &sw
+ " At the start of the file use zero indent.
+ if lnum == 0
+ return 0
endif
- " If previous line started with a double quote and this one
- " doesn't, unindent
- if prevline =~? '^\s*"' && cline =~? '^\s*'
- let chg = chg - &sw
+ " Set up variables for the previous line.
+ let line = getline(lnum)
+ let ind = indent(lnum)
+
+ " If the previous line ended with a block opening, add a level of indent.
+ if s:Match(lnum, s:block_regex)
+ return indent(s:GetMSL(lnum)) + &sw
endif
- " Indent if proper keyword
- if prevline =~? s:falcon_indent_keywords
- let chg = &sw
- " If previous line opened a parenthesis, and did not close it, indent
- elseif prevline =~ '^.*(\s*[^)]*\((.*)\)*[^)]*$'
- " Make sure this isn't just a function split between two lines
- if prevline =~ ',\s*$'
- return indent(prevnonblank(v:lnum - 1)) + &sw
- else
- return match(prevline, '(.*\((.*)\|[^)]\)*.*$') + 1
- endif
- elseif prevline =~ '^[^(]*)\s*$'
- " This line closes a parenthesis. Finds opening.
- let curr_line = prevnonblank(lnum - 1)
- while curr_line >= 0
- let str = getline(curr_line)
- if str !~ '^.*(\s*[^)]*\((.*)\)*[^)]*$'
- let curr_line = prevnonblank(curr_line - 1)
- else
- break
- endif
- endwhile
- if curr_line < 0
- return -1
- endif
- let ind = indent(curr_line)
+ " If it contained hanging closing brackets, find the rightmost one, find its
+ " match and indent according to that.
+ if line =~ '[[({]' || line =~ '[])}]\s*\%(#.*\)\=$'
+ let [opening, closing] = s:ExtraBrackets(lnum)
+
+ if opening.pos != -1
+ if opening.type == '(' && searchpair('(', '', ')', 'bW', s:skip_expr) > 0
+ if col('.') + 1 == col('$')
+ return ind + &sw
+ else
+ return virtcol('.')
+ endif
+ else
+ let nonspace = matchend(line, '\S', opening.pos + 1) - 1
+ return nonspace > 0 ? nonspace : ind + &sw
+ endif
+ elseif closing.pos != -1
+ call cursor(lnum, closing.pos + 1)
+ normal! %
+
+ if s:Match(line('.'), s:falcon_indent_keywords)
+ return indent('.') + &sw
+ else
+ return indent('.')
+ endif
+ else
+ call cursor(clnum, vcol)
+ end
endif
- " If previous line ends in a semi-colon reset indent to previous
- " lines setting
- if prevline =~? ';\s*$' && prevnonblank(prevline) =~? ',\s*$'
- let chg = chg - (2 * &sw)
+ " If the previous line ended with an "end", match that "end"s beginning's
+ " indent.
+ let col = s:Match(lnum, '\%(^\|[^.:@$]\)\<end\>\s*\%(#.*\)\=$')
+ if col > 0
+ call cursor(lnum, 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 msl != n
+ let ind = indent(msl)
+ end
+ return ind
+ endif
+ end
+
+ let col = s:Match(lnum, s:falcon_indent_keywords)
+ if col > 0
+ call cursor(lnum, col)
+ let ind = virtcol('.') - 1 + &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(lnum, s:end_end_regex)
+ let ind = indent('.')
+ endif
+ return ind
endif
- " If previous line ended in a comma, indent again
- if prevline =~? ',\s*$'
- let chg = chg + &sw
+ " Set up variables to use and search for MSL to the previous line.
+ let p_lnum = lnum
+ let lnum = s:GetMSL(lnum)
+
+ " If the previous line wasn't a MSL and is continuation return its indent.
+ " TODO: the || s:IsInString() thing worries me a bit.
+ if p_lnum != lnum
+ if s:Match(p_lnum, s:non_bracket_continuation_regex) || s:IsInString(p_lnum,strlen(line))
+ return ind
+ endif
endif
- " If previous line ended in a =>, indent again
- if prevline =~? '=>\s*$'
- let chg = chg + &sw
+ " Set up more variables, now that we know we wasn't continuation bound.
+ let line = getline(lnum)
+ let msl_ind = indent(lnum)
+
+ " 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
+ if s:Match(lnum, s:falcon_indent_keywords)
+ let ind = msl_ind + &sw
+ if s:Match(lnum, s:end_end_regex)
+ let ind = ind - &sw
+ endif
+ return ind
endif
- " Deindent on proper keywords
- if cline =~? s:falcon_deindent_keywords
- let chg = chg - &sw
+ " If the previous line ended with [*+/.,-=], but wasn't a block ending or a
+ " closing bracket, indent one extra level.
+ if s:Match(lnum, s:non_bracket_continuation_regex) && !s:Match(lnum, '^\s*\([\])}]\|end\)')
+ if lnum == p_lnum
+ let ind = msl_ind + &sw
+ else
+ let ind = msl_ind
+ endif
+ return ind
endif
- return ind + chg
+ return ind
endfunction
+" }}}1
+
let &cpo = s:cpo_save
unlet s:cpo_save
diff --git a/runtime/indent/html.vim b/runtime/indent/html.vim
index 6f016ad16..d9a3d4f51 100644
--- a/runtime/indent/html.vim
+++ b/runtime/indent/html.vim
@@ -1,242 +1,492 @@
-" Description: html indenter
-" Author: Johannes Zellner <johannes@zellner.org>
-" Last Change: Mo, 05 Jun 2006 22:32:41 CEST
-" Restoring 'cpo' and 'ic' added by Bram 2006 May 5
-" Globals: g:html_indent_tags -- indenting tags
-" g:html_indent_strict -- inhibit 'O O' elements
-" g:html_indent_strict_table -- inhibit 'O -' elements
-
-" Only load this indent file when no other was loaded.
+" Vim indent script for HTML
+" General: "{{{
+" File: html.vim (Vimscript #2075)
+" Author: Andy Wokula <anwoku@yahoo.de>
+" Last Change: 2013 Jun 12
+" Rev Days: 9
+" Version: 0.8
+" Vim Version: Vim7
+" Description:
+" Improved version of the distributed html indent script, faster on a
+" range of lines.
+"
+" Credits:
+" indent/html.vim (2006 Jun 05) from J. Zellner
+" indent/css.vim (2006 Dec 20) from N. Weibull
+"
+" History:
+" 2011 Sep 09 added HTML5 tags (thx to J. Zuckerman)
+" }}}
+
+" Init Folklore, check user settings (2nd time ++) "{{{
if exists("b:did_indent")
finish
endif
let b:did_indent = 1
+setlocal indentexpr=HtmlIndent()
+setlocal indentkeys=o,O,<Return>,<>>,{,},!^F
-" [-- local settings (must come before aborting the script) --]
-setlocal indentexpr=HtmlIndentGet(v:lnum)
-setlocal indentkeys=o,O,*<Return>,<>>,{,}
-
+let b:indent = {"lnum": -1}
+let b:undo_indent = "set inde< indk<| unlet b:indent"
-if exists('g:html_indent_tags')
- unlet g:html_indent_tags
+" Load Once:
+if exists("*HtmlIndent")
+ call HtmlIndent_CheckUserSettings()
+ finish
endif
-" [-- helper function to assemble tag list --]
-fun! <SID>HtmlIndentPush(tag)
- if exists('g:html_indent_tags')
- let g:html_indent_tags = g:html_indent_tags.'\|'.a:tag
+let s:cpo_save = &cpo
+set cpo-=C
+"}}}
+
+func! HtmlIndent_CheckUserSettings() "{{{
+ if exists("g:html_indent_inctags")
+ call s:AddITags(split(g:html_indent_inctags, ","))
+ endif
+ if exists("g:html_indent_autotags")
+ call s:RemoveITags(split(g:html_indent_autotags, ","))
+ endif
+
+ let indone = {"zero": 0
+ \,"auto": "indent(prevnonblank(v:lnum-1))"
+ \,"inc": "b:indent.blocktagind + &shiftwidth"}
+ if exists("g:html_indent_script1")
+ let s:js1indent = get(indone, g:html_indent_script1, indone.zero)
+ endif
+ if exists("g:html_indent_style1")
+ let s:css1indent = get(indone, g:html_indent_style1, indone.zero)
+ endif
+endfunc "}}}
+
+" Init Script Vars "{{{
+let s:usestate = 1
+let s:css1indent = 0
+let s:js1indent = 0
+" not to be changed:
+let s:endtags = [0,0,0,0,0,0,0,0] " some places unused
+let s:newstate = {}
+let s:countonly = 0
+ "}}}
+func! s:AddITags(taglist) "{{{
+ for itag in a:taglist
+ let s:indent_tags[itag] = 1
+ let s:indent_tags['/'.itag] = -1
+ endfor
+endfunc "}}}
+func! s:AddBlockTag(tag, id, ...) "{{{
+ if !(a:id >= 2 && a:id < 2+len(s:endtags))
+ return
+ endif
+ let s:indent_tags[a:tag] = a:id
+ if a:0 == 0
+ let s:indent_tags['/'.a:tag] = -a:id
+ let s:endtags[a:id-2] = "</".a:tag.">"
else
- let g:html_indent_tags = a:tag
- endif
-endfun
-
-
-" [-- <ELEMENT ? - - ...> --]
-call <SID>HtmlIndentPush('a')
-call <SID>HtmlIndentPush('abbr')
-call <SID>HtmlIndentPush('acronym')
-call <SID>HtmlIndentPush('address')
-call <SID>HtmlIndentPush('b')
-call <SID>HtmlIndentPush('bdo')
-call <SID>HtmlIndentPush('big')
-call <SID>HtmlIndentPush('blockquote')
-call <SID>HtmlIndentPush('button')
-call <SID>HtmlIndentPush('caption')
-call <SID>HtmlIndentPush('center')
-call <SID>HtmlIndentPush('cite')
-call <SID>HtmlIndentPush('code')
-call <SID>HtmlIndentPush('colgroup')
-call <SID>HtmlIndentPush('del')
-call <SID>HtmlIndentPush('dfn')
-call <SID>HtmlIndentPush('dir')
-call <SID>HtmlIndentPush('div')
-call <SID>HtmlIndentPush('dl')
-call <SID>HtmlIndentPush('em')
-call <SID>HtmlIndentPush('fieldset')
-call <SID>HtmlIndentPush('font')
-call <SID>HtmlIndentPush('form')
-call <SID>HtmlIndentPush('frameset')
-call <SID>HtmlIndentPush('h1')
-call <SID>HtmlIndentPush('h2')
-call <SID>HtmlIndentPush('h3')
-call <SID>HtmlIndentPush('h4')
-call <SID>HtmlIndentPush('h5')
-call <SID>HtmlIndentPush('h6')
-call <SID>HtmlIndentPush('i')
-call <SID>HtmlIndentPush('iframe')
-call <SID>HtmlIndentPush('ins')
-call <SID>HtmlIndentPush('kbd')
-call <SID>HtmlIndentPush('label')
-call <SID>HtmlIndentPush('legend')
-call <SID>HtmlIndentPush('map')
-call <SID>HtmlIndentPush('menu')
-call <SID>HtmlIndentPush('noframes')
-call <SID>HtmlIndentPush('noscript')
-call <SID>HtmlIndentPush('object')
-call <SID>HtmlIndentPush('ol')
-call <SID>HtmlIndentPush('optgroup')
-" call <SID>HtmlIndentPush('pre')
-call <SID>HtmlIndentPush('q')
-call <SID>HtmlIndentPush('s')
-call <SID>HtmlIndentPush('samp')
-call <SID>HtmlIndentPush('script')
-call <SID>HtmlIndentPush('select')
-call <SID>HtmlIndentPush('small')
-call <SID>HtmlIndentPush('span')
-call <SID>HtmlIndentPush('strong')
-call <SID>HtmlIndentPush('style')
-call <SID>HtmlIndentPush('sub')
-call <SID>HtmlIndentPush('sup')
-call <SID>HtmlIndentPush('table')
-call <SID>HtmlIndentPush('textarea')
-call <SID>HtmlIndentPush('title')
-call <SID>HtmlIndentPush('tt')
-call <SID>HtmlIndentPush('u')
-call <SID>HtmlIndentPush('ul')
-call <SID>HtmlIndentPush('var')
-
-
-" [-- <ELEMENT ? O O ...> --]
-if !exists('g:html_indent_strict')
- call <SID>HtmlIndentPush('body')
- call <SID>HtmlIndentPush('head')
- call <SID>HtmlIndentPush('html')
- call <SID>HtmlIndentPush('tbody')
+ let s:indent_tags[a:1] = -a:id
+ let s:endtags[a:id-2] = a:1
+ endif
+endfunc "}}}
+func! s:RemoveITags(taglist) "{{{
+ " remove itags (protect blocktags from being removed)
+ for itag in a:taglist
+ if !has_key(s:indent_tags, itag) || s:indent_tags[itag] != 1
+ continue
+ endif
+ unlet s:indent_tags[itag]
+ if itag =~ '^\w\+$'
+ unlet s:indent_tags["/".itag]
+ endif
+ endfor
+endfunc "}}}
+" Add Indent Tags: {{{
+if !exists("s:indent_tags")
+ let s:indent_tags = {}
endif
+" old tags:
+call s:AddITags(['a', 'abbr', 'acronym', 'address', 'b', 'bdo', 'big',
+ \ 'blockquote', 'button', 'caption', 'center', 'cite', 'code', 'colgroup',
+ \ 'del', 'dfn', 'dir', 'div', 'dl', 'em', 'fieldset', 'font', 'form',
+ \ 'frameset', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'i', 'iframe', 'ins', 'kbd',
+ \ 'label', 'legend', 'map', 'menu', 'noframes', 'noscript', 'object', 'ol',
+ \ 'optgroup', 'q', 's', 'samp', 'select', 'small', 'span', 'strong', 'sub',
+ \ 'sup', 'table', 'textarea', 'title', 'tt', 'u', 'ul', 'var', 'th', 'td',
+ \ 'tr', 'tfoot', 'thead'])
-" [-- <ELEMENT ? O - ...> --]
-if !exists('g:html_indent_strict_table')
- call <SID>HtmlIndentPush('th')
- call <SID>HtmlIndentPush('td')
- call <SID>HtmlIndentPush('tr')
- call <SID>HtmlIndentPush('tfoot')
- call <SID>HtmlIndentPush('thead')
-endif
+" tags added 2011 Sep 09 (especially HTML5 tags):
+call s:AddITags(['area', 'article', 'aside', 'audio', 'bdi', 'canvas',
+ \ 'command', 'datalist', 'details', 'embed', 'figure', 'footer',
+ \ 'header', 'group', 'keygen', 'mark', 'math', 'meter', 'nav', 'output',
+ \ 'progress', 'ruby', 'section', 'svg', 'texture', 'time', 'video',
+ \ 'wbr', 'text'])
-delfun <SID>HtmlIndentPush
+"}}}
+" Add Block Tags: contain alien content "{{{
+call s:AddBlockTag('pre', 2)
+call s:AddBlockTag('script', 3)
+call s:AddBlockTag('style', 4)
+call s:AddBlockTag('<!--', 5, '-->')
+"}}}
-let s:cpo_save = &cpo
-set cpo-=C
+func! s:CountITags(...) "{{{
-" [-- count indent-increasing tags of line a:lnum --]
-fun! <SID>HtmlIndentOpen(lnum, pattern)
- let s = substitute('x'.getline(a:lnum),
- \ '.\{-}\(\(<\)\('.a:pattern.'\)\>\)', "\1", 'g')
- let s = substitute(s, "[^\1].*$", '', '')
- return strlen(s)
-endfun
-
-" [-- count indent-decreasing tags of line a:lnum --]
-fun! <SID>HtmlIndentClose(lnum, pattern)
- let s = substitute('x'.getline(a:lnum),
- \ '.\{-}\(\(<\)/\('.a:pattern.'\)\>>\)', "\1", 'g')
- let s = substitute(s, "[^\1].*$", '', '')
- return strlen(s)
-endfun
-
-" [-- count indent-increasing '{' of (java|css) line a:lnum --]
-fun! <SID>HtmlIndentOpenAlt(lnum)
- return strlen(substitute(getline(a:lnum), '[^{]\+', '', 'g'))
-endfun
-
-" [-- count indent-decreasing '}' of (java|css) line a:lnum --]
-fun! <SID>HtmlIndentCloseAlt(lnum)
- return strlen(substitute(getline(a:lnum), '[^}]\+', '', 'g'))
-endfun
-
-" [-- return the sum of indents respecting the syntax of a:lnum --]
-fun! <SID>HtmlIndentSum(lnum, style)
- if a:style == match(getline(a:lnum), '^\s*</')
- if a:style == match(getline(a:lnum), '^\s*</\<\('.g:html_indent_tags.'\)\>')
- let open = <SID>HtmlIndentOpen(a:lnum, g:html_indent_tags)
- let close = <SID>HtmlIndentClose(a:lnum, g:html_indent_tags)
- if 0 != open || 0 != close
- return open - close
- endif
+ " relative indent steps for current line [unit &sw]:
+ let s:curind = 0
+ " relative indent steps for next line [unit &sw]:
+ let s:nextrel = 0
+
+ if a:0==0
+ let s:block = s:newstate.block
+ let tmpline = substitute(s:curline, '<\zs\/\=\w\+\>\|<!--\|-->', '\=s:CheckTag(submatch(0))', 'g')
+ if s:block == 3
+ let s:newstate.scripttype = s:GetScriptType(matchstr(tmpline, '\C.*<SCRIPT\>\zs[^>]*'))
endif
+ let s:newstate.block = s:block
+ else
+ let s:block = 0 " assume starting outside of a block
+ let s:countonly = 1 " don't change state
+ let tmpline = substitute(s:altline, '<\zs\/\=\w\+\>\|<!--\|-->', '\=s:CheckTag(submatch(0))', 'g')
+ let s:countonly = 0
endif
- if '' != &syntax &&
- \ synIDattr(synID(a:lnum, 1, 1), 'name') =~ '\(css\|java\).*' &&
- \ synIDattr(synID(a:lnum, strlen(getline(a:lnum)), 1), 'name')
- \ =~ '\(css\|java\).*'
- if a:style == match(getline(a:lnum), '^\s*}')
- return <SID>HtmlIndentOpenAlt(a:lnum) - <SID>HtmlIndentCloseAlt(a:lnum)
+endfunc "}}}
+func! s:CheckTag(itag) "{{{
+ " "tag" or "/tag" or "<!--" or "-->"
+ let ind = get(s:indent_tags, a:itag)
+ if ind == -1
+ " closing tag
+ if s:block != 0
+ " ignore itag within a block
+ return "foo"
+ endif
+ if s:nextrel == 0
+ let s:curind -= 1
+ else
+ let s:nextrel -= 1
endif
+ " if s:curind >= 1
+ " let s:curind -= 1
+ " else
+ " let s:nextrel -= 1
+ " endif
+ elseif ind == 1
+ " opening tag
+ if s:block != 0
+ return "foo"
+ endif
+ let s:nextrel += 1
+ elseif ind != 0
+ " block-tag (opening or closing)
+ return s:Blocktag(a:itag, ind)
+ endif
+ " else ind==0 (other tag found): keep indent
+ return "foo" " no matter
+endfunc "}}}
+func! s:Blocktag(blocktag, ind) "{{{
+ if a:ind > 0
+ " a block starts here
+ if s:block != 0
+ " already in a block (nesting) - ignore
+ " especially ignore comments after other blocktags
+ return "foo"
+ endif
+ let s:block = a:ind " block type
+ if s:countonly
+ return "foo"
+ endif
+ let s:newstate.blocklnr = v:lnum
+ " save allover indent for the endtag
+ let s:newstate.blocktagind = b:indent.baseindent + (s:nextrel + s:curind) * &shiftwidth
+ if a:ind == 3
+ return "SCRIPT" " all except this must be lowercase
+ " line is to be checked again for the type attribute
+ endif
+ else
+ let s:block = 0
+ " we get here if starting and closing block-tag on same line
+ endif
+ return "foo"
+endfunc "}}}
+func! s:GetScriptType(str) "{{{
+ if a:str == "" || a:str =~ "java"
+ return "javascript"
+ else
+ return ""
+ endif
+endfunc "}}}
+
+func! s:FreshState(lnum) "{{{
+ " Look back in the file (lines 1 to a:lnum-1) to calc a state for line
+ " a:lnum. A state is to know ALL relevant details about the lines
+ " 1..a:lnum-1, initial calculating (here!) can be slow, but updating is
+ " fast (incremental).
+ " State:
+ " lnum last indented line == prevnonblank(a:lnum - 1)
+ " block = 0 a:lnum located within special tag: 0:none, 2:<pre>,
+ " 3:<script>, 4:<style>, 5:<!--
+ " baseindent use this indent for line a:lnum as a start - kind of
+ " autoindent (if block==0)
+ " scripttype = '' type attribute of a script tag (if block==3)
+ " blocktagind indent for current opening (get) and closing (set)
+ " blocktag (if block!=0)
+ " blocklnr lnum of starting blocktag (if block!=0)
+ " inattr line {lnum} starts with attributes of a tag
+ let state = {}
+ let state.lnum = prevnonblank(a:lnum - 1)
+ let state.scripttype = ""
+ let state.blocktagind = -1
+ let state.block = 0
+ let state.baseindent = 0
+ let state.blocklnr = 0
+ let state.inattr = 0
+
+ if state.lnum == 0
+ return state
endif
- return 0
-endfun
-fun! HtmlIndentGet(lnum)
- " Find a non-empty line above the current line.
- let lnum = prevnonblank(a:lnum - 1)
+ " Heuristic:
+ " remember startline state.lnum
+ " look back for <pre, </pre, <script, </script, <style, </style tags
+ " remember stopline
+ " if opening tag found,
+ " assume a:lnum within block
+ " else
+ " look back in result range (stopline, startline) for comment
+ " \ delimiters (<!--, -->)
+ " if comment opener found,
+ " assume a:lnum within comment
+ " else
+ " assume usual html for a:lnum
+ " if a:lnum-1 has a closing comment
+ " look back to get indent of comment opener
+ " FI
- " Hit the start of the file, use zero indent.
- if lnum == 0
- return 0
+ " look back for blocktag
+ call cursor(a:lnum, 1)
+ let [stopline, stopcol] = searchpos('\c<\zs\/\=\%(pre\>\|script\>\|style\>\)', "bW")
+ " fugly ... why isn't there searchstr()
+ let tagline = tolower(getline(stopline))
+ let blocktag = matchstr(tagline, '\/\=\%(pre\>\|script\>\|style\>\)', stopcol-1)
+ if stopline > 0 && blocktag[0] != "/"
+ " opening tag found, assume a:lnum within block
+ let state.block = s:indent_tags[blocktag]
+ if state.block == 3
+ let state.scripttype = s:GetScriptType(matchstr(tagline, '\>[^>]*', stopcol))
+ endif
+ let state.blocklnr = stopline
+ " check preceding tags in the line:
+ let s:altline = tagline[: stopcol-2]
+ call s:CountITags(1)
+ let state.blocktagind = indent(stopline) + (s:curind + s:nextrel) * &shiftwidth
+ return state
+ elseif stopline == state.lnum
+ " handle special case: previous line (= state.lnum) contains a
+ " closing blocktag which is preceded by line-noise;
+ " blocktag == "/..."
+ let swendtag = match(tagline, '^\s*</') >= 0
+ if !swendtag
+ let [bline, bcol] = searchpos('<'.blocktag[1:].'\>', "bW")
+ let s:altline = tolower(getline(bline)[: bcol-2])
+ call s:CountITags(1)
+ let state.baseindent = indent(bline) + (s:nextrel+s:curline) * &shiftwidth
+ return state
+ endif
endif
- let restore_ic = &ic
- setlocal ic " ignore case
+ " else look back for comment
+ call cursor(a:lnum, 1)
+ let [comline, comcol, found] = searchpos('\(<!--\)\|-->', 'bpW', stopline)
+ if found == 2
+ " comment opener found, assume a:lnum within comment
+ let state.block = 5
+ let state.blocklnr = comline
+ " check preceding tags in the line:
+ let s:altline = tolower(getline(comline)[: comcol-2])
+ call s:CountITags(1)
+ let state.blocktagind = indent(comline) + (s:curind + s:nextrel) * &shiftwidth
+ return state
+ endif
- " [-- special handling for <pre>: no indenting --]
- if getline(a:lnum) =~ '\c</pre>'
- \ || 0 < searchpair('\c<pre>', '', '\c</pre>', 'nWb')
- \ || 0 < searchpair('\c<pre>', '', '\c</pre>', 'nW')
- " we're in a line with </pre> or inside <pre> ... </pre>
- if restore_ic == 0
- setlocal noic
+ " else within usual html
+ let s:altline = tolower(getline(state.lnum))
+ " check a:lnum-1 for closing comment (we need indent from the opening line)
+ let comcol = stridx(s:altline, '-->')
+ if comcol >= 0
+ call cursor(state.lnum, comcol+1)
+ let [comline, comcol] = searchpos('<!--', 'bW')
+ if comline == state.lnum
+ let s:altline = s:altline[: comcol-2]
+ else
+ let s:altline = tolower(getline(comline)[: comcol-2])
endif
+ call s:CountITags(1)
+ let state.baseindent = indent(comline) + (s:nextrel+s:curline) * &shiftwidth
+ return state
+ " TODO check tags that follow "-->"
+ endif
+
+ " else no comments
+ call s:CountITags(1)
+ let state.baseindent = indent(state.lnum) + s:nextrel * &shiftwidth
+ " line starts with end tag
+ let swendtag = match(s:altline, '^\s*</') >= 0
+ if !swendtag
+ let state.baseindent += s:curind * &shiftwidth
+ endif
+ return state
+endfunc "}}}
+
+func! s:Alien2() "{{{
+ " <pre> block
+ return -1
+endfunc "}}}
+func! s:Alien3() "{{{
+ " <script> javascript
+ if prevnonblank(v:lnum-1) == b:indent.blocklnr
+ " indent for the first line after <script>
+ return eval(s:js1indent)
+ endif
+ if b:indent.scripttype == "javascript"
+ return cindent(v:lnum)
+ else
return -1
endif
+endfunc "}}}
+func! s:Alien4() "{{{
+ " <style>
+ if prevnonblank(v:lnum-1) == b:indent.blocklnr
+ " indent for first content line
+ return eval(s:css1indent)
+ endif
+ return s:CSSIndent()
+endfunc
- " [-- special handling for <javascript>: use cindent --]
- let js = '<script.*type\s*=\s*.*java'
-
- """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
- " by Tye Zdrojewski <zdro@yahoo.com>, 05 Jun 2006
- " ZDR: This needs to be an AND (we are 'after the start of the pair' AND
- " we are 'before the end of the pair'). Otherwise, indentation
- " before the start of the script block will be affected; the end of
- " the pair will still match if we are before the beginning of the
- " pair.
- "
- if 0 < searchpair(js, '', '</script>', 'nWb')
- \ && 0 < searchpair(js, '', '</script>', 'nW')
- " we're inside javascript
- if getline(lnum) !~ js && getline(a:lnum) != '</script>'
- if restore_ic == 0
- setlocal noic
+func! s:CSSIndent() "{{{
+ " adopted $VIMRUNTIME/indent/css.vim
+ if getline(v:lnum) =~ '^\s*[*}]'
+ return cindent(v:lnum)
+ endif
+ let minline = b:indent.blocklnr
+ let pnum = s:css_prevnoncomment(v:lnum - 1, minline)
+ if pnum <= minline
+ " < is to catch errors
+ " indent for first content line after comments
+ return eval(s:css1indent)
+ endif
+ let ind = indent(pnum) + s:css_countbraces(pnum, 1) * &sw
+ let pline = getline(pnum)
+ if pline =~ '}\s*$'
+ let ind -= (s:css_countbraces(pnum, 0) - (pline =~ '^\s*}')) * &sw
+ endif
+ return ind
+endfunc "}}}
+func! s:css_prevnoncomment(lnum, stopline) "{{{
+ " caller starts from a line a:lnum-1 that is not a comment
+ let lnum = prevnonblank(a:lnum)
+ let ccol = match(getline(lnum), '\*/')
+ if ccol < 0
+ return lnum
+ endif
+ call cursor(lnum, ccol+1)
+ let lnum = search('/\*', 'bW', a:stopline)
+ if indent(".") == virtcol(".")-1
+ return prevnonblank(lnum-1)
+ else
+ return lnum
+ endif
+endfunc "}}}
+func! s:css_countbraces(lnum, count_open) "{{{
+ let brs = substitute(getline(a:lnum),'[''"].\{-}[''"]\|/\*.\{-}\*/\|/\*.*$\|[^{}]','','g')
+ let n_open = 0
+ let n_close = 0
+ for brace in split(brs, '\zs')
+ if brace == "{"
+ let n_open += 1
+ elseif brace == "}"
+ if n_open > 0
+ let n_open -= 1
+ else
+ let n_close += 1
endif
- return cindent(a:lnum)
endif
+ endfor
+ return a:count_open ? n_open : n_close
+endfunc "}}}
+
+"}}}
+func! s:Alien5() "{{{
+ " <!-- -->
+ return -1
+endfunc "}}}
+
+func! HtmlIndent() "{{{
+ let s:curline = tolower(getline(v:lnum))
+
+ let s:newstate = {}
+ let s:newstate.lnum = v:lnum
+
+ " is the first non-blank in the line the start of a tag?
+ let swendtag = match(s:curline, '^\s*</') >= 0
+
+ if prevnonblank(v:lnum-1) == b:indent.lnum && s:usestate
+ " use state (continue from previous line)
+ else
+ " start over (know nothing)
+ let b:indent = s:FreshState(v:lnum)
endif
- if getline(lnum) =~ '\c</pre>'
- " line before the current line a:lnum contains
- " a closing </pre>. --> search for line before
- " starting <pre> to restore the indent.
- let preline = prevnonblank(search('\c<pre>', 'bW') - 1)
- if preline > 0
- if restore_ic == 0
- setlocal noic
+ if b:indent.block >= 2
+ " within block
+ let endtag = s:endtags[b:indent.block-2]
+ let blockend = stridx(s:curline, endtag)
+ if blockend >= 0
+ " block ends here
+ let s:newstate.block = 0
+ " calc indent for REST OF LINE (may start more blocks):
+ let s:curline = strpart(s:curline, blockend+strlen(endtag))
+ call s:CountITags()
+ if swendtag && b:indent.block != 5
+ let indent = b:indent.blocktagind + s:curind * &shiftwidth
+ let s:newstate.baseindent = indent + s:nextrel * &shiftwidth
+ else
+ let indent = s:Alien{b:indent.block}()
+ let s:newstate.baseindent = b:indent.blocktagind + s:nextrel * &shiftwidth
endif
- return indent(preline)
+ call extend(b:indent, s:newstate, "force")
+ return indent
+ else
+ " block continues
+ " indent this line with alien method
+ let indent = s:Alien{b:indent.block}()
+ call extend(b:indent, s:newstate, "force")
+ return indent
endif
+ else
+ " not within a block - within usual html
+ " if < 2 then always 0
+ let s:newstate.block = b:indent.block
+ call s:CountITags()
+ if swendtag
+ let indent = b:indent.baseindent + s:curind * &shiftwidth
+ let s:newstate.baseindent = indent + s:nextrel * &shiftwidth
+ else
+ let indent = b:indent.baseindent
+ let s:newstate.baseindent = indent + (s:curind + s:nextrel) * &shiftwidth
+ endif
+ call extend(b:indent, s:newstate, "force")
+ return indent
endif
- let ind = <SID>HtmlIndentSum(lnum, -1)
- let ind = ind + <SID>HtmlIndentSum(a:lnum, 0)
+endfunc "}}}
- if restore_ic == 0
- setlocal noic
- endif
+" check user settings (first time), clear cpo, Modeline: {{{1
+
+" DEBUG:
+com! -nargs=* IndHtmlLocal <args>
- return indent(lnum) + (&sw * ind)
-endfun
+call HtmlIndent_CheckUserSettings()
let &cpo = s:cpo_save
unlet s:cpo_save
-" [-- EOF <runtime>/indent/html.vim --]
+" vim:set fdm=marker ts=8:
diff --git a/runtime/indent/ruby.vim b/runtime/indent/ruby.vim
index 04d130104..095b3a43c 100644
--- a/runtime/indent/ruby.vim
+++ b/runtime/indent/ruby.vim
@@ -1,9 +1,7 @@
" Vim indent file
" Language: Ruby
" Maintainer: Nikolai Weibull <now at bitwi.se>
-" Last Change: 2009 Dec 17
-" URL: http://vim-ruby.rubyforge.org
-" Anon CVS: See above site
+" URL: https://github.com/vim-ruby/vim-ruby
" Release Coordinator: Doug Kearns <dougkearns@gmail.com>
" 0. Initialization {{{1
@@ -18,9 +16,9 @@ let b:did_indent = 1
setlocal nosmartindent
" Now, set up our indentation expression and keys that trigger it.
-setlocal indentexpr=GetRubyIndent()
+setlocal indentexpr=GetRubyIndent(v:lnum)
setlocal indentkeys=0{,0},0),0],!^F,o,O,e
-setlocal indentkeys+==end,=elsif,=when,=ensure,=rescue,==begin,==end
+setlocal indentkeys+==end,=else,=elsif,=when,=ensure,=rescue,==begin,==end
" Only define the function once.
if exists("*GetRubyIndent")
@@ -33,8 +31,9 @@ set cpo&vim
" 1. Variables {{{1
" ============
-" Regex of syntax group names that are or delimit string or are comments.
-let s:syng_strcom = '\<ruby\%(String\|StringEscape\|ASCIICode' .
+" Regex of syntax group names that are or delimit strings/symbols or are comments.
+let s:syng_strcom = '\<ruby\%(Regexp\|RegexpDelimiter\|RegexpEscape' .
+ \ '\|Symbol\|String\|StringDelimiter\|StringEscape\|ASCIICode' .
\ '\|Interpolation\|NoInterpolation\|Comment\|Documentation\)\>'
" Regex of syntax group names that are strings.
@@ -43,7 +42,7 @@ let s:syng_string =
" Regex of syntax group names that are strings or documentation.
let s:syng_stringdoc =
- \'\<ruby\%(String\|Interpolation\|NoInterpolation\|StringEscape\|Documentation\)\>'
+ \'\<ruby\%(String\|Interpolation\|NoInterpolation\|StringEscape\|Documentation\)\>'
" Expression used to check whether we should skip a match with searchpair().
let s:skip_expr =
@@ -52,45 +51,60 @@ let s:skip_expr =
" 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\|def\|if\|for' .
\ '\|while\|until\|else\|elsif\|case\|when\|unless\|begin\|ensure' .
- \ '\|rescue\)\>' .
- \ '\|\%([*+/,=-]\|<<\|>>\|:\s\)\s*\zs' .
- \ '\<\%(if\|for\|while\|until\|case\|unless\|begin\)\>'
+ \ '\|rescue\):\@!\>' .
+ \ '\|\%([=,*/%+-]\|<<\|>>\|:\s\)\s*\zs' .
+ \ '\<\%(if\|for\|while\|until\|case\|unless\|begin\):\@!\>'
" Regex used for words that, at the start of a line, remove a level of indent.
let s:ruby_deindent_keywords =
- \ '^\s*\zs\<\%(ensure\|else\|rescue\|elsif\|when\|end\)\>'
+ \ '^\s*\zs\<\%(ensure\|else\|rescue\|elsif\|when\|end\):\@!\>'
" 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 = '^\s*\zs\<\%(module\|class\|def\|if\|for' .
- \ '\|while\|until\|case\|unless\|begin\)\>' .
- \ '\|\%([*+/,=-]\|<<\|>>\|:\s\)\s*\zs' .
- \ '\<\%(if\|for\|while\|until\|case\|unless\|begin\)\>' .
- \ '\|\<do\>'
+let s:end_start_regex =
+ \ '\C\%(^\s*\|[=,*/%+\-|;{]\|<<\|>>\|:\s\)\s*\zs' .
+ \ '\<\%(module\|class\|def\|if\|for\|while\|until\|case\|unless\|begin\):\@!\>' .
+ \ '\|\%(^\|[^.:@$]\)\@<=\<do:\@!\>'
" Regex that defines the middle-match for the 'end' keyword.
-let s:end_middle_regex = '\<\%(ensure\|else\|\%(\%(^\|;\)\s*\)\@<=\<rescue\>\|when\|elsif\)\>'
+let s:end_middle_regex = '\<\%(ensure\|else\|\%(\%(^\|;\)\s*\)\@<=\<rescue:\@!\>\|when\|elsif\):\@!\>'
" Regex that defines the end-match for the 'end' keyword.
-let s:end_end_regex = '\%(^\|[^.:@$]\)\@<=\<end\>'
+let s:end_end_regex = '\%(^\|[^.:@$]\)\@<=\<end:\@!\>'
" Expression used for searchpair() call for finding match for 'end' keyword.
let s:end_skip_expr = s:skip_expr .
\ ' || (expand("<cword>") == "do"' .
- \ ' && getline(".") =~ "^\\s*\\<\\(while\\|until\\|for\\)\\>")'
+ \ ' && getline(".") =~ "^\\s*\\<\\(while\\|until\\|for\\):\\@!\\>")'
" Regex that defines continuation lines, not including (, {, or [.
-let s:continuation_regex = '\%([\\*+/.,:]\|\%(<%\)\@<![=-]\|\W[|&?]\|||\|&&\)\s*\%(#.*\)\=$'
+let s:non_bracket_continuation_regex = '\%([\\.,:*/%+]\|\<and\|\<or\|\%(<%\)\@<![=-]\|\W[|&?]\|||\|&&\)\s*\%(#.*\)\=$'
" Regex that defines continuation lines.
" TODO: this needs to deal with if ...: and so on
-let s:continuation_regex2 =
- \ '\%([\\*+/.,:({[]\|\%(<%\)\@<![=-]\|\W[|&?]\|||\|&&\)\s*\%(#.*\)\=$'
+let s:continuation_regex =
+ \ '\%(%\@<![({[\\.,:*/%+]\|\<and\|\<or\|\%(<%\)\@<![=-]\|\W[|&?]\|||\|&&\)\s*\%(#.*\)\=$'
+
+" Regex that defines bracket continuations
+let s:bracket_continuation_regex = '%\@<!\%([({[]\)\s*\%(#.*\)\=$'
+
+" Regex that defines the first part of a splat pattern
+let s:splat_regex = '[[,(]\s*\*\s*\%(#.*\)\=$'
" Regex that defines blocks.
+"
+" Note that there's a slight problem with this regex and s:continuation_regex.
+" Code like this will be matched by both:
+"
+" method_call do |(a, b)|
+"
+" The reason is that the pipe matches a hanging "|" operator.
+"
let s:block_regex =
- \ '\%(\<do\>\|{\)\s*\%(|\%([*@]\=\h\w*,\=\s*\)\%(,\s*[*@]\=\h\w*\)*|\)\=\s*\%(#.*\)\=$'
+ \ '\%(\<do:\@!\>\|%\@<!{\)\s*\%(|\s*(*\s*\%([*@&]\=\h\w*,\=\s*\)\%(,\s*(*\s*[*@&]\=\h\w*\s*)*\s*\)*|\)\=\s*\%(#.*\)\=$'
+
+let s:block_continuation_regex = '^\s*[^])}\t ].*'.s:block_regex
" 2. Auxiliary Functions {{{1
" ======================
@@ -110,6 +124,11 @@ function s:IsInStringOrDocumentation(lnum, col)
return synIDattr(synID(a:lnum, a:col, 1), 'name') =~ s:syng_stringdoc
endfunction
+" Check if the character at lnum:col is inside a string delimiter
+function s:IsInStringDelimiter(lnum, col)
+ return synIDattr(synID(a:lnum, a:col, 1), 'name') == 'rubyStringDelimiter'
+endfunction
+
" Find line above 'lnum' that isn't empty, in a comment, or in a string.
function s:PrevNonBlankNonString(lnum)
let in_block = 0
@@ -118,16 +137,16 @@ function s:PrevNonBlankNonString(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.
let line = getline(lnum)
- if line =~ '^=begin$'
+ if line =~ '^=begin'
if in_block
- let in_block = 0
+ let in_block = 0
else
- break
+ break
endif
- elseif !in_block && line =~ '^=end$'
+ elseif !in_block && line =~ '^=end'
let in_block = 1
elseif !in_block && line !~ '^\s*#.*$' && !(s:IsInStringOrComment(lnum, 1)
- \ && s:IsInStringOrComment(lnum, strlen(line)))
+ \ && s:IsInStringOrComment(lnum, strlen(line)))
break
endif
let lnum = prevnonblank(lnum - 1)
@@ -139,42 +158,144 @@ endfunction
function s:GetMSL(lnum)
" Start on the line we're at and use its indent.
let msl = a:lnum
+ let msl_body = getline(msl)
let lnum = s: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)
- let col = match(line, s:continuation_regex2) + 1
- if (col > 0 && !s:IsInStringOrComment(lnum, col))
- \ || s:IsInString(lnum, strlen(line))
+
+ if 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
+ "
+ return msl
+ elseif s:Match(line, 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: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
+ "
+ 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
+ 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
+ return msl
else
- break
+ let col = match(line, s:continuation_regex) + 1
+ if (col > 0 && !s:IsInStringOrComment(lnum, col))
+ \ || s:IsInString(lnum, strlen(line))
+ let msl = lnum
+ else
+ break
+ endif
endif
+
+ let msl_body = getline(msl)
let lnum = s:PrevNonBlankNonString(lnum - 1)
endwhile
return msl
endfunction
" Check if line 'lnum' has more opening brackets than closing ones.
-function s:LineHasOpeningBrackets(lnum)
- let open_0 = 0
- let open_2 = 0
- let open_4 = 0
+function s:ExtraBrackets(lnum)
+ let opening = {'parentheses': [], 'braces': [], 'brackets': []}
+ let closing = {'parentheses': [], 'braces': [], 'brackets': []}
+
let line = getline(a:lnum)
- let pos = match(line, '[][(){}]', 0)
+ let 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 !s:IsInStringOrComment(a:lnum, pos + 1)
- let idx = stridx('(){}[]', line[pos])
- if idx % 2 == 0
- let open_{idx} = open_{idx} + 1
- else
- let open_{idx - 1} = open_{idx - 1} - 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]
+ 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
+ let 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
+ let opening.brackets = opening.brackets[0:-2]
+ endif
endif
endif
+
let pos = match(line, '[][(){}]', pos + 1)
endwhile
- return (open_0 > 0) . (open_2 > 0) . (open_4 > 0)
+
+ " 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}
+
+ for opening in opening.parentheses + opening.braces + opening.brackets
+ if opening.pos > rightmost_opening.pos
+ let rightmost_opening = opening
+ endif
+ endfor
+
+ for closing in closing.parentheses + closing.braces + closing.brackets
+ if closing.pos > rightmost_closing.pos
+ let rightmost_closing = closing
+ endif
+ endfor
+
+ return [rightmost_opening, rightmost_closing]
endfunction
function s:Match(lnum, regex)
@@ -195,32 +316,35 @@ endfunction
" 3. GetRubyIndent Function {{{1
" =========================
-function GetRubyIndent()
+function GetRubyIndent(...)
" 3.1. Setup {{{2
" ----------
- " Set up variables for restoring position in file. Could use v:lnum here.
+ " For the current line, use the first argument if given, else v:lnum
+ let clnum = a:0 ? a:1 : v:lnum
+
+ " Set up variables for restoring position in file. Could use clnum here.
let vcol = col('.')
" 3.2. Work on the current line {{{2
" -----------------------------
" Get the current line.
- let line = getline(v:lnum)
+ let line = getline(clnum)
let ind = -1
" 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(line, '^\s*[]})]')
- if col > 0 && !s:IsInStringOrComment(v:lnum, col)
- call cursor(v:lnum, col)
+ if col > 0 && !s:IsInStringOrComment(clnum, col)
+ call cursor(clnum, col)
let bs = strpart('(){}[]', stridx(')}]', line[col - 1]) * 2, 2)
if searchpair(escape(bs[0], '\['), '', bs[1], 'bW', s:skip_expr) > 0
if line[col-1]==')' && col('.') != col('$') - 1
- let ind = virtcol('.')-1
+ let ind = virtcol('.') - 1
else
- let ind = indent(s:GetMSL(line('.')))
+ let ind = indent(s:GetMSL(line('.')))
endif
endif
return ind
@@ -233,35 +357,47 @@ function GetRubyIndent()
" If we have a deindenting keyword, find its match and indent to its level.
" TODO: this is messy
- if s:Match(v:lnum, s:ruby_deindent_keywords)
- call cursor(v:lnum, 1)
+ if s:Match(clnum, s:ruby_deindent_keywords)
+ call cursor(clnum, 1)
if searchpair(s:end_start_regex, s:end_middle_regex, s:end_end_regex, 'bW',
- \ s:end_skip_expr) > 0
- let line = getline('.')
+ \ s:end_skip_expr) > 0
+ let msl = s:GetMSL(line('.'))
+ let line = getline(line('.'))
+
if strpart(line, 0, col('.') - 1) =~ '=\s*$' &&
- \ strpart(line, col('.') - 1, 2) !~ 'do'
- let ind = virtcol('.') - 1
+ \ strpart(line, col('.') - 1, 2) !~ 'do'
+ let ind = virtcol('.') - 1
+ elseif getline(msl) =~ '=\s*\(#.*\)\=$'
+ let ind = indent(line('.'))
else
- let ind = indent('.')
+ let ind = indent(msl)
endif
endif
return ind
endif
" If we are in a multi-line string or line-comment, don't do anything to it.
- if s:IsInStringOrDocumentation(v:lnum, matchend(line, '^\s*') + 1)
+ if s:IsInStringOrDocumentation(clnum, matchend(line, '^\s*') + 1)
return indent('.')
endif
+ " If we are at the closing delimiter of a "<<" heredoc-style string, set the
+ " indent to 0.
+ if line =~ '^\k\+\s*$'
+ \ && s:IsInStringDelimiter(clnum, 1)
+ \ && search('\V<<'.line, 'nbW') > 0
+ return 0
+ endif
+
" 3.3. Work on the previous line. {{{2
" -------------------------------
" Find a non-blank, non-multi-line string line above the current line.
- let lnum = s:PrevNonBlankNonString(v:lnum - 1)
+ let lnum = s:PrevNonBlankNonString(clnum - 1)
" If the line is empty and inside a string, use the previous line.
- if line =~ '^\s*$' && lnum != prevnonblank(v:lnum - 1)
- return indent(prevnonblank(v:lnum))
+ if line =~ '^\s*$' && lnum != prevnonblank(clnum - 1)
+ return indent(prevnonblank(clnum))
endif
" At the start of the file use zero indent.
@@ -269,7 +405,7 @@ function GetRubyIndent()
return 0
endif
- " Set up variables for current line.
+ " Set up variables for the previous line.
let line = getline(lnum)
let ind = indent(lnum)
@@ -278,20 +414,42 @@ function GetRubyIndent()
return indent(s:GetMSL(lnum)) + &sw
endif
- " If the previous line contained an opening bracket, and we are still in it,
- " add indent depending on the bracket type.
- if line =~ '[[({]'
- let counts = s:LineHasOpeningBrackets(lnum)
- if counts[0] == '1' && searchpair('(', '', ')', 'bW', s:skip_expr) > 0
- if col('.') + 1 == col('$')
- return ind + &sw
+ " If the previous line ended with the "*" of a splat, add a level of indent
+ if line =~ s:splat_regex
+ return indent(lnum) + &sw
+ endif
+
+ " 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 line =~ '[[({]' || line =~ '[])}]\s*\%(#.*\)\=$'
+ let [opening, closing] = s:ExtraBrackets(lnum)
+
+ if opening.pos != -1
+ if opening.type == '(' && searchpair('(', '', ')', 'bW', s:skip_expr) > 0
+ if col('.') + 1 == col('$')
+ return ind + &sw
+ else
+ return virtcol('.')
+ endif
else
- return virtcol('.')
+ let nonspace = matchend(line, '\S', opening.pos + 1) - 1
+ return nonspace > 0 ? nonspace : ind + &sw
+ endif
+ elseif closing.pos != -1
+ call cursor(lnum, closing.pos + 1)
+ normal! %
+
+ if s:Match(line('.'), s:ruby_indent_keywords)
+ return indent('.') + &sw
+ else
+ return indent('.')
endif
- elseif counts[1] == '1' || counts[2] == '1'
- return ind + &sw
else
- call cursor(v:lnum, vcol)
+ call cursor(clnum, vcol)
end
endif
@@ -301,12 +459,12 @@ function GetRubyIndent()
if col > 0
call cursor(lnum, col)
if searchpair(s:end_start_regex, '', s:end_end_regex, 'bW',
- \ s:end_skip_expr) > 0
+ \ s:end_skip_expr) > 0
let n = line('.')
let ind = indent('.')
let msl = s:GetMSL(n)
if msl != n
- let ind = indent(msl)
+ let ind = indent(msl)
end
return ind
endif
@@ -316,7 +474,6 @@ function GetRubyIndent()
if col > 0
call cursor(lnum, col)
let ind = virtcol('.') - 1 + &sw
-" let ind = indent(lnum) + &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
@@ -336,7 +493,7 @@ function GetRubyIndent()
" If the previous line wasn't a MSL and is continuation return its indent.
" TODO: the || s:IsInString() thing worries me a bit.
if p_lnum != lnum
- if s:Match(p_lnum,s:continuation_regex)||s:IsInString(p_lnum,strlen(line))
+ if s:Match(p_lnum, s:non_bracket_continuation_regex) || s:IsInString(p_lnum,strlen(line))
return ind
endif
endif
@@ -356,13 +513,15 @@ function GetRubyIndent()
return ind
endif
- " If the previous line ended with [*+/.-=], indent one extra level.
- if s:Match(lnum, s:continuation_regex)
+ " If the previous line ended with [*+/.,-=], but wasn't a block ending or a
+ " closing bracket, indent one extra level.
+ if s:Match(lnum, s:non_bracket_continuation_regex) && !s:Match(lnum, '^\s*\([\])}]\|end\)')
if lnum == p_lnum
let ind = msl_ind + &sw
else
let ind = msl_ind
endif
+ return ind
endif
" }}}2
@@ -375,4 +534,4 @@ endfunction
let &cpo = s:cpo_save
unlet s:cpo_save
-" vim:set sw=2 sts=2 ts=8 noet:
+" vim:set sw=2 sts=2 ts=8 et: