xref: /vim-8.2.3635/runtime/indent/vim.vim (revision f89be8de)
1" Vim indent file
2" Language:	Vim script
3" Maintainer:	Bram Moolenaar <[email protected]>
4" Last Change:	2021 Apr 18
5
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()
13setlocal indentkeys+==end,=},=else,=cat,=finall,=END,0\\,0=\"\\\
14setlocal indentkeys-=0#
15
16let b:undo_indent = "setl indentkeys< indentexpr<"
17
18" Only define the function once.
19if exists("*GetVimIndent")
20  finish
21endif
22let s:keepcpo= &cpo
23set cpo&vim
24
25function GetVimIndent()
26  let ignorecase_save = &ignorecase
27  try
28    let &ignorecase = 0
29    return GetVimIndentIntern()
30  finally
31    let &ignorecase = ignorecase_save
32  endtry
33endfunc
34
35let s:lineContPat = '^\s*\(\\\|"\\ \)'
36
37function GetVimIndentIntern()
38  " Find a non-blank line above the current line.
39  let lnum = prevnonblank(v:lnum - 1)
40
41  " The previous line, ignoring line continuation
42  let prev_text_end = lnum > 0 ? getline(lnum) : ''
43
44  " If the current line doesn't start with '\' or '"\ ' and below a line that
45  " starts with '\' or '"\ ', use the indent of the line above it.
46  let cur_text = getline(v:lnum)
47  if cur_text !~ s:lineContPat
48    while lnum > 0 && getline(lnum) =~ s:lineContPat
49      let lnum = lnum - 1
50    endwhile
51  endif
52
53  " At the start of the file use zero indent.
54  if lnum == 0
55    return 0
56  endif
57
58  " the start of the previous line, skipping over line continuation
59  let prev_text = getline(lnum)
60  let found_cont = 0
61
62  " Add a 'shiftwidth' after :if, :while, :try, :catch, :finally, :function
63  " and :else.  Add it three times for a line that starts with '\' or '"\ '
64  " after a line that doesn't (or g:vim_indent_cont if it exists).
65  let ind = indent(lnum)
66
67  " In heredoc indenting works completely differently.
68  if has('syntax_items')
69    let syn_here = synIDattr(synID(v:lnum, 1, 1), "name")
70    if syn_here =~ 'vimLetHereDocStop'
71      " End of heredoc: use indent of matching start line
72      let lnum = v:lnum - 1
73      while lnum > 0
74	let attr = synIDattr(synID(lnum, 1, 1), "name")
75	if attr != '' && attr !~ 'vimLetHereDoc'
76	  return indent(lnum)
77	endif
78	let lnum -= 1
79      endwhile
80      return 0
81    endif
82    if syn_here =~ 'vimLetHereDoc'
83      if synIDattr(synID(lnum, 1, 1), "name") !~ 'vimLetHereDoc'
84	" First line in heredoc: increase indent
85	return ind + shiftwidth()
86      endif
87      " Heredoc continues: no change in indent
88      return ind
89    endif
90  endif
91
92  if cur_text =~ s:lineContPat && v:lnum > 1 && prev_text !~ s:lineContPat
93    let found_cont = 1
94    if exists("g:vim_indent_cont")
95      let ind = ind + g:vim_indent_cont
96    else
97      let ind = ind + shiftwidth() * 3
98    endif
99  elseif prev_text =~ '^\s*aug\%[roup]\s\+' && prev_text !~ '^\s*aug\%[roup]\s\+[eE][nN][dD]\>'
100    let ind = ind + shiftwidth()
101  else
102    " A line starting with :au does not increment/decrement indent.
103    " A { may start a block or a dict.  Assume that when a } follows it's a
104    " terminated dict.
105    if prev_text !~ '^\s*au\%[tocmd]' && prev_text !~ '^\s*{.*}'
106      let i = match(prev_text, '\(^\||\)\s*\(export\s\+\)\?\({\|\(if\|wh\%[ile]\|for\|try\|cat\%[ch]\|fina\|finall\%[y]\|fu\%[nction]\|def\|el\%[seif]\)\>\)')
107      if i >= 0
108	let ind += shiftwidth()
109	if strpart(prev_text, i, 1) == '|' && has('syntax_items')
110	      \ && synIDattr(synID(lnum, i, 1), "name") =~ '\(Comment\|String\)$'
111	  let ind -= shiftwidth()
112	endif
113      endif
114    endif
115  endif
116
117  " If the previous line contains an "end" after a pipe, but not in an ":au"
118  " command.  And not when there is a backslash before the pipe.
119  " And when syntax HL is enabled avoid a match inside a string.
120  let i = match(prev_text, '[^\\]|\s*\(ene\@!\)')
121  if i > 0 && prev_text !~ '^\s*au\%[tocmd]'
122    if !has('syntax_items') || synIDattr(synID(lnum, i + 2, 1), "name") !~ '\(Comment\|String\)$'
123      let ind = ind - shiftwidth()
124    endif
125  endif
126
127  " For a line starting with "}" find the matching "{".  If it is at the start
128  " of the line align with it, probably end of a block.
129  " Use the mapped "%" from matchit to find the match, otherwise we may match
130  " a { inside a comment or string.
131  if cur_text =~ '^\s*}'
132    if maparg('%') != ''
133      exe v:lnum
134      silent! normal %
135      if line('.') < v:lnum && getline('.') =~ '^\s*{'
136	let ind = indent('.')
137      endif
138    else
139      " todo: use searchpair() to find a match
140    endif
141  endif
142
143  " Below a line starting with "}" find the matching "{".  If it is at the
144  " end of the line we must be below the end of a dictionary.
145  if prev_text =~ '^\s*}'
146    if maparg('%') != ''
147      exe lnum
148      silent! normal %
149      if line('.') == lnum || getline('.') !~ '^\s*{'
150	let ind = ind - shiftwidth()
151      endif
152    else
153      " todo: use searchpair() to find a match
154    endif
155  endif
156
157  " Below a line starting with "]" we must be below the end of a list.
158  " Include a "}" and "},} in case a dictionary ends too.
159  if prev_text_end =~ '^\s*\(},\=\s*\)\=]'
160    let ind = ind - shiftwidth()
161  endif
162
163  let ends_in_comment = has('syntax_items')
164	\ && synIDattr(synID(lnum, len(getline(lnum)), 1), "name") =~ '\(Comment\|String\)$'
165
166  " A line ending in "{" or "[" is most likely the start of a dict/list literal,
167  " indent the next line more.  Not for a continuation line or {{{.
168  if !ends_in_comment && prev_text_end =~ '\s[{[]\s*$' && !found_cont
169    let ind = ind + shiftwidth()
170  endif
171
172  " Subtract a 'shiftwidth' on a :endif, :endwhile, :catch, :finally, :endtry,
173  " :endfun, :enddef, :else and :augroup END.
174  if cur_text =~ '^\s*\(ene\@!\|cat\|finall\|el\|aug\%[roup]\s\+[eE][nN][dD]\)'
175    let ind = ind - shiftwidth()
176  endif
177
178  return ind
179endfunction
180
181let &cpo = s:keepcpo
182unlet s:keepcpo
183
184" vim:sw=2
185