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 | 9faec4e | 2021-02-27 16:38:07 +0100 | [diff] [blame] | 4 | " Last Change: 2021 Feb 18 |
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 | d58a3bf | 2020-09-28 21:48:16 +0200 | [diff] [blame] | 13 | setlocal indentkeys+==end,=},=else,=cat,=finall,=END,0\\,0=\"\\\ |
Bram Moolenaar | 2547aa9 | 2020-07-26 17:00:44 +0200 | [diff] [blame] | 14 | setlocal indentkeys-=0# |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 15 | |
Bram Moolenaar | c873442 | 2012-06-01 22:38:45 +0200 | [diff] [blame] | 16 | let b:undo_indent = "setl indentkeys< indentexpr<" |
| 17 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 18 | " Only define the function once. |
| 19 | if exists("*GetVimIndent") |
| 20 | finish |
| 21 | endif |
Bram Moolenaar | 8e52a59 | 2012-05-18 21:49:28 +0200 | [diff] [blame] | 22 | let s:keepcpo= &cpo |
| 23 | set cpo&vim |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 24 | |
| 25 | function GetVimIndent() |
Bram Moolenaar | 9b45125 | 2012-08-15 17:43:31 +0200 | [diff] [blame] | 26 | let ignorecase_save = &ignorecase |
| 27 | try |
| 28 | let &ignorecase = 0 |
| 29 | return GetVimIndentIntern() |
| 30 | finally |
| 31 | let &ignorecase = ignorecase_save |
| 32 | endtry |
| 33 | endfunc |
| 34 | |
Bram Moolenaar | 67f8ab8 | 2018-09-11 22:37:29 +0200 | [diff] [blame] | 35 | let s:lineContPat = '^\s*\(\\\|"\\ \)' |
| 36 | |
Bram Moolenaar | 9b45125 | 2012-08-15 17:43:31 +0200 | [diff] [blame] | 37 | function GetVimIndentIntern() |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 38 | " Find a non-blank line above the current line. |
| 39 | let lnum = prevnonblank(v:lnum - 1) |
| 40 | |
Bram Moolenaar | e0e3917 | 2021-01-25 21:14:57 +0100 | [diff] [blame] | 41 | " The previous line, ignoring line continuation |
| 42 | let prev_text_end = lnum > 0 ? getline(lnum) : '' |
| 43 | |
Bram Moolenaar | 67f8ab8 | 2018-09-11 22:37:29 +0200 | [diff] [blame] | 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. |
Bram Moolenaar | 91e15e1 | 2014-09-19 22:38:48 +0200 | [diff] [blame] | 46 | let cur_text = getline(v:lnum) |
Bram Moolenaar | 67f8ab8 | 2018-09-11 22:37:29 +0200 | [diff] [blame] | 47 | if cur_text !~ s:lineContPat |
| 48 | while lnum > 0 && getline(lnum) =~ s:lineContPat |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 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 |
Bram Moolenaar | e0e3917 | 2021-01-25 21:14:57 +0100 | [diff] [blame] | 57 | |
| 58 | " the start of the previous line, skipping over line continuation |
Bram Moolenaar | 91e15e1 | 2014-09-19 22:38:48 +0200 | [diff] [blame] | 59 | let prev_text = getline(lnum) |
Bram Moolenaar | 82be484 | 2021-01-11 19:40:15 +0100 | [diff] [blame] | 60 | let found_cont = 0 |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 61 | |
| 62 | " Add a 'shiftwidth' after :if, :while, :try, :catch, :finally, :function |
Bram Moolenaar | 67f8ab8 | 2018-09-11 22:37:29 +0200 | [diff] [blame] | 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). |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 65 | let ind = indent(lnum) |
Bram Moolenaar | 1ff14ba | 2019-11-02 14:09:23 +0100 | [diff] [blame] | 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 | if synIDattr(synID(lnum, 1, 1), "name") !~ 'vimLetHereDoc' |
| 75 | return indent(lnum) |
| 76 | endif |
| 77 | let lnum -= 1 |
| 78 | endwhile |
| 79 | return 0 |
| 80 | endif |
| 81 | if syn_here =~ 'vimLetHereDoc' |
| 82 | if synIDattr(synID(lnum, 1, 1), "name") !~ 'vimLetHereDoc' |
| 83 | " First line in heredoc: increase indent |
| 84 | return ind + shiftwidth() |
| 85 | endif |
| 86 | " Heredoc continues: no change in indent |
| 87 | return ind |
| 88 | endif |
| 89 | endif |
| 90 | |
Bram Moolenaar | 67f8ab8 | 2018-09-11 22:37:29 +0200 | [diff] [blame] | 91 | if cur_text =~ s:lineContPat && v:lnum > 1 && prev_text !~ s:lineContPat |
Bram Moolenaar | 82be484 | 2021-01-11 19:40:15 +0100 | [diff] [blame] | 92 | let found_cont = 1 |
Bram Moolenaar | d4755bb | 2004-09-02 19:12:26 +0000 | [diff] [blame] | 93 | if exists("g:vim_indent_cont") |
| 94 | let ind = ind + g:vim_indent_cont |
| 95 | else |
Bram Moolenaar | 705ada1 | 2016-01-24 17:56:50 +0100 | [diff] [blame] | 96 | let ind = ind + shiftwidth() * 3 |
Bram Moolenaar | d4755bb | 2004-09-02 19:12:26 +0000 | [diff] [blame] | 97 | endif |
Bram Moolenaar | e18dbe8 | 2016-07-02 21:42:23 +0200 | [diff] [blame] | 98 | 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] | 99 | let ind = ind + shiftwidth() |
Bram Moolenaar | cab49df | 2011-03-22 17:40:10 +0100 | [diff] [blame] | 100 | else |
Bram Moolenaar | 91e15e1 | 2014-09-19 22:38:48 +0200 | [diff] [blame] | 101 | " A line starting with :au does not increment/decrement indent. |
Bram Moolenaar | 942db23 | 2021-02-13 18:14:48 +0100 | [diff] [blame] | 102 | " A { may start a block or a dict. Assume that when a } follows it's a |
| 103 | " terminated dict. |
| 104 | if prev_text !~ '^\s*au\%[tocmd]' && prev_text !~ '^\s*{.*}' |
Bram Moolenaar | d58a3bf | 2020-09-28 21:48:16 +0200 | [diff] [blame] | 105 | let i = match(prev_text, '\(^\||\)\s*\(export\s\+\)\?\({\|\(if\|wh\%[ile]\|for\|try\|cat\%[ch]\|fina\|finall\%[y]\|fu\%[nction]\|def\|el\%[seif]\)\>\)') |
Bram Moolenaar | 91e15e1 | 2014-09-19 22:38:48 +0200 | [diff] [blame] | 106 | if i >= 0 |
Bram Moolenaar | 705ada1 | 2016-01-24 17:56:50 +0100 | [diff] [blame] | 107 | let ind += shiftwidth() |
Bram Moolenaar | 91e15e1 | 2014-09-19 22:38:48 +0200 | [diff] [blame] | 108 | if strpart(prev_text, i, 1) == '|' && has('syntax_items') |
| 109 | \ && synIDattr(synID(lnum, i, 1), "name") =~ '\(Comment\|String\)$' |
Bram Moolenaar | 705ada1 | 2016-01-24 17:56:50 +0100 | [diff] [blame] | 110 | let ind -= shiftwidth() |
Bram Moolenaar | 91e15e1 | 2014-09-19 22:38:48 +0200 | [diff] [blame] | 111 | endif |
Bram Moolenaar | cab49df | 2011-03-22 17:40:10 +0100 | [diff] [blame] | 112 | endif |
| 113 | endif |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 114 | endif |
| 115 | |
| 116 | " 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] | 117 | " command. And not when there is a backslash before the pipe. |
Bram Moolenaar | dc27ac1 | 2005-07-06 22:35:45 +0000 | [diff] [blame] | 118 | " And when syntax HL is enabled avoid a match inside a string. |
Bram Moolenaar | 91e15e1 | 2014-09-19 22:38:48 +0200 | [diff] [blame] | 119 | let i = match(prev_text, '[^\\]|\s*\(ene\@!\)') |
| 120 | if i > 0 && prev_text !~ '^\s*au\%[tocmd]' |
Bram Moolenaar | dc27ac1 | 2005-07-06 22:35:45 +0000 | [diff] [blame] | 121 | 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] | 122 | let ind = ind - shiftwidth() |
Bram Moolenaar | dc27ac1 | 2005-07-06 22:35:45 +0000 | [diff] [blame] | 123 | endif |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 124 | endif |
| 125 | |
Bram Moolenaar | 82be484 | 2021-01-11 19:40:15 +0100 | [diff] [blame] | 126 | " For a line starting with "}" find the matching "{". If it is at the start |
| 127 | " of the line align with it, probably end of a block. |
| 128 | " Use the mapped "%" from matchit to find the match, otherwise we may match |
| 129 | " a { inside a comment or string. |
| 130 | if cur_text =~ '^\s*}' |
| 131 | if maparg('%') != '' |
| 132 | exe v:lnum |
| 133 | silent! normal % |
| 134 | if line('.') < v:lnum && getline('.') =~ '^\s*{' |
| 135 | let ind = indent('.') |
| 136 | endif |
| 137 | else |
| 138 | " todo: use searchpair() to find a match |
| 139 | endif |
| 140 | endif |
| 141 | |
| 142 | " Below a line starting with "}" find the matching "{". If it is at the |
| 143 | " end of the line we must be below the end of a dictionary. |
| 144 | if prev_text =~ '^\s*}' |
| 145 | if maparg('%') != '' |
| 146 | exe lnum |
| 147 | silent! normal % |
| 148 | if line('.') == lnum || getline('.') !~ '^\s*{' |
| 149 | let ind = ind - shiftwidth() |
| 150 | endif |
| 151 | else |
| 152 | " todo: use searchpair() to find a match |
| 153 | endif |
| 154 | endif |
| 155 | |
| 156 | " 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] | 157 | " Include a "}" and "},} in case a dictionary ends too. |
| 158 | if prev_text_end =~ '^\s*\(},\=\s*\)\=]' |
Bram Moolenaar | 82be484 | 2021-01-11 19:40:15 +0100 | [diff] [blame] | 159 | let ind = ind - shiftwidth() |
| 160 | endif |
| 161 | |
Bram Moolenaar | 942db23 | 2021-02-13 18:14:48 +0100 | [diff] [blame] | 162 | let ends_in_comment = has('syntax_items') |
Bram Moolenaar | 9faec4e | 2021-02-27 16:38:07 +0100 | [diff] [blame] | 163 | \ && synIDattr(synID(lnum, len(getline(lnum)), 1), "name") =~ '\(Comment\|String\)$' |
Bram Moolenaar | 942db23 | 2021-02-13 18:14:48 +0100 | [diff] [blame] | 164 | |
Bram Moolenaar | 9faec4e | 2021-02-27 16:38:07 +0100 | [diff] [blame] | 165 | " 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] | 166 | " indent the next line more. Not for a continuation line or {{{. |
| 167 | if !ends_in_comment && prev_text_end =~ '\s[{[]\s*$' && !found_cont |
Bram Moolenaar | 82be484 | 2021-01-11 19:40:15 +0100 | [diff] [blame] | 168 | let ind = ind + shiftwidth() |
| 169 | endif |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 170 | |
| 171 | " Subtract a 'shiftwidth' on a :endif, :endwhile, :catch, :finally, :endtry, |
Bram Moolenaar | 8a7d654 | 2020-01-26 15:56:19 +0100 | [diff] [blame] | 172 | " :endfun, :enddef, :else and :augroup END. |
Bram Moolenaar | 82be484 | 2021-01-11 19:40:15 +0100 | [diff] [blame] | 173 | if cur_text =~ '^\s*\(ene\@!\|cat\|finall\|el\|aug\%[roup]\s\+[eE][nN][dD]\)' |
Bram Moolenaar | 705ada1 | 2016-01-24 17:56:50 +0100 | [diff] [blame] | 174 | let ind = ind - shiftwidth() |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 175 | endif |
| 176 | |
| 177 | return ind |
| 178 | endfunction |
| 179 | |
Bram Moolenaar | 8e52a59 | 2012-05-18 21:49:28 +0200 | [diff] [blame] | 180 | let &cpo = s:keepcpo |
| 181 | unlet s:keepcpo |
| 182 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 183 | " vim:sw=2 |