uncrustify.cfg 69 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579
  1. # Uncrustify 0.60
  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 = 8 # number
  9. # The size of tabs in the output (only used if align_with_tabs=true)
  10. output_tab_size = 8 # 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. # Allow interpreting '>=' and '>>=' as part of a template in 'void f(list<list<B>>=val);'.
  16. # If true (default), 'assert(x<0 && y>=3)' will be broken.
  17. # Improvements to template detection may make this option obsolete.
  18. tok_split_gte = false # false/true
  19. # Control what to do with the UTF-8 BOM (recommend 'remove')
  20. utf8_bom = ignore # ignore/add/remove/force
  21. # If the file contains bytes with values between 128 and 255, but is not UTF-8, then output as UTF-8
  22. utf8_byte = false # false/true
  23. # Force the output encoding to UTF-8
  24. utf8_force = false # false/true
  25. #
  26. # Indenting
  27. #
  28. # The number of columns to indent per level.
  29. # Usually 2, 3, 4, or 8.
  30. indent_columns = 2 # number
  31. # The continuation indent. If non-zero, this overrides the indent of '(' and '=' continuation indents.
  32. # For FreeBSD, this is set to 4. Negative value is absolute and not increased for each ( level
  33. indent_continue = 0 # number
  34. # How to use tabs when indenting code
  35. # 0=spaces only
  36. # 1=indent with tabs to brace level, align with spaces
  37. # 2=indent and align with tabs, using spaces when not on a tabstop
  38. indent_with_tabs = 0 # number
  39. # Comments that are not a brace level are indented with tabs on a tabstop.
  40. # Requires indent_with_tabs=2. If false, will use spaces.
  41. indent_cmt_with_tabs = false # false/true
  42. # Whether to indent strings broken by '\' so that they line up
  43. indent_align_string = true # false/true
  44. # The number of spaces to indent multi-line XML strings.
  45. # Requires indent_align_string=True
  46. indent_xml_string = 0 # number
  47. # Spaces to indent '{' from level
  48. indent_brace = 0 # number
  49. # Whether braces are indented to the body level
  50. indent_braces = false # false/true
  51. # Disabled indenting function braces if indent_braces is true
  52. indent_braces_no_func = false # false/true
  53. # Disabled indenting class braces if indent_braces is true
  54. indent_braces_no_class = false # false/true
  55. # Disabled indenting struct braces if indent_braces is true
  56. indent_braces_no_struct = false # false/true
  57. # Indent based on the size of the brace parent, i.e. 'if' => 3 spaces, 'for' => 4 spaces, etc.
  58. indent_brace_parent = false # false/true
  59. # Whether the 'namespace' body is indented
  60. indent_namespace = false # false/true
  61. # The number of spaces to indent a namespace block
  62. indent_namespace_level = 0 # number
  63. # If the body of the namespace is longer than this number, it won't be indented.
  64. # Requires indent_namespace=true. Default=0 (no limit)
  65. indent_namespace_limit = 0 # number
  66. # Whether the 'extern "C"' body is indented
  67. indent_extern = false # false/true
  68. # Whether the 'class' body is indented
  69. indent_class = true # false/true
  70. # Whether to indent the stuff after a leading class colon
  71. indent_class_colon = true # false/true
  72. # Virtual indent from the ':' for member initializers. Default is 2
  73. indent_ctor_init_leading = 2 # number
  74. # Additional indenting for constructor initializer list
  75. indent_ctor_init = 0 # number
  76. # False=treat 'else\nif' as 'else if' for indenting purposes
  77. # True=indent the 'if' one level
  78. indent_else_if = false # false/true
  79. # Amount to indent variable declarations after an open brace. neg=relative, pos=absolute
  80. indent_var_def_blk = 0 # number
  81. # Indent continued variable declarations instead of aligning.
  82. indent_var_def_cont = false # false/true
  83. # True: force indentation of function definition to start in column 1
  84. # False: use the default behavior
  85. indent_func_def_force_col1 = false # false/true
  86. # True: indent continued function call parameters one indent level
  87. # False: align parameters under the open paren
  88. indent_func_call_param = false # false/true
  89. # Same as indent_func_call_param, but for function defs
  90. indent_func_def_param = false # false/true
  91. # Same as indent_func_call_param, but for function protos
  92. indent_func_proto_param = false # false/true
  93. # Same as indent_func_call_param, but for class declarations
  94. indent_func_class_param = false # false/true
  95. # Same as indent_func_call_param, but for class variable constructors
  96. indent_func_ctor_var_param = false # false/true
  97. # Same as indent_func_call_param, but for templates
  98. indent_template_param = false # false/true
  99. # Double the indent for indent_func_xxx_param options
  100. indent_func_param_double = false # false/true
  101. # Indentation column for standalone 'const' function decl/proto qualifier
  102. indent_func_const = 0 # number
  103. # Indentation column for standalone 'throw' function decl/proto qualifier
  104. indent_func_throw = 0 # number
  105. # The number of spaces to indent a continued '->' or '.'
  106. # Usually set to 0, 1, or indent_columns.
  107. indent_member = 0 # number
  108. # Spaces to indent single line ('//') comments on lines before code
  109. indent_sing_line_comments = 0 # number
  110. # If set, will indent trailing single line ('//') comments relative
  111. # to the code instead of trying to keep the same absolute column
  112. indent_relative_single_line_comments = false # false/true
  113. # Spaces to indent 'case' from 'switch'
  114. # Usually 0 or indent_columns.
  115. indent_switch_case = 0 # number
  116. # Spaces to shift the 'case' line, without affecting any other lines
  117. # Usually 0.
  118. indent_case_shift = 0 # number
  119. # Spaces to indent '{' from 'case'.
  120. # By default, the brace will appear under the 'c' in case.
  121. # Usually set to 0 or indent_columns.
  122. indent_case_brace = 0 # number
  123. # Whether to indent comments found in first column
  124. indent_col1_comment = true # false/true
  125. # How to indent goto labels
  126. # >0 : absolute column where 1 is the leftmost column
  127. # <=0 : subtract from brace indent
  128. indent_label = 0 # number
  129. # Same as indent_label, but for access specifiers that are followed by a colon
  130. indent_access_spec = 1 # number
  131. # Indent the code after an access specifier by one level.
  132. # If set, this option forces 'indent_access_spec=0'
  133. indent_access_spec_body = false # false/true
  134. # If an open paren is followed by a newline, indent the next line so that it lines up after the open paren (not recommended)
  135. indent_paren_nl = false # false/true
  136. # Controls the indent of a close paren after a newline.
  137. # 0: Indent to body level
  138. # 1: Align under the open paren
  139. # 2: Indent to the brace level
  140. indent_paren_close = 0 # number
  141. # Controls the indent of a comma when inside a paren.If TRUE, aligns under the open paren
  142. indent_comma_paren = false # false/true
  143. # Controls the indent of a BOOL operator when inside a paren.If TRUE, aligns under the open paren
  144. indent_bool_paren = false # false/true
  145. # If 'indent_bool_paren' is true, controls the indent of the first expression. If TRUE, aligns the first expression to the following ones
  146. indent_first_bool_expr = false # false/true
  147. # If an open square is followed by a newline, indent the next line so that it lines up after the open square (not recommended)
  148. indent_square_nl = false # false/true
  149. # Don't change the relative indent of ESQL/C 'EXEC SQL' bodies
  150. indent_preserve_sql = false # false/true
  151. # Align continued statements at the '='. Default=True
  152. # If FALSE or the '=' is followed by a newline, the next line is indent one tab.
  153. indent_align_assign = true # false/true
  154. # Indent OC blocks at brace level instead of usual rules.
  155. indent_oc_block = false # false/true
  156. # Indent OC blocks in a message relative to the parameter name.
  157. # 0=use indent_oc_block rules, 1+=spaces to indent
  158. indent_oc_block_msg = 0 # number
  159. # Minimum indent for subsequent parameters
  160. indent_oc_msg_colon = 0 # number
  161. #
  162. # Spacing options
  163. #
  164. # Add or remove space around arithmetic operator '+', '-', '/', '*', etc
  165. sp_arith = add # ignore/add/remove/force
  166. # Add or remove space around assignment operator '=', '+=', etc
  167. sp_assign = add # ignore/add/remove/force
  168. # Add or remove space around '=' in C++11 lambda capture specifications. Overrides sp_assign
  169. sp_cpp_lambda_assign = ignore # ignore/add/remove/force
  170. # Add or remove space after the capture specification in C++11 lambda.
  171. sp_cpp_lambda_paren = ignore # ignore/add/remove/force
  172. # Add or remove space around assignment operator '=' in a prototype
  173. sp_assign_default = ignore # ignore/add/remove/force
  174. # Add or remove space before assignment operator '=', '+=', etc. Overrides sp_assign.
  175. sp_before_assign = ignore # ignore/add/remove/force
  176. # Add or remove space after assignment operator '=', '+=', etc. Overrides sp_assign.
  177. sp_after_assign = ignore # ignore/add/remove/force
  178. # Add or remove space around assignment '=' in enum
  179. sp_enum_assign = add # ignore/add/remove/force
  180. # Add or remove space before assignment '=' in enum. Overrides sp_enum_assign.
  181. sp_enum_before_assign = ignore # ignore/add/remove/force
  182. # Add or remove space after assignment '=' in enum. Overrides sp_enum_assign.
  183. sp_enum_after_assign = ignore # ignore/add/remove/force
  184. # Add or remove space around preprocessor '##' concatenation operator. Default=Add
  185. sp_pp_concat = add # ignore/add/remove/force
  186. # Add or remove space after preprocessor '#' stringify operator. Also affects the '#@' charizing operator.
  187. sp_pp_stringify = add # ignore/add/remove/force
  188. # Add or remove space before preprocessor '#' stringify operator as in '#define x(y) L#y'.
  189. sp_before_pp_stringify = ignore # ignore/add/remove/force
  190. # Add or remove space around boolean operators '&&' and '||'
  191. sp_bool = add # ignore/add/remove/force
  192. # Add or remove space around compare operator '<', '>', '==', etc
  193. sp_compare = add # ignore/add/remove/force
  194. # Add or remove space inside '(' and ')'
  195. sp_inside_paren = remove # ignore/add/remove/force
  196. # Add or remove space between nested parens
  197. sp_paren_paren = remove # ignore/add/remove/force
  198. # Whether to balance spaces inside nested parens
  199. sp_balance_nested_parens = false # false/true
  200. # Add or remove space between ')' and '{'
  201. sp_paren_brace = add # ignore/add/remove/force
  202. # Add or remove space before pointer star '*'
  203. sp_before_ptr_star = add # ignore/add/remove/force
  204. # Add or remove space before pointer star '*' that isn't followed by a variable name
  205. # If set to 'ignore', sp_before_ptr_star is used instead.
  206. sp_before_unnamed_ptr_star = add # ignore/add/remove/force
  207. # Add or remove space between pointer stars '*'
  208. sp_between_ptr_star = remove # ignore/add/remove/force
  209. # Add or remove space after pointer star '*', if followed by a word.
  210. sp_after_ptr_star = remove # ignore/add/remove/force
  211. # Add or remove space after a pointer star '*', if followed by a func proto/def.
  212. sp_after_ptr_star_func = add # ignore/add/remove/force
  213. # Add or remove space after a pointer star '*', if followed by an open paren (function types).
  214. sp_ptr_star_paren = ignore # ignore/add/remove/force
  215. # Add or remove space before a pointer star '*', if followed by a func proto/def.
  216. sp_before_ptr_star_func = remove # ignore/add/remove/force
  217. # Add or remove space before a reference sign '&'
  218. sp_before_byref = remove # ignore/add/remove/force
  219. # Add or remove space before a reference sign '&' that isn't followed by a variable name
  220. # If set to 'ignore', sp_before_byref is used instead.
  221. sp_before_unnamed_byref = remove # ignore/add/remove/force
  222. # Add or remove space after reference sign '&', if followed by a word.
  223. sp_after_byref = add # ignore/add/remove/force
  224. # Add or remove space after a reference sign '&', if followed by a func proto/def.
  225. sp_after_byref_func = add # ignore/add/remove/force
  226. # Add or remove space before a reference sign '&', if followed by a func proto/def.
  227. sp_before_byref_func = remove # ignore/add/remove/force
  228. # Add or remove space between type and word. Default=Force
  229. sp_after_type = add # ignore/add/remove/force
  230. # Add or remove space before the paren in the D constructs 'template Foo(' and 'class Foo('.
  231. sp_before_template_paren = ignore # ignore/add/remove/force
  232. # Add or remove space in 'template <' vs 'template<'.
  233. # If set to ignore, sp_before_angle is used.
  234. sp_template_angle = ignore # ignore/add/remove/force
  235. # Add or remove space before '<>'
  236. sp_before_angle = remove # ignore/add/remove/force
  237. # Add or remove space inside '<' and '>'
  238. sp_inside_angle = remove # ignore/add/remove/force
  239. # Add or remove space after '<>'
  240. sp_after_angle = remove # ignore/add/remove/force
  241. # Add or remove space between '<>' and '(' as found in 'new List<byte>();'
  242. sp_angle_paren = remove # ignore/add/remove/force
  243. # Add or remove space between '<>' and a word as in 'List<byte> m;'
  244. sp_angle_word = remove # ignore/add/remove/force
  245. # Add or remove space between '>' and '>' in '>>' (template stuff C++/C# only). Default=Add
  246. sp_angle_shift = add # ignore/add/remove/force
  247. # Permit removal of the space between '>>' in 'foo<bar<int> >' (C++11 only). Default=False
  248. # sp_angle_shift cannot remove the space without this option.
  249. sp_permit_cpp11_shift = false # false/true
  250. # Add or remove space before '(' of 'if', 'for', 'switch', and 'while'
  251. sp_before_sparen = add # ignore/add/remove/force
  252. # Add or remove space inside if-condition '(' and ')'
  253. sp_inside_sparen = remove # ignore/add/remove/force
  254. # Add or remove space before if-condition ')'. Overrides sp_inside_sparen.
  255. sp_inside_sparen_close = ignore # ignore/add/remove/force
  256. # Add or remove space before if-condition '('. Overrides sp_inside_sparen.
  257. sp_inside_sparen_open = ignore # ignore/add/remove/force
  258. # Add or remove space after ')' of 'if', 'for', 'switch', and 'while'
  259. sp_after_sparen = ignore # ignore/add/remove/force
  260. # Add or remove space between ')' and '{' of 'if', 'for', 'switch', and 'while'
  261. sp_sparen_brace = add # ignore/add/remove/force
  262. # Add or remove space between 'invariant' and '(' in the D language.
  263. sp_invariant_paren = ignore # ignore/add/remove/force
  264. # Add or remove space after the ')' in 'invariant (C) c' in the D language.
  265. sp_after_invariant_paren = ignore # ignore/add/remove/force
  266. # Add or remove space before empty statement ';' on 'if', 'for' and 'while'
  267. sp_special_semi = remove # ignore/add/remove/force
  268. # Add or remove space before ';'. Default=Remove
  269. sp_before_semi = remove # ignore/add/remove/force
  270. # Add or remove space before ';' in non-empty 'for' statements
  271. sp_before_semi_for = remove # ignore/add/remove/force
  272. # Add or remove space before a semicolon of an empty part of a for statement.
  273. sp_before_semi_for_empty = remove # ignore/add/remove/force
  274. # Add or remove space after ';', except when followed by a comment. Default=Add
  275. sp_after_semi = add # ignore/add/remove/force
  276. # Add or remove space after ';' in non-empty 'for' statements. Default=Force
  277. sp_after_semi_for = force # ignore/add/remove/force
  278. # Add or remove space after the final semicolon of an empty part of a for statement: for ( ; ; <here> ).
  279. sp_after_semi_for_empty = remove # ignore/add/remove/force
  280. # Add or remove space before '[' (except '[]')
  281. sp_before_square = remove # ignore/add/remove/force
  282. # Add or remove space before '[]'
  283. sp_before_squares = remove # ignore/add/remove/force
  284. # Add or remove space inside a non-empty '[' and ']'
  285. sp_inside_square = remove # ignore/add/remove/force
  286. # Add or remove space after ','
  287. sp_after_comma = add # ignore/add/remove/force
  288. # Add or remove space before ','
  289. sp_before_comma = remove # ignore/add/remove/force
  290. # Add or remove space between an open paren and comma: '(,' vs '( ,'
  291. sp_paren_comma = force # ignore/add/remove/force
  292. # Add or remove space before the variadic '...' when preceded by a non-punctuator
  293. sp_before_ellipsis = ignore # ignore/add/remove/force
  294. # Add or remove space after class ':'
  295. sp_after_class_colon = add # ignore/add/remove/force
  296. # Add or remove space before class ':'
  297. sp_before_class_colon = add # ignore/add/remove/force
  298. # Add or remove space before case ':'. Default=Remove
  299. sp_before_case_colon = remove # ignore/add/remove/force
  300. # Add or remove space between 'operator' and operator sign
  301. sp_after_operator = remove # ignore/add/remove/force
  302. # Add or remove space between the operator symbol and the open paren, as in 'operator ++('
  303. sp_after_operator_sym = remove # ignore/add/remove/force
  304. # Add or remove space after C/D cast, i.e. 'cast(int)a' vs 'cast(int) a' or '(int)a' vs '(int) a'
  305. sp_after_cast = remove # ignore/add/remove/force
  306. # Add or remove spaces inside cast parens
  307. sp_inside_paren_cast = remove # ignore/add/remove/force
  308. # Add or remove space between the type and open paren in a C++ cast, i.e. 'int(exp)' vs 'int (exp)'
  309. sp_cpp_cast_paren = remove # ignore/add/remove/force
  310. # Add or remove space between 'sizeof' and '('
  311. sp_sizeof_paren = remove # ignore/add/remove/force
  312. # Add or remove space after the tag keyword (Pawn)
  313. sp_after_tag = ignore # ignore/add/remove/force
  314. # Add or remove space inside enum '{' and '}'
  315. sp_inside_braces_enum = add # ignore/add/remove/force
  316. # Add or remove space inside struct/union '{' and '}'
  317. sp_inside_braces_struct = add # ignore/add/remove/force
  318. # Add or remove space inside '{' and '}'
  319. sp_inside_braces = add # ignore/add/remove/force
  320. # Add or remove space inside '{}'
  321. sp_inside_braces_empty = remove # ignore/add/remove/force
  322. # Add or remove space between return type and function name
  323. # A minimum of 1 is forced except for pointer return types.
  324. sp_type_func = add # ignore/add/remove/force
  325. # Add or remove space between function name and '(' on function declaration
  326. sp_func_proto_paren = remove # ignore/add/remove/force
  327. # Add or remove space between function name and '(' on function definition
  328. sp_func_def_paren = remove # ignore/add/remove/force
  329. # Add or remove space inside empty function '()'
  330. sp_inside_fparens = remove # ignore/add/remove/force
  331. # Add or remove space inside function '(' and ')'
  332. sp_inside_fparen = remove # ignore/add/remove/force
  333. # Add or remove space inside the first parens in the function type: 'void (*x)(...)'
  334. sp_inside_tparen = ignore # ignore/add/remove/force
  335. # Add or remove between the parens in the function type: 'void (*x)(...)'
  336. sp_after_tparen_close = ignore # ignore/add/remove/force
  337. # Add or remove space between ']' and '(' when part of a function call.
  338. sp_square_fparen = remove # ignore/add/remove/force
  339. # Add or remove space between ')' and '{' of function
  340. sp_fparen_brace = add # ignore/add/remove/force
  341. # Add or remove space between function name and '(' on function calls
  342. sp_func_call_paren = remove # ignore/add/remove/force
  343. # Add or remove space between function name and '()' on function calls without parameters.
  344. # If set to 'ignore' (the default), sp_func_call_paren is used.
  345. sp_func_call_paren_empty = ignore # ignore/add/remove/force
  346. # Add or remove space between the user function name and '(' on function calls
  347. # You need to set a keyword to be a user function, like this: 'set func_call_user _' in the config file.
  348. sp_func_call_user_paren = remove # ignore/add/remove/force
  349. # Add or remove space between a constructor/destructor and the open paren
  350. sp_func_class_paren = remove # ignore/add/remove/force
  351. # Add or remove space between 'return' and '('
  352. sp_return_paren = add # ignore/add/remove/force
  353. # Add or remove space between '__attribute__' and '('
  354. sp_attribute_paren = remove # ignore/add/remove/force
  355. # Add or remove space between 'defined' and '(' in '#if defined (FOO)'
  356. sp_defined_paren = remove # ignore/add/remove/force
  357. # Add or remove space between 'throw' and '(' in 'throw (something)'
  358. sp_throw_paren = remove # ignore/add/remove/force
  359. # Add or remove space between 'throw' and anything other than '(' as in '@throw [...];'
  360. sp_after_throw = ignore # ignore/add/remove/force
  361. # Add or remove space between 'catch' and '(' in 'catch (something) { }'
  362. # If set to ignore, sp_before_sparen is used.
  363. sp_catch_paren = ignore # ignore/add/remove/force
  364. # Add or remove space between 'version' and '(' in 'version (something) { }' (D language)
  365. # If set to ignore, sp_before_sparen is used.
  366. sp_version_paren = ignore # ignore/add/remove/force
  367. # Add or remove space between 'scope' and '(' in 'scope (something) { }' (D language)
  368. # If set to ignore, sp_before_sparen is used.
  369. sp_scope_paren = ignore # ignore/add/remove/force
  370. # Add or remove space between macro and value
  371. sp_macro = add # ignore/add/remove/force
  372. # Add or remove space between macro function ')' and value
  373. sp_macro_func = remove # ignore/add/remove/force
  374. # Add or remove space between 'else' and '{' if on the same line
  375. sp_else_brace = add # ignore/add/remove/force
  376. # Add or remove space between '}' and 'else' if on the same line
  377. sp_brace_else = add # ignore/add/remove/force
  378. # Add or remove space between '}' and the name of a typedef on the same line
  379. sp_brace_typedef = add # ignore/add/remove/force
  380. # Add or remove space between 'catch' and '{' if on the same line
  381. sp_catch_brace = add # ignore/add/remove/force
  382. # Add or remove space between '}' and 'catch' if on the same line
  383. sp_brace_catch = add # ignore/add/remove/force
  384. # Add or remove space between 'finally' and '{' if on the same line
  385. sp_finally_brace = add # ignore/add/remove/force
  386. # Add or remove space between '}' and 'finally' if on the same line
  387. sp_brace_finally = add # ignore/add/remove/force
  388. # Add or remove space between 'try' and '{' if on the same line
  389. sp_try_brace = add # ignore/add/remove/force
  390. # Add or remove space between get/set and '{' if on the same line
  391. sp_getset_brace = add # ignore/add/remove/force
  392. # Add or remove space before the '::' operator
  393. sp_before_dc = remove # ignore/add/remove/force
  394. # Add or remove space after the '::' operator
  395. sp_after_dc = remove # ignore/add/remove/force
  396. # Add or remove around the D named array initializer ':' operator
  397. sp_d_array_colon = ignore # ignore/add/remove/force
  398. # Add or remove space after the '!' (not) operator. Default=Remove
  399. sp_not = remove # ignore/add/remove/force
  400. # Add or remove space after the '~' (invert) operator. Default=Remove
  401. sp_inv = remove # ignore/add/remove/force
  402. # Add or remove space after the '&' (address-of) operator. Default=Remove
  403. # This does not affect the spacing after a '&' that is part of a type.
  404. sp_addr = remove # ignore/add/remove/force
  405. # Add or remove space around the '.' or '->' operators. Default=Remove
  406. sp_member = remove # ignore/add/remove/force
  407. # Add or remove space after the '*' (dereference) operator. Default=Remove
  408. # This does not affect the spacing after a '*' that is part of a type.
  409. sp_deref = remove # ignore/add/remove/force
  410. # Add or remove space after '+' or '-', as in 'x = -5' or 'y = +7'. Default=Remove
  411. sp_sign = remove # ignore/add/remove/force
  412. # Add or remove space before or after '++' and '--', as in '(--x)' or 'y++;'. Default=Remove
  413. sp_incdec = remove # ignore/add/remove/force
  414. # Add or remove space before a backslash-newline at the end of a line. Default=Add
  415. sp_before_nl_cont = remove # ignore/add/remove/force
  416. # Add or remove space after the scope '+' or '-', as in '-(void) foo;' or '+(int) bar;'
  417. sp_after_oc_scope = remove # ignore/add/remove/force
  418. # Add or remove space after the colon in message specs
  419. # '-(int) f:(int) x;' vs '-(int) f: (int) x;'
  420. sp_after_oc_colon = remove # ignore/add/remove/force
  421. # Add or remove space before the colon in message specs
  422. # '-(int) f: (int) x;' vs '-(int) f : (int) x;'
  423. sp_before_oc_colon = remove # ignore/add/remove/force
  424. # Add or remove space after the colon in immutable dictionary expression
  425. # 'NSDictionary *test = @{@"foo" :@"bar"};'
  426. sp_after_oc_dict_colon = ignore # ignore/add/remove/force
  427. # Add or remove space before the colon in immutable dictionary expression
  428. # 'NSDictionary *test = @{@"foo" :@"bar"};'
  429. sp_before_oc_dict_colon = ignore # ignore/add/remove/force
  430. # Add or remove space after the colon in message specs
  431. # '[object setValue:1];' vs '[object setValue: 1];'
  432. sp_after_send_oc_colon = add # ignore/add/remove/force
  433. # Add or remove space before the colon in message specs
  434. # '[object setValue:1];' vs '[object setValue :1];'
  435. sp_before_send_oc_colon = remove # ignore/add/remove/force
  436. # Add or remove space after the (type) in message specs
  437. # '-(int)f: (int) x;' vs '-(int)f: (int)x;'
  438. sp_after_oc_type = remove # ignore/add/remove/force
  439. # Add or remove space after the first (type) in message specs
  440. # '-(int) f:(int)x;' vs '-(int)f:(int)x;'
  441. sp_after_oc_return_type = ignore # ignore/add/remove/force
  442. # Add or remove space between '@selector' and '('
  443. # '@selector(msgName)' vs '@selector (msgName)'
  444. # Also applies to @protocol() constructs
  445. sp_after_oc_at_sel = ignore # ignore/add/remove/force
  446. # Add or remove space between '@selector(x)' and the following word
  447. # '@selector(foo) a:' vs '@selector(foo)a:'
  448. sp_after_oc_at_sel_parens = ignore # ignore/add/remove/force
  449. # Add or remove space inside '@selector' parens
  450. # '@selector(foo)' vs '@selector( foo )'
  451. # Also applies to @protocol() constructs
  452. sp_inside_oc_at_sel_parens = ignore # ignore/add/remove/force
  453. # Add or remove space before a block pointer caret
  454. # '^int (int arg){...}' vs. ' ^int (int arg){...}'
  455. sp_before_oc_block_caret = ignore # ignore/add/remove/force
  456. # Add or remove space after a block pointer caret
  457. # '^int (int arg){...}' vs. '^ int (int arg){...}'
  458. sp_after_oc_block_caret = ignore # ignore/add/remove/force
  459. # Add or remove space between the receiver and selector in a message.
  460. # '[receiver selector ...]'
  461. sp_after_oc_msg_receiver = ignore # ignore/add/remove/force
  462. # Add or remove space after @property.
  463. sp_after_oc_property = ignore # ignore/add/remove/force
  464. # Add or remove space around the ':' in 'b ? t : f'
  465. sp_cond_colon = add # ignore/add/remove/force
  466. # Add or remove space around the '?' in 'b ? t : f'
  467. sp_cond_question = add # ignore/add/remove/force
  468. # Fix the spacing between 'case' and the label. Only 'ignore' and 'force' make sense here.
  469. sp_case_label = ignore # ignore/add/remove/force
  470. # Control the space around the D '..' operator.
  471. sp_range = ignore # ignore/add/remove/force
  472. # Control the spacing after ':' in 'for (TYPE VAR : EXPR)' (Java)
  473. sp_after_for_colon = ignore # ignore/add/remove/force
  474. # Control the spacing before ':' in 'for (TYPE VAR : EXPR)' (Java)
  475. sp_before_for_colon = ignore # ignore/add/remove/force
  476. # Control the spacing in 'extern (C)' (D)
  477. sp_extern_paren = ignore # ignore/add/remove/force
  478. # Control the space after the opening of a C++ comment '// A' vs '//A'
  479. sp_cmt_cpp_start = add # ignore/add/remove/force
  480. # Controls the spaces between #else or #endif and a trailing comment
  481. sp_endif_cmt = ignore # ignore/add/remove/force
  482. # Controls the spaces after 'new', 'delete', and 'delete[]'
  483. sp_after_new = ignore # ignore/add/remove/force
  484. # Controls the spaces before a trailing or embedded comment
  485. sp_before_tr_emb_cmt = ignore # ignore/add/remove/force
  486. # Number of spaces before a trailing or embedded comment
  487. sp_num_before_tr_emb_cmt = 0 # number
  488. # Control space between a Java annotation and the open paren.
  489. sp_annotation_paren = ignore # ignore/add/remove/force
  490. #
  491. # Code alignment (not left column spaces/tabs)
  492. #
  493. # Whether to keep non-indenting tabs
  494. align_keep_tabs = false # false/true
  495. # Whether to use tabs for aligning
  496. align_with_tabs = false # false/true
  497. # Whether to bump out to the next tab when aligning
  498. align_on_tabstop = false # false/true
  499. # Whether to left-align numbers
  500. align_number_left = false # false/true
  501. # Align variable definitions in prototypes and functions
  502. align_func_params = true # false/true
  503. # Align parameters in single-line functions that have the same name.
  504. # The function names must already be aligned with each other.
  505. align_same_func_call_params = true # false/true
  506. # The span for aligning variable definitions (0=don't align)
  507. align_var_def_span = 0 # number
  508. # How to align the star in variable definitions.
  509. # 0=Part of the type 'void * foo;'
  510. # 1=Part of the variable 'void *foo;'
  511. # 2=Dangling 'void *foo;'
  512. align_var_def_star_style = 1 # number
  513. # How to align the '&' in variable definitions.
  514. # 0=Part of the type
  515. # 1=Part of the variable
  516. # 2=Dangling
  517. align_var_def_amp_style = 2 # number
  518. # The threshold for aligning variable definitions (0=no limit)
  519. align_var_def_thresh = 3 # number
  520. # The gap for aligning variable definitions
  521. align_var_def_gap = 1 # number
  522. # Whether to align the colon in struct bit fields
  523. align_var_def_colon = true # false/true
  524. # Whether to align any attribute after the variable name
  525. align_var_def_attribute = true # false/true
  526. # Whether to align inline struct/enum/union variable definitions
  527. align_var_def_inline = true # false/true
  528. # The span for aligning on '=' in assignments (0=don't align)
  529. align_assign_span = 0 # number
  530. # The threshold for aligning on '=' in assignments (0=no limit)
  531. align_assign_thresh = 0 # number
  532. # The span for aligning on '=' in enums (0=don't align)
  533. align_enum_equ_span = 0 # number
  534. # The threshold for aligning on '=' in enums (0=no limit)
  535. align_enum_equ_thresh = 0 # number
  536. # The span for aligning struct/union (0=don't align)
  537. align_var_struct_span = 0 # number
  538. # The threshold for aligning struct/union member definitions (0=no limit)
  539. align_var_struct_thresh = 0 # number
  540. # The gap for aligning struct/union member definitions
  541. align_var_struct_gap = 0 # number
  542. # The span for aligning struct initializer values (0=don't align)
  543. align_struct_init_span = 0 # number
  544. # The minimum space between the type and the synonym of a typedef
  545. align_typedef_gap = 0 # number
  546. # The span for aligning single-line typedefs (0=don't align)
  547. align_typedef_span = 0 # number
  548. # How to align typedef'd functions with other typedefs
  549. # 0: Don't mix them at all
  550. # 1: align the open paren with the types
  551. # 2: align the function type name with the other type names
  552. align_typedef_func = 0 # number
  553. # Controls the positioning of the '*' in typedefs. Just try it.
  554. # 0: Align on typedef type, ignore '*'
  555. # 1: The '*' is part of type name: typedef int *pint;
  556. # 2: The '*' is part of the type, but dangling: typedef int *pint;
  557. align_typedef_star_style = 2 # number
  558. # Controls the positioning of the '&' in typedefs. Just try it.
  559. # 0: Align on typedef type, ignore '&'
  560. # 1: The '&' is part of type name: typedef int &pint;
  561. # 2: The '&' is part of the type, but dangling: typedef int &pint;
  562. align_typedef_amp_style = 2 # number
  563. # The span for aligning comments that end lines (0=don't align)
  564. align_right_cmt_span = 4 # number
  565. # If aligning comments, mix with comments after '}' and #endif with less than 3 spaces before the comment
  566. align_right_cmt_mix = false # false/true
  567. # If a trailing comment is more than this number of columns away from the text it follows,
  568. # it will qualify for being aligned. This has to be > 0 to do anything.
  569. align_right_cmt_gap = 0 # number
  570. # Align trailing comment at or beyond column N; 'pulls in' comments as a bonus side effect (0=ignore)
  571. align_right_cmt_at_col = 1 # number
  572. # The span for aligning function prototypes (0=don't align)
  573. align_func_proto_span = 0 # number
  574. # Minimum gap between the return type and the function name.
  575. align_func_proto_gap = 0 # number
  576. # Align function protos on the 'operator' keyword instead of what follows
  577. align_on_operator = true # false/true
  578. # Whether to mix aligning prototype and variable declarations.
  579. # If true, align_var_def_XXX options are used instead of align_func_proto_XXX options.
  580. align_mix_var_proto = false # false/true
  581. # Align single-line functions with function prototypes, uses align_func_proto_span
  582. align_single_line_func = true # false/true
  583. # Aligning the open brace of single-line functions.
  584. # Requires align_single_line_func=true, uses align_func_proto_span
  585. align_single_line_brace = true # false/true
  586. # Gap for align_single_line_brace.
  587. align_single_line_brace_gap = 0 # number
  588. # The span for aligning ObjC msg spec (0=don't align)
  589. align_oc_msg_spec_span = 0 # number
  590. # Whether to align macros wrapped with a backslash and a newline.
  591. # This will not work right if the macro contains a multi-line comment.
  592. align_nl_cont = true # false/true
  593. # # Align macro functions and variables together
  594. align_pp_define_together = false # false/true
  595. # The minimum space between label and value of a preprocessor define
  596. align_pp_define_gap = 0 # number
  597. # The span for aligning on '#define' bodies (0=don't align)
  598. align_pp_define_span = 0 # number
  599. # Align lines that start with '<<' with previous '<<'. Default=true
  600. align_left_shift = true # false/true
  601. # Span for aligning parameters in an Obj-C message call on the ':' (0=don't align)
  602. align_oc_msg_colon_span = 0 # number
  603. # If true, always align with the first parameter, even if it is too short.
  604. align_oc_msg_colon_first = false # false/true
  605. # Aligning parameters in an Obj-C '+' or '-' declaration on the ':'
  606. align_oc_decl_colon = false # false/true
  607. #
  608. # Newline adding and removing options
  609. #
  610. # Whether to collapse empty blocks between '{' and '}'
  611. nl_collapse_empty_body = true # false/true
  612. # Don't split one-line braced assignments - 'foo_t f = { 1, 2 };'
  613. nl_assign_leave_one_liners = false # false/true
  614. # Don't split one-line braced statements inside a class xx { } body
  615. nl_class_leave_one_liners = false # false/true
  616. # Don't split one-line enums: 'enum foo { BAR = 15 };'
  617. nl_enum_leave_one_liners = false # false/true
  618. # Don't split one-line get or set functions
  619. nl_getset_leave_one_liners = false # false/true
  620. # Don't split one-line function definitions - 'int foo() { return 0; }'
  621. nl_func_leave_one_liners = false # false/true
  622. # Don't split one-line if/else statements - 'if(a) b++;'
  623. nl_if_leave_one_liners = true # false/true
  624. # Don't split one-line OC messages
  625. nl_oc_msg_leave_one_liner = false # false/true
  626. # Add or remove newlines at the start of the file
  627. nl_start_of_file = ignore # ignore/add/remove/force
  628. # The number of newlines at the start of the file (only used if nl_start_of_file is 'add' or 'force'
  629. nl_start_of_file_min = 0 # number
  630. # Add or remove newline at the end of the file
  631. nl_end_of_file = add # ignore/add/remove/force
  632. # The number of newlines at the end of the file (only used if nl_end_of_file is 'add' or 'force')
  633. nl_end_of_file_min = 1 # number
  634. # Add or remove newline between '=' and '{'
  635. nl_assign_brace = ignore # ignore/add/remove/force
  636. # Add or remove newline between '=' and '[' (D only)
  637. nl_assign_square = ignore # ignore/add/remove/force
  638. # Add or remove newline after '= [' (D only). Will also affect the newline before the ']'
  639. nl_after_square_assign = ignore # ignore/add/remove/force
  640. # The number of blank lines after a block of variable definitions at the top of a function body
  641. # 0 = No change (default)
  642. nl_func_var_def_blk = 1 # number
  643. # The number of newlines before a block of typedefs
  644. # 0 = No change (default)
  645. nl_typedef_blk_start = 0 # number
  646. # The number of newlines after a block of typedefs
  647. # 0 = No change (default)
  648. nl_typedef_blk_end = 0 # number
  649. # The maximum consecutive newlines within a block of typedefs
  650. # 0 = No change (default)
  651. nl_typedef_blk_in = 0 # number
  652. # The number of newlines before a block of variable definitions not at the top of a function body
  653. # 0 = No change (default)
  654. nl_var_def_blk_start = 0 # number
  655. # The number of newlines after a block of variable definitions not at the top of a function body
  656. # 0 = No change (default)
  657. nl_var_def_blk_end = 0 # number
  658. # The maximum consecutive newlines within a block of variable definitions
  659. # 0 = No change (default)
  660. nl_var_def_blk_in = 0 # number
  661. # Add or remove newline between a function call's ')' and '{', as in:
  662. # list_for_each(item, &list) { }
  663. nl_fcall_brace = ignore # ignore/add/remove/force
  664. # Add or remove newline between 'enum' and '{'
  665. nl_enum_brace = ignore # ignore/add/remove/force
  666. # Add or remove newline between 'struct and '{'
  667. nl_struct_brace = ignore # ignore/add/remove/force
  668. # Add or remove newline between 'union' and '{'
  669. nl_union_brace = ignore # ignore/add/remove/force
  670. # Add or remove newline between 'if' and '{'
  671. nl_if_brace = ignore # ignore/add/remove/force
  672. # Add or remove newline between '}' and 'else'
  673. nl_brace_else = remove # ignore/add/remove/force
  674. # Add or remove newline between 'else if' and '{'
  675. # If set to ignore, nl_if_brace is used instead
  676. nl_elseif_brace = ignore # ignore/add/remove/force
  677. # Add or remove newline between 'else' and '{'
  678. nl_else_brace = ignore # ignore/add/remove/force
  679. # Add or remove newline between 'else' and 'if'
  680. nl_else_if = ignore # ignore/add/remove/force
  681. # Add or remove newline between '}' and 'finally'
  682. nl_brace_finally = ignore # ignore/add/remove/force
  683. # Add or remove newline between 'finally' and '{'
  684. nl_finally_brace = ignore # ignore/add/remove/force
  685. # Add or remove newline between 'try' and '{'
  686. nl_try_brace = ignore # ignore/add/remove/force
  687. # Add or remove newline between get/set and '{'
  688. nl_getset_brace = ignore # ignore/add/remove/force
  689. # Add or remove newline between 'for' and '{'
  690. nl_for_brace = ignore # ignore/add/remove/force
  691. # Add or remove newline between 'catch' and '{'
  692. nl_catch_brace = ignore # ignore/add/remove/force
  693. # Add or remove newline between '}' and 'catch'
  694. nl_brace_catch = ignore # ignore/add/remove/force
  695. # Add or remove newline between 'while' and '{'
  696. nl_while_brace = ignore # ignore/add/remove/force
  697. # Add or remove newline between 'scope (x)' and '{' (D)
  698. nl_scope_brace = ignore # ignore/add/remove/force
  699. # Add or remove newline between 'unittest' and '{' (D)
  700. nl_unittest_brace = ignore # ignore/add/remove/force
  701. # Add or remove newline between 'version (x)' and '{' (D)
  702. nl_version_brace = ignore # ignore/add/remove/force
  703. # Add or remove newline between 'using' and '{'
  704. nl_using_brace = ignore # ignore/add/remove/force
  705. # Add or remove newline between two open or close braces.
  706. # Due to general newline/brace handling, REMOVE may not work.
  707. nl_brace_brace = ignore # ignore/add/remove/force
  708. # Add or remove newline between 'do' and '{'
  709. nl_do_brace = ignore # ignore/add/remove/force
  710. # Add or remove newline between '}' and 'while' of 'do' statement
  711. nl_brace_while = ignore # ignore/add/remove/force
  712. # Add or remove newline between 'switch' and '{'
  713. nl_switch_brace = ignore # ignore/add/remove/force
  714. # Add a newline between ')' and '{' if the ')' is on a different line than the if/for/etc.
  715. # Overrides nl_for_brace, nl_if_brace, nl_switch_brace, nl_while_switch, and nl_catch_brace.
  716. nl_multi_line_cond = false # false/true
  717. # Force a newline in a define after the macro name for multi-line defines.
  718. nl_multi_line_define = false # false/true
  719. # Whether to put a newline before 'case' statement
  720. nl_before_case = true # false/true
  721. # Add or remove newline between ')' and 'throw'
  722. nl_before_throw = ignore # ignore/add/remove/force
  723. # Whether to put a newline after 'case' statement
  724. nl_after_case = true # false/true
  725. # Add or remove a newline between a case ':' and '{'. Overrides nl_after_case.
  726. nl_case_colon_brace = ignore # ignore/add/remove/force
  727. # Newline between namespace and {
  728. nl_namespace_brace = remove # ignore/add/remove/force
  729. # Add or remove newline between 'template<>' and whatever follows.
  730. nl_template_class = ignore # ignore/add/remove/force
  731. # Add or remove newline between 'class' and '{'
  732. nl_class_brace = remove # ignore/add/remove/force
  733. # Add or remove newline after each ',' in the constructor member initialization
  734. nl_class_init_args = add # ignore/add/remove/force
  735. # Add or remove newline between return type and function name in a function definition
  736. nl_func_type_name = ignore # ignore/add/remove/force
  737. # Add or remove newline between return type and function name inside a class {}
  738. # Uses nl_func_type_name or nl_func_proto_type_name if set to ignore.
  739. nl_func_type_name_class = ignore # ignore/add/remove/force
  740. # Add or remove newline between function scope and name in a definition
  741. # Controls the newline after '::' in 'void A::f() { }'
  742. nl_func_scope_name = ignore # ignore/add/remove/force
  743. # Add or remove newline between return type and function name in a prototype
  744. nl_func_proto_type_name = ignore # ignore/add/remove/force
  745. # Add or remove newline between a function name and the opening '('
  746. nl_func_paren = ignore # ignore/add/remove/force
  747. # Add or remove newline between a function name and the opening '(' in the definition
  748. nl_func_def_paren = ignore # ignore/add/remove/force
  749. # Add or remove newline after '(' in a function declaration
  750. nl_func_decl_start = ignore # ignore/add/remove/force
  751. # Add or remove newline after '(' in a function definition
  752. nl_func_def_start = ignore # ignore/add/remove/force
  753. # Overrides nl_func_decl_start when there is only one parameter.
  754. nl_func_decl_start_single = ignore # ignore/add/remove/force
  755. # Overrides nl_func_def_start when there is only one parameter.
  756. nl_func_def_start_single = ignore # ignore/add/remove/force
  757. # Add or remove newline after each ',' in a function declaration
  758. nl_func_decl_args = add # ignore/add/remove/force
  759. # Add or remove newline after each ',' in a function definition
  760. nl_func_def_args = ignore # ignore/add/remove/force
  761. # Add or remove newline before the ')' in a function declaration
  762. nl_func_decl_end = ignore # ignore/add/remove/force
  763. # Add or remove newline before the ')' in a function definition
  764. nl_func_def_end = ignore # ignore/add/remove/force
  765. # Overrides nl_func_decl_end when there is only one parameter.
  766. nl_func_decl_end_single = ignore # ignore/add/remove/force
  767. # Overrides nl_func_def_end when there is only one parameter.
  768. nl_func_def_end_single = ignore # ignore/add/remove/force
  769. # Add or remove newline between '()' in a function declaration.
  770. nl_func_decl_empty = ignore # ignore/add/remove/force
  771. # Add or remove newline between '()' in a function definition.
  772. nl_func_def_empty = ignore # ignore/add/remove/force
  773. # Whether to put each OC message parameter on a separate line
  774. # See nl_oc_msg_leave_one_liner
  775. nl_oc_msg_args = false # false/true
  776. # Add or remove newline between function signature and '{'
  777. nl_fdef_brace = ignore # ignore/add/remove/force
  778. # Add or remove a newline between the return keyword and return expression.
  779. nl_return_expr = ignore # ignore/add/remove/force
  780. # Whether to put a newline after semicolons, except in 'for' statements
  781. nl_after_semicolon = false # false/true
  782. # Whether to put a newline after brace open.
  783. # This also adds a newline before the matching brace close.
  784. nl_after_brace_open = false # false/true
  785. # If nl_after_brace_open and nl_after_brace_open_cmt are true, a newline is
  786. # placed between the open brace and a trailing single-line comment.
  787. nl_after_brace_open_cmt = false # false/true
  788. # Whether to put a newline after a virtual brace open with a non-empty body.
  789. # These occur in un-braced if/while/do/for statement bodies.
  790. nl_after_vbrace_open = false # false/true
  791. # Whether to put a newline after a virtual brace open with an empty body.
  792. # These occur in un-braced if/while/do/for statement bodies.
  793. nl_after_vbrace_open_empty = false # false/true
  794. # Whether to put a newline after a brace close.
  795. # Does not apply if followed by a necessary ';'.
  796. nl_after_brace_close = false # false/true
  797. # Whether to put a newline after a virtual brace close.
  798. # Would add a newline before return in: 'if (foo) a++; return;'
  799. nl_after_vbrace_close = false # false/true
  800. # Control the newline between the close brace and 'b' in: 'struct { int a; } b;'
  801. # Affects enums, unions, and structures. If set to ignore, uses nl_after_brace_close
  802. nl_brace_struct_var = ignore # ignore/add/remove/force
  803. # Whether to alter newlines in '#define' macros
  804. nl_define_macro = true # false/true
  805. # Whether to not put blanks after '#ifxx', '#elxx', or before '#endif'
  806. nl_squeeze_ifdef = false # false/true
  807. # Add or remove blank line before 'if'
  808. nl_before_if = add # ignore/add/remove/force
  809. # Add or remove blank line after 'if' statement
  810. nl_after_if = ignore # ignore/add/remove/force
  811. # Add or remove blank line before 'for'
  812. nl_before_for = add # ignore/add/remove/force
  813. # Add or remove blank line after 'for' statement
  814. nl_after_for = ignore # ignore/add/remove/force
  815. # Add or remove blank line before 'while'
  816. nl_before_while = add # ignore/add/remove/force
  817. # Add or remove blank line after 'while' statement
  818. nl_after_while = ignore # ignore/add/remove/force
  819. # Add or remove blank line before 'switch'
  820. nl_before_switch = add # ignore/add/remove/force
  821. # Add or remove blank line after 'switch' statement
  822. nl_after_switch = ignore # ignore/add/remove/force
  823. # Add or remove blank line before 'do'
  824. nl_before_do = add # ignore/add/remove/force
  825. # Add or remove blank line after 'do/while' statement
  826. nl_after_do = ignore # ignore/add/remove/force
  827. # Whether to double-space commented-entries in struct/enum
  828. nl_ds_struct_enum_cmt = true # false/true
  829. # Whether to double-space before the close brace of a struct/union/enum
  830. # (lower priority than 'eat_blanks_before_close_brace')
  831. nl_ds_struct_enum_close_brace = true # false/true
  832. # Add or remove a newline around a class colon.
  833. # Related to pos_class_colon, nl_class_init_args, and pos_comma.
  834. nl_class_colon = ignore # ignore/add/remove/force
  835. # Change simple unbraced if statements into a one-liner
  836. # 'if(b)\n i++;' => 'if(b) i++;'
  837. nl_create_if_one_liner = true # false/true
  838. # Change simple unbraced for statements into a one-liner
  839. # 'for (i=0;i<5;i++)\n foo(i);' => 'for (i=0;i<5;i++) foo(i);'
  840. nl_create_for_one_liner = true # false/true
  841. # Change simple unbraced while statements into a one-liner
  842. # 'while (i<5)\n foo(i++);' => 'while (i<5) foo(i++);'
  843. nl_create_while_one_liner = true # false/true
  844. #
  845. # Positioning options
  846. #
  847. # The position of arithmetic operators in wrapped expressions
  848. pos_arith = ignore # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force
  849. # The position of assignment in wrapped expressions.
  850. # Do not affect '=' followed by '{'
  851. pos_assign = ignore # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force
  852. # The position of boolean operators in wrapped expressions
  853. pos_bool = lead_break # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force
  854. # The position of comparison operators in wrapped expressions
  855. pos_compare = ignore # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force
  856. # The position of conditional (b ? t : f) operators in wrapped expressions
  857. pos_conditional = ignore # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force
  858. # The position of the comma in wrapped expressions
  859. pos_comma = ignore # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force
  860. # The position of the comma in the constructor initialization list
  861. pos_class_comma = ignore # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force
  862. # The position of colons between constructor and member initialization
  863. pos_class_colon = ignore # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force
  864. #
  865. # Line Splitting options
  866. #
  867. # Try to limit code width to N number of columns
  868. code_width = 80 # number
  869. # Whether to fully split long 'for' statements at semi-colons
  870. ls_for_split_full = false # false/true
  871. # Whether to fully split long function protos/calls at commas
  872. ls_func_split_full = true # false/true
  873. # Whether to split lines as close to code_width as possible and ignore some groupings
  874. ls_code_width = false # false/true
  875. #
  876. # Blank line options
  877. #
  878. # The maximum consecutive newlines
  879. nl_max = 3 # number
  880. # The number of newlines after a function prototype, if followed by another function prototype
  881. nl_after_func_proto = 0 # number
  882. # The number of newlines after a function prototype, if not followed by another function prototype
  883. nl_after_func_proto_group = 0 # number
  884. # The number of newlines after '}' of a multi-line function body
  885. nl_after_func_body = 2 # number
  886. # The number of newlines after '}' of a multi-line function body in a class declaration
  887. nl_after_func_body_class = 0 # number
  888. # The number of newlines after '}' of a single line function body
  889. nl_after_func_body_one_liner = 2 # number
  890. # The minimum number of newlines before a multi-line comment.
  891. # Doesn't apply if after a brace open or another multi-line comment.
  892. nl_before_block_comment = 2 # number
  893. # The minimum number of newlines before a single-line C comment.
  894. # Doesn't apply if after a brace open or other single-line C comments.
  895. nl_before_c_comment = 2 # number
  896. # The minimum number of newlines before a CPP comment.
  897. # Doesn't apply if after a brace open or other CPP comments.
  898. nl_before_cpp_comment = 2 # number
  899. # Whether to force a newline after a multi-line comment.
  900. nl_after_multiline_comment = true # false/true
  901. # The number of newlines after '}' or ';' of a struct/enum/union definition
  902. nl_after_struct = 0 # number
  903. # The number of newlines after '}' or ';' of a class definition
  904. nl_after_class = 0 # number
  905. # The number of newlines before a 'private:', 'public:', 'protected:', 'signals:', or 'slots:' label.
  906. # Will not change the newline count if after a brace open.
  907. # 0 = No change.
  908. nl_before_access_spec = 2 # number
  909. # The number of newlines after a 'private:', 'public:', 'protected:', 'signals:', or 'slots:' label.
  910. # 0 = No change.
  911. nl_after_access_spec = 2 # number
  912. # The number of newlines between a function def and the function comment.
  913. # 0 = No change.
  914. nl_comment_func_def = 1 # number
  915. # The number of newlines after a try-catch-finally block that isn't followed by a brace close.
  916. # 0 = No change.
  917. nl_after_try_catch_finally = 1 # number
  918. # The number of newlines before and after a property, indexer or event decl.
  919. # 0 = No change.
  920. nl_around_cs_property = 0 # number
  921. # The number of newlines between the get/set/add/remove handlers in C#.
  922. # 0 = No change.
  923. nl_between_get_set = 0 # number
  924. # Add or remove newline between C# property and the '{'
  925. nl_property_brace = ignore # ignore/add/remove/force
  926. # Whether to remove blank lines after '{'
  927. eat_blanks_after_open_brace = true # false/true
  928. # Whether to remove blank lines before '}'
  929. eat_blanks_before_close_brace = true # false/true
  930. # How aggressively to remove extra newlines not in preproc.
  931. # 0: No change
  932. # 1: Remove most newlines not handled by other config
  933. # 2: Remove all newlines and reformat completely by config
  934. nl_remove_extra_newlines = 0 # number
  935. # Whether to put a blank line before 'return' statements, unless after an open brace.
  936. nl_before_return = false # false/true
  937. # Whether to put a blank line after 'return' statements, unless followed by a close brace.
  938. nl_after_return = true # false/true
  939. # Whether to put a newline after a Java annotation statement.
  940. # Only affects annotations that are after a newline.
  941. nl_after_annotation = ignore # ignore/add/remove/force
  942. # Controls the newline between two annotations.
  943. nl_between_annotation = ignore # ignore/add/remove/force
  944. #
  945. # Code modifying options (non-whitespace)
  946. #
  947. # Add or remove braces on single-line 'do' statement
  948. mod_full_brace_do = add # ignore/add/remove/force
  949. # Add or remove braces on single-line 'for' statement
  950. mod_full_brace_for = add # ignore/add/remove/force
  951. # Add or remove braces on single-line function definitions. (Pawn)
  952. mod_full_brace_function = ignore # ignore/add/remove/force
  953. # Add or remove braces on single-line 'if' statement. Will not remove the braces if they contain an 'else'.
  954. mod_full_brace_if = add # ignore/add/remove/force
  955. # Make all if/elseif/else statements in a chain be braced or not. Overrides mod_full_brace_if.
  956. # If any must be braced, they are all braced. If all can be unbraced, then the braces are removed.
  957. mod_full_brace_if_chain = false # false/true
  958. # Don't remove braces around statements that span N newlines
  959. mod_full_brace_nl = 1 # number
  960. # Add or remove braces on single-line 'while' statement
  961. mod_full_brace_while = add # ignore/add/remove/force
  962. # Add or remove braces on single-line 'using ()' statement
  963. mod_full_brace_using = ignore # ignore/add/remove/force
  964. # Add or remove unnecessary paren on 'return' statement
  965. mod_paren_on_return = remove # ignore/add/remove/force
  966. # Whether to change optional semicolons to real semicolons
  967. mod_pawn_semicolon = false # false/true
  968. # Add parens on 'while' and 'if' statement around bools
  969. mod_full_paren_if_bool = true # false/true
  970. # Whether to remove superfluous semicolons
  971. mod_remove_extra_semicolon = true # false/true
  972. # If a function body exceeds the specified number of newlines and doesn't have a comment after
  973. # the close brace, a comment will be added.
  974. mod_add_long_function_closebrace_comment = 0 # number
  975. # If a switch body exceeds the specified number of newlines and doesn't have a comment after
  976. # the close brace, a comment will be added.
  977. mod_add_long_switch_closebrace_comment = 0 # number
  978. # If an #ifdef body exceeds the specified number of newlines and doesn't have a comment after
  979. # the #endif, a comment will be added.
  980. mod_add_long_ifdef_endif_comment = 1 # number
  981. # If an #ifdef or #else body exceeds the specified number of newlines and doesn't have a comment after
  982. # the #else, a comment will be added.
  983. mod_add_long_ifdef_else_comment = 1 # number
  984. # If TRUE, will sort consecutive single-line 'import' statements [Java, D]
  985. mod_sort_import = false # false/true
  986. # If TRUE, will sort consecutive single-line 'using' statements [C#]
  987. mod_sort_using = false # false/true
  988. # If TRUE, will sort consecutive single-line '#include' statements [C/C++] and '#import' statements [Obj-C]
  989. # This is generally a bad idea, as it may break your code.
  990. mod_sort_include = false # false/true
  991. # If TRUE, it will move a 'break' that appears after a fully braced 'case' before the close brace.
  992. mod_move_case_break = true # false/true
  993. # Will add or remove the braces around a fully braced case statement.
  994. # Will only remove the braces if there are no variable declarations in the block.
  995. mod_case_brace = ignore # ignore/add/remove/force
  996. # If TRUE, it will remove a void 'return;' that appears as the last statement in a function.
  997. mod_remove_empty_return = true # false/true
  998. #
  999. # Comment modifications
  1000. #
  1001. # Try to wrap comments at cmt_width columns
  1002. cmt_width = 80 # number
  1003. # Set the comment reflow mode (default: 0)
  1004. # 0: no reflowing (apart from the line wrapping due to cmt_width)
  1005. # 1: no touching at all
  1006. # 2: full reflow
  1007. cmt_reflow_mode = 0 # number
  1008. # If false, disable all multi-line comment changes, including cmt_width. keyword substitution, and leading chars.
  1009. # Default is true.
  1010. cmt_indent_multi = true # false/true
  1011. # Whether to group c-comments that look like they are in a block
  1012. cmt_c_group = false # false/true
  1013. # Whether to put an empty '/*' on the first line of the combined c-comment
  1014. cmt_c_nl_start = false # false/true
  1015. # Whether to put a newline before the closing '*/' of the combined c-comment
  1016. cmt_c_nl_end = false # false/true
  1017. # Whether to group cpp-comments that look like they are in a block
  1018. cmt_cpp_group = false # false/true
  1019. # Whether to put an empty '/*' on the first line of the combined cpp-comment
  1020. cmt_cpp_nl_start = false # false/true
  1021. # Whether to put a newline before the closing '*/' of the combined cpp-comment
  1022. cmt_cpp_nl_end = false # false/true
  1023. # Whether to change cpp-comments into c-comments
  1024. cmt_cpp_to_c = false # false/true
  1025. # Whether to put a star on subsequent comment lines
  1026. cmt_star_cont = false # false/true
  1027. # The number of spaces to insert at the start of subsequent comment lines
  1028. cmt_sp_before_star_cont = 0 # number
  1029. # The number of spaces to insert after the star on subsequent comment lines
  1030. cmt_sp_after_star_cont = 0 # number
  1031. # For multi-line comments with a '*' lead, remove leading spaces if the first and last lines of
  1032. # the comment are the same length. Default=True
  1033. cmt_multi_check_last = true # false/true
  1034. # The filename that contains text to insert at the head of a file if the file doesn't start with a C/C++ comment.
  1035. # Will substitute $(filename) with the current file's name.
  1036. cmt_insert_file_header = "" # string
  1037. # The filename that contains text to insert at the end of a file if the file doesn't end with a C/C++ comment.
  1038. # Will substitute $(filename) with the current file's name.
  1039. cmt_insert_file_footer = "" # string
  1040. # The filename that contains text to insert before a function implementation if the function isn't preceded with a C/C++ comment.
  1041. # Will substitute $(function) with the function name and $(javaparam) with the javadoc @param and @return stuff.
  1042. # Will also substitute $(fclass) with the class name: void CFoo::Bar() { ... }
  1043. cmt_insert_func_header = "" # string
  1044. # The filename that contains text to insert before a class if the class isn't preceded with a C/C++ comment.
  1045. # Will substitute $(class) with the class name.
  1046. cmt_insert_class_header = "" # string
  1047. # The filename that contains text to insert before an Obj-C message specification if the method isn't preceded with a C/C++ comment.
  1048. # Will substitute $(message) with the function name and $(javaparam) with the javadoc @param and @return stuff.
  1049. cmt_insert_oc_msg_header = "" # string
  1050. # If a preprocessor is encountered when stepping backwards from a function name, then
  1051. # this option decides whether the comment should be inserted.
  1052. # Affects cmt_insert_oc_msg_header, cmt_insert_func_header and cmt_insert_class_header.
  1053. cmt_insert_before_preproc = false # false/true
  1054. #
  1055. # Preprocessor options
  1056. #
  1057. # Control indent of preprocessors inside #if blocks at brace level 0
  1058. pp_indent = ignore # ignore/add/remove/force
  1059. # Whether to indent #if/#else/#endif at the brace level (true) or from column 1 (false)
  1060. pp_indent_at_level = false # false/true
  1061. # If pp_indent_at_level=false, specifies the number of columns to indent per level. Default=1.
  1062. pp_indent_count = 1 # number
  1063. # Add or remove space after # based on pp_level of #if blocks
  1064. pp_space = add # ignore/add/remove/force
  1065. # Sets the number of spaces added with pp_space
  1066. pp_space_count = 0 # number
  1067. # The indent for #region and #endregion in C# and '#pragma region' in C/C++
  1068. pp_indent_region = 0 # number
  1069. # Whether to indent the code between #region and #endregion
  1070. pp_region_indent_code = false # false/true
  1071. # If pp_indent_at_level=true, sets the indent for #if, #else, and #endif when not at file-level
  1072. pp_indent_if = 0 # number
  1073. # Control whether to indent the code between #if, #else and #endif when not at file-level
  1074. pp_if_indent_code = false # false/true
  1075. # Whether to indent '#define' at the brace level (true) or from column 1 (false)
  1076. pp_define_at_level = false # false/true
  1077. # You can force a token to be a type with the 'type' option.
  1078. # Example:
  1079. # type myfoo1 myfoo2
  1080. #
  1081. # You can create custom macro-based indentation using macro-open,
  1082. # macro-else and macro-close.
  1083. # Example:
  1084. # macro-open BEGIN_TEMPLATE_MESSAGE_MAP
  1085. # macro-open BEGIN_MESSAGE_MAP
  1086. # macro-close END_MESSAGE_MAP
  1087. #
  1088. # You can assign any keyword to any type with the set option.
  1089. # set func_call_user _ N_
  1090. #
  1091. # The full syntax description of all custom definition config entries
  1092. # is shown below:
  1093. #
  1094. # define custom tokens as:
  1095. # - embed whitespace in token using '' escape character, or
  1096. # put token in quotes
  1097. # - these: ' " and ` are recognized as quote delimiters
  1098. #
  1099. # type token1 token2 token3 ...
  1100. # ^ optionally specify multiple tokens on a single line
  1101. # define def_token output_token
  1102. # ^ output_token is optional, then NULL is assumed
  1103. # macro-open token
  1104. # macro-close token
  1105. # macro-else token
  1106. # set id token1 token2 ...
  1107. # ^ optionally specify multiple tokens on a single line
  1108. # ^ id is one of the names in token_enum.h sans the CT_ prefix,
  1109. # e.g. PP_PRAGMA
  1110. #
  1111. # all tokens are separated by any mix of ',' commas, '=' equal signs
  1112. # and whitespace (space, tab)
  1113. #