Skip to content

Instantly share code, notes, and snippets.

@CDanU
Created February 19, 2016 02:37
Show Gist options
  • Save CDanU/8f0cb37f1e5c88156346 to your computer and use it in GitHub Desktop.
Save CDanU/8f0cb37f1e5c88156346 to your computer and use it in GitHub Desktop.
newlines = crlf # auto/lf/crlf/cr
input_tab_size = 4 # The original size of tabs in the input
output_tab_size = 4 # The size of tabs in the output (only used if align_with_tabs=true)
tok_split_gte = false # Allow interpreting '>=' and '>>=' as part of a template in 'void f(list<list<B>>=val);'.If true (default), 'assert(x<0 && y>=3)' will be broken.
utf8_force = true # Force the output encoding to UTF-8
string_escape_char = 92 # The ASCII value of the string escape char, usually 92 (\) or 94 (^). (Pawn)
#string_escape_char2 = 0 # Alternate string escape char for Pawn. Only works right before the quote char.
string_replace_tab_chars = true # Replace tab characters found in string literals with the escape sequence \t instead.
utf8_bom = remove # Control what to do with the UTF-8 BOM (recommend 'remove')
utf8_byte = true # If the file contains bytes with values between 128 and 255, but is not UTF-8, then output as UTF-8
# enable_processing_cmt = "" # Override the default ' *INDENT-ON*' in comments for enabling processing of part of the file.
# disable_processing_cmt = "" # Override the default ' *INDENT-OFF*' in comments for disabling processing of part of the file.
# enable_digraphs = false # Enable parsing of digraphs. Default=false
################################################################################
#region Indenting options (TODO)
################################################################################
indent_columns = 4 # The number of columns to indent per level.
indent_with_tabs = 0 # 0=spaces only # 1= with tabs to brace level, align with spaces # 2=indent and align with tabs, using spaces when not on a tabstop
indent_align_string = true # Whether to indent strings broken by '\' so that they line up
indent_class = true # Whether the 'class' body is indented
indent_namespace = true # Whether the 'namespace' body is indented
indent_extern = true # Whether the 'extern "C"' body is indented
indent_else_if = false # True: indent 'if' 1 lvl | False: treat 'else\nif' as 'else if' for indenting purposes
indent_access_spec_body = true # Indent code after (privat, public ...) by 1 lvl. # If set, forces 'indent_access_spec=0'
indent_constr_colon = true # Whether to indent the stuff after a leading class initializer colon
# The continuation indent. If non-zero, this overrides the indent of '(' and '=' continuation indents.
# For FreeBSD, this is set to 4. Negative value is absolute and not increased for each ( level )
indent_continue = 0
indent_xml_string = 0 # The number of spaces to indent multi-line XML strings. # Requires indent_align_string=True
indent_brace = 0 # Spaces to indent '{' from level, 2: |{ --> | {
indent_braces = false # Whether braces are indented to the body level
#indent_braces_no_func = false # Disabled indenting function braces if indent_braces is true
#indent_braces_no_class = false # Disabled indenting class braces if indent_braces is true
#indent_braces_no_struct = false # Disabled indenting struct braces if indent_braces is true
indent_brace_parent = false # Indent based on the size of the brace parent, i.e. 'if' => 3 spaces, 'for' => 4 spaces, etc.
indent_paren_open_brace = false # Indent based on the paren open instead of the brace open in '({\n', default is to indent by brace.
indent_namespace_single_indent = false # Only indent one namespace and no sub-namepaces. # Requires indent_namespace=true.
indent_namespace_level = 0 # The number of spaces to indent a namespace block
indent_namespace_limit = 0 # If the body of the namespace is longer than this number, it won't be indented. # Requires indent_namespace=true. Default=0 (no limit)
indent_class_colon = false # Whether to indent the stuff after a leading base class colon
#indent_class_on_colon = true # Indent based on a class colon instead of the stuff after the colon. Requires indent_class_colon=true. Default=false
indent_ctor_init_leading = 2 # Virtual indent from the ':' for member initializers. Default is 2
indent_ctor_init = 0 # Additional indenting for constructor initializer list
indent_var_def_blk = 0 # Amount to indent variable declarations after a open brace. neg=relative, pos=absolute
indent_var_def_cont = false # Indent continued variable declarations instead of aligning.
indent_func_def_force_col1 = false # True: force indentation of function definition to start in column 1 # False: use the default behavior
indent_func_call_param = false # True: indent continued function call parameters one indent level # False: align parameters under the open paren
indent_func_def_param = false # Same as indent_func_call_param, but for function defs
indent_func_proto_param = false # Same as indent_func_call_param, but for function protos
indent_func_class_param = false # Same as indent_func_call_param, but for class declarations
indent_func_ctor_var_param = false # Same as indent_func_call_param, but for class variable constructors
indent_template_param = false # Same as indent_func_call_param, but for templates
indent_func_param_double = false # Double the indent for indent_func_xxx_param options
indent_func_const = 0 # Indentation column for standalone 'const' function decl/proto qualifier
indent_func_throw = 0 # Indentation column for standalone 'throw' function decl/proto qualifier
indent_member = 0 # The number of spaces to indent a continued '->' or '.' # Usually set to 0, 1, or indent_columns.
indent_sing_line_comments = 0 # Spaces to indent single line ('//') comments on lines before code
indent_relative_single_line_comments = false # If set, will indent trailing single line ('//') comments relative # to the code instead of trying to keep the same absolute column
indent_switch_case = 4 # Spaces to indent 'case' from 'switch' # Usually 0 or indent_columns.
indent_case_shift = 0 # Spaces to shift the 'case' line, without affecting any other lines # Usually 0.
indent_case_brace = 0 # Spaces to indent '{' from 'case'. # By default, the brace will appear under the 'c' in case.# Usually set to 0 or indent_columns.
indent_col1_comment = false # Whether to indent comments found in first column
indent_label = 1 # How to indent goto labels # >0 : absolute column where 1 is the leftmost column# <=0 : subtract from brace indent
indent_access_spec = 1 # Same as indent_label, but for access specifiers that are followed by a colon
indent_paren_nl = false # If an open paren is followed by a newline, indent the next line so that it lines up after the open paren (not recommended)
indent_paren_close = 0 # Controls the indent of a close paren after a newline. # 0: Indent to body level# 1: Align under the open paren# 2: Indent to the brace level
indent_comma_paren = false # Controls the indent of a comma when inside a paren.If TRUE, aligns under the open paren
indent_bool_paren = false # Controls the indent of a BOOL operator when inside a paren.If TRUE, aligns under the open paren
indent_first_bool_expr = false # If 'indent_bool_paren' is true, controls the indent of the first expression. If TRUE, aligns the first expression to the following ones
indent_square_nl = false # If an open square is followed by a newline, indent the next line so that it lines up after the open square (not recommended)
indent_align_assign = true # Align continued statements at the '='. Default=True # If FALSE or the '=' is followed by a newline, the next line is indent one tab.
indent_cmt_with_tabs = false # Comments that are not a brace level are indented with tabs on a tabstop. Requires indent_with_tabs=2. If false, will use spaces.
indent_min_vbrace_open = 0 # When identing after virtual brace open and newline add further spaces to reach this min. indent.
indent_vbrace_open_on_tabstop = false # TRUE: When identing after virtual brace open and newline add further spaces after regular indent to reach next tabstop.
indent_shift = false # Indent continued shift expressions ('<<' and '>>') instead of aligning. Turn align_left_shift off when enabling this.
indent_preserve_sql = false # Don't change the relative indent of ESQL/C 'EXEC SQL' bodies
indent_oc_block = false # Indent OC blocks at brace level instead of usual rules.
indent_oc_block_msg = 0 # Indent OC blocks in a message relative to the parameter name. # 0=use indent_oc_block rules, 1+=spaces to indent
indent_oc_block_msg_xcode_style = false # If this && indent_oc_block_msg, blocks will be indented the way that Xcode does by default ( parameter is on its own line ? from keyword : from the prev. indentation lvl )
indent_oc_block_msg_from_keyword = false # If this && indent_oc_block_msg, blocks will be indented from where the brace is relative to a msg keyword.
indent_oc_block_msg_from_colon = false # If this && indent_oc_block_msg, blocks will be indented from where the brace is relative to a msg colon.
indent_oc_block_msg_from_caret = false # If this && indent_oc_block_msg, blocks will be indented from where the block caret is.
indent_oc_block_msg_from_brace = false # If this && indent_oc_block_msg, blocks will be indented from where the brace is.
indent_oc_msg_colon = 0 # Minimum indent for subsequent parameters
indent_oc_msg_prioritize_first_colon = true # If true, prioritize aligning with initial colon (and stripping spaces from lines, if necessary). # Default is true.
#endregion
################################################################################
################################################################################
#region Spacing options
################################################################################
sp_arith = force # space around '+', '-', '/', '*', etc
#region assign ---------------------------------------------------------------->
sp_assign_default = force # space around '=' in a prototype
sp_assign = force # space around '=', '+=', etc
#sp_before_assign = force # space before '=', '+=', etc. Overrides sp_assign.
#sp_after_assign = force # space after '=', '+=', etc. Overrides sp_assign.
sp_cpp_lambda_assign = remove # around '=' in C++11 lambda capture specifications. Overrides sp_assign
sp_enum_assign = force # space around '=' in enum
sp_enum_before_assign = force # space before '=' in enum. Overrides sp_enum_assign.
sp_enum_after_assign = force # space after '=' in enum. Overrides sp_enum_assign.
#endregion
#region preprocessor ---------------------------------------------------------->
sp_pp_concat = force # space around preprocessor '##' concatenation operator. Default=Add # #define COMMAND(NAME) { #NAME, NAME ## _command }
sp_pp_stringify = force # space after preprocessor '#' stringify operator | #define str(s) # s | affects '#@' charizing operator
sp_before_pp_stringify = force # space before preprocessor '#' stringify operator | #define x(y) L#y
sp_bool = force # around '&&' and '||'
sp_compare = force # around compare operator '<', '>', '==', etc
sp_after_type = force # space between type and word. Default=Force
#endregion
#region pointer --------------------------------------------------------------->
sp_before_ptr_star = remove # before pointer star '*'
#sp_before_unnamed_ptr_star = ignore # before pointer star '*' that isn't followed by a variable name # If ignore, uses sp_before_ptr_star
sp_before_ptr_star_func = remove # before a pointer star '*', if followed by a func proto/def.
#
sp_between_ptr_star = remove # between pointer stars '*'
#
sp_after_ptr_star = force # after pointer star '*', if followed by a word.
sp_after_ptr_star_qualifier = force # ... if followed by a qualifier.
sp_after_ptr_star_func = force # ... if followed by a func proto/def.
sp_ptr_star_paren = force # ... if followed by an open paren (function types).
#endregion
#region reference ------------------------------------------------------------->
sp_before_byref = remove # before reference '&'
#sp_before_unnamed_byref = remove # before reference '&' that isn't followed by a variable name # If 'ignore', uses sp_before_byref
sp_before_byref_func = remove # before a reference sign '&', if followed by a func proto/def.
sp_after_byref = force # after reference '&', if followed by a word.
sp_after_byref_func = force # after a reference '&', if followed by a func proto/def.
#endregion
#region less/greater ---------------------------------------------------------->
sp_before_angle = remove # before '<>'
#sp_template_angle = remove # in 'template <' vs 'template<'. # If ignore, uses sp_before_angle
sp_inside_angle = force # inside '<' and '>'
sp_after_angle = force # after '<>'
sp_angle_paren = remove # between '<>' and '(' as found in 'new List<byte>();'
sp_angle_word = force # between '<>' and a word as in 'List<byte> m;'
sp_angle_shift = force # between '>' and '>' in '>>' (template stuff C++/C# only). Default=Add
sp_permit_cpp11_shift = false # Permit space removal between '>>' in 'foo<bar<int> >' (C++11 only). | # sp_angle_shift cannot remove the space without this option. | Default=False
#endregion
sp_square_fparen = remove # between ']' and '(' when part of a function call.
sp_fparen_brace = remove # between ')' and '{' of function
#region parentheses ----------------------------------------------------------->
sp_before_sparen = remove # before '(' of 'if', 'for', 'switch', and 'while'
sp_inside_sparen = force # inside if-condition '(' and ')'
#sp_inside_sparen_close = force # Overrides sp_inside_sparen.
#sp_inside_sparen_open = force # Overrides sp_inside_sparen.
sp_after_sparen = force # after ')' of 'if', 'for', 'switch', and 'while'
sp_sparen_brace = force # between ')' and '{' of 'if', 'for', 'switch', and 'while'
sp_balance_nested_parens = true
#sp_inside_paren = ignore # inside '(' and ')'
#sp_paren_paren = ignore # between nested parens: '((' vs ') )'
sp_paren_brace = force # between ')' and '{' (exmpl: onliner)
sp_sizeof_paren = remove # between 'sizeof' and '('
sp_func_proto_paren = remove # between function name and '(' on function declaration
sp_func_def_paren = remove # between function name and '(' on function definition
sp_inside_fparens = remove # inside empty function '()'
sp_inside_fparen = force # inside function '(' and ')'
sp_inside_tparen = remove # inside 1st parens in function type: 'void (*x)(...)'
sp_after_tparen_close = remove # between 1st parens in function type: 'void (*x)(...)'
sp_func_call_paren = remove # between function name and '(' on function calls
#sp_func_call_paren_empty = ignore # between function name and '()' on function calls without parameters | if 'ignore', uses sp_func_call_paren
sp_func_call_user_paren = remove # between the user function name and '(' on function calls | You need to set a keyword to be a user function, like this: 'set func_call_user _' in the config file.
sp_func_class_paren = remove # between a constructor/destructor and '('
sp_return_paren = force # between 'return' and '('
sp_attribute_paren = force # between '__attribute__' and '('
sp_defined_paren = remove # between 'defined' and '(' in '#if defined (FOO)'
sp_throw_paren = remove # between 'throw' and '(' in 'throw (something)'
sp_after_throw = force # between 'throw' and anything other than '(' as in '@throw [...];'
sp_catch_paren = ignore # between 'catch' and '(' in 'catch (something) { }' | If set to ignore, sp_before_sparen is used.
sp_cparen_oparen = remove # Add or remove space between back-to-back parens: ')(' vs ') ('
sp_between_new_paren = remove # between new and '(' in 'new()'
#endregion
#region braces ---------------------------------------------------------------->
sp_inside_braces_enum = force # inside enum '{' and '}' | one liner
sp_inside_braces_struct = force
sp_inside_braces = force
sp_inside_braces_empty = remove # inside '{}'
sp_else_brace = force # between 'else' and '{' if on the same line
sp_brace_else = force # between '}' and 'else' if on the same line
sp_brace_typedef = force # between '}' and the name of a typedef on the same line
sp_catch_brace = force # between 'catch' and '{' if on the same line
sp_brace_catch = force # between '}' and 'catch' if on the same line
sp_finally_brace = force # between 'finally' and '{' if on the same line
sp_brace_finally = force # between '}' and 'finally' if on the same line
sp_try_brace = force # between 'try' and '{' if on the same line
sp_getset_brace = force # between get/set and '{' if on the same line
sp_word_brace = force # between a variable and '{' for C++ uniform initialization
sp_word_brace_ns = force # between a variable and '{' for a namespace
#endregion
#region bracket --------------------------------------------------------------->
sp_before_square = remove # before '[' (except '[]')
sp_before_squares = remove # before '[]'
sp_inside_square = remove # inside a non-empty '[' and ']'
#endregion
#region comma ----------------------------------------------------------------->
sp_after_comma = force
sp_before_comma = remove
sp_paren_comma = force # '(,' vs '( ,'
#endregion
#region colon ----------------------------------------------------------------->
sp_after_class_colon = force # after class ':'
sp_before_class_colon = force # before class ':'
sp_after_constr_colon = force # after class constructor ':'
sp_before_constr_colon = force # before class constructor ':'
sp_before_case_colon = remove # before case ':'. Default=Remove
sp_cond_colon = force # around the ':' in 'b ? t : f'
#sp_cond_colon_before = force # before the ':' in 'b ? t : f'. Overrides sp_cond_colon.
#sp_cond_colon_after = force # after the ':' in 'b ? t : f'. Overrides sp_cond_colon.
sp_cond_question = force # around the '?' in 'b ? t : f'
#sp_cond_question_before = force # before the '?' in 'b ? t : f'. Overrides sp_cond_question.
#sp_cond_question_after = force # after the '?' in 'b ? t : f'. Overrides sp_cond_question.
sp_cond_ternary_short = force # between '?' and ':', in abbreviated ternary | (a ?: b) | overrides all sp_cond_*
#endregion
#region semicolon ------------------------------------------------------------->
sp_before_semi = remove # before ';'. Default=Remove
sp_after_semi = force # after ';', except when followed by a comment. Default=Add
sp_special_semi = remove # before empty statement ';' on 'if', 'for' and 'while'
sp_before_semi_for = remove # before ';' in non-empty 'for' statements
sp_before_semi_for_empty = remove # before ';' of an empty part of a for statement.
sp_after_semi_for = force # after ';' in non-empty 'for' statements. Default=Force
sp_after_semi_for_empty = remove # after final semicolon of an empty part of a for statement: for ( ; ; <here> ).
#endregion
#region cast ------------------------------------------------------------------>
sp_after_cast = force # after cast, 'cast(int)a' vs 'cast(int) a' or '(int)a' vs '(int) a'
sp_inside_paren_cast = remove # spaces inside cast parens
sp_cpp_cast_paren = remove # between the type and open paren in a C++ cast, i.e. 'int(exp)' vs 'int (exp)'
#endregion
sp_before_ellipsis = remove # before variadic '...' when preceded by a non-punctuator
sp_after_tag = force # after the tag keyword (Pawn)
sp_type_func = force # between return type and function name # A minimum of 1 is forced except for pointer return types.
sp_macro = force # between macro and value
sp_macro_func = force # between macro function ')' and value
sp_before_dc = remove # before the '::' operator
sp_after_dc = remove # after the '::' operator
sp_not = remove # after '!' (not) operator. Default=Remove
sp_inv = remove # after '~' (invert) operator. Default=Remove
sp_addr = remove # after '&' (address-of) operator. Default=Remove | This does not affect the spacing after a '&' that is part of a type.
sp_deref = remove # after '*' (dereference) operator | This does not affect the spacing after a '*' that is part of a type.| Default=Remove
sp_sign = remove # after '+' or '-', as in 'x = -5' or 'y = +7' | Default=Remove
sp_member = remove # around the '.' or '->' operators | Default=Remove
sp_incdec = remove # around '++' and '--', followed/preceded by a variable | '(--x)' or 'y++;' | Default=Remove
sp_after_operator_sym = ignore # space between the operator symbol and the open paren, as in 'operator ++('
sp_case_label = force # Fix the spacing between 'case' and the label. Only 'ignore' and 'force' make sense here.
sp_after_new = force # after 'new', 'delete', and 'delete[]'
#region unverified function --------------------------------------------------->
sp_before_nl_cont = force # before a backslash-newline at the end of a line. Default=Add
sp_cpp_lambda_paren = ignore # Add or remove space after the capture specification in C++11 lambda.
sp_enum_paren = ignore # Add or remove space in 'NS_ENUM ('
sp_after_operator = ignore # space between 'operator' and operator sign
#endregion
#region comment function ------------------------------------------------------>
sp_cmt_cpp_start = force # after the opening of a C++ comment '// !' vs '//!'
sp_cmt_cpp_doxygen = true # TRUE: If space is added with sp_cmt_cpp_start, do it after doxygen sequences like '///', '///<', '//!' and '//!<'.
sp_cmt_cpp_qttr = true # TRUE: If space is added with sp_cmt_cpp_start, do it after Qt translator or meta-data comments like '//:', '//=', and '//~'.
sp_endif_cmt = ignore # between #else or #endif and a trailing comment (TODO)
sp_before_tr_emb_cmt = ignore # before a trailing or embedded comment (TODO)
sp_num_before_tr_emb_cmt = 0 # Number of spaces before a trailing or embedded comment (TODO)
#endregion
#region -------------- Java --------------------------------------------------->
sp_fparen_dbrace = force # (Java) between ')' and '{{' of double brace initializer.
sp_after_for_colon = force # (Java) after ':' in 'for (TYPE VAR : EXPR)'
sp_before_for_colon = force # (Java) before ':' in 'for (TYPE VAR : EXPR)'
sp_annotation_paren = force # (Java) annotation and the open paren.
#endregion
#region -------------- D ------------------------------------------------------>
#sp_version_paren = remove # (D) between 'version' and '(' in 'version (something) { }' | If ignore, uses sp_before_sparen is used.
#sp_scope_paren = remove # (D) between 'scope' and '(' in 'scope (something) { }' | If ignore, uses sp_before_sparen
#sp_before_template_paren = remove # (D) before the paren in the D constructs 'template Foo(' and 'class Foo('.
#sp_d_array_colon = force # (D) around the D named array initializer ':' operator
#sp_invariant_paren = ignore # (D) 'invariant' and '('
#sp_after_invariant_paren = ignore # (D) after ')' in 'invariant (C) c'.
#sp_extern_paren = ignore # (D) in 'extern (C)'
#sp_range = ignore # (D) around the '..' operator.
#endregion
#region -------------- Objective C -------------------------------------------->
#sp_after_oc_scope = force # (objC) after the scope '+' or '-', as in '-(void) foo;' or '+(int) bar;'
#sp_after_oc_colon = ignore # (objC) space after the colon in message specs # '-(int) f:(int) x;' vs '-(int) f: (int) x;'
#sp_before_oc_colon = ignore # (objC) space before the colon in message specs # '-(int) f: (int) x;' vs '-(int) f : (int) x;'
#sp_after_oc_dict_colon = ignore # (objC) space after the colon in immutable dictionary expression # 'NSDictionary *test = @{@"foo" :@"bar"};'
#sp_before_oc_dict_colon = ignore # (objC) space before the colon in immutable dictionary expression # 'NSDictionary *test = @{@"foo" :@"bar"};'
#sp_after_send_oc_colon = ignore # (objC) space after the colon in message specs # '[object setValue:1];' vs '[object setValue: 1];'
#sp_before_send_oc_colon = ignore # (objC) space before the colon in message specs # '[object setValue:1];' vs '[object setValue :1];'
#sp_after_oc_type = ignore # (objC) space after the (type) in message specs # '-(int)f: (int) x;' vs '-(int)f: (int)x;'
#sp_after_oc_return_type = ignore # (objC) space after the first (type) in message specs # '-(int) f:(int)x;' vs '-(int)f:(int)x;'
#sp_after_oc_at_sel = ignore # (objC) space between '@selector' and '(' # '@selector(msgName)' vs '@selector (msgName)'# Also applies to @protocol() constructs
#sp_after_oc_at_sel_parens = ignore # (objC) space between '@selector(x)' and the following word # '@selector(foo) a:' vs '@selector(foo)a:'
#sp_inside_oc_at_sel_parens = ignore # (objC) space inside '@selector' parens # '@selector(foo)' vs '@selector( foo )'# Also applies to @protocol() constructs
#sp_before_oc_block_caret = ignore # (objC) space before a block pointer caret # '^int (int arg){...}' vs. ' ^int (int arg){...}'
#sp_after_oc_block_caret = ignore # (objC) space after a block pointer caret # '^int (int arg){...}' vs. '^ int (int arg){...}'
#sp_after_oc_msg_receiver = ignore # (objC) space between the receiver and selector in a message. # '[receiver selector ...]'
#sp_after_oc_property = ignore # (objC) space after @property.
#endregion
#region ---------------- C# --------------------------------------------------->
sp_after_mdatype_commas = remove # (c#) Add or remove space between ',' and ']' in multidimensional array type 'int[,,]'
sp_before_mdatype_commas = remove # (c#) Add or remove space between '[' and ',' in multidimensional array type 'int[,,]'
sp_between_mdatype_commas = remove # (c#) Add or remove space between ',' in multidimensional array type 'int[,,]'
#endregion
#endregion
################################################################################
################################################################################
##region Code alignment (not left column spaces/tabs) (TODO)
################################################################################
align_keep_tabs = false # keep non-indenting tabs
align_with_tabs = false # use tabs for aligning
align_on_tabstop = false # bump out to the next tab when aligning
align_number_left = false # left-align numbers
align_keep_extra_space = true # keep whitespace not required for alignment.
align_mix_var_proto = true # Whether to mix aligning prototype and variable declarations. # If true, align_var_def_XXX options are used instead of align_func_proto_XXX options.
align_func_params = false # Align variable definitions in prototypes and functions
align_func_proto_span = 1 # The span for aligning function prototypes (0=don't align)
align_func_proto_gap = 0 # Minimum gap between the return type and the function name.
align_var_def_span = 1 # The span for aligning variable definitions (0=don't align)
align_var_def_thresh = 8 # The threshold for aligning variable definitions (0=no limit)
align_var_def_gap = 0 # The gap for aligning variable definitions
align_var_def_star_style = 0 # How to align the star in variable definitions. # 0=Part of the type 'void * foo;' 1=Part of the variable 'void *foo;' 2=Dangling 'void *foo;'
align_var_def_amp_style = 0 # How to align the '&' in variable definitions. # 0=Part of the type# 1=Part of the variable# 2=Dangling
align_var_def_colon = true # Whether to align the colon in struct bit fields
align_var_def_attribute = true # Whether to align any attribute after the variable name
align_var_def_inline = true # Whether to align inline struct/enum/union variable definitions
align_single_line_func = true # Align single-line functions with function prototypes, uses align_func_proto_span
align_single_line_brace = true # Aligning the open brace of single-line functions. # Requires align_single_line_func=true, uses align_func_proto_span
align_single_line_brace_gap = 1 # Gap for align_single_line_brace.
align_same_func_call_params = false # Align parameters in single-line functions that have the same name. # The function names must already be aligned with each other.
align_assign_span = 1 # The span for aligning on '=' in assignments (0=don't align)
align_assign_thresh = 10 # The threshold for aligning on '=' in assignments (0=no limit)
align_enum_equ_span = 1 # The span for aligning on '=' in enums (0=don't align)
align_enum_equ_thresh = 2 # The threshold for aligning on '=' in enums (0=no limit)
align_var_struct_span = 1 # The span for aligning struct/union (0=don't align)
#align_var_struct_thresh = 2 # The threshold for aligning struct/union member definitions (0=no limit)
#align_var_struct_gap = 0 # The gap for aligning struct/union member definitions
align_struct_init_span = 1 # The span for aligning struct initializer values (0=don't align)
align_typedef_gap = 0 # The minimum space between the type and the synonym of a typedef
align_typedef_span = 1 # The span for aligning single-line typedefs (0=don't align)
# How to align typedef'd functions with other typedefs # 0: Don't mix them at all# 1: align the open paren with the types# 2: align the function type name with the other type names
align_typedef_func = 1
# Controls the positioning of the '*' in typedefs. # 0: Align on typedef type, ignore '*'# 1: The '*' is part of type name: typedef int *pint;# 2: The '*' is part of the type, but dangling: typedef int *pint;
align_typedef_star_style = 0
# Controls the positioning of the '&' in typedefs. # 0: Align on typedef type, ignore '&'# 1: The '&' is part of type name: typedef int &pint;# 2: The '&' is part of the type, but dangling: typedef int &pint;
align_typedef_amp_style = 0
align_right_cmt_span = 0 # The span for aligning comments that end lines (0=don't align)
align_right_cmt_mix = false # If aligning comments, mix with comments after '}' and #endif with less than 3 spaces before the comment
align_right_cmt_gap = 0 # If a trailing comment is more than this number of columns away from the text it follows, # it will qualify for being aligned. This has to be > 0 to do anything.
align_right_cmt_at_col = 0 # Align trailing comment at or beyond column N; 'pulls in' comments as a bonus side effect (0=ignore)
align_on_operator = true # Align function protos on the 'operator' keyword instead of what follows
align_nl_cont = false # Whether to align macros wrapped with a backslash and a newline. # This will not work right if the macro contains a multi-line comment.
align_pp_define_together = false # # Align macro functions and variables together
align_pp_define_gap = 0 # The minimum space between label and value of a preprocessor define
align_pp_define_span = 0 # The span for aligning on '#define' bodies (0=don't align, other=number of lines including comments between blocks)
align_left_shift = true # Align lines that start with '<<' with previous '<<'. Default=true
align_oc_msg_colon_span = 0 # Span for aligning parameters in an Obj-C message call on the ':' (0=don't align)
align_oc_msg_colon_first = false # If true, always align with the first parameter, even if it is too short.
align_oc_decl_colon = false # Aligning parameters in an Obj-C '+' or '-' declaration on the ':'
align_oc_msg_spec_span = 0 # The span for aligning ObjC msg spec (0=don't align)
#endregion
################################################################################
################################################################################
#region Newline adding and removing | Blank Line Options
################################################################################
nl_max = 3 # The maximum consecutive newlines
nl_collapse_empty_body = true # Whether to collapse empty blocks between '{' and '}'
nl_end_of_file = force
nl_end_of_file_min = 1 # newlines end of file (if nl_end_of_file !remove )
nl_start_of_file = remove
#nl_start_of_file_min = 0 # newlines start of file (if nl_start_of_file !remove )
nl_define_macro = true # Whether to alter newlines in '#define' macros
nl_multi_line_define = true # in a define after the macro name for multi-line defines.
nl_squeeze_ifdef = true # after '#ifxx', '#elxx', or before '#endif'
#nl_var_def_blk_start = 0 # lines before block of variable definitions not at the top of a function body
nl_func_var_def_blk = 1 # block of: variable definitions at the top of a function body
#nl_var_def_blk_end = 1 # block of: variable definitions not at the top of a function body
nl_after_semicolon = true # except in 'for' statements
#region -------------- access_spec -------------------------------------------->
nl_before_access_spec = 2 # nr before a 'private:', 'public:' .... Will not change the newline count if after a brace open. # 0 = No change.
nl_after_access_spec = 1 # private:', 'public:', 'protected:', 'signals:', or 'slots:'
#endregion
#region -------------- brace -------------------------------------------------->
nl_after_brace_open = true # after 'X' | This also adds a newline before the matching brace close.
nl_brace_square = force # between '}' and '['
nl_brace_fparen = ignore # between '}' and '(' or ')'
nl_brace_brace = force # between two open or close braces. # REMOVE may not work.
#nl_after_brace_close = false # after 'X' | Does not apply if followed by a necessary ';'
#nl_after_vbrace_open = false # after 'X' | virtual brace (un-braced if/while/do/for statement bodies.) with a non-empty body
#nl_after_vbrace_open_empty = false # after 'X' | virtual brace open with an empty body.
#nl_after_vbrace_close = false # after 'X' | exmpl: add newline before return in: 'if (foo) a++; return;'
eat_blanks_after_open_brace = true # Whether to remove blank lines after '{'
eat_blanks_before_close_brace = true # Whether to remove blank lines before '}'
#endregion
nl_template_class = force # 'template<>' and whatever follows.
nl_after_class = 2
nl_class_brace = force # between 'X' and '{'
nl_class_colon = remove # Add or remove a newline around a class colon | Related to pos_class_colon, nl_class_init_args, and pos_class_comma.
nl_class_init_args = remove # after each ',' in the class base list
nl_constr_init_args = remove # after each ',' in the constructor member initialization
nl_constr_colon = force # Add or remove a newline around a class constructor colon | Related to pos_constr_colon, nl_constr_init_args, and pos_constr_comma.
nl_return_expr = remove # between return keyword and return expression.
nl_after_return = false
#region -------------- functions ---------------------------------------------->
nl_fdef_brace = force # between function signature and '{'
nl_fcall_brace = force # between a function call's ')' and '{', as in: # list_for_each(item, &list) { }
#nl_after_func_proto = 1 # newlines after function prototype, if followed by another function prototype
#nl_after_func_proto_group = 1 # newlines after function prototype, if not followed by another function prototype
#nl_after_func_body = 2 # '}' of a multi-line function body
#nl_after_func_body_class = 2 # '}' of a multi-line function body in a class declaration
#nl_after_func_body_one_liner = 2 # '}' of a single line function body
nl_cpp_ldef_brace = remove # between C++11 lambda signature and '{'
nl_func_type_name = remove # return type and function name in a function definition
nl_func_type_name_class = remove # return type and function name inside a class {} # Uses nl_func_type_name or nl_func_proto_type_name if ignore
nl_func_scope_name = remove # in a definition. Controls the newline after '::' in 'void A::f() { }'
nl_func_proto_type_name = remove # return type and function name in a prototype
nl_func_paren = remove # function name and the opening '('
nl_func_def_paren = remove # function name and the opening '(' in the definition
nl_func_decl_empty = remove # '(' ')' in a function declaration.
nl_func_def_empty = remove # '(' ')' in a function definition.
nl_func_decl_start = remove # after '(' in a function declaration
#nl_func_decl_start_single = remove # Overrides nl_func_decl_start when there is only one parameter.
nl_func_def_start = remove # after '(' in a function definition
nl_func_def_start_single = remove # Overrides nl_func_def_start when there is only one parameter.
nl_func_decl_args = remove # after each ',' in a function declaration
nl_func_def_args = remove # after each ',' in a function definition
nl_func_decl_end = remove # before the ')' in a function declaration
#nl_func_decl_end_single = remove # Overrides nl_func_decl_end when there is only one parameter.
nl_func_def_end = remove # before the ')' in a function definition
nl_func_def_end_single = remove # Overrides nl_func_def_end when there is only one parameter.
#endregion
#region -------------- one_liners leave --------------------------------------->
nl_class_leave_one_liners = true
nl_enum_leave_one_liners = true
nl_func_leave_one_liners = true
nl_if_leave_one_liners = true
nl_cpp_lambda_leave_one_liners = true
nl_assign_leave_one_liners = true
nl_getset_leave_one_liners = true
nl_oc_msg_leave_one_liner = true
nl_while_leave_one_liners = true
#endregion
#region -------------- one_liners create -------------------------------------->
nl_create_if_one_liner = true # 'if(b)\n i++;' => 'if(b) i++;'
nl_create_for_one_liner = true # 'for (i=0;i<5;i++)\n foo(i);' => 'for (i=0;i<5;i++) foo(i);'
nl_create_while_one_liner = true # 'while (i<5)\n foo(i++);' => 'while (i<5) foo(i++);'
#endregion
#region -------------- typedef ------------------------------------------------>
#nl_typedef_blk_start = 0 # lines before block of typedefs
#nl_typedef_blk_end = 1 # newlines after 'X'
#endregion
nl_ds_struct_enum_cmt = false # Whether to double-space commented-entries in struct/enum
nl_ds_struct_enum_close_brace = false # Whether to double-space before the close brace of a struct/union/enum | (lower priority than 'eat_blanks_before_close_brace')
#region -------------- enum --------------------------------------------------->
nl_enum_brace = force
#endregion
#region -------------- struct ------------------------------------------------->
nl_brace_struct_var = remove # between } and 'b' in: 'struct { int a; } b;'# Affects enums, unions, and structures. If set to ignore, uses nl_after_brace_close
nl_struct_brace = force
#nl_after_struct = 2
#endregion
#region -------------- else/if ------------------------------------------------>
nl_if_brace = force
nl_elseif_brace = force # else if(){ vs else if()\n{ | If set to ignore, nl_if_brace is used instead
nl_brace_else = force
nl_else_brace = force
nl_else_if = remove # else if() vs else\nif()
nl_before_if = ignore
nl_after_if = ignore
nl_else_if = remove
#endregion
#region -------------- switch/case -------------------------------------------->
nl_switch_brace = force
nl_after_switch = force
nl_before_case = true
nl_before_switch = force
nl_case_colon_brace = force
nl_after_case = true
#endregion
#region -------------- throw/try/catch/finaly --------------------------------->
nl_try_brace = force # try{ vs try\n{
nl_brace_finally = force
nl_finally_brace = force
nl_after_try_catch_finally = 2 # after block that isn't followed by a brace close.
nl_brace_catch = force #} catch vs }\ncatch
nl_catch_brace = force
nl_before_throw = add # between ')' and 'throw'
#endregion
#region -------------- for ---------------------------------------------------->
nl_for_brace = force # for(...){ vs for(...)\n{
nl_after_for = force # no effect on nested for
nl_before_for = ignore # no effect on nested for
#endregion
#region -------------- do/while ----------------------------------------------->
nl_do_brace = force
nl_while_brace = force
nl_brace_while = force # between '}' and 'while' of 'do' statement
nl_after_while = force
#nl_after_do = force
nl_before_while = ignore
nl_before_do = force
#endregion
# ')' and '{' | if ')' 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.
#nl_multi_line_cond = false
#region -------------- comments ----------------------------------------------->
nl_before_block_comment = 0 # min nr before a multi-line comment. Doesn't apply if after a brace open or another multi-line comment.
nl_before_c_comment = 0 # min nr before a single-line C comment. Doesn't apply if after a brace open or other single-line C comments.
nl_before_cpp_comment = 0 # min nr before a CPP comment. Doesn't apply if after a brace open or other CPP comments.
#nl_after_brace_open_cmt = false # after 'X' | If this & nl_after_brace_open true, newline is placed between the open brace and a trailing single-line comment.
nl_after_multiline_comment = false # after 'X'
#endregion
#region -------------- ohter -------------------------------------------------->
nl_assign_brace = remove # between 'X' and '{'
nl_using_brace = force # between 'X' and '{'
nl_namespace_brace = force # between 'X' and '{'
nl_union_brace = force # between 'X' and '{'
nl_before_return = false # unless after an open brace.
#endregion
#region -------------- D ------------------------------------------------------>
#nl_after_square_assign = ignore # Add or remove newline after '= [' (D only). Will also affect the newline before the ']'
#nl_assign_square = ignore # Add or remove newline between '=' and '[' (D only)
#nl_scope_brace = ignore # Add or remove newline between 'scope (x)' and '{' (D)
#nl_unittest_brace = ignore # Add or remove newline between 'unittest' and '{' (D)
#nl_version_brace = ignore # Add or remove newline between 'version (x)' and '{' (D)
#endregion
#region -------------- Java --------------------------------------------------->
nl_after_annotation = force # (Java annotation) after 'X' | Only affects annotations that are after a newline.
nl_paren_dbrace_open = ignore # (Java) | between X & Y | ')' and '{{' of the double brace initializer.
#endregion
#region -------------- objC --------------------------------------------------->
#nl_oc_msg_args = false # (objC) Whether to put each OC message parameter on a separate line | See nl_oc_msg_leave_one_liner
#endregion
#region -------------- C# ----------------------------------------------------->
#nl_between_get_set = 0 # The number of newlines between the get/set/add/remove handlers in C#. # 0 = No change.
#nl_property_brace = ignore # Add or remove newline between C# property and the '{'
#endregion
# TODO =====================================================================
nl_comment_func_def = 0 # The number of newlines between a function def and the function comment. # 0 = No change.
nl_around_cs_property = 0 # The number of newlines before and after a property, indexer or event decl. # 0 = No change.
# How aggressively to remove extra newlines not in preproc. # 0: No change# 1: Remove most newlines not handled by other config# 2: Remove all newlines and reformat completely by config
nl_remove_extra_newlines = 0
nl_between_annotation = force # Controls the newline between two annotations.
#nl_after_label_colon = false # Whether to force a newline after a label's colon.
#nl_after_synchronized = ignore # Add or remove blank line after 'synchronized' statement
#nl_before_synchronized = ignore # Add or remove blank line before 'synchronized'
#nl_synchronized_brace = ignore # Add or remove newline between 'synchronized' and '{'
#nl_getset_brace = ignore # Add or remove newline between get/set and '{'
#nl_typedef_blk_in = 0 # The maximum consecutive newlines within a block of typedefs, 0 = No change (default)
#nl_var_def_blk_in = 0 # The maximum consecutive newlines within a block of variable definitions, 0 = No change (default)
#endregion
################################################################################
################################################################################
#region Positioning options
################################################################################
# ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force
#pos_arith = ignore # The position of arithmetic operators in wrapped expressions
#pos_assign = ignore # The position of assignment in wrapped expressions. # Do not affect '=' followed by '{'
#pos_bool = ignore # The position of boolean operators in wrapped expressions
#pos_compare = ignore # The position of comparison operators in wrapped expressions
#pos_conditional = ignore # The position of conditional (b ? t : f) operators in wrapped expressions
#pos_comma = ignore # The position of the comma in wrapped expressions
#pos_class_comma = ignore # The position of the comma in the class base list
#pos_constr_comma = ignore # The position of the comma in the constructor initialization list
#pos_class_colon = ignore # The position of colons between class and base class list
#pos_constr_colon = ignore # The position of colons between constructor and member initialization
#endregion
################################################################################
################################################################################
#region Line Splitting options
################################################################################
#code_width = 0 # Try to limit code width to N number of columns
#ls_for_split_full = false # Whether to fully split long 'for' statements at semi-colons
#ls_func_split_full = false # Whether to fully split long function protos/calls at commas
#ls_code_width = false # Whether to split lines as close to code_width as possible and ignore some groupings
#endregion
################################################################################
################################################################################
#region Code modifying options (non-whitespace)
################################################################################
mod_full_brace_do = force # on single-line 'do' statement
mod_full_brace_for = force # on single-line 'for' statement
mod_full_brace_function = force # on single-line function definitions. (Pawn)
mod_full_brace_if = force # on single-line 'if' statement. Will not remove the braces if they contain an 'else'
# affects all if/elseif/else statements in a chain. Overrides mod_full_brace_if. # If any must be braced, they are all braced. If all can be unbraced, then the braces are removed.
mod_full_brace_if_chain = false
mod_full_brace_while = force # on single-line 'while' statement
mod_full_brace_using = force # on single-line 'using ()' statement
mod_paren_on_return = remove # Add or remove unnecessary paren on 'return' statement
#mod_full_brace_nl = 0 # Don't remove braces around statements that span N newlines
mod_pawn_semicolon = true # Whether to change optional semicolons to real semicolons
mod_full_paren_if_bool = true # Add parens on 'while' and 'if' statement around bools
mod_remove_extra_semicolon = true # Whether to remove superfluous semicolons
mod_add_long_function_closebrace_comment = 0 # 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.
mod_add_long_namespace_closebrace_comment = 0 # 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.
mod_add_long_switch_closebrace_comment = 0 # 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.
mod_add_long_ifdef_endif_comment = 0 # If an #ifdef body exceeds the specified number of newlines and doesn't have a comment after # the #endif, a comment will be added.
mod_add_long_ifdef_else_comment = 0 # 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.
mod_sort_import = true # If TRUE, will sort consecutive single-line 'import' statements [Java, D]
mod_sort_using = true # If TRUE, will sort consecutive single-line 'using' statements [C#]
mod_sort_include = false # If TRUE, will sort consecutive single-line '#include' statements [C/C++] and '#import' statements [Obj-C] # may break your code !!
mod_move_case_break = true # If TRUE, it will move a 'break' that appears after a fully braced 'case' before the close brace.
mod_case_brace = force # Will add or remove the braces around a fully braced case statement. # Will only remove the braces if there are no variable declarations in the block.
mod_remove_empty_return = true # If TRUE, it will remove a void 'return;' that appears as the last statement in a function.
#endregion
################################################################################
################################################################################
#regionc Comment modifications (TODO)
################################################################################
#cmt_width = 0 # Try to wrap comments at cmt_width columns
cmt_reflow_mode = 0 # Set the comment reflow mode (default: 0) # 0: no reflowing (apart from the line wrapping due to cmt_width)# 1: no touching at all# 2: full reflow
cmt_convert_tab_to_spaces = true # Whether to convert all tabs to spaces in comments. Default is to leave tabs inside comments alone, unless used for indenting.
cmt_indent_multi = true # If false, disable all multi-line comment changes, including cmt_width. keyword substitution, and leading chars. # Default is true.
cmt_c_group = false # Whether to group c-comments that look like they are in a block
cmt_c_nl_start = false # Whether to put an empty '/*' on the first line of the combined c-comment
cmt_c_nl_end = true # Whether to put a newline before the closing '*/' of the combined c-comment
cmt_cpp_group = false # Whether to group cpp-comments that look like they are in a block
cmt_cpp_nl_start = false # Whether to put an empty '/*' on the first line of the combined cpp-comment
cmt_cpp_nl_end = false # Whether to put a newline before the closing '*/' of the combined cpp-comment
cmt_cpp_to_c = false # Whether to change cpp-comments into c-comments
cmt_star_cont = false # Whether to put a star on subsequent comment lines
cmt_sp_before_star_cont = 1 # The number of spaces to insert at the start of subsequent comment lines
cmt_sp_after_star_cont = 1 # The number of spaces to insert after the star on subsequent comment lines
cmt_multi_check_last = true # 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
# The filename that contains text to insert at the head of a file if the file doesn't start with a C/C++ comment. # Will substitute $(filename) with the current file's name.
cmt_insert_file_header = ""
# The filename that contains text to insert at the end of a file if the file doesn't end with a C/C++ comment. # Will substitute $(filename) with the current file's name.
cmt_insert_file_footer = ""
# The filename that contains text to insert before a function implementation if the function isn't preceded with a C/C++ comment.
# Will substitute $(function) with the function name and $(javaparam) with the javadoc @param and @return stuff.# Will also substitute $(fclass) with the class name: void CFoo::Bar() { ... }
cmt_insert_func_header = ""
# The filename that contains text to insert before a class if the class isn't preceded with a C/C++ comment. # Will substitute $(class) with the class name.
cmt_insert_class_header = ""
# The filename that contains text to insert before a Obj-C message specification if the method isn't preceded with a C/C++ comment.
# Will substitute $(message) with the function name and $(javaparam) with the javadoc @param and @return stuff.
cmt_insert_oc_msg_header = ""
# If a preprocessor is encountered when stepping backwards from a function name, then # this option decides whether the comment should be inserted.
# Affects cmt_insert_oc_msg_header, cmt_insert_func_header and cmt_insert_class_header.
cmt_insert_before_preproc = false
#endregion
################################################################################
################################################################################
#region Preprocessor options (TODO)
################################################################################
pp_indent = ignore # Control indent of preprocessors inside #if blocks at brace level 0 (file-level)
pp_indent_at_level = false # Whether to indent #if/#else/#endif at the brace level (true) or from column 1 (false)
# Specifies the number of columns to indent preprocessors per level at brace level 0 (file-level). # If pp_indent_at_level=false, specifies the number of columns to indent preprocessors per level at brace level > 0 (function-level).
pp_indent_count = 1
# If pp_indent_at_level=true, sets the indent for #if, #else, and #endif when not at file-level. # 0: indent preprocessors using output_tab_size.# >0: column at which all preprocessors will be indented.
pp_indent_if = 0
pp_space = ignore # Add or remove space after # based on pp_level of #if blocks
pp_space_count = 0 # Sets the number of spaces added with pp_space
pp_indent_region = 0 # The indent for \region and \endregion in C# and '#pragma region' in C/C++
pp_region_indent_code = false # Whether to indent the code between \region and \endregion
pp_if_indent_code = false # Control whether to indent the code between #if, #else and #endif.
pp_define_at_level = false # Whether to indent '#define' at the brace level (true) or from column 1 (false)
#endregion
################################################################################
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment