comparison runtime/indent/tex.vim @ 13937:cd513458728c

Updated runtime files commit https://github.com/vim/vim/commit/eb3dc87f01391bb075d97aef3d00f91b4e08a25c Author: Bram Moolenaar <Bram@vim.org> Date: Sun May 13 22:34:24 2018 +0200 Updated runtime files
author Christian Brabandt <cb@256bit.org>
date Sun, 13 May 2018 22:45:06 +0200
parents a9fdf01085a8
children 74e3316c1d5a
comparison
equal deleted inserted replaced
13936:692a7c488651 13937:cd513458728c
1 " Vim indent file for TeX 1 " Vim indent file
2 " Language: TeX 2 " Language: LaTeX
3 " Maintainer: Christian Brabandt <cb@256bit.org> 3 " Maintainer: Yichao Zhou <broken.zhou AT gmail.com>
4 " Previous Maintainer: YiChao Zhou <broken.zhou AT gmail.com> 4 " Created: Sat, 16 Feb 2002 16:50:19 +0100
5 " Latest Revision: 2017-05-03 5 " Version: 1.0.0
6 " Version: 0.9.3
7 " Repository: https://github.com/chrisbra/vim-tex-indent
8 " Documention: :h ft-tex-indent
9 " Created: Sat, 16 Feb 2002 16:50:19 +0100
10 " Please email me if you found something I can do. Comments, bug report and 6 " Please email me if you found something I can do. Comments, bug report and
11 " feature request are welcome. 7 " feature request are welcome.
12 8
13 " Last Update: {{{1 9 " Last Update: {{{
14 " 25th Sep 2002, by LH : 10 " 25th Sep 2002, by LH :
15 " (*) better support for the option 11 " (*) better support for the option
16 " (*) use some regex instead of several '||'. 12 " (*) use some regex instead of several '||'.
17 " Oct 9th, 2003, by JT: 13 " Oct 9th, 2003, by JT:
18 " (*) don't change indentation of lines starting with '%' 14 " (*) don't change indentation of lines starting with '%'
19 " 2005/06/15, Moshe Kaminsky <kaminsky AT math.huji.ac.il> 15 " 2005/06/15, Moshe Kaminsky <kaminsky AT math.huji.ac.il>
20 " (*) New variables: 16 " (*) New variables:
21 " g:tex_items, g:tex_itemize_env, g:tex_noindent_env 17 " g:tex_items, g:tex_itemize_env, g:tex_noindent_env
22 " 2011/3/6, by Zhou YiChao <broken.zhou AT gmail.com> 18 " 2011/3/6, by Yichao Zhou <broken.zhou AT gmail.com>
23 " (*) Don't change indentation of lines starting with '%' 19 " (*) Don't change indentation of lines starting with '%'
24 " I don't see any code with '%' and it doesn't work properly 20 " I don't see any code with '%' and it doesn't work properly
25 " so I add some code. 21 " so I add some code.
26 " (*) New features: Add smartindent-like indent for "{}" and "[]". 22 " (*) New features: Add smartindent-like indent for "{}" and "[]".
27 " (*) New variables: g:tex_indent_brace 23 " (*) New variables: g:tex_indent_brace
28 " 2011/9/25, by Zhou Yichao <broken.zhou AT gmail.com> 24 " 2011/9/25, by Yichao Zhou <broken.zhou AT gmail.com>
29 " (*) Bug fix: smartindent-like indent for "[]" 25 " (*) Bug fix: smartindent-like indent for "[]"
30 " (*) New features: Align with "&". 26 " (*) New features: Align with "&".
31 " (*) New variable: g:tex_indent_and. 27 " (*) New variable: g:tex_indent_and.
32 " 2011/10/23 by Zhou Yichao <broken.zhou AT gmail.com> 28 " 2011/10/23 by Yichao Zhou <broken.zhou AT gmail.com>
33 " (*) Bug fix: improve the smartindent-like indent for "{}" and 29 " (*) Bug fix: improve the smartindent-like indent for "{}" and
34 " "[]". 30 " "[]".
35 " 2012/02/27 by Zhou Yichao <broken.zhou AT gmail.com> 31 " 2012/02/27 by Yichao Zhou <broken.zhou AT gmail.com>
36 " (*) Bug fix: support default folding marker. 32 " (*) Bug fix: support default folding marker.
37 " (*) Indent with "&" is not very handy. Make it not enable by 33 " (*) Indent with "&" is not very handy. Make it not enable by
38 " default. 34 " default.
39 " 2012/03/06 by Zhou Yichao <broken.zhou AT gmail.com> 35 " 2012/03/06 by Yichao Zhou <broken.zhou AT gmail.com>
40 " (*) Modify "&" behavior and make it default again. Now "&" 36 " (*) Modify "&" behavior and make it default again. Now "&"
41 " won't align when there are more then one "&" in the previous 37 " won't align when there are more then one "&" in the previous
42 " line. 38 " line.
43 " (*) Add indent "\left(" and "\right)" 39 " (*) Add indent "\left(" and "\right)"
44 " (*) Trust user when in "verbatim" and "lstlisting" 40 " (*) Trust user when in "verbatim" and "lstlisting"
45 " 2012/03/11 by Zhou Yichao <broken.zhou AT gmail.com> 41 " 2012/03/11 by Yichao Zhou <broken.zhou AT gmail.com>
46 " (*) Modify "&" so that only indent when current line start with 42 " (*) Modify "&" so that only indent when current line start with
47 " "&". 43 " "&".
48 " 2012/03/12 by Zhou Yichao <broken.zhou AT gmail.com> 44 " 2012/03/12 by Yichao Zhou <broken.zhou AT gmail.com>
49 " (*) Modify indentkeys. 45 " (*) Modify indentkeys.
50 " 2012/03/18 by Zhou Yichao <broken.zhou AT gmail.com> 46 " 2012/03/18 by Yichao Zhou <broken.zhou AT gmail.com>
51 " (*) Add &cpo 47 " (*) Add &cpo
52 " 2013/05/02 by Zhou Yichao <broken.zhou AT gmail.com> 48 " 2013/05/02 by Yichao Zhou <broken.zhou AT gmail.com>
53 " (*) Fix problem about GetTeXIndent checker. Thank Albert Netymk 49 " (*) Fix problem about GetTeXIndent checker. Thank Albert Netymk
54 " for reporting this. 50 " for reporting this.
55 " 2014/06/23 by Zhou Yichao <broken.zhou AT gmail.com> 51 " 2014/06/23 by Yichao Zhou <broken.zhou AT gmail.com>
56 " (*) Remove the feature g:tex_indent_and because it is buggy. 52 " (*) Remove the feature g:tex_indent_and because it is buggy.
57 " (*) If there is not any obvious indentation hints, we do not 53 " (*) If there is not any obvious indentation hints, we do not
58 " alert our user's current indentation. 54 " alert our user's current indentation.
59 " (*) g:tex_indent_brace now only works if the open brace is the 55 " (*) g:tex_indent_brace now only works if the open brace is the
60 " last character of that line. 56 " last character of that line.
61 " 2014/08/03 by Zhou Yichao <broken.zhou AT gmail.com> 57 " 2014/08/03 by Yichao Zhou <broken.zhou AT gmail.com>
62 " (*) Indent current line if last line has larger indentation 58 " (*) Indent current line if last line has larger indentation
63 " 2014/08/09 by Zhou Yichao <broken.zhou AT gmail.com> 59 " 2016/11/08 by Yichao Zhou <broken.zhou AT gmail.com>
64 " (*) Add missing return value for s:GetEndIndentation(...) 60 " (*) Fix problems for \[ and \]. Thanks Bruno for reporting.
65 " 2017/05/02: new maintainer Christian Brabandt 61 " 2017/04/30 by Yichao Zhou <broken.zhou AT gmail.com>
66 " 2017/05/02: use shiftwidth() function 62 " (*) Fix a bug between g:tex_noindent_env and g:tex_indent_items
67 " 2017/05/02: do not add indent when environment starts and ends 63 " Now g:tex_noindent_env='document\|verbatim\|itemize' (Emacs
68 " at previous line 64 " style) is supported. Thanks Miles Wheeler for reporting.
69 " 2017/05/03: release 0.9.3 submitted for inclusion with Vim 65 " 2018/02/07 by Yichao Zhou <broken.zhou AT gmail.com>
66 " (*) Make indentation more smart in the normal mode
70 " 67 "
71 " }}} 68 " }}}
72 " Only define the function once {{{1 69
70 " Document: {{{
71 "
72 " To set the following options (ok, currently it's just one), add a line like
73 " let g:tex_indent_items = 1
74 " to your ~/.vimrc.
75 "
76 " * g:tex_indent_brace
77 "
78 " If this variable is unset or non-zero, it will use smartindent-like style
79 " for "{}" and "[]". Now this only works if the open brace is the last
80 " character of that line.
81 "
82 " % Example 1
83 " \usetikzlibrary{
84 " external
85 " }
86 "
87 " % Example 2
88 " \tikzexternalize[
89 " prefix=tikz]
90 "
91 " * g:tex_indent_items
92 "
93 " If this variable is set, item-environments are indented like Emacs does
94 " it, i.e., continuation lines are indented with a shiftwidth.
95 "
96 " set unset
97 " ------------------------------------------------------
98 " \begin{itemize} \begin{itemize}
99 " \item blablabla \item blablabla
100 " bla bla bla bla bla bla
101 " \item blablabla \item blablabla
102 " bla bla bla bla bla bla
103 " \end{itemize} \end{itemize}
104 "
105 "
106 " * g:tex_items
107 "
108 " A list of tokens to be considered as commands for the beginning of an item
109 " command. The tokens should be separated with '\|'. The initial '\' should
110 " be escaped. The default is '\\bibitem\|\\item'.
111 "
112 " * g:tex_itemize_env
113 "
114 " A list of environment names, separated with '\|', where the items (item
115 " commands matching g:tex_items) may appear. The default is
116 " 'itemize\|description\|enumerate\|thebibliography'.
117 "
118 " * g:tex_noindent_env
119 "
120 " A list of environment names. separated with '\|', where no indentation is
121 " required. The default is 'document\|verbatim'.
122 " }}}
123
124 " Only define the function once
73 if exists("b:did_indent") 125 if exists("b:did_indent")
74 finish 126 finish
75 endif 127 endif
76 128
77 let s:cpo_save = &cpo 129 let s:cpo_save = &cpo
78 set cpo&vim 130 set cpo&vim
79 " Define global variable {{{1 131
132 " Define global variable {{{
133
80 let b:did_indent = 1 134 let b:did_indent = 1
81 135
82 if !exists("g:tex_indent_items") 136 if !exists("g:tex_indent_items")
83 let g:tex_indent_items = 1 137 let g:tex_indent_items = 1
84 endif 138 endif
91 if g:tex_indent_items 145 if g:tex_indent_items
92 if !exists("g:tex_itemize_env") 146 if !exists("g:tex_itemize_env")
93 let g:tex_itemize_env = 'itemize\|description\|enumerate\|thebibliography' 147 let g:tex_itemize_env = 'itemize\|description\|enumerate\|thebibliography'
94 endif 148 endif
95 if !exists('g:tex_items') 149 if !exists('g:tex_items')
96 let g:tex_items = '\\bibitem\|\\item' 150 let g:tex_items = '\\bibitem\|\\item'
97 endif 151 endif
98 else 152 else
99 let g:tex_items = '' 153 let g:tex_items = ''
100 endif 154 endif
101 155
102 if !exists("g:tex_noindent_env") 156 if !exists("g:tex_noindent_env")
103 let g:tex_noindent_env = 'document\|verbatim\|lstlisting' 157 let g:tex_noindent_env = 'document\|verbatim\|lstlisting'
104 endif "}}} 158 endif "}}}
105 " VIM Setting " {{{1 159
160 " VIM Setting " {{{
106 setlocal autoindent 161 setlocal autoindent
107 setlocal nosmartindent 162 setlocal nosmartindent
108 setlocal indentexpr=GetTeXIndent() 163 setlocal indentexpr=GetTeXIndent()
109 setlocal indentkeys& 164 setlocal indentkeys&
110 exec 'setlocal indentkeys+=[,(,{,),},],\&' . substitute(g:tex_items, '^\|\(\\|\)', ',=', 'g') 165 exec 'setlocal indentkeys+=[,(,{,),},],\&' . substitute(g:tex_items, '^\|\(\\|\)', ',=', 'g')
111 let g:tex_items = '^\s*' . substitute(g:tex_items, '^\(\^\\s\*\)*', '', '') 166 let g:tex_items = '^\s*' . substitute(g:tex_items, '^\(\^\\s\*\)*', '', '')
112
113 let b:undo_indent = 'setlocal indentexpr< indentkeys< smartindent< autoindent<'
114 " }}} 167 " }}}
115 function! GetTeXIndent() " {{{1 168
169 function! GetTeXIndent() " {{{
116 " Find a non-blank line above the current line. 170 " Find a non-blank line above the current line.
117 let lnum = prevnonblank(v:lnum - 1) 171 let lnum = prevnonblank(v:lnum - 1)
118 let cnum = v:lnum 172 let cnum = v:lnum
119 173
120 " Comment line is not what we need. 174 " Comment line is not what we need.
122 let lnum = prevnonblank(lnum - 1) 176 let lnum = prevnonblank(lnum - 1)
123 endwhile 177 endwhile
124 178
125 " At the start of the file use zero indent. 179 " At the start of the file use zero indent.
126 if lnum == 0 180 if lnum == 0
127 return 0 181 return 0
128 endif 182 endif
129 183
130 let line = substitute(getline(lnum), '\s*%.*', '','g') " last line 184 let line = substitute(getline(lnum), '\s*%.*', '','g') " last line
131 let cline = substitute(getline(v:lnum), '\s*%.*', '', 'g') " current line 185 let cline = substitute(getline(v:lnum), '\s*%.*', '', 'g') " current line
132 186
136 return indent(lnum) 190 return indent(lnum)
137 else 191 else
138 return indent(v:lnum) 192 return indent(v:lnum)
139 end 193 end
140 endif 194 endif
141 195
142 if lnum == 0 196 if lnum == 0
143 return 0 197 return 0
144 endif 198 endif
145 199
146 let ind = indent(lnum) 200 let ind = indent(lnum)
147 let stay = 1 201 let stay = 1
148 202
149 " New code for comment: retain the indent of current line 203 " New code for comment: retain the indent of current line
150 if cline =~ '^\s*%' 204 if cline =~ '^\s*%'
151 return indent(v:lnum) 205 return indent(v:lnum)
152 endif 206 endif
153 207
154 " Add a 'shiftwidth' after beginning of environments 208 " Add a 'shiftwidth' after beginning of environments.
155 " But don't do it for g:tex_noindent_env or when it also ends at the 209 " Don't add it for \begin{document} and \begin{verbatim}
156 " previous line. 210 " if line =~ '^\s*\\begin{\(.*\)}' && line !~ 'verbatim'
157 if line =~ '\\begin{.*}' && line !~ '\\end{.*}' && line !~ g:tex_noindent_env 211 " LH modification : \begin does not always start a line
158 let ind = ind + shiftwidth() 212 " ZYC modification : \end after \begin won't cause wrong indent anymore
159 let stay = 0 213 if line =~ '\\begin{.*}'
214 if line !~ g:tex_noindent_env
215 let ind = ind + shiftwidth()
216 let stay = 0
217 endif
160 218
161 if g:tex_indent_items 219 if g:tex_indent_items
162 " Add another sw for item-environments 220 " Add another sw for item-environments
163 if line =~ g:tex_itemize_env 221 if line =~ g:tex_itemize_env
164 let ind = ind + shiftwidth() 222 let ind = ind + shiftwidth()
188 let ind = ind - shiftwidth() 246 let ind = ind - shiftwidth()
189 let stay = 0 247 let stay = 0
190 endif 248 endif
191 249
192 if g:tex_indent_brace 250 if g:tex_indent_brace
193 let char = line[strlen(line)-1] 251 if line =~ '[[{]$'
194 if char == '[' || char == '{'
195 let ind += shiftwidth() 252 let ind += shiftwidth()
196 let stay = 0 253 let stay = 0
197 endif 254 endif
198 255
199 let cind = indent(v:lnum) 256 if cline =~ '^\s*\\\?[\]}]' && s:CheckPairedIsLastCharacter(v:lnum, indent(v:lnum))
200 let char = cline[cind]
201 if (char == ']' || char == '}') &&
202 \ s:CheckPairedIsLastCharacter(v:lnum, cind)
203 let ind -= shiftwidth() 257 let ind -= shiftwidth()
204 let stay = 0 258 let stay = 0
205 endif 259 endif
206 260
207 for i in range(indent(lnum)+1, strlen(line)-1) 261 if line !~ '^\s*\\\?[\]}]'
208 let char = line[i] 262 for i in range(indent(lnum)+1, strlen(line)-1)
209 if char == ']' || char == '}' 263 let char = line[i]
210 if s:CheckPairedIsLastCharacter(lnum, i) 264 if char == ']' || char == '}'
211 let ind -= shiftwidth() 265 if s:CheckPairedIsLastCharacter(lnum, i)
212 let stay = 0 266 let ind -= shiftwidth()
267 let stay = 0
268 endif
213 endif 269 endif
214 endif 270 endfor
215 endfor 271 endif
216 endif 272 endif
217 273
218 " Special treatment for 'item' 274 " Special treatment for 'item'
219 " ---------------------------- 275 " ----------------------------
220 276
229 let ind = ind + shiftwidth() 285 let ind = ind + shiftwidth()
230 let stay = 0 286 let stay = 0
231 endif 287 endif
232 endif 288 endif
233 289
234 if stay 290 if stay && mode() == 'i'
235 " If there is no obvious indentation hint, we trust our user. 291 " If there is no obvious indentation hint, and indentation is triggered
292 " in insert mode, we trust our user.
236 if empty(cline) 293 if empty(cline)
237 return ind 294 return ind
238 else 295 else
239 return max([indent(v:lnum), s:GetLastBeginIndentation(v:lnum)]) 296 return max([indent(v:lnum), s:GetLastBeginIndentation(v:lnum)])
240 endif 297 endif
241 else 298 else
242 return ind 299 return ind
243 endif 300 endif
244 endfunction "}}} 301 endfunction "}}}
245 function! s:GetLastBeginIndentation(lnum) " {{{1 302
303 function! s:GetLastBeginIndentation(lnum) " {{{
246 let matchend = 1 304 let matchend = 1
247 for lnum in range(a:lnum-1, max([a:lnum - g:tex_max_scan_line, 1]), -1) 305 for lnum in range(a:lnum-1, max([a:lnum - g:tex_max_scan_line, 1]), -1)
248 let line = getline(lnum) 306 let line = getline(lnum)
249 if line =~ '\\end{.*}' 307 if line =~ '\\end{.*}'
250 let matchend += 1 308 let matchend += 1
251 endif 309 endif
252 if line =~ '\\begin{.*}' 310 if line =~ '\\begin{.*}'
253 let matchend -= 1 311 let matchend -= 1
254 endif 312 endif
255 if matchend == 0 313 if matchend == 0
314 if line =~ g:tex_noindent_env
315 return indent(lnum)
316 endif
256 if line =~ g:tex_itemize_env 317 if line =~ g:tex_itemize_env
257 return indent(lnum) + 2 * shiftwidth() 318 return indent(lnum) + 2 * shiftwidth()
258 endif 319 endif
259 if line =~ g:tex_noindent_env
260 return indent(lnum)
261 endif
262 return indent(lnum) + shiftwidth() 320 return indent(lnum) + shiftwidth()
263 endif 321 endif
264 endfor 322 endfor
265 return -1 323 return -1
266 endfunction 324 endfunction
267 325
268 function! s:GetEndIndentation(lnum) " {{{1 326 function! s:GetEndIndentation(lnum) " {{{
269 if getline(a:lnum) =~ '\\begin{.*}.*\\end{.*}' 327 if getline(a:lnum) =~ '\\begin{.*}.*\\end{.*}'
270 return -1 328 return -1
271 endif 329 endif
272 330
273 let min_indent = 100 331 let min_indent = 100
290 return min_indent - shiftwidth() 348 return min_indent - shiftwidth()
291 endfunction 349 endfunction
292 350
293 " Most of the code is from matchparen.vim 351 " Most of the code is from matchparen.vim
294 function! s:CheckPairedIsLastCharacter(lnum, col) "{{{ 352 function! s:CheckPairedIsLastCharacter(lnum, col) "{{{
295 " Get the character under the cursor and check if it's in 'matchpairs'.
296 let c_lnum = a:lnum 353 let c_lnum = a:lnum
297 let c_col = a:col+1 354 let c_col = a:col+1
298 355
299 356 let line = getline(c_lnum)
300 let c = getline(c_lnum)[c_col-1] 357 if line[c_col-1] == '\'
358 let c_col = c_col + 1
359 endif
360 let c = line[c_col-1]
361
301 let plist = split(&matchpairs, '.\zs[:,]') 362 let plist = split(&matchpairs, '.\zs[:,]')
302 let i = index(plist, c) 363 let i = index(plist, c)
303 if i < 0 364 if i < 0
304 return 0 365 return 0
305 endif 366 endif
344 let line = getline(m_lnum) 405 let line = getline(m_lnum)
345 return strlen(line) == m_col 406 return strlen(line) == m_col
346 endif 407 endif
347 408
348 return 0 409 return 0
349 endfunction 410 endfunction "}}}
350 " Reset cpo setting {{{1 411
351 let &cpo = s:cpo_save 412 let &cpo = s:cpo_save
352 unlet s:cpo_save 413 unlet s:cpo_save
353 414
354 " vim: set sw=4 textwidth=80: 415 " vim: set sw=4 textwidth=80: