You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

1156 lines
49 KiB

17 years ago
17 years ago
17 years ago
17 years ago
17 years ago
17 years ago
17 years ago
17 years ago
17 years ago
17 years ago
17 years ago
17 years ago
17 years ago
17 years ago
17 years ago
17 years ago
17 years ago
17 years ago
17 years ago
17 years ago
  1. # Uncrustify 0.51+svn
  2. #
  3. # General options
  4. #
  5. # The type of line endings
  6. newlines = auto # 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 = 0 # 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 'extern "C"' body is indented
  42. indent_extern = false # false/true
  43. # Whether the 'class' body is indented
  44. indent_class = true # false/true
  45. # Whether to indent the stuff after a leading class colon
  46. indent_class_colon = false # false/true
  47. # False=treat 'else\nif' as 'else if' for indenting purposes
  48. # True=indent the 'if' one level
  49. indent_else_if = true # false/true
  50. # Amount to indent variable declarations after a open brace. neg=relative, pos=absolute
  51. indent_var_def_blk = 0 # number
  52. # True: indent continued function call parameters one indent level
  53. # False: align parameters under the open paren
  54. indent_func_call_param = false # false/true
  55. # Same as indent_func_call_param, but for function defs
  56. indent_func_def_param = false # false/true
  57. # Same as indent_func_call_param, but for function protos
  58. indent_func_proto_param = false # false/true
  59. # Same as indent_func_call_param, but for class declarations
  60. indent_func_class_param = false # false/true
  61. # Same as indent_func_call_param, but for class variable constructors
  62. indent_func_ctor_var_param = false # false/true
  63. # Same as indent_func_call_param, but for templates
  64. indent_template_param = false # false/true
  65. # Double the indent for indent_func_xxx_param options
  66. indent_func_param_double = false # false/true
  67. # Indentation column for standalone 'const' function decl/proto qualifier
  68. indent_func_const = 0 # number
  69. # Indentation column for standalone 'throw' function decl/proto qualifier
  70. indent_func_throw = 0 # number
  71. # The number of spaces to indent a continued '->' or '.'
  72. # Usually set to 0, 1, or indent_columns.
  73. indent_member = 0 # number
  74. # Spaces to indent single line ('//') comments on lines before code
  75. indent_sing_line_comments = 0 # number
  76. # If set, will indent trailing single line ('//') comments relative
  77. # to the code instead of trying to keep the same absolute column
  78. indent_relative_single_line_comments = false # false/true
  79. # Spaces to indent 'case' from 'switch'
  80. # Usually 0 or indent_columns.
  81. indent_switch_case = 0 # number
  82. # Spaces to shift the 'case' line, without affecting any other lines
  83. # Usually 0.
  84. indent_case_shift = 0 # number
  85. # Spaces to indent '{' from 'case'.
  86. # By default, the brace will appear under the 'c' in case.
  87. # Usually set to 0 or indent_columns.
  88. indent_case_brace = 0 # number
  89. # Whether to indent comments found in first column
  90. indent_col1_comment = false # false/true
  91. # How to indent goto labels
  92. # >0 : absolute column where 1 is the leftmost column
  93. # <=0 : subtract from brace indent
  94. indent_label = 1 # number
  95. # Same as indent_label, but for access specifiers that are followed by a colon
  96. indent_access_spec = 1 # number
  97. # Indent the code after an access specifier by one level.
  98. # If set, this option forces 'indent_access_spec=0'
  99. indent_access_spec_body = false # false/true
  100. # If an open paren is followed by a newline, indent the next line so that it lines up after the open paren (not recommended)
  101. indent_paren_nl = false # false/true
  102. # Controls the indent of a close paren after a newline.
  103. # 0: Indent to body level
  104. # 1: Align under the open paren
  105. # 2: Indent to the brace level
  106. indent_paren_close = 0 # number
  107. # Controls the indent of a comma when inside a paren.If TRUE, aligns under the open paren
  108. indent_comma_paren = false # false/true
  109. # Controls the indent of a BOOL operator when inside a paren.If TRUE, aligns under the open paren
  110. indent_bool_paren = false # false/true
  111. # If an open square is followed by a newline, indent the next line so that it lines up after the open square (not recommended)
  112. indent_square_nl = false # false/true
  113. # Don't change the relative indent of ESQL/C 'EXEC SQL' bodies
  114. indent_preserve_sql = false # false/true
  115. # Align continued statements at the '='. Default=True
  116. # If FALSE or the '=' is followed by a newline, the next line is indent one tab.
  117. indent_align_assign = true # false/true
  118. #
  119. # Spacing options
  120. #
  121. # Add or remove space around arithmetic operator '+', '-', '/', '*', etc
  122. sp_arith = force # ignore/add/remove/force
  123. # Add or remove space around assignment operator '=', '+=', etc
  124. sp_assign = force # ignore/add/remove/force
  125. # Add or remove space before assignment operator '=', '+=', etc. Overrides sp_assign.
  126. sp_before_assign = ignore # ignore/add/remove/force
  127. # Add or remove space after assignment operator '=', '+=', etc. Overrides sp_assign.
  128. sp_after_assign = ignore # ignore/add/remove/force
  129. # Add or remove space around assignment '=' in enum
  130. sp_enum_assign = ignore # ignore/add/remove/force
  131. # Add or remove space before assignment '=' in enum. Overrides sp_enum_assign.
  132. sp_enum_before_assign = ignore # ignore/add/remove/force
  133. # Add or remove space after assignment '=' in enum. Overrides sp_enum_assign.
  134. sp_enum_after_assign = ignore # ignore/add/remove/force
  135. # Add or remove space around boolean operators '&&' and '||'
  136. sp_bool = ignore # ignore/add/remove/force
  137. # Add or remove space around compare operator '<', '>', '==', etc
  138. sp_compare = ignore # ignore/add/remove/force
  139. # Add or remove space inside '(' and ')'
  140. sp_inside_paren = ignore # ignore/add/remove/force
  141. # Add or remove space between nested parens
  142. sp_paren_paren = ignore # ignore/add/remove/force
  143. # Whether to balance spaces inside nested parens
  144. sp_balance_nested_parens = true # false/true
  145. # Add or remove space between ')' and '{'
  146. sp_paren_brace = add # ignore/add/remove/force
  147. # Add or remove space before pointer star '*'
  148. sp_before_ptr_star = remove # ignore/add/remove/force
  149. # Add or remove space before pointer star '*' that isn't followed by a variable name
  150. # If set to 'ignore', sp_before_ptr_star is used instead.
  151. sp_before_unnamed_ptr_star = ignore # ignore/add/remove/force
  152. # Add or remove space between pointer stars '*'
  153. sp_between_ptr_star = remove # ignore/add/remove/force
  154. # Add or remove space after pointer star '*', if followed by a word.
  155. sp_after_ptr_star = force # ignore/add/remove/force
  156. # Add or remove space after a pointer star '*', if followed by a func proto/def.
  157. sp_after_ptr_star_func = ignore # ignore/add/remove/force
  158. # Add or remove space before a pointer star '*', if followed by a func proto/def.
  159. sp_before_ptr_star_func = ignore # ignore/add/remove/force
  160. # Add or remove space before a reference sign '&'
  161. sp_before_byref = remove # ignore/add/remove/force
  162. # Add or remove space before a reference sign '&' that isn't followed by a variable name
  163. # If set to 'ignore', sp_before_byref is used instead.
  164. sp_before_unnamed_byref = ignore # ignore/add/remove/force
  165. # Add or remove space after reference sign '&', if followed by a word.
  166. sp_after_byref = force # ignore/add/remove/force
  167. # Add or remove space after a reference sign '&', if followed by a func proto/def.
  168. sp_after_byref_func = ignore # ignore/add/remove/force
  169. # Add or remove space before a reference sign '&', if followed by a func proto/def.
  170. sp_before_byref_func = ignore # ignore/add/remove/force
  171. # Add or remove space between type and word
  172. sp_after_type = force # ignore/add/remove/force
  173. # Add or remove space in 'template <' vs 'template<'.
  174. # If set to ignore, sp_before_angle is used.
  175. sp_template_angle = force # ignore/add/remove/force
  176. # Add or remove space before '<>'
  177. sp_before_angle = ignore # ignore/add/remove/force
  178. # Add or remove space inside '<' and '>'
  179. sp_inside_angle = remove # ignore/add/remove/force
  180. # Add or remove space after '<>'
  181. sp_after_angle = force # ignore/add/remove/force
  182. # Add or remove space between '<>' and '(' as found in 'new List<byte>();'
  183. sp_angle_paren = ignore # ignore/add/remove/force
  184. # Add or remove space between '<>' and a word as in 'List<byte> m;'
  185. sp_angle_word = ignore # ignore/add/remove/force
  186. # Add or remove space before '(' of 'if', 'for', 'switch', and 'while'
  187. sp_before_sparen = remove # ignore/add/remove/force
  188. # Add or remove space inside if-condition '(' and ')'
  189. sp_inside_sparen = add # ignore/add/remove/force
  190. # Add or remove space before if-condition ')'. Overrides sp_inside_sparen.
  191. sp_inside_sparen_close = ignore # ignore/add/remove/force
  192. # Add or remove space after ')' of 'if', 'for', 'switch', and 'while'
  193. sp_after_sparen = ignore # ignore/add/remove/force
  194. # Add or remove space between ')' and '{' of 'if', 'for', 'switch', and 'while'
  195. sp_sparen_brace = add # ignore/add/remove/force
  196. # Add or remove space between 'invariant' and '(' in the D language.
  197. sp_invariant_paren = ignore # ignore/add/remove/force
  198. # Add or remove space after the ')' in 'invariant (C) c' in the D language.
  199. sp_after_invariant_paren = ignore # ignore/add/remove/force
  200. # Add or remove space before empty statement ';' on 'if', 'for' and 'while'
  201. sp_special_semi = add # ignore/add/remove/force
  202. # Add or remove space before ';'
  203. sp_before_semi = remove # ignore/add/remove/force
  204. # Add or remove space before ';' in non-empty 'for' statements
  205. sp_before_semi_for = remove # ignore/add/remove/force
  206. # Add or remove space before a semicolon of an empty part of a for statment.
  207. sp_before_semi_for_empty = add # ignore/add/remove/force
  208. # Add or remove space after the final semicolon of an empty part of a for statment: for ( ; ; <here> ).
  209. sp_after_semi_for_empty = ignore # ignore/add/remove/force
  210. # Add or remove space before '[' (except '[]')
  211. sp_before_square = remove # ignore/add/remove/force
  212. # Add or remove space before '[]'
  213. sp_before_squares = ignore # ignore/add/remove/force
  214. # Add or remove space inside '[' and ']'
  215. sp_inside_square = ignore # ignore/add/remove/force
  216. # Add or remove space after ','
  217. sp_after_comma = force # ignore/add/remove/force
  218. # Add or remove space before ','
  219. sp_before_comma = remove # ignore/add/remove/force
  220. # Add or remove space after class ':'
  221. sp_after_class_colon = ignore # ignore/add/remove/force
  222. # Add or remove space before class ':'
  223. sp_before_class_colon = ignore # ignore/add/remove/force
  224. # Add or remove space before case ':'
  225. sp_before_case_colon = remove # ignore/add/remove/force
  226. # Add or remove space between 'operator' and operator sign
  227. sp_after_operator = ignore # ignore/add/remove/force
  228. # Add or remove space between the operator symbol and the open paren, as in 'operator ++('
  229. sp_after_operator_sym = ignore # ignore/add/remove/force
  230. # Add or remove space after C/D cast, ie 'cast(int)a' vs 'cast(int) a' or '(int)a' vs '(int) a'
  231. sp_after_cast = force # ignore/add/remove/force
  232. # Add or remove spaces inside cast parens
  233. sp_inside_paren_cast = remove # ignore/add/remove/force
  234. # Add or remove space between the type and open paren in a C++ cast, ie 'int(exp)' vs 'int (exp)'
  235. sp_cpp_cast_paren = ignore # ignore/add/remove/force
  236. # Add or remove space between 'sizeof' and '('
  237. sp_sizeof_paren = remove # ignore/add/remove/force
  238. # Add or remove space after the tag keyword (Pawn)
  239. sp_after_tag = ignore # ignore/add/remove/force
  240. # Add or remove space inside enum '{' and '}'
  241. sp_inside_braces_enum = add # ignore/add/remove/force
  242. # Add or remove space inside struct/union '{' and '}'
  243. sp_inside_braces_struct = add # ignore/add/remove/force
  244. # Add or remove space inside '{' and '}'
  245. sp_inside_braces = add # ignore/add/remove/force
  246. # Add or remove space inside '{}'
  247. sp_inside_braces_empty = ignore # ignore/add/remove/force
  248. # Add or remove space between return type and function name
  249. # A minimum of 1 is forced except for pointer return types.
  250. sp_type_func = add # ignore/add/remove/force
  251. # Add or remove space between function name and '(' on function declaration
  252. sp_func_proto_paren = remove # ignore/add/remove/force
  253. # Add or remove space between function name and '(' on function definition
  254. sp_func_def_paren = remove # ignore/add/remove/force
  255. # Add or remove space inside empty function '()'
  256. sp_inside_fparens = remove # ignore/add/remove/force
  257. # Add or remove space inside function '(' and ')'
  258. sp_inside_fparen = add # ignore/add/remove/force
  259. # Add or remove space between ']' and '(' when part of a function call.
  260. sp_square_fparen = ignore # ignore/add/remove/force
  261. # Add or remove space between ')' and '{' of function
  262. sp_fparen_brace = add # ignore/add/remove/force
  263. # Add or remove space between function name and '(' on function calls
  264. sp_func_call_paren = remove # ignore/add/remove/force
  265. # Add or remove space between the user function name and '(' on function calls
  266. # You need to set a keyword to be a user function, like this: 'set func_call_user _' in the config file.
  267. sp_func_call_user_paren = ignore # ignore/add/remove/force
  268. # Add or remove space between a constructor/destructor and the open paren
  269. sp_func_class_paren = remove # ignore/add/remove/force
  270. # Add or remove space between 'return' and '('
  271. sp_return_paren = add # ignore/add/remove/force
  272. # Add or remove space between '__attribute__' and '('
  273. sp_attribute_paren = ignore # ignore/add/remove/force
  274. # Add or remove space between 'defined' and '(' in '#if defined (FOO)'
  275. sp_defined_paren = remove # ignore/add/remove/force
  276. # Add or remove space between 'throw' and '(' in 'throw (something)'
  277. sp_throw_paren = ignore # ignore/add/remove/force
  278. # Add or remove space between macro and value
  279. sp_macro = add # ignore/add/remove/force
  280. # Add or remove space between macro function ')' and value
  281. sp_macro_func = add # ignore/add/remove/force
  282. # Add or remove space between 'else' and '{' if on the same line
  283. sp_else_brace = add # ignore/add/remove/force
  284. # Add or remove space between '}' and 'else' if on the same line
  285. sp_brace_else = ignore # ignore/add/remove/force
  286. # Add or remove space between '}' and the name of a typedef on the same line
  287. sp_brace_typedef = ignore # ignore/add/remove/force
  288. # Add or remove space between 'catch' and '{' if on the same line
  289. sp_catch_brace = add # ignore/add/remove/force
  290. # Add or remove space between '}' and 'catch' if on the same line
  291. sp_brace_catch = add # ignore/add/remove/force
  292. # Add or remove space between 'finally' and '{' if on the same line
  293. sp_finally_brace = add # ignore/add/remove/force
  294. # Add or remove space between '}' and 'finally' if on the same line
  295. sp_brace_finally = add # ignore/add/remove/force
  296. # Add or remove space between 'try' and '{' if on the same line
  297. sp_try_brace = add # ignore/add/remove/force
  298. # Add or remove space between get/set and '{' if on the same line
  299. sp_getset_brace = add # ignore/add/remove/force
  300. # Add or remove space before the '::' operator
  301. sp_before_dc = ignore # ignore/add/remove/force
  302. # Add or remove space after the '::' operator
  303. sp_after_dc = ignore # ignore/add/remove/force
  304. # Add or remove around the D named array initializer ':' operator
  305. sp_d_array_colon = ignore # ignore/add/remove/force
  306. # Add or remove space after the '!' (not) operator.
  307. sp_not = remove # ignore/add/remove/force
  308. # Add or remove space after the '~' (invert) operator.
  309. sp_inv = remove # ignore/add/remove/force
  310. # Add or remove space after the '&' (address-of) operator.
  311. # This does not affect the spacing after a '&' that is part of a type.
  312. sp_addr = remove # ignore/add/remove/force
  313. # Add or remove space around the '.' or '->' operators
  314. sp_member = remove # ignore/add/remove/force
  315. # Add or remove space after the '*' (dereference) operator.
  316. # This does not affect the spacing after a '*' that is part of a type.
  317. sp_deref = remove # ignore/add/remove/force
  318. # Add or remove space after '+' or '-', as in 'x = -5' or 'y = +7'
  319. sp_sign = remove # ignore/add/remove/force
  320. # Add or remove space before or after '++' and '--', as in '(--x)' or 'y++;'
  321. sp_incdec = remove # ignore/add/remove/force
  322. # Add or remove space before a backslash-newline at the end of a line
  323. sp_before_nl_cont = add # ignore/add/remove/force
  324. # Add or remove space after the scope '+' or '-', as in '-(void) foo;' or '+(int) bar;'
  325. sp_after_oc_scope = ignore # ignore/add/remove/force
  326. # Add or remove space after the colon in message specs
  327. # '-(int) f:(int) x;' vs '-(int) f: (int) x;'
  328. sp_after_oc_colon = ignore # ignore/add/remove/force
  329. # Add or remove space before the colon in message specs
  330. # '-(int) f: (int) x;' vs '-(int) f : (int) x;'
  331. sp_before_oc_colon = ignore # ignore/add/remove/force
  332. # Add or remove space after the colon in message specs
  333. # '[object setValue:1];' vs '[object setValue: 1];'
  334. sp_after_send_oc_colon = ignore # ignore/add/remove/force
  335. # Add or remove space before the colon in message specs
  336. # '[object setValue:1];' vs '[object setValue :1];'
  337. sp_before_send_oc_colon = ignore # ignore/add/remove/force
  338. # Add or remove space after the (type) in message specs
  339. # '-(int) f: (int) x;' vs '-(int) f: (int)x;'
  340. sp_after_oc_type = ignore # ignore/add/remove/force
  341. # Add or remove space around the ':' in 'b ? t : f'
  342. sp_cond_colon = add # ignore/add/remove/force
  343. # Add or remove space around the '?' in 'b ? t : f'
  344. sp_cond_question = add # ignore/add/remove/force
  345. # Fix the spacing between 'case' and the label. Only 'ignore' and 'force' make sense here.
  346. sp_case_label = force # ignore/add/remove/force
  347. # Control the space around the D '..' operator.
  348. sp_range = ignore # ignore/add/remove/force
  349. #
  350. # Code alignment (not left column spaces/tabs)
  351. #
  352. # Whether to keep non-indenting tabs
  353. align_keep_tabs = false # false/true
  354. # Whether to use tabs for alinging
  355. align_with_tabs = false # false/true
  356. # Whether to bump out to the next tab when aligning
  357. align_on_tabstop = true # false/true
  358. # Whether to left-align numbers
  359. align_number_left = false # false/true
  360. # Align variable definitions in prototypes and functions
  361. align_func_params = true # false/true
  362. # Align parameters in single-line functions that have the same name.
  363. # The function names must already be aligned with each other.
  364. align_same_func_call_params = false # false/true
  365. # The span for aligning variable definitions (0=don't align)
  366. align_var_def_span = 3 # number
  367. # How to align the star in variable definitions.
  368. # 0=Part of the type 'void * foo;'
  369. # 1=Part of the variable 'void *foo;'
  370. # 2=Dangling 'void *foo;'
  371. align_var_def_star_style = 0 # number
  372. # How to align the '&' in variable definitions.
  373. # 0=Part of the type
  374. # 1=Part of the variable
  375. # 2=Dangling
  376. align_var_def_amp_style = 0 # number
  377. # The threshold for aligning variable definitions (0=no limit)
  378. align_var_def_thresh = 12 # number
  379. # The gap for aligning variable definitions
  380. align_var_def_gap = 0 # number
  381. # Whether to align the colon in struct bit fields
  382. align_var_def_colon = false # false/true
  383. # Whether to align inline struct/enum/union variable definitions
  384. align_var_def_inline = true # false/true
  385. # The span for aligning on '=' in assignments (0=don't align)
  386. align_assign_span = 1 # number
  387. # The threshold for aligning on '=' in assignments (0=no limit)
  388. align_assign_thresh = 4 # number
  389. # The span for aligning on '=' in enums (0=don't align)
  390. align_enum_equ_span = 3 # number
  391. # The threshold for aligning on '=' in enums (0=no limit)
  392. align_enum_equ_thresh = 2 # number
  393. # The span for aligning struct/union (0=don't align)
  394. align_var_struct_span = 1 # number
  395. # The threshold for aligning struct/union member definitions (0=no limit)
  396. align_var_struct_thresh = 0 # number
  397. # The gap for aligning struct/union member definitions
  398. align_var_struct_gap = 0 # number
  399. # The span for aligning struct initializer values (0=don't align)
  400. align_struct_init_span = 1 # number
  401. # The minimum space between the type and the synonym of a typedef
  402. align_typedef_gap = 1 # number
  403. # The span for aligning single-line typedefs (0=don't align)
  404. align_typedef_span = 2 # number
  405. # How to align typedef'd functions with other typedefs
  406. # 0: Don't mix them at all
  407. # 1: align the open paren with the types
  408. # 2: align the function type name with the other type names
  409. align_typedef_func = 0 # number
  410. # Controls the positioning of the '*' in typedefs. Just try it.
  411. # 0: Align on typdef type, ignore '*'
  412. # 1: The '*' is part of type name: typedef int *pint;
  413. # 2: The '*' is part of the type, but dangling: typedef int *pint;
  414. align_typedef_star_style = 2 # number
  415. # Controls the positioning of the '&' in typedefs. Just try it.
  416. # 0: Align on typdef type, ignore '&'
  417. # 1: The '&' is part of type name: typedef int &pint;
  418. # 2: The '&' is part of the type, but dangling: typedef int &pint;
  419. align_typedef_amp_style = 0 # number
  420. # The span for aligning comments that end lines (0=don't align)
  421. align_right_cmt_span = 3 # number
  422. # If aligning comments, mix with comments after '}' and #endif with less than 3 spaces before the comment
  423. align_right_cmt_mix = false # false/true
  424. # If a trailing comment is more than this number of columns away from the text it follows,
  425. # it will qualify for being aligned.
  426. align_right_cmt_gap = 0 # number
  427. # The span for aligning function prototypes (0=don't align)
  428. align_func_proto_span = 5 # number
  429. # Minimum gap between the return type and the function name.
  430. align_func_proto_gap = 0 # number
  431. # Whether to mix aligning prototype and variable declarations.
  432. # If true, align_var_def_XXX options are used instead of align_func_proto_XXX options.
  433. align_mix_var_proto = false # false/true
  434. # Align single-line functions with function prototypes, uses align_func_proto_span
  435. align_single_line_func = false # false/true
  436. # Aligning the open brace of single-line functions.
  437. # Requires align_single_line_func=true, uses align_func_proto_span
  438. align_single_line_brace = false # false/true
  439. # Gap for align_single_line_brace.
  440. align_single_line_brace_gap = 0 # number
  441. # The span for aligning ObjC msg spec (0=don't align)
  442. align_oc_msg_spec_span = 0 # number
  443. # Whether to align macros wrapped with a backslash and a newline.
  444. # This will not work right if the macro contains a multi-line comment.
  445. align_nl_cont = false # false/true
  446. # The minimum space between label and value of a preprocessor define
  447. align_pp_define_gap = 1 # number
  448. # The span for aligning on '#define' bodies (0=don't align)
  449. align_pp_define_span = 1 # number
  450. # Align lines that start with '<<' with previous '<<'. Default=true
  451. align_left_shift = true # false/true
  452. #
  453. # Newline adding and removing options
  454. #
  455. # Whether to collapse empty blocks between '{' and '}'
  456. nl_collapse_empty_body = false # false/true
  457. # Don't split one-line braced assignments - 'foo_t f = { 1, 2 };'
  458. nl_assign_leave_one_liners = true # false/true
  459. # Don't split one-line braced statements inside a class xx { } body
  460. nl_class_leave_one_liners = true # false/true
  461. # Don't split one-line enums: 'enum foo { BAR = 15 };'
  462. nl_enum_leave_one_liners = false # false/true
  463. # Don't split one-line get or set functions
  464. nl_getset_leave_one_liners = false # false/true
  465. # Don't split one-line function definitions - 'int foo() { return 0; }'
  466. nl_func_leave_one_liners = false # false/true
  467. # Don't split one-line if/else statements - 'if(a) b++;'
  468. nl_if_leave_one_liners = false # false/true
  469. # Add or remove newlines at the start of the file
  470. nl_start_of_file = ignore # ignore/add/remove/force
  471. # The number of newlines at the start of the file (only used if nl_start_of_file is 'add' or 'force'
  472. nl_start_of_file_min = 0 # number
  473. # Add or remove newline at the end of the file
  474. nl_end_of_file = force # ignore/add/remove/force
  475. # The number of newlines at the end of the file (only used if nl_end_of_file is 'add' or 'force')
  476. nl_end_of_file_min = 1 # number
  477. # Add or remove newline between '=' and '{'
  478. nl_assign_brace = add # ignore/add/remove/force
  479. # Add or remove newline between '=' and '[' (D only)
  480. nl_assign_square = add # ignore/add/remove/force
  481. # Add or remove newline after '= [' (D only). Will also affect the newline before the ']'
  482. nl_after_square_assign = ignore # ignore/add/remove/force
  483. # The number of newlines after a block of variable definitions
  484. nl_func_var_def_blk = 1 # number
  485. # Add or remove newline between a function call's ')' and '{', as in:
  486. # list_for_each(item, &list) { }
  487. nl_fcall_brace = remove # ignore/add/remove/force
  488. # Add or remove newline between 'enum' and '{'
  489. nl_enum_brace = remove # ignore/add/remove/force
  490. # Add or remove newline between 'struct and '{'
  491. nl_struct_brace = add # ignore/add/remove/force
  492. # Add or remove newline between 'union' and '{'
  493. nl_union_brace = add # ignore/add/remove/force
  494. # Add or remove newline between 'if' and '{'
  495. nl_if_brace = force # ignore/add/remove/force
  496. # Add or remove newline between '}' and 'else'
  497. nl_brace_else = force # ignore/add/remove/force
  498. # Add or remove newline between 'else if' and '{'
  499. # If set to ignore, nl_if_brace is used instead
  500. nl_elseif_brace = force # ignore/add/remove/force
  501. # Add or remove newline between 'else' and '{'
  502. nl_else_brace = force # ignore/add/remove/force
  503. # Add or remove newline between 'else' and 'if'
  504. nl_else_if = remove # ignore/add/remove/force
  505. # Add or remove newline between '}' and 'finally'
  506. nl_brace_finally = ignore # ignore/add/remove/force
  507. # Add or remove newline between 'finally' and '{'
  508. nl_finally_brace = ignore # ignore/add/remove/force
  509. # Add or remove newline between 'try' and '{'
  510. nl_try_brace = force # ignore/add/remove/force
  511. # Add or remove newline between get/set and '{'
  512. nl_getset_brace = ignore # ignore/add/remove/force
  513. # Add or remove newline between 'for' and '{'
  514. nl_for_brace = force # ignore/add/remove/force
  515. # Add or remove newline between 'catch' and '{'
  516. nl_catch_brace = force # ignore/add/remove/force
  517. # Add or remove newline between '}' and 'catch'
  518. nl_brace_catch = force # ignore/add/remove/force
  519. # Add or remove newline between 'while' and '{'
  520. nl_while_brace = force # ignore/add/remove/force
  521. # Add or remove newline between 'do' and '{'
  522. nl_do_brace = ignore # ignore/add/remove/force
  523. # Add or remove newline between '}' and 'while' of 'do' statement
  524. nl_brace_while = remove # ignore/add/remove/force
  525. # Add or remove newline between 'switch' and '{'
  526. nl_switch_brace = force # ignore/add/remove/force
  527. # Add or remove newline when condition spans two or more lines
  528. nl_multi_line_cond = false # false/true
  529. # Force a newline in a define after the macro name for multi-line defines.
  530. nl_multi_line_define = false # false/true
  531. # Whether to put a newline before 'case' statement
  532. nl_before_case = true # false/true
  533. # Add or remove newline between ')' and 'throw'
  534. nl_before_throw = ignore # ignore/add/remove/force
  535. # Whether to put a newline after 'case' statement
  536. nl_after_case = true # false/true
  537. # Newline between namespace and {
  538. nl_namespace_brace = ignore # ignore/add/remove/force
  539. # Add or remove newline between 'template<>' and whatever follows.
  540. nl_template_class = force # ignore/add/remove/force
  541. # Add or remove newline between 'class' and '{'
  542. nl_class_brace = force # ignore/add/remove/force
  543. # Add or remove newline after each ',' in the constructor member initialization
  544. nl_class_init_args = add # ignore/add/remove/force
  545. # Add or remove newline between return type and function name in definition
  546. nl_func_type_name = remove # ignore/add/remove/force
  547. # Add or remove newline between return type and function name in a prototype
  548. nl_func_proto_type_name = remove # ignore/add/remove/force
  549. # Add or remove newline between a function name and the opening '('
  550. nl_func_paren = remove # ignore/add/remove/force
  551. # Add or remove newline after '(' in a function declaration
  552. nl_func_decl_start = ignore # ignore/add/remove/force
  553. # Add or remove newline after each ',' in a function declaration
  554. nl_func_decl_args = ignore # ignore/add/remove/force
  555. # Add or remove newline before the ')' in a function declaration
  556. nl_func_decl_end = ignore # ignore/add/remove/force
  557. # Add or remove newline between function signature and '{'
  558. nl_fdef_brace = force # ignore/add/remove/force
  559. # Whether to put a newline after 'return' statement
  560. nl_after_return = false # false/true
  561. # Add or remove a newline between the return keyword and return expression.
  562. nl_return_expr = ignore # ignore/add/remove/force
  563. # Whether to put a newline after semicolons, except in 'for' statements
  564. nl_after_semicolon = false # false/true
  565. # Whether to put a newline after brace open.
  566. # This also adds a newline before the matching brace close.
  567. nl_after_brace_open = true # false/true
  568. # If nl_after_brace_open and nl_after_brace_open_cmt are true, a newline is
  569. # placed between the open brace and a trailing single-line comment.
  570. nl_after_brace_open_cmt = true # false/true
  571. # Whether to put a newline after a virtual brace open.
  572. # These occur in un-braced if/while/do/for statement bodies.
  573. nl_after_vbrace_open = true # false/true
  574. # Whether to alter newlines in '#define' macros
  575. nl_define_macro = false # false/true
  576. # Whether to not put blanks after '#ifxx', '#elxx', or before '#endif'
  577. nl_squeeze_ifdef = false # false/true
  578. # Add or remove newline before 'if'
  579. nl_before_if = ignore # ignore/add/remove/force
  580. # Add or remove newline after 'if'
  581. # Dick: this needs to stay at ignore until the trailing else support is fixed.
  582. nl_after_if = ignore # ignore/add/remove/force
  583. # Add or remove newline before 'for'
  584. nl_before_for = ignore # ignore/add/remove/force
  585. # Add or remove newline after 'for'
  586. nl_after_for = add # ignore/add/remove/force
  587. # Add or remove newline before 'while'
  588. nl_before_while = ignore # ignore/add/remove/force
  589. # Add or remove newline after 'while'
  590. nl_after_while = add # ignore/add/remove/force
  591. # Add or remove newline before 'switch'
  592. nl_before_switch = ignore # ignore/add/remove/force
  593. # Add or remove newline after 'switch'
  594. nl_after_switch = add # ignore/add/remove/force
  595. # Add or remove newline before 'do'
  596. nl_before_do = ignore # ignore/add/remove/force
  597. # Add or remove newline after 'do'
  598. nl_after_do = add # ignore/add/remove/force
  599. # Whether to double-space commented-entries in struct/enum
  600. nl_ds_struct_enum_cmt = true # false/true
  601. # Whether to double-space before the close brace of a struct/union/enum
  602. nl_ds_struct_enum_close_brace = false # false/true
  603. # Add or remove a newline around a class colon.
  604. # Related to pos_class_colon, nl_class_init_args, and pos_comma.
  605. nl_class_colon = ignore # ignore/add/remove/force
  606. # Change simple unbraced if statements into a one-liner
  607. # 'if(b)\n i++;' => 'if(b) i++;'
  608. nl_create_if_one_liner = false # false/true
  609. # Change simple unbraced for statements into a one-liner
  610. # 'for (i=0;i<5;i++)\n foo(i);' => 'for (i=0;i<5;i++) foo(i);'
  611. nl_create_for_one_liner = false # false/true
  612. # Change simple unbraced while statements into a one-liner
  613. # 'while (i<5)\n foo(i++);' => 'while (i<5) foo(i++);'
  614. nl_create_while_one_liner = false # false/true
  615. #
  616. # Positioning options
  617. #
  618. # The position of arithmetic operators in wrapped expressions
  619. pos_arith = ignore # ignore/lead/trail
  620. # The position of assignment in wrapped expressions
  621. pos_assign = ignore # ignore/lead/trail
  622. # The position of boolean operators in wrapped expressions
  623. pos_bool = lead # ignore/lead/trail
  624. # The position of the comma in wrapped expressions
  625. pos_comma = trail # ignore/lead/trail
  626. # The position of the comma in the constructor initialization list
  627. pos_class_comma = ignore # ignore/lead/trail
  628. # The position of colons between constructor and member initialization
  629. pos_class_colon = trail # ignore/lead/trail
  630. #
  631. # Line Splitting options
  632. #
  633. # Try to limit code width to N number of columns
  634. code_width = 99 # number
  635. # Whether to fully split long 'for' statements at semi-colons
  636. ls_for_split_full = true # false/true
  637. # Whether to fully split long function protos/calls at commas
  638. ls_func_split_full = true # false/true
  639. #
  640. # Blank line options
  641. #
  642. # The maximum consecutive newlines
  643. nl_max = 3 # number
  644. # The number of newlines after a function prototype, if followed by another function prototype
  645. nl_after_func_proto = 0 # number
  646. # The number of newlines after a function prototype, if not followed by another function prototype
  647. nl_after_func_proto_group = 2 # number
  648. # The number of newlines after '}' of a multi-line function body
  649. nl_after_func_body = 3 # number
  650. # The number of newlines after '}' of a single line function body
  651. nl_after_func_body_one_liner = 1 # number
  652. # The minimum number of newlines before a multi-line comment.
  653. # Doesn't apply if after a brace open or another multi-line comment.
  654. nl_before_block_comment = 2 # number
  655. # The minimum number of newlines before a single-line C comment.
  656. # Doesn't apply if after a brace open or other single-line C comments.
  657. nl_before_c_comment = 1 # number
  658. # The minimum number of newlines before a CPP comment.
  659. # Doesn't apply if after a brace open or other CPP comments.
  660. nl_before_cpp_comment = 2 # number
  661. # Whether to force a newline after a mulit-line comment.
  662. nl_after_multiline_comment = false # false/true
  663. # The number of newlines before a 'private:', 'public:', 'protected:', 'signals:', or 'slots:' label.
  664. # Will not change the newline count if after a brace open.
  665. # 0 = No change.
  666. nl_before_access_spec = 0 # number
  667. # The number of newlines after a 'private:', 'public:', 'protected:', 'signals:', or 'slots:' label.
  668. # 0 = No change.
  669. nl_after_access_spec = 0 # number
  670. # The number of newlines between a function def and the function comment.
  671. # 0 = No change.
  672. nl_comment_func_def = 0 # number
  673. # The number of newlines after a try-catch-finally block that isn't followed by a brace close.
  674. # 0 = No change.
  675. nl_after_try_catch_finally = 1 # number
  676. # The number of newlines before and after a property, indexer or event decl.
  677. # 0 = No change.
  678. nl_around_cs_property = 0 # number
  679. # The number of newlines between the get/set/add/remove handlers in C#.
  680. # 0 = No change.
  681. nl_between_get_set = 0 # number
  682. # Whether to remove blank lines after '{'
  683. eat_blanks_after_open_brace = true # false/true
  684. # Whether to remove blank lines before '}'
  685. eat_blanks_before_close_brace = true # false/true
  686. #
  687. # Code modifying options (non-whitespace)
  688. #
  689. # Add or remove braces on single-line 'do' statement
  690. mod_full_brace_do = add # ignore/add/remove/force
  691. # Add or remove braces on single-line 'for' statement
  692. mod_full_brace_for = ignore # ignore/add/remove/force
  693. # Add or remove braces on single-line function defintions. (Pawn)
  694. mod_full_brace_function = ignore # ignore/add/remove/force
  695. # Add or remove braces on single-line 'if' statement. Will not remove the braces if they contain an 'else'.
  696. mod_full_brace_if = ignore # ignore/add/remove/force
  697. # Don't remove braces around statements that span N newlines
  698. mod_full_brace_nl = 3 # number
  699. # Add or remove braces on single-line 'while' statement
  700. mod_full_brace_while = ignore # ignore/add/remove/force
  701. # Add or remove unnecessary paren on 'return' statement
  702. mod_paren_on_return = remove # ignore/add/remove/force
  703. # Whether to change optional semicolons to real semicolons
  704. mod_pawn_semicolon = false # false/true
  705. # Add parens on 'while' and 'if' statement around bools
  706. mod_full_paren_if_bool = false # false/true
  707. # Whether to remove superfluous semicolons
  708. mod_remove_extra_semicolon = false # false/true
  709. # If a function body exceeds the specified number of newlines and doesn't have a comment after
  710. # the close brace, a comment will be added.
  711. mod_add_long_function_closebrace_comment = 0 # number
  712. # If a switch body exceeds the specified number of newlines and doesn't have a comment after
  713. # the close brace, a comment will be added.
  714. mod_add_long_switch_closebrace_comment = 0 # number
  715. # If TRUE, will sort consecutive single-line 'import' statements [Java, D]
  716. mod_sort_import = false # false/true
  717. # If TRUE, will sort consecutive single-line 'using' statements [C#]
  718. mod_sort_using = false # false/true
  719. # If TRUE, will sort consecutive single-line '#include' statements [C/C++] and '#import' statements [Obj-C]
  720. # This is generally a bad idea, as it may break your code.
  721. mod_sort_include = false # false/true
  722. # If TRUE, it will move a 'break' that appears after a fully braced 'case' before the close brace.
  723. mod_move_case_break = false # false/true
  724. # If TRUE, it will remove a void 'return;' that appears as the last statement in a function.
  725. mod_remove_empty_return = false # false/true
  726. #
  727. # Comment modifications
  728. #
  729. # Try to wrap comments at cmt_width columns
  730. cmt_width = 0 # number
  731. # If false, disable all multi-line comment changes, including cmt_width and leading chars.
  732. # Default is true.
  733. cmt_indent_multi = true # false/true
  734. # Whether to group c-comments that look like they are in a block
  735. cmt_c_group = false # false/true
  736. # Whether to put an empty '/*' on the first line of the combined c-comment
  737. cmt_c_nl_start = false # false/true
  738. # Whether to put a newline before the closing '*/' of the combined c-comment
  739. cmt_c_nl_end = false # false/true
  740. # Whether to group cpp-comments that look like they are in a block
  741. cmt_cpp_group = false # false/true
  742. # Whether to put an empty '/*' on the first line of the combined cpp-comment
  743. cmt_cpp_nl_start = false # false/true
  744. # Whether to put a newline before the closing '*/' of the combined cpp-comment
  745. cmt_cpp_nl_end = false # false/true
  746. # Whether to change cpp-comments into c-comments
  747. cmt_cpp_to_c = false # false/true
  748. # Whether to put a star on subsequent comment lines
  749. cmt_star_cont = true # false/true
  750. # The number of spaces to insert at the start of subsequent comment lines
  751. cmt_sp_before_star_cont = 0 # number
  752. # The number of spaces to insert after the star on subsequent comment lines
  753. cmt_sp_after_star_cont = 1 # number
  754. # For multi-line comments with a '*' lead, remove leading spaces if the first and last lines of
  755. # the comment are the same length. Default=True
  756. cmt_multi_check_last = true # false/true
  757. # The filename that contains text to insert at the head of a file if the file doesn't start with a C/C++ comment.
  758. # Will substitue $(filename) with the current file's name.
  759. cmt_insert_file_header = "" # string
  760. # The filename that contains text to insert before a function implementation if the function isn't preceeded with a C/C++ comment.
  761. # Will substitue $(function) with the function name and $(javaparam) with the javadoc @param and @return stuff.
  762. # Will also substitute $(fclass) with the class name: void CFoo::Bar() { ... }
  763. cmt_insert_func_header = "" # string
  764. # The filename that contains text to insert before a class if the class isn't preceeded with a C/C++ comment.
  765. # Will substitue $(class) with the class name.
  766. cmt_insert_class_header = "" # string
  767. # If a preprocessor is encountered when stepping backwards from a function name, then
  768. # this option decides whether the comment should be inserted.
  769. # Affects cmt_insert_func_header and cmt_insert_class_header.
  770. cmt_insert_before_preproc = false # false/true
  771. #
  772. # Preprocessor options
  773. #
  774. # Control indent of preprocessors inside #if blocks at brace level 0
  775. pp_indent = ignore # ignore/add/remove/force
  776. # Whether to indent #if/#else/#endif at the brace level (true) or from column 1 (false)
  777. pp_indent_at_level = false # false/true
  778. # If pp_indent_at_level=false, specifies the number of columns to indent per level. Default=1.
  779. pp_indent_count = 1 # number
  780. # Add or remove space after # based on pp_level of #if blocks
  781. pp_space = ignore # ignore/add/remove/force
  782. # Sets the number of spaces added with pp_space
  783. pp_space_count = 1 # number
  784. # The indent for #region and #endregion in C# and '#pragma region' in C/C++
  785. pp_indent_region = 0 # number
  786. # Whether to indent the code between #region and #endregion
  787. pp_region_indent_code = false # false/true
  788. # If pp_indent_at_level=true, sets the indent for #if, #else, and #endif when not at file-level
  789. pp_indent_if = 1 # number
  790. # Control whether to indent the code between #if, #else and #endif when not at file-level
  791. pp_if_indent_code = false # false/true
  792. # Whether to indent '#define' at the brace level (true) or from column 1 (false)
  793. pp_define_at_level = false # false/true
  794. # You can force a token to be a type with the 'type' option.
  795. # Example:
  796. # type myfoo1 myfoo2
  797. #
  798. # You can create custom macro-based indentation using macro-open,
  799. # macro-else and macro-close.
  800. # Example:
  801. # macro-open BEGIN_TEMPLATE_MESSAGE_MAP
  802. # macro-open BEGIN_MESSAGE_MAP
  803. # macro-close END_MESSAGE_MAP
  804. #
  805. # You can assign any keyword to any type with the set option.
  806. # set func_call_user _ N_