blob: e1b7876ba3e48b89baf082a7810f78b6635c6227 [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 Moolenaarc51cf032022-02-26 12:25:45 +00004" Last Change: 2022 Feb 23
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 Moolenaar071d4272004-06-13 20:20:40 +000039 " Find a non-blank line above the current line.
40 let lnum = prevnonblank(v:lnum - 1)
41
Bram Moolenaare0e39172021-01-25 21:14:57 +010042 " The previous line, ignoring line continuation
43 let prev_text_end = lnum > 0 ? getline(lnum) : ''
44
Bram Moolenaar67f8ab82018-09-11 22:37:29 +020045 " If the current line doesn't start with '\' or '"\ ' and below a line that
46 " starts with '\' or '"\ ', use the indent of the line above it.
Bram Moolenaar91e15e12014-09-19 22:38:48 +020047 let cur_text = getline(v:lnum)
Bram Moolenaar67f8ab82018-09-11 22:37:29 +020048 if cur_text !~ s:lineContPat
49 while lnum > 0 && getline(lnum) =~ s:lineContPat
Bram Moolenaar071d4272004-06-13 20:20:40 +000050 let lnum = lnum - 1
51 endwhile
52 endif
53
54 " At the start of the file use zero indent.
55 if lnum == 0
56 return 0
57 endif
Bram Moolenaare0e39172021-01-25 21:14:57 +010058
59 " the start of the previous line, skipping over line continuation
Bram Moolenaar91e15e12014-09-19 22:38:48 +020060 let prev_text = getline(lnum)
Bram Moolenaar82be4842021-01-11 19:40:15 +010061 let found_cont = 0
Bram Moolenaar071d4272004-06-13 20:20:40 +000062
63 " Add a 'shiftwidth' after :if, :while, :try, :catch, :finally, :function
Bram Moolenaar67f8ab82018-09-11 22:37:29 +020064 " and :else. Add it three times for a line that starts with '\' or '"\ '
65 " after a line that doesn't (or g:vim_indent_cont if it exists).
Bram Moolenaar071d4272004-06-13 20:20:40 +000066 let ind = indent(lnum)
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +010067
68 " In heredoc indenting works completely differently.
69 if has('syntax_items')
70 let syn_here = synIDattr(synID(v:lnum, 1, 1), "name")
71 if syn_here =~ 'vimLetHereDocStop'
72 " End of heredoc: use indent of matching start line
73 let lnum = v:lnum - 1
74 while lnum > 0
Bram Moolenaar11e3c5b2021-04-21 18:09:37 +020075 let attr = synIDattr(synID(lnum, 1, 1), "name")
76 if attr != '' && attr !~ 'vimLetHereDoc'
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +010077 return indent(lnum)
78 endif
79 let lnum -= 1
80 endwhile
81 return 0
82 endif
83 if syn_here =~ 'vimLetHereDoc'
84 if synIDattr(synID(lnum, 1, 1), "name") !~ 'vimLetHereDoc'
85 " First line in heredoc: increase indent
86 return ind + shiftwidth()
87 endif
88 " Heredoc continues: no change in indent
89 return ind
90 endif
91 endif
92
Bram Moolenaar67f8ab82018-09-11 22:37:29 +020093 if cur_text =~ s:lineContPat && v:lnum > 1 && prev_text !~ s:lineContPat
Bram Moolenaar82be4842021-01-11 19:40:15 +010094 let found_cont = 1
Bram Moolenaard4755bb2004-09-02 19:12:26 +000095 if exists("g:vim_indent_cont")
96 let ind = ind + g:vim_indent_cont
97 else
Bram Moolenaar705ada12016-01-24 17:56:50 +010098 let ind = ind + shiftwidth() * 3
Bram Moolenaard4755bb2004-09-02 19:12:26 +000099 endif
Bram Moolenaare18dbe82016-07-02 21:42:23 +0200100 elseif prev_text =~ '^\s*aug\%[roup]\s\+' && prev_text !~ '^\s*aug\%[roup]\s\+[eE][nN][dD]\>'
Bram Moolenaar705ada12016-01-24 17:56:50 +0100101 let ind = ind + shiftwidth()
Bram Moolenaarcab49df2011-03-22 17:40:10 +0100102 else
Bram Moolenaar91e15e12014-09-19 22:38:48 +0200103 " A line starting with :au does not increment/decrement indent.
Bram Moolenaar942db232021-02-13 18:14:48 +0100104 " A { may start a block or a dict. Assume that when a } follows it's a
105 " terminated dict.
Bram Moolenaarc51cf032022-02-26 12:25:45 +0000106 " ":function" starts a block but "function(" doesn't.
Bram Moolenaar942db232021-02-13 18:14:48 +0100107 if prev_text !~ '^\s*au\%[tocmd]' && prev_text !~ '^\s*{.*}'
Bram Moolenaarc51cf032022-02-26 12:25:45 +0000108 let i = match(prev_text, '\(^\||\)\s*\(export\s\+\)\?\({\|\(if\|wh\%[ile]\|for\|try\|cat\%[ch]\|fina\|finall\%[y]\|def\|el\%[seif]\)\>\|fu\%[nction]\s\)')
Bram Moolenaar91e15e12014-09-19 22:38:48 +0200109 if i >= 0
Bram Moolenaar705ada12016-01-24 17:56:50 +0100110 let ind += shiftwidth()
Bram Moolenaar91e15e12014-09-19 22:38:48 +0200111 if strpart(prev_text, i, 1) == '|' && has('syntax_items')
Bram Moolenaar113cb512021-11-07 20:27:04 +0000112 \ && synIDattr(synID(lnum, i, 1), "name") =~ '\(Comment\|String\|PatSep\)$'
Bram Moolenaar705ada12016-01-24 17:56:50 +0100113 let ind -= shiftwidth()
Bram Moolenaar91e15e12014-09-19 22:38:48 +0200114 endif
Bram Moolenaarcab49df2011-03-22 17:40:10 +0100115 endif
116 endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000117 endif
118
119 " If the previous line contains an "end" after a pipe, but not in an ":au"
Bram Moolenaar520470a2005-06-16 21:59:56 +0000120 " command. And not when there is a backslash before the pipe.
Bram Moolenaardc27ac12005-07-06 22:35:45 +0000121 " And when syntax HL is enabled avoid a match inside a string.
Bram Moolenaar91e15e12014-09-19 22:38:48 +0200122 let i = match(prev_text, '[^\\]|\s*\(ene\@!\)')
123 if i > 0 && prev_text !~ '^\s*au\%[tocmd]'
Bram Moolenaardc27ac12005-07-06 22:35:45 +0000124 if !has('syntax_items') || synIDattr(synID(lnum, i + 2, 1), "name") !~ '\(Comment\|String\)$'
Bram Moolenaar705ada12016-01-24 17:56:50 +0100125 let ind = ind - shiftwidth()
Bram Moolenaardc27ac12005-07-06 22:35:45 +0000126 endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000127 endif
128
Bram Moolenaar82be4842021-01-11 19:40:15 +0100129 " For a line starting with "}" find the matching "{". If it is at the start
130 " of the line align with it, probably end of a block.
131 " Use the mapped "%" from matchit to find the match, otherwise we may match
132 " a { inside a comment or string.
133 if cur_text =~ '^\s*}'
134 if maparg('%') != ''
135 exe v:lnum
136 silent! normal %
137 if line('.') < v:lnum && getline('.') =~ '^\s*{'
138 let ind = indent('.')
139 endif
140 else
141 " todo: use searchpair() to find a match
142 endif
143 endif
144
145 " Below a line starting with "}" find the matching "{". If it is at the
146 " end of the line we must be below the end of a dictionary.
147 if prev_text =~ '^\s*}'
148 if maparg('%') != ''
149 exe lnum
150 silent! normal %
151 if line('.') == lnum || getline('.') !~ '^\s*{'
152 let ind = ind - shiftwidth()
153 endif
154 else
155 " todo: use searchpair() to find a match
156 endif
157 endif
158
159 " Below a line starting with "]" we must be below the end of a list.
Bram Moolenaar942db232021-02-13 18:14:48 +0100160 " Include a "}" and "},} in case a dictionary ends too.
161 if prev_text_end =~ '^\s*\(},\=\s*\)\=]'
Bram Moolenaar82be4842021-01-11 19:40:15 +0100162 let ind = ind - shiftwidth()
163 endif
164
Bram Moolenaar942db232021-02-13 18:14:48 +0100165 let ends_in_comment = has('syntax_items')
Bram Moolenaar9faec4e2021-02-27 16:38:07 +0100166 \ && synIDattr(synID(lnum, len(getline(lnum)), 1), "name") =~ '\(Comment\|String\)$'
Bram Moolenaar942db232021-02-13 18:14:48 +0100167
Bram Moolenaar9faec4e2021-02-27 16:38:07 +0100168 " A line ending in "{" or "[" is most likely the start of a dict/list literal,
Bram Moolenaar942db232021-02-13 18:14:48 +0100169 " indent the next line more. Not for a continuation line or {{{.
170 if !ends_in_comment && prev_text_end =~ '\s[{[]\s*$' && !found_cont
Bram Moolenaar82be4842021-01-11 19:40:15 +0100171 let ind = ind + shiftwidth()
172 endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000173
Bram Moolenaarc51cf032022-02-26 12:25:45 +0000174 " Subtract a 'shiftwidth' on a :endif, :endwhile, :endfor, :catch, :finally,
175 " :endtry, :endfun, :enddef, :else and :augroup END.
176 " Although ":en" would be enough only match short command names as in
177 " 'indentkeys'.
178 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 +0100179 let ind = ind - shiftwidth()
Bram Moolenaarc51cf032022-02-26 12:25:45 +0000180 if ind < 0
181 let ind = 0
182 endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000183 endif
184
185 return ind
186endfunction
187
Bram Moolenaar8e52a592012-05-18 21:49:28 +0200188let &cpo = s:keepcpo
189unlet s:keepcpo
190
Bram Moolenaar071d4272004-06-13 20:20:40 +0000191" vim:sw=2