Mercurial > vim
annotate runtime/doc/indent.txt @ 15512:f0f06837a699
Update runtime files.
commit https://github.com/vim/vim/commit/d09091d4955c5f41de69928f2db85611ed54ed23
Author: Bram Moolenaar <Bram@vim.org>
Date: Thu Jan 17 16:07:22 2019 +0100
Update runtime files.
| author | Bram Moolenaar <Bram@vim.org> |
|---|---|
| date | Thu, 17 Jan 2019 16:15:08 +0100 |
| parents | f8b0f1e42f2c |
| children | 9cd11f6beb70 |
| rev | line source |
|---|---|
| 13963 | 1 *indent.txt* For Vim version 8.1. Last change: 2018 Apr 04 |
| 7 | 2 |
| 3 | |
| 4 VIM REFERENCE MANUAL by Bram Moolenaar | |
| 5 | |
| 6 | |
| 7 This file is about indenting C programs and other files. | |
| 8 | |
| 1620 | 9 1. Indenting C style programs |C-indenting| |
| 7 | 10 2. Indenting by expression |indent-expression| |
| 11 | |
| 12 ============================================================================== | |
| 1620 | 13 1. Indenting C style programs *C-indenting* |
| 7 | 14 |
| 1620 | 15 The basics for C style indenting are explained in section |30.2| of the user |
| 16 manual. | |
| 7 | 17 |
| 1620 | 18 Vim has options for automatically indenting C style program files. Many |
| 19 programming languages including Java and C++ follow very closely the | |
| 20 formatting conventions established with C. These options affect only the | |
| 21 indent and do not perform other formatting. There are additional options that | |
| 22 affect other kinds of formatting as well as indenting, see |format-comments|, | |
| 23 |fo-table|, |gq| and |formatting| for the main ones. | |
| 7 | 24 |
| 25 Note that this will not work when the |+smartindent| or |+cindent| features | |
| 26 have been disabled at compile time. | |
| 27 | |
| 1620 | 28 There are in fact four main methods available for indentation, each one |
| 29 overrides the previous if it is enabled, or non-empty for 'indentexpr': | |
| 7 | 30 '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|. | |
| 38 The rest of this section describes the 'cindent' option. | |
| 39 | |
| 40 Note that 'cindent' indenting does not work for every code scenario. Vim | |
| 829 | 41 is not a C compiler: it does not recognize all syntax. One requirement is |
| 42 that toplevel functions have a '{' in the first column. Otherwise they are | |
| 43 easily confused with declarations. | |
| 7 | 44 |
| 45 These four options control C program indenting: | |
| 46 '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. | |
| 50 | |
| 51 If 'lisp' is not on and 'equalprg' is empty, the "=" operator indents using | |
| 52 Vim's built-in algorithm rather than calling an external program. | |
| 53 | |
| 54 See |autocommand| for how to set the 'cindent' option automatically for C code | |
| 55 files and reset it for others. | |
| 56 | |
| 57 *cinkeys-format* *indentkeys-format* | |
| 58 The 'cinkeys' option is a string that controls Vim's indenting in response to | |
| 59 typing certain characters or commands in certain contexts. Note that this not | |
| 60 only triggers C-indenting. When 'indentexpr' is not empty 'indentkeys' is | |
| 61 used instead. The format of 'cinkeys' and 'indentkeys' is equal. | |
| 62 | |
| 63 The default is "0{,0},0),:,0#,!^F,o,O,e" which specifies that indenting occurs | |
| 64 as follows: | |
| 65 | |
| 66 "0{" if you type '{' as the first character in a line | |
| 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 ":" if you type ':' after a label or case statement | |
| 70 "0#" if you type '#' as the first character in a line | |
| 71 "!^F" if you type CTRL-F (which is not inserted) | |
| 72 "o" if you type a <CR> anywhere or use the "o" command (not in | |
| 73 insert mode!) | |
| 74 "O" if you use the "O" command (not in insert mode!) | |
| 75 "e" if you type the second 'e' for an "else" at the start of a | |
| 76 line | |
| 77 | |
| 818 | 78 Characters that can precede each key: *i_CTRL-F* |
| 7 | 79 ! When a '!' precedes the key, Vim will not insert the key but will |
| 80 instead reindent the current line. This allows you to define a | |
| 81 command key for reindenting the current line. CTRL-F is the default | |
| 82 key for this. Be careful if you define CTRL-I for this because CTRL-I | |
| 83 is the ASCII code for <Tab>. | |
| 84 * When a '*' precedes the key, Vim will reindent the line before | |
| 85 inserting the key. If 'cinkeys' contains "*<Return>", Vim reindents | |
| 86 the current line before opening a new line. | |
| 87 0 When a zero precedes the key (but appears after '!' or '*') Vim will | |
| 88 reindent the line only if the key is the first character you type in | |
| 89 the line. When used before "=" Vim will only reindent the line if | |
| 90 there is only white space before the word. | |
| 91 | |
| 92 When neither '!' nor '*' precedes the key, Vim reindents the line after you | |
| 93 type the key. So ';' sets the indentation of a line which includes the ';'. | |
| 94 | |
| 95 Special key names: | |
| 96 <> Angle brackets mean spelled-out names of keys. For example: "<Up>", | |
| 97 "<Ins>" (see |key-notation|). | |
| 98 ^ Letters preceded by a caret (^) are control characters. For example: | |
| 99 "^F" is CTRL-F. | |
| 100 o Reindent a line when you use the "o" command or when Vim opens a new | |
| 101 line below the current one (e.g., when you type <Enter> in insert | |
| 102 mode). | |
| 103 O Reindent a line when you use the "O" command. | |
| 104 e Reindent a line that starts with "else" when you type the second 'e'. | |
| 105 : Reindent a line when a ':' is typed which is after a label or case | |
| 106 statement. Don't reindent for a ":" in "class::method" for C++. To | |
| 107 Reindent for any ":", use "<:>". | |
| 108 =word Reindent when typing the last character of "word". "word" may | |
| 109 actually be part of another word. Thus "=end" would cause reindenting | |
| 110 when typing the "d" in "endif" or "endwhile". But not when typing | |
| 111 "bend". Also reindent when completion produces a word that starts | |
| 112 with "word". "0=word" reindents when there is only white space before | |
| 113 the word. | |
| 114 =~word Like =word, but ignore case. | |
| 115 | |
| 116 If you really want to reindent when you type 'o', 'O', 'e', '0', '<', '>', | |
| 117 '*', ':' or '!', use "<o>", "<O>", "<e>", "<0>", "<<>", "<>>", "<*>", "<:>" or | |
| 118 "<!>", respectively, for those keys. | |
| 119 | |
| 120 For an emacs-style indent mode where lines aren't indented every time you | |
| 1247 | 121 press <Enter> but only if you press <Tab>, I suggest: |
| 7 | 122 :set cinkeys=0{,0},:,0#,!<Tab>,!^F |
| 123 You might also want to switch off 'autoindent' then. | |
| 124 | |
| 125 Note: If you change the current line's indentation manually, Vim ignores the | |
| 126 cindent settings for that line. This prevents vim from reindenting after you | |
| 127 have changed the indent by typing <BS>, <Tab>, or <Space> in the indent or | |
| 128 used CTRL-T or CTRL-D. | |
| 129 | |
| 130 *cinoptions-values* | |
| 2857 | 131 The 'cinoptions' option sets how Vim performs indentation. The value after |
| 132 the option character can be one of these (N is any number): | |
| 133 N indent N spaces | |
| 134 -N indent N spaces to the left | |
| 3082 | 135 Ns N times 'shiftwidth' spaces |
| 136 -Ns N times 'shiftwidth' spaces to the left | |
| 2857 | 137 |
| 138 In the list below, | |
| 7 | 139 "N" represents a number of your choice (the number can be negative). When |
| 140 there is an 's' after the number, Vim multiplies the number by 'shiftwidth': | |
| 141 "1s" is 'shiftwidth', "2s" is two times 'shiftwidth', etc. You can use a | |
| 2857 | 142 decimal point, too: "-0.5s" is minus half a 'shiftwidth'. |
| 143 The examples below assume a 'shiftwidth' of 4. | |
| 144 *cino->* | |
| 7 | 145 >N Amount added for "normal" indent. Used after a line that should |
| 146 increase the indent (lines starting with "if", an opening brace, | |
| 147 etc.). (default 'shiftwidth'). | |
| 148 | |
| 149 cino= cino=>2 cino=>2s > | |
| 150 if (cond) if (cond) if (cond) | |
| 151 { { { | |
| 152 foo; foo; foo; | |
| 153 } } } | |
| 154 < | |
| 2857 | 155 *cino-e* |
| 7 | 156 eN Add N to the prevailing indent inside a set of braces if the |
| 157 opening brace at the End of the line (more precise: is not the | |
| 158 first character in a line). This is useful if you want a | |
| 159 different indent when the '{' is at the start of the line from | |
| 160 when '{' is at the end of the line. (default 0). | |
| 161 | |
| 162 cino= cino=e2 cino=e-2 > | |
| 163 if (cond) { if (cond) { if (cond) { | |
| 164 foo; foo; foo; | |
| 165 } } } | |
| 166 else else else | |
| 167 { { { | |
| 168 bar; bar; bar; | |
| 169 } } } | |
| 170 < | |
| 2857 | 171 *cino-n* |
| 7 | 172 nN Add N to the prevailing indent for a statement after an "if", |
| 173 "while", etc., if it is NOT inside a set of braces. This is | |
| 174 useful if you want a different indent when there is no '{' | |
| 175 before the statement from when there is a '{' before it. | |
| 176 (default 0). | |
| 177 | |
| 178 cino= cino=n2 cino=n-2 > | |
| 179 if (cond) if (cond) if (cond) | |
| 180 foo; foo; foo; | |
| 181 else else else | |
| 182 { { { | |
| 183 bar; bar; bar; | |
| 184 } } } | |
| 185 < | |
| 2857 | 186 *cino-f* |
| 7 | 187 fN Place the first opening brace of a function or other block in |
| 188 column N. This applies only for an opening brace that is not | |
| 189 inside other braces and is at the start of the line. What comes | |
| 190 after the brace is put relative to this brace. (default 0). | |
| 191 | |
| 192 cino= cino=f.5s cino=f1s > | |
| 193 func() func() func() | |
| 194 { { { | |
| 195 int foo; int foo; int foo; | |
| 196 < | |
| 2857 | 197 *cino-{* |
| 7 | 198 {N Place opening braces N characters from the prevailing indent. |
| 199 This applies only for opening braces that are inside other | |
| 200 braces. (default 0). | |
| 201 | |
| 202 cino= cino={.5s cino={1s > | |
| 203 if (cond) if (cond) if (cond) | |
| 204 { { { | |
| 205 foo; foo; foo; | |
| 206 < | |
| 2857 | 207 *cino-}* |
| 7 | 208 }N Place closing braces N characters from the matching opening |
| 209 brace. (default 0). | |
| 210 | |
| 211 cino= cino={2,}-0.5s cino=}2 > | |
| 212 if (cond) if (cond) if (cond) | |
| 213 { { { | |
| 214 foo; foo; foo; | |
| 215 } } } | |
| 216 < | |
| 2857 | 217 *cino-^* |
| 7 | 218 ^N Add N to the prevailing indent inside a set of braces if the |
| 219 opening brace is in column 0. This can specify a different | |
| 220 indent for whole of a function (some may like to set it to a | |
| 221 negative number). (default 0). | |
| 222 | |
| 223 cino= cino=^-2 cino=^-s > | |
| 224 func() func() func() | |
| 225 { { { | |
| 226 if (cond) if (cond) if (cond) | |
| 227 { { { | |
| 228 a = b; a = b; a = b; | |
| 229 } } } | |
| 230 } } } | |
| 231 < | |
| 2857 | 232 *cino-L* |
|
2328
15379284e55a
Add the 'L' item to 'cinoptions'. (Manuel Konig)
Bram Moolenaar <bram@vim.org>
parents:
2297
diff
changeset
|
233 LN Controls placement of jump labels. If N is negative, the label |
|
15379284e55a
Add the 'L' item to 'cinoptions'. (Manuel Konig)
Bram Moolenaar <bram@vim.org>
parents:
2297
diff
changeset
|
234 will be placed at column 1. If N is non-negative, the indent of |
|
15379284e55a
Add the 'L' item to 'cinoptions'. (Manuel Konig)
Bram Moolenaar <bram@vim.org>
parents:
2297
diff
changeset
|
235 the label will be the prevailing indent minus N. (default -1). |
|
15379284e55a
Add the 'L' item to 'cinoptions'. (Manuel Konig)
Bram Moolenaar <bram@vim.org>
parents:
2297
diff
changeset
|
236 |
|
15379284e55a
Add the 'L' item to 'cinoptions'. (Manuel Konig)
Bram Moolenaar <bram@vim.org>
parents:
2297
diff
changeset
|
237 cino= cino=L2 cino=Ls > |
|
15379284e55a
Add the 'L' item to 'cinoptions'. (Manuel Konig)
Bram Moolenaar <bram@vim.org>
parents:
2297
diff
changeset
|
238 func() func() func() |
|
15379284e55a
Add the 'L' item to 'cinoptions'. (Manuel Konig)
Bram Moolenaar <bram@vim.org>
parents:
2297
diff
changeset
|
239 { { { |
|
15379284e55a
Add the 'L' item to 'cinoptions'. (Manuel Konig)
Bram Moolenaar <bram@vim.org>
parents:
2297
diff
changeset
|
240 { { { |
|
15379284e55a
Add the 'L' item to 'cinoptions'. (Manuel Konig)
Bram Moolenaar <bram@vim.org>
parents:
2297
diff
changeset
|
241 stmt; stmt; stmt; |
|
15379284e55a
Add the 'L' item to 'cinoptions'. (Manuel Konig)
Bram Moolenaar <bram@vim.org>
parents:
2297
diff
changeset
|
242 LABEL: LABEL: LABEL: |
|
15379284e55a
Add the 'L' item to 'cinoptions'. (Manuel Konig)
Bram Moolenaar <bram@vim.org>
parents:
2297
diff
changeset
|
243 } } } |
|
15379284e55a
Add the 'L' item to 'cinoptions'. (Manuel Konig)
Bram Moolenaar <bram@vim.org>
parents:
2297
diff
changeset
|
244 } } } |
|
15379284e55a
Add the 'L' item to 'cinoptions'. (Manuel Konig)
Bram Moolenaar <bram@vim.org>
parents:
2297
diff
changeset
|
245 < |
| 2857 | 246 *cino-:* |
| 7 | 247 :N Place case labels N characters from the indent of the switch(). |
| 248 (default 'shiftwidth'). | |
| 249 | |
| 250 cino= cino=:0 > | |
| 251 switch (x) switch(x) | |
| 252 { { | |
| 253 case 1: case 1: | |
| 254 a = b; a = b; | |
| 255 default: default: | |
| 256 } } | |
| 257 < | |
| 2857 | 258 *cino-=* |
| 7 | 259 =N Place statements occurring after a case label N characters from |
| 260 the indent of the label. (default 'shiftwidth'). | |
| 261 | |
| 262 cino= cino==10 > | |
| 263 case 11: case 11: a = a + 1; | |
| 264 a = a + 1; b = b + 1; | |
| 265 < | |
| 2857 | 266 *cino-l* |
| 7 | 267 lN If N != 0 Vim will align with a case label instead of the |
| 268 statement after it in the same line. | |
| 269 | |
| 270 cino= cino=l1 > | |
| 271 switch (a) { switch (a) { | |
| 272 case 1: { case 1: { | |
| 273 break; break; | |
| 274 } } | |
| 275 < | |
| 2857 | 276 *cino-b* |
| 7 | 277 bN If N != 0 Vim will align a final "break" with the case label, |
| 236 | 278 so that case..break looks like a sort of block. (default: 0). |
| 2662 | 279 When using 1, consider adding "0=break" to 'cinkeys'. |
| 7 | 280 |
| 281 cino= cino=b1 > | |
| 282 switch (x) switch(x) | |
| 283 { { | |
| 284 case 1: case 1: | |
| 285 a = b; a = b; | |
| 286 break; break; | |
| 287 | |
| 288 default: default: | |
| 289 a = 0; a = 0; | |
| 290 break; break; | |
| 291 } } | |
| 292 < | |
| 2857 | 293 *cino-g* |
| 7 | 294 gN Place C++ scope declarations N characters from the indent of the |
| 295 block they are in. (default 'shiftwidth'). A scope declaration | |
| 296 can be "public:", "protected:" or "private:". | |
| 297 | |
| 298 cino= cino=g0 > | |
| 299 { { | |
| 300 public: public: | |
| 301 a = b; a = b; | |
| 302 private: private: | |
| 303 } } | |
| 304 < | |
| 2857 | 305 *cino-h* |
| 7 | 306 hN Place statements occurring after a C++ scope declaration N |
| 307 characters from the indent of the label. (default | |
| 308 'shiftwidth'). | |
| 309 | |
| 310 cino= cino=h10 > | |
| 311 public: public: a = a + 1; | |
| 312 a = a + 1; b = b + 1; | |
| 313 < | |
| 2857 | 314 *cino-N* |
| 315 NN Indent inside C++ namespace N characters extra compared to a | |
| 316 normal block. (default 0). | |
| 317 | |
| 318 cino= cino=N-s > | |
| 319 namespace { namespace { | |
| 320 void function(); void function(); | |
| 321 } } | |
| 322 | |
| 323 namespace my namespace my | |
| 324 { { | |
| 325 void function(); void function(); | |
| 326 } } | |
| 327 < | |
|
11087
242e0617aa51
patch 8.0.0431: 'cinoptions' cannot set indent for extern block
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
328 *cino-E* |
|
242e0617aa51
patch 8.0.0431: 'cinoptions' cannot set indent for extern block
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
329 EN Indent inside C++ linkage specifications (extern "C" or |
|
242e0617aa51
patch 8.0.0431: 'cinoptions' cannot set indent for extern block
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
330 extern "C++") N characters extra compared to a normal block. |
|
242e0617aa51
patch 8.0.0431: 'cinoptions' cannot set indent for extern block
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
331 (default 0). |
|
242e0617aa51
patch 8.0.0431: 'cinoptions' cannot set indent for extern block
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
332 |
|
242e0617aa51
patch 8.0.0431: 'cinoptions' cannot set indent for extern block
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
333 cino= cino=E-s > |
|
242e0617aa51
patch 8.0.0431: 'cinoptions' cannot set indent for extern block
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
334 extern "C" { extern "C" { |
|
242e0617aa51
patch 8.0.0431: 'cinoptions' cannot set indent for extern block
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
335 void function(); void function(); |
|
242e0617aa51
patch 8.0.0431: 'cinoptions' cannot set indent for extern block
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
336 } } |
|
242e0617aa51
patch 8.0.0431: 'cinoptions' cannot set indent for extern block
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
337 |
|
242e0617aa51
patch 8.0.0431: 'cinoptions' cannot set indent for extern block
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
338 extern "C" extern "C" |
|
242e0617aa51
patch 8.0.0431: 'cinoptions' cannot set indent for extern block
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
339 { { |
|
242e0617aa51
patch 8.0.0431: 'cinoptions' cannot set indent for extern block
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
340 void function(); void function(); |
|
242e0617aa51
patch 8.0.0431: 'cinoptions' cannot set indent for extern block
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
341 } } |
|
242e0617aa51
patch 8.0.0431: 'cinoptions' cannot set indent for extern block
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
342 < |
| 2857 | 343 *cino-p* |
| 7 | 344 pN Parameter declarations for K&R-style function declarations will |
| 345 be indented N characters from the margin. (default | |
| 346 'shiftwidth'). | |
| 347 | |
| 348 cino= cino=p0 cino=p2s > | |
| 349 func(a, b) func(a, b) func(a, b) | |
| 350 int a; int a; int a; | |
| 351 char b; char b; char b; | |
| 352 < | |
| 2857 | 353 *cino-t* |
| 7 | 354 tN Indent a function return type declaration N characters from the |
| 355 margin. (default 'shiftwidth'). | |
| 356 | |
| 357 cino= cino=t0 cino=t7 > | |
| 358 int int int | |
| 359 func() func() func() | |
| 360 < | |
| 2857 | 361 *cino-i* |
| 843 | 362 iN Indent C++ base class declarations and constructor |
| 7 | 363 initializations, if they start in a new line (otherwise they |
| 364 are aligned at the right side of the ':'). | |
| 365 (default 'shiftwidth'). | |
| 366 | |
| 367 cino= cino=i0 > | |
| 368 class MyClass : class MyClass : | |
| 369 public BaseClass public BaseClass | |
| 370 {} {} | |
| 371 MyClass::MyClass() : MyClass::MyClass() : | |
| 372 BaseClass(3) BaseClass(3) | |
| 373 {} {} | |
| 374 < | |
| 2857 | 375 *cino-+* |
| 2725 | 376 +N Indent a continuation line (a line that spills onto the next) |
| 377 inside a function N additional characters. (default | |
| 378 'shiftwidth'). | |
| 379 Outside of a function, when the previous line ended in a | |
| 380 backslash, the 2 * N is used. | |
| 7 | 381 |
| 382 cino= cino=+10 > | |
| 383 a = b + 9 * a = b + 9 * | |
| 384 c; c; | |
| 385 < | |
| 2857 | 386 *cino-c* |
| 7 | 387 cN Indent comment lines after the comment opener, when there is no |
| 388 other text with which to align, N characters from the comment | |
| 389 opener. (default 3). See also |format-comments|. | |
| 390 | |
| 391 cino= cino=c5 > | |
| 392 /* /* | |
| 393 text. text. | |
| 394 */ */ | |
| 395 < | |
| 2857 | 396 *cino-C* |
| 7 | 397 CN When N is non-zero, indent comment lines by the amount specified |
| 398 with the c flag above even if there is other text behind the | |
| 399 comment opener. (default 0). | |
| 400 | |
| 401 cino=c0 cino=c0,C1 > | |
| 402 /******** /******** | |
| 403 text. text. | |
| 404 ********/ ********/ | |
| 405 < (Example uses ":set comments& comments-=s1:/* comments^=s0:/*") | |
| 406 | |
| 2857 | 407 *cino-/* |
| 236 | 408 /N Indent comment lines N characters extra. (default 0). |
| 7 | 409 cino= cino=/4 > |
| 410 a = b; a = b; | |
| 411 /* comment */ /* comment */ | |
| 412 c = d; c = d; | |
| 413 < | |
| 2857 | 414 *cino-(* |
| 7 | 415 (N When in unclosed parentheses, indent N characters from the line |
| 416 with the unclosed parentheses. Add a 'shiftwidth' for every | |
| 13589 | 417 extra unclosed parentheses. When N is 0 or the unclosed |
| 418 parentheses is the first non-white character in its line, line | |
| 419 up with the next non-white character after the unclosed | |
| 420 parentheses. (default 'shiftwidth' * 2). | |
| 7 | 421 |
| 422 cino= cino=(0 > | |
| 423 if (c1 && (c2 || if (c1 && (c2 || | |
| 424 c3)) c3)) | |
| 425 foo; foo; | |
| 426 if (c1 && if (c1 && | |
| 427 (c2 || c3)) (c2 || c3)) | |
| 428 { { | |
| 429 < | |
| 2857 | 430 *cino-u* |
| 13589 | 431 uN Same as (N, but for one nesting level deeper. |
| 432 (default 'shiftwidth'). | |
| 7 | 433 |
| 434 cino= cino=u2 > | |
| 435 if (c123456789 if (c123456789 | |
| 436 && (c22345 && (c22345 | |
| 437 || c3)) || c3)) | |
| 438 < | |
| 2857 | 439 *cino-U* |
| 7 | 440 UN When N is non-zero, do not ignore the indenting specified by |
| 441 ( or u in case that the unclosed parentheses is the first | |
| 442 non-white character in its line. (default 0). | |
| 443 | |
| 444 cino= or cino=(s cino=(s,U1 > | |
| 445 c = c1 && c = c1 && | |
| 446 ( ( | |
| 447 c2 || c2 || | |
| 448 c3 c3 | |
| 449 ) && c4; ) && c4; | |
| 450 < | |
| 3082 | 451 *cino-w* |
| 7 | 452 wN When in unclosed parentheses and N is non-zero and either |
| 453 using "(0" or "u0", respectively, or using "U0" and the unclosed | |
| 454 parentheses is the first non-white character in its line, line | |
| 455 up with the character immediately after the unclosed parentheses | |
| 456 rather than the first non-white character. (default 0). | |
| 457 | |
| 458 cino=(0 cino=(0,w1 > | |
| 459 if ( c1 if ( c1 | |
| 460 && ( c2 && ( c2 | |
| 461 || c3)) || c3)) | |
| 462 foo; foo; | |
| 463 < | |
| 2857 | 464 *cino-W* |
| 7 | 465 WN When in unclosed parentheses and N is non-zero and either |
| 466 using "(0" or "u0", respectively and the unclosed parentheses is | |
| 467 the last non-white character in its line and it is not the | |
| 468 closing parentheses, indent the following line N characters | |
| 469 relative to the outer context (i.e. start of the line or the | |
| 236 | 470 next unclosed parentheses). (default: 0). |
| 7 | 471 |
| 472 cino=(0 cino=(0,W4 > | |
| 473 a_long_line( a_long_line( | |
| 474 argument, argument, | |
| 475 argument); argument); | |
| 476 a_short_line(argument, a_short_line(argument, | |
| 477 argument); argument); | |
| 478 < | |
| 3454 | 479 *cino-k* |
| 480 kN When in unclosed parentheses which follow "if", "for" or | |
| 481 "while" and N is non-zero, overrides the behaviour defined by | |
| 482 "(N": causes the indent to be N characters relative to the outer | |
| 483 context (i.e. the line where "if", "for" or "while" is). Has | |
| 484 no effect on deeper levels of nesting. Affects flags like "wN" | |
| 485 only for the "if", "for" and "while" conditions. If 0, defaults | |
| 486 to behaviour defined by the "(N" flag. (default: 0). | |
| 487 | |
| 488 cino=(0 cino=(0,ks > | |
| 489 if (condition1 if (condition1 | |
| 490 && condition2) && condition2) | |
| 491 action(); action(); | |
| 492 function(argument1 function(argument1 | |
| 493 && argument2); && argument2); | |
| 494 < | |
| 2857 | 495 *cino-m* |
| 7 | 496 mN When N is non-zero, line up a line starting with a closing |
| 497 parentheses with the first character of the line with the | |
| 498 matching opening parentheses. (default 0). | |
| 499 | |
| 500 cino=(s cino=(s,m1 > | |
| 501 c = c1 && ( c = c1 && ( | |
| 502 c2 || c2 || | |
| 503 c3 c3 | |
| 504 ) && c4; ) && c4; | |
| 505 if ( if ( | |
| 506 c1 && c2 c1 && c2 | |
| 507 ) ) | |
| 508 foo; foo; | |
| 509 < | |
| 2857 | 510 *cino-M* |
| 829 | 511 MN When N is non-zero, line up a line starting with a closing |
| 512 parentheses with the first character of the previous line. | |
| 513 (default 0). | |
| 514 | |
| 515 cino= cino=M1 > | |
| 516 if (cond1 && if (cond1 && | |
| 856 | 517 cond2 cond2 |
| 518 ) ) | |
| 829 | 519 < |
| 2857 | 520 *java-cinoptions* *java-indenting* *cino-j* |
| 2965 | 521 jN Indent Java anonymous classes correctly. Also works well for |
| 522 Javascript. The value 'N' is currently unused but must be | |
| 523 non-zero (e.g. 'j1'). 'j1' will indent for example the | |
| 524 following code snippet correctly: > | |
| 7 | 525 |
| 526 object.add(new ChangeListener() { | |
| 527 public void stateChanged(ChangeEvent e) { | |
| 528 do_something(); | |
| 529 } | |
| 530 }); | |
| 531 < | |
| 2857 | 532 *javascript-cinoptions* *javascript-indenting* *cino-J* |
|
2297
5ffe000a9ecf
Improve Javascript indenting. Add "J" flag to 'cino'. (Hari Kumar G)
Bram Moolenaar <bram@vim.org>
parents:
2278
diff
changeset
|
533 JN Indent JavaScript object declarations correctly by not confusing |
|
5ffe000a9ecf
Improve Javascript indenting. Add "J" flag to 'cino'. (Hari Kumar G)
Bram Moolenaar <bram@vim.org>
parents:
2278
diff
changeset
|
534 them with labels. The value 'N' is currently unused but must be |
| 2965 | 535 non-zero (e.g. 'J1'). If you enable this you probably also want |
| 536 to set |cino-j|. > | |
|
2297
5ffe000a9ecf
Improve Javascript indenting. Add "J" flag to 'cino'. (Hari Kumar G)
Bram Moolenaar <bram@vim.org>
parents:
2278
diff
changeset
|
537 |
|
5ffe000a9ecf
Improve Javascript indenting. Add "J" flag to 'cino'. (Hari Kumar G)
Bram Moolenaar <bram@vim.org>
parents:
2278
diff
changeset
|
538 var bar = { |
|
5ffe000a9ecf
Improve Javascript indenting. Add "J" flag to 'cino'. (Hari Kumar G)
Bram Moolenaar <bram@vim.org>
parents:
2278
diff
changeset
|
539 foo: { |
|
5ffe000a9ecf
Improve Javascript indenting. Add "J" flag to 'cino'. (Hari Kumar G)
Bram Moolenaar <bram@vim.org>
parents:
2278
diff
changeset
|
540 that: this, |
|
5ffe000a9ecf
Improve Javascript indenting. Add "J" flag to 'cino'. (Hari Kumar G)
Bram Moolenaar <bram@vim.org>
parents:
2278
diff
changeset
|
541 some: ok, |
|
5ffe000a9ecf
Improve Javascript indenting. Add "J" flag to 'cino'. (Hari Kumar G)
Bram Moolenaar <bram@vim.org>
parents:
2278
diff
changeset
|
542 }, |
|
5ffe000a9ecf
Improve Javascript indenting. Add "J" flag to 'cino'. (Hari Kumar G)
Bram Moolenaar <bram@vim.org>
parents:
2278
diff
changeset
|
543 "bar":{ |
|
5ffe000a9ecf
Improve Javascript indenting. Add "J" flag to 'cino'. (Hari Kumar G)
Bram Moolenaar <bram@vim.org>
parents:
2278
diff
changeset
|
544 a : 2, |
|
5ffe000a9ecf
Improve Javascript indenting. Add "J" flag to 'cino'. (Hari Kumar G)
Bram Moolenaar <bram@vim.org>
parents:
2278
diff
changeset
|
545 b: "123abc", |
|
5ffe000a9ecf
Improve Javascript indenting. Add "J" flag to 'cino'. (Hari Kumar G)
Bram Moolenaar <bram@vim.org>
parents:
2278
diff
changeset
|
546 x: 4, |
|
5ffe000a9ecf
Improve Javascript indenting. Add "J" flag to 'cino'. (Hari Kumar G)
Bram Moolenaar <bram@vim.org>
parents:
2278
diff
changeset
|
547 "y": 5 |
|
5ffe000a9ecf
Improve Javascript indenting. Add "J" flag to 'cino'. (Hari Kumar G)
Bram Moolenaar <bram@vim.org>
parents:
2278
diff
changeset
|
548 } |
|
5ffe000a9ecf
Improve Javascript indenting. Add "J" flag to 'cino'. (Hari Kumar G)
Bram Moolenaar <bram@vim.org>
parents:
2278
diff
changeset
|
549 } |
|
5ffe000a9ecf
Improve Javascript indenting. Add "J" flag to 'cino'. (Hari Kumar G)
Bram Moolenaar <bram@vim.org>
parents:
2278
diff
changeset
|
550 < |
| 2857 | 551 *cino-)* |
| 7 | 552 )N Vim searches for unclosed parentheses at most N lines away. |
| 553 This limits the time needed to search for parentheses. (default | |
| 554 20 lines). | |
| 555 | |
| 2857 | 556 *cino-star* |
| 7 | 557 *N Vim searches for unclosed comments at most N lines away. This |
| 558 limits the time needed to search for the start of a comment. | |
| 3830 | 559 If your /* */ comments stop indenting after N lines this is the |
| 2788 | 560 value you will want to change. |
| 2072 | 561 (default 70 lines). |
| 7 | 562 |
| 2857 | 563 *cino-#* |
| 5438 | 564 #N When N is non-zero recognize shell/Perl comments starting with |
| 565 '#', do not recognize preprocessor lines; allow right-shifting | |
| 566 lines that start with "#". | |
| 567 When N is zero (default): don't recognize '#' comments, do | |
| 568 recognize preprocessor lines; right-shifting lines that start | |
| 569 with "#" does not work. | |
| 1096 | 570 |
| 7 | 571 |
| 572 The defaults, spelled out in full, are: | |
|
11087
242e0617aa51
patch 8.0.0431: 'cinoptions' cannot set indent for extern block
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
573 cinoptions=>s,e0,n0,f0,{0,}0,^0,L-1,:s,=s,l0,b0,gs,hs,N0,E0,ps,ts,is,+s, |
| 3454 | 574 c3,C0,/0,(2s,us,U0,w0,W0,k0,m0,j0,J0,)20,*70,#0 |
| 7 | 575 |
| 576 Vim puts a line in column 1 if: | |
| 5438 | 577 - It starts with '#' (preprocessor directives), if 'cinkeys' contains '#0'. |
| 7 | 578 - It starts with a label (a keyword followed by ':', other than "case" and |
|
2328
15379284e55a
Add the 'L' item to 'cinoptions'. (Manuel Konig)
Bram Moolenaar <bram@vim.org>
parents:
2297
diff
changeset
|
579 "default") and 'cinoptions' does not contain an 'L' entry with a positive |
|
15379284e55a
Add the 'L' item to 'cinoptions'. (Manuel Konig)
Bram Moolenaar <bram@vim.org>
parents:
2297
diff
changeset
|
580 value. |
| 7 | 581 - Any combination of indentations causes the line to have less than 0 |
| 582 indentation. | |
| 583 | |
| 584 ============================================================================== | |
| 585 2. Indenting by expression *indent-expression* | |
| 586 | |
| 587 The basics for using flexible indenting are explained in section |30.3| of the | |
| 588 user manual. | |
| 589 | |
| 590 If you want to write your own indent file, it must set the 'indentexpr' | |
| 14999 | 591 option. Setting the 'indentkeys' option is often useful. |
| 592 See the $VIMRUNTIME/indent/README.txt file for hints. | |
| 593 See the $VIMRUNTIME/indent directory for examples. | |
| 7 | 594 |
| 595 | |
| 596 REMARKS ABOUT SPECIFIC INDENT FILES ~ | |
| 597 | |
| 598 | |
| 4098 | 599 CLOJURE *ft-clojure-indent* *clojure-indent* |
| 600 | |
| 601 Clojure indentation differs somewhat from traditional Lisps, due in part to | |
| 602 the use of square and curly brackets, and otherwise by community convention. | |
|
5362
ab1508486b12
Update runtime files. Add support for J.
Bram Moolenaar <bram@vim.org>
parents:
5294
diff
changeset
|
603 These conventions are not universally followed, so the Clojure indent script |
|
ab1508486b12
Update runtime files. Add support for J.
Bram Moolenaar <bram@vim.org>
parents:
5294
diff
changeset
|
604 offers a few configurable options, listed below. |
| 4098 | 605 |
| 15033 | 606 If the current vim does not include |searchpairpos()|, the indent script falls |
| 4098 | 607 back to normal 'lisp' indenting, and the following options are ignored. |
| 608 | |
| 609 *g:clojure_maxlines* | |
| 610 | |
| 15033 | 611 Set maximum scan distance of |searchpairpos()|. Larger values trade |
| 612 performance for correctness when dealing with very long forms. A value of 0 | |
| 613 will scan without limits. | |
| 4098 | 614 > |
| 615 " Default | |
| 616 let g:clojure_maxlines = 100 | |
| 617 < | |
| 618 *g:clojure_fuzzy_indent* | |
| 619 *g:clojure_fuzzy_indent_patterns* | |
| 620 *g:clojure_fuzzy_indent_blacklist* | |
| 621 | |
| 622 The 'lispwords' option is a list of comma-separated words that mark special | |
| 623 forms whose subforms must be indented with two spaces. | |
| 624 | |
| 625 For example: | |
| 626 > | |
| 627 (defn bad [] | |
| 628 "Incorrect indentation") | |
| 629 | |
| 630 (defn good [] | |
| 631 "Correct indentation") | |
| 632 < | |
| 633 If you would like to specify 'lispwords' with a |pattern| instead, you can use | |
| 634 the fuzzy indent feature: | |
| 635 > | |
| 636 " Default | |
| 637 let g:clojure_fuzzy_indent = 1 | |
| 638 let g:clojure_fuzzy_indent_patterns = ['^with', '^def', '^let'] | |
| 639 let g:clojure_fuzzy_indent_blacklist = | |
| 640 \ ['-fn$', '\v^with-%(meta|out-str|loading-context)$'] | |
| 641 | |
| 642 " Legacy comma-delimited string version; the list format above is | |
| 643 " recommended. Note that patterns are implicitly anchored with ^ and $ | |
| 644 let g:clojure_fuzzy_indent_patterns = 'with.*,def.*,let.*' | |
| 645 < | |
| 646 |g:clojure_fuzzy_indent_patterns| and |g:clojure_fuzzy_indent_blacklist| are | |
| 647 |Lists| of patterns that will be matched against the unquoted, unqualified | |
| 648 symbol at the head of a list. This means that a pattern like "^foo" will match | |
| 649 all these candidates: "foobar", "my.ns/foobar", and "#'foobar". | |
| 650 | |
| 651 Each candidate word is tested for special treatment in this order: | |
| 652 | |
| 653 1. Return true if word is literally in 'lispwords' | |
| 654 2. Return false if word matches a pattern in | |
| 655 |g:clojure_fuzzy_indent_blacklist| | |
| 656 3. Return true if word matches a pattern in | |
| 657 |g:clojure_fuzzy_indent_patterns| | |
| 658 4. Return false and indent normally otherwise | |
| 659 | |
| 660 *g:clojure_special_indent_words* | |
| 661 | |
| 662 Some forms in Clojure are indented so that every subform is indented only two | |
| 663 spaces, regardless of 'lispwords'. If you have a custom construct that should | |
| 664 be indented in this idiosyncratic fashion, you can add your symbols to the | |
| 665 default list below. | |
| 666 > | |
| 667 " Default | |
| 668 let g:clojure_special_indent_words = | |
| 669 \ 'deftype,defrecord,reify,proxy,extend-type,extend-protocol,letfn' | |
| 670 < | |
| 671 *g:clojure_align_multiline_strings* | |
| 672 | |
| 673 Align subsequent lines in multiline strings to the column after the opening | |
| 674 quote, instead of the same column. | |
| 675 | |
| 676 For example: | |
| 677 > | |
| 678 (def default | |
| 679 "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do | |
| 680 eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut | |
| 681 enim ad minim veniam, quis nostrud exercitation ullamco laboris | |
| 682 nisi ut aliquip ex ea commodo consequat.") | |
| 683 | |
| 684 (def aligned | |
| 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 This option is off by default. | |
| 691 > | |
| 692 " Default | |
| 693 let g:clojure_align_multiline_strings = 0 | |
| 694 < | |
| 5577 | 695 *g:clojure_align_subforms* |
| 696 | |
| 697 By default, parenthesized compound forms that look like function calls and | |
| 698 whose head subform is on its own line have subsequent subforms indented by | |
| 699 two spaces relative to the opening paren: | |
| 700 > | |
| 701 (foo | |
| 702 bar | |
| 703 baz) | |
| 704 < | |
| 705 Setting this option changes this behavior so that all subforms are aligned to | |
| 5763 | 706 the same column, emulating the default behavior of clojure-mode.el: |
| 5577 | 707 > |
| 708 (foo | |
| 709 bar | |
| 710 baz) | |
| 711 < | |
| 712 This option is off by default. | |
| 713 > | |
| 714 " Default | |
| 715 let g:clojure_align_subforms = 0 | |
| 716 < | |
| 4098 | 717 |
| 501 | 718 FORTRAN *ft-fortran-indent* |
| 7 | 719 |
| 2908 | 720 Block if, select case, where, and forall constructs are indented. So are |
| 721 type, interface, associate, block, and enum constructs. The indenting of | |
| 722 subroutines, functions, modules, and program blocks is optional. Comments, | |
| 723 labelled statements and continuation lines are indented if the Fortran is in | |
| 724 free source form, whereas they are not indented if the Fortran is in fixed | |
| 725 source form because of the left margin requirements. Hence manual indent | |
| 726 corrections will be necessary for labelled statements and continuation lines | |
| 727 when fixed source form is being used. For further discussion of the method | |
| 728 used for the detection of source format see |ft-fortran-syntax|. | |
| 7 | 729 |
| 730 Do loops ~ | |
| 236 | 731 All do loops are left unindented by default. Do loops can be unstructured in |
| 7 | 732 Fortran with (possibly multiple) loops ending on a labelled executable |
| 236 | 733 statement of almost arbitrary type. Correct indentation requires |
| 734 compiler-quality parsing. Old code with do loops ending on labelled statements | |
| 7 | 735 of arbitrary type can be indented with elaborate programs such as Tidy |
| 236 | 736 (http://www.unb.ca/chem/ajit/f_tidy.htm). Structured do/continue loops are |
| 7 | 737 also left unindented because continue statements are also used for purposes |
| 236 | 738 other than ending a do loop. Programs such as Tidy can convert structured |
| 739 do/continue loops to the do/enddo form. Do loops of the do/enddo variety can | |
| 740 be indented. If you use only structured loops of the do/enddo form, you should | |
| 7 | 741 declare this by setting the fortran_do_enddo variable in your .vimrc as |
| 742 follows > | |
| 743 | |
| 744 let fortran_do_enddo=1 | |
| 745 | |
| 236 | 746 in which case do loops will be indented. If all your loops are of do/enddo |
| 7 | 747 type only in, say, .f90 files, then you should set a buffer flag with an |
| 748 autocommand such as > | |
| 749 | |
| 750 au! BufRead,BufNewFile *.f90 let b:fortran_do_enddo=1 | |
| 751 | |
| 752 to get do loops indented in .f90 files and left alone in Fortran files with | |
| 753 other extensions such as .for. | |
| 754 | |
| 2908 | 755 Program units ~ |
| 756 The indenting of program units (subroutines, functions, modules, and program | |
| 757 blocks) is enabled by default but can be suppressed if a lighter, screen-width | |
| 758 preserving indent style is desired. To suppress the indenting of program | |
| 759 units for all fortran files set the global fortran_indent_less variable in | |
| 760 your .vimrc as follows > | |
| 761 | |
| 762 let fortran_indent_less=1 | |
| 763 | |
| 764 A finer level of suppression can be achieved by setting the corresponding | |
| 765 buffer-local variable as follows > | |
| 766 | |
| 767 let b:fortran_indent_less=1 | |
| 768 | |
| 7 | 769 |
| 4869 | 770 HTML *ft-html-indent* *html-indent* *html-indenting* |
| 771 | |
| 772 This is about variables you can set in your vimrc to customize HTML indenting. | |
| 773 | |
| 774 You can set the indent for the first line after <script> and <style> | |
| 775 "blocktags" (default "zero"): > | |
| 776 | |
| 777 :let g:html_indent_script1 = "inc" | |
| 778 :let g:html_indent_style1 = "inc" | |
| 779 < | |
| 780 VALUE MEANING ~ | |
| 781 "zero" zero indent | |
| 782 "auto" auto indent (same indent as the blocktag) | |
| 783 "inc" auto indent + one indent step | |
| 784 | |
| 785 Many tags increase the indent for what follows per default (see "Add Indent | |
| 4911 | 786 Tags" in the script). You can add further tags with: > |
| 4869 | 787 |
| 788 :let g:html_indent_inctags = "html,body,head,tbody" | |
| 789 | |
| 790 You can also remove such tags with: > | |
| 791 | |
| 792 :let g:html_indent_autotags = "th,td,tr,tfoot,thead" | |
| 793 | |
| 794 Default value is empty for both variables. Note: the initial "inctags" are | |
| 795 only defined once per Vim session. | |
| 796 | |
| 797 User variables are only read when the script is sourced. To enable your | |
| 4911 | 798 changes during a session, without reloading the HTML file, you can manually |
| 4869 | 799 do: > |
| 800 | |
| 801 :call HtmlIndent_CheckUserSettings() | |
| 802 | |
| 803 Detail: | |
| 804 Calculation of indent inside "blocktags" with "alien" content: | |
| 805 BLOCKTAG INDENT EXPR WHEN APPLICABLE ~ | |
| 4911 | 806 <script> : {customizable} if first line of block |
| 807 : cindent(v:lnum) if attributes empty or contain "java" | |
| 808 : -1 else (vbscript, tcl, ...) | |
| 809 <style> : {customizable} if first line of block | |
| 810 : GetCSSIndent() else | |
| 4869 | 811 <!-- --> : -1 |
| 812 | |
| 813 | |
| 1668 | 814 PHP *ft-php-indent* *php-indent* *php-indenting* |
| 815 | |
| 816 NOTE: PHP files will be indented correctly only if PHP |syntax| is active. | |
| 817 | |
| 818 If you are editing a file in Unix 'fileformat' and '\r' characters are present | |
| 819 before new lines, indentation won't proceed correctly ; you have to remove | |
| 820 those useless characters first with a command like: > | |
| 821 | |
| 822 :%s /\r$//g | |
| 823 | |
| 824 Or, you can simply |:let| the variable PHP_removeCRwhenUnix to 1 and the | |
|
4502
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4098
diff
changeset
|
825 script will silently remove them when Vim loads a PHP file (at each |BufRead|). |
| 1668 | 826 |
| 827 OPTIONS: ~ | |
| 828 | |
| 829 PHP indenting can be altered in several ways by modifying the values of some | |
|
4502
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4098
diff
changeset
|
830 global variables: |
| 1668 | 831 |
| 5862 | 832 *php-comment* *PHP_autoformatcomment* |
|
9407
619a98a67f67
commit https://github.com/vim/vim/commit/e18dbe865d190e74fb5d43ac8bc6ac22507d0223
Christian Brabandt <cb@256bit.org>
parents:
6421
diff
changeset
|
833 To not enable auto-formatting of comments by default (if you want to use your |
| 1668 | 834 own 'formatoptions'): > |
| 835 :let g:PHP_autoformatcomment = 0 | |
| 836 | |
| 837 Else, 't' will be removed from the 'formatoptions' string and "qrowcb" will be | |
|
4502
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4098
diff
changeset
|
838 added, see |fo-table| for more information. |
| 1668 | 839 ------------- |
| 840 | |
| 5862 | 841 *PHP_outdentSLComments* |
|
4502
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4098
diff
changeset
|
842 To add extra indentation to single-line comments: > |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4098
diff
changeset
|
843 :let g:PHP_outdentSLComments = N |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4098
diff
changeset
|
844 |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4098
diff
changeset
|
845 With N being the number of 'shiftwidth' to add. |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4098
diff
changeset
|
846 |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4098
diff
changeset
|
847 Only single-line comments will be affected such as: > |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4098
diff
changeset
|
848 # Comment |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4098
diff
changeset
|
849 // Comment |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4098
diff
changeset
|
850 /* Comment */ |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4098
diff
changeset
|
851 ------------- |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4098
diff
changeset
|
852 |
| 5862 | 853 *PHP_default_indenting* |
|
4502
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4098
diff
changeset
|
854 To add extra indentation to every PHP lines with N being the number of |
| 1668 | 855 'shiftwidth' to add: > |
| 856 :let g:PHP_default_indenting = N | |
| 857 | |
| 858 For example, with N = 1, this will give: | |
| 859 > | |
| 860 <?php | |
| 861 if (!isset($History_lst_sel)) | |
| 862 if (!isset($History_lst_sel)) | |
| 863 if (!isset($History_lst_sel)) { | |
| 864 $History_lst_sel=0; | |
| 865 } else | |
| 866 $foo="bar"; | |
| 867 | |
| 868 $command_hist = TRUE; | |
| 869 ?> | |
|
4502
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4098
diff
changeset
|
870 (Notice the extra indentation between the PHP container markers and the code) |
| 1668 | 871 ------------- |
| 872 | |
| 5862 | 873 *PHP_outdentphpescape* |
| 874 To indent PHP escape tags as the surrounding non-PHP code (only affects the | |
| 875 PHP escape tags): > | |
| 876 :let g:PHP_outdentphpescape = 0 | |
| 2442 | 877 ------------- |
| 878 | |
| 5862 | 879 *PHP_removeCRwhenUnix* |
| 1668 | 880 To automatically remove '\r' characters when the 'fileformat' is set to Unix: > |
| 881 :let g:PHP_removeCRwhenUnix = 1 | |
| 882 ------------- | |
| 883 | |
| 5862 | 884 *PHP_BracesAtCodeLevel* |
| 1668 | 885 To indent braces at the same level than the code they contain: > |
| 886 :let g:PHP_BracesAtCodeLevel = 1 | |
| 887 | |
| 888 This will give the following result: > | |
| 889 if ($foo) | |
| 890 { | |
| 891 foo(); | |
| 892 } | |
| 893 Instead of: > | |
| 894 if ($foo) | |
| 895 { | |
| 896 foo(); | |
| 897 } | |
| 898 | |
| 899 NOTE: Indenting will be a bit slower if this option is used because some | |
| 900 optimizations won't be available. | |
| 901 ------------- | |
| 902 | |
| 5862 | 903 *PHP_vintage_case_default_indent* |
| 1668 | 904 To indent 'case:' and 'default:' statements in switch() blocks: > |
| 905 :let g:PHP_vintage_case_default_indent = 1 | |
| 906 | |
|
4502
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4098
diff
changeset
|
907 In PHP braces are not required inside 'case/default' blocks therefore 'case:' |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4098
diff
changeset
|
908 and 'default:' are indented at the same level than the 'switch()' to avoid |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4098
diff
changeset
|
909 meaningless indentation. You can use the above option to return to the |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4098
diff
changeset
|
910 traditional way. |
| 14006 | 911 ------------- |
| 912 | |
| 913 *PHP_noArrowMatching* | |
| 914 By default the indent script will indent multi-line chained calls by matching | |
| 915 the position of the '->': > | |
| 916 | |
| 917 $user_name_very_long->name() | |
| 918 ->age() | |
| 919 ->info(); | |
| 920 | |
| 921 You can revert to the classic way of indenting by setting this option to 1: > | |
| 922 :let g:PHP_noArrowMatching = 1 | |
| 923 | |
| 924 You will obtain the following result: > | |
| 925 | |
| 926 $user_name_very_long->name() | |
| 927 ->age() | |
| 928 ->info(); | |
| 929 | |
| 1668 | 930 |
| 931 | |
| 501 | 932 PYTHON *ft-python-indent* |
| 170 | 933 |
| 934 The amount of indent can be set for the following situations. The examples | |
| 1698 | 935 given are the defaults. Note that the variables are set to an expression, so |
| 936 that you can change the value of 'shiftwidth' later. | |
| 170 | 937 |
| 938 Indent after an open paren: > | |
| 15033 | 939 let g:pyindent_open_paren = 'shiftwidth() * 2' |
| 170 | 940 Indent after a nested paren: > |
| 15033 | 941 let g:pyindent_nested_paren = 'shiftwidth()' |
| 170 | 942 Indent for a continuation line: > |
| 15033 | 943 let g:pyindent_continue = 'shiftwidth() * 2' |
| 170 | 944 |
| 15033 | 945 The method uses |searchpair()| to look back for unclosed parenthesis. This |
| 946 can sometimes be slow, thus it timeouts after 150 msec. If you notice the | |
| 14945 | 947 indenting isn't correct, you can set a larger timeout in msec: > |
| 948 let g:pyindent_searchpair_timeout = 500 | |
| 949 | |
| 170 | 950 |
| 3082 | 951 R *ft-r-indent* |
| 952 | |
| 953 Function arguments are aligned if they span for multiple lines. If you prefer | |
| 954 do not have the arguments of functions aligned, put in your |vimrc|: | |
| 955 > | |
| 956 let r_indent_align_args = 0 | |
| 957 < | |
| 958 All lines beginning with a comment character, #, get the same indentation | |
| 959 level of the normal R code. Users of Emacs/ESS may be used to have lines | |
| 960 beginning with a single # indented in the 40th column, ## indented as R code, | |
| 961 and ### not indented. If you prefer that lines beginning with comment | |
| 962 characters are aligned as they are by Emacs/ESS, put in your |vimrc|: | |
| 963 > | |
| 964 let r_indent_ess_comments = 1 | |
| 965 < | |
| 966 If you prefer that lines beginning with a single # are aligned at a column | |
| 967 different from the 40th one, you should set a new value to the variable | |
| 968 r_indent_comment_column, as in the example below: | |
| 969 > | |
| 970 let r_indent_comment_column = 30 | |
| 971 < | |
| 972 Any code after a line that ends with "<-" is indented. Emacs/ESS does not | |
| 973 indent the code if it is a top level function. If you prefer that the | |
| 974 Vim-R-plugin behaves like Emacs/ESS in this regard, put in your |vimrc|: | |
| 975 > | |
| 976 let r_indent_ess_compatible = 1 | |
| 977 < | |
| 978 Below is an example of indentation with and without this option enabled: | |
| 979 > | |
| 980 ### r_indent_ess_compatible = 1 ### r_indent_ess_compatible = 0 | |
| 981 foo <- foo <- | |
| 982 function(x) function(x) | |
| 983 { { | |
| 984 paste(x) paste(x) | |
| 985 } } | |
| 986 < | |
| 14637 | 987 The code will be indented after lines that match the pattern |
| 988 `'\(&\||\|+\|-\|\*\|/\|=\|\~\|%\|->\)\s*$'`. If you want indentation after | |
| 989 lines that match a different pattern, you should set the appropriate value of | |
| 990 `r_indent_op_pattern` in your |vimrc|. | |
| 991 | |
| 3082 | 992 |
| 1201 | 993 SHELL *ft-sh-indent* |
| 994 | |
| 995 The amount of indent applied under various circumstances in a shell file can | |
| 996 be configured by setting the following keys in the |Dictionary| | |
| 997 b:sh_indent_defaults to a specific amount or to a |Funcref| that references a | |
| 998 function that will return the amount desired: | |
| 999 | |
| 1000 b:sh_indent_options['default'] Default amount of indent. | |
| 1001 | |
| 1002 b:sh_indent_options['continuation-line'] | |
| 1003 Amount of indent to add to a continued line. | |
| 1004 | |
| 1005 b:sh_indent_options['case-labels'] | |
| 1006 Amount of indent to add for case labels. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1007 (not actually implemented) |
| 1201 | 1008 |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1009 b:sh_indent_options['case-statements'] |
| 1201 | 1010 Amount of indent to add for case statements. |
| 1011 | |
| 1012 b:sh_indent_options['case-breaks'] | |
| 1013 Amount of indent to add (or more likely | |
| 1014 remove) for case breaks. | |
| 1015 | |
| 501 | 1016 VERILOG *ft-verilog-indent* |
| 7 | 1017 |
| 1018 General block statements such as if, for, case, always, initial, function, | |
| 1019 specify and begin, etc., are indented. The module block statements (first | |
| 1020 level blocks) are not indented by default. you can turn on the indent with | |
| 1021 setting a variable in the .vimrc as follows: > | |
| 1022 | |
| 1023 let b:verilog_indent_modules = 1 | |
| 1024 | |
| 1025 then the module blocks will be indented. To stop this, remove the variable: > | |
| 1026 | |
| 1027 :unlet b:verilog_indent_modules | |
| 1028 | |
| 1029 To set the variable only for Verilog file. The following statements can be | |
| 1030 used: > | |
| 1031 | |
| 1032 au BufReadPost * if exists("b:current_syntax") | |
| 1033 au BufReadPost * if b:current_syntax == "verilog" | |
| 1034 au BufReadPost * let b:verilog_indent_modules = 1 | |
| 1035 au BufReadPost * endif | |
| 1036 au BufReadPost * endif | |
| 1037 | |
| 1038 Furthermore, setting the variable b:verilog_indent_width to change the | |
| 1039 indenting width (default is 'shiftwidth'): > | |
| 1040 | |
| 1041 let b:verilog_indent_width = 4 | |
| 15033 | 1042 let b:verilog_indent_width = shiftwidth() * 2 |
| 7 | 1043 |
| 1044 In addition, you can turn the verbose mode for debug issue: > | |
| 1045 | |
| 1046 let b:verilog_indent_verbose = 1 | |
| 1047 | |
| 1048 Make sure to do ":set cmdheight=2" first to allow the display of the message. | |
| 1049 | |
| 22 | 1050 |
| 1620 | 1051 VHDL *ft-vhdl-indent* |
| 1052 | |
| 1053 Alignment of generic/port mapping statements are performed by default. This | |
| 1054 causes the following alignment example: > | |
| 1055 | |
| 1056 ENTITY sync IS | |
| 1057 PORT ( | |
| 1058 clk : IN STD_LOGIC; | |
| 1059 reset_n : IN STD_LOGIC; | |
| 1060 data_input : IN STD_LOGIC; | |
| 1061 data_out : OUT STD_LOGIC | |
| 1062 ); | |
| 1063 END ENTITY sync; | |
| 1064 | |
| 1065 To turn this off, add > | |
| 1066 | |
| 1067 let g:vhdl_indent_genportmap = 0 | |
| 1068 | |
| 1069 to the .vimrc file, which causes the previous alignment example to change: > | |
| 1070 | |
| 1071 ENTITY sync IS | |
| 1072 PORT ( | |
| 1073 clk : IN STD_LOGIC; | |
| 1074 reset_n : IN STD_LOGIC; | |
| 1075 data_input : IN STD_LOGIC; | |
| 1076 data_out : OUT STD_LOGIC | |
| 1077 ); | |
| 1078 END ENTITY sync; | |
| 1079 | |
| 1080 ---------------------------------------- | |
| 1081 | |
| 1082 Alignment of right-hand side assignment "<=" statements are performed by | |
| 1083 default. This causes the following alignment example: > | |
| 1084 | |
| 1085 sig_out <= (bus_a(1) AND | |
| 1086 (sig_b OR sig_c)) OR | |
| 1087 (bus_a(0) AND sig_d); | |
| 1088 | |
| 1089 To turn this off, add > | |
| 1090 | |
| 1091 let g:vhdl_indent_rhsassign = 0 | |
| 1092 | |
| 1093 to the .vimrc file, which causes the previous alignment example to change: > | |
| 1094 | |
| 1095 sig_out <= (bus_a(1) AND | |
| 1096 (sig_b OR sig_c)) OR | |
| 1097 (bus_a(0) AND sig_d); | |
| 1098 | |
| 1099 ---------------------------------------- | |
| 1100 | |
| 1101 Full-line comments (lines that begin with "--") are indented to be aligned with | |
| 1102 the very previous line's comment, PROVIDED that a whitespace follows after | |
| 1103 "--". | |
| 1104 | |
| 1105 For example: > | |
| 1106 | |
| 1107 sig_a <= sig_b; -- start of a comment | |
| 1108 -- continuation of the comment | |
| 1109 -- more of the same comment | |
| 1110 | |
| 1111 While in Insert mode, after typing "-- " (note the space " "), hitting CTRL-F | |
| 1112 will align the current "-- " with the previous line's "--". | |
| 1113 | |
| 1114 If the very previous line does not contain "--", THEN the full-line comment | |
| 1115 will be aligned with the start of the next non-blank line that is NOT a | |
| 1116 full-line comment. | |
| 1117 | |
| 1118 Indenting the following code: > | |
| 1119 | |
| 1120 sig_c <= sig_d; -- comment 0 | |
| 1121 -- comment 1 | |
| 1122 -- comment 2 | |
| 1123 --debug_code: | |
| 1124 --PROCESS(debug_in) | |
| 1125 --BEGIN | |
| 1126 -- FOR i IN 15 DOWNTO 0 LOOP | |
| 1127 -- debug_out(8*i+7 DOWNTO 8*i) <= debug_in(15-i); | |
| 1128 -- END LOOP; | |
| 1129 --END PROCESS debug_code; | |
| 1130 | |
| 1131 -- comment 3 | |
| 1132 sig_e <= sig_f; -- comment 4 | |
| 1133 -- comment 5 | |
| 1134 | |
| 1135 results in: > | |
| 1136 | |
| 1137 sig_c <= sig_d; -- comment 0 | |
| 1138 -- comment 1 | |
| 1139 -- comment 2 | |
| 1140 --debug_code: | |
| 1141 --PROCESS(debug_in) | |
| 1142 --BEGIN | |
| 1143 -- FOR i IN 15 DOWNTO 0 LOOP | |
| 1144 -- debug_out(8*i+7 DOWNTO 8*i) <= debug_in(15-i); | |
| 1145 -- END LOOP; | |
| 1146 --END PROCESS debug_code; | |
| 1147 | |
| 1148 -- comment 3 | |
| 1149 sig_e <= sig_f; -- comment 4 | |
| 1150 -- comment 5 | |
| 1151 | |
| 1152 Notice that "--debug_code:" does not align with "-- comment 2" | |
| 1153 because there is no whitespace that follows after "--" in "--debug_code:". | |
| 1154 | |
| 1155 Given the dynamic nature of indenting comments, indenting should be done TWICE. | |
| 1156 On the first pass, code will be indented. On the second pass, full-line | |
| 1157 comments will be indented according to the correctly indented code. | |
| 1158 | |
| 1159 | |
| 501 | 1160 VIM *ft-vim-indent* |
| 22 | 1161 |
| 1162 For indenting Vim scripts there is one variable that specifies the amount of | |
| 1163 indent for a continuation line, a line that starts with a backslash: > | |
| 1164 | |
| 15033 | 1165 :let g:vim_indent_cont = shiftwidth() * 3 |
| 22 | 1166 |
| 1167 Three times shiftwidth is the default value. | |
| 1168 | |
| 1169 | |
| 14421 | 1170 vim:tw=78:ts=8:noet:ft=help:norl: |