blob: ae4f4b53c4ed117eb198335d8cf302d4ceda4ac5 [file] [log] [blame]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001" Vim indent file
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +02002" Language: Shell Script
3" Maintainer: Christian Brabandt <cb@256bit.org>
Bram Moolenaar86ae7202015-07-10 19:31:35 +02004" Previous Maintainer: Peter Aronoff <telemachus@arpinum.org>
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +02005" Original Author: Nikolai Weibull <now@bitwi.se>
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02006" Latest Revision: 2017-05-02
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +02007" License: Vim (see :h license)
8" Repository: https://github.com/chrisbra/vim-sh-indent
Bram Moolenaare18dbe82016-07-02 21:42:23 +02009" Changelog:
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +020010" 20170502: - get rid of buffer-shiftwidth function
11" 20160912: - preserve indentation of here-doc blocks
Bram Moolenaare18dbe82016-07-02 21:42:23 +020012" 20160627: - detect heredocs correctly
13" 20160213: - detect function definition correctly
14" 20160202: - use shiftwidth() function
15" 20151215: - set b:undo_indent variable
16" 20150728: - add foreach detection for zsh
Bram Moolenaar071d4272004-06-13 20:20:40 +000017
Bram Moolenaar071d4272004-06-13 20:20:40 +000018if exists("b:did_indent")
19 finish
20endif
Bram Moolenaar071d4272004-06-13 20:20:40 +000021let b:did_indent = 1
22
23setlocal indentexpr=GetShIndent()
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +020024setlocal indentkeys+=0=then,0=do,0=else,0=elif,0=fi,0=esac,0=done,0=end,),0=;;,0=;&
Bram Moolenaar5c736222010-01-06 20:54:52 +010025setlocal indentkeys+=0=fin,0=fil,0=fip,0=fir,0=fix
Bram Moolenaar071d4272004-06-13 20:20:40 +000026setlocal indentkeys-=:,0#
Bram Moolenaar5c736222010-01-06 20:54:52 +010027setlocal nosmartindent
Bram Moolenaar071d4272004-06-13 20:20:40 +000028
Bram Moolenaarf3913272016-02-25 00:00:01 +010029let b:undo_indent = 'setlocal indentexpr< indentkeys< smartindent<'
30
Bram Moolenaar071d4272004-06-13 20:20:40 +000031if exists("*GetShIndent")
32 finish
33endif
34
Bram Moolenaar42eeac32005-06-29 22:40:58 +000035let s:cpo_save = &cpo
36set cpo&vim
Bram Moolenaar071d4272004-06-13 20:20:40 +000037
Bram Moolenaar5c736222010-01-06 20:54:52 +010038let s:sh_indent_defaults = {
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +020039 \ 'default': function('shiftwidth'),
40 \ 'continuation-line': function('shiftwidth'),
41 \ 'case-labels': function('shiftwidth'),
42 \ 'case-statements': function('shiftwidth'),
Bram Moolenaar5c736222010-01-06 20:54:52 +010043 \ 'case-breaks': 0 }
44
45function! s:indent_value(option)
46 let Value = exists('b:sh_indent_options')
47 \ && has_key(b:sh_indent_options, a:option) ?
48 \ b:sh_indent_options[a:option] :
49 \ s:sh_indent_defaults[a:option]
50 if type(Value) == type(function('type'))
51 return Value()
52 endif
53 return Value
54endfunction
55
56function! GetShIndent()
Bram Moolenaar071d4272004-06-13 20:20:40 +000057 let lnum = prevnonblank(v:lnum - 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +000058 if lnum == 0
59 return 0
60 endif
61
Bram Moolenaar5c736222010-01-06 20:54:52 +010062 let pnum = prevnonblank(lnum - 1)
63
Bram Moolenaar071d4272004-06-13 20:20:40 +000064 let ind = indent(lnum)
65 let line = getline(lnum)
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +020066 if line =~ '^\s*\%(if\|then\|do\|else\|elif\|case\|while\|until\|for\|select\|foreach\)\>'
67 if line !~ '\<\%(fi\|esac\|done\|end\)\>\s*\%(#.*\)\=$'
Bram Moolenaar5c736222010-01-06 20:54:52 +010068 let ind += s:indent_value('default')
Bram Moolenaar071d4272004-06-13 20:20:40 +000069 endif
Bram Moolenaar5c736222010-01-06 20:54:52 +010070 elseif s:is_case_label(line, pnum)
71 if !s:is_case_ended(line)
72 let ind += s:indent_value('case-statements')
73 endif
Bram Moolenaarf3913272016-02-25 00:00:01 +010074 elseif line =~ '^\s*\<\k\+\>\s*()\s*{' || line =~ '^\s*{' || line =~ '^\s*function\s*\w\S\+\s*\%(()\)\?\s*{'
Bram Moolenaar5c736222010-01-06 20:54:52 +010075 if line !~ '}\s*\%(#.*\)\=$'
76 let ind += s:indent_value('default')
77 endif
78 elseif s:is_continuation_line(line)
79 if pnum == 0 || !s:is_continuation_line(getline(pnum))
80 let ind += s:indent_value('continuation-line')
81 endif
82 elseif pnum != 0 && s:is_continuation_line(getline(pnum))
83 let ind = indent(s:find_continued_lnum(pnum))
Bram Moolenaar071d4272004-06-13 20:20:40 +000084 endif
85
Bram Moolenaar5c736222010-01-06 20:54:52 +010086 let pine = line
Bram Moolenaar071d4272004-06-13 20:20:40 +000087 let line = getline(v:lnum)
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +020088 if line =~ '^\s*\%(then\|do\|else\|elif\|fi\|done\|end\)\>' || line =~ '^\s*}'
Bram Moolenaar5c736222010-01-06 20:54:52 +010089 let ind -= s:indent_value('default')
Bram Moolenaardfb18412013-12-11 18:53:29 +010090 elseif line =~ '^\s*esac\>' && s:is_case_empty(getline(v:lnum - 1))
91 let ind -= s:indent_value('default')
Bram Moolenaar5c736222010-01-06 20:54:52 +010092 elseif line =~ '^\s*esac\>'
93 let ind -= (s:is_case_label(pine, lnum) && s:is_case_ended(pine) ?
94 \ 0 : s:indent_value('case-statements')) +
95 \ s:indent_value('case-labels')
96 if s:is_case_break(pine)
97 let ind += s:indent_value('case-breaks')
98 endif
99 elseif s:is_case_label(line, lnum)
100 if s:is_case(pine)
101 let ind = indent(lnum) + s:indent_value('case-labels')
102 else
Bram Moolenaarfb539272014-08-22 19:21:47 +0200103 let ind -= (s:is_case_label(pine, lnum) && s:is_case_ended(pine) ?
104 \ 0 : s:indent_value('case-statements')) -
105 \ s:indent_value('case-breaks')
Bram Moolenaar5c736222010-01-06 20:54:52 +0100106 endif
107 elseif s:is_case_break(line)
108 let ind -= s:indent_value('case-breaks')
Bram Moolenaare18dbe82016-07-02 21:42:23 +0200109 elseif s:is_here_doc(line)
110 let ind = 0
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200111 " statements, executed within a here document. Keep the current indent
112 elseif match(map(synstack(v:lnum, 1), 'synIDattr(v:val, "name")'), '\c\mheredoc') > -1
113 return indent(v:lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000114 endif
115
116 return ind
117endfunction
118
Bram Moolenaar5c736222010-01-06 20:54:52 +0100119function! s:is_continuation_line(line)
120 return a:line =~ '\%(\%(^\|[^\\]\)\\\|&&\|||\)$'
121endfunction
122
123function! s:find_continued_lnum(lnum)
124 let i = a:lnum
125 while i > 1 && s:is_continuation_line(getline(i - 1))
126 let i -= 1
127 endwhile
128 return i
129endfunction
130
131function! s:is_case_label(line, pnum)
132 if a:line !~ '^\s*(\=.*)'
133 return 0
134 endif
135
136 if a:pnum > 0
137 let pine = getline(a:pnum)
138 if !(s:is_case(pine) || s:is_case_ended(pine))
139 return 0
140 endif
141 endif
142
143 let suffix = substitute(a:line, '^\s*(\=', "", "")
144 let nesting = 0
145 let i = 0
146 let n = strlen(suffix)
147 while i < n
148 let c = suffix[i]
149 let i += 1
150 if c == '\\'
151 let i += 1
152 elseif c == '('
153 let nesting += 1
154 elseif c == ')'
155 if nesting == 0
156 return 1
157 endif
158 let nesting -= 1
159 endif
160 endwhile
161 return 0
162endfunction
163
164function! s:is_case(line)
165 return a:line =~ '^\s*case\>'
166endfunction
167
168function! s:is_case_break(line)
169 return a:line =~ '^\s*;[;&]'
170endfunction
171
Bram Moolenaare18dbe82016-07-02 21:42:23 +0200172function! s:is_here_doc(line)
173 if a:line =~ '^\w\+$'
174 let here_pat = '<<-\?'. s:escape(a:line). '\$'
175 return search(here_pat, 'bnW') > 0
176 endif
177 return 0
178endfunction
179
Bram Moolenaar5c736222010-01-06 20:54:52 +0100180function! s:is_case_ended(line)
181 return s:is_case_break(a:line) || a:line =~ ';[;&]\s*\%(#.*\)\=$'
182endfunction
183
Bram Moolenaardfb18412013-12-11 18:53:29 +0100184function! s:is_case_empty(line)
185 if a:line =~ '^\s*$' || a:line =~ '^\s*#'
186 return s:is_case_empty(getline(v:lnum - 1))
187 else
188 return a:line =~ '^\s*case\>'
189 endif
190endfunction
191
Bram Moolenaare18dbe82016-07-02 21:42:23 +0200192function! s:escape(pattern)
193 return '\V'. escape(a:pattern, '\\')
194endfunction
195
Bram Moolenaar42eeac32005-06-29 22:40:58 +0000196let &cpo = s:cpo_save
197unlet s:cpo_save