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