diff options
Diffstat (limited to 'runtime/indent/html.vim')
| -rw-r--r-- | runtime/indent/html.vim | 1306 |
1 files changed, 886 insertions, 420 deletions
diff --git a/runtime/indent/html.vim b/runtime/indent/html.vim index d1f439905a..b5374bd68a 100644 --- a/runtime/indent/html.vim +++ b/runtime/indent/html.vim @@ -1,537 +1,1003 @@ " Vim indent script for HTML -" General: "{{{ -" File: html.vim (Vimscript #2075) -" Author: Andy Wokula <anwoku@yahoo.de> -" Last Change: 2014 Jun 19 -" Rev Days: 13 -" Version: 0.9 -" Vim Version: Vim7 -" Description: -" Improved version of the distributed html indent script, faster on a -" range of lines. +" Header: "{{{ +" Maintainer: Bram Moolenaar +" Original Author: Andy Wokula <anwoku@yahoo.de> +" Last Change: 2014 Jul 04 +" Version: 1.0 +" Description: HTML indent script with cached state for faster indenting on a +" range of lines. +" Supports template systems through hooks. +" Supports Closure stylesheets. " " Credits: " indent/html.vim (2006 Jun 05) from J. Zellner " indent/css.vim (2006 Dec 20) from N. Weibull " " History: +" 2014 June (v1.0) overhaul (Bram) " 2012 Oct 21 (v0.9) added support for shiftwidth() " 2011 Sep 09 (v0.8) added HTML5 tags (thx to J. Zuckerman) " 2008 Apr 28 (v0.6) revised customization " 2008 Mar 09 (v0.5) fixed 'indk' issue (thx to C.J. Robinson) -" }}} +"}}} -" Init Folklore, check user settings (2nd time ++) "{{{ -if exists("b:did_indent") - finish +" 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 -" Needed for % to work when finding start of a tag. +" "j1" is included to make cindent() work better with Javascript. +setlocal cino=j1 +" "J1" should be included, but it doen't work properly before 7.4.355. +if has("patch-7.4.355") + setlocal cino+=J1 +endif +" Before patch 7.4.355 indenting after "(function() {" does not work well, add +" )2 to limit paren search. +if !has("patch-7.4.355") + setlocal cino+=)2 +endif + +" Needed for % to work when finding start/end of a tag. setlocal matchpairs+=<:> -let b:indent = {"lnum": -1} -let b:undo_indent = "set inde< indk<| unlet b:indent" +let b:undo_indent = "setlocal inde< indk< cino<" + +" b:hi_indent keeps state to speed up indenting consecutive lines. +let b:hi_indent = {"lnum": -1} -" Load Once: -if exists("*HtmlIndent") - call HtmlIndent_CheckUserSettings() - finish +"""""" Code below this is loaded only once. """"" +if exists("*HtmlIndent") && !exists('g:force_reload_html') + call HtmlIndent_CheckUserSettings() + finish endif -" Patch 7.3.694 +" shiftwidth() exists since patch 7.3.694 if exists('*shiftwidth') - let s:ShiftWidth = function('shiftwidth') + let s:ShiftWidth = function('shiftwidth') else - func! s:ShiftWidth() - return &shiftwidth - endfunc + func! s:ShiftWidth() + return &shiftwidth + endfunc endif +" Allow for line continuation below. 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 +" Check and process settings from b:html_indent and g:html_indent... variables. +" Prefer using buffer-local settings over global settings, so that there can +" be defaults for all HTML files and exceptions for specific types of HTML +" files. +func! HtmlIndent_CheckUserSettings() + "{{{ + let inctags = '' + if exists("b:html_indent_inctags") + let inctags = b:html_indent_inctags + elseif exists("g:html_indent_inctags") + let inctags = g:html_indent_inctags + endif + let b:hi_tags = {} + if len(inctags) > 0 + call s:AddITags(b:hi_tags, split(inctags, ",")) + endif - let indone = {"zero": 0 - \,"auto": "indent(prevnonblank(v:lnum-1))" - \,"inc": "b:indent.blocktagind + s: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) + let autotags = '' + if exists("b:html_indent_autotags") + let autotags = b:html_indent_autotags + elseif exists("g:html_indent_autotags") + let autotags = g:html_indent_autotags + endif + let b:hi_removed_tags = {} + if autotags + call s:RemoveITags(b:hi_removed_tags, split(autotags, ",")) + endif + + " Syntax names indicating being inside a string of an attribute value. + let string_names = [] + if exists("b:html_indent_string_names") + let string_names = b:html_indent_string_names + elseif exists("g:html_indent_string_names") + let string_names = g:html_indent_string_names + endif + let b:hi_insideStringNames = ['htmlString'] + if len(string_names) > 0 + for s in string_names + call add(b:hi_insideStringNames, s) + endfor + endif + + " Syntax names indicating being inside a tag. + let tag_names = [] + if exists("b:html_indent_tag_names") + let tag_names = b:html_indent_tag_names + elseif exists("g:html_indent_tag_names") + let tag_names = g:html_indent_tag_names + endif + let b:hi_insideTagNames = ['htmlTag', 'htmlScriptTag'] + if len(tag_names) > 0 + for s in tag_names + call add(b:hi_insideTagNames, s) + endfor + endif + + let indone = {"zero": 0 + \,"auto": "indent(prevnonblank(v:lnum-1))" + \,"inc": "b:hi_indent.blocktagind + s:ShiftWidth()"} + + let script1 = '' + if exists("b:html_indent_script1") + let script1 = b:html_indent_script1 + elseif exists("g:html_indent_script1") + let script1 = g:html_indent_script1 + endif + if len(script1) > 0 + let b:hi_js1indent = get(indone, script1, indone.zero) + else + let b:hi_js1indent = 0 + endif + + let style1 = '' + if exists("b:html_indent_style1") + let style1 = b:html_indent_style1 + elseif exists("g:html_indent_style1") + let style1 = g:html_indent_style1 + endif + if len(style1) > 0 + let b:hi_css1indent = get(indone, style1, indone.zero) + else + let b:hi_css1indent = 0 + endif + + if !exists('b:html_indent_line_limit') + if exists('g:html_indent_line_limit') + let b:html_indent_line_limit = g:html_indent_line_limit + else + let b:html_indent_line_limit = 200 endif + endif endfunc "}}} -" Init Script Vars "{{{ -let s:lasttick = 0 -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 = {} +" Init Script Vars +"{{{ +let b:hi_lasttick = 0 +let b:hi_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 + +" Fill the s:indent_tags dict with known tags. +" The key is "tagname" or "/tagname". {{{ +" The value is: +" 1 opening tag +" 2 "pre" +" 3 "script" +" 4 "style" +" 5 comment start +" -1 closing tag +" -2 "/pre" +" -3 "/script" +" -4 "/style" +" -5 comment end +let s:indent_tags = {} +let s:endtags = [0,0,0,0,0,0] " long enough for the highest index +"}}} + +" Add a list of tag names for a pair of <tag> </tag> to "tags". +func! s:AddITags(tags, taglist) + "{{{ + for itag in a:taglist + let a:tags[itag] = 1 + let a: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 s:indent_tags[a:1] = -a:id - let s:endtags[a:id-2] = a:1 - endif + +" Take a list of tag name pairs that are not to be used as tag pairs. +func! s:RemoveITags(tags, taglist) + "{{{ + for itag in a:taglist + let a:tags[itag] = 1 + let a:tags['/' . itag] = 1 + endfor 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 + +" Add a block tag, that is a tag with a different kind of indenting. +func! s:AddBlockTag(tag, id, ...) + "{{{ + if !(a:id >= 2 && a:id < len(s:endtags)) + echoerr 'AddBlockTag ' . a:id + 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] = "</" . a:tag . ">" + else + let s:indent_tags[a:1] = -a:id + let s:endtags[a:id] = a:1 + endif 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', +" Add known tag pairs. +" Self-closing tags and tags that are sometimes {{{ +" self-closing (e.g., <p>) are not here (when encountering </p> we can find +" the matching <p>, but not the other way around). +" Old HTML tags: +call s:AddITags(s:indent_tags, [ + \ 'a', 'abbr', 'acronym', 'address', 'b', 'bdo', 'big', + \ 'blockquote', 'body', 'button', 'caption', 'center', 'cite', 'code', + \ 'colgroup', 'del', 'dfn', 'dir', 'div', 'dl', 'em', 'fieldset', 'font', + \ 'form', 'frameset', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'head', 'html', + \ 'i', 'iframe', 'ins', 'kbd', 'label', 'legend', 'li', + \ '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']) + \ 'tr', 'tbody', 'tfoot', 'thead']) -" tags added 2011 Sep 09 (especially HTML5 tags): -call s:AddITags(['area', 'article', 'aside', 'audio', 'bdi', 'canvas', +" Tags added 2011 Sep 09 (especially HTML5 tags): +call s:AddITags(s:indent_tags, [ + \ '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']) - "}}} -" Add Block Tags: contain alien content "{{{ + +" Add Block Tags: these contain alien content +"{{{ call s:AddBlockTag('pre', 2) call s:AddBlockTag('script', 3) call s:AddBlockTag('style', 4) call s:AddBlockTag('<!--', 5, '-->') "}}} -func! s:CountITags(...) "{{{ +" Return non-zero when "tagname" is an opening tag, not being a block tag, for +" which there should be a closing tag. Can be used by scripts that include +" HTML indenting. +func! HtmlIndent_IsOpenTag(tagname) + "{{{ + if get(s:indent_tags, a:tagname) == 1 + return 1 + endif + return get(b:hi_tags, a:tagname) == 1 +endfunc "}}} - " relative indent steps for current line [unit &sw]: - let s:curind = 0 - " relative indent steps for next line [unit &sw]: - let s:nextrel = 0 +" Get the value for "tagname", taking care of buffer-local tags. +func! s:get_tag(tagname) + "{{{ + let i = get(s:indent_tags, a:tagname) + if (i == 1 || i == -1) && get(b:hi_removed_tags, a:tagname) != 0 + return 0 + endif + if i == 0 + let i = get(b:hi_tags, a:tagname) + endif + return i +endfunc "}}} - 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 +" Count the number of start and end tags in "text". +func! s:CountITags(text) + "{{{ + " Store the result in s:curind and s:nextrel. + let s:curind = 0 " relative indent steps for current line [unit &sw]: + let s:nextrel = 0 " relative indent steps for next line [unit &sw]: + let s:block = 0 " assume starting outside of a block + let s:countonly = 1 " don't change state + call substitute(a:text, '<\zs/\=\w\+\>\|<!--\|-->', '\=s:CheckTag(submatch(0))', 'g') + let s:countonly = 0 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 + +" Count the number of start and end tags in text. +func! s:CountTagsAndState(text) + "{{{ + " Store the result in s:curind and s:nextrel. Update b:hi_newstate.block. + let s:curind = 0 " relative indent steps for current line [unit &sw]: + let s:nextrel = 0 " relative indent steps for next line [unit &sw]: + + let s:block = b:hi_newstate.block + let tmp = substitute(a:text, '<\zs/\=\w\+\>\|<!--\|-->', '\=s:CheckTag(submatch(0))', 'g') + if s:block == 3 + let b:hi_newstate.scripttype = s:GetScriptType(matchstr(tmp, '\C.*<SCRIPT\>\zs[^>]*')) + endif + let b:hi_newstate.block = s:block 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) * s: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 + +" Used by s:CountITags() and s:CountTagsAndState(). +func! s:CheckTag(itag) + "{{{ + " Returns an empty string or "SCRIPT". + " a:itag can be "tag" or "/tag" or "<!--" or "-->" + let ind = s:get_tag(a:itag) + if ind == -1 + " closing tag + if s:block != 0 + " ignore itag within a block + return "" endif - return "foo" -endfunc "}}} -func! s:GetScriptType(str) "{{{ - if a:str == "" || a:str =~ "java" - return "javascript" + if s:nextrel == 0 + let s:curind -= 1 else - return "" + let s:nextrel -= 1 + endif + elseif ind == 1 + " opening tag + if s:block != 0 + return "" endif + let s:nextrel += 1 + elseif ind != 0 + " block-tag (opening or closing) + return s:CheckBlockTag(a:itag, ind) + " else ind==0 (other tag found): keep indent + endif + return "" 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 +" Used by s:CheckTag(). Returns an empty string or "SCRIPT". +func! s:CheckBlockTag(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 "" + endif + let s:block = a:ind " block type + if s:countonly + return "" + endif + let b:hi_newstate.blocklnr = v:lnum + " save allover indent for the endtag + let b:hi_newstate.blocktagind = b:hi_indent.baseindent + (s:nextrel + s:curind) * s: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 a block-tag on the same line + endif + return "" +endfunc "}}} + +" Return the <script> type: either "javascript" or "" +func! s:GetScriptType(str) + "{{{ + if a:str == "" || a:str =~ "java" + return "javascript" + else + return "" + endif +endfunc "}}} - " 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 - - " look back for blocktag - call cursor(a:lnum, 1) - let [stopline, stopcol] = searchpos('\c<\zs\/\=\%(pre\>\|script\>\|style\>\)', "bW") +" Look back in the file, starting at a:lnum - 1, to compute a state for the +" start of line a:lnum. Return the new state. +func! s:FreshState(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). + " TODO: this should be split up in detecting the block type and computing the + " indent for the block type, so that when we do not know the indent we do + " not need to clear the whole state and re-detect the block type again. + " 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 + + " 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 + + " look back for a blocktag + call cursor(a:lnum, 1) + let [stopline, stopcol] = searchpos('\c<\zs\/\=\%(pre\>\|script\>\|style\>\)', "bW") + if stopline > 0 " 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) * s:ShiftWidth() - return state + let blocktag = matchstr(tagline, '\/\=\%(pre\>\|script\>\|style\>\)', stopcol - 1) + if 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: + call s:CountITags(tagline[: stopcol-2]) + let state.blocktagind = indent(stopline) + (s:curind + s:nextrel) * s: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) * s:ShiftWidth() - return state - endif + " 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") + call s:CountITags(tolower(getline(bline)[: bcol-2])) + let state.baseindent = indent(bline) + (s:curind + s:nextrel) * s:ShiftWidth() + return state + endif endif + endif - " 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) * s:ShiftWidth() - return state - endif + " else look back for comment + call cursor(a:lnum, 1) + let [comlnum, comcol, found] = searchpos('\(<!--\)\|-->', 'bpW', stopline) + if found == 2 + " comment opener found, assume a:lnum within comment + let state.block = 5 + let state.blocklnr = comlnum + " check preceding tags in the line: + call s:CountITags(tolower(getline(comlnum)[: comcol-2])) + let state.blocktagind = indent(comlnum) + (s:curind + s:nextrel) * s:ShiftWidth() + return state + endif - " 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) * s:ShiftWidth() - return state - " TODO check tags that follow "-->" + " else within usual HTML + let text = tolower(getline(state.lnum)) + + " Check a:lnum-1 for closing comment (we need indent from the opening line). + " Not when other tags follow (might be --> inside a string). + let comcol = stridx(text, '-->') + if comcol >= 0 && match(text, '[<>]', comcol) <= 0 + call cursor(state.lnum, comcol + 1) + let [comlnum, comcol] = searchpos('<!--', 'bW') + if comlnum == state.lnum + let text = text[: comcol-2] + else + let text = tolower(getline(comlnum)[: comcol-2]) endif + call s:CountITags(text) + let state.baseindent = indent(comlnum) + (s:curind + s:nextrel) * s:ShiftWidth() + " TODO check tags that follow "-->" + return state + endif - " Check if the previous line starts with end tag. - let swendtag = match(s:altline, '^\s*</') >= 0 - - " If previous line ended in a closing tag, line up with the opening tag. - " Avoids aligning with continuation lines. - " TODO: this assumes the start tag is at the start of a line. - if !swendtag && s:altline =~ '</\w\+\s*>\s*$' - call cursor(state.lnum, 99999) - normal F<h - " TODO: doesn't work for nested <br> and the like - let slnum = searchpair('<\w\+', '', '</\w', 'bW') - if slnum > 0 - let state.baseindent = indent(slnum) - return state + " Check if the previous line starts with end tag. + let swendtag = match(text, '^\s*</') >= 0 + + " If previous line ended in a closing tag, line up with the opening tag. + if !swendtag && text =~ '</\w\+\s*>\s*$' + call cursor(state.lnum, 99999) + normal F< + let start_lnum = HtmlIndent_FindStartTag() + if start_lnum > 0 + let state.baseindent = indent(start_lnum) + if col('.') > 2 + " check for tags before the matching opening tag. + let text = getline(start_lnum) + let swendtag = match(text, '^\s*</') >= 0 + call s:CountITags(text[: col('.') - 2]) + let state.baseindent += s:nextrel * s:ShiftWidth() + if !swendtag + let state.baseindent += s:curind * s:ShiftWidth() endif + endif + return state endif + endif - " else no comments - let state.lnum = s:FindTagStart(state.lnum) - let s:altline = tolower(getline(state.lnum)) - call s:CountITags(1) - let state.baseindent = indent(state.lnum) + s:nextrel * s:ShiftWidth() - if !swendtag - let state.baseindent += s:curind * s:ShiftWidth() - endif - return state + " Else: no comments. Skip backwards to find the tag we're inside. + let [state.lnum, found] = HtmlIndent_FindTagStart(state.lnum) + " Check if that line starts with end tag. + let text = getline(state.lnum) + let swendtag = match(text, '^\s*</') >= 0 + call s:CountITags(tolower(text)) + let state.baseindent = indent(state.lnum) + s:nextrel * s:ShiftWidth() + if !swendtag + let state.baseindent += s:curind * s:ShiftWidth() + endif + return state +endfunc "}}} + +" Indent inside a <pre> block: Keep indent as-is. +func! s:Alien2() + "{{{ + return -1 endfunc "}}} -func! s:Alien2() "{{{ - " <pre> block +" Return the indent inside a <script> block for javascript. +func! s:Alien3() + "{{{ + let lnum = prevnonblank(v:lnum - 1) + while lnum > 1 && getline(lnum) =~ '^\s*/[/*]' + " Skip over comments to avoid that cindent() aligns with the <script> tag + let lnum = prevnonblank(lnum - 1) + endwhile + if lnum == b:hi_indent.blocklnr + " indent for the first line after <script> + return eval(b:hi_js1indent) + endif + if b:hi_indent.scripttype == "javascript" + return cindent(v:lnum) + else return -1 + endif 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 + +" Return the indent inside a <style> block. +func! s:Alien4() + "{{{ + if prevnonblank(v:lnum-1) == b:hi_indent.blocklnr + " indent for first content line + return eval(b:hi_css1indent) + endif + return s:CSSIndent() 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 -func! s:CSSIndent() "{{{ - " adopted $VIMRUNTIME/indent/css.vim - if getline(v:lnum) =~ '^\s*[*}]' - return cindent(v:lnum) +" Indending inside a <style> block. Returns the indent. +func! s:CSSIndent() + "{{{ + " This handles standard CSS and also Closure stylesheets where special lines + " start with @. + " When the line starts with '*' or the previous line starts with "/*" + " and does not end in "*/", use C indenting to format the comment. + " Adopted $VIMRUNTIME/indent/css.vim + let curtext = getline(v:lnum) + if curtext =~ '^\s*[*]' + \ || (v:lnum > 1 && getline(v:lnum - 1) =~ '\s*/\*' + \ && getline(v:lnum - 1) !~ '\*/\s*$') + return cindent(v:lnum) + endif + + let min_lnum = b:hi_indent.blocklnr + let prev_lnum = s:CssPrevNonComment(v:lnum - 1, min_lnum) + let [prev_lnum, found] = HtmlIndent_FindTagStart(prev_lnum) + if prev_lnum <= min_lnum + " Just below the <style> tag, indent for first content line after comments. + return eval(b:hi_css1indent) + endif + + " If the current line starts with "}" align with it's match. + if curtext =~ '^\s*}' + call cursor(v:lnum, 1) + try + normal! % + " Found the matching "{", align with it after skipping unfinished lines. + let align_lnum = s:CssFirstUnfinished(line('.'), min_lnum) + return indent(align_lnum) + catch + " can't find it, try something else, but it's most likely going to be + " wrong + endtry + endif + + " add indent after { + let brace_counts = HtmlIndent_CountBraces(prev_lnum) + let extra = brace_counts.c_open * s:ShiftWidth() + + let prev_text = getline(prev_lnum) + let below_end_brace = prev_text =~ '}\s*$' + + " Search back to align with the first line that's unfinished. + let align_lnum = s:CssFirstUnfinished(prev_lnum, min_lnum) + + " Handle continuation lines if aligning with previous line and not after a + " "}". + if extra == 0 && align_lnum == prev_lnum && !below_end_brace + let prev_hasfield = prev_text =~ '^\s*[a-zA-Z0-9-]\+:' + let prev_special = prev_text =~ '^\s*\(/\*\|@\)' + if curtext =~ '^\s*\(/\*\|@\)' + " if the current line is not a comment or starts with @ (used by template + " systems) reduce indent if previous line is a continuation line + if !prev_hasfield && !prev_special + let extra = -s:ShiftWidth() + endif + else + let cur_hasfield = curtext =~ '^\s*[a-zA-Z0-9-]\+:' + let prev_unfinished = s:CssUnfinished(prev_text) + if !cur_hasfield && (prev_hasfield || prev_unfinished) + " Continuation line has extra indent if the previous line was not a + " continuation line. + let extra = s:ShiftWidth() + " Align with @if + if prev_text =~ '^\s*@if ' + let extra = 4 + endif + elseif cur_hasfield && !prev_hasfield && !prev_special + " less indent below a continuation line + let extra = -s:ShiftWidth() + endif endif - let minline = b:indent.blocklnr - let pnum = s:css_prevnoncomment(v:lnum - 1, minline) - let pnum = s:FindTagStart(pnum) - if pnum <= minline - " < is to catch errors - " indent for first content line after comments - return eval(s:css1indent) + endif + + if below_end_brace + " find matching {, if that line starts with @ it's not the start of a rule + " but something else from a template system + call cursor(prev_lnum, 1) + call search('}\s*$') + try + normal! % + " Found the matching "{", align with it. + let align_lnum = s:CssFirstUnfinished(line('.'), min_lnum) + let special = getline(align_lnum) =~ '^\s*@' + catch + let special = 0 + endtry + if special + " do not reduce indent below @{ ... } + if extra < 0 + let extra += s:ShiftWidth() + endif + else + let extra -= (brace_counts.c_close - (prev_text =~ '^\s*}')) * s:ShiftWidth() endif - let ind = indent(pnum) + s:css_countbraces(pnum, 1) * s:ShiftWidth() - let pline = getline(pnum) - if pline =~ '}\s*$' - let ind -= (s:css_countbraces(pnum, 0) - (pline =~ '^\s*}')) * s:ShiftWidth() + endif + + " if no extra indent yet... + if extra == 0 + if brace_counts.p_open > brace_counts.p_close + " previous line has more ( than ): add a shiftwidth + let extra = s:ShiftWidth() + elseif brace_counts.p_open < brace_counts.p_close + " previous line has more ) than (: subtract a shiftwidth + let extra = -s:ShiftWidth() endif - return ind + endif + + return indent(align_lnum) + extra +endfunc "}}} + +" Inside <style>: Whether a line is unfinished. +func! s:CssUnfinished(text) + "{{{ + return a:text =~ '\s\(||\|&&\|:\)\s*$' 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) + +" Search back for the first unfinished line above "lnum". +func! s:CssFirstUnfinished(lnum, min_lnum) + "{{{ + let align_lnum = a:lnum + while align_lnum > a:min_lnum && s:CssUnfinished(getline(align_lnum - 1)) + let align_lnum -= 1 + endwhile + return align_lnum +endfunc "}}} + +" Find the non-empty line at or before "lnum" that is not a comment. +func! s:CssPrevNonComment(lnum, stopline) + "{{{ + " caller starts from a line a:lnum + 1 that is not a comment + let lnum = prevnonblank(a:lnum) + while 1 let ccol = match(getline(lnum), '\*/') if ccol < 0 - return lnum + " No comment end thus its something else. + return lnum endif - call cursor(lnum, ccol+1) + call cursor(lnum, ccol + 1) + " Search back for the /* that starts the comment let lnum = search('/\*', 'bW', a:stopline) - if indent(".") == virtcol(".")-1 - return prevnonblank(lnum-1) + if indent(".") == virtcol(".") - 1 + " The found /* is at the start of the line. Now go back to the line + " above it and again check if it is a comment. + let lnum = prevnonblank(lnum - 1) else - return lnum + " /* is after something else, thus it's not a comment line. + return lnum endif + endwhile 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 - endif - endfor - return a:count_open ? n_open : n_close |