Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1 | " Vim indent file |
| 2 | " Language: Vim script |
| 3 | " Maintainer: Bram Moolenaar <Bram@vim.org> |
Bram Moolenaar | a57b553 | 2022-06-24 11:48:03 +0100 | [diff] [blame] | 4 | " Last Change: 2022 Jun 24 |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5 | |
| 6 | " Only load this indent file when no other was loaded. |
| 7 | if exists("b:did_indent") |
| 8 | finish |
| 9 | endif |
| 10 | let b:did_indent = 1 |
| 11 | |
| 12 | setlocal indentexpr=GetVimIndent() |
Bram Moolenaar | c51cf03 | 2022-02-26 12:25:45 +0000 | [diff] [blame] | 13 | setlocal indentkeys+==endif,=enddef,=endfu,=endfor,=endwh,=endtry,=},=else,=cat,=finall,=END,0\\,0=\"\\\ |
Bram Moolenaar | 2547aa9 | 2020-07-26 17:00:44 +0200 | [diff] [blame] | 14 | setlocal indentkeys-=0# |
Bram Moolenaar | 4700398 | 2021-12-05 21:54:04 +0000 | [diff] [blame] | 15 | setlocal indentkeys-=: |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 16 | |
Bram Moolenaar | c873442 | 2012-06-01 22:38:45 +0200 | [diff] [blame] | 17 | let b:undo_indent = "setl indentkeys< indentexpr<" |
| 18 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 19 | " Only define the function once. |
| 20 | if exists("*GetVimIndent") |
| 21 | finish |
| 22 | endif |
Bram Moolenaar | 8e52a59 | 2012-05-18 21:49:28 +0200 | [diff] [blame] | 23 | let s:keepcpo= &cpo |
| 24 | set cpo&vim |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 25 | |
| 26 | function GetVimIndent() |
Bram Moolenaar | 9b45125 | 2012-08-15 17:43:31 +0200 | [diff] [blame] | 27 | let ignorecase_save = &ignorecase |
| 28 | try |
| 29 | let &ignorecase = 0 |
| 30 | return GetVimIndentIntern() |
| 31 | finally |
| 32 | let &ignorecase = ignorecase_save |
| 33 | endtry |
| 34 | endfunc |
| 35 | |
Bram Moolenaar | 0daafaa | 2022-09-04 17:45:43 +0100 | [diff] [blame] | 36 | " Legacy script line continuation and Vim9 script operators that must mean an |
| 37 | " expression that continues from the previous line. |
| 38 | let s:lineContPat = '^\s*\(\\\|"\\ \|->\)' |
Bram Moolenaar | 67f8ab8 | 2018-09-11 22:37:29 +0200 | [diff] [blame] | 39 | |
Bram Moolenaar | 9b45125 | 2012-08-15 17:43:31 +0200 | [diff] [blame] | 40 | function GetVimIndentIntern() |
Bram Moolenaar | a57b553 | 2022-06-24 11:48:03 +0100 | [diff] [blame] | 41 | " If the current line has line continuation and the previous one too, use |
| 42 | " the same indent. This does not skip empty lines. |
| 43 | let cur_text = getline(v:lnum) |
| 44 | let cur_has_linecont = cur_text =~ s:lineContPat |
| 45 | if cur_has_linecont && v:lnum > 1 && getline(v:lnum - 1) =~ s:lineContPat |
| 46 | return indent(v:lnum - 1) |
| 47 | endif |
| 48 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 49 | " Find a non-blank line above the current line. |
| 50 | let lnum = prevnonblank(v:lnum - 1) |
| 51 | |
Bram Moolenaar | e0e3917 | 2021-01-25 21:14:57 +0100 | [diff] [blame] | 52 | " The previous line, ignoring line continuation |
| 53 | let prev_text_end = lnum > 0 ? getline(lnum) : '' |
| 54 | |
Bram Moolenaar | 67f8ab8 | 2018-09-11 22:37:29 +0200 | [diff] [blame] | 55 | " If the current line doesn't start with '\' or '"\ ' and below a line that |
| 56 | " starts with '\' or '"\ ', use the indent of the line above it. |
Bram Moolenaar | a57b553 | 2022-06-24 11:48:03 +0100 | [diff] [blame] | 57 | if !cur_has_linecont |
Bram Moolenaar | 67f8ab8 | 2018-09-11 22:37:29 +0200 | [diff] [blame] | 58 | while lnum > 0 && getline(lnum) =~ s:lineContPat |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 59 | let lnum = lnum - 1 |
| 60 | endwhile |
| 61 | endif |
| 62 | |
| 63 | " At the start of the file use zero indent. |
| 64 | if lnum == 0 |
| 65 | return 0 |
| 66 | endif |
Bram Moolenaar | e0e3917 | 2021-01-25 21:14:57 +0100 | [diff] [blame] | 67 | |
| 68 | " the start of the previous line, skipping over line continuation |
Bram Moolenaar | 91e15e1 | 2014-09-19 22:38:48 +0200 | [diff] [blame] | 69 | let prev_text = getline(lnum) |
Bram Moolenaar | 82be484 | 2021-01-11 19:40:15 +0100 | [diff] [blame] | 70 | let found_cont = 0 |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 71 | |
| 72 | " Add a 'shiftwidth' after :if, :while, :try, :catch, :finally, :function |
Bram Moolenaar | 67f8ab8 | 2018-09-11 22:37:29 +0200 | [diff] [blame] | 73 | " and :else. Add it three times for a line that starts with '\' or '"\ ' |
| 74 | " after a line that doesn't (or g:vim_indent_cont if it exists). |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 75 | let ind = indent(lnum) |
Bram Moolenaar | 1ff14ba | 2019-11-02 14:09:23 +0100 | [diff] [blame] | 76 | |
| 77 | " In heredoc indenting works completely differently. |
| 78 | if has('syntax_items') |
| 79 | let syn_here = synIDattr(synID(v:lnum, 1, 1), "name") |
| 80 | if syn_here =~ 'vimLetHereDocStop' |
| 81 | " End of heredoc: use indent of matching start line |
| 82 | let lnum = v:lnum - 1 |
| 83 | while lnum > 0 |
Bram Moolenaar | 11e3c5b | 2021-04-21 18:09:37 +0200 | [diff] [blame] | 84 | let attr = synIDattr(synID(lnum, 1, 1), "name") |
| 85 | if attr != '' && attr !~ 'vimLetHereDoc' |
Bram Moolenaar | 1ff14ba | 2019-11-02 14:09:23 +0100 | [diff] [blame] | 86 | return indent(lnum) |
| 87 | endif |
| 88 | let lnum -= 1 |
| 89 | endwhile |
| 90 | return 0 |
| 91 | endif |
| 92 | if syn_here =~ 'vimLetHereDoc' |
| 93 | if synIDattr(synID(lnum, 1, 1), "name") !~ 'vimLetHereDoc' |
| 94 | " First line in heredoc: increase indent |
| 95 | return ind + shiftwidth() |
| 96 | endif |
| 97 | " Heredoc continues: no change in indent |
| 98 | return ind |
| 99 | endif |
| 100 | endif |
| 101 | |
Bram Moolenaar | 67f8ab8 | 2018-09-11 22:37:29 +0200 | [diff] [blame] | 102 | if cur_text =~ s:lineContPat && v:lnum > 1 && prev_text !~ s:lineContPat |
Bram Moolenaar | 82be484 | 2021-01-11 19:40:15 +0100 | [diff] [blame] | 103 | let found_cont = 1 |
Bram Moolenaar | d4755bb | 2004-09-02 19:12:26 +0000 | [diff] [blame] | 104 | if exists("g:vim_indent_cont") |
| 105 | let ind = ind + g:vim_indent_cont |
| 106 | else |
Bram Moolenaar | 705ada1 | 2016-01-24 17:56:50 +0100 | [diff] [blame] | 107 | let ind = ind + shiftwidth() * 3 |
Bram Moolenaar | d4755bb | 2004-09-02 19:12:26 +0000 | [diff] [blame] | 108 | endif |
Bram Moolenaar | e18dbe8 | 2016-07-02 21:42:23 +0200 | [diff] [blame] | 109 | elseif prev_text =~ '^\s*aug\%[roup]\s\+' && prev_text !~ '^\s*aug\%[roup]\s\+[eE][nN][dD]\>' |
Bram Moolenaar | 705ada1 | 2016-01-24 17:56:50 +0100 | [diff] [blame] | 110 | let ind = ind + shiftwidth() |
Bram Moolenaar | cab49df | 2011-03-22 17:40:10 +0100 | [diff] [blame] | 111 | else |
Bram Moolenaar | 91e15e1 | 2014-09-19 22:38:48 +0200 | [diff] [blame] | 112 | " A line starting with :au does not increment/decrement indent. |
Bram Moolenaar | 942db23 | 2021-02-13 18:14:48 +0100 | [diff] [blame] | 113 | " A { may start a block or a dict. Assume that when a } follows it's a |
| 114 | " terminated dict. |
Bram Moolenaar | c51cf03 | 2022-02-26 12:25:45 +0000 | [diff] [blame] | 115 | " ":function" starts a block but "function(" doesn't. |
Bram Moolenaar | 942db23 | 2021-02-13 18:14:48 +0100 | [diff] [blame] | 116 | if prev_text !~ '^\s*au\%[tocmd]' && prev_text !~ '^\s*{.*}' |
Bram Moolenaar | 1588bc8 | 2022-03-08 21:35:07 +0000 | [diff] [blame] | 117 | let i = match(prev_text, '\(^\||\)\s*\(export\s\+\)\?\({\|\(if\|wh\%[ile]\|for\|try\|cat\%[ch]\|fina\|finall\%[y]\|def\|el\%[seif]\)\>\|fu\%[nction][! ]\)') |
Bram Moolenaar | 91e15e1 | 2014-09-19 22:38:48 +0200 | [diff] [blame] | 118 | if i >= 0 |
Bram Moolenaar | 705ada1 | 2016-01-24 17:56:50 +0100 | [diff] [blame] | 119 | let ind += shiftwidth() |
Bram Moolenaar | 91e15e1 | 2014-09-19 22:38:48 +0200 | [diff] [blame] | 120 | if strpart(prev_text, i, 1) == '|' && has('syntax_items') |
Bram Moolenaar | 113cb51 | 2021-11-07 20:27:04 +0000 | [diff] [blame] | 121 | \ && synIDattr(synID(lnum, i, 1), "name") =~ '\(Comment\|String\|PatSep\)$' |
Bram Moolenaar | 705ada1 | 2016-01-24 17:56:50 +0100 | [diff] [blame] | 122 | let ind -= shiftwidth() |
Bram Moolenaar | 91e15e1 | 2014-09-19 22:38:48 +0200 | [diff] [blame] | 123 | endif |
Bram Moolenaar | cab49df | 2011-03-22 17:40:10 +0100 | [diff] [blame] | 124 | endif |
| 125 | endif |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 126 | endif |
| 127 | |
| 128 | " If the previous line contains an "end" after a pipe, but not in an ":au" |
Bram Moolenaar | 520470a | 2005-06-16 21:59:56 +0000 | [diff] [blame] | 129 | " command. And not when there is a backslash before the pipe. |
Bram Moolenaar | dc27ac1 | 2005-07-06 22:35:45 +0000 | [diff] [blame] | 130 | " And when syntax HL is enabled avoid a match inside a string. |
Bram Moolenaar | 91e15e1 | 2014-09-19 22:38:48 +0200 | [diff] [blame] | 131 | let i = match(prev_text, '[^\\]|\s*\(ene\@!\)') |
| 132 | if i > 0 && prev_text !~ '^\s*au\%[tocmd]' |
Bram Moolenaar | dc27ac1 | 2005-07-06 22:35:45 +0000 | [diff] [blame] | 133 | if !has('syntax_items') || synIDattr(synID(lnum, i + 2, 1), "name") !~ '\(Comment\|String\)$' |
Bram Moolenaar | 705ada1 | 2016-01-24 17:56:50 +0100 | [diff] [blame] | 134 | let ind = ind - shiftwidth() |
Bram Moolenaar | dc27ac1 | 2005-07-06 22:35:45 +0000 | [diff] [blame] | 135 | endif |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 136 | endif |
| 137 | |
Bram Moolenaar | 0daafaa | 2022-09-04 17:45:43 +0100 | [diff] [blame] | 138 | " For a line starting with "}" find the matching "{". Align with that line, |
| 139 | " it is either the matching block start or dictionary start. |
Bram Moolenaar | 82be484 | 2021-01-11 19:40:15 +0100 | [diff] [blame] | 140 | " Use the mapped "%" from matchit to find the match, otherwise we may match |
| 141 | " a { inside a comment or string. |
| 142 | if cur_text =~ '^\s*}' |
| 143 | if maparg('%') != '' |
| 144 | exe v:lnum |
| 145 | silent! normal % |
Bram Moolenaar | 0daafaa | 2022-09-04 17:45:43 +0100 | [diff] [blame] | 146 | if line('.') < v:lnum |
Bram Moolenaar | 82be484 | 2021-01-11 19:40:15 +0100 | [diff] [blame] | 147 | let ind = indent('.') |
| 148 | endif |
| 149 | else |
| 150 | " todo: use searchpair() to find a match |
| 151 | endif |
| 152 | endif |
| 153 | |
Bram Moolenaar | 0daafaa | 2022-09-04 17:45:43 +0100 | [diff] [blame] | 154 | " Look back for a line to align with |
| 155 | while lnum > 1 |
| 156 | " Below a line starting with "}" find the matching "{". |
| 157 | if prev_text =~ '^\s*}' |
| 158 | if maparg('%') != '' |
| 159 | exe lnum |
| 160 | silent! normal % |
| 161 | if line('.') < lnum |
| 162 | let lnum = line('.') |
| 163 | let ind = indent(lnum) |
| 164 | let prev_text = getline(lnum) |
| 165 | else |
| 166 | break |
| 167 | endif |
| 168 | else |
| 169 | " todo: use searchpair() to find a match |
| 170 | break |
Bram Moolenaar | 82be484 | 2021-01-11 19:40:15 +0100 | [diff] [blame] | 171 | endif |
Bram Moolenaar | 0daafaa | 2022-09-04 17:45:43 +0100 | [diff] [blame] | 172 | elseif prev_text =~ s:lineContPat |
| 173 | " looks like a continuation like, go back one line |
| 174 | let lnum = lnum - 1 |
| 175 | let ind = indent(lnum) |
| 176 | let prev_text = getline(lnum) |
Bram Moolenaar | 82be484 | 2021-01-11 19:40:15 +0100 | [diff] [blame] | 177 | else |
Bram Moolenaar | 0daafaa | 2022-09-04 17:45:43 +0100 | [diff] [blame] | 178 | break |
Bram Moolenaar | 82be484 | 2021-01-11 19:40:15 +0100 | [diff] [blame] | 179 | endif |
Bram Moolenaar | 0daafaa | 2022-09-04 17:45:43 +0100 | [diff] [blame] | 180 | endwhile |
Bram Moolenaar | 82be484 | 2021-01-11 19:40:15 +0100 | [diff] [blame] | 181 | |
| 182 | " Below a line starting with "]" we must be below the end of a list. |
Bram Moolenaar | 942db23 | 2021-02-13 18:14:48 +0100 | [diff] [blame] | 183 | " Include a "}" and "},} in case a dictionary ends too. |
| 184 | if prev_text_end =~ '^\s*\(},\=\s*\)\=]' |
Bram Moolenaar | 82be484 | 2021-01-11 19:40:15 +0100 | [diff] [blame] | 185 | let ind = ind - shiftwidth() |
| 186 | endif |
| 187 | |
Bram Moolenaar | 942db23 | 2021-02-13 18:14:48 +0100 | [diff] [blame] | 188 | let ends_in_comment = has('syntax_items') |
Bram Moolenaar | 9faec4e | 2021-02-27 16:38:07 +0100 | [diff] [blame] | 189 | \ && synIDattr(synID(lnum, len(getline(lnum)), 1), "name") =~ '\(Comment\|String\)$' |
Bram Moolenaar | 942db23 | 2021-02-13 18:14:48 +0100 | [diff] [blame] | 190 | |
Bram Moolenaar | 9faec4e | 2021-02-27 16:38:07 +0100 | [diff] [blame] | 191 | " A line ending in "{" or "[" is most likely the start of a dict/list literal, |
Bram Moolenaar | 942db23 | 2021-02-13 18:14:48 +0100 | [diff] [blame] | 192 | " indent the next line more. Not for a continuation line or {{{. |
| 193 | if !ends_in_comment && prev_text_end =~ '\s[{[]\s*$' && !found_cont |
Bram Moolenaar | 82be484 | 2021-01-11 19:40:15 +0100 | [diff] [blame] | 194 | let ind = ind + shiftwidth() |
| 195 | endif |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 196 | |
Bram Moolenaar | c51cf03 | 2022-02-26 12:25:45 +0000 | [diff] [blame] | 197 | " Subtract a 'shiftwidth' on a :endif, :endwhile, :endfor, :catch, :finally, |
| 198 | " :endtry, :endfun, :enddef, :else and :augroup END. |
| 199 | " Although ":en" would be enough only match short command names as in |
| 200 | " 'indentkeys'. |
| 201 | if cur_text =~ '^\s*\(endif\|endwh\|endfor\|endtry\|endfu\|enddef\|cat\|finall\|else\|aug\%[roup]\s\+[eE][nN][dD]\)' |
Bram Moolenaar | 705ada1 | 2016-01-24 17:56:50 +0100 | [diff] [blame] | 202 | let ind = ind - shiftwidth() |
Bram Moolenaar | c51cf03 | 2022-02-26 12:25:45 +0000 | [diff] [blame] | 203 | if ind < 0 |
| 204 | let ind = 0 |
| 205 | endif |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 206 | endif |
| 207 | |
| 208 | return ind |
| 209 | endfunction |
| 210 | |
Bram Moolenaar | 8e52a59 | 2012-05-18 21:49:28 +0200 | [diff] [blame] | 211 | let &cpo = s:keepcpo |
| 212 | unlet s:keepcpo |
| 213 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 214 | " vim:sw=2 |