blob: 69a03f977d837a2c997661c536eddc783d2ff7bd [file] [log] [blame]
Bram Moolenaarc4573eb2022-01-31 15:40:56 +00001*indent.txt* For Vim version 8.2. Last change: 2022 Jan 31
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7This file is about indenting C programs and other files.
8
Bram Moolenaar3577c6f2008-06-24 21:16:56 +000091. Indenting C style programs |C-indenting|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000102. Indenting by expression |indent-expression|
11
12==============================================================================
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000131. Indenting C style programs *C-indenting*
Bram Moolenaar071d4272004-06-13 20:20:40 +000014
Bram Moolenaar3577c6f2008-06-24 21:16:56 +000015The basics for C style indenting are explained in section |30.2| of the user
16manual.
Bram Moolenaar071d4272004-06-13 20:20:40 +000017
Bram Moolenaar3577c6f2008-06-24 21:16:56 +000018Vim has options for automatically indenting C style program files. Many
19programming languages including Java and C++ follow very closely the
20formatting conventions established with C. These options affect only the
21indent and do not perform other formatting. There are additional options that
22affect other kinds of formatting as well as indenting, see |format-comments|,
23|fo-table|, |gq| and |formatting| for the main ones.
Bram Moolenaar071d4272004-06-13 20:20:40 +000024
25Note that this will not work when the |+smartindent| or |+cindent| features
26have been disabled at compile time.
27
Bram Moolenaar3577c6f2008-06-24 21:16:56 +000028There are in fact four main methods available for indentation, each one
29overrides the previous if it is enabled, or non-empty for 'indentexpr':
Bram Moolenaar071d4272004-06-13 20:20:40 +000030'autoindent' uses the indent from the previous line.
31'smartindent' is like 'autoindent' but also recognizes some C syntax to
32 increase/reduce the indent where appropriate.
33'cindent' Works more cleverly than the other two and is configurable to
34 different indenting styles.
35'indentexpr' The most flexible of all: Evaluates an expression to compute
36 the indent of a line. When non-empty this method overrides
37 the other ones. See |indent-expression|.
38The rest of this section describes the 'cindent' option.
39
40Note that 'cindent' indenting does not work for every code scenario. Vim
Bram Moolenaar9e54a0e2006-04-14 20:42:25 +000041is not a C compiler: it does not recognize all syntax. One requirement is
42that toplevel functions have a '{' in the first column. Otherwise they are
43easily confused with declarations.
Bram Moolenaar071d4272004-06-13 20:20:40 +000044
Tom Praschan3506cf32022-04-07 12:39:08 +010045These five options control C program indenting:
Bram Moolenaar071d4272004-06-13 20:20:40 +000046'cindent' Enables Vim to perform C program indenting automatically.
47'cinkeys' Specifies which keys trigger reindenting in insert mode.
48'cinoptions' Sets your preferred indent style.
49'cinwords' Defines keywords that start an extra indent in the next line.
Tom Praschan3506cf32022-04-07 12:39:08 +010050'cinscopedecls' Defines strings that are recognized as a C++ scope declaration.
Bram Moolenaar071d4272004-06-13 20:20:40 +000051
52If 'lisp' is not on and 'equalprg' is empty, the "=" operator indents using
53Vim's built-in algorithm rather than calling an external program.
54
55See |autocommand| for how to set the 'cindent' option automatically for C code
56files and reset it for others.
57
58 *cinkeys-format* *indentkeys-format*
59The 'cinkeys' option is a string that controls Vim's indenting in response to
60typing certain characters or commands in certain contexts. Note that this not
61only triggers C-indenting. When 'indentexpr' is not empty 'indentkeys' is
62used instead. The format of 'cinkeys' and 'indentkeys' is equal.
63
Bram Moolenaarce655742019-01-31 14:12:57 +010064The default is "0{,0},0),0],:,0#,!^F,o,O,e" which specifies that indenting
65occurs as follows:
Bram Moolenaar071d4272004-06-13 20:20:40 +000066
67 "0{" if you type '{' as the first character in a line
68 "0}" if you type '}' as the first character in a line
69 "0)" if you type ')' as the first character in a line
Bram Moolenaarce655742019-01-31 14:12:57 +010070 "0]" if you type ']' as the first character in a line
Bram Moolenaar071d4272004-06-13 20:20:40 +000071 ":" if you type ':' after a label or case statement
72 "0#" if you type '#' as the first character in a line
73 "!^F" if you type CTRL-F (which is not inserted)
74 "o" if you type a <CR> anywhere or use the "o" command (not in
75 insert mode!)
76 "O" if you use the "O" command (not in insert mode!)
77 "e" if you type the second 'e' for an "else" at the start of a
78 line
79
Bram Moolenaare2f98b92006-03-29 21:18:24 +000080Characters that can precede each key: *i_CTRL-F*
Bram Moolenaar071d4272004-06-13 20:20:40 +000081! When a '!' precedes the key, Vim will not insert the key but will
82 instead reindent the current line. This allows you to define a
83 command key for reindenting the current line. CTRL-F is the default
84 key for this. Be careful if you define CTRL-I for this because CTRL-I
85 is the ASCII code for <Tab>.
86* When a '*' precedes the key, Vim will reindent the line before
87 inserting the key. If 'cinkeys' contains "*<Return>", Vim reindents
88 the current line before opening a new line.
890 When a zero precedes the key (but appears after '!' or '*') Vim will
90 reindent the line only if the key is the first character you type in
91 the line. When used before "=" Vim will only reindent the line if
92 there is only white space before the word.
93
94When neither '!' nor '*' precedes the key, Vim reindents the line after you
95type the key. So ';' sets the indentation of a line which includes the ';'.
96
97Special key names:
98<> Angle brackets mean spelled-out names of keys. For example: "<Up>",
99 "<Ins>" (see |key-notation|).
100^ Letters preceded by a caret (^) are control characters. For example:
101 "^F" is CTRL-F.
102o Reindent a line when you use the "o" command or when Vim opens a new
103 line below the current one (e.g., when you type <Enter> in insert
104 mode).
105O Reindent a line when you use the "O" command.
106e Reindent a line that starts with "else" when you type the second 'e'.
107: Reindent a line when a ':' is typed which is after a label or case
108 statement. Don't reindent for a ":" in "class::method" for C++. To
109 Reindent for any ":", use "<:>".
110=word Reindent when typing the last character of "word". "word" may
111 actually be part of another word. Thus "=end" would cause reindenting
112 when typing the "d" in "endif" or "endwhile". But not when typing
113 "bend". Also reindent when completion produces a word that starts
114 with "word". "0=word" reindents when there is only white space before
115 the word.
116=~word Like =word, but ignore case.
117
118If you really want to reindent when you type 'o', 'O', 'e', '0', '<', '>',
119'*', ':' or '!', use "<o>", "<O>", "<e>", "<0>", "<<>", "<>>", "<*>", "<:>" or
120"<!>", respectively, for those keys.
121
122For an emacs-style indent mode where lines aren't indented every time you
Bram Moolenaar5c3e56a2007-05-12 13:43:14 +0000123press <Enter> but only if you press <Tab>, I suggest:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000124 :set cinkeys=0{,0},:,0#,!<Tab>,!^F
125You might also want to switch off 'autoindent' then.
126
127Note: If you change the current line's indentation manually, Vim ignores the
128cindent settings for that line. This prevents vim from reindenting after you
129have changed the indent by typing <BS>, <Tab>, or <Space> in the indent or
130used CTRL-T or CTRL-D.
131
132 *cinoptions-values*
Bram Moolenaared38b0a2011-05-25 15:16:18 +0200133The 'cinoptions' option sets how Vim performs indentation. The value after
134the option character can be one of these (N is any number):
135 N indent N spaces
136 -N indent N spaces to the left
Bram Moolenaar5302d9e2011-09-14 17:55:08 +0200137 Ns N times 'shiftwidth' spaces
138 -Ns N times 'shiftwidth' spaces to the left
Bram Moolenaared38b0a2011-05-25 15:16:18 +0200139
140In the list below,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000141"N" represents a number of your choice (the number can be negative). When
142there is an 's' after the number, Vim multiplies the number by 'shiftwidth':
143"1s" is 'shiftwidth', "2s" is two times 'shiftwidth', etc. You can use a
Bram Moolenaared38b0a2011-05-25 15:16:18 +0200144decimal point, too: "-0.5s" is minus half a 'shiftwidth'.
145The examples below assume a 'shiftwidth' of 4.
146 *cino->*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000147 >N Amount added for "normal" indent. Used after a line that should
148 increase the indent (lines starting with "if", an opening brace,
149 etc.). (default 'shiftwidth').
150
151 cino= cino=>2 cino=>2s >
152 if (cond) if (cond) if (cond)
153 { { {
154 foo; foo; foo;
155 } } }
156<
Bram Moolenaared38b0a2011-05-25 15:16:18 +0200157 *cino-e*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000158 eN Add N to the prevailing indent inside a set of braces if the
159 opening brace at the End of the line (more precise: is not the
160 first character in a line). This is useful if you want a
161 different indent when the '{' is at the start of the line from
162 when '{' is at the end of the line. (default 0).
163
164 cino= cino=e2 cino=e-2 >
165 if (cond) { if (cond) { if (cond) {
166 foo; foo; foo;
167 } } }
168 else else else
169 { { {
170 bar; bar; bar;
171 } } }
172<
Bram Moolenaared38b0a2011-05-25 15:16:18 +0200173 *cino-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000174 nN Add N to the prevailing indent for a statement after an "if",
175 "while", etc., if it is NOT inside a set of braces. This is
176 useful if you want a different indent when there is no '{'
177 before the statement from when there is a '{' before it.
178 (default 0).
179
180 cino= cino=n2 cino=n-2 >
181 if (cond) if (cond) if (cond)
182 foo; foo; foo;
183 else else else
184 { { {
185 bar; bar; bar;
186 } } }
187<
Bram Moolenaared38b0a2011-05-25 15:16:18 +0200188 *cino-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000189 fN Place the first opening brace of a function or other block in
190 column N. This applies only for an opening brace that is not
191 inside other braces and is at the start of the line. What comes
192 after the brace is put relative to this brace. (default 0).
193
194 cino= cino=f.5s cino=f1s >
195 func() func() func()
196 { { {
197 int foo; int foo; int foo;
198<
Bram Moolenaared38b0a2011-05-25 15:16:18 +0200199 *cino-{*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000200 {N Place opening braces N characters from the prevailing indent.
201 This applies only for opening braces that are inside other
202 braces. (default 0).
203
204 cino= cino={.5s cino={1s >
205 if (cond) if (cond) if (cond)
206 { { {
207 foo; foo; foo;
208<
Bram Moolenaared38b0a2011-05-25 15:16:18 +0200209 *cino-}*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000210 }N Place closing braces N characters from the matching opening
211 brace. (default 0).
212
213 cino= cino={2,}-0.5s cino=}2 >
214 if (cond) if (cond) if (cond)
215 { { {
216 foo; foo; foo;
217 } } }
218<
Bram Moolenaared38b0a2011-05-25 15:16:18 +0200219 *cino-^*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000220 ^N Add N to the prevailing indent inside a set of braces if the
221 opening brace is in column 0. This can specify a different
222 indent for whole of a function (some may like to set it to a
223 negative number). (default 0).
224
225 cino= cino=^-2 cino=^-s >
226 func() func() func()
227 { { {
228 if (cond) if (cond) if (cond)
229 { { {
230 a = b; a = b; a = b;
231 } } }
232 } } }
233<
Bram Moolenaared38b0a2011-05-25 15:16:18 +0200234 *cino-L*
Bram Moolenaar02c707a2010-07-17 17:12:06 +0200235 LN Controls placement of jump labels. If N is negative, the label
236 will be placed at column 1. If N is non-negative, the indent of
237 the label will be the prevailing indent minus N. (default -1).
238
239 cino= cino=L2 cino=Ls >
240 func() func() func()
241 { { {
242 { { {
243 stmt; stmt; stmt;
244 LABEL: LABEL: LABEL:
245 } } }
246 } } }
247<
Bram Moolenaared38b0a2011-05-25 15:16:18 +0200248 *cino-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000249 :N Place case labels N characters from the indent of the switch().
250 (default 'shiftwidth').
251
252 cino= cino=:0 >
253 switch (x) switch(x)
254 { {
255 case 1: case 1:
256 a = b; a = b;
257 default: default:
258 } }
259<
Bram Moolenaared38b0a2011-05-25 15:16:18 +0200260 *cino-=*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000261 =N Place statements occurring after a case label N characters from
262 the indent of the label. (default 'shiftwidth').
263
264 cino= cino==10 >
265 case 11: case 11: a = a + 1;
266 a = a + 1; b = b + 1;
267<
Bram Moolenaared38b0a2011-05-25 15:16:18 +0200268 *cino-l*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000269 lN If N != 0 Vim will align with a case label instead of the
270 statement after it in the same line.
271
272 cino= cino=l1 >
273 switch (a) { switch (a) {
274 case 1: { case 1: {
275 break; break;
276 } }
277<
Bram Moolenaared38b0a2011-05-25 15:16:18 +0200278 *cino-b*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000279 bN If N != 0 Vim will align a final "break" with the case label,
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000280 so that case..break looks like a sort of block. (default: 0).
Bram Moolenaar81af9252010-12-10 20:35:50 +0100281 When using 1, consider adding "0=break" to 'cinkeys'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000282
283 cino= cino=b1 >
284 switch (x) switch(x)
285 { {
286 case 1: case 1:
287 a = b; a = b;
288 break; break;
289
290 default: default:
291 a = 0; a = 0;
292 break; break;
293 } }
294<
Bram Moolenaared38b0a2011-05-25 15:16:18 +0200295 *cino-g*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000296 gN Place C++ scope declarations N characters from the indent of the
Tom Praschan3506cf32022-04-07 12:39:08 +0100297 block they are in. (default 'shiftwidth'). By default, a scope
298 declaration is "public:", "protected:" or "private:". This can
299 be adjusted with the 'cinscopedecls' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000300
301 cino= cino=g0 >
302 { {
303 public: public:
304 a = b; a = b;
305 private: private:
306 } }
307<
Bram Moolenaared38b0a2011-05-25 15:16:18 +0200308 *cino-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000309 hN Place statements occurring after a C++ scope declaration N
310 characters from the indent of the label. (default
311 'shiftwidth').
312
313 cino= cino=h10 >
314 public: public: a = a + 1;
315 a = a + 1; b = b + 1;
316<
Bram Moolenaared38b0a2011-05-25 15:16:18 +0200317 *cino-N*
318 NN Indent inside C++ namespace N characters extra compared to a
319 normal block. (default 0).
320
321 cino= cino=N-s >
322 namespace { namespace {
323 void function(); void function();
324 } }
325
326 namespace my namespace my
327 { {
328 void function(); void function();
329 } }
330<
Bram Moolenaar7720ba82017-03-08 22:19:26 +0100331 *cino-E*
332 EN Indent inside C++ linkage specifications (extern "C" or
333 extern "C++") N characters extra compared to a normal block.
334 (default 0).
335
336 cino= cino=E-s >
337 extern "C" { extern "C" {
338 void function(); void function();
339 } }
340
341 extern "C" extern "C"
342 { {
343 void function(); void function();
344 } }
345<
Bram Moolenaared38b0a2011-05-25 15:16:18 +0200346 *cino-p*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000347 pN Parameter declarations for K&R-style function declarations will
348 be indented N characters from the margin. (default
349 'shiftwidth').
350
351 cino= cino=p0 cino=p2s >
352 func(a, b) func(a, b) func(a, b)
353 int a; int a; int a;
354 char b; char b; char b;
355<
Bram Moolenaared38b0a2011-05-25 15:16:18 +0200356 *cino-t*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000357 tN Indent a function return type declaration N characters from the
358 margin. (default 'shiftwidth').
359
360 cino= cino=t0 cino=t7 >
361 int int int
362 func() func() func()
363<
Bram Moolenaared38b0a2011-05-25 15:16:18 +0200364 *cino-i*
Bram Moolenaar551dbcc2006-04-25 22:13:59 +0000365 iN Indent C++ base class declarations and constructor
Bram Moolenaar071d4272004-06-13 20:20:40 +0000366 initializations, if they start in a new line (otherwise they
367 are aligned at the right side of the ':').
368 (default 'shiftwidth').
369
370 cino= cino=i0 >
371 class MyClass : class MyClass :
372 public BaseClass public BaseClass
373 {} {}
374 MyClass::MyClass() : MyClass::MyClass() :
375 BaseClass(3) BaseClass(3)
376 {} {}
377<
Bram Moolenaared38b0a2011-05-25 15:16:18 +0200378 *cino-+*
Bram Moolenaar662db672011-03-22 14:05:35 +0100379 +N Indent a continuation line (a line that spills onto the next)
380 inside a function N additional characters. (default
381 'shiftwidth').
382 Outside of a function, when the previous line ended in a
383 backslash, the 2 * N is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000384
385 cino= cino=+10 >
386 a = b + 9 * a = b + 9 *
387 c; c;
388<
Bram Moolenaared38b0a2011-05-25 15:16:18 +0200389 *cino-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000390 cN Indent comment lines after the comment opener, when there is no
391 other text with which to align, N characters from the comment
392 opener. (default 3). See also |format-comments|.
393
394 cino= cino=c5 >
395 /* /*
396 text. text.
397 */ */
398<
Bram Moolenaared38b0a2011-05-25 15:16:18 +0200399 *cino-C*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000400 CN When N is non-zero, indent comment lines by the amount specified
401 with the c flag above even if there is other text behind the
402 comment opener. (default 0).
403
404 cino=c0 cino=c0,C1 >
405 /******** /********
406 text. text.
407 ********/ ********/
408< (Example uses ":set comments& comments-=s1:/* comments^=s0:/*")
409
Bram Moolenaared38b0a2011-05-25 15:16:18 +0200410 *cino-/*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000411 /N Indent comment lines N characters extra. (default 0).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000412 cino= cino=/4 >
413 a = b; a = b;
414 /* comment */ /* comment */
415 c = d; c = d;
416<
Bram Moolenaared38b0a2011-05-25 15:16:18 +0200417 *cino-(*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000418 (N When in unclosed parentheses, indent N characters from the line
Bram Moolenaare7b1ea02020-08-07 19:54:59 +0200419 with the unclosed parenthesis. Add a 'shiftwidth' for every
Bram Moolenaar51ad4ea2018-04-06 11:14:11 +0200420 extra unclosed parentheses. When N is 0 or the unclosed
Bram Moolenaare7b1ea02020-08-07 19:54:59 +0200421 parenthesis is the first non-white character in its line, line
Bram Moolenaar51ad4ea2018-04-06 11:14:11 +0200422 up with the next non-white character after the unclosed
Bram Moolenaare7b1ea02020-08-07 19:54:59 +0200423 parenthesis. (default 'shiftwidth' * 2).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000424
425 cino= cino=(0 >
426 if (c1 && (c2 || if (c1 && (c2 ||
427 c3)) c3))
428 foo; foo;
429 if (c1 && if (c1 &&
430 (c2 || c3)) (c2 || c3))
431 { {
432<
Bram Moolenaared38b0a2011-05-25 15:16:18 +0200433 *cino-u*
Bram Moolenaar51ad4ea2018-04-06 11:14:11 +0200434 uN Same as (N, but for one nesting level deeper.
435 (default 'shiftwidth').
Bram Moolenaar071d4272004-06-13 20:20:40 +0000436
437 cino= cino=u2 >
438 if (c123456789 if (c123456789
439 && (c22345 && (c22345
440 || c3)) || c3))
441<
Bram Moolenaared38b0a2011-05-25 15:16:18 +0200442 *cino-U*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000443 UN When N is non-zero, do not ignore the indenting specified by
Bram Moolenaare7b1ea02020-08-07 19:54:59 +0200444 ( or u in case that the unclosed parenthesis is the first
Bram Moolenaar071d4272004-06-13 20:20:40 +0000445 non-white character in its line. (default 0).
446
447 cino= or cino=(s cino=(s,U1 >
448 c = c1 && c = c1 &&
449 ( (
450 c2 || c2 ||
451 c3 c3
452 ) && c4; ) && c4;
453<
Bram Moolenaar5302d9e2011-09-14 17:55:08 +0200454 *cino-w*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000455 wN When in unclosed parentheses and N is non-zero and either
456 using "(0" or "u0", respectively, or using "U0" and the unclosed
Bram Moolenaare7b1ea02020-08-07 19:54:59 +0200457 parenthesis is the first non-white character in its line, line
458 up with the character immediately after the unclosed parenthesis
Bram Moolenaar071d4272004-06-13 20:20:40 +0000459 rather than the first non-white character. (default 0).
460
461 cino=(0 cino=(0,w1 >
462 if ( c1 if ( c1
463 && ( c2 && ( c2
464 || c3)) || c3))
465 foo; foo;
466<
Bram Moolenaared38b0a2011-05-25 15:16:18 +0200467 *cino-W*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000468 WN When in unclosed parentheses and N is non-zero and either
Bram Moolenaare7b1ea02020-08-07 19:54:59 +0200469 using "(0" or "u0", respectively and the unclosed parenthesis is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000470 the last non-white character in its line and it is not the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +0200471 closing parenthesis, indent the following line N characters
Bram Moolenaar071d4272004-06-13 20:20:40 +0000472 relative to the outer context (i.e. start of the line or the
Bram Moolenaare7b1ea02020-08-07 19:54:59 +0200473 next unclosed parenthesis). (default: 0).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000474
475 cino=(0 cino=(0,W4 >
476 a_long_line( a_long_line(
477 argument, argument,
478 argument); argument);
479 a_short_line(argument, a_short_line(argument,
480 argument); argument);
481<
Bram Moolenaar3675fa02012-04-05 17:17:42 +0200482 *cino-k*
483 kN When in unclosed parentheses which follow "if", "for" or
484 "while" and N is non-zero, overrides the behaviour defined by
485 "(N": causes the indent to be N characters relative to the outer
486 context (i.e. the line where "if", "for" or "while" is). Has
487 no effect on deeper levels of nesting. Affects flags like "wN"
488 only for the "if", "for" and "while" conditions. If 0, defaults
489 to behaviour defined by the "(N" flag. (default: 0).
490
491 cino=(0 cino=(0,ks >
492 if (condition1 if (condition1
493 && condition2) && condition2)
494 action(); action();
495 function(argument1 function(argument1
496 && argument2); && argument2);
497<
Bram Moolenaared38b0a2011-05-25 15:16:18 +0200498 *cino-m*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000499 mN When N is non-zero, line up a line starting with a closing
Bram Moolenaare7b1ea02020-08-07 19:54:59 +0200500 parenthesis with the first character of the line with the
501 matching opening parenthesis. (default 0).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000502
503 cino=(s cino=(s,m1 >
504 c = c1 && ( c = c1 && (
505 c2 || c2 ||
506 c3 c3
507 ) && c4; ) && c4;
508 if ( if (
509 c1 && c2 c1 && c2
510 ) )
511 foo; foo;
512<
Bram Moolenaared38b0a2011-05-25 15:16:18 +0200513 *cino-M*
Bram Moolenaar9e54a0e2006-04-14 20:42:25 +0000514 MN When N is non-zero, line up a line starting with a closing
Bram Moolenaare7b1ea02020-08-07 19:54:59 +0200515 parenthesis with the first character of the previous line.
Bram Moolenaar9e54a0e2006-04-14 20:42:25 +0000516 (default 0).
517
518 cino= cino=M1 >
519 if (cond1 && if (cond1 &&
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000520 cond2 cond2
521 ) )
Bram Moolenaar9e54a0e2006-04-14 20:42:25 +0000522<
Bram Moolenaared38b0a2011-05-25 15:16:18 +0200523 *java-cinoptions* *java-indenting* *cino-j*
Bram Moolenaar97293012011-07-18 19:40:27 +0200524 jN Indent Java anonymous classes correctly. Also works well for
525 Javascript. The value 'N' is currently unused but must be
526 non-zero (e.g. 'j1'). 'j1' will indent for example the
527 following code snippet correctly: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000528
529 object.add(new ChangeListener() {
530 public void stateChanged(ChangeEvent e) {
531 do_something();
532 }
533 });
534<
Bram Moolenaared38b0a2011-05-25 15:16:18 +0200535 *javascript-cinoptions* *javascript-indenting* *cino-J*
Bram Moolenaar3acfc302010-07-11 17:23:02 +0200536 JN Indent JavaScript object declarations correctly by not confusing
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100537 them with labels. The value 'N' is currently unused but must be
Bram Moolenaar97293012011-07-18 19:40:27 +0200538 non-zero (e.g. 'J1'). If you enable this you probably also want
539 to set |cino-j|. >
Bram Moolenaar3acfc302010-07-11 17:23:02 +0200540
541 var bar = {
542 foo: {
543 that: this,
544 some: ok,
545 },
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100546 "bar":{
Bram Moolenaar3acfc302010-07-11 17:23:02 +0200547 a : 2,
548 b: "123abc",
549 x: 4,
550 "y": 5
551 }
552 }
553<
Bram Moolenaared38b0a2011-05-25 15:16:18 +0200554 *cino-)*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000555 )N Vim searches for unclosed parentheses at most N lines away.
556 This limits the time needed to search for parentheses. (default
557 20 lines).
558
Bram Moolenaared38b0a2011-05-25 15:16:18 +0200559 *cino-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000560 *N Vim searches for unclosed comments at most N lines away. This
561 limits the time needed to search for the start of a comment.
Bram Moolenaard09acef2012-09-21 14:54:30 +0200562 If your /* */ comments stop indenting after N lines this is the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +0200563 value you will want to change.
Bram Moolenaar6dfc28b2010-02-11 14:19:15 +0100564 (default 70 lines).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000565
Bram Moolenaared38b0a2011-05-25 15:16:18 +0200566 *cino-#*
Bram Moolenaar6bcbcc52013-11-05 07:13:41 +0100567 #N When N is non-zero recognize shell/Perl comments starting with
568 '#', do not recognize preprocessor lines; allow right-shifting
569 lines that start with "#".
570 When N is zero (default): don't recognize '#' comments, do
571 recognize preprocessor lines; right-shifting lines that start
572 with "#" does not work.
Bram Moolenaar39353fd2007-03-27 09:02:11 +0000573
Bram Moolenaare7b1ea02020-08-07 19:54:59 +0200574 *cino-P*
Bram Moolenaard881b512020-05-31 17:49:30 +0200575 PN When N is non-zero recognize C pragmas, and indent them like any
576 other code; does not concern other preprocessor directives.
577 When N is zero (default): don't recognize C pragmas, treating
578 them like every other preprocessor directive.
579
580
Bram Moolenaar071d4272004-06-13 20:20:40 +0000581The defaults, spelled out in full, are:
Bram Moolenaar7720ba82017-03-08 22:19:26 +0100582 cinoptions=>s,e0,n0,f0,{0,}0,^0,L-1,:s,=s,l0,b0,gs,hs,N0,E0,ps,ts,is,+s,
Bram Moolenaard881b512020-05-31 17:49:30 +0200583 c3,C0,/0,(2s,us,U0,w0,W0,k0,m0,j0,J0,)20,*70,#0,P0
Bram Moolenaar071d4272004-06-13 20:20:40 +0000584
585Vim puts a line in column 1 if:
Bram Moolenaar6bcbcc52013-11-05 07:13:41 +0100586- It starts with '#' (preprocessor directives), if 'cinkeys' contains '#0'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000587- It starts with a label (a keyword followed by ':', other than "case" and
Bram Moolenaar02c707a2010-07-17 17:12:06 +0200588 "default") and 'cinoptions' does not contain an 'L' entry with a positive
589 value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000590- Any combination of indentations causes the line to have less than 0
591 indentation.
592
593==============================================================================
5942. Indenting by expression *indent-expression*
595
596The basics for using flexible indenting are explained in section |30.3| of the
597user manual.
598
599If you want to write your own indent file, it must set the 'indentexpr'
Bram Moolenaarba3ff532018-11-04 14:45:49 +0100600option. Setting the 'indentkeys' option is often useful.
601See the $VIMRUNTIME/indent/README.txt file for hints.
602See the $VIMRUNTIME/indent directory for examples.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000603
604
605REMARKS ABOUT SPECIFIC INDENT FILES ~
606
607
Bram Moolenaarfa13eef2013-02-06 17:34:04 +0100608CLOJURE *ft-clojure-indent* *clojure-indent*
609
610Clojure indentation differs somewhat from traditional Lisps, due in part to
611the use of square and curly brackets, and otherwise by community convention.
Bram Moolenaarbaca7f72013-09-22 14:42:24 +0200612These conventions are not universally followed, so the Clojure indent script
Bram Moolenaar113cb512021-11-07 20:27:04 +0000613offers a few configuration options.
Bram Moolenaarfa13eef2013-02-06 17:34:04 +0100614
Bram Moolenaar113cb512021-11-07 20:27:04 +0000615(If the current Vim does not include |searchpairpos()|, the indent script falls
616back to normal 'lisp' indenting, and the following options are ignored.)
617
Bram Moolenaarfa13eef2013-02-06 17:34:04 +0100618
619 *g:clojure_maxlines*
620
Bram Moolenaar113cb512021-11-07 20:27:04 +0000621Sets maximum scan distance of `searchpairpos()`. Larger values trade
622performance for correctness when dealing with very long forms. A value of
6230 will scan without limits. The default is 300.
624
625
Bram Moolenaarfa13eef2013-02-06 17:34:04 +0100626 *g:clojure_fuzzy_indent*
627 *g:clojure_fuzzy_indent_patterns*
628 *g:clojure_fuzzy_indent_blacklist*
629
630The 'lispwords' option is a list of comma-separated words that mark special
Bram Moolenaar113cb512021-11-07 20:27:04 +0000631forms whose subforms should be indented with two spaces.
Bram Moolenaarfa13eef2013-02-06 17:34:04 +0100632
633For example:
634>
635 (defn bad []
636 "Incorrect indentation")
637
638 (defn good []
639 "Correct indentation")
640<
641If you would like to specify 'lispwords' with a |pattern| instead, you can use
642the fuzzy indent feature:
643>
644 " Default
645 let g:clojure_fuzzy_indent = 1
646 let g:clojure_fuzzy_indent_patterns = ['^with', '^def', '^let']
647 let g:clojure_fuzzy_indent_blacklist =
648 \ ['-fn$', '\v^with-%(meta|out-str|loading-context)$']
Bram Moolenaarfa13eef2013-02-06 17:34:04 +0100649<
650|g:clojure_fuzzy_indent_patterns| and |g:clojure_fuzzy_indent_blacklist| are
Bram Moolenaar113cb512021-11-07 20:27:04 +0000651lists of patterns that will be matched against the unqualified symbol at the
652head of a list. This means that a pattern like `"^foo"` will match all these
653candidates: `foobar`, `my.ns/foobar`, and `#'foobar`.
Bram Moolenaarfa13eef2013-02-06 17:34:04 +0100654
655Each candidate word is tested for special treatment in this order:
656
657 1. Return true if word is literally in 'lispwords'
658 2. Return false if word matches a pattern in
659 |g:clojure_fuzzy_indent_blacklist|
660 3. Return true if word matches a pattern in
661 |g:clojure_fuzzy_indent_patterns|
662 4. Return false and indent normally otherwise
663
Bram Moolenaar113cb512021-11-07 20:27:04 +0000664
Bram Moolenaarfa13eef2013-02-06 17:34:04 +0100665 *g:clojure_special_indent_words*
666
Bram Moolenaar113cb512021-11-07 20:27:04 +0000667Some forms in Clojure are indented such that every subform is indented by only
668two spaces, regardless of 'lispwords'. If you have a custom construct that
669should be indented in this idiosyncratic fashion, you can add your symbols to
670the default list below.
Bram Moolenaarfa13eef2013-02-06 17:34:04 +0100671>
672 " Default
673 let g:clojure_special_indent_words =
674 \ 'deftype,defrecord,reify,proxy,extend-type,extend-protocol,letfn'
675<
Bram Moolenaar113cb512021-11-07 20:27:04 +0000676
Bram Moolenaarfa13eef2013-02-06 17:34:04 +0100677 *g:clojure_align_multiline_strings*
678
Bram Moolenaar113cb512021-11-07 20:27:04 +0000679Align subsequent lines in multi-line strings to the column after the opening
Bram Moolenaarfa13eef2013-02-06 17:34:04 +0100680quote, instead of the same column.
681
682For example:
683>
684 (def default
685 "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do
686 eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut
687 enim ad minim veniam, quis nostrud exercitation ullamco laboris
688 nisi ut aliquip ex ea commodo consequat.")
689
690 (def aligned
691 "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do
692 eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut
693 enim ad minim veniam, quis nostrud exercitation ullamco laboris
694 nisi ut aliquip ex ea commodo consequat.")
695<
Bram Moolenaar113cb512021-11-07 20:27:04 +0000696
Bram Moolenaar438f67a2014-01-07 06:09:28 +0100697 *g:clojure_align_subforms*
698
699By default, parenthesized compound forms that look like function calls and
700whose head subform is on its own line have subsequent subforms indented by
701two spaces relative to the opening paren:
702>
703 (foo
704 bar
705 baz)
706<
Bram Moolenaar113cb512021-11-07 20:27:04 +0000707Setting this option to `1` changes this behaviour so that all subforms are
708aligned to the same column, emulating the default behaviour of
709clojure-mode.el:
Bram Moolenaar438f67a2014-01-07 06:09:28 +0100710>
711 (foo
712 bar
713 baz)
714<
Bram Moolenaarfa13eef2013-02-06 17:34:04 +0100715
Bram Moolenaarda2303d2005-08-30 21:55:26 +0000716FORTRAN *ft-fortran-indent*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000717
Bram Moolenaar251e1912011-06-19 05:09:16 +0200718Block if, select case, where, and forall constructs are indented. So are
719type, interface, associate, block, and enum constructs. The indenting of
720subroutines, functions, modules, and program blocks is optional. Comments,
721labelled statements and continuation lines are indented if the Fortran is in
722free source form, whereas they are not indented if the Fortran is in fixed
723source form because of the left margin requirements. Hence manual indent
724corrections will be necessary for labelled statements and continuation lines
725when fixed source form is being used. For further discussion of the method
726used for the detection of source format see |ft-fortran-syntax|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000727
728Do loops ~
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000729All do loops are left unindented by default. Do loops can be unstructured in
Bram Moolenaar071d4272004-06-13 20:20:40 +0000730Fortran with (possibly multiple) loops ending on a labelled executable
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000731statement of almost arbitrary type. Correct indentation requires
732compiler-quality parsing. Old code with do loops ending on labelled statements
Bram Moolenaar071d4272004-06-13 20:20:40 +0000733of arbitrary type can be indented with elaborate programs such as Tidy
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000734(http://www.unb.ca/chem/ajit/f_tidy.htm). Structured do/continue loops are
Bram Moolenaar071d4272004-06-13 20:20:40 +0000735also left unindented because continue statements are also used for purposes
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000736other than ending a do loop. Programs such as Tidy can convert structured
737do/continue loops to the do/enddo form. Do loops of the do/enddo variety can
738be indented. If you use only structured loops of the do/enddo form, you should
Bram Moolenaar071d4272004-06-13 20:20:40 +0000739declare this by setting the fortran_do_enddo variable in your .vimrc as
740follows >
741
742 let fortran_do_enddo=1
743
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000744in which case do loops will be indented. If all your loops are of do/enddo
Bram Moolenaar071d4272004-06-13 20:20:40 +0000745type only in, say, .f90 files, then you should set a buffer flag with an
746autocommand such as >
747
748 au! BufRead,BufNewFile *.f90 let b:fortran_do_enddo=1
749
750to get do loops indented in .f90 files and left alone in Fortran files with
751other extensions such as .for.
752
Bram Moolenaar251e1912011-06-19 05:09:16 +0200753Program units ~
754The indenting of program units (subroutines, functions, modules, and program
755blocks) is enabled by default but can be suppressed if a lighter, screen-width
756preserving indent style is desired. To suppress the indenting of program
757units for all fortran files set the global fortran_indent_less variable in
758your .vimrc as follows >
759
760 let fortran_indent_less=1
761
762A finer level of suppression can be achieved by setting the corresponding
763buffer-local variable as follows >
764
765 let b:fortran_indent_less=1
766
Bram Moolenaar071d4272004-06-13 20:20:40 +0000767
Bram Moolenaarec7944a2013-06-12 21:29:15 +0200768HTML *ft-html-indent* *html-indent* *html-indenting*
769
770This is about variables you can set in your vimrc to customize HTML indenting.
771
772You can set the indent for the first line after <script> and <style>
773"blocktags" (default "zero"): >
774
775 :let g:html_indent_script1 = "inc"
776 :let g:html_indent_style1 = "inc"
777<
778 VALUE MEANING ~
779 "zero" zero indent
780 "auto" auto indent (same indent as the blocktag)
781 "inc" auto indent + one indent step
782
Bram Moolenaarc4573eb2022-01-31 15:40:56 +0000783You can set the indent for attributes after an open <tag line: >
784
785 :let g:html_indent_attribute = 1
786<
787 VALUE MEANING ~
788 1 auto indent, one indent step more than <tag
789 2 auto indent, two indent steps (default)
790 > 2 auto indent, more indent steps
791
Bram Moolenaarec7944a2013-06-12 21:29:15 +0200792Many tags increase the indent for what follows per default (see "Add Indent
Bram Moolenaar52b91d82013-06-15 21:39:51 +0200793Tags" in the script). You can add further tags with: >
Bram Moolenaarec7944a2013-06-12 21:29:15 +0200794
795 :let g:html_indent_inctags = "html,body,head,tbody"
796
797You can also remove such tags with: >
798
799 :let g:html_indent_autotags = "th,td,tr,tfoot,thead"
800
801Default value is empty for both variables. Note: the initial "inctags" are
802only defined once per Vim session.
803
804User variables are only read when the script is sourced. To enable your
Bram Moolenaar52b91d82013-06-15 21:39:51 +0200805changes during a session, without reloading the HTML file, you can manually
Bram Moolenaarec7944a2013-06-12 21:29:15 +0200806do: >
807
808 :call HtmlIndent_CheckUserSettings()
809
810Detail:
811 Calculation of indent inside "blocktags" with "alien" content:
812 BLOCKTAG INDENT EXPR WHEN APPLICABLE ~
Bram Moolenaar52b91d82013-06-15 21:39:51 +0200813 <script> : {customizable} if first line of block
814 : cindent(v:lnum) if attributes empty or contain "java"
815 : -1 else (vbscript, tcl, ...)
816 <style> : {customizable} if first line of block
817 : GetCSSIndent() else
Bram Moolenaarec7944a2013-06-12 21:29:15 +0200818 <!-- --> : -1
819
820
Bram Moolenaar32b364f2019-12-08 15:07:48 +0100821MATLAB *ft-matlab-indent* *matlab-indent* *matlab-indenting*
822
823The setting Function indenting format in MATLAB Editor/Debugger Language
824Preferences corresponds to: >
825 :let g:MATLAB_function_indent = {0, 1 or 2 (default)}
826
827Where 0 is for Classic, 1 for Indent nested functions and 2 for Indent all
828functions.
829
830
Bram Moolenaarc236c162008-07-13 17:41:49 +0000831PHP *ft-php-indent* *php-indent* *php-indenting*
832
833NOTE: PHP files will be indented correctly only if PHP |syntax| is active.
834
835If you are editing a file in Unix 'fileformat' and '\r' characters are present
836before new lines, indentation won't proceed correctly ; you have to remove
837those useless characters first with a command like: >
838
839 :%s /\r$//g
840
841Or, you can simply |:let| the variable PHP_removeCRwhenUnix to 1 and the
Bram Moolenaare6ae6222013-05-21 21:01:10 +0200842script will silently remove them when Vim loads a PHP file (at each |BufRead|).
Bram Moolenaarc236c162008-07-13 17:41:49 +0000843
844OPTIONS: ~
845
846PHP indenting can be altered in several ways by modifying the values of some
Bram Moolenaare6ae6222013-05-21 21:01:10 +0200847global variables:
Bram Moolenaarc236c162008-07-13 17:41:49 +0000848
Bram Moolenaarbcb98982014-05-01 14:08:19 +0200849 *php-comment* *PHP_autoformatcomment*
Bram Moolenaar088e8e32019-08-08 22:15:18 +0200850To not enable auto-formatting of comments by default (if you want to use your
Bram Moolenaarc236c162008-07-13 17:41:49 +0000851own 'formatoptions'): >
852 :let g:PHP_autoformatcomment = 0
853
854Else, 't' will be removed from the 'formatoptions' string and "qrowcb" will be
Bram Moolenaare6ae6222013-05-21 21:01:10 +0200855added, see |fo-table| for more information.
Bram Moolenaarc236c162008-07-13 17:41:49 +0000856-------------
857
Bram Moolenaarbcb98982014-05-01 14:08:19 +0200858 *PHP_outdentSLComments*
Bram Moolenaare6ae6222013-05-21 21:01:10 +0200859To add extra indentation to single-line comments: >
860 :let g:PHP_outdentSLComments = N
861
862With N being the number of 'shiftwidth' to add.
863
864Only single-line comments will be affected such as: >
865 # Comment
866 // Comment
867 /* Comment */
868-------------
869
Bram Moolenaarbcb98982014-05-01 14:08:19 +0200870 *PHP_default_indenting*
Bram Moolenaare6ae6222013-05-21 21:01:10 +0200871To add extra indentation to every PHP lines with N being the number of
Bram Moolenaarc236c162008-07-13 17:41:49 +0000872'shiftwidth' to add: >
873 :let g:PHP_default_indenting = N
874
875For example, with N = 1, this will give:
876>
877 <?php
878 if (!isset($History_lst_sel))
879 if (!isset($History_lst_sel))
880 if (!isset($History_lst_sel)) {
881 $History_lst_sel=0;
882 } else
883 $foo="bar";
884
885 $command_hist = TRUE;
886 ?>
Bram Moolenaare6ae6222013-05-21 21:01:10 +0200887(Notice the extra indentation between the PHP container markers and the code)
Bram Moolenaarc236c162008-07-13 17:41:49 +0000888-------------
889
Bram Moolenaarbcb98982014-05-01 14:08:19 +0200890 *PHP_outdentphpescape*
891To indent PHP escape tags as the surrounding non-PHP code (only affects the
892PHP escape tags): >
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000893 :let g:PHP_outdentphpescape = 0
Bram Moolenaar8408a9a2010-07-30 22:41:22 +0200894-------------
895
Bram Moolenaarbcb98982014-05-01 14:08:19 +0200896 *PHP_removeCRwhenUnix*
Bram Moolenaarc236c162008-07-13 17:41:49 +0000897To automatically remove '\r' characters when the 'fileformat' is set to Unix: >
898 :let g:PHP_removeCRwhenUnix = 1
899-------------
900
Bram Moolenaarbcb98982014-05-01 14:08:19 +0200901 *PHP_BracesAtCodeLevel*
Bram Moolenaarc236c162008-07-13 17:41:49 +0000902To indent braces at the same level than the code they contain: >
903 :let g:PHP_BracesAtCodeLevel = 1
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100904
Bram Moolenaarc236c162008-07-13 17:41:49 +0000905This will give the following result: >
906 if ($foo)
907 {
908 foo();
909 }
910Instead of: >
911 if ($foo)
912 {
913 foo();
914 }
915
916NOTE: Indenting will be a bit slower if this option is used because some
917 optimizations won't be available.
918-------------
919
Bram Moolenaar54775062019-07-31 21:07:14 +0200920 *PHP_vintage_case_default_indent*
Bram Moolenaarc236c162008-07-13 17:41:49 +0000921To indent 'case:' and 'default:' statements in switch() blocks: >
922 :let g:PHP_vintage_case_default_indent = 1
923
Bram Moolenaare6ae6222013-05-21 21:01:10 +0200924In PHP braces are not required inside 'case/default' blocks therefore 'case:'
925and 'default:' are indented at the same level than the 'switch()' to avoid
926meaningless indentation. You can use the above option to return to the
927traditional way.
Bram Moolenaar0b0f0992018-05-22 21:41:30 +0200928-------------
929
930 *PHP_noArrowMatching*
931By default the indent script will indent multi-line chained calls by matching
932the position of the '->': >
933
934 $user_name_very_long->name()
935 ->age()
936 ->info();
937
938You can revert to the classic way of indenting by setting this option to 1: >
939 :let g:PHP_noArrowMatching = 1
940
941You will obtain the following result: >
942
943 $user_name_very_long->name()
944 ->age()
945 ->info();
946
Bram Moolenaar54775062019-07-31 21:07:14 +0200947-------------
948
949 *PHP_IndentFunctionCallParameters*
950Extra indentation levels to add to parameters in multi-line function calls. >
951 let g:PHP_IndentFunctionCallParameters = 1
952
953Function call arguments will indent 1 extra level. For two-space indentation: >
954
955 function call_the_thing(
956 $with_this,
957 $and_that
958 ) {
959 $this->do_the_thing(
960 $with_this,
961 $and_that
962 );
963 }
964
965-------------
966
967 *PHP_IndentFunctionDeclarationParameters*
Bram Moolenaar2e693a82019-10-16 22:35:02 +0200968Extra indentation levels to add to arguments in multi-line function
969definitions. >
Bram Moolenaar54775062019-07-31 21:07:14 +0200970 let g:PHP_IndentFunctionDeclarationParameters = 1
971
Bram Moolenaar2e693a82019-10-16 22:35:02 +0200972Function arguments in declarations will indent 1 extra level. For two-space
973indentation: >
Bram Moolenaar54775062019-07-31 21:07:14 +0200974
975 function call_the_thing(
976 $with_this,
977 $and_that
978 ) {
979 $this->do_the_thing(
980 $with_this,
981 $and_that
982 );
983 }
Bram Moolenaarc236c162008-07-13 17:41:49 +0000984
985
Bram Moolenaarda2303d2005-08-30 21:55:26 +0000986PYTHON *ft-python-indent*
Bram Moolenaar05159a02005-02-26 23:04:13 +0000987
988The amount of indent can be set for the following situations. The examples
Bram Moolenaare37d50a2008-08-06 17:06:04 +0000989given are the defaults. Note that the variables are set to an expression, so
990that you can change the value of 'shiftwidth' later.
Bram Moolenaar05159a02005-02-26 23:04:13 +0000991
992Indent after an open paren: >
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +0100993 let g:pyindent_open_paren = 'shiftwidth() * 2'
Bram Moolenaar05159a02005-02-26 23:04:13 +0000994Indent after a nested paren: >
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +0100995 let g:pyindent_nested_paren = 'shiftwidth()'
Bram Moolenaar05159a02005-02-26 23:04:13 +0000996Indent for a continuation line: >
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +0100997 let g:pyindent_continue = 'shiftwidth() * 2'
Bram Moolenaar05159a02005-02-26 23:04:13 +0000998
Bram Moolenaare7b1ea02020-08-07 19:54:59 +0200999The method uses |searchpair()| to look back for unclosed parentheses. This
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001000can sometimes be slow, thus it timeouts after 150 msec. If you notice the
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02001001indenting isn't correct, you can set a larger timeout in msec: >
1002 let g:pyindent_searchpair_timeout = 500
1003
Bram Moolenaarf6b40102019-02-22 15:24:03 +01001004If looking back for unclosed parenthesis is still too slow, especially during
1005a copy-paste operation, or if you don't need indenting inside multi-line
1006parentheses, you can completely disable this feature: >
1007 let g:pyindent_disable_parentheses_indenting = 1
1008
Bram Moolenaar05159a02005-02-26 23:04:13 +00001009
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02001010R *ft-r-indent*
1011
1012Function arguments are aligned if they span for multiple lines. If you prefer
1013do not have the arguments of functions aligned, put in your |vimrc|:
1014>
1015 let r_indent_align_args = 0
1016<
1017All lines beginning with a comment character, #, get the same indentation
1018level of the normal R code. Users of Emacs/ESS may be used to have lines
1019beginning with a single # indented in the 40th column, ## indented as R code,
1020and ### not indented. If you prefer that lines beginning with comment
1021characters are aligned as they are by Emacs/ESS, put in your |vimrc|:
1022>
1023 let r_indent_ess_comments = 1
1024<
1025If you prefer that lines beginning with a single # are aligned at a column
1026different from the 40th one, you should set a new value to the variable
1027r_indent_comment_column, as in the example below:
1028>
1029 let r_indent_comment_column = 30
1030<
1031Any code after a line that ends with "<-" is indented. Emacs/ESS does not
1032indent the code if it is a top level function. If you prefer that the
1033Vim-R-plugin behaves like Emacs/ESS in this regard, put in your |vimrc|:
1034>
1035 let r_indent_ess_compatible = 1
1036<
1037Below is an example of indentation with and without this option enabled:
1038>
1039 ### r_indent_ess_compatible = 1 ### r_indent_ess_compatible = 0
1040 foo <- foo <-
1041 function(x) function(x)
1042 { {
1043 paste(x) paste(x)
1044 } }
1045<
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02001046The code will be indented after lines that match the pattern
1047`'\(&\||\|+\|-\|\*\|/\|=\|\~\|%\|->\)\s*$'`. If you want indentation after
1048lines that match a different pattern, you should set the appropriate value of
1049`r_indent_op_pattern` in your |vimrc|.
1050
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02001051
Bram Moolenaar7263a772007-05-10 17:35:54 +00001052SHELL *ft-sh-indent*
1053
1054The amount of indent applied under various circumstances in a shell file can
1055be configured by setting the following keys in the |Dictionary|
1056b:sh_indent_defaults to a specific amount or to a |Funcref| that references a
1057function that will return the amount desired:
1058
1059b:sh_indent_options['default'] Default amount of indent.
1060
1061b:sh_indent_options['continuation-line']
1062 Amount of indent to add to a continued line.
1063
1064b:sh_indent_options['case-labels']
1065 Amount of indent to add for case labels.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001066 (not actually implemented)
Bram Moolenaar7263a772007-05-10 17:35:54 +00001067
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001068b:sh_indent_options['case-statements']
Bram Moolenaar7263a772007-05-10 17:35:54 +00001069 Amount of indent to add for case statements.
1070
1071b:sh_indent_options['case-breaks']
1072 Amount of indent to add (or more likely
1073 remove) for case breaks.
1074
Bram Moolenaarda2303d2005-08-30 21:55:26 +00001075VERILOG *ft-verilog-indent*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001076
1077General block statements such as if, for, case, always, initial, function,
1078specify and begin, etc., are indented. The module block statements (first
1079level blocks) are not indented by default. you can turn on the indent with
1080setting a variable in the .vimrc as follows: >
1081
1082 let b:verilog_indent_modules = 1
1083
1084then the module blocks will be indented. To stop this, remove the variable: >
1085
1086 :unlet b:verilog_indent_modules
1087
1088To set the variable only for Verilog file. The following statements can be
1089used: >
1090
1091 au BufReadPost * if exists("b:current_syntax")
1092 au BufReadPost * if b:current_syntax == "verilog"
1093 au BufReadPost * let b:verilog_indent_modules = 1
1094 au BufReadPost * endif
1095 au BufReadPost * endif
1096
1097Furthermore, setting the variable b:verilog_indent_width to change the
1098indenting width (default is 'shiftwidth'): >
1099
1100 let b:verilog_indent_width = 4
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001101 let b:verilog_indent_width = shiftwidth() * 2
Bram Moolenaar071d4272004-06-13 20:20:40 +00001102
1103In addition, you can turn the verbose mode for debug issue: >
1104
1105 let b:verilog_indent_verbose = 1
1106
1107Make sure to do ":set cmdheight=2" first to allow the display of the message.
1108
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001109
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00001110VHDL *ft-vhdl-indent*
1111
1112Alignment of generic/port mapping statements are performed by default. This
1113causes the following alignment example: >
1114
1115 ENTITY sync IS
1116 PORT (
1117 clk : IN STD_LOGIC;
1118 reset_n : IN STD_LOGIC;
1119 data_input : IN STD_LOGIC;
1120 data_out : OUT STD_LOGIC
1121 );
1122 END ENTITY sync;
1123
1124To turn this off, add >
1125
1126 let g:vhdl_indent_genportmap = 0
1127
1128to the .vimrc file, which causes the previous alignment example to change: >
1129
1130 ENTITY sync IS
1131 PORT (
1132 clk : IN STD_LOGIC;
1133 reset_n : IN STD_LOGIC;
1134 data_input : IN STD_LOGIC;
1135 data_out : OUT STD_LOGIC
1136 );
1137 END ENTITY sync;
1138
1139----------------------------------------
1140
1141Alignment of right-hand side assignment "<=" statements are performed by
1142default. This causes the following alignment example: >
1143
1144 sig_out <= (bus_a(1) AND
1145 (sig_b OR sig_c)) OR
1146 (bus_a(0) AND sig_d);
1147
1148To turn this off, add >
1149
1150 let g:vhdl_indent_rhsassign = 0
1151
1152to the .vimrc file, which causes the previous alignment example to change: >
1153
1154 sig_out <= (bus_a(1) AND
1155 (sig_b OR sig_c)) OR
1156 (bus_a(0) AND sig_d);
1157
1158----------------------------------------
1159
1160Full-line comments (lines that begin with "--") are indented to be aligned with
1161the very previous line's comment, PROVIDED that a whitespace follows after
1162"--".
1163
1164For example: >
1165
1166 sig_a <= sig_b; -- start of a comment
1167 -- continuation of the comment
1168 -- more of the same comment
1169
1170While in Insert mode, after typing "-- " (note the space " "), hitting CTRL-F
1171will align the current "-- " with the previous line's "--".
1172
1173If the very previous line does not contain "--", THEN the full-line comment
1174will be aligned with the start of the next non-blank line that is NOT a
1175full-line comment.
1176
1177Indenting the following code: >
1178
1179 sig_c <= sig_d; -- comment 0
1180 -- comment 1
1181 -- comment 2
1182 --debug_code:
1183 --PROCESS(debug_in)
1184 --BEGIN
1185 -- FOR i IN 15 DOWNTO 0 LOOP
1186 -- debug_out(8*i+7 DOWNTO 8*i) <= debug_in(15-i);
1187 -- END LOOP;
1188 --END PROCESS debug_code;
1189
1190 -- comment 3
1191 sig_e <= sig_f; -- comment 4
1192 -- comment 5
1193
1194results in: >
1195
1196 sig_c <= sig_d; -- comment 0
1197 -- comment 1
1198 -- comment 2
1199 --debug_code:
1200 --PROCESS(debug_in)
1201 --BEGIN
1202 -- FOR i IN 15 DOWNTO 0 LOOP
1203 -- debug_out(8*i+7 DOWNTO 8*i) <= debug_in(15-i);
1204 -- END LOOP;
1205 --END PROCESS debug_code;
1206
1207 -- comment 3
1208 sig_e <= sig_f; -- comment 4
1209 -- comment 5
1210
1211Notice that "--debug_code:" does not align with "-- comment 2"
1212because there is no whitespace that follows after "--" in "--debug_code:".
1213
1214Given the dynamic nature of indenting comments, indenting should be done TWICE.
1215On the first pass, code will be indented. On the second pass, full-line
1216comments will be indented according to the correctly indented code.
1217
1218
Bram Moolenaarda2303d2005-08-30 21:55:26 +00001219VIM *ft-vim-indent*
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00001220 *g:vim_indent_cont*
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001221For indenting Vim scripts there is one variable that specifies the amount of
1222indent for a continuation line, a line that starts with a backslash: >
1223
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001224 :let g:vim_indent_cont = shiftwidth() * 3
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001225
1226Three times shiftwidth is the default value.
1227
1228
Bram Moolenaar91f84f62018-07-29 15:07:52 +02001229 vim:tw=78:ts=8:noet:ft=help:norl: