| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
align_asm_colon
Whether to align text after 'asm volatile ()' colons.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
true |
|
align_assign_decl_func
How to apply align_assign_span to function declaration "assignments", i.e.
'virtual void foo() = 0' or '~foo() = {default|delete}'.
0: Align with other assignments (default)
1: Align with each other, ignoring regular assignments
2: Don't align
Type: numeric [0 .. 2]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
align_assign_func_proto_span
The span for aligning on '=' in function prototype modifier.
0: Don't align (default).
Type: numeric [0 .. 5000]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
align_assign_on_multi_var_defs
Whether to align on the left most assignment when multiple
definitions are found on the same line.
Depends on 'align_assign_span' and 'align_assign_thresh' settings.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
align_assign_span
The span for aligning on '=' in assignments.
0: Don't align (default).
Type: numeric [0 .. 5000]
Default: 0
|
0
|
1 |
1 |
|
|
|
|
|
|
|
|
align_assign_thresh
The threshold for aligning on '=' in assignments.
Use a negative number for absolute thresholds.
0: No limit (default).
Type: numeric [-1000 .. 5000]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
12 |
align_braced_init_list_span
The span for aligning on '{' in braced init list.
0: Don't align (default).
Type: numeric [0 .. 5000]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
align_braced_init_list_thresh
The threshold for aligning on '{' in braced init list.
Use a negative number for absolute thresholds.
0: No limit (default).
Type: numeric [-1000 .. 5000]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
align_constr_value_gap
The gap for aligning constructor value.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
align_constr_value_span
The span for aligning constructor value.
0: Don't align (default).
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
align_constr_value_thresh
The threshold for aligning constructor value.
Use a negative number for absolute thresholds.
0: No limit (default).
Type: numeric [-1000 .. 5000]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
align_eigen_comma_init
Whether to align comma-separated statements following '<<' (as used to
initialize Eigen matrices).
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
align_enum_equ_span
The span for aligning on '=' in enums.
0: Don't align (default).
Type: numeric [0 .. 5000]
Default: 0
|
0
|
1 |
1 |
|
|
4 |
4 |
|
|
|
16 |
align_enum_equ_thresh
The threshold for aligning on '=' in enums.
Use a negative number for absolute thresholds.
0: no limit (default).
Type: numeric [-1000 .. 5000]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
align_func_params
Whether to align variable definitions in prototypes and functions.
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
|
|
true |
|
|
|
|
|
align_func_params_gap
The gap for aligning function parameter definitions.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
align_func_params_span
The span for aligning parameter definitions in function on parameter name.
0: Don't align (default).
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
align_func_params_thresh
The threshold for aligning function parameter definitions.
Use a negative number for absolute thresholds.
0: No limit (default).
Type: numeric [-1000 .. 5000]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
align_func_proto_amp_style
How to consider (or treat) the '&' in the alignment of function prototypes.
0: Part of the type 'long & foo();' (default)
1: Part of the function 'long &foo();'
2: Dangling 'long &foo();'
Dangling: the '&' will not be taken into account when aligning.
Type: numeric [0 .. 2]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
align_func_proto_gap
Minimum gap between the return type and the function name.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
align_func_proto_span
The span for aligning function prototypes.
0: Don't align (default).
Type: numeric [0 .. 5000]
Default: 0
|
0
|
3 |
3 |
|
|
|
|
|
|
|
|
align_func_proto_span_ignore_cont_lines
Whether to ignore continuation lines when evaluating the number of
new lines for the function prototype alignment's span.
false: continuation lines are part of the newlines count
true: continuation lines are not counted
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
align_func_proto_star_style
How to consider (or treat) the '*' in the alignment of function prototypes.
0: Part of the type 'void * foo();' (default)
1: Part of the function 'void *foo();'
2: Dangling 'void *foo();'
Dangling: the '*' will not be taken into account when aligning.
Type: numeric [0 .. 2]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
align_func_proto_thresh
The threshold for aligning function prototypes.
Use a negative number for absolute thresholds.
0: No limit (default).
Type: numeric [-1000 .. 5000]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
align_keep_extra_space
Whether to keep whitespace not required for alignment.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
align_keep_tabs
Whether to keep non-indenting tabs.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
align_left_shift
Whether to align lines that start with '<<' with previous '<<'.
Default: true
Type: boolean [false, true]
Default: true
|
true
|
|
|
|
|
|
|
|
|
false |
|
align_mix_var_proto
Whether to mix aligning prototype and variable declarations. If true,
align_var_def_XXX options are used instead of align_func_proto_XXX options.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
align_nl_cont
Whether and how to align backslashes that split a macro onto multiple lines.
This will not work right if the macro contains a multi-line comment.
0: Do nothing (default)
1: Align the backslashes in the column at the end of the longest line
2: Align with the backslash that is farthest to the left, or, if that
backslash is farther left than the end of the longest line, at the end of
the longest line
3: Align with the backslash that is farthest to the right
Type: numeric [0 .. 3]
Default: 0
|
0
|
true |
true |
false |
false |
|
|
|
|
|
1 |
align_nl_cont_spaces
The minimum number of spaces between the end of a line and its continuation
backslash. Requires align_nl_cont.
Default: 1
Type: numeric [0 .. 16]
Default: 1
|
1
|
|
|
|
|
|
|
|
|
|
|
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
align_number_right
Whether to right-align numbers.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
true |
true |
align_oc_decl_colon
(OC) Whether to align parameters in an Objective-C '+' or '-' declaration
on the ':'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
true |
|
|
|
|
|
|
align_oc_msg_colon_first
(OC) Whether to always align with the first parameter, even if it is too
short.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
align_oc_msg_colon_span
(OC) Span for aligning parameters in an Objective-C message call
on the ':'.
0: Don't align.
Type: numeric [0 .. 5000]
Default: 0
|
0
|
|
|
|
16 |
|
|
|
|
|
|
align_oc_msg_colon_xcode_like
(OC) Whether to not align parameters in an Objectve-C message call if first
colon is not on next line of the message call (the same way Xcode does
alignment)
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
align_oc_msg_spec_span
(OC) The span for aligning Objective-C message specifications.
0: Don't align (default).
Type: numeric [0 .. 5000]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
1 |
|
align_on_operator
Whether to align function prototypes on the 'operator' keyword instead of
what follows.
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
|
|
|
|
|
|
|
|
align_on_tabstop
Whether to bump out to the next tab when aligning.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
TRUE |
TRUE |
|
|
true |
true |
align_pp_define_gap
The minimum space between label and value of a preprocessor define.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
1 |
4 |
align_pp_define_span
The span for aligning on '#define' bodies.
=0: Don't align (default)
>0: Number of lines (including comments) between blocks
Type: numeric [0 .. 5000]
Default: 0
|
0
|
|
|
|
2 |
|
|
|
|
8 |
3 |
align_pp_define_together
Whether to align macro functions and variables together.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
true |
|
align_right_cmt_at_col
Minimum column at which to align trailing comments. Comments which are
aligned beyond this column, but which can be aligned in a lesser column,
may be "pulled in".
0: Ignore (default).
Type: numeric [0 .. 200]
Default: 0
|
0
|
1 |
1 |
|
|
|
|
|
|
41 |
|
align_right_cmt_gap
Minimum number of columns between preceding text and a trailing comment in
order for the comment to qualify for being aligned. Must be non-zero to have
an effect.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
1 |
|
align_right_cmt_mix
If aligning comments, whether to mix with comments after '}' and #endif with
less than three spaces before the comment.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
align_right_cmt_same_level
Whether to only align trailing comments that are at the same brace level.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
align_right_cmt_span
The span for aligning comments that end lines.
0: Don't align (default).
Type: numeric [0 .. 5000]
Default: 0
|
0
|
4 |
4 |
|
|
3 |
3 |
|
|
4 |
3 |
align_same_func_call_params
Whether to align parameters in single-line functions that have the same
name. The function names must already be aligned with each other.
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
|
|
|
|
|
|
|
|
align_same_func_call_params_span
The span for aligning function-call parameters for single line functions.
0: Don't align (default).
Type: numeric [0 .. 5000]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
align_same_func_call_params_thresh
The threshold for aligning function-call parameters for single line
functions.
Use a negative number for absolute thresholds.
0: No limit (default).
Type: numeric [-1000 .. 5000]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
align_single_line_brace
Whether to align the open brace of single-line functions.
Requires align_single_line_func=true. Uses align_func_proto_span.
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
|
|
|
|
|
|
|
|
align_single_line_brace_gap
Gap for align_single_line_brace.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
align_single_line_func
Whether to align single-line functions with function prototypes.
Uses align_func_proto_span.
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
|
|
|
|
|
|
true |
|
align_struct_init_span
The span for aligning struct initializer values.
0: Don't align (default).
Type: numeric [0 .. 5000]
Default: 0
|
0
|
1 |
1 |
|
2 |
3 |
3 |
|
|
|
3 |
align_typedef_amp_style
How to consider (or treat) the '&' in the alignment of typedefs.
0: Part of the typedef type, 'typedef int & intref;' (default)
1: Part of type name: 'typedef int &intref;'
2: Dangling: 'typedef int &intref;'
Dangling: the '&' will not be taken into account when aligning.
Type: numeric [0 .. 2]
Default: 0
|
0
|
2 |
2 |
|
|
|
|
|
|
1 |
|
align_typedef_func
How to align typedef'd functions with other typedefs.
0: Don't mix them at all (default)
1: Align the open parenthesis with the types
2: Align the function type name with the other type names
Type: numeric [0 .. 2]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
align_typedef_gap
The minimum space between the type and the synonym of a typedef.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
1 |
3 |
align_typedef_span
The span for aligning single-line typedefs.
0: Don't align (default).
Type: numeric [0 .. 16]
Default: 0
|
0
|
1 |
1 |
|
|
|
|
|
|
|
5 |
align_typedef_star_style
How to consider (or treat) the '*' in the alignment of typedefs.
0: Part of the typedef type, 'typedef int * pint;' (default)
1: Part of type name: 'typedef int *pint;'
2: Dangling: 'typedef int *pint;'
Dangling: the '*' will not be taken into account when aligning.
Type: numeric [0 .. 2]
Default: 0
|
0
|
2 |
2 |
|
|
|
|
|
|
1 |
|
align_var_class_gap
The gap for aligning class member definitions.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
align_var_class_span
The span for aligning class member definitions.
0: Don't align (default).
Type: numeric [0 .. 5000]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
align_var_class_thresh
The threshold for aligning class member definitions.
Use a negative number for absolute thresholds.
0: No limit (default).
Type: numeric [-1000 .. 5000]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
align_var_def_amp_style
How to consider (or treat) the '&' in the alignment of variable definitions.
0: Part of the type 'long & foo;' (default)
1: Part of the variable 'long &foo;'
2: Dangling 'long &foo;'
Dangling: the '&' will not be taken into account when aligning.
Type: numeric [0 .. 2]
Default: 0
|
0
|
2 |
2 |
|
|
|
|
|
|
1 |
|
align_var_def_attribute
Whether to align any attribute after the variable name.
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
|
true |
|
|
|
|
|
|
align_var_def_colon
Whether to align the colon in struct bit fields.
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
|
true |
|
|
|
|
|
|
align_var_def_colon_gap
The gap for aligning the colon in struct bit fields.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
align_var_def_gap
The gap for aligning variable definitions.
Type: numeric [0 .. 16]
Default: 0
|
0
|
1 |
1 |
|
|
|
|
|
|
|
|
align_var_def_inline
Whether to align inline struct/enum/union variable definitions.
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
|
true |
|
|
|
|
|
|
align_var_def_span
The span for aligning variable definitions.
0: Don't align (default).
Type: numeric [0 .. 5000]
Default: 0
|
0
|
1 |
1 |
|
|
|
|
|
|
|
|
align_var_def_star_style
How to consider (or treat) the '*' in the alignment of variable definitions.
0: Part of the type 'void * foo;' (default)
1: Part of the variable 'void *foo;'
2: Dangling 'void *foo;'
Dangling: the '*' will not be taken into account when aligning.
Type: numeric [0 .. 2]
Default: 0
|
0
|
2 |
2 |
|
|
|
|
|
|
1 |
|
align_var_def_thresh
The threshold for aligning variable definitions.
Use a negative number for absolute thresholds.
0: No limit (default).
Type: numeric [-1000 .. 5000]
Default: 0
|
0
|
3 |
3 |
|
|
|
|
|
|
10 |
|
align_var_struct_gap
The gap for aligning struct/union member definitions.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
align_var_struct_span
The span for aligning struct/union member definitions.
0: Don't align (default).
Type: numeric [0 .. 5000]
Default: 0
|
0
|
1 |
1 |
|
|
6 |
|
|
|
|
99 |
align_var_struct_thresh
The threshold for aligning struct/union member definitions.
Use a negative number for absolute thresholds.
0: No limit (default).
Type: numeric [-1000 .. 5000]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
align_with_tabs
Whether to use tabs for aligning.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
TRUE |
TRUE |
|
|
true |
true |
cmt_align_doxygen_javadoc_tags
Whether to align doxygen javadoc-style tags ('@param', '@return', etc.)
and corresponding fields such that groups of consecutive block tags,
parameter names, and descriptions align with one another. Overrides that
which is specified by the cmt_sp_after_star_cont. If cmt_width > 0, it may
be necessary to enable cmt_indent_multi and set cmt_reflow_mode = 2
in order to achieve the desired alignment for line-wrapping.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
cmt_c_group
Whether to group c-comments that look like they are in a block.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
true |
|
cmt_c_nl_end
Whether to add a newline before the closing '*/' of the combined c-comment.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
true |
|
cmt_c_nl_start
Whether to put an empty '/*' on the first line of the combined c-comment.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
true |
|
cmt_convert_tab_to_spaces
Whether to convert all tabs to spaces in comments. If false, tabs in
comments are left alone, unless used for indenting.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
cmt_cpp_group
Whether to group cpp-comments that look like they are in a block. Only
meaningful if cmt_cpp_to_c=true.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
true |
|
cmt_cpp_nl_end
Whether to add a newline before the closing '*/' of the combined cpp-comment
when converting to a c-comment.
Requires cmt_cpp_to_c=true and cmt_cpp_group=true.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
true |
|
cmt_cpp_nl_start
Whether to put an empty '/*' on the first line of the combined cpp-comment
when converting to a c-comment.
Requires cmt_cpp_to_c=true and cmt_cpp_group=true.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
true |
|
cmt_cpp_to_c
Whether to change cpp-comments into c-comments.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
true |
|
|
|
|
|
|
cmt_indent_multi
Whether to apply changes to multi-line comments, including cmt_width,
keyword substitution and leading chars.
Default: true
Type: boolean [false, true]
Default: true
|
true
|
|
|
false |
|
|
|
|
|
|
|
cmt_insert_before_ctor_dtor
Whether a comment should be inserted if the function is a class constructor
or destructor.
Applies to cmt_insert_func_header.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
cmt_insert_before_inlines
Whether a comment should be inserted if a function is declared inline to a
class definition.
Applies to cmt_insert_func_header.
Default: true
Type: boolean [false, true]
Default: true
|
true
|
|
|
|
|
|
|
|
|
|
|
cmt_insert_before_preproc
Whether a comment should be inserted if a preprocessor is encountered when
stepping backwards from a function name.
Applies to cmt_insert_oc_msg_header, cmt_insert_func_header and
cmt_insert_class_header.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
cmt_insert_class_header
Path to a file that contains text to insert before a class if the class
isn't preceded by a C/C++ comment. If the inserted text contains '$(class)',
that will be replaced with the class name.
Type: string
Default:
|
|
|
|
|
|
|
|
|
|
|
|
cmt_insert_file_footer
Path to a file that contains text to insert at the end of a file if the
file doesn't end with a C/C++ comment. If the inserted text contains
'$(filename)', that will be replaced with the current file's name.
Type: string
Default:
|
|
|
|
|
|
|
|
|
|
|
|
cmt_insert_file_header
Path to a file that contains text to insert at the beginning of a file if
the file doesn't start with a C/C++ comment. If the inserted text contains
'$(filename)', that will be replaced with the current file's name.
Type: string
Default:
|
|
|
|
|
|
|
|
|
|
|
|
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
cmt_insert_func_header
Path to a file that contains text to insert before a function definition if
the function isn't preceded by a C/C++ comment. If the inserted text
contains '$(function)', '$(javaparam)' or '$(fclass)', these will be
replaced with, respectively, the name of the function, the javadoc '@param'
and '@return' stuff, or the name of the class to which the member function
belongs.
Type: string
Default:
|
|
|
|
|
|
|
|
|
|
|
|
cmt_insert_oc_msg_header
Path to a file that contains text to insert before an Objective-C message
specification, if the method isn't preceded by a C/C++ comment. If the
inserted text contains '$(message)' or '$(javaparam)', these will be
replaced with, respectively, the name of the function, or the javadoc
'@param' and '@return' stuff.
Type: string
Default:
|
|
|
|
|
|
|
|
|
|
|
|
cmt_multi_check_last
For multi-line comments with a '*' lead, remove leading spaces if the first
and last lines of the comment are the same length.
Default: true
Type: boolean [false, true]
Default: true
|
true
|
|
|
|
|
|
|
|
|
false |
|
cmt_multi_first_len_minimum
For multi-line comments with a '*' lead, remove leading spaces if the first
and last lines of the comment are the same length AND if the length is
bigger as the first_len minimum.
Default: 4
Type: numeric [1 .. 20]
Default: 4
|
4
|
|
|
|
|
|
|
|
|
|
|
cmt_reflow_fold_regex_file
Path to a file that contains regular expressions describing patterns for
which the end of one line and the beginning of the next will be folded into
the same sentence or paragraph during full comment reflow. The regular
expressions are described using ECMAScript syntax. The syntax for this
specification is as follows, where "..." indicates the custom regular
expression and "n" indicates the nth end_of_prev_line_regex and
beg_of_next_line_regex regular expression pair:
end_of_prev_line_regex[1] = "...$"
beg_of_next_line_regex[1] = "^..."
end_of_prev_line_regex[2] = "...$"
beg_of_next_line_regex[2] = "^..."
.
.
.
end_of_prev_line_regex[n] = "...$"
beg_of_next_line_regex[n] = "^..."
Note that use of this option overrides the default reflow fold regular
expressions, which are internally defined as follows:
end_of_prev_line_regex[1] = "[\w,\]\)]$"
beg_of_next_line_regex[1] = "^[\w,\[\(]"
end_of_prev_line_regex[2] = "\.$"
beg_of_next_line_regex[2] = "^[A-Z]"
Type: string
Default:
|
|
|
|
|
|
|
|
|
|
|
|
cmt_reflow_indent_to_paragraph_start
Whether to indent wrapped lines to the start of the encompassing paragraph
during full comment reflow (cmt_reflow_mode = 2). Overrides the value
specified by cmt_sp_after_star_cont.
Note that cmt_align_doxygen_javadoc_tags overrides this option for
paragraphs associated with javadoc tags
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
cmt_reflow_mode
How to reflow comments.
0: No reflowing (apart from the line wrapping due to cmt_width) (default)
1: No touching at all
2: Full reflow (enable cmt_indent_multi for indent with line wrapping due to cmt_width)
Type: numeric [0 .. 2]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
1 |
|
cmt_sp_after_star_cont
The number of spaces to insert after the star on subsequent comment lines.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
cmt_sp_before_doxygen_javadoc_tags
The number of spaces to insert after the star and before doxygen
javadoc-style tags (@param, @return, etc). Requires enabling
cmt_align_doxygen_javadoc_tags. Overrides that which is specified by the
cmt_sp_after_star_cont.
Default: 1
Type: numeric [0 .. 16]
Default: 1
|
1
|
|
|
|
|
|
|
|
|
|
|
cmt_sp_before_star_cont
The number of spaces to insert at the start of subsequent comment lines.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
cmt_star_cont
Whether to put a star on subsequent comment lines.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
true |
true |
|
|
|
true |
true |
cmt_trailing_single_line_c_to_cpp
Whether to change trailing, single-line c-comments into cpp-comments.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
cmt_width
Try to wrap comments at N columns.
Type: numeric [0 .. 256]
Default: 0
|
0
|
80 |
80 |
|
|
|
|
|
|
80 |
|
code_width
Try to limit code width to N columns.
Type: numeric [0 .. 10000]
Default: 0
|
0
|
82 |
80 |
100 |
78 |
|
|
|
|
80 |
80 |
debug_decode_the_flags
decode (or not) the flags as a new line.
only if the -p option is set.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
debug_line_number_to_protocol
Set the number of the line to protocol;
Used in the function prot_the_line if the 2. parameter is zero.
0: nothing protocol.
Type: numeric [0 .. ]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
debug_max_number_of_loops
Limit the number of loops.
Used by uncrustify.cpp to exit from infinite loop.
0: no limit.
Type: numeric [0 .. ]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
debug_sort_the_tracks
sort (or not) the tracking info.
Default: true
Type: boolean [false, true]
Default: true
|
true
|
|
|
|
|
|
|
|
|
|
|
debug_timeout
Set the number of second(s) before terminating formatting the current file,
0: no timeout.
only for linux
Type: numeric [0 .. ]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
debug_truncate
Set the number of characters to be printed if the text is too long,
0: do not truncate.
Type: numeric [0 .. 960]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
debug_use_the_exit_function_pop
use (or not) the exit(EX_SOFTWARE) function.
Default: true
Type: boolean [false, true]
Default: true
|
true
|
|
|
|
|
|
|
|
|
|
|
disable_processing_cmt
Specify the marker used in comments to disable processing of part of the
file.
Default: *INDENT-OFF*
Type: string
Default: *INDENT-OFF*
|
*INDENT-OFF*
|
|
|
|
|
|
|
|
|
|
|
disable_processing_nl_cont
Disable formatting of NL_CONT ('\\n') ended lines (e.g. multi-line macros).
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
donot_add_nl_before_cpp_comment
Don't add a newline before a cpp-comment in a parameter list of a function
call.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
donot_indent_func_def_close_paren
Don't indent the close parenthesis of a function definition,
if the parenthesis is on its own line.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
eat_blanks_after_open_brace
Whether to remove blank lines after '{'.
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
|
|
true |
|
TRUE |
TRUE |
true |
true |
eat_blanks_before_close_brace
Whether to remove blank lines before '}'.
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
|
|
true |
|
TRUE |
TRUE |
true |
true |
enable_digraphs
Enable parsing of digraphs.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
enable_processing_cmt
Specify the marker used in comments to (re)enable processing in a file.
Default: *INDENT-ON*
Type: string
Default: *INDENT-ON*
|
*INDENT-ON*
|
|
|
|
|
|
|
|
|
|
|
force_tab_after_define
If true, a <TAB> is inserted after #define.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
true |
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
include_category_0
The regex for include category with priority 0.
Type: string
Default:
|
|
|
|
|
|
|
|
|
|
|
|
include_category_1
The regex for include category with priority 1.
Type: string
Default:
|
|
|
|
|
|
|
|
|
|
|
|
include_category_2
The regex for include category with priority 2.
Type: string
Default:
|
|
|
|
|
|
|
|
|
|
|
|
indent_access_spec
How to indent access specifiers that are followed by a
colon.
>0: Absolute column where 1 is the leftmost column
<=0: Subtract from brace indent
Default: 1
Type: numeric [-16 .. 16]
Default: 1
|
1
|
|
|
|
|
|
|
|
|
-4 |
|
indent_access_spec_body
Whether to indent the code after an access specifier by one level.
If true, this option forces 'indent_access_spec=0'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_align_assign
Whether to align continued statements at the '='. If false or if the '=' is
followed by a newline, the next line is indent one tab.
Default: true
Type: boolean [false, true]
Default: true
|
true
|
|
|
false |
|
|
|
|
|
false |
|
indent_align_paren
Whether to align continued statements at the '('. If false or the '(' is
followed by a newline, the next line indent is one tab.
Default: true
Type: boolean [false, true]
Default: true
|
true
|
|
|
|
|
|
|
|
|
|
|
indent_align_string
Whether to indent strings broken by '\' so that they line up.
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
|
|
|
|
|
False |
|
|
indent_before_class_colon
Additional indent before the leading base class colon.
Negative values decrease indent down to the first column.
Requires indent_ignore_before_class_colon=false and a newline break before
the colon (see pos_class_colon and nl_class_colon)
Type: numeric [-16 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
indent_bool_paren
How to indent a Boolean operator when inside parentheses.
0: Indent by one level (default)
1: Align under the open parenthesis
-1: Preserve original indentation
Type: numeric [-1 .. 1]
Default: 0
|
0
|
false |
false |
false |
false |
|
|
|
|
|
|
indent_brace
Spaces to indent '{' from level.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
2 |
|
|
indent_brace_parent
Whether to indent based on the size of the brace parent,
i.e. 'if' => 3 spaces, 'for' => 4 spaces, etc.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_braces
Whether braces are indented to the body level.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_braces_no_class
Whether to disable indenting class braces if indent_braces=true.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_braces_no_func
Whether to disable indenting function braces if indent_braces=true.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_braces_no_struct
Whether to disable indenting struct braces if indent_braces=true.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_case_brace
Spaces to indent '{' from 'case'. By default, the brace will appear under
the 'c' in case. Usually set to 0 or indent_columns. Negative values are OK.
It might be wise to choose the same value for the option indent_switch_case.
Type: numeric [-16 .. 16]
Default: 0
|
0
|
|
|
2 |
|
|
|
|
|
|
|
indent_case_comment
Whether to align comments before 'case' with the 'case'.
Default: true
Type: boolean [false, true]
Default: true
|
true
|
|
|
|
|
|
|
|
|
|
|
indent_case_shift
Spaces to shift the 'case' line, without affecting any other lines.
Usually 0.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
indent_class
Whether the 'class' body is indented.
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
true |
|
|
|
|
|
true |
true |
indent_class_colon
Whether to indent the stuff after a leading base class colon.
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
|
|
|
|
|
|
|
true |
indent_class_on_colon
Whether to indent based on a class colon instead of the stuff after the
colon. Requires indent_class_colon=true.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_cmt_with_tabs
Whether to indent comments that are not at a brace level with tabs on a
tabstop. Requires indent_with_tabs=2. If false, will use spaces.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_col1_comment
Whether to indent comments found in first column.
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
|
|
|
|
|
|
|
|
indent_col1_multi_string_literal
Whether to indent multi string literal in first column.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_columns
The number of columns to indent per level. Usually 2, 3, 4, or 8.
Default: 8
Type: numeric [0 .. 16]
Default: 8
|
8
|
2 |
2 |
2 |
4 |
output_tab_size |
output_tab_size |
output_tab_size |
2 |
4 |
|
indent_comma_brace
How to indent a comma when inside braces.
0: Indent by one level (default)
1: Align under the open brace
-1: Preserve original indentation
Type: numeric [-1 .. 1]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
indent_comma_paren
How to indent a comma when inside parentheses.
0: Indent by one level (default)
1: Align under the open parenthesis
-1: Preserve original indentation
Type: numeric [-1 .. 1]
Default: 0
|
0
|
false |
false |
false |
false |
|
|
|
|
|
|
indent_comment
Whether to indent comments not found in first column.
Default: true
Type: boolean [false, true]
Default: true
|
true
|
|
|
|
|
|
|
|
|
|
|
indent_comment_align_thresh
Align comments on adjacent lines that are this many columns apart or less.
Default: 3
Type: numeric [0 .. 16]
Default: 3
|
3
|
|
|
|
|
|
|
|
|
|
|
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
indent_compound_literal_return
How to indent compound literals that are being returned.
true: add both the indent from return & the compound literal open brace
(i.e. 2 indent levels)
false: only indent 1 level, don't add the indent for the open brace, only
add the indent for the return.
Default: true
Type: boolean [false, true]
Default: true
|
true
|
|
|
|
|
|
|
|
|
|
|
indent_constr_colon
Whether to indent the stuff after a leading class initializer colon.
Type: boolean [false, true]
Default: false
|
false
|
|
|
true |
|
|
|
|
|
|
|
indent_continue
The continuation indent. If non-zero, this overrides the indent of '(', '['
and '=' continuation indents. Negative values are OK; negative value is
absolute and not increased for each '(' or '[' level.
For FreeBSD, this is set to 4.
Requires indent_ignore_first_continue=false.
Type: numeric [-16 .. 16]
Default: 0
|
0
|
|
|
2 |
|
|
|
|
|
-4 |
4 |
indent_continue_class_head
The continuation indent, only for class header line(s). If non-zero, this
overrides the indent of 'class' continuation indents.
Requires indent_ignore_first_continue=false.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
indent_cpp_lambda_body
Whether to indent the body of a C++11 lambda.
Type: boolean [false, true]
Default: false
|
false
|
|
|
true |
|
|
|
|
|
|
|
indent_cpp_lambda_only_once
The indentation can be:
- after the assignment, at the '[' character
- at the beginning of the lambda body
true: indentation will be at the beginning of the lambda body
false: indentation will be after the assignment (default)
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_cs_delegate_body
(C#) Whether to indent a C# delegate (to handle delegates with no brace) by
another level.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_cs_delegate_brace
(C#) Whether to indent the brace of a C# delegate by another level.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_ctor_init
Additional indent for constructor initializer list.
Negative values decrease indent down to the first column.
Type: numeric [-16 .. 16]
Default: 0
|
0
|
|
|
-2 |
|
|
|
|
|
|
|
indent_ctor_init_following
Virtual indent from the ':' for following member initializers.
Default: 2
Type: numeric [0 .. 16]
Default: 2
|
2
|
|
|
|
|
|
|
|
|
|
|
indent_ctor_init_leading
Virtual indent from the ':' for leading member initializers.
Default: 2
Type: numeric [0 .. 16]
Default: 2
|
2
|
|
|
|
|
|
|
|
|
0 |
|
indent_else_if
Whether to indent 'if' following 'else' as a new block under the 'else'.
If false, 'else\nif' is treated as 'else if' for indenting purposes.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_extern
Whether the 'extern "C"' body is indented.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_first_bool_expr
Whether to align the first expression to following ones
if indent_bool_paren=1.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_first_for_expr
Whether to align the first expression to following ones
if indent_semicolon_for_paren=true.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_func_call_param
Whether to indent continued function call parameters one indent level,
rather than aligning parameters under the open parenthesis.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
true |
|
indent_func_class_param
Whether to indent continued function call declaration one indent level,
rather than aligning parameters under the open parenthesis.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
true |
|
indent_func_const
Indentation column for standalone 'const' qualifier on a function
prototype.
Type: numeric [0 .. 69]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
indent_func_ctor_var_param
Whether to indent continued class variable constructors one indent level,
rather than aligning parameters under the open parenthesis.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
true |
|
indent_func_def_force_col1
Whether to force indentation of function definitions to start in column 1.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_func_def_param
Whether to indent continued function definition parameters one indent level,
rather than aligning parameters under the open parenthesis.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
true |
|
indent_func_def_param_paren_pos_threshold
for function definitions, only if indent_func_def_param is false
Allows to align params when appropriate and indent them when not
behave as if it was true if paren position is more than this value
if paren position is more than the option value
Type: numeric [0 .. 160]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
indent_func_param_double
Double the indent for indent_func_xxx_param options.
Use both values of the options indent_columns and indent_param.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_func_proto_param
Whether to indent continued function call prototype one indent level,
rather than aligning parameters under the open parenthesis.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
true |
|
indent_func_throw
Indentation column for standalone 'throw' qualifier on a function
prototype.
Type: numeric [0 .. 41]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
indent_ignore_arith
Whether to ignore the indentation of an arithmetic operator.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_ignore_asm_block
Whether to ignore indent and alignment for 'asm' blocks (i.e. assume they
have their own indentation).
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_ignore_assign
Whether to ignore the indentation of an assignment operator.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_ignore_before_class_colon
Whether to ignore indent for the leading base class colon.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_ignore_before_constr_colon
Whether to ignore indent for a leading class initializer colon.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
indent_ignore_bool
Whether to ignore the indentation of a Boolean operator when outside
parentheses.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_ignore_case_brace
Whether to ignore indent for '{' following 'case'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_ignore_first_continue
Whether to ignore indent for the first continuation line. Subsequent
continuation lines will still be indented to match the first.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_ignore_label
Whether to ignore indent for goto labels.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_ignore_semicolon
Whether to ignore the indentation of a semicolon outside of a 'for'
statement.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_inside_ternary_operator
Whether to indent the statements inside ternary operator.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_label
How to indent goto labels. Requires indent_ignore_label=false.
>0: Absolute column where 1 is the leftmost column
<=0: Subtract from brace indent
Default: 1
Type: numeric [-16 .. 16]
Default: 1
|
1
|
|
|
|
|
|
2 |
2 |
|
-4 |
|
indent_macro_brace
How to indent within a macro followed by a brace on the same line
This allows reducing the indent in macros that have (for example)
`do { ... } while (0)` blocks bracketing them.
true: add an indent for the brace on the same line as the macro
false: do not add an indent for the brace on the same line as the macro
Default: true
Type: boolean [false, true]
Default: true
|
true
|
|
|
|
|
|
|
|
|
|
|
indent_member
The number of spaces to indent a continued '->' or '.'.
Usually set to 0, 1, or indent_columns.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
4 |
|
indent_member_single
Whether lines broken at '.' or '->' should be indented by a single indent.
The indent_member option will not be effective if this is set to true.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_min_vbrace_open
When indenting after virtual brace open and newline add further spaces to
reach this minimum indent.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
indent_namespace
Whether to indent the body of a 'namespace'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_namespace_inner_only
Whether to indent only in inner namespaces (nested in other namespaces).
Requires indent_namespace=true.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_namespace_level
The number of spaces to indent a namespace block.
If set to zero, use the value indent_columns
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
indent_namespace_limit
If the body of the namespace is longer than this number, it won't be
indented. Requires indent_namespace=true. 0 means no limit.
Type: numeric [0 .. 255]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
indent_namespace_single_indent
Whether to indent only the first namespace, and not any nested namespaces.
Requires indent_namespace=true.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_oc_block
(OC) Whether to indent Objective-C blocks at brace level instead of usual
rules.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_oc_block_msg
(OC) Indent for Objective-C blocks in a message relative to the parameter
name.
=0: Use indent_oc_block rules
>0: Use specified number of spaces to indent
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
indent_oc_block_msg_from_brace
(OC) Whether to indent blocks from where the brace caret is.
Requires indent_oc_block_msg=true.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_oc_block_msg_from_caret
(OC) Whether to indent blocks from where the block caret is.
Requires indent_oc_block_msg=true.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_oc_block_msg_from_colon
(OC) Whether to indent blocks from where the brace is, relative to a message
colon. Requires indent_oc_block_msg=true.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_oc_block_msg_from_keyword
(OC) Whether to indent blocks from where the brace is, relative to a
message keyword. Requires indent_oc_block_msg=true.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_oc_block_msg_xcode_style
(OC) Whether to indent blocks the way that Xcode does by default
(from the keyword if the parameter is on its own line; otherwise, from the
previous indentation level). Requires indent_oc_block_msg=true.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_oc_inside_msg_sel
(OC) Whether to indent Objective-C code inside message selectors.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_oc_msg_colon
(OC) Minimum indent for subsequent parameters
Type: numeric [0 .. 5000]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
indent_oc_msg_prioritize_first_colon
(OC) Whether to prioritize aligning with initial colon (and stripping spaces
from lines, if necessary).
Default: true
Type: boolean [false, true]
Default: true
|
true
|
|
|
|
|
|
|
|
|
|
|
indent_off_after_assign
If true, the indentation of the chunks after a '=' sequence will be set at
LHS token indentation column before '='.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_off_after_return
If true, the indentation of the chunks after a `return` sequence will be set at return indentation column.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_off_after_return_new
If true, the indentation of the chunks after a `return new` sequence will be set at return indentation column.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_param
The continuation indent for func_*_param if they are true. If non-zero, this
overrides the indent.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
indent_paren_after_func_call
Whether to indent the open parenthesis of a function call,
if the parenthesis is on its own line.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_paren_after_func_decl
Whether to indent the open parenthesis of a function declaration,
if the parenthesis is on its own line.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_paren_after_func_def
Whether to indent the open parenthesis of a function definition,
if the parenthesis is on its own line.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_paren_close
How to indent a close parenthesis after a newline.
0: Indent to body level (default)
1: Align under the open parenthesis
2: Indent to the brace level
-1: Preserve original indentation
Type: numeric [-1 .. 2]
Default: 0
|
0
|
|
|
2 |
|
|
|
|
|
|
|
indent_paren_nl
If an open parenthesis is followed by a newline, whether to indent the next
line so that it lines up after the open parenthesis (not recommended).
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_paren_open_brace
Whether to indent based on the open parenthesis instead of the open brace
in '({\n'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_preserve_sql
(ESQL/C) Whether to preserve the relative indent of 'EXEC SQL' bodies.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_relative_single_line_comments
Whether to indent trailing single line ('//') comments relative to the code
instead of trying to keep the same absolute column.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_semicolon_for_paren
Whether to indent a semicolon when inside a for parenthesis.
If true, aligns under the open for parenthesis.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_shift
How to indent continued shift expressions ('<<' and '>>').
Set align_left_shift=false when using this.
0: Align shift operators instead of indenting them (default)
1: Indent by one level
-1: Preserve original indentation
Type: numeric [-1 .. 1]
Default: 0
|
0
|
|
|
false |
|
|
|
|
|
|
|
indent_single_after_return
If true, the tokens after return are indented with regular single indentation. By default (false) the indentation is after the return token.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_single_line_comments_after
Spaces to indent single line ('//') comments on lines after code.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
indent_single_line_comments_before
Spaces to indent single line ('//') comments on lines before code.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
indent_single_newlines
Whether to indent empty lines (i.e. lines which contain only spaces before
the newline character).
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_sparen_extra
When opening a paren for a control statement (if, for, while, etc), increase
the indent level by this value. Negative values decrease the indent level.
Type: numeric [-16 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
indent_square_nl
If an open square is followed by a newline, whether to indent the next line
so that it lines up after the open square (not recommended).
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_switch_body
Spaces to indent the body of a 'switch' before any 'case'.
Usually the same as indent_columns or indent_switch_case.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
indent_switch_break_with_case
indent 'break' with 'case' from 'switch'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_switch_case
Spaces to indent 'case' from 'switch'. Usually 0 or indent_columns.
It might be wise to choose the same value for the option indent_case_brace.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
2 |
2 |
|
|
|
|
|
|
|
indent_switch_pp
Whether to indent preprocessor statements inside of switch statements.
Default: true
Type: boolean [false, true]
Default: true
|
true
|
|
|
|
|
|
|
|
|
|
|
indent_template_param
Whether to indent continued template parameter list one indent level,
rather than aligning parameters under the open parenthesis.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
true |
|
indent_ternary_operator
How to indent the continuation of ternary operator.
0: Off (default)
1: When the `if_false` is a continuation, indent it under the `if_true` branch
2: When the `:` is a continuation, indent it under `?`
Type: numeric [0 .. 2]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
indent_token_after_brace
How to indent after a brace followed by another token (not a newline).
true: indent all contained lines to match the token
false: indent all contained lines to match the brace
Default: true
Type: boolean [false, true]
Default: true
|
true
|
|
|
false |
|
|
|
|
|
|
|
indent_using_block
(C#) Whether to indent a 'using' block if no braces are used.
Default: true
Type: boolean [false, true]
Default: true
|
true
|
|
|
|
|
|
|
|
|
|
|
indent_var_def_blk
Amount to indent variable declarations after a open brace.
<0: Relative
>=0: Absolute
Type: numeric [-16 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
indent_var_def_cont
Whether to indent continued variable declarations instead of aligning.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
true |
|
indent_vbrace_open_on_tabstop
Whether to add further spaces after regular indent to reach next tabstop
when indenting after virtual brace open and newline.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_with_tabs
How to use tabs when indenting code.
0: Spaces only
1: Indent with tabs to brace level, align with spaces (default)
2: Indent and align with tabs, using spaces when not on a tabstop
Default: 1
Type: multiple (0 1 2)
Default: 1
|
1
|
0 |
0 |
0 |
0 |
2 |
2 |
2 |
0 |
2 |
2 |
indent_xml_string
The number of spaces to indent multi-line XML strings.
Requires indent_align_string=true.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
2 |
|
input_tab_size
The original size of tabs in the input.
Default: 8
Type: numeric [1 .. 32]
Default: 8
|
8
|
|
|
|
|
|
|
|
|
|
|
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
ls_code_width
Whether to split lines as close to code_width as possible and ignore some
groupings.
The option ls_code_width has priority over the option ls_func_split_full.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
true |
|
ls_for_split_full
Whether to fully split long 'for' statements at semi-colons.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
ls_func_split_full
Whether to fully split long function prototypes/calls at commas.
The option ls_code_width has priority over the option ls_func_split_full.
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
|
|
|
|
|
|
|
|
mod_add_force_c_closebrace_comment
the following options (mod_XX_closebrace_comment) use different comment,
depending of the setting of the next option.
false: Use the c comment (default)
true : Use the cpp comment
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
mod_add_long_class_closebrace_comment
If a class body exceeds the specified number of newlines and doesn't have a
comment after the close brace, a comment will be added.
Type: numeric [0 .. 255]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
mod_add_long_function_closebrace_comment
If a function body exceeds the specified number of newlines and doesn't have
a comment after the close brace, a comment will be added.
Type: numeric [0 .. 255]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
mod_add_long_ifdef_else_comment
If an #ifdef or #else body exceeds the specified number of newlines and
doesn't have a comment after the #else, a comment will be added.
Type: numeric [0 .. 255]
Default: 0
|
0
|
1 |
1 |
|
|
|
|
|
|
|
|
mod_add_long_ifdef_endif_comment
If an #ifdef body exceeds the specified number of newlines and doesn't have
a comment after the #endif, a comment will be added.
Type: numeric [0 .. 255]
Default: 0
|
0
|
1 |
1 |
|
|
|
|
|
|
|
|
mod_add_long_namespace_closebrace_comment
If a namespace body exceeds the specified number of newlines and doesn't
have a comment after the close brace, a comment will be added.
Type: numeric [0 .. 255]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
mod_add_long_switch_closebrace_comment
If a switch body exceeds the specified number of newlines and doesn't have a
comment after the close brace, a comment will be added.
Type: numeric [0 .. 255]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
mod_case_brace
Add or remove braces around a fully braced case statement. Will only remove
braces if there are no variable declarations in the block.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
remove |
mod_enum_last_comma
Add or remove the comma after the last value of an enumeration.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
mod_full_brace_do
Add or remove braces on a single-line 'do' statement.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
force |
|
remove |
|
|
|
force |
add |
mod_full_brace_for
Add or remove braces on a single-line 'for' statement.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
force |
|
remove |
|
|
|
remove |
add |
mod_full_brace_function
(Pawn) Add or remove braces on a single-line function definition.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
force |
|
|
|
|
|
|
|
mod_full_brace_if
Add or remove braces on a single-line 'if' statement. Braces will not be
removed if the braced statement contains an 'else'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
force |
|
|
|
|
|
remove |
add |
mod_full_brace_if_chain
Whether to enforce that all blocks of an 'if'/'else if'/'else' chain either
have, or do not have, braces. Overrides mod_full_brace_if.
0: Don't override mod_full_brace_if
1: Add braces to all blocks if any block needs braces and remove braces if
they can be removed from all blocks
2: Add braces to all blocks if any block already has braces, regardless of
whether it needs them
3: Add braces to all blocks if any block needs braces and remove braces if
they can be removed from all blocks, except if all blocks have braces
despite none needing them
Type: numeric [0 .. 3]
Default: 0
|
0
|
|
|
false |
false |
1 |
|
|
|
1 |
|
mod_full_brace_if_chain_only
Whether to add braces to all blocks of an 'if'/'else if'/'else' chain.
If true, mod_full_brace_if_chain will only remove braces from an 'if' that
does not have an 'else if' or 'else'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
mod_full_brace_nl
Don't remove braces around statements that span N newlines
Type: numeric [0 .. 5000]
Default: 0
|
0
|
1 |
1 |
|
|
3 |
|
|
|
2 |
|
mod_full_brace_nl_block_rem_mlcond
Whether to prevent removal of braces from 'if'/'for'/'while'/etc. blocks
which span multiple lines.
Affects:
mod_full_brace_for
mod_full_brace_if
mod_full_brace_if_chain
mod_full_brace_if_chain_only
mod_full_brace_while
mod_full_brace_using
Does not affect:
mod_full_brace_do
mod_full_brace_function
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
mod_full_brace_using
Add or remove braces on single-line 'using ()' statement.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
force |
|
|
|
|
|
remove |
|
mod_full_brace_while
Add or remove braces on single-line 'while' statement.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
force |
|
remove |
|
|
|
remove |
add |
mod_full_paren_assign_bool
Whether to fully parenthesize Boolean expressions after '='
statement, as in 'x = a && b > c;' => 'x = (a && (b > c));'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
mod_full_paren_if_bool
Whether to fully parenthesize Boolean expressions in 'while' and 'if'
statement, as in 'if (a && b > c)' => 'if (a && (b > c))'.
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
|
|
|
|
|
|
|
true |
mod_full_paren_return_bool
Whether to fully parenthesize Boolean expressions after '='
statement, as in 'return a && b > c;' => 'return (a && (b > c));'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
mod_infinite_loop
Syntax to use for infinite loops.
0: Leave syntax alone (default)
1: Rewrite as `for(;;)`
2: Rewrite as `while(true)`
3: Rewrite as `do`...`while(true);`
4: Rewrite as `while(1)`
5: Rewrite as `do`...`while(1);`
Infinite loops that do not already match one of these syntaxes are ignored.
Other options that affect loop formatting will be applied after transforming
the syntax.
Type: numeric [0 .. 5]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
mod_int_long
Add or remove the 'int' keyword in 'int long'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
mod_int_prefer_int_on_left
If there is a situation where mod_int_* and mod_*_int would result in
multiple int keywords, whether to keep the rightmost int (the default) or the
leftmost int.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
mod_int_short
Add or remove the 'int' keyword in 'int short'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
mod_int_signed
Add or remove the 'int' keyword in 'int signed'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
mod_int_unsigned
Add or remove the 'int' keyword in 'int unsigned'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
mod_long_int
Add or remove the 'int' keyword in 'long int'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
mod_move_case_break
Whether to move a 'break' that appears after a fully braced 'case' before
the close brace, as in 'case X: { ... } break;' => 'case X: { ... break; }'.
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
|
|
|
|
|
|
|
|
mod_move_case_return
Whether to move a 'return' that appears after a fully braced 'case' before
the close brace, as in 'case X: { ... } return;' => 'case X: { ... return; }'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
mod_paren_on_return
Add or remove unnecessary parentheses on 'return' statement.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
remove |
|
remove |
|
|
|
remove |
add |
mod_paren_on_throw
Add or remove unnecessary parentheses on 'throw' statement.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
mod_pawn_semicolon
(Pawn) Whether to change optional semicolons to real semicolons.
Type: boolean [false, true]
Default: false
|
false
|
|
|
true |
|
|
|
|
|
|
|
mod_remove_duplicate_include
Whether to remove duplicate include.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
mod_remove_empty_return
Whether to remove a void 'return;' that appears as the last statement in a
function.
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
true |
|
|
|
|
|
true |
true |
mod_remove_extra_semicolon
Whether to remove superfluous semicolons.
Type: boolean [false, true]
Default: false
|
false
|
true |
|
true |
|
|
|
|
|
true |
true |
mod_short_int
Add or remove the 'int' keyword in 'short int'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
mod_signed_int
Add or remove the 'int' keyword in 'signed int'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
mod_sort_case_sensitive
Whether to take care of the case by the mod_sort_xx options.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
mod_sort_import
Whether to sort consecutive single-line 'import' statements.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
true |
|
mod_sort_incl_import_grouping_enabled
Whether to group '#include' and '#import' statements when sorting is enabled.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
mod_sort_incl_import_ignore_extension
Whether to ignore file extension in '#include' and '#import' statements
for sorting comparison.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
mod_sort_incl_import_prioritize_angle_over_quotes
Whether to prioritize '#include' and '#import' statements that contain
angle over quotes when sorting is enabled.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
mod_sort_incl_import_prioritize_extensionless
Whether to prioritize '#include' and '#import' statements that does not
contain extensions when sorting is enabled.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
mod_sort_incl_import_prioritize_filename
Whether to prioritize '#include' and '#import' statements that contain
filename without extension when sorting is enabled.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
mod_sort_include
Whether to sort consecutive single-line '#include' statements (C/C++) and
'#import' statements (Objective-C). Be aware that this has the potential to
break your code if your includes/imports have ordering dependencies.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
mod_sort_oc_properties
(OC) Whether to organize the properties. If true, properties will be
rearranged according to the mod_sort_oc_property_*_weight factors.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
mod_sort_oc_property_class_weight
(OC) Weight of a class property modifier.
Type: numeric [0 .. ]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
mod_sort_oc_property_getter_weight
(OC) Weight of getter type ('getter=') when organizing properties.
Type: numeric [0 .. ]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
mod_sort_oc_property_nullability_weight
(OC) Weight of nullability type ('nullable', 'nonnull', 'null_unspecified',
'null_resettable') when organizing properties.
Type: numeric [0 .. ]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
mod_sort_oc_property_readwrite_weight
(OC) Weight of 'readwrite' when organizing properties.
Type: numeric [0 .. ]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
mod_sort_oc_property_reference_weight
(OC) Weight of a reference type specifier ('retain', 'copy', 'assign',
'weak', 'strong') when organizing properties.
Type: numeric [0 .. ]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
mod_sort_oc_property_setter_weight
(OC) Weight of setter type ('setter=') when organizing properties.
Type: numeric [0 .. ]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
mod_sort_oc_property_thread_safe_weight
(OC) Weight of 'atomic' and 'nonatomic'.
Type: numeric [0 .. ]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
mod_sort_using
(C#) Whether to sort consecutive single-line 'using' statements.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
true |
|
mod_unsigned_int
Add or remove the 'int' keyword in 'unsigned int'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
newlines
The type of line endings.
Default: auto
Type: multiple (lf crlf cr auto)
Default: auto
|
auto
|
|
|
|
|
|
|
|
|
|
lf |
nl_after_access_spec
The number of newlines after an access specifier label. This also includes
the Qt-specific 'signals:' and 'slots:'. Will not change the newline count
if after a brace open.
0: No change (default).
Overrides nl_typedef_blk_start and nl_var_def_blk_start.
Type: numeric [0 .. 16]
Default: 0
|
0
|
2 |
2 |
1 |
|
|
|
|
|
1 |
|
nl_after_annotation
(Java) Add or remove newline after an annotation statement. Only affects
annotations that are after a newline.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
nl_after_brace_close
Whether to add a newline after '}'. Does not apply if followed by a
necessary ';'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
true |
true |
nl_after_brace_open
Whether to add a newline after '{'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
true |
|
|
|
|
true |
true |
nl_after_brace_open_cmt
Whether to add a newline between the open brace and a trailing single-line
comment. Requires nl_after_brace_open=true.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_after_case
Whether to add a newline after a 'case' statement.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
true |
|
|
|
|
true |
true |
nl_after_class
The number of newlines after '}' or ';' of a class definition.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
2 |
|
nl_after_do
Add or remove blank line after 'do/while' statement.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
nl_after_for
Add or remove blank line after 'for' statement.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
nl_after_func_body
The number of newlines after '}' of a multi-line function body.
Overrides nl_min_after_func_body and nl_max_after_func_body.
Type: numeric [0 .. 16]
Default: 0
|
0
|
2 |
2 |
|
|
|
|
|
|
2 |
3 |
nl_after_func_body_class
The number of newlines after '}' of a multi-line function body in a class
declaration. Also affects class constructors/destructors.
Overrides nl_after_func_body.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
1 |
|
nl_after_func_body_one_liner
The number of newlines after '}' of a single line function body. Also
affects class constructors/destructors.
Overrides nl_after_func_body and nl_after_func_body_class.
Type: numeric [0 .. 16]
Default: 0
|
0
|
2 |
2 |
|
|
|
|
|
|
1 |
|
nl_after_func_class_proto
The number of newlines after a class constructor/destructor prototype.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
nl_after_func_class_proto_group
The number of newlines after a class constructor/destructor prototype,
if not followed by another constructor/destructor prototype.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
nl_after_func_proto
The number of newlines after a function prototype.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
1 |
|
nl_after_func_proto_group
The number of newlines after a function prototype, if not followed by
another function prototype.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
2 |
2 |
nl_after_if
Add or remove blank line after 'if' statement. Add/Force work only if the
next token is not a closing brace.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
nl_after_label_colon
Whether to force a newline after a label's colon.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
true |
|
|
|
|
|
nl_after_member
(Java) Whether to put a blank line after a member '.' or '->' operators.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_after_multiline_comment
Whether to force a newline after a multi-line comment.
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
|
|
|
|
|
|
true |
|
nl_after_namespace
The number of newlines after '}' of a namespace.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
2 |
|
nl_after_return
Whether to put a blank line after 'return' statements, unless followed by a
close brace.
Type: boolean [false, true]
Default: false
|
false
|
true |
|
|
|
|
|
|
|
|
true |
nl_after_semicolon
Whether to add a newline after semicolons, except in 'for' statements.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
true |
|
|
|
|
true |
true |
nl_after_square_assign
(D) Add or remove newline after '= ['. Will also affect the newline before
the ']'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
remove |
|
|
|
|
remove |
|
nl_after_struct
The number of newlines after '}' or ';' of a struct/enum/union definition.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
2 |
|
nl_after_switch
Add or remove blank line after 'switch' statement.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
nl_after_synchronized
Add or remove blank line after 'synchronized' statement.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
nl_after_try_catch_finally
The number of newlines after a try-catch-finally block that isn't followed
by a brace close.
0: No change (default).
Type: numeric [0 .. 16]
Default: 0
|
0
|
1 |
1 |
|
|
|
|
|
|
1 |
|
nl_after_vbrace_close
Whether to add a newline after a virtual brace close,
as in 'if (foo) a++; <here> return;'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
true |
|
|
|
|
|
true |
|
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
nl_after_vbrace_open
Whether to add a newline after a virtual brace open with a non-empty body.
These occur in un-braced if/while/do/for statement bodies.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
true |
|
nl_after_vbrace_open_empty
Whether to add a newline after a virtual brace open with an empty body.
These occur in un-braced if/while/do/for statement bodies.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
true |
|
nl_after_while
Add or remove blank line after 'while' statement.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
nl_after_whole_file_endif
The number of newlines after a whole-file #endif.
0: No change (default).
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
nl_after_whole_file_ifdef
The number of newlines after a whole-file #ifdef.
0: No change (default).
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
nl_around_cs_property
(C#) The number of newlines before and after a property, indexer or event
declaration.
0: No change (default).
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
1 |
|
nl_assign_brace
Add or remove newline between '=' and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
add |
nl_assign_leave_one_liners
Don't split one-line braced assignments, as in 'foo_t f = { 1, 2 };'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
true |
true |
|
|
|
|
true |
true |
nl_assign_square
(D) Add or remove newline between '=' and '['.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
remove |
|
|
|
|
remove |
|
nl_before_access_spec
The number of newlines before an access specifier label. This also includes
the Qt-specific 'signals:' and 'slots:'. Will not change the newline count
if after a brace open.
0: No change (default).
Type: numeric [0 .. 16]
Default: 0
|
0
|
2 |
2 |
2 |
|
|
|
|
|
2 |
|
nl_before_block_comment
The minimum number of newlines before a multi-line comment.
Doesn't apply if after a brace open or another multi-line comment.
Type: numeric [0 .. 16]
Default: 0
|
0
|
2 |
2 |
|
|
|
|
|
|
2 |
2 |
nl_before_brace_open
Whether to add a newline before '{'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_before_c_comment
The minimum number of newlines before a single-line C comment.
Doesn't apply if after a brace open or other single-line C comments.
Type: numeric [0 .. 16]
Default: 0
|
0
|
2 |
2 |
|
|
|
|
|
|
1 |
|
nl_before_case
Whether to add a newline before 'case', and a blank line before a 'case'
statement that follows a ';' or '}'.
Type: boolean [false, true]
Default: false
|
false
|
true |
|
|
true |
|
|
|
1 |
|
true |
nl_before_class
The number of newlines before a class definition.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
nl_before_cpp_comment
The minimum number of newlines before a CPP comment.
Doesn't apply if after a brace open or other CPP comments.
Type: numeric [0 .. 16]
Default: 0
|
0
|
2 |
2 |
|
|
|
|
|
|
1 |
|
nl_before_do
Add or remove blank line before 'do'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
|
|
|
|
|
|
remove |
|
nl_before_for
Add or remove blank line before 'for'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
|
|
|
|
|
|
remove |
|
nl_before_func_body_def
The number of newlines before a multi-line function definition. Where
applicable, this option is overridden with eat_blanks_after_open_brace=true
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
nl_before_func_body_proto
The number of newlines before a function prototype.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
nl_before_func_class_def
The number of newlines before a class constructor/destructor definition.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
nl_before_func_class_proto
The number of newlines before a class constructor/destructor prototype.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
nl_before_if
Add or remove blank line before 'if'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
|
|
|
|
|
|
remove |
|
nl_before_if_closing_paren
Add or remove newline before 'if'/'else if' closing parenthesis.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
|
|
|
|
|
|
|
nl_before_ignore_after_case
Ignore nl_before_{if,for,switch,do,synchronized} if the control
statement is immediately after a case statement.
if nl_before_{if,for,switch,do} is set to remove, this option
does nothing.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_before_member
Whether to put a blank line before a member '.' or '->' operators.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_before_namespace
The number of newlines before a namespace.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
nl_before_opening_brace_func_class_def
Add or remove newline before '{' opening brace
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_before_return
Whether to put a blank line before 'return' statements, unless after an open
brace.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_before_struct
The number of newlines before a struct definition.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
nl_before_switch
Add or remove blank line before 'switch'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
|
|
|
|
|
|
remove |
|
nl_before_synchronized
Add or remove blank line before 'synchronized'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
nl_before_throw
Add or remove newline between ')' and 'throw'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
nl_before_while
Add or remove blank line before 'while'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
|
|
|
|
|
|
remove |
|
nl_before_whole_file_endif
The number of newlines before a whole-file #endif.
0: No change (default).
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
nl_before_whole_file_ifdef
The number of newlines before a whole-file #ifdef.
0: No change (default).
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
nl_between_annotation
(Java) Add or remove newline between two annotations.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_between_get_set
(C#) The number of newlines between the get/set/add/remove handlers.
0: No change (default).
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
1 |
|
nl_brace_brace
Add or remove newline between two open or close braces. Due to general
newline/brace handling, REMOVE may not work.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
nl_brace_catch
Add or remove newline between '}' and 'catch'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
|
|
|
|
|
remove |
|
nl_brace_else
Add or remove newline between '}' and 'else'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
force |
remove |
remove |
remove |
add |
remove |
remove |
nl_brace_finally
Add or remove newline between '}' and 'finally'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
|
|
|
|
|
remove |
|
nl_brace_fparen
Add or remove newline between '}' and ')' in a function invocation.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
nl_brace_square
Add or remove newline between '}' and ']'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
nl_brace_struct_var
Add or remove newline between the close brace and identifier,
as in 'struct { int a; } <here> b;'. Affects enumerations, unions and
structures. If set to ignore, uses nl_after_brace_close.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
nl_brace_while
Add or remove newline between '}' and 'while' of 'do' statement.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
remove |
remove |
remove |
remove |
remove |
remove |
remove |
nl_case_colon_brace
Add or remove newline between a case ':' and '{'.
Overrides nl_after_case.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
force |
|
|
|
|
remove |
|
nl_catch_brace
Add or remove newline before the '{' of a 'catch' statement, as in
'catch (decl) <here> {'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
|
|
|
|
|
remove |
|
nl_class_brace
Add or remove newline between 'class' and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
force |
|
|
|
|
|
remove |
|
nl_class_colon
Add or remove newline before or after (depending on pos_class_colon) a class
colon, as in 'class Foo <here> : <or here> public Bar'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
nl_class_init_args
Add or remove newline before or after (depending on pos_class_comma,
may not be IGNORE) each',' in the base class list.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
|
|
|
|
|
|
remove |
|
nl_class_leave_one_liner_groups
Whether one-line method definitions inside a class body should be treated
as if they were prototypes for the purposes of adding newlines.
Requires nl_class_leave_one_liners=true. Overrides nl_before_func_body_def
and nl_before_func_class_def for one-liners.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_class_leave_one_liners
Don't split one-line braced statements inside a 'class xx { }' body.
Type: boolean [false, true]
Default: false
|
false
|
|
|
true |
true |
|
|
|
|
true |
true |
nl_collapse_empty_body
Whether to collapse empty blocks between '{' and '}' except for functions.
Use nl_collapse_empty_body_functions to specify how empty function braces
should be formatted.
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
|
true |
|
|
|
|
true |
|
nl_collapse_empty_body_functions
Whether to collapse empty blocks between '{' and '}' for functions only.
If true, overrides nl_inside_empty_func.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_comment_func_def
The number of newlines between a function definition and the function
comment, as in '// comment\n <here> void foo() {...}'.
0: No change (default).
Type: numeric [0 .. 16]
Default: 0
|
0
|
1 |
1 |
|
|
1 |
|
|
|
1 |
1 |
nl_constr_colon
Add or remove newline around a class constructor colon. The exact position
depends on nl_constr_init_args, pos_constr_colon and pos_constr_comma.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
force |
|
|
|
|
|
remove |
|
nl_constr_init_args
Add or remove newline after each ',' in the constructor member
initialization. Related to nl_constr_colon, pos_constr_colon and
pos_constr_comma.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
nl_cpp_lambda_leave_one_liners
Don't split one-line C++11 lambdas, as in '[]() { return 0; }'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
true |
|
|
|
|
|
true |
|
nl_cpp_ldef_brace
Add or remove newline between C++11 lambda signature and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
nl_create_for_one_liner
Whether to remove a newline in simple unbraced for statements, turning them
into one-liners, as in 'for (...)\n stmt;' => 'for (...) stmt;'.
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
|
|
|
|
|
|
|
|
nl_create_func_def_one_liner
Whether to collapse a function definition whose body (not counting braces)
is only one line so that the entire definition (prototype, braces, body) is
a single line.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_create_if_one_liner
Whether to remove a newline in simple unbraced if statements, turning them
into one-liners, as in 'if(b)\n i++;' => 'if(b) i++;'.
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
|
|
|
|
|
|
|
|
nl_create_list_one_liner
Whether to split one-line simple list definitions into three lines by
adding newlines, as in 'int a[12] = { <here> 0 <here> };'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_create_while_one_liner
Whether to remove a newline in simple unbraced while statements, turning
them into one-liners, as in 'while (expr)\n stmt;' => 'while (expr) stmt;'.
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
|
|
|
|
|
|
|
|
nl_cs_property_leave_one_liners
(C#) Don't split one-line property get or set functions.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_define_macro
Whether to alter newlines in '#define' macros.
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
|
|
|
|
|
|
|
|
nl_do_brace
Add or remove newline between 'do' and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
remove |
remove |
remove |
remove |
add |
remove |
add |
nl_do_leave_one_liners
Don't split one-line do statements, as in 'do { b++; } while(...);'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_ds_struct_enum_close_brace
Whether to force a newline before '}' of a 'struct'/'union'/'enum'.
(Lower priority than eat_blanks_before_close_brace.)
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
|
|
|
|
|
|
|
|
nl_ds_struct_enum_cmt
Whether to double-space commented-entries in 'struct'/'union'/'enum'.
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
|
|
|
|
|
|
|
|
nl_else_brace
Add or remove newline between 'else' and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
remove |
remove |
remove |
remove |
add |
remove |
remove |
nl_else_if
Add or remove newline between 'else' and 'if'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
remove |
|
|
|
|
remove |
remove |
nl_elseif_brace
Add or remove newline between 'else if' and '{'. If set to ignore,
nl_if_brace is used instead.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
remove |
|
|
|
|
remove |
|
nl_end_of_file
Add or remove newline at the end of the file.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
force |
force |
|
|
|
force |
force |
nl_end_of_file_min
The minimum number of newlines at the end of the file (only used if
nl_end_of_file is 'add' or 'force').
Type: numeric [0 .. 16]
Default: 0
|
0
|
1 |
1 |
1 |
1 |
1 |
|
|
|
1 |
1 |
nl_enum_brace
Add or remove newline between 'enum' and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
force |
remove |
remove |
remove |
remove |
remove |
remove |
remove |
nl_enum_class
Add or remove newline between 'enum' and 'class'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
|
|
|
|
|
|
|
nl_enum_class_identifier
Add or remove newline between 'enum class' and the identifier.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
|
|
|
|
|
|
|
nl_enum_colon_type
Add or remove newline between 'enum class identifier :' and type.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
|
|
|
|
|
|
|
nl_enum_identifier_colon
Add or remove newline between 'enum class' type and ':'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
|
|
|
|
|
|
|
nl_enum_leave_one_liners
Don't split one-line enums, as in 'enum foo { BAR = 15 };'
Type: boolean [false, true]
Default: false
|
false
|
|
|
true |
true |
|
|
|
|
true |
|
nl_enum_own_lines
Add or remove newline before first element, after comma, and after last
element, in 'enum'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_fcall_brace
Add or remove newline between a function call's ')' and '{', as in
'list_for_each(item, &list) { }'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
remove |
remove |
remove |
add |
add |
remove |
add |
nl_fdef_brace
Add or remove newline between function signature and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
force |
force |
add |
add |
add |
add |
remove |
add |
nl_fdef_brace_cond
Add or remove newline between function signature and '{',
if signature ends with ')'. Overrides nl_fdef_brace.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_finally_brace
Add or remove newline between 'finally' and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
|
|
|
|
|
remove |
|
nl_for_brace
Add or remove newline between 'for' and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
remove |
remove |
remove |
remove |
add |
remove |
add |
nl_for_leave_one_liners
Don't split one-line for statements, as in 'for(...) b++;'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_func_call_args
Add or remove newline after each ',' in a function call.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
nl_func_call_args_multi_line
Whether to add a newline after each ',' in a function call if '(' and ')'
are in different lines.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_func_call_args_multi_line_ignore_closures
Whether to respect nl_func_call_XXX option in case of closure args.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_func_call_empty
Add or remove newline between '()' in a function call.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_func_call_end
Whether to add a newline before ')' in a function call.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_func_call_end_multi_line
Whether to add a newline before ')' in a function call if '(' and ')' are in
different lines.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_func_call_paren
Add or remove newline between a function name and the opening '(' in the
call.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
|
|
|
|
|
|
|
nl_func_call_paren_empty
Overrides nl_func_call_paren for functions with no parameters.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
|
|
|
|
|
|
|
nl_func_call_start
Whether to add a newline after '(' in a function call,
has preference over nl_func_call_start_multi_line.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_func_call_start_multi_line
Whether to add a newline after '(' in a function call if '(' and ')' are in
different lines.
Type: boolean [false, true]
Default: false
|
false
|
|
|
true |
|
|
|
|
|
|
|
nl_func_class_scope
Add or remove newline between class specification and '::'
in 'void A::f() { }'. Only appears in separate member implementation (does
not appear with in-line implementation).
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
|
|
|
|
|
|
|
nl_func_decl_args
Add or remove newline after each ',' in a function declaration.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
|
remove |
remove |
|
|
|
remove |
|
nl_func_decl_args_multi_line
Whether to add a newline after each ',' in a function declaration if '('
and ')' are in different lines. If false, nl_func_decl_args is used instead.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_func_decl_empty
Add or remove newline between '()' in a function declaration.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
remove |
remove |
|
|
|
remove |
|
nl_func_decl_end
Add or remove newline before the ')' in a function declaration.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
remove |
remove |
|
|
|
remove |
|
nl_func_decl_end_multi_line
Whether to add a newline before ')' in a function declaration if '(' and ')'
are in different lines. If false, nl_func_decl_end is used instead.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_func_decl_end_single
Overrides nl_func_decl_end when there is only one parameter.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
remove |
|
|
|
|
remove |
|
nl_func_decl_start
Add or remove newline after '(' in a function declaration.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
remove |
remove |
|
|
|
remove |
|
nl_func_decl_start_multi_line
Whether to add a newline after '(' in a function declaration if '(' and ')'
are in different lines. If false, nl_func_decl_start is used instead.
Type: boolean [false, true]
Default: false
|
false
|
|
|
true |
|
|
|
|
|
|
|
nl_func_decl_start_single
Overrides nl_func_decl_start when there is only one parameter.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
nl_func_def_args
Add or remove newline after each ',' in a function definition.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
nl_func_def_args_multi_line
Whether to add a newline after each ',' in a function definition if '('
and ')' are in different lines. If false, nl_func_def_args is used instead.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_func_def_empty
Add or remove newline between '()' in a function definition.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
remove |
|
|
|
|
remove |
|
nl_func_def_end
Add or remove newline before the ')' in a function definition.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
remove |
|
|
|
|
remove |
|
nl_func_def_end_multi_line
Whether to add a newline before ')' in a function definition if '(' and ')'
are in different lines. If false, nl_func_def_end is used instead.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_func_def_end_single
Overrides nl_func_def_end when there is only one parameter.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
remove |
|
|
|
|
remove |
|
nl_func_def_paren
Add or remove newline between a function name and the opening '(' in the
definition.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
remove |
|
|
|
|
remove |
|
nl_func_def_paren_empty
Overrides nl_func_def_paren for functions with no parameters.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
|
|
|
|
|
|
|
nl_func_def_start
Add or remove newline after '(' in a function definition.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
remove |
|
|
|
|
remove |
|
nl_func_def_start_multi_line
Whether to add a newline after '(' in a function definition if '(' and ')'
are in different lines. If false, nl_func_def_start is used instead.
Type: boolean [false, true]
Default: false
|
false
|
|
|
true |
|
|
|
|
|
|
|
nl_func_def_start_single
Overrides nl_func_def_start when there is only one parameter.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
nl_func_leave_one_liners
Don't split one-line function definitions, as in 'int foo() { return 0; }'.
might modify nl_func_type_name
Type: boolean [false, true]
Default: false
|
false
|
|
|
true |
true |
|
|
|
|
true |
|
nl_func_paren
Add or remove newline between a function name and the opening '(' in the
declaration.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
remove |
remove |
|
|
|
remove |
remove |
nl_func_paren_empty
Overrides nl_func_paren for functions with no parameters.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
|
|
|
|
|
|
|
nl_func_proto_type_name
Add or remove newline between return type and function name in a prototype.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
force |
|
|
|
|
remove |
|
nl_func_scope_name
Add or remove newline between function scope and name, as in
'void A :: <here> f() { }'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
|
|
|
|
|
remove |
|
nl_func_type_name
Add or remove newline between return type and function name in a function
definition.
might be modified by nl_func_leave_one_liners
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
force |
|
|
|
|
remove |
|
nl_func_type_name_class
Add or remove newline between return type and function name inside a class
definition. If set to ignore, nl_func_type_name or nl_func_proto_type_name
is used instead.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
force |
|
|
|
|
remove |
|
nl_getset_brace
Add or remove newline between get/set and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
force |
nl_getset_leave_one_liners
Don't split one-line get or set functions.
Type: boolean [false, true]
Default: false
|
false
|
|
|
true |
true |
|
|
|
|
true |
|
nl_if_brace
Add or remove newline between 'if' and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
remove |
remove |
remove |
remove |
add |
remove |
remove |
nl_if_leave_one_liners
Don't split one-line if/else statements, as in 'if(...) b++;'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
true |
true |
|
|
|
|
|
|
nl_inside_empty_func
The number of newlines inside an empty function body.
This option overrides eat_blanks_after_open_brace and
eat_blanks_before_close_brace, but is ignored when
nl_collapse_empty_body_functions=true
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
nl_inside_namespace
The number of newlines after '{' of a namespace. This also adds newlines
before the matching '}'.
0: Apply eat_blanks_after_open_brace or eat_blanks_before_close_brace if
applicable, otherwise no change.
Overrides eat_blanks_after_open_brace and eat_blanks_before_close_brace.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
nl_max
The maximum number of consecutive newlines (3 = 2 blank lines).
Type: numeric [0 .. 16]
Default: 0
|
0
|
3 |
3 |
3 |
2 |
|
|
|
|
2 |
4 |
nl_max_after_func_body
The maximum number of newlines after '}' of a multi-line function body.
Only works when nl_after_func_body is 0.
Takes precedence over nl_min_after_func_body.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
nl_max_blank_in_func
The maximum number of consecutive newlines in a function.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
nl_min_after_func_body
The minimum number of newlines after '}' of a multi-line function body.
Only works when nl_after_func_body is 0.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
nl_multi_line_cond
Add a newline between ')' and '{' if the ')' is on a different line than the
if/for/etc.
Overrides nl_for_brace, nl_if_brace, nl_switch_brace, nl_while_switch and
nl_catch_brace.
Type: boolean [false, true]
Default: false
|
false
|
|
|
true |
|
|
|
|
|
|
|
nl_multi_line_define
Force a newline in a define after the macro name for multi-line defines.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
true |
nl_multi_line_sparen_close
Add a newline before ')' if an if/for/while/switch condition spans multiple
lines. Overrides nl_before_if_closing_paren if both are specified.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_multi_line_sparen_open
Add a newline after '(' if an if/for/while/switch condition spans multiple
lines
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_namespace_brace
Add or remove newline between 'namespace' and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
force |
|
|
|
|
|
remove |
|
nl_namespace_two_to_one_liner
Whether to collapse a two-line namespace, like 'namespace foo\n{ decl; }'
into a single line. If true, prevents other brace newline rules from turning
such code into four lines. If true, it also preserves one-liner namespaces.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_oc_before_end
(OC) Add or remove blank line before '@end' statement.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_oc_before_implementation
(OC) Add or remove blank line before '@implementation' statement.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_oc_before_interface
(OC) Add or remove blank line before '@interface' statement.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_oc_block_brace
(OC) Add or remove newline between Objective-C block signature and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_oc_brace_catch
(OC) Add or remove newline between '}' and '@catch'. If set to ignore,
nl_brace_catch is used.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_oc_catch_brace
(OC) Add or remove newline before the '{' of a '@catch' statement, as in
'@catch (decl) <here> {'. If set to ignore, nl_catch_brace is used.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_oc_implementation_brace
(OC) Add or remove newline between '@implementation' and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
nl_oc_interface_brace
(OC) Add or remove newline between '@interface' and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_oc_mdef_brace
(OC) Add or remove newline between method declaration and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_oc_msg_args
(OC) Whether to put each Objective-C message parameter on a separate line.
See nl_oc_msg_leave_one_liner.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_oc_msg_args_max_code_width
(OC) Max code width of Objective-C message before applying nl_oc_msg_args.
Type: numeric [0 .. 10000]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
nl_oc_msg_args_min_params
(OC) Minimum number of Objective-C message parameters before applying nl_oc_msg_args.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
nl_oc_msg_leave_one_liner
(OC) Don't split one-line Objective-C messages.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
true |
|
nl_paren_dbrace_open
(Java) Add or remove newline between the ')' and '{{' of the double brace
initializer.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
nl_property_brace
(C#) Add or remove newline between property and the '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
nl_remove_extra_newlines
How aggressively to remove extra newlines not in preprocessor.
0: No change (default)
1: Remove most newlines not handled by other config
2: Remove all newlines and reformat completely by config
Type: numeric [0 .. 2]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
1 |
|
nl_return_expr
Add or remove newline between 'return' and the return expression.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
remove |
|
|
|
|
remove |
|
nl_scope_brace
(D) Add or remove newline between 'scope (x)' and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
nl_split_for_one_liner
Whether to split one-line simple unbraced for statements into two lines by
adding a newline, as in 'for (...) <here> stmt;'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_split_if_one_liner
Whether to split one-line simple unbraced if statements into two lines by
adding a newline, as in 'if(b) <here> i++;'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_split_while_one_liner
Whether to split one-line simple unbraced while statements into two lines by
adding a newline, as in 'while (expr) <here> stmt;'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_squeeze_ifdef
Whether to remove blanks after '#ifxx' and '#elxx', or before '#elxx' and
'#endif'. Does not affect top-level #ifdefs.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
TRUE |
TRUE |
true |
true |
nl_squeeze_ifdef_top_level
Makes the nl_squeeze_ifdef option affect the top-level #ifdefs as well.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_squeeze_paren_close
Whether to alter newlines between consecutive parenthesis closes. The number
of closing parentheses in a line will depend on respective open parenthesis
lines.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_start_of_file
Add or remove newlines at the start of the file.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
remove |
remove |
|
|
|
remove |
remove |
nl_start_of_file_min
The minimum number of newlines at the start of the file (only used if
nl_start_of_file is 'add' or 'force').
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
nl_struct_brace
Add or remove newline between 'struct and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
force |
remove |
remove |
remove |
remove |
remove |
remove |
remove |
nl_switch_brace
Add or remove newline between 'switch' and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
remove |
remove |
remove |
remove |
add |
remove |
add |
nl_synchronized_brace
Add or remove newline between 'synchronized' and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
|
|
|
|
|
remove |
|
nl_template_args
Whether to add a newline after each ',' in a template parameter list.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_template_class
Add or remove newline after 'template<...>' of a template class.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
force |
|
|
|
|
|
force |
|
nl_template_class_decl
Add or remove newline after 'template<...>' of a template class declaration.
Overrides nl_template_class.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_template_class_decl_special
Add or remove newline after 'template<>' of a specialized class declaration.
Overrides nl_template_class_decl.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_template_class_def
Add or remove newline after 'template<...>' of a template class definition.
Overrides nl_template_class.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_template_class_def_special
Add or remove newline after 'template<>' of a specialized class definition.
Overrides nl_template_class_def.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_template_end
Whether to add a newline before '>' of a template parameter list.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_template_func
Add or remove newline after 'template<...>' of a template function.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
nl_template_func_decl
Add or remove newline after 'template<...>' of a template function
declaration.
Overrides nl_template_func.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_template_func_decl_special
Add or remove newline after 'template<>' of a specialized function
declaration.
Overrides nl_template_func_decl.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_template_func_def
Add or remove newline after 'template<...>' of a template function
definition.
Overrides nl_template_func.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_template_func_def_special
Add or remove newline after 'template<>' of a specialized function
definition.
Overrides nl_template_func_def.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_template_start
Whether to add a newline after '<' of a template parameter list.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_template_using
Add or remove newline between 'template<...>' and 'using' of a templated
type alias.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_template_var
Add or remove newline after 'template<...>' of a template variable.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_throw_expr
Add or remove newline between 'throw' and the throw expression.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_try_brace
Add or remove newline between 'try' and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
|
|
|
|
|
remove |
|
nl_tsquare_brace
Add or remove newline between '[]' and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_type_brace_init_lst
Whether to add a newline after the type in an unnamed temporary
direct-list-initialization, better:
before a direct-list-initialization.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_type_brace_init_lst_close
Whether to add a newline before the close brace in an unnamed temporary
direct-list-initialization.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_type_brace_init_lst_open
Whether to add a newline after the open brace in an unnamed temporary
direct-list-initialization.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_typedef_blk_end
The number of newlines after a block of typedefs.
0: No change (default).
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
2 |
|
nl_typedef_blk_in
The maximum number of consecutive newlines within a block of typedefs.
0: No change (default).
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
1 |
|
nl_typedef_blk_start
The number of newlines before a block of typedefs. If nl_after_access_spec
is non-zero, that option takes precedence.
0: No change (default).
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
2 |
|
nl_union_brace
Add or remove newline between 'union' and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
remove |
remove |
remove |
remove |
remove |
remove |
remove |
nl_unittest_brace
(D) Add or remove newline between 'unittest' and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
nl_using_brace
(C#) Add or remove newline between 'using' and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
nl_var_def_blk_end
The minimum number of empty newlines after a block of variable definitions
not at the top of a function body. Newlines are not added if the block
is at the bottom of the file or just before a preprocessor directive.
0: No change (default).
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
2 |
|
nl_var_def_blk_end_func_top
The minimum number of blank lines after a block of variable definitions
at the top of a function body. If any preprocessor directives appear
between the opening brace of the function and the variable block, then
it is considered as not at the top of the function.Newlines are added
before trailing preprocessor directives, if any exist.
0: No change (default).
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
1 |
1 |
|
1 |
1 |
1 |
nl_var_def_blk_in
The maximum number of consecutive newlines within a block of variable
definitions.
0: No change (default).
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
1 |
|
nl_var_def_blk_start
The minimum number of empty newlines before a block of variable definitions
not at the top of a function body. If nl_after_access_spec is non-zero,
that option takes precedence. Newlines are not added at the top of the
file or just after an opening brace. Newlines are added above any
preprocessor directives before the block.
0: No change (default).
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
2 |
|
nl_version_brace
(D) Add or remove newline between 'version (x)' and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
nl_while_brace
Add or remove newline between 'while' and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
|
remove |
remove |
remove |
add |
remove |
add |
nl_while_leave_one_liners
Don't split one-line while statements, as in 'while(...) b++;'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
true |
|
|
|
|
|
|
|
output_tab_size
The size of tabs in the output (only used if align_with_tabs=true).
Default: 8
Type: numeric [1 .. 32]
Default: 8
|
8
|
|
|
|
|
|
|
|
|
|
|
pos_arith
The position of arithmetic operators in wrapped expressions.
Type: multiple (ignore break force lead trail join lead_break lead_force trail_break trail_force)
Default: ignore
|
ignore
|
|
|
trail |
|
|
|
|
|
join |
|
pos_assign
The position of assignment in wrapped expressions. Do not affect '='
followed by '{'.
Type: multiple (ignore break force lead trail join lead_break lead_force trail_break trail_force)
Default: ignore
|
ignore
|
|
|
trail |
|
|
|
|
|
join |
|
pos_bool
The position of Boolean operators in wrapped expressions.
Type: multiple (ignore break force lead trail join lead_break lead_force trail_break trail_force)
Default: ignore
|
ignore
|
|
|
trail |
|
|
|
|
|
join |
trail |
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
pos_class_colon
The position of trailing/leading class colon, between class and base class
list. Affects nl_class_colon.
Type: multiple (ignore break force lead trail join lead_break lead_force trail_break trail_force)
Default: ignore
|
ignore
|
|
|
lead_force |
|
|
|
|
|
join |
|
pos_class_comma
The position of the comma in the base class list if there is more than one
line. Affects nl_class_init_args.
Type: multiple (ignore break force lead trail join lead_break lead_force trail_break trail_force)
Default: ignore
|
ignore
|
|
|
trail |
|
|
|
|
|
join |
|
pos_comma
The position of the comma in wrapped expressions.
Type: multiple (ignore break force lead trail join lead_break lead_force trail_break trail_force)
Default: ignore
|
ignore
|
|
|
trail |
|
|
|
|
|
join |
|
pos_compare
The position of comparison operators in wrapped expressions.
Type: multiple (ignore break force lead trail join lead_break lead_force trail_break trail_force)
Default: ignore
|
ignore
|
|
|
trail |
|
|
|
|
|
join |
|
pos_conditional
The position of conditional operators, as in the '?' and ':' of
'expr ? stmt : stmt', in wrapped expressions.
Type: multiple (ignore break force lead trail join lead_break lead_force trail_break trail_force)
Default: ignore
|
ignore
|
|
|
trail |
|
|
|
|
|
join |
|
pos_constr_colon
The position of colons between constructor and member initialization.
Related to nl_constr_colon, nl_constr_init_args and pos_constr_comma.
Type: multiple (ignore break force lead trail join lead_break lead_force trail_break trail_force)
Default: ignore
|
ignore
|
|
|
lead_break |
|
|
|
|
|
join |
|
pos_constr_comma
The position of the comma in the constructor initialization list.
Related to nl_constr_colon, nl_constr_init_args and pos_constr_colon.
Type: multiple (ignore break force lead trail join lead_break lead_force trail_break trail_force)
Default: ignore
|
ignore
|
|
|
trail |
|
|
|
|
|
join |
|
pos_enum_comma
The position of the comma in enum entries.
Type: multiple (ignore break force lead trail join lead_break lead_force trail_break trail_force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
pos_shift
The position of shift operators in wrapped expressions.
Type: multiple (ignore break force lead trail join lead_break lead_force trail_break trail_force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
pp_define_at_level
Whether to indent '#define' at the brace level. If false, these are
indented from column 1.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
pp_if_indent_code
Whether to indent the code between #if, #else and #endif.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
pp_ignore_define_body
Whether to ignore the '#define' body while formatting.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
pp_include_at_level
Whether to indent '#include' at the brace level.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
pp_indent
Add or remove indentation of preprocessor directives inside #if blocks
at brace level 0 (file-level).
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
remove |
|
|
|
|
remove |
pp_indent_at_level
Whether to indent #if/#else/#endif at the brace level. If false, these are
indented from column 1.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
pp_indent_at_level0
Whether to indent #if/#else/#endif at the parenthesis level if the brace
level is 0. If false, these are indented from column 1.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
pp_indent_brace
How to indent braces directly inside #if, #else, and #endif.
Requires pp_if_indent_code=true and only applies to the indent of the
preprocessor that the braces are directly inside of.
0: No extra indent
1: Indent by one level
-1: Preserve original indentation
Default: 1
Type: numeric [-1 .. 1]
Default: 1
|
1
|
|
|
true |
|
|
|
|
|
|
|
pp_indent_case
Whether to indent case statements between #if, #else, and #endif.
Only applies to the indent of the preprocessor that the case statements
directly inside of.
Default: true
Type: boolean [false, true]
Default: true
|
true
|
|
|
|
|
|
|
|
|
|
|
pp_indent_count
Specifies the number of columns to indent preprocessors per level
at brace level 0 (file-level). If pp_indent_at_level=false, also specifies
the number of columns to indent preprocessors per level
at brace level > 0 (function-level).
Default: 1
Type: numeric [0 .. 16]
Default: 1
|
1
|
|
|
2 |
|
|
|
|
|
|
|
pp_indent_extern
Whether to indent extern C blocks between #if, #else, and #endif.
Only applies to the indent of the preprocessor that the extern block is
directly inside of.
Default: true
Type: boolean [false, true]
Default: true
|
true
|
|
|
|
|
|
|
|
|
|
|
pp_indent_func_def
Whether to indent whole function definitions between #if, #else, and #endif.
Only applies to the indent of the preprocessor that the function definition
is directly inside of.
Default: true
Type: boolean [false, true]
Default: true
|
true
|
|
|
|
|
|
|
|
|
|
|
pp_indent_if
If pp_indent_at_level=true, sets the indent for #if, #else and #endif when
not at file-level. Negative values decrease indent down to the first column.
=0: Indent preprocessors using output_tab_size
>0: Column at which all preprocessors will be indented
Type: numeric [-16 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
pp_indent_in_guard
Whether to indent the body of an #if that encompasses all the code in the file.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
pp_indent_region
The indent for '#region' and '#endregion' in C# and '#pragma region' in
C/C++. Negative values decrease indent down to the first column.
Type: numeric [-16 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
pp_indent_with_tabs
How to use tabs when indenting preprocessor code.
-1: Use 'indent_with_tabs' setting (default)
0: Spaces only
1: Indent with tabs to brace level, align with spaces
2: Indent and align with tabs, using spaces when not on a tabstop
Default: -1
Type: numeric [-1 .. 2]
Default: -1
|
-1
|
|
|
|
|
|
|
|
|
|
|
pp_multiline_define_body_indent
An offset value that controls the indentation of the body of a multiline #define.
'body' refers to all the lines of a multiline #define except the first line.
Requires 'pp_ignore_define_body = false'.
<0: Absolute column: the body indentation starts off at the specified column
(ex. -3 ==> the body is indented starting from column 3)
>=0: Relative to the column of the '#' of '#define'
(ex. 3 ==> the body is indented starting 3 columns at the right of '#')
Default: 8
Type: numeric [-32 .. 32]
Default: 8
|
8
|
|
|
|
|
|
|
|
|
|
|
pp_region_indent_code
Whether to indent the code between #region and #endregion.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
pp_space_after
Add or remove space after # based on pp level of #if blocks.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
pp_space_count
Sets the number of spaces per level added with pp_space_after.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
1 |
|
pp_unbalanced_if_action
Action to perform when unbalanced #if and #else blocks are found.
0: do nothing
1: print a warning message
2: terminate the program with an error (EX_SOFTWARE)
The action will be triggered in the following cases:
- if an #ifdef block ends on a different indent level than
where it started from. Example:
#ifdef TEST
int i;
{
int j;
#endif
- an #elif/#else block ends on a different indent level than
the corresponding #ifdef block. Example:
#ifdef TEST
int i;
#else
}
int j;
#endif
Type: numeric [0 .. 2]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
processing_cmt_as_regex
Option to allow both disable_processing_cmt and enable_processing_cmt
strings, if specified, to be interpreted as ECMAScript regular expressions.
If true, a regex search will be performed within comments according to the
specified patterns in order to disable/enable processing.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
set_numbering_for_html_output
insert the number of the line at the beginning of each line
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
sp_addr
Add or remove space after the '&' (address-of) unary operator. This does not
affect the spacing after a '&' that is part of a type.
Default: remove
Type: multiple (ignore add remove force)
Default: remove
|
remove
|
|
|
|
|
|
|
|
|
|
|
sp_after_angle
Add or remove space after '>'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
remove |
|
|
|
|
|
force |
force |
sp_after_assign
Add or remove space after assignment operator '=', '+=', etc.
Overrides sp_assign.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
force |
|
|
|
|
force |
|
sp_after_bit_colon
Add or remove space after a bit colon ':'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_after_byref
Add or remove space after reference sign '&', if followed by a word.
Overrides sp_type_func.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
remove |
|
|
|
|
remove |
force |
sp_after_byref_func
Add or remove space after a reference sign '&', if followed by a function
prototype or function definition.
Overrides sp_after_byref and sp_type_func.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
|
|
|
|
|
remove |
|
sp_after_cast
Add or remove space after C/D cast, i.e. 'cast(int)a' vs. 'cast(int) a' or
'(int)a' vs. '(int) a'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
|
force |
remove |
remove |
remove |
remove |
remove |
remove |
sp_after_class_colon
Add or remove space after class ':'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
force |
|
|
|
|
force |
|
sp_after_comma
Add or remove space after ',', i.e. 'a,b' vs. 'a, b'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
force |
force |
add |
force |
force |
force |
force |
sp_after_constr_colon
Add or remove space after class constructor ':'.
Default: add
Type: multiple (ignore add remove force)
Default: add
|
add
|
|
|
ignore |
|
|
|
|
|
force |
|
sp_after_dc
Add or remove space after the '::' operator.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
remove |
|
|
|
|
|
remove |
remove |
sp_after_decltype
Add or remove space between 'decltype(...)' and word,
brace or function call.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_after_ellipsis
Add or remove space after the variadic '...' when preceded by a
non-punctuator.
The value REMOVE will be overridden with FORCE
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_after_emb_cmt
Add or remove space after an embedded comment.
Default: force
Type: multiple (ignore add remove force)
Default: force
|
force
|
|
|
|
|
|
|
|
|
|
|
sp_after_for_colon
Add or remove space after ':' in a Java/C++11 range-based 'for',
as in 'for (Type var : <here> expr)'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_after_invariant_paren
(D) Add or remove space after the ')' in 'invariant (C) c'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_after_mdatype_commas
(C#, Vala) Add or remove space between ',' and ']' in multidimensional array type
like 'int[,,]'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
sp_after_new
Add or remove space after 'new', 'delete' and 'delete[]'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
force |
|
|
|
|
|
force |
|
sp_after_newop_paren
Add or remove space between ')' and type in 'new(foo) BAR'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_after_noexcept
Add or remove space after 'noexcept'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_after_oc_at_sel
(OC) Add or remove space between '@selector' and '(',
i.e. '@selector(msgName)' vs. '@selector (msgName)'.
Also applies to '@protocol()' constructs.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
sp_after_oc_at_sel_parens
(OC) Add or remove space between '@selector(x)' and the following word,
i.e. '@selector(foo) a:' vs. '@selector(foo)a:'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_after_oc_block_caret
(OC) Add or remove space after a block pointer caret,
i.e. '^int (int arg){...}' vs. '^ int (int arg){...}'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
sp_after_oc_colon
(OC) Add or remove space after the colon in message specs,
i.e. '-(int) f:(int) x;' vs. '-(int) f: (int) x;'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
|
|
|
|
|
|
force |
|
sp_after_oc_dict_colon
(OC) Add or remove space after the colon in immutable dictionary expression
'NSDictionary *test = @{@"foo" :@"bar"};'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_after_oc_msg_receiver
(OC) Add or remove space between the receiver and selector in a message,
as in '[receiver selector ...]'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
sp_after_oc_property
(OC) Add or remove space after '@property'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_after_oc_return_type
(OC) Add or remove space after the first (type) in message specs,
i.e. '-(int) f:(int)x;' vs. '-(int)f:(int)x;'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
sp_after_oc_scope
(OC) Add or remove space after the scope '+' or '-', as in '-(void) foo;'
or '+(int) bar;'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
|
|
|
|
|
|
remove |
|
sp_after_oc_synchronized
(OC) Add or remove space between '@synchronized' and the open parenthesis,
i.e. '@synchronized(foo)' vs. '@synchronized (foo)'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_after_oc_type
(OC) Add or remove space after the (type) in message specs,
i.e. '-(int)f: (int) x;' vs. '-(int)f: (int)x;'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
|
|
|
|
|
|
remove |
|
sp_after_operator
Add or remove space between 'operator' and operator sign.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
remove |
|
|
|
|
|
force |
|
sp_after_operator_sym
Add or remove space between the operator symbol and the open parenthesis, as
in 'operator ++('.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
remove |
|
|
|
|
|
remove |
|
sp_after_operator_sym_empty
Overrides sp_after_operator_sym when the operator has no arguments, as in
'operator *()'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
|
|
|
|
|
|
|
sp_after_ptr_block_caret
Add or remove space after pointer caret '^', if followed by a word.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_after_ptr_star
Add or remove space after pointer star '*', if followed by a word.
Overrides sp_type_func.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
force |
|
remove |
|
|
|
remove |
remove |
sp_after_ptr_star_func
Add or remove space after a pointer star '*', if followed by a function
prototype or function definition.
Overrides sp_after_ptr_star and sp_type_func.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
|
|
|
|
|
remove |
|
sp_after_ptr_star_qualifier
Add or remove space after pointer star '*', if followed by a qualifier.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_after_ptr_star_trailing
Add or remove space after a pointer star '*' in the trailing return of a
function prototype or function definition.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_after_semi
Add or remove space after ';', except when followed by a comment.
Default: add
Type: multiple (ignore add remove force)
Default: add
|
add
|
|
|
ignore |
force |
|
|
|
|
force |
|
sp_after_semi_for
Add or remove space after ';' in non-empty 'for' statements.
Default: force
Type: multiple (ignore add remove force)
Default: force
|
force
|
|
|
|
|
|
|
|
|
|
|
sp_after_semi_for_empty
Add or remove space after the final semicolon of an empty part of a for
statement, as in 'for ( ; ; <here> )'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
force |
force |
|
|
|
|
remove |
|
sp_after_send_oc_colon
(OC) Add or remove space after the colon in message specs,
i.e. '[object setValue:1];' vs. '[object setValue: 1];'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
|
|
|
|
|
|
force |
|
sp_after_sparen
Add or remove space after ')' of control statements.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
force |
force |
force |
force |
force |
force |
force |
sp_after_tag
(Pawn) Add or remove space after the tag keyword.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_after_throw
Add or remove space between 'throw' and anything other than '(' as in
'@throw [...];'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_after_tparen_close
Add or remove space between the ')' and '(' in a function type, as in
'void (*x)(...)'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
sp_after_type
Add or remove space between type and word. In cases where total removal of
whitespace would be a syntax error, a value of 'remove' is treated the same
as 'force'.
This also affects some other instances of space following a type that are
not covered by other options; for example, between the return type and
parenthesis of a function type template argument, between the type and
parenthesis of an array parameter, or between 'decltype(...)' and the
following word.
Default: force
Type: multiple (ignore add remove force)
Default: force
|
force
|
add |
add |
|
|
|
|
|
|
|
|
sp_after_type_brace_init_lst_open
Add or remove space after open brace in an unnamed temporary
direct-list-initialization
if statement is a brace_init_lst
works only if sp_brace_brace is set to ignore.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_angle_colon
Add or remove space between '>' and ':'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_angle_paren
Add or remove space between '>' and '(' as found in 'new List<byte>(foo);'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
remove |
|
|
|
|
|
remove |
|
sp_angle_paren_empty
Add or remove space between '>' and '()' as found in 'new List<byte>();'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
|
|
|
|
|
|
|
sp_angle_shift
Add or remove space between '>' and '>' in '>>' (template stuff).
Default: add
Type: multiple (ignore add remove force)
Default: add
|
add
|
|
|
remove |
|
|
|
|
|
force |
|
sp_angle_word
Add or remove space between '>' and a word as in 'List<byte> m;' or
'template <typename T> static ...'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
force |
|
|
|
|
|
force |
|
sp_annotation_paren
(Java) Add or remove space between an annotation and the open parenthesis.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
sp_arith
Add or remove space around non-assignment symbolic operators ('+', '/', '%',
'<<', and so forth).
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
force |
force |
add |
force |
force |
force |
|
sp_arith_additive
Add or remove space around arithmetic operators '+' and '-'.
Overrides sp_arith.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
force |
|
|
|
|
|
|
|
sp_assign
Add or remove space around assignment operator '=', '+=', etc.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
force |
force |
add |
force |
force |
force |
force |
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
sp_assign_default
Add or remove space around assignment operator '=' in a prototype.
If set to ignore, use sp_assign.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
force |
|
|
|
|
force |
|
sp_attribute_paren
Add or remove space between '__attribute__' and '('.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
|
remove |
|
|
|
|
force |
|
sp_balance_nested_parens
Whether to balance spaces inside nested parentheses.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
sp_before_angle
Add or remove space before '<'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
remove |
|
|
|
|
|
remove |
remove |
sp_before_assign
Add or remove space before assignment operator '=', '+=', etc.
Overrides sp_assign.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
force |
|
|
|
|
force |
|
sp_before_bit_colon
Add or remove space before a bit colon ':'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_before_byref
Add or remove space before a reference sign '&'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
force |
force |
|
|
|
|
force |
remove |
sp_before_byref_func
Add or remove space before a reference sign '&', if followed by a function
prototype or function definition.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
force |
|
|
|
|
|
force |
|
sp_before_case_colon
Add or remove space before case ':'.
Default: remove
Type: multiple (ignore add remove force)
Default: remove
|
remove
|
|
|
|
|
|
|
|
|
|
|
sp_before_class_colon
Add or remove space before class ':'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
force |
|
|
|
|
remove |
|
sp_before_comma
Add or remove space before ',', i.e. 'a,b' vs. 'a ,b'.
Default: remove
Type: multiple (ignore add remove force)
Default: remove
|
remove
|
|
|
|
|
|
|
|
|
|
|
sp_before_constr_colon
Add or remove space before class constructor ':'.
Default: add
Type: multiple (ignore add remove force)
Default: add
|
add
|
|
|
ignore |
|
|
|
|
|
remove |
|
sp_before_dc
Add or remove space before the '::' operator.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
remove |
|
|
|
|
|
remove |
remove |
sp_before_ellipsis
Add or remove space before the variadic '...' when preceded by a
non-punctuator.
The value REMOVE will be overridden with FORCE
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
force |
|
|
|
|
force |
|
sp_before_emb_cmt
Add or remove space before an embedded comment.
Default: force
Type: multiple (ignore add remove force)
Default: force
|
force
|
|
|
|
|
|
|
|
|
|
|
sp_before_for_colon
Add or remove space before ':' in a Java/C++11 range-based 'for',
as in 'for (Type var <here> : expr)'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_before_global_scope_ptr_star
Add or remove space before pointer star '*' that is followed by '::',
as in 'int *::func()'.
If set to ignore, sp_before_unnamed_ptr_star is used instead.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_before_mdatype_commas
(C#, Vala) Add or remove space between '[' and ',' in multidimensional array type
like 'int[,,]'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
sp_before_nl_cont
Add or remove space before a backslash-newline at the end of a line.
Default: add
Type: multiple (ignore add remove force)
Default: add
|
add
|
remove |
remove |
force |
|
|
|
|
|
force |
|
sp_before_oc_block_caret
(OC) Add or remove space before a block pointer caret,
i.e. '^int (int arg){...}' vs. ' ^int (int arg){...}'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
sp_before_oc_colon
(OC) Add or remove space before the colon in message specs,
i.e. '-(int) f: (int) x;' vs. '-(int) f : (int) x;'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
|
|
|
|
|
|
force |
|
sp_before_oc_dict_colon
(OC) Add or remove space before the colon in immutable dictionary expression
'NSDictionary *test = @{@"foo" :@"bar"};'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_before_oc_proto_list
(OC) Add or remove space before Objective-C protocol list
as in '@protocol Protocol<here><Protocol_A>' or '@interface MyClass : NSObject<here><MyProtocol>'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_before_operator_ptr_star
Add or remove space before pointer star '*' that is followed by 'operator' keyword.
If set to ignore, sp_before_unnamed_ptr_star is used instead.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_before_pp_stringify
Add or remove space before preprocessor '#' stringify operator
as in '#define x(y) L#y'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_before_ptr_star
Add or remove space before pointer star '*'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
|
force |
|
|
|
force |
force |
sp_before_ptr_star_func
Add or remove space before a pointer star '*', if followed by a function
prototype or function definition. If set to ignore, sp_before_ptr_star is
used instead.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
force |
|
|
|
|
|
force |
|
sp_before_ptr_star_trailing
Add or remove space before a pointer star '*' in the trailing return of a
function prototype or function definition.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_before_qualifier_ptr_star
Add or remove space before pointer star '*' that is followed by a qualifier.
If set to ignore, sp_before_unnamed_ptr_star is used instead.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_before_scope_ptr_star
Add or remove space before pointer star '*' that is followed by
a class scope (as in 'int *MyClass::method()') or namespace scope
(as in 'int *my_ns::func()').
If set to ignore, sp_before_unnamed_ptr_star is used instead.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
sp_before_semi
Add or remove space before ';'.
Default: remove
Type: multiple (ignore add remove force)
Default: remove
|
remove
|
|
|
|
|
|
|
|
|
|
|
sp_before_semi_for
Add or remove space before ';' in non-empty 'for' statements.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
|
|
|
|
|
|
remove |
|
sp_before_semi_for_empty
Add or remove space before a semicolon of an empty left part of a for
statement, as in 'for ( <here> ; ; )'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
|
|
|
|
|
|
remove |
force |
sp_before_send_oc_colon
(OC) Add or remove space before the colon in message specs,
i.e. '[object setValue:1];' vs. '[object setValue :1];'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
|
|
|
|
|
|
remove |
|
sp_before_sparen
Add or remove space before '(' of control statements ('if', 'for', 'switch',
'while', etc.).
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
force |
force |
force |
force |
force |
force |
force |
sp_before_square
Add or remove space before '[' (except '[]').
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
remove |
remove |
|
|
|
|
remove |
|
sp_before_square_asm_block
Add or remove space before '[' for asm block.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_before_squares
Add or remove space before '[]'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
remove |
|
|
|
|
|
remove |
|
sp_before_template_paren
(D) Add or remove space before the parenthesis in the D constructs
'template Foo(' and 'class Foo('.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
sp_before_tr_cmt
Add or remove space before a trailing comment.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_before_type_brace_init_lst_close
Add or remove space before close brace in an unnamed temporary
direct-list-initialization
if statement is a brace_init_lst
works only if sp_brace_brace is set to ignore.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_before_unnamed_byref
Add or remove space before a reference sign '&' that isn't followed by a
variable name. If set to ignore, sp_before_byref is used instead.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
|
force |
|
|
|
|
force |
|
sp_before_unnamed_ptr_star
Add or remove space before pointer star '*' that isn't followed by a
variable name. If set to ignore, sp_before_ptr_star is used instead.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
|
force |
|
|
|
|
force |
|
sp_before_vardef_square
Add or remove space before '[' for a variable definition.
Default: remove
Type: multiple (ignore add remove force)
Default: remove
|
remove
|
|
|
|
|
|
|
|
|
|
|
sp_between_mdatype_commas
(C#, Vala) Add or remove space between ',' in multidimensional array type
like 'int[,,]'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
sp_between_new_paren
Add or remove space between 'new' and '(' in 'new()'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
sp_between_ptr_ref
Add or remove space between pointer star '*' and reference '&', as in 'int *& a;'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_between_ptr_star
Add or remove space between pointer stars '*', as in 'int ***a;'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
remove |
|
remove |
|
|
|
remove |
remove |
sp_between_semi_for_empty
Add or remove space between the semicolons of an empty middle part of a for
statement, as in 'for ( ; <here> ; )'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
force |
sp_bool
Add or remove space around boolean operators '&&' and '||'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
force |
force |
add |
force |
force |
force |
force |
sp_brace_brace
Add or remove space between nested braces, i.e. '{{' vs. '{ {'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_brace_catch
Add or remove space between '}' and 'catch' if on the same line.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
|
|
|
|
|
force |
|
sp_brace_close_while
Add or remove space between '}' and 'while'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_brace_else
Add or remove space between '}' and 'else' if on the same line.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
force |
force |
|
|
|
force |
|
sp_brace_finally
Add or remove space between '}' and 'finally' if on the same line.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
|
|
|
|
|
force |
|
sp_brace_typedef
Add or remove space between '}' and the name of a typedef on the same line.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
force |
|
|
|
|
force |
force |
sp_byref_ellipsis
Add or remove space between '&&' and '...'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_byref_paren
Add or remove space after a reference sign '&', if followed by an open
parenthesis, as in 'char& (*)()'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_case_label
Fix the spacing between 'case' and the label. Only 'ignore' and 'force' make
sense here.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
force |
|
|
|
|
|
force |
remove |
sp_catch_brace
Add or remove space before the '{' of a 'catch' statement, if the '{' and
'catch' are on the same line, as in 'catch (decl) <here> {'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
|
|
|
|
|
force |
|
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
sp_catch_paren
Add or remove space between 'catch' and '(' in 'catch (something) { }'.
If set to ignore, sp_before_sparen is used.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_cmt_cpp_doxygen
If true, space added with sp_cmt_cpp_start will be added after Doxygen
sequences like '///', '///<', '//!' and '//!<'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
sp_cmt_cpp_lint
remove space after the '//' and the command 'lint',
only works with sp_cmt_cpp_start set to add or force.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
sp_cmt_cpp_pvs
remove space after the '//' and the pvs command '-V1234',
only works with sp_cmt_cpp_start set to add or force.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
sp_cmt_cpp_qttr
If true, space added with sp_cmt_cpp_start will be added after Qt translator
or meta-data comments like '//:', '//=', and '//~'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
sp_cmt_cpp_region
Add or remove space in a C++ region marker comment, as in '// <here> BEGIN'.
A region marker is defined as a comment which is not preceded by other text
(i.e. the comment is the first non-whitespace on the line), and which starts
with either 'BEGIN' or 'END'.
Overrides sp_cmt_cpp_start.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_cmt_cpp_start
Add or remove space after the opening of a C++ comment, as in '// <here> A'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
|
|
|
|
|
|
force |
|
sp_compare
Add or remove space around compare operator '<', '>', '==', etc.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
force |
force |
add |
force |
force |
force |
force |
sp_cond_colon
Add or remove space around the ':' in 'b ? t : f'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
|
|
|
|
|
force |
|
sp_cond_colon_after
Add or remove space after the ':' in 'b ? t : f'.
Overrides sp_cond_colon.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_cond_colon_before
Add or remove space before the ':' in 'b ? t : f'.
Overrides sp_cond_colon.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_cond_question
Add or remove space around the '?' in 'b ? t : f'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
|
|
|
|
|
force |
|
sp_cond_question_after
Add or remove space after the '?' in 'b ? t : f'.
Overrides sp_cond_question.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_cond_question_before
Add or remove space before the '?' in 'b ? t : f'.
Overrides sp_cond_question.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_cond_ternary_short
In the abbreviated ternary form '(a ?: b)', add or remove space between '?'
and ':'.
Overrides all other sp_cond_* options.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_cparen_oparen
Add or remove space between back-to-back parentheses, i.e. ')(' vs. ') ('.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
sp_cpp_before_struct_binding
Add or remove space before C++17 structured bindings.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_cpp_before_struct_binding_after_byref
Add or remove space before C++17 structured bindings
after byref.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_cpp_cast_paren
Add or remove space between the type and open parenthesis in a C++ cast,
i.e. 'int(exp)' vs. 'int (exp)'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
remove |
|
|
|
|
|
remove |
|
sp_cpp_lambda_argument_list
Add or remove space after the opening parenthesis and before the closing
parenthesis of a argument list of a C++11 lambda, as in
'[]( <here> int x <here> ){ ... }'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_cpp_lambda_argument_list_empty
Add or remove space after the opening parenthesis and before the closing
parenthesis of a argument list of a C++11 lambda, as in
'[]( <here> ){ ... }'
with an empty list.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_cpp_lambda_assign
Add or remove space around '=' in C++11 lambda capture specifications.
Overrides sp_assign.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_cpp_lambda_fparen
Add or remove space between a lambda body and its call operator of an
immediately invoked lambda, as in '[]( ... ){ ... } <here> ( ... )'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_cpp_lambda_paren_brace
Add or remove space after the argument list of a C++11 lambda, as in
'[](int x) <here> { ... }'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_cpp_lambda_square_brace
Add or remove space after the capture specification of a C++11 lambda with
no argument list is present, as in '[] <here> { ... }'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_cpp_lambda_square_paren
Add or remove space after the capture specification of a C++11 lambda when
an argument list is present, as in '[] <here> (int x){ ... }'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_d_array_colon
(D) Add or remove around the D named array initializer ':' operator.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_decltype_paren
Add or remove space between 'decltype' and '('.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_defined_paren
Add or remove space between 'defined' and '(' in '#if defined (FOO)'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
|
remove |
|
|
|
|
remove |
|
sp_deref
Add or remove space after the '*' (dereference) unary operator. This does
not affect the spacing after a '*' that is part of a type.
Default: remove
Type: multiple (ignore add remove force)
Default: remove
|
remove
|
|
|
|
|
|
|
|
|
|
|
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
sp_do_brace_open
Add or remove space between 'do' and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_ellipsis_parameter_pack
Add or remove space between '...' and a parameter pack.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_else_brace
Add or remove space between 'else' and '{' if on the same line.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
force |
force |
|
|
|
force |
|
sp_endif_cmt
Add or remove space between #else or #endif and a trailing comment.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_enum_after_assign
Add or remove space after assignment '=' in enum.
Overrides sp_enum_assign.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
force |
|
|
|
|
force |
|
sp_enum_assign
Add or remove space around assignment '=' in enum.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
|
force |
|
|
|
|
force |
|
sp_enum_before_assign
Add or remove space before assignment '=' in enum.
Overrides sp_enum_assign.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
force |
|
|
|
|
force |
|
sp_enum_brace
Add or remove space in 'enum {'.
Default: add
Type: multiple (ignore add remove force)
Default: add
|
add
|
|
|
|
|
|
|
|
|
|
|
sp_enum_colon
Add or remove space around assignment ':' in enum.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_enum_paren
Add or remove space in 'NS_ENUM ('.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_extern_paren
(D) Add or remove space between 'extern' and '(' as in 'extern <here> (C)'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_finally_brace
Add or remove space between 'finally' and '{' if on the same line.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
|
|
|
|
|
force |
|
sp_fparen_brace
Add or remove space between ')' and '{' of function.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
force |
|
|
|
|
force |
add |
sp_fparen_brace_initializer
Add or remove space between ')' and '{' of a function call in object
initialization.
Overrides sp_fparen_brace.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
force |
|
|
|
|
|
|
|
sp_fparen_dbrace
(Java) Add or remove space between ')' and '{{' of double brace initializer.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_func_call_paren
Add or remove space between function name and '(' on function calls.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
remove |
remove |
remove |
remove |
remove |
remove |
remove |
remove |
sp_func_call_paren_empty
Add or remove space between function name and '()' on function calls without
parameters. If set to ignore (the default), sp_func_call_paren is used.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
remove |
|
|
|
|
remove |
|
sp_func_call_user_inside_fparen
Add or remove space inside user function '(' and ')'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_func_call_user_inside_rparen
Add or remove space inside user functor '(' and ')'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_func_call_user_paren
Add or remove space between the user function name and '(' on function
calls. You need to set a keyword to be a user function in the config file,
like:
set func_call_user tr _ i18n
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
|
|
|
|
|
|
remove |
|
sp_func_call_user_paren_paren
Add or remove space between nested parentheses with user functions,
i.e. '((' vs. '( ('.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_func_class_paren
Add or remove space between a constructor/destructor and the open
parenthesis.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
remove |
|
|
|
|
|
remove |
remove |
sp_func_class_paren_empty
Add or remove space between a constructor without parameters or destructor
and '()'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
|
|
|
|
|
|
|
sp_func_def_paren
Add or remove space between alias name and '(' of a non-pointer function type typedef.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
remove |
remove |
remove |
remove |
remove |
remove |
remove |
remove |
sp_func_def_paren_empty
Add or remove space between function name and '()' on function definition
if empty.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
|
|
|
|
|
|
|
sp_func_proto_paren
Add or remove space between function name and '(' on function declaration.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
remove |
remove |
remove |
remove |
remove |
remove |
remove |
remove |
sp_func_proto_paren_empty
Add or remove space between function name and '()' on function declaration
if empty.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
|
|
|
|
|
|
|
sp_func_type_paren
Add or remove space between function name and '(' with a typedef specifier.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_getset_brace
Add or remove space between get/set and '{' if on the same line.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
|
|
|
|
|
|
force |
|
sp_incdec
Add or remove space between '++' and '--' the word to which it is being
applied, as in '(--x)' or 'y++;'.
Default: remove
Type: multiple (ignore add remove force)
Default: remove
|
remove
|
|
|
|
|
|
|
|
|
|
|
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
sp_inside_angle
Add or remove space inside '<' and '>'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
remove |
|
|
|
|
|
remove |
remove |
sp_inside_angle_empty
Add or remove space inside '<>'.
if empty.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_inside_braces
Add or remove space inside '{' and '}'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
remove |
force |
force |
add |
force |
force |
force |
force |
sp_inside_braces_empty
Add or remove space inside '{}'.
if empty.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
remove |
force |
|
|
|
|
remove |
|
sp_inside_braces_enum
Add or remove space inside enum '{' and '}'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
|
force |
force |
add |
force |
force |
force |
force |
sp_inside_braces_oc_dict
(OC) Add or remove space inside Objective-C boxed dictionary '{' and '}'
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_inside_braces_struct
Add or remove space inside struct/union '{' and '}'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
|
force |
force |
add |
force |
force |
force |
force |
sp_inside_for
Add or remove space inside '(' and ')' of 'for' statements.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
remove |
|
remove |
remove |
remove |
remove |
sp_inside_for_close
Add or remove space before ')' of 'for' statements.
Overrides sp_inside_for.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
sp_inside_for_open
Add or remove space after '(' of 'for' statements.
Overrides sp_inside_for.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
sp_inside_fparen
Add or remove space inside function '(' and ')'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
remove |
remove |
remove |
|
remove |
remove |
remove |
remove |
sp_inside_fparens
Add or remove space inside empty function '()'.
Overrides sp_after_angle unless use_sp_after_angle_always is set to true.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
remove |
remove |
|
|
|
|
remove |
|
sp_inside_newop_paren
Add or remove space inside parentheses of the new operator
as in 'new(foo) BAR'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_inside_newop_paren_close
Add or remove space before the close parenthesis of the new operator,
as in 'new(foo) BAR'.
Overrides sp_inside_newop_paren.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_inside_newop_paren_open
Add or remove space after the open parenthesis of the new operator,
as in 'new(foo) BAR'.
Overrides sp_inside_newop_paren.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_inside_oc_at_sel_parens
(OC) Add or remove space inside '@selector' parentheses,
i.e. '@selector(foo)' vs. '@selector( foo )'.
Also applies to '@protocol()' constructs.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
sp_inside_paren
Add or remove space inside '(' and ')'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
|
remove |
remove |
|
remove |
remove |
remove |
remove |
sp_inside_paren_cast
Add or remove spaces inside cast parentheses.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
remove |
remove |
remove |
|
|
|
remove |
|
sp_inside_rparen
Add or remove space inside functor '(' and ')'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_inside_rparens
Add or remove space inside empty functor '()'.
Overrides sp_after_angle unless use_sp_after_angle_always is set to true.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_inside_sparen
Add or remove space inside '(' and ')' of control statements other than
'for'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
remove |
remove |
remove |
|
remove |
remove |
remove |
remove |
sp_inside_sparen_close
Add or remove space before ')' of control statements other than 'for'.
Overrides sp_inside_sparen.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
remove |
|
|
|
|
remove |
|
sp_inside_sparen_open
Add or remove space after '(' of control statements other than 'for'.
Overrides sp_inside_sparen.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
sp_inside_square
Add or remove space inside a non-empty '[' and ']'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
remove |
remove |
remove |
|
|
|
remove |
remove |
sp_inside_square_empty
Add or remove space inside '[]'.
if empty.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_inside_square_oc_array
(OC) Add or remove space inside a non-empty Objective-C boxed array '@[' and
']'. If set to ignore, sp_inside_square is used.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_inside_tparen
Add or remove space inside the first parentheses in a function type, as in
'void (*x)(...)'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
sp_inside_type_brace_init_lst
Add or remove space inside an unnamed temporary direct-list-initialization
if statement is a brace_init_lst
works only if sp_brace_brace is set to ignore
works only if sp_before_type_brace_init_lst_close is set to ignore.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_inv
Add or remove space after the '~' (invert) unary operator.
Default: remove
Type: multiple (ignore add remove force)
Default: remove
|
remove
|
|
|
|
|
|
|
|
|
|
|
sp_invariant_paren
(D) Add or remove space between 'invariant' and '('.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
sp_macro
Add or remove space between a macro name and its definition.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
|
force |
|
|
|
|
force |
|
sp_macro_func
Add or remove space between a macro function ')' and its definition.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
|
force |
|
|
|
|
force |
|
sp_member
Add or remove space around the '.' or '->' operators.
Default: remove
Type: multiple (ignore add remove force)
Default: remove
|
remove
|
|
|
|
|
|
|
|
|
|
|
sp_not
Add or remove space after the '!' (not) unary operator.
Default: remove
Type: multiple (ignore add remove force)
Default: remove
|
remove
|
|
|
|
|
|
|
|
|
|
|
sp_not_not
Add or remove space between two '!' (not) unary operators.
If set to ignore, sp_not will be used.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_num_after_emb_cmt
Number of spaces after an embedded comment.
Default: 1
Type: numeric [0 .. 16]
Default: 1
|
1
|
|
|
|
|
|
|
|
|
|
|
sp_num_before_emb_cmt
Number of spaces before an embedded comment.
Default: 1
Type: numeric [0 .. 16]
Default: 1
|
1
|
|
|
|
|
|
|
|
|
|
|
sp_num_before_tr_cmt
Number of spaces before a trailing comment.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
sp_oc_brace_catch
(OC) Add or remove space between '}' and '@catch' if on the same line.
If set to ignore, sp_brace_catch is used.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_oc_catch_brace
(OC) Add or remove space before the '{' of a '@catch' statement, if the '{'
and '@catch' are on the same line, as in '@catch (decl) <here> {'.
If set to ignore, sp_catch_brace is used.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_oc_catch_paren
(OC) Add or remove space between '@catch' and '('
in '@catch (something) { }'. If set to ignore, sp_catch_paren is used.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_oc_classname_paren
(OC) Add or remove space between class name and '('
in '@interface className(categoryName)<ProtocolName>:BaseClass'
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_parameter_pack_ellipsis
Add or remove space between a parameter pack and '...'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_paren_brace
Add or remove space between ')' and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
force |
|
|
|
|
force |
|
sp_paren_comma
Add or remove space between an open parenthesis and comma,
i.e. '(,' vs. '( ,'.
Default: force
Type: multiple (ignore add remove force)
Default: force
|
force
|
|
|
|
|
|
|
|
|
|
|
sp_paren_ellipsis
Add or remove space between ')' and '...'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_paren_noexcept
Add or remove space between ')' and 'noexcept'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_paren_paren
Add or remove space between nested parentheses, i.e. '((' vs. ') )'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
|
remove |
remove |
|
remove |
remove |
remove |
remove |
sp_paren_qualifier
Add or remove space between ')' and a qualifier such as 'const'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_permit_cpp11_shift
(C++11) Permit removal of the space between '>>' in 'foo<bar<int> >'. Note
that sp_angle_shift cannot remove the space without this option.
Type: boolean [false, true]
Default: false
|
false
|
|
|
true |
|
|
|
|
|
|
|
sp_pp_concat
Add or remove space around preprocessor '##' concatenation operator.
Default: add
Type: multiple (ignore add remove force)
Default: add
|
add
|
|
|
force |
|
|
|
|
|
force |
|
sp_pp_stringify
Add or remove space after preprocessor '#' stringify operator.
Also affects the '#@' charizing operator.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
remove |
add |
|
|
|
|
force |
add |
sp_ptr_star_func_type
Add or remove space between the pointer star '*' and the name of the type
in a function pointer type definition.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_ptr_star_func_var
Add or remove space between the pointer star '*' and the name of the variable
in a function pointer definition.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
remove |
|
|
|
remove |
|
sp_ptr_star_paren
Add or remove space after a pointer star '*', if followed by an open
parenthesis, as in 'void* (*)()'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
sp_ptr_type_ellipsis
Add or remove space between a '*' and '...'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_qualifier_ptr_star_func
Add or remove space between a qualifier and a pointer star '*' followed by
the name of the function in a function prototype or definition, as in
'char const *foo()`. If set to ignore, sp_before_ptr_star is used instead.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_qualifier_ptr_star_trailing
Add or remove space between a qualifier and a pointer star '*' in the
trailing return of a function prototype or function definition, as in
'auto foo() -> char const *'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_qualifier_unnamed_ptr_star
Add or remove space between a qualifier and a pointer star '*' that isn't
followed by a variable name, as in '(char const *)'. If set to ignore,
sp_before_ptr_star is used instead.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_range
(D) Add or remove space around the D '..' operator.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
sp_return
Add or remove space after 'return'.
Default: force
Type: multiple (ignore add remove force)
Default: force
|
force
|
|
|
|
|
|
|
|
|
|
|
sp_return_brace
Add or remove space between 'return' and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_return_paren
Add or remove space between 'return' and '('.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
|
force |
force |
|
remove |
remove |
force |
force |
sp_scope_paren
(D) Add or remove space between 'scope' and '('
in 'scope (something) { }'. If set to ignore, sp_before_sparen is used.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_sign
Add or remove space after '+' or '-', as in 'x = -5' or 'y = +7'.
Default: remove
Type: multiple (ignore add remove force)
Default: remove
|
remove
|
|
|
|
|
|
|
|
|
|
|
sp_sizeof_ellipsis
Add or remove space between 'sizeof' and '...'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_sizeof_ellipsis_paren
Add or remove space between 'sizeof...' and '('.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_sizeof_paren
Add or remove space between 'sizeof' and '('.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
remove |
remove |
remove |
remove |
remove |
remove |
force |
remove |
sp_skip_vbrace_tokens
If true, vbrace tokens are dropped to the previous token and skipped.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
sp_sparen_brace
Add or remove space between ')' and '{' of control statements.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
force |
|
|
|
|
force |
add |
sp_sparen_paren
Add or remove space between '((' or '))' of control statements.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_special_semi
Add or remove space before empty statement ';' on 'if', 'for' and 'while'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
|
force |
|
|
|
|
remove |
|
sp_square_fparen
Add or remove space between ']' and '(' when part of a function call.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
remove |
remove |
|
|
|
|
remove |
|
sp_string_string
Add or remove space between two strings.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_super_paren
Add or remove space between 'super' and '(' in 'super (something)'.
Default: remove
Type: multiple (ignore add remove force)
Default: remove
|
remove
|
|
|
|
|
|
|
|
|
|
|
sp_template_angle
Add or remove space between 'template' and '<'.
If set to ignore, sp_before_angle is used.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
sp_this_paren
Add or remove space between 'this' and '(' in 'this (something)'.
Default: remove
Type: multiple (ignore add remove force)
Default: remove
|
remove
|
|
|
|
|
|
|
|
|
|
|
sp_throw_paren
Add or remove space between 'throw' and '(' in 'throw (something)'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
|
|
|
|
|
|
force |
|
sp_trailing_return
Add or remove space around trailing return operator '->'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_try_brace
Add or remove space between 'try' and '{' if on the same line.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
|
|
|
|
|
force |
|
sp_type_brace_init_lst
Add or remove space between type and open brace of an unnamed temporary
direct-list-initialization.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
add |
|
sp_type_colon
Add or remove space between a type and ':'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_type_ellipsis
Add or remove space between a type and '...'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_type_func
Add or remove space between return type and function name. A minimum of 1
is forced except for pointer return types.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
|
|
|
|
|
|
remove |
force |
sp_vala_after_translation
Add or remove space after '_'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_version_paren
(D) Add or remove space between 'version' and '('
in 'version (something) { }'. If set to ignore, sp_before_sparen is used.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_while_paren_open
Add or remove space between 'while' and '('. Overrides sp_before_sparen.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_word_brace_init_lst
Add or remove space between a variable and '{' for C++ uniform
initialization.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_word_brace_ns
Add or remove space between a variable and '{' for a namespace.
Default: add
Type: multiple (ignore add remove force)
Default: add
|
add
|
|
|
|
|
|
|
|
|
force |
|
string_escape_char
The ASCII value of the string escape char, usually 92 (\) or (Pawn) 94 (^).
Default: 92
Type: numeric [0 .. 255]
Default: 92
|
92
|
|
|
|
|
|
|
|
|
|
|
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
string_escape_char2
Alternate string escape char (usually only used for Pawn).
Only works right before the quote char.
Type: numeric [0 .. 255]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
string_replace_tab_chars
Replace tab characters found in string literals with the escape sequence \t
instead.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
true |
|
tok_split_gte
Allow interpreting '>=' and '>>=' as part of a template in code like
'void f(list<list<B>>=val);'. If true, 'assert(x<0 && y>=3)' will be broken.
Improvements to template detection may make this option obsolete.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
use_form_feed_no_more_as_whitespace_character
If true: the form feed character is removed from the list of whitespace
characters. See https://en.cppreference.com/w/cpp/string/byte/isspace.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
use_indent_continue_only_once
The value of the indentation for a continuation line is calculated
differently if the statement is:
- a declaration: your case with QString fileName ...
- an assignment: your case with pSettings = new QSettings( ...
At the second case the indentation value might be used twice:
- at the assignment
- at the function call (if present)
To prevent the double use of the indentation value, use this option with the
value 'true'.
true: indent_continue will be used only once
false: indent_continue will be used every time (default)
Requires indent_ignore_first_continue=false.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
use_indent_func_call_param
true: indent_func_call_param will be used (default)
false: indent_func_call_param will NOT be used
Default: true
Type: boolean [false, true]
Default: true
|
true
|
|
|
|
|
|
|
|
|
|
|
use_options_overriding_for_qt_macros
Whether to apply special formatting for Qt SIGNAL/SLOT macros. Essentially,
this tries to format these so that they match Qt's normalized form (i.e. the
result of QMetaObject::normalizedSignature), which can slightly improve the
performance of the QObject::connect call, rather than how they would
otherwise be formatted.
See options_for_QT.cpp for details.
Default: true
Type: boolean [false, true]
Default: true
|
true
|
|
|
|
|
|
|
|
|
|
|
use_sp_after_angle_always
Whether sp_after_angle takes precedence over sp_inside_fparen. This was the
historic behavior, but is probably not the desired behavior, so this is off
by default.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
utf8_bom
Add or remove the UTF-8 BOM (recommend 'remove').
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
utf8_byte
If the file contains bytes with values between 128 and 255, but is not
UTF-8, then output as UTF-8.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
true |
|
|
|
|
|
|
utf8_force
Force the output encoding to UTF-8.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
true |
|
|
|
|
|
|
warn_level_tabs_found_in_verbatim_string_literals
(C#) Warning is given if doing tab-to-\t replacement and we have found one
in a C# verbatim string literal.
Default: 2
Type: numeric [1 .. 3]
Default: 2
|
2
|
|
|
|
|
|
|
|
|
|
|
General options |
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
disable_processing_cmt
Specify the marker used in comments to disable processing of part of the
file.
Default: *INDENT-OFF*
Type: string
Default: *INDENT-OFF*
|
*INDENT-OFF*
|
|
|
|
|
|
|
|
|
|
|
disable_processing_nl_cont
Disable formatting of NL_CONT ('\\n') ended lines (e.g. multi-line macros).
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
enable_digraphs
Enable parsing of digraphs.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
enable_processing_cmt
Specify the marker used in comments to (re)enable processing in a file.
Default: *INDENT-ON*
Type: string
Default: *INDENT-ON*
|
*INDENT-ON*
|
|
|
|
|
|
|
|
|
|
|
input_tab_size
The original size of tabs in the input.
Default: 8
Type: numeric [1 .. 32]
Default: 8
|
8
|
|
|
|
|
|
|
|
|
|
|
newlines
The type of line endings.
Default: auto
Type: multiple (lf crlf cr auto)
Default: auto
|
auto
|
|
|
|
|
|
|
|
|
|
lf |
output_tab_size
The size of tabs in the output (only used if align_with_tabs=true).
Default: 8
Type: numeric [1 .. 32]
Default: 8
|
8
|
|
|
|
|
|
|
|
|
|
|
processing_cmt_as_regex
Option to allow both disable_processing_cmt and enable_processing_cmt
strings, if specified, to be interpreted as ECMAScript regular expressions.
If true, a regex search will be performed within comments according to the
specified patterns in order to disable/enable processing.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
string_escape_char
The ASCII value of the string escape char, usually 92 (\) or (Pawn) 94 (^).
Default: 92
Type: numeric [0 .. 255]
Default: 92
|
92
|
|
|
|
|
|
|
|
|
|
|
string_escape_char2
Alternate string escape char (usually only used for Pawn).
Only works right before the quote char.
Type: numeric [0 .. 255]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
string_replace_tab_chars
Replace tab characters found in string literals with the escape sequence \t
instead.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
true |
|
tok_split_gte
Allow interpreting '>=' and '>>=' as part of a template in code like
'void f(list<list<B>>=val);'. If true, 'assert(x<0 && y>=3)' will be broken.
Improvements to template detection may make this option obsolete.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
utf8_bom
Add or remove the UTF-8 BOM (recommend 'remove').
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
utf8_byte
If the file contains bytes with values between 128 and 255, but is not
UTF-8, then output as UTF-8.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
true |
|
|
|
|
|
|
utf8_force
Force the output encoding to UTF-8.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
true |
|
|
|
|
|
|
Blank line options |
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
eat_blanks_after_open_brace
Whether to remove blank lines after '{'.
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
|
|
true |
|
TRUE |
TRUE |
true |
true |
eat_blanks_before_close_brace
Whether to remove blank lines before '}'.
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
|
|
true |
|
TRUE |
TRUE |
true |
true |
nl_after_access_spec
The number of newlines after an access specifier label. This also includes
the Qt-specific 'signals:' and 'slots:'. Will not change the newline count
if after a brace open.
0: No change (default).
Overrides nl_typedef_blk_start and nl_var_def_blk_start.
Type: numeric [0 .. 16]
Default: 0
|
0
|
2 |
2 |
1 |
|
|
|
|
|
1 |
|
nl_after_annotation
(Java) Add or remove newline after an annotation statement. Only affects
annotations that are after a newline.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
nl_after_class
The number of newlines after '}' or ';' of a class definition.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
2 |
|
nl_after_func_body
The number of newlines after '}' of a multi-line function body.
Overrides nl_min_after_func_body and nl_max_after_func_body.
Type: numeric [0 .. 16]
Default: 0
|
0
|
2 |
2 |
|
|
|
|
|
|
2 |
3 |
nl_after_func_body_class
The number of newlines after '}' of a multi-line function body in a class
declaration. Also affects class constructors/destructors.
Overrides nl_after_func_body.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
1 |
|
nl_after_func_body_one_liner
The number of newlines after '}' of a single line function body. Also
affects class constructors/destructors.
Overrides nl_after_func_body and nl_after_func_body_class.
Type: numeric [0 .. 16]
Default: 0
|
0
|
2 |
2 |
|
|
|
|
|
|
1 |
|
nl_after_func_class_proto
The number of newlines after a class constructor/destructor prototype.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
nl_after_func_class_proto_group
The number of newlines after a class constructor/destructor prototype,
if not followed by another constructor/destructor prototype.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
nl_after_func_proto
The number of newlines after a function prototype.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
1 |
|
nl_after_func_proto_group
The number of newlines after a function prototype, if not followed by
another function prototype.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
2 |
2 |
nl_after_label_colon
Whether to force a newline after a label's colon.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
true |
|
|
|
|
|
nl_after_multiline_comment
Whether to force a newline after a multi-line comment.
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
|
|
|
|
|
|
true |
|
nl_after_namespace
The number of newlines after '}' of a namespace.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
2 |
|
nl_after_struct
The number of newlines after '}' or ';' of a struct/enum/union definition.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
2 |
|
nl_after_try_catch_finally
The number of newlines after a try-catch-finally block that isn't followed
by a brace close.
0: No change (default).
Type: numeric [0 .. 16]
Default: 0
|
0
|
1 |
1 |
|
|
|
|
|
|
1 |
|
nl_after_whole_file_endif
The number of newlines after a whole-file #endif.
0: No change (default).
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
nl_after_whole_file_ifdef
The number of newlines after a whole-file #ifdef.
0: No change (default).
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
nl_around_cs_property
(C#) The number of newlines before and after a property, indexer or event
declaration.
0: No change (default).
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
1 |
|
nl_before_access_spec
The number of newlines before an access specifier label. This also includes
the Qt-specific 'signals:' and 'slots:'. Will not change the newline count
if after a brace open.
0: No change (default).
Type: numeric [0 .. 16]
Default: 0
|
0
|
2 |
2 |
2 |
|
|
|
|
|
2 |
|
nl_before_block_comment
The minimum number of newlines before a multi-line comment.
Doesn't apply if after a brace open or another multi-line comment.
Type: numeric [0 .. 16]
Default: 0
|
0
|
2 |
2 |
|
|
|
|
|
|
2 |
2 |
nl_before_c_comment
The minimum number of newlines before a single-line C comment.
Doesn't apply if after a brace open or other single-line C comments.
Type: numeric [0 .. 16]
Default: 0
|
0
|
2 |
2 |
|
|
|
|
|
|
1 |
|
nl_before_class
The number of newlines before a class definition.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
nl_before_cpp_comment
The minimum number of newlines before a CPP comment.
Doesn't apply if after a brace open or other CPP comments.
Type: numeric [0 .. 16]
Default: 0
|
0
|
2 |
2 |
|
|
|
|
|
|
1 |
|
nl_before_func_body_def
The number of newlines before a multi-line function definition. Where
applicable, this option is overridden with eat_blanks_after_open_brace=true
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
nl_before_func_body_proto
The number of newlines before a function prototype.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
nl_before_func_class_def
The number of newlines before a class constructor/destructor definition.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
nl_before_func_class_proto
The number of newlines before a class constructor/destructor prototype.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
nl_before_namespace
The number of newlines before a namespace.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
nl_before_struct
The number of newlines before a struct definition.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
nl_before_whole_file_endif
The number of newlines before a whole-file #endif.
0: No change (default).
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
nl_before_whole_file_ifdef
The number of newlines before a whole-file #ifdef.
0: No change (default).
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
nl_between_annotation
(Java) Add or remove newline between two annotations.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_between_get_set
(C#) The number of newlines between the get/set/add/remove handlers.
0: No change (default).
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
1 |
|
nl_class_leave_one_liner_groups
Whether one-line method definitions inside a class body should be treated
as if they were prototypes for the purposes of adding newlines.
Requires nl_class_leave_one_liners=true. Overrides nl_before_func_body_def
and nl_before_func_class_def for one-liners.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_comment_func_def
The number of newlines between a function definition and the function
comment, as in '// comment\n <here> void foo() {...}'.
0: No change (default).
Type: numeric [0 .. 16]
Default: 0
|
0
|
1 |
1 |
|
|
1 |
|
|
|
1 |
1 |
nl_inside_empty_func
The number of newlines inside an empty function body.
This option overrides eat_blanks_after_open_brace and
eat_blanks_before_close_brace, but is ignored when
nl_collapse_empty_body_functions=true
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
nl_inside_namespace
The number of newlines after '{' of a namespace. This also adds newlines
before the matching '}'.
0: Apply eat_blanks_after_open_brace or eat_blanks_before_close_brace if
applicable, otherwise no change.
Overrides eat_blanks_after_open_brace and eat_blanks_before_close_brace.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
nl_max
The maximum number of consecutive newlines (3 = 2 blank lines).
Type: numeric [0 .. 16]
Default: 0
|
0
|
3 |
3 |
3 |
2 |
|
|
|
|
2 |
4 |
nl_max_after_func_body
The maximum number of newlines after '}' of a multi-line function body.
Only works when nl_after_func_body is 0.
Takes precedence over nl_min_after_func_body.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
nl_max_blank_in_func
The maximum number of consecutive newlines in a function.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
nl_min_after_func_body
The minimum number of newlines after '}' of a multi-line function body.
Only works when nl_after_func_body is 0.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
nl_property_brace
(C#) Add or remove newline between property and the '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
nl_remove_extra_newlines
How aggressively to remove extra newlines not in preprocessor.
0: No change (default)
1: Remove most newlines not handled by other config
2: Remove all newlines and reformat completely by config
Type: numeric [0 .. 2]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
1 |
|
nl_typedef_blk_end
The number of newlines after a block of typedefs.
0: No change (default).
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
2 |
|
nl_typedef_blk_in
The maximum number of consecutive newlines within a block of typedefs.
0: No change (default).
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
1 |
|
nl_typedef_blk_start
The number of newlines before a block of typedefs. If nl_after_access_spec
is non-zero, that option takes precedence.
0: No change (default).
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
2 |
|
nl_var_def_blk_end
The minimum number of empty newlines after a block of variable definitions
not at the top of a function body. Newlines are not added if the block
is at the bottom of the file or just before a preprocessor directive.
0: No change (default).
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
2 |
|
nl_var_def_blk_end_func_top
The minimum number of blank lines after a block of variable definitions
at the top of a function body. If any preprocessor directives appear
between the opening brace of the function and the variable block, then
it is considered as not at the top of the function.Newlines are added
before trailing preprocessor directives, if any exist.
0: No change (default).
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
1 |
1 |
|
1 |
1 |
1 |
nl_var_def_blk_in
The maximum number of consecutive newlines within a block of variable
definitions.
0: No change (default).
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
1 |
|
nl_var_def_blk_start
The minimum number of empty newlines before a block of variable definitions
not at the top of a function body. If nl_after_access_spec is non-zero,
that option takes precedence. Newlines are not added at the top of the
file or just after an opening brace. Newlines are added above any
preprocessor directives before the block.
0: No change (default).
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
2 |
|
Code alignment options (not left column spaces/tabs) |
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
align_asm_colon
Whether to align text after 'asm volatile ()' colons.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
true |
|
align_assign_decl_func
How to apply align_assign_span to function declaration "assignments", i.e.
'virtual void foo() = 0' or '~foo() = {default|delete}'.
0: Align with other assignments (default)
1: Align with each other, ignoring regular assignments
2: Don't align
Type: numeric [0 .. 2]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
align_assign_func_proto_span
The span for aligning on '=' in function prototype modifier.
0: Don't align (default).
Type: numeric [0 .. 5000]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
align_assign_on_multi_var_defs
Whether to align on the left most assignment when multiple
definitions are found on the same line.
Depends on 'align_assign_span' and 'align_assign_thresh' settings.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
align_assign_span
The span for aligning on '=' in assignments.
0: Don't align (default).
Type: numeric [0 .. 5000]
Default: 0
|
0
|
1 |
1 |
|
|
|
|
|
|
|
|
align_assign_thresh
The threshold for aligning on '=' in assignments.
Use a negative number for absolute thresholds.
0: No limit (default).
Type: numeric [-1000 .. 5000]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
12 |
align_braced_init_list_span
The span for aligning on '{' in braced init list.
0: Don't align (default).
Type: numeric [0 .. 5000]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
align_braced_init_list_thresh
The threshold for aligning on '{' in braced init list.
Use a negative number for absolute thresholds.
0: No limit (default).
Type: numeric [-1000 .. 5000]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
align_constr_value_gap
The gap for aligning constructor value.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
align_constr_value_span
The span for aligning constructor value.
0: Don't align (default).
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
align_constr_value_thresh
The threshold for aligning constructor value.
Use a negative number for absolute thresholds.
0: No limit (default).
Type: numeric [-1000 .. 5000]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
align_eigen_comma_init
Whether to align comma-separated statements following '<<' (as used to
initialize Eigen matrices).
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
align_enum_equ_span
The span for aligning on '=' in enums.
0: Don't align (default).
Type: numeric [0 .. 5000]
Default: 0
|
0
|
1 |
1 |
|
|
4 |
4 |
|
|
|
16 |
align_enum_equ_thresh
The threshold for aligning on '=' in enums.
Use a negative number for absolute thresholds.
0: no limit (default).
Type: numeric [-1000 .. 5000]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
align_func_params
Whether to align variable definitions in prototypes and functions.
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
|
|
true |
|
|
|
|
|
align_func_params_gap
The gap for aligning function parameter definitions.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
align_func_params_span
The span for aligning parameter definitions in function on parameter name.
0: Don't align (default).
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
align_func_params_thresh
The threshold for aligning function parameter definitions.
Use a negative number for absolute thresholds.
0: No limit (default).
Type: numeric [-1000 .. 5000]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
align_func_proto_amp_style
How to consider (or treat) the '&' in the alignment of function prototypes.
0: Part of the type 'long & foo();' (default)
1: Part of the function 'long &foo();'
2: Dangling 'long &foo();'
Dangling: the '&' will not be taken into account when aligning.
Type: numeric [0 .. 2]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
align_func_proto_gap
Minimum gap between the return type and the function name.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
align_func_proto_span
The span for aligning function prototypes.
0: Don't align (default).
Type: numeric [0 .. 5000]
Default: 0
|
0
|
3 |
3 |
|
|
|
|
|
|
|
|
align_func_proto_span_ignore_cont_lines
Whether to ignore continuation lines when evaluating the number of
new lines for the function prototype alignment's span.
false: continuation lines are part of the newlines count
true: continuation lines are not counted
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
align_func_proto_star_style
How to consider (or treat) the '*' in the alignment of function prototypes.
0: Part of the type 'void * foo();' (default)
1: Part of the function 'void *foo();'
2: Dangling 'void *foo();'
Dangling: the '*' will not be taken into account when aligning.
Type: numeric [0 .. 2]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
align_func_proto_thresh
The threshold for aligning function prototypes.
Use a negative number for absolute thresholds.
0: No limit (default).
Type: numeric [-1000 .. 5000]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
align_keep_extra_space
Whether to keep whitespace not required for alignment.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
align_keep_tabs
Whether to keep non-indenting tabs.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
align_left_shift
Whether to align lines that start with '<<' with previous '<<'.
Default: true
Type: boolean [false, true]
Default: true
|
true
|
|
|
|
|
|
|
|
|
false |
|
align_mix_var_proto
Whether to mix aligning prototype and variable declarations. If true,
align_var_def_XXX options are used instead of align_func_proto_XXX options.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
align_nl_cont
Whether and how to align backslashes that split a macro onto multiple lines.
This will not work right if the macro contains a multi-line comment.
0: Do nothing (default)
1: Align the backslashes in the column at the end of the longest line
2: Align with the backslash that is farthest to the left, or, if that
backslash is farther left than the end of the longest line, at the end of
the longest line
3: Align with the backslash that is farthest to the right
Type: numeric [0 .. 3]
Default: 0
|
0
|
true |
true |
false |
false |
|
|
|
|
|
1 |
align_nl_cont_spaces
The minimum number of spaces between the end of a line and its continuation
backslash. Requires align_nl_cont.
Default: 1
Type: numeric [0 .. 16]
Default: 1
|
1
|
|
|
|
|
|
|
|
|
|
|
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
align_number_right
Whether to right-align numbers.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
true |
true |
align_oc_decl_colon
(OC) Whether to align parameters in an Objective-C '+' or '-' declaration
on the ':'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
true |
|
|
|
|
|
|
align_oc_msg_colon_first
(OC) Whether to always align with the first parameter, even if it is too
short.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
align_oc_msg_colon_span
(OC) Span for aligning parameters in an Objective-C message call
on the ':'.
0: Don't align.
Type: numeric [0 .. 5000]
Default: 0
|
0
|
|
|
|
16 |
|
|
|
|
|
|
align_oc_msg_colon_xcode_like
(OC) Whether to not align parameters in an Objectve-C message call if first
colon is not on next line of the message call (the same way Xcode does
alignment)
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
align_oc_msg_spec_span
(OC) The span for aligning Objective-C message specifications.
0: Don't align (default).
Type: numeric [0 .. 5000]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
1 |
|
align_on_operator
Whether to align function prototypes on the 'operator' keyword instead of
what follows.
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
|
|
|
|
|
|
|
|
align_on_tabstop
Whether to bump out to the next tab when aligning.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
TRUE |
TRUE |
|
|
true |
true |
align_pp_define_gap
The minimum space between label and value of a preprocessor define.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
1 |
4 |
align_pp_define_span
The span for aligning on '#define' bodies.
=0: Don't align (default)
>0: Number of lines (including comments) between blocks
Type: numeric [0 .. 5000]
Default: 0
|
0
|
|
|
|
2 |
|
|
|
|
8 |
3 |
align_pp_define_together
Whether to align macro functions and variables together.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
true |
|
align_right_cmt_at_col
Minimum column at which to align trailing comments. Comments which are
aligned beyond this column, but which can be aligned in a lesser column,
may be "pulled in".
0: Ignore (default).
Type: numeric [0 .. 200]
Default: 0
|
0
|
1 |
1 |
|
|
|
|
|
|
41 |
|
align_right_cmt_gap
Minimum number of columns between preceding text and a trailing comment in
order for the comment to qualify for being aligned. Must be non-zero to have
an effect.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
1 |
|
align_right_cmt_mix
If aligning comments, whether to mix with comments after '}' and #endif with
less than three spaces before the comment.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
align_right_cmt_same_level
Whether to only align trailing comments that are at the same brace level.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
align_right_cmt_span
The span for aligning comments that end lines.
0: Don't align (default).
Type: numeric [0 .. 5000]
Default: 0
|
0
|
4 |
4 |
|
|
3 |
3 |
|
|
4 |
3 |
align_same_func_call_params
Whether to align parameters in single-line functions that have the same
name. The function names must already be aligned with each other.
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
|
|
|
|
|
|
|
|
align_same_func_call_params_span
The span for aligning function-call parameters for single line functions.
0: Don't align (default).
Type: numeric [0 .. 5000]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
align_same_func_call_params_thresh
The threshold for aligning function-call parameters for single line
functions.
Use a negative number for absolute thresholds.
0: No limit (default).
Type: numeric [-1000 .. 5000]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
align_single_line_brace
Whether to align the open brace of single-line functions.
Requires align_single_line_func=true. Uses align_func_proto_span.
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
|
|
|
|
|
|
|
|
align_single_line_brace_gap
Gap for align_single_line_brace.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
align_single_line_func
Whether to align single-line functions with function prototypes.
Uses align_func_proto_span.
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
|
|
|
|
|
|
true |
|
align_struct_init_span
The span for aligning struct initializer values.
0: Don't align (default).
Type: numeric [0 .. 5000]
Default: 0
|
0
|
1 |
1 |
|
2 |
3 |
3 |
|
|
|
3 |
align_typedef_amp_style
How to consider (or treat) the '&' in the alignment of typedefs.
0: Part of the typedef type, 'typedef int & intref;' (default)
1: Part of type name: 'typedef int &intref;'
2: Dangling: 'typedef int &intref;'
Dangling: the '&' will not be taken into account when aligning.
Type: numeric [0 .. 2]
Default: 0
|
0
|
2 |
2 |
|
|
|
|
|
|
1 |
|
align_typedef_func
How to align typedef'd functions with other typedefs.
0: Don't mix them at all (default)
1: Align the open parenthesis with the types
2: Align the function type name with the other type names
Type: numeric [0 .. 2]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
align_typedef_gap
The minimum space between the type and the synonym of a typedef.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
1 |
3 |
align_typedef_span
The span for aligning single-line typedefs.
0: Don't align (default).
Type: numeric [0 .. 16]
Default: 0
|
0
|
1 |
1 |
|
|
|
|
|
|
|
5 |
align_typedef_star_style
How to consider (or treat) the '*' in the alignment of typedefs.
0: Part of the typedef type, 'typedef int * pint;' (default)
1: Part of type name: 'typedef int *pint;'
2: Dangling: 'typedef int *pint;'
Dangling: the '*' will not be taken into account when aligning.
Type: numeric [0 .. 2]
Default: 0
|
0
|
2 |
2 |
|
|
|
|
|
|
1 |
|
align_var_class_gap
The gap for aligning class member definitions.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
align_var_class_span
The span for aligning class member definitions.
0: Don't align (default).
Type: numeric [0 .. 5000]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
align_var_class_thresh
The threshold for aligning class member definitions.
Use a negative number for absolute thresholds.
0: No limit (default).
Type: numeric [-1000 .. 5000]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
align_var_def_amp_style
How to consider (or treat) the '&' in the alignment of variable definitions.
0: Part of the type 'long & foo;' (default)
1: Part of the variable 'long &foo;'
2: Dangling 'long &foo;'
Dangling: the '&' will not be taken into account when aligning.
Type: numeric [0 .. 2]
Default: 0
|
0
|
2 |
2 |
|
|
|
|
|
|
1 |
|
align_var_def_attribute
Whether to align any attribute after the variable name.
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
|
true |
|
|
|
|
|
|
align_var_def_colon
Whether to align the colon in struct bit fields.
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
|
true |
|
|
|
|
|
|
align_var_def_colon_gap
The gap for aligning the colon in struct bit fields.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
align_var_def_gap
The gap for aligning variable definitions.
Type: numeric [0 .. 16]
Default: 0
|
0
|
1 |
1 |
|
|
|
|
|
|
|
|
align_var_def_inline
Whether to align inline struct/enum/union variable definitions.
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
|
true |
|
|
|
|
|
|
align_var_def_span
The span for aligning variable definitions.
0: Don't align (default).
Type: numeric [0 .. 5000]
Default: 0
|
0
|
1 |
1 |
|
|
|
|
|
|
|
|
align_var_def_star_style
How to consider (or treat) the '*' in the alignment of variable definitions.
0: Part of the type 'void * foo;' (default)
1: Part of the variable 'void *foo;'
2: Dangling 'void *foo;'
Dangling: the '*' will not be taken into account when aligning.
Type: numeric [0 .. 2]
Default: 0
|
0
|
2 |
2 |
|
|
|
|
|
|
1 |
|
align_var_def_thresh
The threshold for aligning variable definitions.
Use a negative number for absolute thresholds.
0: No limit (default).
Type: numeric [-1000 .. 5000]
Default: 0
|
0
|
3 |
3 |
|
|
|
|
|
|
10 |
|
align_var_struct_gap
The gap for aligning struct/union member definitions.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
align_var_struct_span
The span for aligning struct/union member definitions.
0: Don't align (default).
Type: numeric [0 .. 5000]
Default: 0
|
0
|
1 |
1 |
|
|
6 |
|
|
|
|
99 |
align_var_struct_thresh
The threshold for aligning struct/union member definitions.
Use a negative number for absolute thresholds.
0: No limit (default).
Type: numeric [-1000 .. 5000]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
align_with_tabs
Whether to use tabs for aligning.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
TRUE |
TRUE |
|
|
true |
true |
Code modifying options (non-whitespace) |
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
mod_add_force_c_closebrace_comment
the following options (mod_XX_closebrace_comment) use different comment,
depending of the setting of the next option.
false: Use the c comment (default)
true : Use the cpp comment
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
mod_add_long_class_closebrace_comment
If a class body exceeds the specified number of newlines and doesn't have a
comment after the close brace, a comment will be added.
Type: numeric [0 .. 255]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
mod_add_long_function_closebrace_comment
If a function body exceeds the specified number of newlines and doesn't have
a comment after the close brace, a comment will be added.
Type: numeric [0 .. 255]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
mod_add_long_ifdef_else_comment
If an #ifdef or #else body exceeds the specified number of newlines and
doesn't have a comment after the #else, a comment will be added.
Type: numeric [0 .. 255]
Default: 0
|
0
|
1 |
1 |
|
|
|
|
|
|
|
|
mod_add_long_ifdef_endif_comment
If an #ifdef body exceeds the specified number of newlines and doesn't have
a comment after the #endif, a comment will be added.
Type: numeric [0 .. 255]
Default: 0
|
0
|
1 |
1 |
|
|
|
|
|
|
|
|
mod_add_long_namespace_closebrace_comment
If a namespace body exceeds the specified number of newlines and doesn't
have a comment after the close brace, a comment will be added.
Type: numeric [0 .. 255]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
mod_add_long_switch_closebrace_comment
If a switch body exceeds the specified number of newlines and doesn't have a
comment after the close brace, a comment will be added.
Type: numeric [0 .. 255]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
mod_case_brace
Add or remove braces around a fully braced case statement. Will only remove
braces if there are no variable declarations in the block.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
remove |
mod_enum_last_comma
Add or remove the comma after the last value of an enumeration.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
mod_full_brace_do
Add or remove braces on a single-line 'do' statement.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
force |
|
remove |
|
|
|
force |
add |
mod_full_brace_for
Add or remove braces on a single-line 'for' statement.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
force |
|
remove |
|
|
|
remove |
add |
mod_full_brace_function
(Pawn) Add or remove braces on a single-line function definition.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
force |
|
|
|
|
|
|
|
mod_full_brace_if
Add or remove braces on a single-line 'if' statement. Braces will not be
removed if the braced statement contains an 'else'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
force |
|
|
|
|
|
remove |
add |
mod_full_brace_if_chain
Whether to enforce that all blocks of an 'if'/'else if'/'else' chain either
have, or do not have, braces. Overrides mod_full_brace_if.
0: Don't override mod_full_brace_if
1: Add braces to all blocks if any block needs braces and remove braces if
they can be removed from all blocks
2: Add braces to all blocks if any block already has braces, regardless of
whether it needs them
3: Add braces to all blocks if any block needs braces and remove braces if
they can be removed from all blocks, except if all blocks have braces
despite none needing them
Type: numeric [0 .. 3]
Default: 0
|
0
|
|
|
false |
false |
1 |
|
|
|
1 |
|
mod_full_brace_if_chain_only
Whether to add braces to all blocks of an 'if'/'else if'/'else' chain.
If true, mod_full_brace_if_chain will only remove braces from an 'if' that
does not have an 'else if' or 'else'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
mod_full_brace_nl
Don't remove braces around statements that span N newlines
Type: numeric [0 .. 5000]
Default: 0
|
0
|
1 |
1 |
|
|
3 |
|
|
|
2 |
|
mod_full_brace_nl_block_rem_mlcond
Whether to prevent removal of braces from 'if'/'for'/'while'/etc. blocks
which span multiple lines.
Affects:
mod_full_brace_for
mod_full_brace_if
mod_full_brace_if_chain
mod_full_brace_if_chain_only
mod_full_brace_while
mod_full_brace_using
Does not affect:
mod_full_brace_do
mod_full_brace_function
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
mod_full_brace_using
Add or remove braces on single-line 'using ()' statement.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
force |
|
|
|
|
|
remove |
|
mod_full_brace_while
Add or remove braces on single-line 'while' statement.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
force |
|
remove |
|
|
|
remove |
add |
mod_full_paren_assign_bool
Whether to fully parenthesize Boolean expressions after '='
statement, as in 'x = a && b > c;' => 'x = (a && (b > c));'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
mod_full_paren_if_bool
Whether to fully parenthesize Boolean expressions in 'while' and 'if'
statement, as in 'if (a && b > c)' => 'if (a && (b > c))'.
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
|
|
|
|
|
|
|
true |
mod_full_paren_return_bool
Whether to fully parenthesize Boolean expressions after '='
statement, as in 'return a && b > c;' => 'return (a && (b > c));'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
mod_infinite_loop
Syntax to use for infinite loops.
0: Leave syntax alone (default)
1: Rewrite as `for(;;)`
2: Rewrite as `while(true)`
3: Rewrite as `do`...`while(true);`
4: Rewrite as `while(1)`
5: Rewrite as `do`...`while(1);`
Infinite loops that do not already match one of these syntaxes are ignored.
Other options that affect loop formatting will be applied after transforming
the syntax.
Type: numeric [0 .. 5]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
mod_int_long
Add or remove the 'int' keyword in 'int long'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
mod_int_prefer_int_on_left
If there is a situation where mod_int_* and mod_*_int would result in
multiple int keywords, whether to keep the rightmost int (the default) or the
leftmost int.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
mod_int_short
Add or remove the 'int' keyword in 'int short'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
mod_int_signed
Add or remove the 'int' keyword in 'int signed'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
mod_int_unsigned
Add or remove the 'int' keyword in 'int unsigned'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
mod_long_int
Add or remove the 'int' keyword in 'long int'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
mod_move_case_break
Whether to move a 'break' that appears after a fully braced 'case' before
the close brace, as in 'case X: { ... } break;' => 'case X: { ... break; }'.
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
|
|
|
|
|
|
|
|
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
mod_move_case_return
Whether to move a 'return' that appears after a fully braced 'case' before
the close brace, as in 'case X: { ... } return;' => 'case X: { ... return; }'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
mod_paren_on_return
Add or remove unnecessary parentheses on 'return' statement.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
remove |
|
remove |
|
|
|
remove |
add |
mod_paren_on_throw
Add or remove unnecessary parentheses on 'throw' statement.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
mod_pawn_semicolon
(Pawn) Whether to change optional semicolons to real semicolons.
Type: boolean [false, true]
Default: false
|
false
|
|
|
true |
|
|
|
|
|
|
|
mod_remove_duplicate_include
Whether to remove duplicate include.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
mod_remove_empty_return
Whether to remove a void 'return;' that appears as the last statement in a
function.
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
true |
|
|
|
|
|
true |
true |
mod_remove_extra_semicolon
Whether to remove superfluous semicolons.
Type: boolean [false, true]
Default: false
|
false
|
true |
|
true |
|
|
|
|
|
true |
true |
mod_short_int
Add or remove the 'int' keyword in 'short int'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
mod_signed_int
Add or remove the 'int' keyword in 'signed int'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
mod_sort_case_sensitive
Whether to take care of the case by the mod_sort_xx options.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
mod_sort_import
Whether to sort consecutive single-line 'import' statements.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
true |
|
mod_sort_incl_import_grouping_enabled
Whether to group '#include' and '#import' statements when sorting is enabled.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
mod_sort_incl_import_ignore_extension
Whether to ignore file extension in '#include' and '#import' statements
for sorting comparison.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
mod_sort_incl_import_prioritize_angle_over_quotes
Whether to prioritize '#include' and '#import' statements that contain
angle over quotes when sorting is enabled.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
mod_sort_incl_import_prioritize_extensionless
Whether to prioritize '#include' and '#import' statements that does not
contain extensions when sorting is enabled.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
mod_sort_incl_import_prioritize_filename
Whether to prioritize '#include' and '#import' statements that contain
filename without extension when sorting is enabled.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
mod_sort_include
Whether to sort consecutive single-line '#include' statements (C/C++) and
'#import' statements (Objective-C). Be aware that this has the potential to
break your code if your includes/imports have ordering dependencies.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
mod_sort_oc_properties
(OC) Whether to organize the properties. If true, properties will be
rearranged according to the mod_sort_oc_property_*_weight factors.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
mod_sort_oc_property_class_weight
(OC) Weight of a class property modifier.
Type: numeric [0 .. ]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
mod_sort_oc_property_getter_weight
(OC) Weight of getter type ('getter=') when organizing properties.
Type: numeric [0 .. ]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
mod_sort_oc_property_nullability_weight
(OC) Weight of nullability type ('nullable', 'nonnull', 'null_unspecified',
'null_resettable') when organizing properties.
Type: numeric [0 .. ]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
mod_sort_oc_property_readwrite_weight
(OC) Weight of 'readwrite' when organizing properties.
Type: numeric [0 .. ]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
mod_sort_oc_property_reference_weight
(OC) Weight of a reference type specifier ('retain', 'copy', 'assign',
'weak', 'strong') when organizing properties.
Type: numeric [0 .. ]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
mod_sort_oc_property_setter_weight
(OC) Weight of setter type ('setter=') when organizing properties.
Type: numeric [0 .. ]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
mod_sort_oc_property_thread_safe_weight
(OC) Weight of 'atomic' and 'nonatomic'.
Type: numeric [0 .. ]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
mod_sort_using
(C#) Whether to sort consecutive single-line 'using' statements.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
true |
|
mod_unsigned_int
Add or remove the 'int' keyword in 'unsigned int'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
Comment modification options |
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
cmt_align_doxygen_javadoc_tags
Whether to align doxygen javadoc-style tags ('@param', '@return', etc.)
and corresponding fields such that groups of consecutive block tags,
parameter names, and descriptions align with one another. Overrides that
which is specified by the cmt_sp_after_star_cont. If cmt_width > 0, it may
be necessary to enable cmt_indent_multi and set cmt_reflow_mode = 2
in order to achieve the desired alignment for line-wrapping.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
cmt_c_group
Whether to group c-comments that look like they are in a block.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
true |
|
cmt_c_nl_end
Whether to add a newline before the closing '*/' of the combined c-comment.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
true |
|
cmt_c_nl_start
Whether to put an empty '/*' on the first line of the combined c-comment.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
true |
|
cmt_convert_tab_to_spaces
Whether to convert all tabs to spaces in comments. If false, tabs in
comments are left alone, unless used for indenting.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
cmt_cpp_group
Whether to group cpp-comments that look like they are in a block. Only
meaningful if cmt_cpp_to_c=true.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
true |
|
cmt_cpp_nl_end
Whether to add a newline before the closing '*/' of the combined cpp-comment
when converting to a c-comment.
Requires cmt_cpp_to_c=true and cmt_cpp_group=true.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
true |
|
cmt_cpp_nl_start
Whether to put an empty '/*' on the first line of the combined cpp-comment
when converting to a c-comment.
Requires cmt_cpp_to_c=true and cmt_cpp_group=true.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
true |
|
cmt_cpp_to_c
Whether to change cpp-comments into c-comments.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
true |
|
|
|
|
|
|
cmt_indent_multi
Whether to apply changes to multi-line comments, including cmt_width,
keyword substitution and leading chars.
Default: true
Type: boolean [false, true]
Default: true
|
true
|
|
|
false |
|
|
|
|
|
|
|
cmt_insert_before_ctor_dtor
Whether a comment should be inserted if the function is a class constructor
or destructor.
Applies to cmt_insert_func_header.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
cmt_insert_before_inlines
Whether a comment should be inserted if a function is declared inline to a
class definition.
Applies to cmt_insert_func_header.
Default: true
Type: boolean [false, true]
Default: true
|
true
|
|
|
|
|
|
|
|
|
|
|
cmt_insert_before_preproc
Whether a comment should be inserted if a preprocessor is encountered when
stepping backwards from a function name.
Applies to cmt_insert_oc_msg_header, cmt_insert_func_header and
cmt_insert_class_header.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
cmt_insert_class_header
Path to a file that contains text to insert before a class if the class
isn't preceded by a C/C++ comment. If the inserted text contains '$(class)',
that will be replaced with the class name.
Type: string
Default:
|
|
|
|
|
|
|
|
|
|
|
|
cmt_insert_file_footer
Path to a file that contains text to insert at the end of a file if the
file doesn't end with a C/C++ comment. If the inserted text contains
'$(filename)', that will be replaced with the current file's name.
Type: string
Default:
|
|
|
|
|
|
|
|
|
|
|
|
cmt_insert_file_header
Path to a file that contains text to insert at the beginning of a file if
the file doesn't start with a C/C++ comment. If the inserted text contains
'$(filename)', that will be replaced with the current file's name.
Type: string
Default:
|
|
|
|
|
|
|
|
|
|
|
|
cmt_insert_func_header
Path to a file that contains text to insert before a function definition if
the function isn't preceded by a C/C++ comment. If the inserted text
contains '$(function)', '$(javaparam)' or '$(fclass)', these will be
replaced with, respectively, the name of the function, the javadoc '@param'
and '@return' stuff, or the name of the class to which the member function
belongs.
Type: string
Default:
|
|
|
|
|
|
|
|
|
|
|
|
cmt_insert_oc_msg_header
Path to a file that contains text to insert before an Objective-C message
specification, if the method isn't preceded by a C/C++ comment. If the
inserted text contains '$(message)' or '$(javaparam)', these will be
replaced with, respectively, the name of the function, or the javadoc
'@param' and '@return' stuff.
Type: string
Default:
|
|
|
|
|
|
|
|
|
|
|
|
cmt_multi_check_last
For multi-line comments with a '*' lead, remove leading spaces if the first
and last lines of the comment are the same length.
Default: true
Type: boolean [false, true]
Default: true
|
true
|
|
|
|
|
|
|
|
|
false |
|
cmt_multi_first_len_minimum
For multi-line comments with a '*' lead, remove leading spaces if the first
and last lines of the comment are the same length AND if the length is
bigger as the first_len minimum.
Default: 4
Type: numeric [1 .. 20]
Default: 4
|
4
|
|
|
|
|
|
|
|
|
|
|
cmt_reflow_fold_regex_file
Path to a file that contains regular expressions describing patterns for
which the end of one line and the beginning of the next will be folded into
the same sentence or paragraph during full comment reflow. The regular
expressions are described using ECMAScript syntax. The syntax for this
specification is as follows, where "..." indicates the custom regular
expression and "n" indicates the nth end_of_prev_line_regex and
beg_of_next_line_regex regular expression pair:
end_of_prev_line_regex[1] = "...$"
beg_of_next_line_regex[1] = "^..."
end_of_prev_line_regex[2] = "...$"
beg_of_next_line_regex[2] = "^..."
.
.
.
end_of_prev_line_regex[n] = "...$"
beg_of_next_line_regex[n] = "^..."
Note that use of this option overrides the default reflow fold regular
expressions, which are internally defined as follows:
end_of_prev_line_regex[1] = "[\w,\]\)]$"
beg_of_next_line_regex[1] = "^[\w,\[\(]"
end_of_prev_line_regex[2] = "\.$"
beg_of_next_line_regex[2] = "^[A-Z]"
Type: string
Default:
|
|
|
|
|
|
|
|
|
|
|
|
cmt_reflow_indent_to_paragraph_start
Whether to indent wrapped lines to the start of the encompassing paragraph
during full comment reflow (cmt_reflow_mode = 2). Overrides the value
specified by cmt_sp_after_star_cont.
Note that cmt_align_doxygen_javadoc_tags overrides this option for
paragraphs associated with javadoc tags
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
cmt_reflow_mode
How to reflow comments.
0: No reflowing (apart from the line wrapping due to cmt_width) (default)
1: No touching at all
2: Full reflow (enable cmt_indent_multi for indent with line wrapping due to cmt_width)
Type: numeric [0 .. 2]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
1 |
|
cmt_sp_after_star_cont
The number of spaces to insert after the star on subsequent comment lines.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
cmt_sp_before_doxygen_javadoc_tags
The number of spaces to insert after the star and before doxygen
javadoc-style tags (@param, @return, etc). Requires enabling
cmt_align_doxygen_javadoc_tags. Overrides that which is specified by the
cmt_sp_after_star_cont.
Default: 1
Type: numeric [0 .. 16]
Default: 1
|
1
|
|
|
|
|
|
|
|
|
|
|
cmt_sp_before_star_cont
The number of spaces to insert at the start of subsequent comment lines.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
cmt_star_cont
Whether to put a star on subsequent comment lines.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
true |
true |
|
|
|
true |
true |
cmt_trailing_single_line_c_to_cpp
Whether to change trailing, single-line c-comments into cpp-comments.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
cmt_width
Try to wrap comments at N columns.
Type: numeric [0 .. 256]
Default: 0
|
0
|
80 |
80 |
|
|
|
|
|
|
80 |
|
Indenting options |
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
donot_indent_func_def_close_paren
Don't indent the close parenthesis of a function definition,
if the parenthesis is on its own line.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_access_spec
How to indent access specifiers that are followed by a
colon.
>0: Absolute column where 1 is the leftmost column
<=0: Subtract from brace indent
Default: 1
Type: numeric [-16 .. 16]
Default: 1
|
1
|
|
|
|
|
|
|
|
|
-4 |
|
indent_access_spec_body
Whether to indent the code after an access specifier by one level.
If true, this option forces 'indent_access_spec=0'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_align_assign
Whether to align continued statements at the '='. If false or if the '=' is
followed by a newline, the next line is indent one tab.
Default: true
Type: boolean [false, true]
Default: true
|
true
|
|
|
false |
|
|
|
|
|
false |
|
indent_align_paren
Whether to align continued statements at the '('. If false or the '(' is
followed by a newline, the next line indent is one tab.
Default: true
Type: boolean [false, true]
Default: true
|
true
|
|
|
|
|
|
|
|
|
|
|
indent_align_string
Whether to indent strings broken by '\' so that they line up.
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
|
|
|
|
|
False |
|
|
indent_before_class_colon
Additional indent before the leading base class colon.
Negative values decrease indent down to the first column.
Requires indent_ignore_before_class_colon=false and a newline break before
the colon (see pos_class_colon and nl_class_colon)
Type: numeric [-16 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
indent_bool_paren
How to indent a Boolean operator when inside parentheses.
0: Indent by one level (default)
1: Align under the open parenthesis
-1: Preserve original indentation
Type: numeric [-1 .. 1]
Default: 0
|
0
|
false |
false |
false |
false |
|
|
|
|
|
|
indent_brace
Spaces to indent '{' from level.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
2 |
|
|
indent_brace_parent
Whether to indent based on the size of the brace parent,
i.e. 'if' => 3 spaces, 'for' => 4 spaces, etc.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_braces
Whether braces are indented to the body level.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_braces_no_class
Whether to disable indenting class braces if indent_braces=true.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_braces_no_func
Whether to disable indenting function braces if indent_braces=true.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_braces_no_struct
Whether to disable indenting struct braces if indent_braces=true.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_case_brace
Spaces to indent '{' from 'case'. By default, the brace will appear under
the 'c' in case. Usually set to 0 or indent_columns. Negative values are OK.
It might be wise to choose the same value for the option indent_switch_case.
Type: numeric [-16 .. 16]
Default: 0
|
0
|
|
|
2 |
|
|
|
|
|
|
|
indent_case_comment
Whether to align comments before 'case' with the 'case'.
Default: true
Type: boolean [false, true]
Default: true
|
true
|
|
|
|
|
|
|
|
|
|
|
indent_case_shift
Spaces to shift the 'case' line, without affecting any other lines.
Usually 0.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
indent_class
Whether the 'class' body is indented.
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
true |
|
|
|
|
|
true |
true |
indent_class_colon
Whether to indent the stuff after a leading base class colon.
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
|
|
|
|
|
|
|
true |
indent_class_on_colon
Whether to indent based on a class colon instead of the stuff after the
colon. Requires indent_class_colon=true.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_cmt_with_tabs
Whether to indent comments that are not at a brace level with tabs on a
tabstop. Requires indent_with_tabs=2. If false, will use spaces.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_col1_comment
Whether to indent comments found in first column.
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
|
|
|
|
|
|
|
|
indent_col1_multi_string_literal
Whether to indent multi string literal in first column.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_columns
The number of columns to indent per level. Usually 2, 3, 4, or 8.
Default: 8
Type: numeric [0 .. 16]
Default: 8
|
8
|
2 |
2 |
2 |
4 |
output_tab_size |
output_tab_size |
output_tab_size |
2 |
4 |
|
indent_comma_brace
How to indent a comma when inside braces.
0: Indent by one level (default)
1: Align under the open brace
-1: Preserve original indentation
Type: numeric [-1 .. 1]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
indent_comma_paren
How to indent a comma when inside parentheses.
0: Indent by one level (default)
1: Align under the open parenthesis
-1: Preserve original indentation
Type: numeric [-1 .. 1]
Default: 0
|
0
|
false |
false |
false |
false |
|
|
|
|
|
|
indent_comment
Whether to indent comments not found in first column.
Default: true
Type: boolean [false, true]
Default: true
|
true
|
|
|
|
|
|
|
|
|
|
|
indent_comment_align_thresh
Align comments on adjacent lines that are this many columns apart or less.
Default: 3
Type: numeric [0 .. 16]
Default: 3
|
3
|
|
|
|
|
|
|
|
|
|
|
indent_compound_literal_return
How to indent compound literals that are being returned.
true: add both the indent from return & the compound literal open brace
(i.e. 2 indent levels)
false: only indent 1 level, don't add the indent for the open brace, only
add the indent for the return.
Default: true
Type: boolean [false, true]
Default: true
|
true
|
|
|
|
|
|
|
|
|
|
|
indent_constr_colon
Whether to indent the stuff after a leading class initializer colon.
Type: boolean [false, true]
Default: false
|
false
|
|
|
true |
|
|
|
|
|
|
|
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
indent_continue
The continuation indent. If non-zero, this overrides the indent of '(', '['
and '=' continuation indents. Negative values are OK; negative value is
absolute and not increased for each '(' or '[' level.
For FreeBSD, this is set to 4.
Requires indent_ignore_first_continue=false.
Type: numeric [-16 .. 16]
Default: 0
|
0
|
|
|
2 |
|
|
|
|
|
-4 |
4 |
indent_continue_class_head
The continuation indent, only for class header line(s). If non-zero, this
overrides the indent of 'class' continuation indents.
Requires indent_ignore_first_continue=false.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
indent_cpp_lambda_body
Whether to indent the body of a C++11 lambda.
Type: boolean [false, true]
Default: false
|
false
|
|
|
true |
|
|
|
|
|
|
|
indent_cs_delegate_body
(C#) Whether to indent a C# delegate (to handle delegates with no brace) by
another level.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_cs_delegate_brace
(C#) Whether to indent the brace of a C# delegate by another level.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_ctor_init
Additional indent for constructor initializer list.
Negative values decrease indent down to the first column.
Type: numeric [-16 .. 16]
Default: 0
|
0
|
|
|
-2 |
|
|
|
|
|
|
|
indent_ctor_init_following
Virtual indent from the ':' for following member initializers.
Default: 2
Type: numeric [0 .. 16]
Default: 2
|
2
|
|
|
|
|
|
|
|
|
|
|
indent_ctor_init_leading
Virtual indent from the ':' for leading member initializers.
Default: 2
Type: numeric [0 .. 16]
Default: 2
|
2
|
|
|
|
|
|
|
|
|
0 |
|
indent_else_if
Whether to indent 'if' following 'else' as a new block under the 'else'.
If false, 'else\nif' is treated as 'else if' for indenting purposes.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_extern
Whether the 'extern "C"' body is indented.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_first_bool_expr
Whether to align the first expression to following ones
if indent_bool_paren=1.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_first_for_expr
Whether to align the first expression to following ones
if indent_semicolon_for_paren=true.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_func_call_param
Whether to indent continued function call parameters one indent level,
rather than aligning parameters under the open parenthesis.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
true |
|
indent_func_class_param
Whether to indent continued function call declaration one indent level,
rather than aligning parameters under the open parenthesis.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
true |
|
indent_func_const
Indentation column for standalone 'const' qualifier on a function
prototype.
Type: numeric [0 .. 69]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
indent_func_ctor_var_param
Whether to indent continued class variable constructors one indent level,
rather than aligning parameters under the open parenthesis.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
true |
|
indent_func_def_force_col1
Whether to force indentation of function definitions to start in column 1.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_func_def_param
Whether to indent continued function definition parameters one indent level,
rather than aligning parameters under the open parenthesis.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
true |
|
indent_func_def_param_paren_pos_threshold
for function definitions, only if indent_func_def_param is false
Allows to align params when appropriate and indent them when not
behave as if it was true if paren position is more than this value
if paren position is more than the option value
Type: numeric [0 .. 160]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
indent_func_param_double
Double the indent for indent_func_xxx_param options.
Use both values of the options indent_columns and indent_param.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_func_proto_param
Whether to indent continued function call prototype one indent level,
rather than aligning parameters under the open parenthesis.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
true |
|
indent_func_throw
Indentation column for standalone 'throw' qualifier on a function
prototype.
Type: numeric [0 .. 41]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
indent_ignore_arith
Whether to ignore the indentation of an arithmetic operator.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_ignore_asm_block
Whether to ignore indent and alignment for 'asm' blocks (i.e. assume they
have their own indentation).
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_ignore_assign
Whether to ignore the indentation of an assignment operator.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_ignore_before_class_colon
Whether to ignore indent for the leading base class colon.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_ignore_before_constr_colon
Whether to ignore indent for a leading class initializer colon.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_ignore_bool
Whether to ignore the indentation of a Boolean operator when outside
parentheses.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_ignore_case_brace
Whether to ignore indent for '{' following 'case'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_ignore_first_continue
Whether to ignore indent for the first continuation line. Subsequent
continuation lines will still be indented to match the first.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
indent_ignore_label
Whether to ignore indent for goto labels.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_ignore_semicolon
Whether to ignore the indentation of a semicolon outside of a 'for'
statement.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_inside_ternary_operator
Whether to indent the statements inside ternary operator.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_label
How to indent goto labels. Requires indent_ignore_label=false.
>0: Absolute column where 1 is the leftmost column
<=0: Subtract from brace indent
Default: 1
Type: numeric [-16 .. 16]
Default: 1
|
1
|
|
|
|
|
|
2 |
2 |
|
-4 |
|
indent_macro_brace
How to indent within a macro followed by a brace on the same line
This allows reducing the indent in macros that have (for example)
`do { ... } while (0)` blocks bracketing them.
true: add an indent for the brace on the same line as the macro
false: do not add an indent for the brace on the same line as the macro
Default: true
Type: boolean [false, true]
Default: true
|
true
|
|
|
|
|
|
|
|
|
|
|
indent_member
The number of spaces to indent a continued '->' or '.'.
Usually set to 0, 1, or indent_columns.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
4 |
|
indent_member_single
Whether lines broken at '.' or '->' should be indented by a single indent.
The indent_member option will not be effective if this is set to true.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_min_vbrace_open
When indenting after virtual brace open and newline add further spaces to
reach this minimum indent.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
indent_namespace
Whether to indent the body of a 'namespace'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_namespace_inner_only
Whether to indent only in inner namespaces (nested in other namespaces).
Requires indent_namespace=true.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_namespace_level
The number of spaces to indent a namespace block.
If set to zero, use the value indent_columns
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
indent_namespace_limit
If the body of the namespace is longer than this number, it won't be
indented. Requires indent_namespace=true. 0 means no limit.
Type: numeric [0 .. 255]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
indent_namespace_single_indent
Whether to indent only the first namespace, and not any nested namespaces.
Requires indent_namespace=true.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_oc_block
(OC) Whether to indent Objective-C blocks at brace level instead of usual
rules.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_oc_block_msg
(OC) Indent for Objective-C blocks in a message relative to the parameter
name.
=0: Use indent_oc_block rules
>0: Use specified number of spaces to indent
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
indent_oc_block_msg_from_brace
(OC) Whether to indent blocks from where the brace caret is.
Requires indent_oc_block_msg=true.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_oc_block_msg_from_caret
(OC) Whether to indent blocks from where the block caret is.
Requires indent_oc_block_msg=true.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_oc_block_msg_from_colon
(OC) Whether to indent blocks from where the brace is, relative to a message
colon. Requires indent_oc_block_msg=true.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_oc_block_msg_from_keyword
(OC) Whether to indent blocks from where the brace is, relative to a
message keyword. Requires indent_oc_block_msg=true.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_oc_block_msg_xcode_style
(OC) Whether to indent blocks the way that Xcode does by default
(from the keyword if the parameter is on its own line; otherwise, from the
previous indentation level). Requires indent_oc_block_msg=true.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_oc_inside_msg_sel
(OC) Whether to indent Objective-C code inside message selectors.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_oc_msg_colon
(OC) Minimum indent for subsequent parameters
Type: numeric [0 .. 5000]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
indent_oc_msg_prioritize_first_colon
(OC) Whether to prioritize aligning with initial colon (and stripping spaces
from lines, if necessary).
Default: true
Type: boolean [false, true]
Default: true
|
true
|
|
|
|
|
|
|
|
|
|
|
indent_off_after_assign
If true, the indentation of the chunks after a '=' sequence will be set at
LHS token indentation column before '='.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_off_after_return
If true, the indentation of the chunks after a `return` sequence will be set at return indentation column.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_off_after_return_new
If true, the indentation of the chunks after a `return new` sequence will be set at return indentation column.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_param
The continuation indent for func_*_param if they are true. If non-zero, this
overrides the indent.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
indent_paren_after_func_call
Whether to indent the open parenthesis of a function call,
if the parenthesis is on its own line.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_paren_after_func_decl
Whether to indent the open parenthesis of a function declaration,
if the parenthesis is on its own line.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_paren_after_func_def
Whether to indent the open parenthesis of a function definition,
if the parenthesis is on its own line.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
indent_paren_close
How to indent a close parenthesis after a newline.
0: Indent to body level (default)
1: Align under the open parenthesis
2: Indent to the brace level
-1: Preserve original indentation
Type: numeric [-1 .. 2]
Default: 0
|
0
|
|
|
2 |
|
|
|
|
|
|
|
indent_paren_nl
If an open parenthesis is followed by a newline, whether to indent the next
line so that it lines up after the open parenthesis (not recommended).
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_paren_open_brace
Whether to indent based on the open parenthesis instead of the open brace
in '({\n'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_preserve_sql
(ESQL/C) Whether to preserve the relative indent of 'EXEC SQL' bodies.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_relative_single_line_comments
Whether to indent trailing single line ('//') comments relative to the code
instead of trying to keep the same absolute column.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_semicolon_for_paren
Whether to indent a semicolon when inside a for parenthesis.
If true, aligns under the open for parenthesis.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_shift
How to indent continued shift expressions ('<<' and '>>').
Set align_left_shift=false when using this.
0: Align shift operators instead of indenting them (default)
1: Indent by one level
-1: Preserve original indentation
Type: numeric [-1 .. 1]
Default: 0
|
0
|
|
|
false |
|
|
|
|
|
|
|
indent_single_after_return
If true, the tokens after return are indented with regular single indentation. By default (false) the indentation is after the return token.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_single_line_comments_after
Spaces to indent single line ('//') comments on lines after code.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
indent_single_line_comments_before
Spaces to indent single line ('//') comments on lines before code.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
indent_single_newlines
Whether to indent empty lines (i.e. lines which contain only spaces before
the newline character).
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_sparen_extra
When opening a paren for a control statement (if, for, while, etc), increase
the indent level by this value. Negative values decrease the indent level.
Type: numeric [-16 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
indent_square_nl
If an open square is followed by a newline, whether to indent the next line
so that it lines up after the open square (not recommended).
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_switch_body
Spaces to indent the body of a 'switch' before any 'case'.
Usually the same as indent_columns or indent_switch_case.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
indent_switch_break_with_case
indent 'break' with 'case' from 'switch'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_switch_case
Spaces to indent 'case' from 'switch'. Usually 0 or indent_columns.
It might be wise to choose the same value for the option indent_case_brace.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
2 |
2 |
|
|
|
|
|
|
|
indent_switch_pp
Whether to indent preprocessor statements inside of switch statements.
Default: true
Type: boolean [false, true]
Default: true
|
true
|
|
|
|
|
|
|
|
|
|
|
indent_template_param
Whether to indent continued template parameter list one indent level,
rather than aligning parameters under the open parenthesis.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
true |
|
indent_ternary_operator
How to indent the continuation of ternary operator.
0: Off (default)
1: When the `if_false` is a continuation, indent it under the `if_true` branch
2: When the `:` is a continuation, indent it under `?`
Type: numeric [0 .. 2]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
indent_token_after_brace
How to indent after a brace followed by another token (not a newline).
true: indent all contained lines to match the token
false: indent all contained lines to match the brace
Default: true
Type: boolean [false, true]
Default: true
|
true
|
|
|
false |
|
|
|
|
|
|
|
indent_using_block
(C#) Whether to indent a 'using' block if no braces are used.
Default: true
Type: boolean [false, true]
Default: true
|
true
|
|
|
|
|
|
|
|
|
|
|
indent_var_def_blk
Amount to indent variable declarations after a open brace.
<0: Relative
>=0: Absolute
Type: numeric [-16 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
indent_var_def_cont
Whether to indent continued variable declarations instead of aligning.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
true |
|
indent_vbrace_open_on_tabstop
Whether to add further spaces after regular indent to reach next tabstop
when indenting after virtual brace open and newline.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
indent_with_tabs
How to use tabs when indenting code.
0: Spaces only
1: Indent with tabs to brace level, align with spaces (default)
2: Indent and align with tabs, using spaces when not on a tabstop
Default: 1
Type: multiple (0 1 2)
Default: 1
|
1
|
0 |
0 |
0 |
0 |
2 |
2 |
2 |
0 |
2 |
2 |
indent_xml_string
The number of spaces to indent multi-line XML strings.
Requires indent_align_string=true.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
2 |
|
Line splitting options |
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
code_width
Try to limit code width to N columns.
Type: numeric [0 .. 10000]
Default: 0
|
0
|
82 |
80 |
100 |
78 |
|
|
|
|
80 |
80 |
ls_code_width
Whether to split lines as close to code_width as possible and ignore some
groupings.
The option ls_code_width has priority over the option ls_func_split_full.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
true |
|
ls_for_split_full
Whether to fully split long 'for' statements at semi-colons.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
ls_func_split_full
Whether to fully split long function prototypes/calls at commas.
The option ls_code_width has priority over the option ls_func_split_full.
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
|
|
|
|
|
|
|
|
Newline adding and removing options |
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
donot_add_nl_before_cpp_comment
Don't add a newline before a cpp-comment in a parameter list of a function
call.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_after_brace_close
Whether to add a newline after '}'. Does not apply if followed by a
necessary ';'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
true |
true |
nl_after_brace_open
Whether to add a newline after '{'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
true |
|
|
|
|
true |
true |
nl_after_brace_open_cmt
Whether to add a newline between the open brace and a trailing single-line
comment. Requires nl_after_brace_open=true.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_after_case
Whether to add a newline after a 'case' statement.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
true |
|
|
|
|
true |
true |
nl_after_do
Add or remove blank line after 'do/while' statement.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
nl_after_for
Add or remove blank line after 'for' statement.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
nl_after_if
Add or remove blank line after 'if' statement. Add/Force work only if the
next token is not a closing brace.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
nl_after_member
(Java) Whether to put a blank line after a member '.' or '->' operators.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_after_return
Whether to put a blank line after 'return' statements, unless followed by a
close brace.
Type: boolean [false, true]
Default: false
|
false
|
true |
|
|
|
|
|
|
|
|
true |
nl_after_semicolon
Whether to add a newline after semicolons, except in 'for' statements.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
true |
|
|
|
|
true |
true |
nl_after_square_assign
(D) Add or remove newline after '= ['. Will also affect the newline before
the ']'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
remove |
|
|
|
|
remove |
|
nl_after_switch
Add or remove blank line after 'switch' statement.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
nl_after_synchronized
Add or remove blank line after 'synchronized' statement.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
nl_after_vbrace_close
Whether to add a newline after a virtual brace close,
as in 'if (foo) a++; <here> return;'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
true |
|
|
|
|
|
true |
|
nl_after_vbrace_open
Whether to add a newline after a virtual brace open with a non-empty body.
These occur in un-braced if/while/do/for statement bodies.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
true |
|
nl_after_vbrace_open_empty
Whether to add a newline after a virtual brace open with an empty body.
These occur in un-braced if/while/do/for statement bodies.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
true |
|
nl_after_while
Add or remove blank line after 'while' statement.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
nl_assign_brace
Add or remove newline between '=' and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
add |
nl_assign_leave_one_liners
Don't split one-line braced assignments, as in 'foo_t f = { 1, 2 };'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
true |
true |
|
|
|
|
true |
true |
nl_assign_square
(D) Add or remove newline between '=' and '['.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
remove |
|
|
|
|
remove |
|
nl_before_brace_open
Whether to add a newline before '{'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_before_case
Whether to add a newline before 'case', and a blank line before a 'case'
statement that follows a ';' or '}'.
Type: boolean [false, true]
Default: false
|
false
|
true |
|
|
true |
|
|
|
1 |
|
true |
nl_before_do
Add or remove blank line before 'do'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
|
|
|
|
|
|
remove |
|
nl_before_for
Add or remove blank line before 'for'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
|
|
|
|
|
|
remove |
|
nl_before_if
Add or remove blank line before 'if'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
|
|
|
|
|
|
remove |
|
nl_before_if_closing_paren
Add or remove newline before 'if'/'else if' closing parenthesis.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
|
|
|
|
|
|
|
nl_before_ignore_after_case
Ignore nl_before_{if,for,switch,do,synchronized} if the control
statement is immediately after a case statement.
if nl_before_{if,for,switch,do} is set to remove, this option
does nothing.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_before_member
Whether to put a blank line before a member '.' or '->' operators.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_before_opening_brace_func_class_def
Add or remove newline before '{' opening brace
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
nl_before_return
Whether to put a blank line before 'return' statements, unless after an open
brace.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_before_switch
Add or remove blank line before 'switch'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
|
|
|
|
|
|
remove |
|
nl_before_synchronized
Add or remove blank line before 'synchronized'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
nl_before_throw
Add or remove newline between ')' and 'throw'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
nl_before_while
Add or remove blank line before 'while'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
|
|
|
|
|
|
remove |
|
nl_brace_brace
Add or remove newline between two open or close braces. Due to general
newline/brace handling, REMOVE may not work.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
nl_brace_catch
Add or remove newline between '}' and 'catch'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
|
|
|
|
|
remove |
|
nl_brace_else
Add or remove newline between '}' and 'else'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
force |
remove |
remove |
remove |
add |
remove |
remove |
nl_brace_finally
Add or remove newline between '}' and 'finally'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
|
|
|
|
|
remove |
|
nl_brace_fparen
Add or remove newline between '}' and ')' in a function invocation.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
nl_brace_square
Add or remove newline between '}' and ']'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
nl_brace_struct_var
Add or remove newline between the close brace and identifier,
as in 'struct { int a; } <here> b;'. Affects enumerations, unions and
structures. If set to ignore, uses nl_after_brace_close.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
nl_brace_while
Add or remove newline between '}' and 'while' of 'do' statement.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
remove |
remove |
remove |
remove |
remove |
remove |
remove |
nl_case_colon_brace
Add or remove newline between a case ':' and '{'.
Overrides nl_after_case.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
force |
|
|
|
|
remove |
|
nl_catch_brace
Add or remove newline before the '{' of a 'catch' statement, as in
'catch (decl) <here> {'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
|
|
|
|
|
remove |
|
nl_class_brace
Add or remove newline between 'class' and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
force |
|
|
|
|
|
remove |
|
nl_class_colon
Add or remove newline before or after (depending on pos_class_colon) a class
colon, as in 'class Foo <here> : <or here> public Bar'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
nl_class_init_args
Add or remove newline before or after (depending on pos_class_comma,
may not be IGNORE) each',' in the base class list.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
|
|
|
|
|
|
remove |
|
nl_class_leave_one_liners
Don't split one-line braced statements inside a 'class xx { }' body.
Type: boolean [false, true]
Default: false
|
false
|
|
|
true |
true |
|
|
|
|
true |
true |
nl_collapse_empty_body
Whether to collapse empty blocks between '{' and '}' except for functions.
Use nl_collapse_empty_body_functions to specify how empty function braces
should be formatted.
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
|
true |
|
|
|
|
true |
|
nl_collapse_empty_body_functions
Whether to collapse empty blocks between '{' and '}' for functions only.
If true, overrides nl_inside_empty_func.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_constr_colon
Add or remove newline around a class constructor colon. The exact position
depends on nl_constr_init_args, pos_constr_colon and pos_constr_comma.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
force |
|
|
|
|
|
remove |
|
nl_constr_init_args
Add or remove newline after each ',' in the constructor member
initialization. Related to nl_constr_colon, pos_constr_colon and
pos_constr_comma.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
nl_cpp_lambda_leave_one_liners
Don't split one-line C++11 lambdas, as in '[]() { return 0; }'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
true |
|
|
|
|
|
true |
|
nl_cpp_ldef_brace
Add or remove newline between C++11 lambda signature and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
nl_create_for_one_liner
Whether to remove a newline in simple unbraced for statements, turning them
into one-liners, as in 'for (...)\n stmt;' => 'for (...) stmt;'.
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
|
|
|
|
|
|
|
|
nl_create_func_def_one_liner
Whether to collapse a function definition whose body (not counting braces)
is only one line so that the entire definition (prototype, braces, body) is
a single line.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_create_if_one_liner
Whether to remove a newline in simple unbraced if statements, turning them
into one-liners, as in 'if(b)\n i++;' => 'if(b) i++;'.
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
|
|
|
|
|
|
|
|
nl_create_list_one_liner
Whether to split one-line simple list definitions into three lines by
adding newlines, as in 'int a[12] = { <here> 0 <here> };'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_create_while_one_liner
Whether to remove a newline in simple unbraced while statements, turning
them into one-liners, as in 'while (expr)\n stmt;' => 'while (expr) stmt;'.
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
|
|
|
|
|
|
|
|
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
nl_cs_property_leave_one_liners
(C#) Don't split one-line property get or set functions.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_define_macro
Whether to alter newlines in '#define' macros.
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
|
|
|
|
|
|
|
|
nl_do_brace
Add or remove newline between 'do' and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
remove |
remove |
remove |
remove |
add |
remove |
add |
nl_do_leave_one_liners
Don't split one-line do statements, as in 'do { b++; } while(...);'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_ds_struct_enum_close_brace
Whether to force a newline before '}' of a 'struct'/'union'/'enum'.
(Lower priority than eat_blanks_before_close_brace.)
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
|
|
|
|
|
|
|
|
nl_ds_struct_enum_cmt
Whether to double-space commented-entries in 'struct'/'union'/'enum'.
Type: boolean [false, true]
Default: false
|
false
|
true |
true |
|
|
|
|
|
|
|
|
nl_else_brace
Add or remove newline between 'else' and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
remove |
remove |
remove |
remove |
add |
remove |
remove |
nl_else_if
Add or remove newline between 'else' and 'if'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
remove |
|
|
|
|
remove |
remove |
nl_elseif_brace
Add or remove newline between 'else if' and '{'. If set to ignore,
nl_if_brace is used instead.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
remove |
|
|
|
|
remove |
|
nl_end_of_file
Add or remove newline at the end of the file.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
force |
force |
|
|
|
force |
force |
nl_end_of_file_min
The minimum number of newlines at the end of the file (only used if
nl_end_of_file is 'add' or 'force').
Type: numeric [0 .. 16]
Default: 0
|
0
|
1 |
1 |
1 |
1 |
1 |
|
|
|
1 |
1 |
nl_enum_brace
Add or remove newline between 'enum' and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
force |
remove |
remove |
remove |
remove |
remove |
remove |
remove |
nl_enum_class
Add or remove newline between 'enum' and 'class'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
|
|
|
|
|
|
|
nl_enum_class_identifier
Add or remove newline between 'enum class' and the identifier.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
|
|
|
|
|
|
|
nl_enum_colon_type
Add or remove newline between 'enum class identifier :' and type.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
|
|
|
|
|
|
|
nl_enum_identifier_colon
Add or remove newline between 'enum class' type and ':'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
|
|
|
|
|
|
|
nl_enum_leave_one_liners
Don't split one-line enums, as in 'enum foo { BAR = 15 };'
Type: boolean [false, true]
Default: false
|
false
|
|
|
true |
true |
|
|
|
|
true |
|
nl_enum_own_lines
Add or remove newline before first element, after comma, and after last
element, in 'enum'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_fcall_brace
Add or remove newline between a function call's ')' and '{', as in
'list_for_each(item, &list) { }'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
remove |
remove |
remove |
add |
add |
remove |
add |
nl_fdef_brace
Add or remove newline between function signature and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
force |
force |
add |
add |
add |
add |
remove |
add |
nl_fdef_brace_cond
Add or remove newline between function signature and '{',
if signature ends with ')'. Overrides nl_fdef_brace.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_finally_brace
Add or remove newline between 'finally' and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
|
|
|
|
|
remove |
|
nl_for_brace
Add or remove newline between 'for' and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
remove |
remove |
remove |
remove |
add |
remove |
add |
nl_for_leave_one_liners
Don't split one-line for statements, as in 'for(...) b++;'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_func_call_args
Add or remove newline after each ',' in a function call.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_func_call_args_multi_line
Whether to add a newline after each ',' in a function call if '(' and ')'
are in different lines.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_func_call_args_multi_line_ignore_closures
Whether to respect nl_func_call_XXX option in case of closure args.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_func_call_empty
Add or remove newline between '()' in a function call.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_func_call_end
Whether to add a newline before ')' in a function call.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_func_call_end_multi_line
Whether to add a newline before ')' in a function call if '(' and ')' are in
different lines.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
nl_func_call_paren
Add or remove newline between a function name and the opening '(' in the
call.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
|
|
|
|
|
|
|
nl_func_call_paren_empty
Overrides nl_func_call_paren for functions with no parameters.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
|
|
|
|
|
|
|
nl_func_call_start
Whether to add a newline after '(' in a function call,
has preference over nl_func_call_start_multi_line.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_func_call_start_multi_line
Whether to add a newline after '(' in a function call if '(' and ')' are in
different lines.
Type: boolean [false, true]
Default: false
|
false
|
|
|
true |
|
|
|
|
|
|
|
nl_func_class_scope
Add or remove newline between class specification and '::'
in 'void A::f() { }'. Only appears in separate member implementation (does
not appear with in-line implementation).
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
|
|
|
|
|
|
|
nl_func_decl_args
Add or remove newline after each ',' in a function declaration.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
|
remove |
remove |
|
|
|
remove |
|
nl_func_decl_args_multi_line
Whether to add a newline after each ',' in a function declaration if '('
and ')' are in different lines. If false, nl_func_decl_args is used instead.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_func_decl_empty
Add or remove newline between '()' in a function declaration.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
remove |
remove |
|
|
|
remove |
|
nl_func_decl_end
Add or remove newline before the ')' in a function declaration.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
remove |
remove |
|
|
|
remove |
|
nl_func_decl_end_multi_line
Whether to add a newline before ')' in a function declaration if '(' and ')'
are in different lines. If false, nl_func_decl_end is used instead.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_func_decl_end_single
Overrides nl_func_decl_end when there is only one parameter.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
remove |
|
|
|
|
remove |
|
nl_func_decl_start
Add or remove newline after '(' in a function declaration.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
remove |
remove |
|
|
|
remove |
|
nl_func_decl_start_multi_line
Whether to add a newline after '(' in a function declaration if '(' and ')'
are in different lines. If false, nl_func_decl_start is used instead.
Type: boolean [false, true]
Default: false
|
false
|
|
|
true |
|
|
|
|
|
|
|
nl_func_decl_start_single
Overrides nl_func_decl_start when there is only one parameter.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
nl_func_def_args
Add or remove newline after each ',' in a function definition.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
nl_func_def_args_multi_line
Whether to add a newline after each ',' in a function definition if '('
and ')' are in different lines. If false, nl_func_def_args is used instead.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_func_def_empty
Add or remove newline between '()' in a function definition.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
remove |
|
|
|
|
remove |
|
nl_func_def_end
Add or remove newline before the ')' in a function definition.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
remove |
|
|
|
|
remove |
|
nl_func_def_end_multi_line
Whether to add a newline before ')' in a function definition if '(' and ')'
are in different lines. If false, nl_func_def_end is used instead.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_func_def_end_single
Overrides nl_func_def_end when there is only one parameter.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
remove |
|
|
|
|
remove |
|
nl_func_def_paren
Add or remove newline between a function name and the opening '(' in the
definition.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
remove |
|
|
|
|
remove |
|
nl_func_def_paren_empty
Overrides nl_func_def_paren for functions with no parameters.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
|
|
|
|
|
|
|
nl_func_def_start
Add or remove newline after '(' in a function definition.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
remove |
|
|
|
|
remove |
|
nl_func_def_start_multi_line
Whether to add a newline after '(' in a function definition if '(' and ')'
are in different lines. If false, nl_func_def_start is used instead.
Type: boolean [false, true]
Default: false
|
false
|
|
|
true |
|
|
|
|
|
|
|
nl_func_def_start_single
Overrides nl_func_def_start when there is only one parameter.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
nl_func_leave_one_liners
Don't split one-line function definitions, as in 'int foo() { return 0; }'.
might modify nl_func_type_name
Type: boolean [false, true]
Default: false
|
false
|
|
|
true |
true |
|
|
|
|
true |
|
nl_func_paren
Add or remove newline between a function name and the opening '(' in the
declaration.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
remove |
remove |
|
|
|
remove |
remove |
nl_func_paren_empty
Overrides nl_func_paren for functions with no parameters.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
|
|
|
|
|
|
|
nl_func_proto_type_name
Add or remove newline between return type and function name in a prototype.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
force |
|
|
|
|
remove |
|
nl_func_scope_name
Add or remove newline between function scope and name, as in
'void A :: <here> f() { }'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
|
|
|
|
|
remove |
|
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
nl_func_type_name
Add or remove newline between return type and function name in a function
definition.
might be modified by nl_func_leave_one_liners
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
force |
|
|
|
|
remove |
|
nl_func_type_name_class
Add or remove newline between return type and function name inside a class
definition. If set to ignore, nl_func_type_name or nl_func_proto_type_name
is used instead.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
force |
|
|
|
|
remove |
|
nl_getset_brace
Add or remove newline between get/set and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
force |
nl_getset_leave_one_liners
Don't split one-line get or set functions.
Type: boolean [false, true]
Default: false
|
false
|
|
|
true |
true |
|
|
|
|
true |
|
nl_if_brace
Add or remove newline between 'if' and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
remove |
remove |
remove |
remove |
add |
remove |
remove |
nl_if_leave_one_liners
Don't split one-line if/else statements, as in 'if(...) b++;'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
true |
true |
|
|
|
|
|
|
nl_multi_line_cond
Add a newline between ')' and '{' if the ')' is on a different line than the
if/for/etc.
Overrides nl_for_brace, nl_if_brace, nl_switch_brace, nl_while_switch and
nl_catch_brace.
Type: boolean [false, true]
Default: false
|
false
|
|
|
true |
|
|
|
|
|
|
|
nl_multi_line_define
Force a newline in a define after the macro name for multi-line defines.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
true |
nl_multi_line_sparen_close
Add a newline before ')' if an if/for/while/switch condition spans multiple
lines. Overrides nl_before_if_closing_paren if both are specified.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_multi_line_sparen_open
Add a newline after '(' if an if/for/while/switch condition spans multiple
lines
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_namespace_brace
Add or remove newline between 'namespace' and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
force |
|
|
|
|
|
remove |
|
nl_namespace_two_to_one_liner
Whether to collapse a two-line namespace, like 'namespace foo\n{ decl; }'
into a single line. If true, prevents other brace newline rules from turning
such code into four lines. If true, it also preserves one-liner namespaces.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_oc_before_end
(OC) Add or remove blank line before '@end' statement.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_oc_before_implementation
(OC) Add or remove blank line before '@implementation' statement.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_oc_before_interface
(OC) Add or remove blank line before '@interface' statement.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_oc_block_brace
(OC) Add or remove newline between Objective-C block signature and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_oc_brace_catch
(OC) Add or remove newline between '}' and '@catch'. If set to ignore,
nl_brace_catch is used.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_oc_catch_brace
(OC) Add or remove newline before the '{' of a '@catch' statement, as in
'@catch (decl) <here> {'. If set to ignore, nl_catch_brace is used.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_oc_implementation_brace
(OC) Add or remove newline between '@implementation' and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_oc_interface_brace
(OC) Add or remove newline between '@interface' and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_oc_mdef_brace
(OC) Add or remove newline between method declaration and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_oc_msg_args
(OC) Whether to put each Objective-C message parameter on a separate line.
See nl_oc_msg_leave_one_liner.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_oc_msg_args_max_code_width
(OC) Max code width of Objective-C message before applying nl_oc_msg_args.
Type: numeric [0 .. 10000]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
nl_oc_msg_args_min_params
(OC) Minimum number of Objective-C message parameters before applying nl_oc_msg_args.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
nl_oc_msg_leave_one_liner
(OC) Don't split one-line Objective-C messages.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
true |
|
nl_paren_dbrace_open
(Java) Add or remove newline between the ')' and '{{' of the double brace
initializer.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
nl_return_expr
Add or remove newline between 'return' and the return expression.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
remove |
|
|
|
|
remove |
|
nl_scope_brace
(D) Add or remove newline between 'scope (x)' and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
nl_split_for_one_liner
Whether to split one-line simple unbraced for statements into two lines by
adding a newline, as in 'for (...) <here> stmt;'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_split_if_one_liner
Whether to split one-line simple unbraced if statements into two lines by
adding a newline, as in 'if(b) <here> i++;'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
nl_split_while_one_liner
Whether to split one-line simple unbraced while statements into two lines by
adding a newline, as in 'while (expr) <here> stmt;'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_squeeze_ifdef
Whether to remove blanks after '#ifxx' and '#elxx', or before '#elxx' and
'#endif'. Does not affect top-level #ifdefs.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
TRUE |
TRUE |
true |
true |
nl_squeeze_ifdef_top_level
Makes the nl_squeeze_ifdef option affect the top-level #ifdefs as well.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_squeeze_paren_close
Whether to alter newlines between consecutive parenthesis closes. The number
of closing parentheses in a line will depend on respective open parenthesis
lines.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_start_of_file
Add or remove newlines at the start of the file.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
remove |
remove |
|
|
|
remove |
remove |
nl_start_of_file_min
The minimum number of newlines at the start of the file (only used if
nl_start_of_file is 'add' or 'force').
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
nl_struct_brace
Add or remove newline between 'struct and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
force |
remove |
remove |
remove |
remove |
remove |
remove |
remove |
nl_switch_brace
Add or remove newline between 'switch' and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
remove |
remove |
remove |
remove |
add |
remove |
add |
nl_synchronized_brace
Add or remove newline between 'synchronized' and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
|
|
|
|
|
remove |
|
nl_template_args
Whether to add a newline after each ',' in a template parameter list.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_template_class
Add or remove newline after 'template<...>' of a template class.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
force |
|
|
|
|
|
force |
|
nl_template_class_decl
Add or remove newline after 'template<...>' of a template class declaration.
Overrides nl_template_class.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_template_class_decl_special
Add or remove newline after 'template<>' of a specialized class declaration.
Overrides nl_template_class_decl.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_template_class_def
Add or remove newline after 'template<...>' of a template class definition.
Overrides nl_template_class.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_template_class_def_special
Add or remove newline after 'template<>' of a specialized class definition.
Overrides nl_template_class_def.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_template_end
Whether to add a newline before '>' of a template parameter list.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_template_func
Add or remove newline after 'template<...>' of a template function.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_template_func_decl
Add or remove newline after 'template<...>' of a template function
declaration.
Overrides nl_template_func.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_template_func_decl_special
Add or remove newline after 'template<>' of a specialized function
declaration.
Overrides nl_template_func_decl.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_template_func_def
Add or remove newline after 'template<...>' of a template function
definition.
Overrides nl_template_func.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_template_func_def_special
Add or remove newline after 'template<>' of a specialized function
definition.
Overrides nl_template_func_def.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_template_start
Whether to add a newline after '<' of a template parameter list.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
nl_template_using
Add or remove newline between 'template<...>' and 'using' of a templated
type alias.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_template_var
Add or remove newline after 'template<...>' of a template variable.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_throw_expr
Add or remove newline between 'throw' and the throw expression.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_try_brace
Add or remove newline between 'try' and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
|
|
|
|
|
remove |
|
nl_tsquare_brace
Add or remove newline between '[]' and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_type_brace_init_lst
Whether to add a newline after the type in an unnamed temporary
direct-list-initialization, better:
before a direct-list-initialization.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_type_brace_init_lst_close
Whether to add a newline before the close brace in an unnamed temporary
direct-list-initialization.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
nl_type_brace_init_lst_open
Whether to add a newline after the open brace in an unnamed temporary
direct-list-initialization.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
nl_union_brace
Add or remove newline between 'union' and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
remove |
remove |
remove |
remove |
remove |
remove |
remove |
nl_unittest_brace
(D) Add or remove newline between 'unittest' and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
nl_using_brace
(C#) Add or remove newline between 'using' and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
nl_version_brace
(D) Add or remove newline between 'version (x)' and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
nl_while_brace
Add or remove newline between 'while' and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
|
remove |
remove |
remove |
add |
remove |
add |
nl_while_leave_one_liners
Don't split one-line while statements, as in 'while(...) b++;'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
true |
|
|
|
|
|
|
|
Positioning options |
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
pos_arith
The position of arithmetic operators in wrapped expressions.
Type: multiple (ignore break force lead trail join lead_break lead_force trail_break trail_force)
Default: ignore
|
ignore
|
|
|
trail |
|
|
|
|
|
join |
|
pos_assign
The position of assignment in wrapped expressions. Do not affect '='
followed by '{'.
Type: multiple (ignore break force lead trail join lead_break lead_force trail_break trail_force)
Default: ignore
|
ignore
|
|
|
trail |
|
|
|
|
|
join |
|
pos_bool
The position of Boolean operators in wrapped expressions.
Type: multiple (ignore break force lead trail join lead_break lead_force trail_break trail_force)
Default: ignore
|
ignore
|
|
|
trail |
|
|
|
|
|
join |
trail |
pos_class_colon
The position of trailing/leading class colon, between class and base class
list. Affects nl_class_colon.
Type: multiple (ignore break force lead trail join lead_break lead_force trail_break trail_force)
Default: ignore
|
ignore
|
|
|
lead_force |
|
|
|
|
|
join |
|
pos_class_comma
The position of the comma in the base class list if there is more than one
line. Affects nl_class_init_args.
Type: multiple (ignore break force lead trail join lead_break lead_force trail_break trail_force)
Default: ignore
|
ignore
|
|
|
trail |
|
|
|
|
|
join |
|
pos_comma
The position of the comma in wrapped expressions.
Type: multiple (ignore break force lead trail join lead_break lead_force trail_break trail_force)
Default: ignore
|
ignore
|
|
|
trail |
|
|
|
|
|
join |
|
pos_compare
The position of comparison operators in wrapped expressions.
Type: multiple (ignore break force lead trail join lead_break lead_force trail_break trail_force)
Default: ignore
|
ignore
|
|
|
trail |
|
|
|
|
|
join |
|
pos_conditional
The position of conditional operators, as in the '?' and ':' of
'expr ? stmt : stmt', in wrapped expressions.
Type: multiple (ignore break force lead trail join lead_break lead_force trail_break trail_force)
Default: ignore
|
ignore
|
|
|
trail |
|
|
|
|
|
join |
|
pos_constr_colon
The position of colons between constructor and member initialization.
Related to nl_constr_colon, nl_constr_init_args and pos_constr_comma.
Type: multiple (ignore break force lead trail join lead_break lead_force trail_break trail_force)
Default: ignore
|
ignore
|
|
|
lead_break |
|
|
|
|
|
join |
|
pos_constr_comma
The position of the comma in the constructor initialization list.
Related to nl_constr_colon, nl_constr_init_args and pos_constr_colon.
Type: multiple (ignore break force lead trail join lead_break lead_force trail_break trail_force)
Default: ignore
|
ignore
|
|
|
trail |
|
|
|
|
|
join |
|
pos_enum_comma
The position of the comma in enum entries.
Type: multiple (ignore break force lead trail join lead_break lead_force trail_break trail_force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
pos_shift
The position of shift operators in wrapped expressions.
Type: multiple (ignore break force lead trail join lead_break lead_force trail_break trail_force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
Preprocessor options |
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
pp_define_at_level
Whether to indent '#define' at the brace level. If false, these are
indented from column 1.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
pp_if_indent_code
Whether to indent the code between #if, #else and #endif.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
pp_ignore_define_body
Whether to ignore the '#define' body while formatting.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
pp_include_at_level
Whether to indent '#include' at the brace level.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
pp_indent
Add or remove indentation of preprocessor directives inside #if blocks
at brace level 0 (file-level).
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
remove |
|
|
|
|
remove |
pp_indent_at_level
Whether to indent #if/#else/#endif at the brace level. If false, these are
indented from column 1.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
pp_indent_at_level0
Whether to indent #if/#else/#endif at the parenthesis level if the brace
level is 0. If false, these are indented from column 1.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
pp_indent_brace
How to indent braces directly inside #if, #else, and #endif.
Requires pp_if_indent_code=true and only applies to the indent of the
preprocessor that the braces are directly inside of.
0: No extra indent
1: Indent by one level
-1: Preserve original indentation
Default: 1
Type: numeric [-1 .. 1]
Default: 1
|
1
|
|
|
true |
|
|
|
|
|
|
|
pp_indent_case
Whether to indent case statements between #if, #else, and #endif.
Only applies to the indent of the preprocessor that the case statements
directly inside of.
Default: true
Type: boolean [false, true]
Default: true
|
true
|
|
|
|
|
|
|
|
|
|
|
pp_indent_count
Specifies the number of columns to indent preprocessors per level
at brace level 0 (file-level). If pp_indent_at_level=false, also specifies
the number of columns to indent preprocessors per level
at brace level > 0 (function-level).
Default: 1
Type: numeric [0 .. 16]
Default: 1
|
1
|
|
|
2 |
|
|
|
|
|
|
|
pp_indent_extern
Whether to indent extern C blocks between #if, #else, and #endif.
Only applies to the indent of the preprocessor that the extern block is
directly inside of.
Default: true
Type: boolean [false, true]
Default: true
|
true
|
|
|
|
|
|
|
|
|
|
|
pp_indent_func_def
Whether to indent whole function definitions between #if, #else, and #endif.
Only applies to the indent of the preprocessor that the function definition
is directly inside of.
Default: true
Type: boolean [false, true]
Default: true
|
true
|
|
|
|
|
|
|
|
|
|
|
pp_indent_if
If pp_indent_at_level=true, sets the indent for #if, #else and #endif when
not at file-level. Negative values decrease indent down to the first column.
=0: Indent preprocessors using output_tab_size
>0: Column at which all preprocessors will be indented
Type: numeric [-16 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
pp_indent_in_guard
Whether to indent the body of an #if that encompasses all the code in the file.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
pp_indent_region
The indent for '#region' and '#endregion' in C# and '#pragma region' in
C/C++. Negative values decrease indent down to the first column.
Type: numeric [-16 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
pp_indent_with_tabs
How to use tabs when indenting preprocessor code.
-1: Use 'indent_with_tabs' setting (default)
0: Spaces only
1: Indent with tabs to brace level, align with spaces
2: Indent and align with tabs, using spaces when not on a tabstop
Default: -1
Type: numeric [-1 .. 2]
Default: -1
|
-1
|
|
|
|
|
|
|
|
|
|
|
pp_multiline_define_body_indent
An offset value that controls the indentation of the body of a multiline #define.
'body' refers to all the lines of a multiline #define except the first line.
Requires 'pp_ignore_define_body = false'.
<0: Absolute column: the body indentation starts off at the specified column
(ex. -3 ==> the body is indented starting from column 3)
>=0: Relative to the column of the '#' of '#define'
(ex. 3 ==> the body is indented starting 3 columns at the right of '#')
Default: 8
Type: numeric [-32 .. 32]
Default: 8
|
8
|
|
|
|
|
|
|
|
|
|
|
pp_region_indent_code
Whether to indent the code between #region and #endregion.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
pp_space_after
Add or remove space after # based on pp level of #if blocks.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
pp_space_count
Sets the number of spaces per level added with pp_space_after.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
1 |
|
pp_unbalanced_if_action
Action to perform when unbalanced #if and #else blocks are found.
0: do nothing
1: print a warning message
2: terminate the program with an error (EX_SOFTWARE)
The action will be triggered in the following cases:
- if an #ifdef block ends on a different indent level than
where it started from. Example:
#ifdef TEST
int i;
{
int j;
#endif
- an #elif/#else block ends on a different indent level than
the corresponding #ifdef block. Example:
#ifdef TEST
int i;
#else
}
int j;
#endif
Type: numeric [0 .. 2]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
Sort includes options |
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
include_category_0
The regex for include category with priority 0.
Type: string
Default:
|
|
|
|
|
|
|
|
|
|
|
|
include_category_1
The regex for include category with priority 1.
Type: string
Default:
|
|
|
|
|
|
|
|
|
|
|
|
include_category_2
The regex for include category with priority 2.
Type: string
Default:
|
|
|
|
|
|
|
|
|
|
|
|
Spacing options |
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
force_tab_after_define
If true, a <TAB> is inserted after #define.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
true |
sp_addr
Add or remove space after the '&' (address-of) unary operator. This does not
affect the spacing after a '&' that is part of a type.
Default: remove
Type: multiple (ignore add remove force)
Default: remove
|
remove
|
|
|
|
|
|
|
|
|
|
|
sp_after_angle
Add or remove space after '>'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
remove |
|
|
|
|
|
force |
force |
sp_after_assign
Add or remove space after assignment operator '=', '+=', etc.
Overrides sp_assign.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
force |
|
|
|
|
force |
|
sp_after_bit_colon
Add or remove space after a bit colon ':'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_after_byref
Add or remove space after reference sign '&', if followed by a word.
Overrides sp_type_func.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
remove |
|
|
|
|
remove |
force |
sp_after_byref_func
Add or remove space after a reference sign '&', if followed by a function
prototype or function definition.
Overrides sp_after_byref and sp_type_func.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
|
|
|
|
|
remove |
|
sp_after_cast
Add or remove space after C/D cast, i.e. 'cast(int)a' vs. 'cast(int) a' or
'(int)a' vs. '(int) a'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
|
force |
remove |
remove |
remove |
remove |
remove |
remove |
sp_after_class_colon
Add or remove space after class ':'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
force |
|
|
|
|
force |
|
sp_after_comma
Add or remove space after ',', i.e. 'a,b' vs. 'a, b'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
force |
force |
add |
force |
force |
force |
force |
sp_after_constr_colon
Add or remove space after class constructor ':'.
Default: add
Type: multiple (ignore add remove force)
Default: add
|
add
|
|
|
ignore |
|
|
|
|
|
force |
|
sp_after_dc
Add or remove space after the '::' operator.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
remove |
|
|
|
|
|
remove |
remove |
sp_after_decltype
Add or remove space between 'decltype(...)' and word,
brace or function call.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_after_ellipsis
Add or remove space after the variadic '...' when preceded by a
non-punctuator.
The value REMOVE will be overridden with FORCE
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_after_emb_cmt
Add or remove space after an embedded comment.
Default: force
Type: multiple (ignore add remove force)
Default: force
|
force
|
|
|
|
|
|
|
|
|
|
|
sp_after_for_colon
Add or remove space after ':' in a Java/C++11 range-based 'for',
as in 'for (Type var : <here> expr)'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_after_invariant_paren
(D) Add or remove space after the ')' in 'invariant (C) c'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_after_mdatype_commas
(C#, Vala) Add or remove space between ',' and ']' in multidimensional array type
like 'int[,,]'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
sp_after_new
Add or remove space after 'new', 'delete' and 'delete[]'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
force |
|
|
|
|
|
force |
|
sp_after_newop_paren
Add or remove space between ')' and type in 'new(foo) BAR'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_after_noexcept
Add or remove space after 'noexcept'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_after_oc_at_sel
(OC) Add or remove space between '@selector' and '(',
i.e. '@selector(msgName)' vs. '@selector (msgName)'.
Also applies to '@protocol()' constructs.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
sp_after_oc_at_sel_parens
(OC) Add or remove space between '@selector(x)' and the following word,
i.e. '@selector(foo) a:' vs. '@selector(foo)a:'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_after_oc_block_caret
(OC) Add or remove space after a block pointer caret,
i.e. '^int (int arg){...}' vs. '^ int (int arg){...}'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
sp_after_oc_colon
(OC) Add or remove space after the colon in message specs,
i.e. '-(int) f:(int) x;' vs. '-(int) f: (int) x;'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
|
|
|
|
|
|
force |
|
sp_after_oc_dict_colon
(OC) Add or remove space after the colon in immutable dictionary expression
'NSDictionary *test = @{@"foo" :@"bar"};'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_after_oc_msg_receiver
(OC) Add or remove space between the receiver and selector in a message,
as in '[receiver selector ...]'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
sp_after_oc_property
(OC) Add or remove space after '@property'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_after_oc_return_type
(OC) Add or remove space after the first (type) in message specs,
i.e. '-(int) f:(int)x;' vs. '-(int)f:(int)x;'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
sp_after_oc_scope
(OC) Add or remove space after the scope '+' or '-', as in '-(void) foo;'
or '+(int) bar;'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
|
|
|
|
|
|
remove |
|
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
sp_after_oc_synchronized
(OC) Add or remove space between '@synchronized' and the open parenthesis,
i.e. '@synchronized(foo)' vs. '@synchronized (foo)'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_after_oc_type
(OC) Add or remove space after the (type) in message specs,
i.e. '-(int)f: (int) x;' vs. '-(int)f: (int)x;'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
|
|
|
|
|
|
remove |
|
sp_after_operator
Add or remove space between 'operator' and operator sign.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
remove |
|
|
|
|
|
force |
|
sp_after_operator_sym
Add or remove space between the operator symbol and the open parenthesis, as
in 'operator ++('.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
remove |
|
|
|
|
|
remove |
|
sp_after_operator_sym_empty
Overrides sp_after_operator_sym when the operator has no arguments, as in
'operator *()'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
|
|
|
|
|
|
|
sp_after_ptr_block_caret
Add or remove space after pointer caret '^', if followed by a word.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_after_ptr_star
Add or remove space after pointer star '*', if followed by a word.
Overrides sp_type_func.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
force |
|
remove |
|
|
|
remove |
remove |
sp_after_ptr_star_func
Add or remove space after a pointer star '*', if followed by a function
prototype or function definition.
Overrides sp_after_ptr_star and sp_type_func.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
|
|
|
|
|
remove |
|
sp_after_ptr_star_qualifier
Add or remove space after pointer star '*', if followed by a qualifier.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_after_ptr_star_trailing
Add or remove space after a pointer star '*' in the trailing return of a
function prototype or function definition.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_after_semi
Add or remove space after ';', except when followed by a comment.
Default: add
Type: multiple (ignore add remove force)
Default: add
|
add
|
|
|
ignore |
force |
|
|
|
|
force |
|
sp_after_semi_for
Add or remove space after ';' in non-empty 'for' statements.
Default: force
Type: multiple (ignore add remove force)
Default: force
|
force
|
|
|
|
|
|
|
|
|
|
|
sp_after_semi_for_empty
Add or remove space after the final semicolon of an empty part of a for
statement, as in 'for ( ; ; <here> )'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
force |
force |
|
|
|
|
remove |
|
sp_after_send_oc_colon
(OC) Add or remove space after the colon in message specs,
i.e. '[object setValue:1];' vs. '[object setValue: 1];'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
|
|
|
|
|
|
force |
|
sp_after_sparen
Add or remove space after ')' of control statements.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
force |
force |
force |
force |
force |
force |
force |
sp_after_tag
(Pawn) Add or remove space after the tag keyword.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_after_throw
Add or remove space between 'throw' and anything other than '(' as in
'@throw [...];'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_after_tparen_close
Add or remove space between the ')' and '(' in a function type, as in
'void (*x)(...)'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
sp_after_type
Add or remove space between type and word. In cases where total removal of
whitespace would be a syntax error, a value of 'remove' is treated the same
as 'force'.
This also affects some other instances of space following a type that are
not covered by other options; for example, between the return type and
parenthesis of a function type template argument, between the type and
parenthesis of an array parameter, or between 'decltype(...)' and the
following word.
Default: force
Type: multiple (ignore add remove force)
Default: force
|
force
|
add |
add |
|
|
|
|
|
|
|
|
sp_after_type_brace_init_lst_open
Add or remove space after open brace in an unnamed temporary
direct-list-initialization
if statement is a brace_init_lst
works only if sp_brace_brace is set to ignore.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_angle_colon
Add or remove space between '>' and ':'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_angle_paren
Add or remove space between '>' and '(' as found in 'new List<byte>(foo);'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
remove |
|
|
|
|
|
remove |
|
sp_angle_paren_empty
Add or remove space between '>' and '()' as found in 'new List<byte>();'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
|
|
|
|
|
|
|
sp_angle_shift
Add or remove space between '>' and '>' in '>>' (template stuff).
Default: add
Type: multiple (ignore add remove force)
Default: add
|
add
|
|
|
remove |
|
|
|
|
|
force |
|
sp_angle_word
Add or remove space between '>' and a word as in 'List<byte> m;' or
'template <typename T> static ...'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
force |
|
|
|
|
|
force |
|
sp_annotation_paren
(Java) Add or remove space between an annotation and the open parenthesis.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
sp_arith
Add or remove space around non-assignment symbolic operators ('+', '/', '%',
'<<', and so forth).
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
force |
force |
add |
force |
force |
force |
|
sp_arith_additive
Add or remove space around arithmetic operators '+' and '-'.
Overrides sp_arith.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
force |
|
|
|
|
|
|
|
sp_assign
Add or remove space around assignment operator '=', '+=', etc.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
force |
force |
add |
force |
force |
force |
force |
sp_assign_default
Add or remove space around assignment operator '=' in a prototype.
If set to ignore, use sp_assign.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
force |
|
|
|
|
force |
|
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
sp_attribute_paren
Add or remove space between '__attribute__' and '('.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
|
remove |
|
|
|
|
force |
|
sp_balance_nested_parens
Whether to balance spaces inside nested parentheses.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
sp_before_angle
Add or remove space before '<'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
remove |
|
|
|
|
|
remove |
remove |
sp_before_assign
Add or remove space before assignment operator '=', '+=', etc.
Overrides sp_assign.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
force |
|
|
|
|
force |
|
sp_before_bit_colon
Add or remove space before a bit colon ':'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_before_byref
Add or remove space before a reference sign '&'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
force |
force |
|
|
|
|
force |
remove |
sp_before_byref_func
Add or remove space before a reference sign '&', if followed by a function
prototype or function definition.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
force |
|
|
|
|
|
force |
|
sp_before_case_colon
Add or remove space before case ':'.
Default: remove
Type: multiple (ignore add remove force)
Default: remove
|
remove
|
|
|
|
|
|
|
|
|
|
|
sp_before_class_colon
Add or remove space before class ':'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
force |
|
|
|
|
remove |
|
sp_before_comma
Add or remove space before ',', i.e. 'a,b' vs. 'a ,b'.
Default: remove
Type: multiple (ignore add remove force)
Default: remove
|
remove
|
|
|
|
|
|
|
|
|
|
|
sp_before_constr_colon
Add or remove space before class constructor ':'.
Default: add
Type: multiple (ignore add remove force)
Default: add
|
add
|
|
|
ignore |
|
|
|
|
|
remove |
|
sp_before_dc
Add or remove space before the '::' operator.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
remove |
|
|
|
|
|
remove |
remove |
sp_before_ellipsis
Add or remove space before the variadic '...' when preceded by a
non-punctuator.
The value REMOVE will be overridden with FORCE
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
force |
|
|
|
|
force |
|
sp_before_emb_cmt
Add or remove space before an embedded comment.
Default: force
Type: multiple (ignore add remove force)
Default: force
|
force
|
|
|
|
|
|
|
|
|
|
|
sp_before_for_colon
Add or remove space before ':' in a Java/C++11 range-based 'for',
as in 'for (Type var <here> : expr)'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_before_global_scope_ptr_star
Add or remove space before pointer star '*' that is followed by '::',
as in 'int *::func()'.
If set to ignore, sp_before_unnamed_ptr_star is used instead.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_before_mdatype_commas
(C#, Vala) Add or remove space between '[' and ',' in multidimensional array type
like 'int[,,]'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
sp_before_nl_cont
Add or remove space before a backslash-newline at the end of a line.
Default: add
Type: multiple (ignore add remove force)
Default: add
|
add
|
remove |
remove |
force |
|
|
|
|
|
force |
|
sp_before_oc_block_caret
(OC) Add or remove space before a block pointer caret,
i.e. '^int (int arg){...}' vs. ' ^int (int arg){...}'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
sp_before_oc_colon
(OC) Add or remove space before the colon in message specs,
i.e. '-(int) f: (int) x;' vs. '-(int) f : (int) x;'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
|
|
|
|
|
|
force |
|
sp_before_oc_dict_colon
(OC) Add or remove space before the colon in immutable dictionary expression
'NSDictionary *test = @{@"foo" :@"bar"};'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_before_oc_proto_list
(OC) Add or remove space before Objective-C protocol list
as in '@protocol Protocol<here><Protocol_A>' or '@interface MyClass : NSObject<here><MyProtocol>'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_before_operator_ptr_star
Add or remove space before pointer star '*' that is followed by 'operator' keyword.
If set to ignore, sp_before_unnamed_ptr_star is used instead.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_before_pp_stringify
Add or remove space before preprocessor '#' stringify operator
as in '#define x(y) L#y'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_before_ptr_star
Add or remove space before pointer star '*'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
|
force |
|
|
|
force |
force |
sp_before_ptr_star_func
Add or remove space before a pointer star '*', if followed by a function
prototype or function definition. If set to ignore, sp_before_ptr_star is
used instead.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
force |
|
|
|
|
|
force |
|
sp_before_ptr_star_trailing
Add or remove space before a pointer star '*' in the trailing return of a
function prototype or function definition.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_before_qualifier_ptr_star
Add or remove space before pointer star '*' that is followed by a qualifier.
If set to ignore, sp_before_unnamed_ptr_star is used instead.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_before_scope_ptr_star
Add or remove space before pointer star '*' that is followed by
a class scope (as in 'int *MyClass::method()') or namespace scope
(as in 'int *my_ns::func()').
If set to ignore, sp_before_unnamed_ptr_star is used instead.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_before_semi
Add or remove space before ';'.
Default: remove
Type: multiple (ignore add remove force)
Default: remove
|
remove
|
|
|
|
|
|
|
|
|
|
|
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
sp_before_semi_for
Add or remove space before ';' in non-empty 'for' statements.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
|
|
|
|
|
|
remove |
|
sp_before_semi_for_empty
Add or remove space before a semicolon of an empty left part of a for
statement, as in 'for ( <here> ; ; )'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
|
|
|
|
|
|
remove |
force |
sp_before_send_oc_colon
(OC) Add or remove space before the colon in message specs,
i.e. '[object setValue:1];' vs. '[object setValue :1];'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
|
|
|
|
|
|
remove |
|
sp_before_sparen
Add or remove space before '(' of control statements ('if', 'for', 'switch',
'while', etc.).
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
force |
force |
force |
force |
force |
force |
force |
sp_before_square
Add or remove space before '[' (except '[]').
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
remove |
remove |
|
|
|
|
remove |
|
sp_before_square_asm_block
Add or remove space before '[' for asm block.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_before_squares
Add or remove space before '[]'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
remove |
|
|
|
|
|
remove |
|
sp_before_template_paren
(D) Add or remove space before the parenthesis in the D constructs
'template Foo(' and 'class Foo('.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
sp_before_tr_cmt
Add or remove space before a trailing comment.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_before_type_brace_init_lst_close
Add or remove space before close brace in an unnamed temporary
direct-list-initialization
if statement is a brace_init_lst
works only if sp_brace_brace is set to ignore.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_before_unnamed_byref
Add or remove space before a reference sign '&' that isn't followed by a
variable name. If set to ignore, sp_before_byref is used instead.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
|
force |
|
|
|
|
force |
|
sp_before_unnamed_ptr_star
Add or remove space before pointer star '*' that isn't followed by a
variable name. If set to ignore, sp_before_ptr_star is used instead.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
|
force |
|
|
|
|
force |
|
sp_before_vardef_square
Add or remove space before '[' for a variable definition.
Default: remove
Type: multiple (ignore add remove force)
Default: remove
|
remove
|
|
|
|
|
|
|
|
|
|
|
sp_between_mdatype_commas
(C#, Vala) Add or remove space between ',' in multidimensional array type
like 'int[,,]'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
sp_between_new_paren
Add or remove space between 'new' and '(' in 'new()'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
sp_between_ptr_ref
Add or remove space between pointer star '*' and reference '&', as in 'int *& a;'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_between_ptr_star
Add or remove space between pointer stars '*', as in 'int ***a;'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
remove |
|
remove |
|
|
|
remove |
remove |
sp_between_semi_for_empty
Add or remove space between the semicolons of an empty middle part of a for
statement, as in 'for ( ; <here> ; )'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
force |
sp_bool
Add or remove space around boolean operators '&&' and '||'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
force |
force |
add |
force |
force |
force |
force |
sp_brace_brace
Add or remove space between nested braces, i.e. '{{' vs. '{ {'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_brace_catch
Add or remove space between '}' and 'catch' if on the same line.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
|
|
|
|
|
force |
|
sp_brace_close_while
Add or remove space between '}' and 'while'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_brace_else
Add or remove space between '}' and 'else' if on the same line.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
force |
force |
|
|
|
force |
|
sp_brace_finally
Add or remove space between '}' and 'finally' if on the same line.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
|
|
|
|
|
force |
|
sp_brace_typedef
Add or remove space between '}' and the name of a typedef on the same line.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
force |
|
|
|
|
force |
force |
sp_byref_ellipsis
Add or remove space between '&&' and '...'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_byref_paren
Add or remove space after a reference sign '&', if followed by an open
parenthesis, as in 'char& (*)()'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_case_label
Fix the spacing between 'case' and the label. Only 'ignore' and 'force' make
sense here.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
force |
|
|
|
|
|
force |
remove |
sp_catch_brace
Add or remove space before the '{' of a 'catch' statement, if the '{' and
'catch' are on the same line, as in 'catch (decl) <here> {'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
|
|
|
|
|
force |
|
sp_catch_paren
Add or remove space between 'catch' and '(' in 'catch (something) { }'.
If set to ignore, sp_before_sparen is used.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
sp_cmt_cpp_doxygen
If true, space added with sp_cmt_cpp_start will be added after Doxygen
sequences like '///', '///<', '//!' and '//!<'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
sp_cmt_cpp_lint
remove space after the '//' and the command 'lint',
only works with sp_cmt_cpp_start set to add or force.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
sp_cmt_cpp_pvs
remove space after the '//' and the pvs command '-V1234',
only works with sp_cmt_cpp_start set to add or force.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
sp_cmt_cpp_qttr
If true, space added with sp_cmt_cpp_start will be added after Qt translator
or meta-data comments like '//:', '//=', and '//~'.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
sp_cmt_cpp_region
Add or remove space in a C++ region marker comment, as in '// <here> BEGIN'.
A region marker is defined as a comment which is not preceded by other text
(i.e. the comment is the first non-whitespace on the line), and which starts
with either 'BEGIN' or 'END'.
Overrides sp_cmt_cpp_start.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_cmt_cpp_start
Add or remove space after the opening of a C++ comment, as in '// <here> A'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
|
|
|
|
|
|
force |
|
sp_compare
Add or remove space around compare operator '<', '>', '==', etc.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
force |
force |
add |
force |
force |
force |
force |
sp_cond_colon
Add or remove space around the ':' in 'b ? t : f'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
|
|
|
|
|
force |
|
sp_cond_colon_after
Add or remove space after the ':' in 'b ? t : f'.
Overrides sp_cond_colon.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_cond_colon_before
Add or remove space before the ':' in 'b ? t : f'.
Overrides sp_cond_colon.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_cond_question
Add or remove space around the '?' in 'b ? t : f'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
|
|
|
|
|
force |
|
sp_cond_question_after
Add or remove space after the '?' in 'b ? t : f'.
Overrides sp_cond_question.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_cond_question_before
Add or remove space before the '?' in 'b ? t : f'.
Overrides sp_cond_question.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_cond_ternary_short
In the abbreviated ternary form '(a ?: b)', add or remove space between '?'
and ':'.
Overrides all other sp_cond_* options.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_cparen_oparen
Add or remove space between back-to-back parentheses, i.e. ')(' vs. ') ('.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
sp_cpp_before_struct_binding
Add or remove space before C++17 structured bindings.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_cpp_before_struct_binding_after_byref
Add or remove space before C++17 structured bindings
after byref.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_cpp_cast_paren
Add or remove space between the type and open parenthesis in a C++ cast,
i.e. 'int(exp)' vs. 'int (exp)'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
remove |
|
|
|
|
|
remove |
|
sp_cpp_lambda_argument_list
Add or remove space after the opening parenthesis and before the closing
parenthesis of a argument list of a C++11 lambda, as in
'[]( <here> int x <here> ){ ... }'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_cpp_lambda_argument_list_empty
Add or remove space after the opening parenthesis and before the closing
parenthesis of a argument list of a C++11 lambda, as in
'[]( <here> ){ ... }'
with an empty list.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_cpp_lambda_assign
Add or remove space around '=' in C++11 lambda capture specifications.
Overrides sp_assign.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_cpp_lambda_fparen
Add or remove space between a lambda body and its call operator of an
immediately invoked lambda, as in '[]( ... ){ ... } <here> ( ... )'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_cpp_lambda_paren_brace
Add or remove space after the argument list of a C++11 lambda, as in
'[](int x) <here> { ... }'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_cpp_lambda_square_brace
Add or remove space after the capture specification of a C++11 lambda with
no argument list is present, as in '[] <here> { ... }'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_cpp_lambda_square_paren
Add or remove space after the capture specification of a C++11 lambda when
an argument list is present, as in '[] <here> (int x){ ... }'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_d_array_colon
(D) Add or remove around the D named array initializer ':' operator.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_decltype_paren
Add or remove space between 'decltype' and '('.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_defined_paren
Add or remove space between 'defined' and '(' in '#if defined (FOO)'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
|
remove |
|
|
|
|
remove |
|
sp_deref
Add or remove space after the '*' (dereference) unary operator. This does
not affect the spacing after a '*' that is part of a type.
Default: remove
Type: multiple (ignore add remove force)
Default: remove
|
remove
|
|
|
|
|
|
|
|
|
|
|
sp_do_brace_open
Add or remove space between 'do' and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
sp_ellipsis_parameter_pack
Add or remove space between '...' and a parameter pack.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_else_brace
Add or remove space between 'else' and '{' if on the same line.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
force |
force |
|
|
|
force |
|
sp_endif_cmt
Add or remove space between #else or #endif and a trailing comment.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_enum_after_assign
Add or remove space after assignment '=' in enum.
Overrides sp_enum_assign.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
force |
|
|
|
|
force |
|
sp_enum_assign
Add or remove space around assignment '=' in enum.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
|
force |
|
|
|
|
force |
|
sp_enum_before_assign
Add or remove space before assignment '=' in enum.
Overrides sp_enum_assign.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
force |
|
|
|
|
force |
|
sp_enum_brace
Add or remove space in 'enum {'.
Default: add
Type: multiple (ignore add remove force)
Default: add
|
add
|
|
|
|
|
|
|
|
|
|
|
sp_enum_colon
Add or remove space around assignment ':' in enum.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_enum_paren
Add or remove space in 'NS_ENUM ('.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_extern_paren
(D) Add or remove space between 'extern' and '(' as in 'extern <here> (C)'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_finally_brace
Add or remove space between 'finally' and '{' if on the same line.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
|
|
|
|
|
force |
|
sp_fparen_brace
Add or remove space between ')' and '{' of function.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
force |
|
|
|
|
force |
add |
sp_fparen_brace_initializer
Add or remove space between ')' and '{' of a function call in object
initialization.
Overrides sp_fparen_brace.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
force |
|
|
|
|
|
|
|
sp_fparen_dbrace
(Java) Add or remove space between ')' and '{{' of double brace initializer.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_func_call_paren
Add or remove space between function name and '(' on function calls.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
remove |
remove |
remove |
remove |
remove |
remove |
remove |
remove |
sp_func_call_paren_empty
Add or remove space between function name and '()' on function calls without
parameters. If set to ignore (the default), sp_func_call_paren is used.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
remove |
|
|
|
|
remove |
|
sp_func_call_user_inside_fparen
Add or remove space inside user function '(' and ')'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_func_call_user_inside_rparen
Add or remove space inside user functor '(' and ')'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_func_call_user_paren
Add or remove space between the user function name and '(' on function
calls. You need to set a keyword to be a user function in the config file,
like:
set func_call_user tr _ i18n
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
|
|
|
|
|
|
remove |
|
sp_func_call_user_paren_paren
Add or remove space between nested parentheses with user functions,
i.e. '((' vs. '( ('.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_func_class_paren
Add or remove space between a constructor/destructor and the open
parenthesis.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
remove |
|
|
|
|
|
remove |
remove |
sp_func_class_paren_empty
Add or remove space between a constructor without parameters or destructor
and '()'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
|
|
|
|
|
|
|
sp_func_def_paren
Add or remove space between alias name and '(' of a non-pointer function type typedef.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
remove |
remove |
remove |
remove |
remove |
remove |
remove |
remove |
sp_func_def_paren_empty
Add or remove space between function name and '()' on function definition
if empty.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
|
|
|
|
|
|
|
sp_func_proto_paren
Add or remove space between function name and '(' on function declaration.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
remove |
remove |
remove |
remove |
remove |
remove |
remove |
remove |
sp_func_proto_paren_empty
Add or remove space between function name and '()' on function declaration
if empty.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
remove |
|
|
|
|
|
|
|
sp_func_type_paren
Add or remove space between function name and '(' with a typedef specifier.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_getset_brace
Add or remove space between get/set and '{' if on the same line.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
|
|
|
|
|
|
force |
|
sp_incdec
Add or remove space between '++' and '--' the word to which it is being
applied, as in '(--x)' or 'y++;'.
Default: remove
Type: multiple (ignore add remove force)
Default: remove
|
remove
|
|
|
|
|
|
|
|
|
|
|
sp_inside_angle
Add or remove space inside '<' and '>'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
remove |
|
|
|
|
|
remove |
remove |
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
sp_inside_angle_empty
Add or remove space inside '<>'.
if empty.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_inside_braces
Add or remove space inside '{' and '}'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
remove |
force |
force |
add |
force |
force |
force |
force |
sp_inside_braces_empty
Add or remove space inside '{}'.
if empty.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
remove |
force |
|
|
|
|
remove |
|
sp_inside_braces_enum
Add or remove space inside enum '{' and '}'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
|
force |
force |
add |
force |
force |
force |
force |
sp_inside_braces_oc_dict
(OC) Add or remove space inside Objective-C boxed dictionary '{' and '}'
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_inside_braces_struct
Add or remove space inside struct/union '{' and '}'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
|
force |
force |
add |
force |
force |
force |
force |
sp_inside_for
Add or remove space inside '(' and ')' of 'for' statements.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
remove |
|
remove |
remove |
remove |
remove |
sp_inside_for_close
Add or remove space before ')' of 'for' statements.
Overrides sp_inside_for.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
sp_inside_for_open
Add or remove space after '(' of 'for' statements.
Overrides sp_inside_for.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
sp_inside_fparen
Add or remove space inside function '(' and ')'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
remove |
remove |
remove |
|
remove |
remove |
remove |
remove |
sp_inside_fparens
Add or remove space inside empty function '()'.
Overrides sp_after_angle unless use_sp_after_angle_always is set to true.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
remove |
remove |
|
|
|
|
remove |
|
sp_inside_newop_paren
Add or remove space inside parentheses of the new operator
as in 'new(foo) BAR'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_inside_newop_paren_close
Add or remove space before the close parenthesis of the new operator,
as in 'new(foo) BAR'.
Overrides sp_inside_newop_paren.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_inside_newop_paren_open
Add or remove space after the open parenthesis of the new operator,
as in 'new(foo) BAR'.
Overrides sp_inside_newop_paren.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_inside_oc_at_sel_parens
(OC) Add or remove space inside '@selector' parentheses,
i.e. '@selector(foo)' vs. '@selector( foo )'.
Also applies to '@protocol()' constructs.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
sp_inside_paren
Add or remove space inside '(' and ')'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
|
remove |
remove |
|
remove |
remove |
remove |
remove |
sp_inside_paren_cast
Add or remove spaces inside cast parentheses.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
remove |
remove |
remove |
|
|
|
remove |
|
sp_inside_rparen
Add or remove space inside functor '(' and ')'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_inside_rparens
Add or remove space inside empty functor '()'.
Overrides sp_after_angle unless use_sp_after_angle_always is set to true.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_inside_sparen
Add or remove space inside '(' and ')' of control statements other than
'for'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
remove |
remove |
remove |
|
remove |
remove |
remove |
remove |
sp_inside_sparen_close
Add or remove space before ')' of control statements other than 'for'.
Overrides sp_inside_sparen.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
remove |
|
|
|
|
remove |
|
sp_inside_sparen_open
Add or remove space after '(' of control statements other than 'for'.
Overrides sp_inside_sparen.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
sp_inside_square
Add or remove space inside a non-empty '[' and ']'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
remove |
remove |
remove |
|
|
|
remove |
remove |
sp_inside_square_empty
Add or remove space inside '[]'.
if empty.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_inside_square_oc_array
(OC) Add or remove space inside a non-empty Objective-C boxed array '@[' and
']'. If set to ignore, sp_inside_square is used.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_inside_tparen
Add or remove space inside the first parentheses in a function type, as in
'void (*x)(...)'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
sp_inside_type_brace_init_lst
Add or remove space inside an unnamed temporary direct-list-initialization
if statement is a brace_init_lst
works only if sp_brace_brace is set to ignore
works only if sp_before_type_brace_init_lst_close is set to ignore.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_inv
Add or remove space after the '~' (invert) unary operator.
Default: remove
Type: multiple (ignore add remove force)
Default: remove
|
remove
|
|
|
|
|
|
|
|
|
|
|
sp_invariant_paren
(D) Add or remove space between 'invariant' and '('.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
sp_macro
Add or remove space between a macro name and its definition.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
|
force |
|
|
|
|
force |
|
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
sp_macro_func
Add or remove space between a macro function ')' and its definition.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
|
force |
|
|
|
|
force |
|
sp_member
Add or remove space around the '.' or '->' operators.
Default: remove
Type: multiple (ignore add remove force)
Default: remove
|
remove
|
|
|
|
|
|
|
|
|
|
|
sp_not
Add or remove space after the '!' (not) unary operator.
Default: remove
Type: multiple (ignore add remove force)
Default: remove
|
remove
|
|
|
|
|
|
|
|
|
|
|
sp_not_not
Add or remove space between two '!' (not) unary operators.
If set to ignore, sp_not will be used.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_num_after_emb_cmt
Number of spaces after an embedded comment.
Default: 1
Type: numeric [0 .. 16]
Default: 1
|
1
|
|
|
|
|
|
|
|
|
|
|
sp_num_before_emb_cmt
Number of spaces before an embedded comment.
Default: 1
Type: numeric [0 .. 16]
Default: 1
|
1
|
|
|
|
|
|
|
|
|
|
|
sp_num_before_tr_cmt
Number of spaces before a trailing comment.
Type: numeric [0 .. 16]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
sp_oc_brace_catch
(OC) Add or remove space between '}' and '@catch' if on the same line.
If set to ignore, sp_brace_catch is used.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_oc_catch_brace
(OC) Add or remove space before the '{' of a '@catch' statement, if the '{'
and '@catch' are on the same line, as in '@catch (decl) <here> {'.
If set to ignore, sp_catch_brace is used.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_oc_catch_paren
(OC) Add or remove space between '@catch' and '('
in '@catch (something) { }'. If set to ignore, sp_catch_paren is used.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_oc_classname_paren
(OC) Add or remove space between class name and '('
in '@interface className(categoryName)<ProtocolName>:BaseClass'
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_parameter_pack_ellipsis
Add or remove space between a parameter pack and '...'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_paren_brace
Add or remove space between ')' and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
force |
|
|
|
|
force |
|
sp_paren_comma
Add or remove space between an open parenthesis and comma,
i.e. '(,' vs. '( ,'.
Default: force
Type: multiple (ignore add remove force)
Default: force
|
force
|
|
|
|
|
|
|
|
|
|
|
sp_paren_ellipsis
Add or remove space between ')' and '...'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_paren_noexcept
Add or remove space between ')' and 'noexcept'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_paren_paren
Add or remove space between nested parentheses, i.e. '((' vs. ') )'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
|
remove |
remove |
|
remove |
remove |
remove |
remove |
sp_paren_qualifier
Add or remove space between ')' and a qualifier such as 'const'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_permit_cpp11_shift
(C++11) Permit removal of the space between '>>' in 'foo<bar<int> >'. Note
that sp_angle_shift cannot remove the space without this option.
Type: boolean [false, true]
Default: false
|
false
|
|
|
true |
|
|
|
|
|
|
|
sp_pp_concat
Add or remove space around preprocessor '##' concatenation operator.
Default: add
Type: multiple (ignore add remove force)
Default: add
|
add
|
|
|
force |
|
|
|
|
|
force |
|
sp_pp_stringify
Add or remove space after preprocessor '#' stringify operator.
Also affects the '#@' charizing operator.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
remove |
add |
|
|
|
|
force |
add |
sp_ptr_star_func_type
Add or remove space between the pointer star '*' and the name of the type
in a function pointer type definition.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_ptr_star_func_var
Add or remove space between the pointer star '*' and the name of the variable
in a function pointer definition.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
remove |
|
|
|
remove |
|
sp_ptr_star_paren
Add or remove space after a pointer star '*', if followed by an open
parenthesis, as in 'void* (*)()'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
sp_ptr_type_ellipsis
Add or remove space between a '*' and '...'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_qualifier_ptr_star_func
Add or remove space between a qualifier and a pointer star '*' followed by
the name of the function in a function prototype or definition, as in
'char const *foo()`. If set to ignore, sp_before_ptr_star is used instead.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_qualifier_ptr_star_trailing
Add or remove space between a qualifier and a pointer star '*' in the
trailing return of a function prototype or function definition, as in
'auto foo() -> char const *'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_qualifier_unnamed_ptr_star
Add or remove space between a qualifier and a pointer star '*' that isn't
followed by a variable name, as in '(char const *)'. If set to ignore,
sp_before_ptr_star is used instead.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_range
(D) Add or remove space around the D '..' operator.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_return
Add or remove space after 'return'.
Default: force
Type: multiple (ignore add remove force)
Default: force
|
force
|
|
|
|
|
|
|
|
|
|
|
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
sp_return_brace
Add or remove space between 'return' and '{'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_return_paren
Add or remove space between 'return' and '('.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
|
force |
force |
|
remove |
remove |
force |
force |
sp_scope_paren
(D) Add or remove space between 'scope' and '('
in 'scope (something) { }'. If set to ignore, sp_before_sparen is used.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_sign
Add or remove space after '+' or '-', as in 'x = -5' or 'y = +7'.
Default: remove
Type: multiple (ignore add remove force)
Default: remove
|
remove
|
|
|
|
|
|
|
|
|
|
|
sp_sizeof_ellipsis
Add or remove space between 'sizeof' and '...'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_sizeof_ellipsis_paren
Add or remove space between 'sizeof...' and '('.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_sizeof_paren
Add or remove space between 'sizeof' and '('.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
remove |
remove |
remove |
remove |
remove |
remove |
force |
remove |
sp_skip_vbrace_tokens
If true, vbrace tokens are dropped to the previous token and skipped.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
sp_sparen_brace
Add or remove space between ')' and '{' of control statements.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
force |
|
|
|
|
force |
add |
sp_sparen_paren
Add or remove space between '((' or '))' of control statements.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_special_semi
Add or remove space before empty statement ';' on 'if', 'for' and 'while'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
|
force |
|
|
|
|
remove |
|
sp_square_fparen
Add or remove space between ']' and '(' when part of a function call.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
remove |
remove |
|
|
|
|
remove |
|
sp_string_string
Add or remove space between two strings.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_super_paren
Add or remove space between 'super' and '(' in 'super (something)'.
Default: remove
Type: multiple (ignore add remove force)
Default: remove
|
remove
|
|
|
|
|
|
|
|
|
|
|
sp_template_angle
Add or remove space between 'template' and '<'.
If set to ignore, sp_before_angle is used.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
remove |
|
sp_this_paren
Add or remove space between 'this' and '(' in 'this (something)'.
Default: remove
Type: multiple (ignore add remove force)
Default: remove
|
remove
|
|
|
|
|
|
|
|
|
|
|
sp_throw_paren
Add or remove space between 'throw' and '(' in 'throw (something)'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
remove |
remove |
|
|
|
|
|
|
force |
|
sp_trailing_return
Add or remove space around trailing return operator '->'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_try_brace
Add or remove space between 'try' and '{' if on the same line.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
force |
|
|
|
|
|
force |
|
sp_type_brace_init_lst
Add or remove space between type and open brace of an unnamed temporary
direct-list-initialization.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
add |
|
sp_type_colon
Add or remove space between a type and ':'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_type_ellipsis
Add or remove space between a type and '...'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_type_func
Add or remove space between return type and function name. A minimum of 1
is forced except for pointer return types.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
add |
add |
|
|
|
|
|
|
remove |
force |
sp_vala_after_translation
Add or remove space after '_'.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_version_paren
(D) Add or remove space between 'version' and '('
in 'version (something) { }'. If set to ignore, sp_before_sparen is used.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
force |
|
sp_while_paren_open
Add or remove space between 'while' and '('. Overrides sp_before_sparen.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_word_brace_init_lst
Add or remove space between a variable and '{' for C++ uniform
initialization.
Type: multiple (ignore add remove force)
Default: ignore
|
ignore
|
|
|
|
|
|
|
|
|
|
|
sp_word_brace_ns
Add or remove space between a variable and '{' for a namespace.
Default: add
Type: multiple (ignore add remove force)
Default: add
|
add
|
|
|
|
|
|
|
|
|
force |
|
Use or Do not Use options |
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
indent_cpp_lambda_only_once
The indentation can be:
- after the assignment, at the '[' character
- at the beginning of the lambda body
true: indentation will be at the beginning of the lambda body
false: indentation will be after the assignment (default)
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
use_form_feed_no_more_as_whitespace_character
If true: the form feed character is removed from the list of whitespace
characters. See https://en.cppreference.com/w/cpp/string/byte/isspace.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
use_indent_continue_only_once
The value of the indentation for a continuation line is calculated
differently if the statement is:
- a declaration: your case with QString fileName ...
- an assignment: your case with pSettings = new QSettings( ...
At the second case the indentation value might be used twice:
- at the assignment
- at the function call (if present)
To prevent the double use of the indentation value, use this option with the
value 'true'.
true: indent_continue will be used only once
false: indent_continue will be used every time (default)
Requires indent_ignore_first_continue=false.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
use_indent_func_call_param
true: indent_func_call_param will be used (default)
false: indent_func_call_param will NOT be used
Default: true
Type: boolean [false, true]
Default: true
|
true
|
|
|
|
|
|
|
|
|
|
|
use_options_overriding_for_qt_macros
Whether to apply special formatting for Qt SIGNAL/SLOT macros. Essentially,
this tries to format these so that they match Qt's normalized form (i.e. the
result of QMetaObject::normalizedSignature), which can slightly improve the
performance of the QObject::connect call, rather than how they would
otherwise be formatted.
See options_for_QT.cpp for details.
Default: true
Type: boolean [false, true]
Default: true
|
true
|
|
|
|
|
|
|
|
|
|
|
use_sp_after_angle_always
Whether sp_after_angle takes precedence over sp_inside_fparen. This was the
historic behavior, but is probably not the desired behavior, so this is off
by default.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
Warn levels - 1: error, 2: warning (default), 3: note |
| Options |
default |
google2.cfg |
google3.cfg |
ros_ament.cfg |
libxkb.cfg |
linux.cfg |
linux-indent.cfg |
kr-indent.cfg |
gnu-indent.cfg |
sun.cfg |
freebsd.cfg |
debug_decode_the_flags
decode (or not) the flags as a new line.
only if the -p option is set.
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
debug_line_number_to_protocol
Set the number of the line to protocol;
Used in the function prot_the_line if the 2. parameter is zero.
0: nothing protocol.
Type: numeric [0 .. ]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
debug_max_number_of_loops
Limit the number of loops.
Used by uncrustify.cpp to exit from infinite loop.
0: no limit.
Type: numeric [0 .. ]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
debug_sort_the_tracks
sort (or not) the tracking info.
Default: true
Type: boolean [false, true]
Default: true
|
true
|
|
|
|
|
|
|
|
|
|
|
debug_timeout
Set the number of second(s) before terminating formatting the current file,
0: no timeout.
only for linux
Type: numeric [0 .. ]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
debug_truncate
Set the number of characters to be printed if the text is too long,
0: do not truncate.
Type: numeric [0 .. 960]
Default: 0
|
0
|
|
|
|
|
|
|
|
|
|
|
debug_use_the_exit_function_pop
use (or not) the exit(EX_SOFTWARE) function.
Default: true
Type: boolean [false, true]
Default: true
|
true
|
|
|
|
|
|
|
|
|
|
|
set_numbering_for_html_output
insert the number of the line at the beginning of each line
Type: boolean [false, true]
Default: false
|
false
|
|
|
|
|
|
|
|
|
|
|
warn_level_tabs_found_in_verbatim_string_literals
(C#) Warning is given if doing tab-to-\t replacement and we have found one
in a C# verbatim string literal.
Default: 2
Type: numeric [1 .. 3]
Default: 2
|
2
|
|
|
|
|
|
|
|
|
|
|
Uncrustify Documentation Project