uncrustify.cfg 38 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930
  1. # Uncrustify 0.44
  2. #
  3. # General options
  4. #
  5. # The type of line endings
  6. newlines = lf # auto/lf/crlf/cr
  7. # The original size of tabs in the input
  8. input_tab_size = 4 # number
  9. # The size of tabs in the output (only used if align_with_tabs=true)
  10. output_tab_size = 4 # number
  11. # The ascii value of the string escape char, usually 92 (\) or 94 (^). (Pawn)
  12. string_escape_char = 92 # number
  13. # Alternate string escape char for Pawn. Only works right before the quote char.
  14. string_escape_char2 = 0 # number
  15. #
  16. # Indenting
  17. #
  18. # The number of columns to indent per level.
  19. # Usually 2, 3, 4, or 8.
  20. indent_columns = 4 # number
  21. # How to use tabs when indenting code
  22. # 0=spaces only
  23. # 1=indent with tabs, align with spaces
  24. # 2=indent and align with tabs
  25. indent_with_tabs = 2 # number
  26. # Whether to indent strings broken by '\' so that they line up
  27. indent_align_string = true # false/true
  28. # The number of spaces to indent multi-line XML strings.
  29. # Requires indent_align_string=True
  30. indent_xml_string = 0 # number
  31. # Spaces to indent '{' from level
  32. indent_brace = 0 # number
  33. # Whether braces are indented to the body level
  34. indent_braces = false # false/true
  35. # Disabled indenting function braces if indent_braces is true
  36. indent_braces_no_func = false # false/true
  37. # Indent based on the size of the brace parent, ie 'if' => 3 spaces, 'for' => 4 spaces, etc.
  38. indent_brace_parent = false # false/true
  39. # Whether the 'namespace' body is indented
  40. indent_namespace = false # false/true
  41. # Whether the 'class' body is indented
  42. indent_class = false # false/true
  43. # Whether to indent the stuff after a leading class colon
  44. indent_class_colon = false # false/true
  45. # True: indent continued function call parameters one indent level
  46. # False: align parameters under the open paren
  47. indent_func_call_param = false # false/true
  48. # Same as indent_func_call_param, but for function defs
  49. indent_func_def_param = false # false/true
  50. # Same as indent_func_call_param, but for function protos
  51. indent_func_proto_param = false # false/true
  52. # Same as indent_func_call_param, but for class declarations
  53. indent_func_class_param = false # false/true
  54. # Same as indent_func_call_param, but for class variable constructors
  55. indent_func_ctor_var_param = false # false/true
  56. # Double the indent for indent_func_xxx_param options
  57. indent_func_param_double = false # false/true
  58. # The number of spaces to indent a continued '->' or '.'
  59. # Usually set to 0, 1, or indent_columns.
  60. indent_member = 0 # number
  61. # Spaces to indent single line ('//') comments on lines before code
  62. indent_sing_line_comments = 0 # number
  63. # Spaces to indent 'case' from 'switch'
  64. # Usually 0 or indent_columns.
  65. indent_switch_case = 0 # number
  66. # Spaces to shift the 'case' line, without affecting any other lines
  67. # Usually 0.
  68. indent_case_shift = 0 # number
  69. # Spaces to indent '{' from 'case'.
  70. # By default, the brace will appear under the 'c' in case.
  71. # Usually set to 0 or indent_columns.
  72. indent_case_brace = 0 # number
  73. # Whether to indent comments found in first column
  74. indent_col1_comment = false # false/true
  75. # How to indent goto labels
  76. # >0 : absolute column where 1 is the leftmost column
  77. # <=0 : subtract from brace indent
  78. indent_label = 1 # number
  79. # Same as indent_label, but for access specifiers that are followed by a colon
  80. indent_access_spec = 1 # number
  81. # If an open paren is followed by a newline, indent the next line so that it lines up after the open paren (not recommended)
  82. indent_paren_nl = false # false/true
  83. # Controls the indent of a close paren after a newline.
  84. # 0: Indent to body level
  85. # 1: Align under the open paren
  86. # 2: Indent to the brace level
  87. indent_paren_close = 0 # number
  88. # Controls the indent of a comma when inside a paren.If TRUE, aligns under the open paren
  89. indent_comma_paren = false # false/true
  90. # Controls the indent of a BOOL operator when inside a paren.If TRUE, aligns under the open paren
  91. indent_bool_paren = false # false/true
  92. # If an open square is followed by a newline, indent the next line so that it lines up after the open square (not recommended)
  93. indent_square_nl = false # false/true
  94. # Don't change the relative indent of ESQL/C 'EXEC SQL' bodies
  95. indent_preserve_sql = false # false/true
  96. #
  97. # Spacing options
  98. #
  99. # Add or remove space around arithmetic operator '+', '-', '/', '*', etc
  100. sp_arith = add # ignore/add/remove/force
  101. # Add or remove space around assignment operator '=', '+=', etc
  102. sp_assign = add # ignore/add/remove/force
  103. # Add or remove space around boolean operators '&&' and '||'
  104. sp_bool = add # ignore/add/remove/force
  105. # Add or remove space around compare operator '<', '>', '==', etc
  106. sp_compare = add # ignore/add/remove/force
  107. # Add or remove space inside '(' and ')'
  108. sp_inside_paren = add # ignore/add/remove/force
  109. # Add or remove space between nested parens
  110. sp_paren_paren = add # ignore/add/remove/force
  111. # Whether to balance spaces inside nested parens
  112. sp_balance_nested_parens = false # false/true
  113. # Add or remove space between ')' and '{'
  114. sp_paren_brace = add # ignore/add/remove/force
  115. # Add or remove space before pointer star '*'
  116. sp_before_ptr_star = ignore # ignore/add/remove/force
  117. # Add or remove space between pointer stars '*'
  118. sp_between_ptr_star = ignore # ignore/add/remove/force
  119. # Add or remove space after pointer star '*', if followed by a word.
  120. sp_after_ptr_star = ignore # ignore/add/remove/force
  121. # Add or remove space before reference sign '&'
  122. sp_before_byref = ignore # ignore/add/remove/force
  123. # Add or remove space after reference sign '&', if followed by a word.
  124. sp_after_byref = ignore # ignore/add/remove/force
  125. # Add or remove space before '<>'
  126. sp_before_angle = ignore # ignore/add/remove/force
  127. # Add or remove space after '<>'
  128. sp_after_angle = ignore # ignore/add/remove/force
  129. # Add or remove space between '<>' and '(' as found in 'new List<byte>();'
  130. sp_angle_paren = ignore # ignore/add/remove/force
  131. # Add or remove space between '<>' and a word as in 'List<byte> m;'
  132. sp_angle_word = ignore # ignore/add/remove/force
  133. # Add or remove space before '(' of 'if', 'for', 'switch', and 'while'
  134. sp_before_sparen = add # ignore/add/remove/force
  135. # Add or remove space inside if-condition '(' and ')'
  136. sp_inside_sparen = add # ignore/add/remove/force
  137. # Add or remove space after ')' of 'if', 'for', 'switch', and 'while'
  138. sp_after_sparen = add # ignore/add/remove/force
  139. # Add or remove space between ')' and '{' of 'if', 'for', 'switch', and 'while'
  140. sp_sparen_brace = add # ignore/add/remove/force
  141. # Add or remove space before empty statement ';' on 'if', 'for' and 'while'
  142. sp_special_semi = ignore # ignore/add/remove/force
  143. # Add or remove space before ';'
  144. sp_before_semi = ignore # ignore/add/remove/force
  145. # Add or remove space before ';' in non-empty 'for' statements
  146. sp_before_semi_for = ignore # ignore/add/remove/force
  147. # Add or remove space before a semicolon of an empty part of a for statment.
  148. sp_before_semi_for_empty = ignore # ignore/add/remove/force
  149. # Add or remove space after the final semicolon of an empty part of a for statment: for ( ; ; <here> ).
  150. sp_after_semi_for_empty = ignore # ignore/add/remove/force
  151. # Add or remove space before '[' (except '[]')
  152. sp_before_square = ignore # ignore/add/remove/force
  153. # Add or remove space before '[]'
  154. sp_before_squares = ignore # ignore/add/remove/force
  155. # Add or remove space inside '[' and ']'
  156. sp_inside_square = ignore # ignore/add/remove/force
  157. # Add or remove space after ','
  158. sp_after_comma = ignore # ignore/add/remove/force
  159. # Add or remove space before ','
  160. sp_before_comma = remove # ignore/add/remove/force
  161. # Add or remove space between 'operator' and operator sign
  162. sp_after_operator = ignore # ignore/add/remove/force
  163. # Add or remove space after cast
  164. sp_after_cast = ignore # ignore/add/remove/force
  165. # Add or remove spaces inside cast parens
  166. sp_inside_paren_cast = ignore # ignore/add/remove/force
  167. # Add or remove space between 'sizeof' and '('
  168. sp_sizeof_paren = remove # ignore/add/remove/force
  169. # Add or remove space after the tag keyword (Pawn)
  170. sp_after_tag = ignore # ignore/add/remove/force
  171. # Add or remove space inside enum '{' and '}'
  172. sp_inside_braces_enum = ignore # ignore/add/remove/force
  173. # Add or remove space inside struct/union '{' and '}'
  174. sp_inside_braces_struct = ignore # ignore/add/remove/force
  175. # Add or remove space inside '{' and '}'
  176. sp_inside_braces = ignore # ignore/add/remove/force
  177. # Add or remove space inside '<' and '>'
  178. sp_inside_angle = ignore # ignore/add/remove/force
  179. # Add or remove space between return type and function name
  180. # A minimum of 1 is forced except for pointer return types.
  181. sp_type_func = ignore # ignore/add/remove/force
  182. # Add or remove space between function name and '(' on function declaration
  183. sp_func_proto_paren = remove # ignore/add/remove/force
  184. # Add or remove space between function name and '(' on function definition
  185. sp_func_def_paren = remove # ignore/add/remove/force
  186. # Add or remove space inside empty function '()'
  187. sp_inside_fparens = remove # ignore/add/remove/force
  188. # Add or remove space inside function '(' and ')'
  189. sp_inside_fparen = add # ignore/add/remove/force
  190. # Add or remove space between ']' and '(' when part of a function call.
  191. sp_square_fparen = ignore # ignore/add/remove/force
  192. # Add or remove space between ')' and '{' of function
  193. sp_fparen_brace = add # ignore/add/remove/force
  194. # Add or remove space between function name and '(' on function calls
  195. sp_func_call_paren = remove # ignore/add/remove/force
  196. # Add or remove space between a constructor/destructor and the open paren
  197. sp_func_class_paren = ignore # ignore/add/remove/force
  198. # Add or remove space between 'return' and '('
  199. sp_return_paren = ignore # ignore/add/remove/force
  200. # Add or remove space between '__attribute__' and '('
  201. sp_attribute_paren = ignore # ignore/add/remove/force
  202. # Add or remove space between macro and value
  203. sp_macro = ignore # ignore/add/remove/force
  204. # Add or remove space between macro function ')' and value
  205. sp_macro_func = ignore # ignore/add/remove/force
  206. # Add or remove space between 'else' and '{' if on the same line
  207. sp_else_brace = add # ignore/add/remove/force
  208. # Add or remove space between '}' and 'else' if on the same line
  209. sp_brace_else = add # ignore/add/remove/force
  210. # Add or remove space between 'catch' and '{' if on the same line
  211. sp_catch_brace = ignore # ignore/add/remove/force
  212. # Add or remove space between '}' and 'catch' if on the same line
  213. sp_brace_catch = ignore # ignore/add/remove/force
  214. # Add or remove space between 'finally' and '{' if on the same line
  215. sp_finally_brace = ignore # ignore/add/remove/force
  216. # Add or remove space between '}' and 'finally' if on the same line
  217. sp_brace_finally = ignore # ignore/add/remove/force
  218. # Add or remove space between 'try' and '{' if on the same line
  219. sp_try_brace = ignore # ignore/add/remove/force
  220. # Add or remove space between get/set and '{' if on the same line
  221. sp_getset_brace = ignore # ignore/add/remove/force
  222. # Add or remove space before the '::' operator
  223. sp_before_dc = ignore # ignore/add/remove/force
  224. # Add or remove space after the '::' operator
  225. sp_after_dc = ignore # ignore/add/remove/force
  226. # Add or remove around the D named array initializer ':' operator
  227. sp_d_array_colon = ignore # ignore/add/remove/force
  228. # Add or remove space after the '!' (not) operator.
  229. sp_not = remove # ignore/add/remove/force
  230. # Add or remove space after the '~' (invert) operator.
  231. sp_inv = remove # ignore/add/remove/force
  232. # Add or remove space after the '&' (address-of) operator.
  233. # This does not affect the spacing after a '&' that is part of a type.
  234. sp_addr = remove # ignore/add/remove/force
  235. # Add or remove space around the '.' or '->' operators
  236. sp_member = remove # ignore/add/remove/force
  237. # Add or remove space after the '*' (dereference) operator.
  238. # This does not affect the spacing after a '*' that is part of a type.
  239. sp_deref = remove # ignore/add/remove/force
  240. # Add or remove space after '+' or '-', as in 'x = -5' or 'y = +7'
  241. sp_sign = remove # ignore/add/remove/force
  242. # Add or remove space before or after '++' and '--', as in '(--x)' or 'y++;'
  243. sp_incdec = remove # ignore/add/remove/force
  244. # Add or remove space after the scope '+' or '-', as in '-(void) foo;' or '+(int) bar;'
  245. sp_after_oc_scope = ignore # ignore/add/remove/force
  246. # Add or remove space after the colon in message specs
  247. # '-(int) f: (int) x;' vs '+(int) f : (int) x;'
  248. sp_before_oc_colon = ignore # ignore/add/remove/force
  249. # Add or remove space after the (type) in message specs
  250. # '-(int) f: (int) x;' vs '+(int)f : (int)x;'
  251. sp_after_oc_type = ignore # ignore/add/remove/force
  252. #
  253. # Code alignment (not left column spaces/tabs)
  254. #
  255. # Whether to keep non-indenting tabs
  256. align_keep_tabs = false # false/true
  257. # Whether to use tabs for alinging
  258. align_with_tabs = true # false/true
  259. # Whether to bump out to the next tab when aligning
  260. align_on_tabstop = false # false/true
  261. # Whether to left-align numbers
  262. align_number_left = false # false/true
  263. # Align variable definitions in prototypes and functions
  264. align_func_params = false # false/true
  265. # The span for aligning variable definitions (0=don't align)
  266. align_var_def_span = 0 # number
  267. # How to align the star in variable definitions.
  268. # 0=Part of the type
  269. # 1=Part of the variable
  270. # 2=Dangling
  271. align_var_def_star_style = 0 # number
  272. # How to align the '&' in variable definitions.
  273. # 0=Part of the type
  274. # 1=Part of the variable
  275. # 2=Dangling
  276. align_var_def_amp_style = 0 # number
  277. # The threshold for aligning variable definitions (0=no limit)
  278. align_var_def_thresh = 0 # number
  279. # Whether to align the colon in struct bit fields
  280. align_var_def_colon = false # false/true
  281. # Whether to align inline struct/enum/union variable definitions
  282. align_var_def_inline = false # false/true
  283. # The span for aligning on '=' in assignments (0=don't align)
  284. align_assign_span = 0 # number
  285. # The threshold for aligning on '=' in assignments (0=no limit)
  286. align_assign_thresh = 0 # number
  287. # The span for aligning on '=' in enums (0=don't align)
  288. align_enum_equ_span = 0 # number
  289. # The threshold for aligning on '=' in enums (0=no limit)
  290. align_enum_equ_thresh = 0 # number
  291. # The span for aligning struct/union (0=don't align)
  292. align_var_struct_span = 0 # number
  293. # The threshold for aligning struct/union member definitions (0=no limit)
  294. align_var_struct_thresh = 0 # number
  295. # The span for aligning struct initializer values (0=don't align)
  296. align_struct_init_span = 0 # number
  297. # The minimum space between the type and the synonym of a typedef
  298. align_typedef_gap = 0 # number
  299. # The span for aligning single-line typedefs (0=don't align)
  300. align_typedef_span = 0 # number
  301. # How to align typedef'd functions with other typedefs
  302. # 0: Don't mix them at all
  303. # 1: align the open paren with the types
  304. # 2: align the function type name with the other type names
  305. align_typedef_func = 0 # number
  306. # Controls the positioning of the '*' in typedefs. Just try it.
  307. # 0: Align on typdef type, ignore '*'
  308. # 1: The '*' is part of type name: typedef int *pint;
  309. # 2: The '*' is part of the type, but dangling: typedef int *pint;
  310. align_typedef_star_style = 0 # number
  311. # Controls the positioning of the '&' in typedefs. Just try it.
  312. # 0: Align on typdef type, ignore '&'
  313. # 1: The '&' is part of type name: typedef int &pint;
  314. # 2: The '&' is part of the type, but dangling: typedef int &pint;
  315. align_typedef_amp_style = 0 # number
  316. # The span for aligning comments that end lines (0=don't align)
  317. align_right_cmt_span = 0 # number
  318. # If aligning comments, mix with comments after '}' and #endif with less than 3 spaces before the comment
  319. align_right_cmt_mix = false # false/true
  320. # The span for aligning function prototypes (0=don't align)
  321. align_func_proto_span = 0 # number
  322. # The span for aligning function prototypes (0=don't align)
  323. align_oc_msg_spec_span = 0 # number
  324. # Whether to align macros wrapped with a backslash and a newline.
  325. # This will not work right if the macro contains a multi-line comment.
  326. align_nl_cont = false # false/true
  327. # The minimum space between label and value of a preprocessor define
  328. align_pp_define_gap = 0 # number
  329. # The span for aligning on '#define' bodies (0=don't align)
  330. align_pp_define_span = 0 # number
  331. #
  332. # Newline adding and removing options
  333. #
  334. # Whether to collapse empty blocks between '{' and '}'
  335. nl_collapse_empty_body = false # false/true
  336. # Don't split one-line braced assignments - 'foo_t f = { 1, 2 };'
  337. nl_assign_leave_one_liners = true # false/true
  338. # Don't split one-line braced statements inside a class xx { } body
  339. nl_class_leave_one_liners = false # false/true
  340. # Don't split one-line enums: 'enum foo { BAR = 15 };'
  341. nl_enum_leave_one_liners = true # false/true
  342. # Don't split one-line get or set functions
  343. nl_getset_leave_one_liners = true # false/true
  344. # Don't split one-line function definitions - 'int foo() { return 0; }'
  345. nl_func_leave_one_liners = true # false/true
  346. # Don't split one-line if/else statements - 'if(a) b++;'
  347. nl_if_leave_one_liners = false # false/true
  348. # Add or remove newlines at the start of the file
  349. nl_start_of_file = ignore # ignore/add/remove/force
  350. # The number of newlines at the start of the file (only used if nl_start_of_file is 'add' or 'force'
  351. nl_start_of_file_min = 0 # number
  352. # Add or remove newline at the end of the file
  353. nl_end_of_file = add # ignore/add/remove/force
  354. # The number of newlines at the end of the file (only used if nl_end_of_file is 'add' or 'force')
  355. nl_end_of_file_min = 0 # number
  356. # Add or remove newline between '=' and '{'
  357. nl_assign_brace = ignore # ignore/add/remove/force
  358. # Add or remove newline between '=' and '[' (D only)
  359. nl_assign_square = ignore # ignore/add/remove/force
  360. # Add or remove newline after '= [' (D only). Will also affect the newline before the ']'
  361. nl_after_square_assign = ignore # ignore/add/remove/force
  362. # The number of newlines after a block of variable definitions
  363. nl_func_var_def_blk = 0 # number
  364. # Add or remove newline between a function call's ')' and '{', as in:
  365. # list_for_each(item, &list) { }
  366. nl_fcall_brace = ignore # ignore/add/remove/force
  367. # Add or remove newline between 'enum' and '{'
  368. nl_enum_brace = ignore # ignore/add/remove/force
  369. # Add or remove newline between 'struct and '{'
  370. nl_struct_brace = ignore # ignore/add/remove/force
  371. # Add or remove newline between 'union' and '{'
  372. nl_union_brace = ignore # ignore/add/remove/force
  373. # Add or remove newline between 'if' and '{'
  374. nl_if_brace = remove # ignore/add/remove/force
  375. # Add or remove newline between '}' and 'else'
  376. nl_brace_else = remove # ignore/add/remove/force
  377. # Add or remove newline between 'else if' and '{'
  378. # If set to ignore, nl_if_brace is used instead
  379. nl_elseif_brace = ignore # ignore/add/remove/force
  380. # Add or remove newline between 'else' and '{'
  381. nl_else_brace = ignore # ignore/add/remove/force
  382. # Add or remove newline between '}' and 'finally'
  383. nl_brace_finally = ignore # ignore/add/remove/force
  384. # Add or remove newline between 'finally' and '{'
  385. nl_finally_brace = ignore # ignore/add/remove/force
  386. # Add or remove newline between 'try' and '{'
  387. nl_try_brace = ignore # ignore/add/remove/force
  388. # Add or remove newline between get/set and '{'
  389. nl_getset_brace = ignore # ignore/add/remove/force
  390. # Add or remove newline between 'for' and '{'
  391. nl_for_brace = ignore # ignore/add/remove/force
  392. # Add or remove newline between 'catch' and '{'
  393. nl_catch_brace = ignore # ignore/add/remove/force
  394. # Add or remove newline between '}' and 'catch'
  395. nl_brace_catch = ignore # ignore/add/remove/force
  396. # Add or remove newline between 'while' and '{'
  397. nl_while_brace = ignore # ignore/add/remove/force
  398. # Add or remove newline between 'do' and '{'
  399. nl_do_brace = ignore # ignore/add/remove/force
  400. # Add or remove newline between '}' and 'while' of 'do' statement
  401. nl_brace_while = ignore # ignore/add/remove/force
  402. # Add or remove newline between 'switch' and '{'
  403. nl_switch_brace = ignore # ignore/add/remove/force
  404. # Add or remove newline when condition spans two or more lines
  405. nl_multi_line_cond = false # false/true
  406. # Force a newline in a define after the macro name for multi-line defines.
  407. nl_multi_line_define = false # false/true
  408. # Whether to put a newline before 'case' statement
  409. nl_before_case = false # false/true
  410. # Whether to put a newline after 'case' statement
  411. nl_after_case = false # false/true
  412. # Newline between namespace and {
  413. nl_namespace_brace = ignore # ignore/add/remove/force
  414. # Add or remove newline between 'template<>' and 'class'
  415. nl_template_class = ignore # ignore/add/remove/force
  416. # Add or remove newline between 'class' and '{'
  417. nl_class_brace = ignore # ignore/add/remove/force
  418. # Add or remove newline after each ',' in the constructor member initialization
  419. nl_class_init_args = ignore # ignore/add/remove/force
  420. # Add or remove newline between return type and function name in definition
  421. nl_func_type_name = ignore # ignore/add/remove/force
  422. # Add or remove newline between return type and function name in a prototype
  423. nl_func_proto_type_name = ignore # ignore/add/remove/force
  424. # Add or remove newline between a function name and the opening '('
  425. nl_func_paren = ignore # ignore/add/remove/force
  426. # Add or remove newline after '(' in a function declaration
  427. nl_func_decl_start = ignore # ignore/add/remove/force
  428. # Add or remove newline after each ',' in a function declaration
  429. nl_func_decl_args = ignore # ignore/add/remove/force
  430. # Add or remove newline before the ')' in a function declaration
  431. nl_func_decl_end = ignore # ignore/add/remove/force
  432. # Add or remove newline between function signature and '{'
  433. nl_fdef_brace = remove # ignore/add/remove/force
  434. # Whether to put a newline after 'return' statement
  435. nl_after_return = false # false/true
  436. # Whether to put a newline after semicolons, except in 'for' statements
  437. nl_after_semicolon = false # false/true
  438. # Whether to put a newline after brace open.
  439. # This also adds a newline before the matching brace close.
  440. nl_after_brace_open = false # false/true
  441. # If nl_after_brace_open and nl_after_brace_open_cmt are true, a newline is
  442. # placed between the open brace and a trailing single-line comment.
  443. nl_after_brace_open_cmt = false # false/true
  444. # Whether to put a newline after a virtual brace open.
  445. # These occur in un-braced if/while/do/for statement bodies.
  446. nl_after_vbrace_open = false # false/true
  447. # Whether to alter newlines in '#define' macros
  448. nl_define_macro = false # false/true
  449. # Whether to not put blanks after '#ifxx', '#elxx', or before '#endif'
  450. nl_squeeze_ifdef = false # false/true
  451. # Add or remove newline before 'if'
  452. nl_before_if = ignore # ignore/add/remove/force
  453. # Add or remove newline after 'if'
  454. nl_after_if = ignore # ignore/add/remove/force
  455. # Add or remove newline before 'for'
  456. nl_before_for = ignore # ignore/add/remove/force
  457. # Add or remove newline after 'for'
  458. nl_after_for = ignore # ignore/add/remove/force
  459. # Add or remove newline before 'while'
  460. nl_before_while = ignore # ignore/add/remove/force
  461. # Add or remove newline after 'while'
  462. nl_after_while = ignore # ignore/add/remove/force
  463. # Add or remove newline before 'switch'
  464. nl_before_switch = ignore # ignore/add/remove/force
  465. # Add or remove newline after 'switch'
  466. nl_after_switch = ignore # ignore/add/remove/force
  467. # Add or remove newline before 'do'
  468. nl_before_do = ignore # ignore/add/remove/force
  469. # Add or remove newline after 'do'
  470. nl_after_do = ignore # ignore/add/remove/force
  471. # Whether to double-space commented-entries in struct/enum
  472. nl_ds_struct_enum_cmt = false # false/true
  473. # Whether to double-space before the close brace of a struct/union/enum
  474. nl_ds_struct_enum_close_brace = false # false/true
  475. # Add or remove a newline around a class colon.
  476. # Related to pos_class_colon, nl_class_init_args, and pos_comma.
  477. nl_class_colon = ignore # ignore/add/remove/force
  478. # Change simple unbraced if statements into a one-liner
  479. # 'if(b)\n i++;' => 'if(b) i++;'
  480. nl_create_if_one_liner = true # false/true
  481. # Change simple unbraced for statements into a one-liner
  482. # 'for (i=0;i<5;i++)\n foo(i);' => 'for (i=0;i<5;i++) foo(i);'
  483. nl_create_for_one_liner = false # false/true
  484. # Change simple unbraced while statements into a one-liner
  485. # 'while (i<5)\n foo(i++);' => 'while (i<5) foo(i++);'
  486. nl_create_while_one_liner = false # false/true
  487. #
  488. # Positioning options
  489. #
  490. # The position of boolean operators in wrapped expressions
  491. pos_bool = ignore # ignore/lead/trail
  492. # The position of the comma in wrapped expressions
  493. pos_comma = ignore # ignore/lead/trail
  494. # The position of the comma in the constructor initialization list
  495. pos_class_comma = ignore # ignore/lead/trail
  496. # The position of colons between constructor and member initialization
  497. pos_class_colon = ignore # ignore/lead/trail
  498. #
  499. # Line Splitting options
  500. #
  501. # Try to limit code width to N number of columns
  502. code_width = 0 # number
  503. # Whether to fully split long 'for' statements at semi-colons
  504. ls_for_split_full = false # false/true
  505. # Whether to fully split long function protos/calls at commas
  506. ls_func_split_full = false # false/true
  507. #
  508. # Blank line options
  509. #
  510. # The maximum consecutive newlines
  511. nl_max = 0 # number
  512. # The number of newlines after a function prototype, if followed by another function prototype
  513. nl_after_func_proto = 0 # number
  514. # The number of newlines after a function prototype, if not followed by another function prototype
  515. nl_after_func_proto_group = 0 # number
  516. # The number of newlines after '}' of a multi-line function body
  517. nl_after_func_body = 0 # number
  518. # The number of newlines after '}' of a single line function body
  519. nl_after_func_body_one_liner = 0 # number
  520. # The minimum number of newlines before a multi-line comment.
  521. # Doesn't apply if after a brace open or another multi-line comment.
  522. nl_before_block_comment = 0 # number
  523. # The minimum number of newlines before a single-line C comment.
  524. # Doesn't apply if after a brace open or other single-line C comments.
  525. nl_before_c_comment = 0 # number
  526. # The minimum number of newlines before a CPP comment.
  527. # Doesn't apply if after a brace open or other CPP comments.
  528. nl_before_cpp_comment = 0 # number
  529. # Whether to force a newline after a mulit-line comment.
  530. nl_after_multiline_comment = false # false/true
  531. # The number of newlines before a 'private:', 'public:', 'protected:', 'signals:', or 'slots:' label.
  532. # Will not change the newline count if after a brace open.
  533. # 0 = No change.
  534. nl_before_access_spec = 0 # number
  535. # The number of newlines after a 'private:', 'public:', 'protected:', 'signals:', or 'slots:' label.
  536. # 0 = No change.
  537. nl_after_access_spec = 0 # number
  538. # Whether to remove blank lines after '{'
  539. eat_blanks_after_open_brace = false # false/true
  540. # Whether to remove blank lines before '}'
  541. eat_blanks_before_close_brace = false # false/true
  542. #
  543. # Code modifying options (non-whitespace)
  544. #
  545. # Add or remove braces on single-line 'do' statement
  546. mod_full_brace_do = ignore # ignore/add/remove/force
  547. # Add or remove braces on single-line 'for' statement
  548. mod_full_brace_for = ignore # ignore/add/remove/force
  549. # Add or remove braces on single-line function defintions. (Pawn)
  550. mod_full_brace_function = ignore # ignore/add/remove/force
  551. # Add or remove braces on single-line 'if' statement
  552. mod_full_brace_if = add # ignore/add/remove/force
  553. # Don't remove braces around statements that span N newlines
  554. mod_full_brace_nl = 0 # number
  555. # Add or remove braces on single-line 'while' statement
  556. mod_full_brace_while = ignore # ignore/add/remove/force
  557. # Add or remove unnecessary paren on 'return' statement
  558. mod_paren_on_return = ignore # ignore/add/remove/force
  559. # Whether to change optional semicolons to real semicolons
  560. mod_pawn_semicolon = false # false/true
  561. # Add parens on 'while' and 'if' statement around bools
  562. mod_full_paren_if_bool = false # false/true
  563. # Whether to remove superfluous semicolons
  564. mod_remove_extra_semicolon = false # false/true
  565. # If a function body exceeds the specified number of newlines and doesn't have a comment after
  566. # the close brace, a comment will be added.
  567. mod_add_long_function_closebrace_comment = 0 # number
  568. # If a switch body exceeds the specified number of newlines and doesn't have a comment after
  569. # the close brace, a comment will be added.
  570. mod_add_long_switch_closebrace_comment = 0 # number
  571. # If TRUE, will sort consecutive single-line 'import' statements [Java, D]
  572. mod_sort_import = false # false/true
  573. # If TRUE, will sort consecutive single-line 'using' statements [C#]
  574. mod_sort_using = false # false/true
  575. # If TRUE, will sort consecutive single-line '#include' statements [C/C++] and '#import' statements [Obj-C]
  576. # This is generally a bad idea, as it may break your code.
  577. mod_sort_include = false # false/true
  578. #
  579. # Comment modifications
  580. #
  581. # Try to wrap comments at cmt_witdth columns
  582. cmt_width = 0 # number
  583. # Whether to group c-comments that look like they are in a block
  584. cmt_c_group = false # false/true
  585. # Whether to put an empty '/*' on the first line of the combined c-comment
  586. cmt_c_nl_start = false # false/true
  587. # Whether to put a newline before the closing '*/' of the combined c-comment
  588. cmt_c_nl_end = false # false/true
  589. # Whether to group cpp-comments that look like they are in a block
  590. cmt_cpp_group = false # false/true
  591. # Whether to put an empty '/*' on the first line of the combined cpp-comment
  592. cmt_cpp_nl_start = false # false/true
  593. # Whether to put a newline before the closing '*/' of the combined cpp-comment
  594. cmt_cpp_nl_end = false # false/true
  595. # Whether to change cpp-comments into c-comments
  596. cmt_cpp_to_c = false # false/true
  597. # Whether to put a star on subsequent comment lines
  598. cmt_star_cont = false # false/true
  599. # The number of spaces to insert at the start of subsequent comment lines
  600. cmt_sp_before_star_cont = 0 # number
  601. # The number of spaces to insert after the star on subsequent comment lines
  602. cmt_sp_after_star_cont = 0 # number
  603. # The filename that contains text to insert at the head of a file if the file doesn't start with a C/C++ comment.
  604. # Will substitue $(filename) with the current file's name.
  605. cmt_insert_file_header = "" # string
  606. # The filename that contains text to insert before a function implementation if the function isn't preceeded with a C/C++ comment.
  607. # Will substitue $(function) with the function name and $(javaparam) with the javadoc @param and @return stuff.
  608. # Will also substitute $(fclass) with the class name: void CFoo::Bar() { ... }
  609. cmt_insert_func_header = "" # string
  610. # The filename that contains text to insert before a class if the class isn't preceeded with a C/C++ comment.
  611. # Will substitue $(class) with the class name.
  612. cmt_insert_class_header = "" # string
  613. #
  614. # Preprocessor options
  615. #
  616. # Control indent of preprocessors inside #if blocks at brace level 0
  617. pp_indent = ignore # ignore/add/remove/force
  618. # Whether to indent #if/#else/#endif at the brace level (true) or from column 1 (false)
  619. pp_indent_at_level = false # false/true
  620. # Add or remove space after # based on pp_level of #if blocks
  621. pp_space = ignore # ignore/add/remove/force
  622. # Sets the number of spaces added with pp_space
  623. pp_space_count = 0 # number
  624. # The indent for #region and #endregion in C# and '#pragma region' in C/C++
  625. pp_indent_region = 0 # number
  626. # Whether to indent the code between #region and #endregion
  627. pp_region_indent_code = false # false/true
  628. # If pp_indent_at_level=true, sets the indent for #if, #else, and #endif when not at file-level
  629. pp_indent_if = 0 # number
  630. # Control whether to indent the code between #if, #else and #endif when not at file-level
  631. pp_if_indent_code = false # false/true
  632. # Whether to indent '#define' at the brace level (true) or from column 1 (false)
  633. pp_define_at_level = false # false/true
  634. # You can force a token to be a type with the 'type' option.
  635. # Example:
  636. # type myfoo1 myfoo2
  637. #
  638. # You can create custom macro-based indentation using macro-open,
  639. # macro-else and macro-close.
  640. # Example:
  641. # macro-open BEGIN_TEMPLATE_MESSAGE_MAP
  642. # macro-open BEGIN_MESSAGE_MAP
  643. # macro-close END_MESSAGE_MAP
  644. # If false, disable all multi-line comment changes, including cmt_width and leading chars.
  645. # Default is true.
  646. cmt_indent_multi = false # false/true