annotate runtime/indent/xml.vim @ 15729:fe57e4f0eac1

Update runtime files. commit https://github.com/vim/vim/commit/314dd79cac2adc10304212d1980d23ecf6782cfc Author: Bram Moolenaar <Bram@vim.org> Date: Sun Feb 3 15:27:20 2019 +0100 Update runtime files.
author Bram Moolenaar <Bram@vim.org>
date Sun, 03 Feb 2019 15:30:09 +0100
parents 8b334e4cb97f
children bd7461db24b3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
15194
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
1 " Language: xml
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
2 " Repository: https://github.com/chrisbra/vim-xml-ftplugin
15729
fe57e4f0eac1 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
3 " Last Changed: Jan 28, 2019
15194
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
4 " Maintainer: Christian Brabandt <cb@256bit.org>
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
5 " Previous Maintainer: Johannes Zellner <johannes@zellner.org>
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
6 " Last Change:
15729
fe57e4f0eac1 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
7 " 20190128 - Make sure to find previous tag
fe57e4f0eac1 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
8 " https://github.com/chrisbra/vim-xml-ftplugin/issues/4
15194
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
9 " 20181116 - Fix indentation when tags start with a colon or an underscore
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
10 " https://github.com/vim/vim/pull/926
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
11 " 20181022 - Do not overwrite indentkeys setting
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
12 " https://github.com/chrisbra/vim-xml-ftplugin/issues/1
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
13 " 20180724 - Correctly indent xml comments https://github.com/vim/vim/issues/3200
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
14 "
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
15 " Notes:
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
16 " 1) does not indent pure non-xml code (e.g. embedded scripts)
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
17 " 2) will be confused by unbalanced tags in comments
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
18 " or CDATA sections.
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
19 " 2009-05-26 patch by Nikolai Weibull
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
20 " TODO: implement pre-like tags, see xml_indent_open / xml_indent_close
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
21
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
22 " Only load this indent file when no other was loaded.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
23 if exists("b:did_indent")
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
24 finish
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
25 endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
26 let b:did_indent = 1
3526
dd6c2497c997 Fix more 'cpo' issues in runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2034
diff changeset
27 let s:keepcpo= &cpo
dd6c2497c997 Fix more 'cpo' issues in runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2034
diff changeset
28 set cpo&vim
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
29
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
30 " [-- local settings (must come before aborting the script) --]
15194
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
31 " Attention: Parameter use_syntax_check is used by the docbk.vim indent script
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
32 setlocal indentexpr=XmlIndentGet(v:lnum,1)
14999
2b30a2b4bde2 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 14421
diff changeset
33 setlocal indentkeys=o,O,*<Return>,<>>,<<>,/,{,},!^F
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
34
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
35 if !exists('b:xml_indent_open')
15194
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
36 let b:xml_indent_open = '.\{-}<[:A-Z_a-z]'
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
37 " pre tag, e.g. <address>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
38 " let b:xml_indent_open = '.\{-}<[/]\@!\(address\)\@!'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
39 endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
40
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
41 if !exists('b:xml_indent_close')
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
42 let b:xml_indent_close = '.\{-}</'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
43 " end pre tag, e.g. </address>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
44 " let b:xml_indent_close = '.\{-}</\(address\)\@!'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
45 endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
46
3713
9910cbff5f16 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3526
diff changeset
47 let &cpo = s:keepcpo
9910cbff5f16 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3526
diff changeset
48 unlet s:keepcpo
9910cbff5f16 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3526
diff changeset
49
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
50 " [-- finish, if the function already exists --]
3713
9910cbff5f16 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3526
diff changeset
51 if exists('*XmlIndentGet')
15194
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
52 finish
3713
9910cbff5f16 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3526
diff changeset
53 endif
9910cbff5f16 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3526
diff changeset
54
9910cbff5f16 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3526
diff changeset
55 let s:keepcpo= &cpo
9910cbff5f16 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3526
diff changeset
56 set cpo&vim
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
57
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
58 fun! <SID>XmlIndentWithPattern(line, pat)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
59 let s = substitute('x'.a:line, a:pat, "\1", 'g')
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
60 return strlen(substitute(s, "[^\1].*$", '', ''))
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
61 endfun
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
62
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
63 " [-- check if it's xml --]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
64 fun! <SID>XmlIndentSynCheck(lnum)
15194
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
65 if &syntax != ''
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
66 let syn1 = synIDattr(synID(a:lnum, 1, 1), 'name')
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
67 let syn2 = synIDattr(synID(a:lnum, strlen(getline(a:lnum)) - 1, 1), 'name')
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
68 if syn1 != '' && syn1 !~ 'xml' && syn2 != '' && syn2 !~ 'xml'
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
69 " don't indent pure non-xml code
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
70 return 0
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
71 endif
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
72 endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
73 return 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
74 endfun
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
75
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
76 " [-- return the sum of indents of a:lnum --]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
77 fun! <SID>XmlIndentSum(lnum, style, add)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
78 let line = getline(a:lnum)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
79 if a:style == match(line, '^\s*</')
15194
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
80 return (shiftwidth() *
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
81 \ (<SID>XmlIndentWithPattern(line, b:xml_indent_open)
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
82 \ - <SID>XmlIndentWithPattern(line, b:xml_indent_close)
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
83 \ - <SID>XmlIndentWithPattern(line, '.\{-}/>'))) + a:add
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
84 else
15194
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
85 return a:add
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
86 endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
87 endfun
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
88
15194
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
89 " Main indent function
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
90 fun! XmlIndentGet(lnum, use_syntax_check)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
91 " Find a non-empty line above the current line.
15194
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
92 let plnum = prevnonblank(a:lnum - 1)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
93 " Hit the start of the file, use zero indent.
15194
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
94 if plnum == 0
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
95 return 0
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
96 endif
15729
fe57e4f0eac1 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
97 " Find previous line with a tag (regardless whether open or closed,
fe57e4f0eac1 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
98 " but always start restrict the match to a line before the current one
fe57e4f0eac1 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
99 let ptag_pattern = '\%(.\{-}<[/:A-Z_a-z]\)'. '\%(\&\%<'. line('.').'l\)'
fe57e4f0eac1 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
100 let ptag = search(ptag_pattern, 'bnw')
fe57e4f0eac1 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15194
diff changeset
101
15194
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
102 let syn_name = ''
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
103 if a:use_syntax_check
15194
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
104 let check_lnum = <SID>XmlIndentSynCheck(plnum)
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
105 let check_alnum = <SID>XmlIndentSynCheck(a:lnum)
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
106 if check_lnum == 0 || check_alnum == 0
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
107 return indent(a:lnum)
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
108 endif
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
109 let syn_name = synIDattr(synID(a:lnum, strlen(getline(a:lnum)) - 1, 1), 'name')
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
110 endif
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
111
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
112 if syn_name =~ 'Comment'
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
113 return <SID>XmlIndentComment(a:lnum)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
114 endif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
115
15194
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
116 " Get indent from previous tag line
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
117 let ind = <SID>XmlIndentSum(ptag, -1, indent(ptag))
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
118 " Determine indent from current line
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
119 let ind = <SID>XmlIndentSum(a:lnum, 0, ind)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
120 return ind
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
121 endfun
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
122
15194
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
123 " return indent for a commented line,
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
124 " the middle part might be indented on additional level
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
125 func! <SID>XmlIndentComment(lnum)
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
126 let ptagopen = search(b:xml_indent_open, 'bnw')
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
127 let ptagclose = search(b:xml_indent_close, 'bnw')
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
128 if getline(a:lnum) =~ '<!--'
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
129 " if previous tag was a closing tag, do not add
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
130 " one additional level of indent
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
131 if ptagclose > ptagopen && a:lnum > ptagclose
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
132 return indent(ptagclose)
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
133 else
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
134 " start of comment, add one indentation level
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
135 return indent(ptagopen) + shiftwidth()
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
136 endif
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
137 elseif getline(a:lnum) =~ '-->'
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
138 " end of comment, same as start of comment
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
139 return indent(search('<!--', 'bnw'))
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
140 else
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
141 " middle part of comment, add one additional level
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
142 return indent(search('<!--', 'bnw')) + shiftwidth()
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
143 endif
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
144 endfunc
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
145
3526
dd6c2497c997 Fix more 'cpo' issues in runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2034
diff changeset
146 let &cpo = s:keepcpo
dd6c2497c997 Fix more 'cpo' issues in runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2034
diff changeset
147 unlet s:keepcpo
dd6c2497c997 Fix more 'cpo' issues in runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2034
diff changeset
148
15194
8b334e4cb97f Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14999
diff changeset
149 " vim:ts=4 et sts=-1 sw=0