blob: 8a2502a275ded15323187c854e56fbcd61b68e4b [file] [log] [blame]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001" Vim indent file
2" Language: Vim script
3" Maintainer: Bram Moolenaar <Bram@vim.org>
Bram Moolenaara57b5532022-06-24 11:48:03 +01004" Last Change: 2022 Jun 24
Bram Moolenaar071d4272004-06-13 20:20:40 +00005
6" Only load this indent file when no other was loaded.
7if exists("b:did_indent")
8 finish
9endif
10let b:did_indent = 1
11
12setlocal indentexpr=GetVimIndent()
Bram Moolenaarc51cf032022-02-26 12:25:45 +000013setlocal indentkeys+==endif,=enddef,=endfu,=endfor,=endwh,=endtry,=},=else,=cat,=finall,=END,0\\,0=\"\\\
Bram Moolenaar2547aa92020-07-26 17:00:44 +020014setlocal indentkeys-=0#
Bram Moolenaar47003982021-12-05 21:54:04 +000015setlocal indentkeys-=:
Bram Moolenaar071d4272004-06-13 20:20:40 +000016
Bram Moolenaarc8734422012-06-01 22:38:45 +020017let b:undo_indent = "setl indentkeys< indentexpr<"
18
Bram Moolenaar071d4272004-06-13 20:20:40 +000019" Only define the function once.
20if exists("*GetVimIndent")
21 finish
22endif
Bram Moolenaar8e52a592012-05-18 21:49:28 +020023let s:keepcpo= &cpo
24set cpo&vim
Bram Moolenaar071d4272004-06-13 20:20:40 +000025
26function GetVimIndent()
Bram Moolenaar9b451252012-08-15 17:43:31 +020027 let ignorecase_save = &ignorecase
28 try
29 let &ignorecase = 0
30 return GetVimIndentIntern()
31 finally
32 let &ignorecase = ignorecase_save
33 endtry
34endfunc
35
Bram Moolenaar67f8ab82018-09-11 22:37:29 +020036let s:lineContPat = '^\s*\(\\\|"\\ \)'
37
Bram Moolenaar9b451252012-08-15 17:43:31 +020038function GetVimIndentIntern()
Bram Moolenaara57b5532022-06-24 11:48:03 +010039 " If the current line has line continuation and the previous one too, use
40 " the same indent. This does not skip empty lines.
41 let cur_text = getline(v:lnum)
42 let cur_has_linecont = cur_text =~ s:lineContPat
43 if cur_has_linecont && v:lnum > 1 && getline(v:lnum - 1) =~ s:lineContPat
44 return indent(v:lnum - 1)
45 endif
46
Bram Moolenaar071d4272004-06-13 20:20:40 +000047 " Find a non-blank line above the current line.
48 let lnum = prevnonblank(v:lnum - 1)
49
Bram Moolenaare0e39172021-01-25 21:14:57 +010050 " The previous line, ignoring line continuation
51 let prev_text_end = lnum > 0 ? getline(lnum) : ''
52
Bram Moolenaar67f8ab82018-09-11 22:37:29 +020053 " If the current line doesn't start with '\' or '"\ ' and below a line that
54 " starts with '\' or '"\ ', use the indent of the line above it.
Bram Moolenaara57b5532022-06-24 11:48:03 +010055 if !cur_has_linecont
Bram Moolenaar67f8ab82018-09-11 22:37:29 +020056 while lnum > 0 && getline(lnum) =~ s:lineContPat
Bram Moolenaar071d4272004-06-13 20:20:40 +000057 let lnum = lnum - 1
58 endwhile
59 endif
60
61 " At the start of the file use zero indent.
62 if lnum == 0
63 return 0
64 endif
Bram Moolenaare0e39172021-01-25 21:14:57 +010065
66 " the start of the previous line, skipping over line continuation
Bram Moolenaar91e15e12014-09-19 22:38:48 +020067 let prev_text = getline(lnum)
Bram Moolenaar82be4842021-01-11 19:40:15 +010068 let found_cont = 0
Bram Moolenaar071d4272004-06-13 20:20:40 +000069
70 " Add a 'shiftwidth' after :if, :while, :try, :catch, :finally, :function
Bram Moolenaar67f8ab82018-09-11 22:37:29 +020071 " and :else. Add it three times for a line that starts with '\' or '"\ '
72 " after a line that doesn't (or g:vim_indent_cont if it exists).
Bram Moolenaar071d4272004-06-13 20:20:40 +000073 let ind = indent(lnum)
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +010074
75 " In heredoc indenting works completely differently.
76 if has('syntax_items')
77 let syn_here = synIDattr(synID(v:lnum, 1, 1), "name")
78 if syn_here =~ 'vimLetHereDocStop'
79 " End of heredoc: use indent of matching start line
80 let lnum = v:lnum - 1
81 while lnum > 0
Bram Moolenaar11e3c5b2021-04-21 18:09:37 +020082 let attr = synIDattr(synID(lnum, 1, 1), "name")
83 if attr != '' && attr !~ 'vimLetHereDoc'
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +010084 return indent(lnum)
85 endif
86 let lnum -= 1
87 endwhile
88 return 0
89 endif
90 if syn_here =~ 'vimLetHereDoc'
91 if synIDattr(synID(lnum, 1, 1), "name") !~ 'vimLetHereDoc'
92 " First line in heredoc: increase indent
93 return ind + shiftwidth()
94 endif
95 " Heredoc continues: no change in indent
96 return ind
97 endif
98 endif
99
Bram Moolenaar67f8ab82018-09-11 22:37:29 +0200100 if cur_text =~ s:lineContPat && v:lnum > 1 && prev_text !~ s:lineContPat
Bram Moolenaar82be4842021-01-11 19:40:15 +0100101 let found_cont = 1
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000102 if exists("g:vim_indent_cont")
103 let ind = ind + g:vim_indent_cont
104 else
Bram Moolenaar705ada12016-01-24 17:56:50 +0100105 let ind = ind + shiftwidth() * 3
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000106 endif
Bram Moolenaare18dbe82016-07-02 21:42:23 +0200107 elseif prev_text =~ '^\s*aug\%[roup]\s\+' && prev_text !~ '^\s*aug\%[roup]\s\+[eE][nN][dD]\>'
Bram Moolenaar705ada12016-01-24 17:56:50 +0100108 let ind = ind + shiftwidth()
Bram Moolenaarcab49df2011-03-22 17:40:10 +0100109 else
Bram Moolenaar91e15e12014-09-19 22:38:48 +0200110 " A line starting with :au does not increment/decrement indent.
Bram Moolenaar942db232021-02-13 18:14:48 +0100111 " A { may start a block or a dict. Assume that when a } follows it's a
112 " terminated dict.
Bram Moolenaarc51cf032022-02-26 12:25:45 +0000113 " ":function" starts a block but "function(" doesn't.
Bram Moolenaar942db232021-02-13 18:14:48 +0100114 if prev_text !~ '^\s*au\%[tocmd]' && prev_text !~ '^\s*{.*}'
Bram Moolenaar1588bc82022-03-08 21:35:07 +0000115 let i = match(prev_text, '\(^\||\)\s*\(export\s\+\)\?\({\|\(if\|wh\%[ile]\|for\|try\|cat\%[ch]\|fina\|finall\%[y]\|def\|el\%[seif]\)\>\|fu\%[nction][! ]\)')
Bram Moolenaar91e15e12014-09-19 22:38:48 +0200116 if i >= 0
Bram Moolenaar705ada12016-01-24 17:56:50 +0100117 let ind += shiftwidth()
Bram Moolenaar91e15e12014-09-19 22:38:48 +0200118 if strpart(prev_text, i, 1) == '|' && has('syntax_items')
Bram Moolenaar113cb512021-11-07 20:27:04 +0000119 \ && synIDattr(synID(lnum, i, 1), "name") =~ '\(Comment\|String\|PatSep\)$'
Bram Moolenaar705ada12016-01-24 17:56:50 +0100120 let ind -= shiftwidth()
Bram Moolenaar91e15e12014-09-19 22:38:48 +0200121 endif
Bram Moolenaarcab49df2011-03-22 17:40:10 +0100122 endif
123 endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000124 endif
125
126 " If the previous line contains an "end" after a pipe, but not in an ":au"
Bram Moolenaar520470a2005-06-16 21:59:56 +0000127 " command. And not when there is a backslash before the pipe.
Bram Moolenaardc27ac12005-07-06 22:35:45 +0000128 " And when syntax HL is enabled avoid a match inside a string.
Bram Moolenaar91e15e12014-09-19 22:38:48 +0200129 let i = match(prev_text, '[^\\]|\s*\(ene\@!\)')
130 if i > 0 && prev_text !~ '^\s*au\%[tocmd]'
Bram Moolenaardc27ac12005-07-06 22:35:45 +0000131 if !has('syntax_items') || synIDattr(synID(lnum, i + 2, 1), "name") !~ '\(Comment\|String\)$'
Bram Moolenaar705ada12016-01-24 17:56:50 +0100132 let ind = ind - shiftwidth()
Bram Moolenaardc27ac12005-07-06 22:35:45 +0000133 endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000134 endif
135
Bram Moolenaar82be4842021-01-11 19:40:15 +0100136 " For a line starting with "}" find the matching "{". If it is at the start
137 " of the line align with it, probably end of a block.
138 " Use the mapped "%" from matchit to find the match, otherwise we may match
139 " a { inside a comment or string.
140 if cur_text =~ '^\s*}'
141 if maparg('%') != ''
142 exe v:lnum
143 silent! normal %
144 if line('.') < v:lnum && getline('.') =~ '^\s*{'
145 let ind = indent('.')
146 endif
147 else
148 " todo: use searchpair() to find a match
149 endif
150 endif
151
152 " Below a line starting with "}" find the matching "{". If it is at the
153 " end of the line we must be below the end of a dictionary.
154 if prev_text =~ '^\s*}'
155 if maparg('%') != ''
156 exe lnum
157 silent! normal %
158 if line('.') == lnum || getline('.') !~ '^\s*{'
159 let ind = ind - shiftwidth()
160 endif
161 else
162 " todo: use searchpair() to find a match
163 endif
164 endif
165
166 " Below a line starting with "]" we must be below the end of a list.
Bram Moolenaar942db232021-02-13 18:14:48 +0100167 " Include a "}" and "},} in case a dictionary ends too.
168 if prev_text_end =~ '^\s*\(},\=\s*\)\=]'
Bram Moolenaar82be4842021-01-11 19:40:15 +0100169 let ind = ind - shiftwidth()
170 endif
171
Bram Moolenaar942db232021-02-13 18:14:48 +0100172 let ends_in_comment = has('syntax_items')
Bram Moolenaar9faec4e2021-02-27 16:38:07 +0100173 \ && synIDattr(synID(lnum, len(getline(lnum)), 1), "name") =~ '\(Comment\|String\)$'
Bram Moolenaar942db232021-02-13 18:14:48 +0100174
Bram Moolenaar9faec4e2021-02-27 16:38:07 +0100175 " A line ending in "{" or "[" is most likely the start of a dict/list literal,
Bram Moolenaar942db232021-02-13 18:14:48 +0100176 " indent the next line more. Not for a continuation line or {{{.
177 if !ends_in_comment && prev_text_end =~ '\s[{[]\s*$' && !found_cont
Bram Moolenaar82be4842021-01-11 19:40:15 +0100178 let ind = ind + shiftwidth()
179 endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000180
Bram Moolenaarc51cf032022-02-26 12:25:45 +0000181 " Subtract a 'shiftwidth' on a :endif, :endwhile, :endfor, :catch, :finally,
182 " :endtry, :endfun, :enddef, :else and :augroup END.
183 " Although ":en" would be enough only match short command names as in
184 " 'indentkeys'.
185 if cur_text =~ '^\s*\(endif\|endwh\|endfor\|endtry\|endfu\|enddef\|cat\|finall\|else\|aug\%[roup]\s\+[eE][nN][dD]\)'
Bram Moolenaar705ada12016-01-24 17:56:50 +0100186 let ind = ind - shiftwidth()
Bram Moolenaarc51cf032022-02-26 12:25:45 +0000187 if ind < 0
188 let ind = 0
189 endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000190 endif
191
192 return ind
193endfunction
194
Bram Moolenaar8e52a592012-05-18 21:49:28 +0200195let &cpo = s:keepcpo
196unlet s:keepcpo
197
Bram Moolenaar071d4272004-06-13 20:20:40 +0000198" vim:sw=2