My Objective-C Uncrustify configuration file

uncrustify-objc.cfg

#
# Uncrustify Configuration File
# File Created With UncrustifyX 0.4.3 (252)
#

# Alignment
# ---------

## Alignment

# Align ObjC declaration params on colon
align_oc_decl_colon                     = true          # boolean (false/true)

# Align on tabstop
align_on_tabstop                        = false         # boolean (false/true)

# Align variable definitions
align_func_params                       = false         # boolean (false/true)

# Align with tabs
align_with_tabs                         = false         # boolean (false/true)

# Keep non-indenting tabs
align_keep_tabs                         = false         # boolean (false/true)

## Alignment Span

# Alignment span for #define bodies
align_pp_define_span                    = 0             # number

# Alignment span for ObjC message colons
align_oc_msg_colon_span                 = 0             # number

# Alignment span for ObjC message spec
align_oc_msg_spec_span                  = 0             # number

# Alignment span for assignment
align_assign_span                       = 0             # number

# Alignment span for equals in enums
align_enum_equ_span                     = 0             # number

# Alignment span for function prototypes
align_func_proto_span                   = 0             # number

# Alignment span for single-line typedefs
align_typedef_span                      = 0             # number

# Alignment span for struct initializer values
align_struct_init_span                  = 0             # number

# Alignment span for struct/union
align_var_struct_span                   = 0             # number

# Alignment span for trailing comments
align_right_cmt_span                    = 0             # number

# Alignment span for variable definitions
align_var_def_span                      = 0             # number

## Alignment Style

# Alignment style for star in variable definitions
align_var_def_star_style                = 1             # number

## Gap

# Minimum gap between type and synonym of typedef
align_typedef_gap                       = 3             # number

# Minimum gap for trailing comment
align_right_cmt_gap                     = 8             # number

## Other

# Align macros wrapped with backslash and newline
align_nl_cont                           = true          # boolean (false/true)

# Always align with first parameter in ObjC message
align_oc_msg_colon_first                = false         # boolean (false/true)

# Blank Lines
# -----------

## Newline Count After

# Newline count after function body
nl_after_func_body                      = 2             # number

# Newline count after single-line function body
nl_after_func_body_one_liner            = 2             # number

# Newline count after variable definition block
nl_func_var_def_blk                     = 0             # number

## Other

# Maximum consecutive newlines
nl_max                                  = 2             # number

# Remove blank lines after open brace
eat_blanks_after_open_brace             = true          # boolean (false/true)

# Remove blank lines before close brace
eat_blanks_before_close_brace           = true          # boolean (false/true)

# Code-Modifying
# --------------

## Braces

# Braces around statments that span N newlines
mod_full_brace_nl                       = 3             # number

# Braces on single-line do statement
mod_full_brace_do                       = force         # string (add/force/ignore/remove)

# Braces on single-line else statement
mod_full_brace_if                       = force         # string (add/force/ignore/remove)

# Braces on single-line for statement
mod_full_brace_for                      = force         # string (add/force/ignore/remove)

# Braces on single-line while statement
mod_full_brace_while                    = force         # string (add/force/ignore/remove)

## Comments

# Add comment after ifdef/else statement of size
mod_add_long_ifdef_else_comment         = 20            # number

# Add comment after ifdef/endif statement of size
mod_add_long_ifdef_endif_comment        = 20            # number

## Parentheses

# Remove unnecessary parentheses on return statement
mod_paren_on_return                     = ignore        # string (add/force/ignore/remove)

## Semicolons

# Remove superflous semicolons
mod_remove_extra_semicolon              = true          # boolean (false/true)

# Comments
# --------

## Empty Lines

# Empty first line for multi-line C comments
cmt_c_nl_start                          = true          # boolean (false/true)

# Empty first line for multi-line C++ comments
cmt_cpp_nl_start                        = true          # boolean (false/true)

## Other

# Stars on multi-line comments
cmt_star_cont                           = false         # boolean (false/true)

# General
# -------

## Other

# Newline character
newlines                                = lf            # string (auto/cr/crlf/lf)

# Output tab size
output_tab_size                         = 4             # number

# Indentation
# -----------

## Indentation

# Indent ObjC block
indent_oc_block                         = true          # boolean (false/true)

## Indentation Size

# Indentation column size
indent_columns                          = 4             # number

# Indentation size between case and switch
indent_switch_case                      = 4             # number

# Indentation size for ObjC blocks in a message parameter
indent_oc_block_msg                     = 0             # number

# Indentation size for ObjC message subsequent parameters
indent_oc_msg_colon                     = 4             # number

## Other

# Align continued statements at equals
indent_align_assign                     = false         # boolean (false/true)

# Indent goto labels
indent_label                            = 2             # number

# Indent with tabs
indent_with_tabs                        = 0             # number

# Newlines
# --------

## Merging

# Change unbraced if statements into one-liner
nl_create_if_one_liner                  = true          # boolean (false/true)

## Newline After

# Newline after brace open
nl_after_brace_open                     = false         # boolean (false/true)

# Newline after do
nl_after_do                             = ignore        # string (add/force/ignore/remove)

# Newline after for
nl_after_for                            = ignore        # string (add/force/ignore/remove)

# Newline after if
nl_after_if                             = ignore        # string (add/force/ignore/remove)

# Newline after macro multi-line definition
nl_multi_line_define                    = true          # boolean (false/true)

# Newline after return
nl_after_return                         = false         # boolean (false/true)

# Newline after switch
nl_after_switch                         = ignore        # string (add/force/ignore/remove)

# Newline after while
nl_after_while                          = ignore        # string (add/force/ignore/remove)

## Newline Before

# Newline before case statement
nl_before_case                          = true          # boolean (false/true)

# Newline before do
nl_before_do                            = ignore        # string (add/force/ignore/remove)

# Newline before for
nl_before_for                           = ignore        # string (add/force/ignore/remove)

# Newline before if
nl_before_if                            = ignore        # string (add/force/ignore/remove)

# Newline before switch
nl_before_switch                        = ignore        # string (add/force/ignore/remove)

# Newline before while
nl_before_while                         = ignore        # string (add/force/ignore/remove)

## Newline Between

# Newline between case colon and open brace
nl_case_colon_brace                     = remove        # string (add/force/ignore/remove)

# Newline between catch and open brace
nl_catch_brace                          = remove        # string (add/force/ignore/remove)

# Newline between close brace and catch
nl_brace_catch                          = force         # string (add/force/ignore/remove)

# Newline between close brace and else
nl_brace_else                           = force         # string (add/force/ignore/remove)

# Newline between close brace and finally
nl_brace_finally                        = force         # string (add/force/ignore/remove)

# Newline between close brace and while
nl_brace_while                          = remove        # string (add/force/ignore/remove)

# Newline between close parenthesis and open brace in multi line conditional
nl_multi_line_cond                      = false         # boolean (false/true)

# Newline between do and open brace
nl_do_brace                             = remove        # string (add/force/ignore/remove)

# Newline between else and open brace
nl_else_brace                           = remove        # string (add/force/ignore/remove)

# Newline between else if and open brace
nl_elseif_brace                         = remove        # string (add/force/ignore/remove)

# Newline between enum and open brace
nl_enum_brace                           = remove        # string (add/force/ignore/remove)

# Newline between finally and open brace
nl_finally_brace                        = remove        # string (add/force/ignore/remove)

# Newline between for and open brace
nl_for_brace                            = remove        # string (add/force/ignore/remove)

# Newline between function call and open brace
nl_fcall_brace                          = remove        # string (add/force/ignore/remove)

# Newline between function signature and open brace
nl_fdef_brace                           = force         # string (add/force/ignore/remove)

# Newline between if and open brace
nl_if_brace                             = remove        # string (add/force/ignore/remove)

# Newline between struct and open brace
nl_struct_brace                         = remove        # string (add/force/ignore/remove)

# Newline between switch and open brace
nl_switch_brace                         = remove        # string (add/force/ignore/remove)

# Newline between try and open brace
nl_try_brace                            = remove        # string (add/force/ignore/remove)

# Newline between union and open brace
nl_union_brace                          = remove        # string (add/force/ignore/remove)

# Newline between while and open brace
nl_while_brace                          = remove        # string (add/force/ignore/remove)

## Other

# Collapse empty blocks between braces
nl_collapse_empty_body                  = true          # boolean (false/true)

# Don't split one-line ObjC messages
nl_oc_msg_leave_one_liner               = true          # boolean (false/true)

# Newlines at end of file
nl_end_of_file                          = add           # string (add/force/ignore/remove)

# Place ObjC message parameters on new lines
nl_oc_msg_args                          = false         # boolean (false/true)

# Spacing
# -------

## Space After

# Space after C++ comment opening
sp_cmt_cpp_start                        = ignore        # string (add/force/ignore/remove)

# Space after ObjC block caret
sp_after_oc_block_caret                 = remove        # string (add/force/ignore/remove)

# Space after ObjC colon
sp_after_oc_colon                       = remove        # string (add/force/ignore/remove)

# Space after ObjC dictionary colon
sp_after_oc_dict_colon                  = add           # string (add/force/ignore/remove)

# Space after ObjC message colon
sp_after_send_oc_colon                  = remove        # string (add/force/ignore/remove)

# Space after ObjC property
sp_after_oc_property                    = add           # string (add/force/ignore/remove)

# Space after ObjC return type
sp_after_oc_return_type                 = remove        # string (add/force/ignore/remove)

# Space after ObjC scope
sp_after_oc_scope                       = force         # string (add/force/ignore/remove)

# Space after ObjC type
sp_after_oc_type                        = remove        # string (add/force/ignore/remove)

# Space after cast
sp_after_cast                           = remove        # string (add/force/ignore/remove)

# Space after class colon
sp_after_class_colon                    = force         # string (add/force/ignore/remove)

# Space after comma
sp_after_comma                          = add           # string (add/force/ignore/remove)

# Space after condition close parenthesis
sp_after_sparen                         = force         # string (add/force/ignore/remove)

# Space after not operator
sp_not                                  = force         # string (add/force/ignore/remove)

# Space after pointer star
sp_after_ptr_star                       = remove        # string (add/force/ignore/remove)

# Space after pointer star followed by function
sp_after_ptr_star_func                  = remove        # string (add/force/ignore/remove)

## Space Around

# Space around arithmetic operators
sp_arith                                = add           # string (add/force/ignore/remove)

# Space around assignment operator
sp_assign                               = add           # string (add/force/ignore/remove)

# Space around boolean operators
sp_bool                                 = add           # string (add/force/ignore/remove)

# Space around compare operators
sp_compare                              = add           # string (add/force/ignore/remove)

# Space around ternary condition colon
sp_cond_colon                           = force         # string (add/force/ignore/remove)

# Space around ternary condition question mark
sp_cond_question                        = force         # string (add/force/ignore/remove)

## Space Before

# Space before ObjC block caret
sp_before_oc_block_caret                = ignore        # string (add/force/ignore/remove)

# Space before ObjC colon
sp_before_oc_colon                      = remove        # string (add/force/ignore/remove)

# Space before ObjC dictionary colon
sp_before_oc_dict_colon                 = remove        # string (add/force/ignore/remove)

# Space before ObjC message colon
sp_before_send_oc_colon                 = remove        # string (add/force/ignore/remove)

# Space before case colon
sp_before_case_colon                    = remove        # string (add/force/ignore/remove)

# Space before class colon
sp_before_class_colon                   = force         # string (add/force/ignore/remove)

# Space before if/for/switch/while open parenthesis
sp_before_sparen                        = force         # string (add/force/ignore/remove)

# Space before pointer star
sp_before_ptr_star                      = force         # string (add/force/ignore/remove)

# Space before pointer star followed by function
sp_before_ptr_star_func                 = force         # string (add/force/ignore/remove)

# Space before unnamed pointer star
sp_before_unnamed_ptr_star              = ignore        # string (add/force/ignore/remove)

## Space Between

# Space between @selector and open parenthesis
sp_after_oc_at_sel                      = remove        # string (add/force/ignore/remove)

# Space between catch and open brace
sp_catch_brace                          = add           # string (add/force/ignore/remove)

# Space between catch and open parenthesis
sp_catch_paren                          = add           # string (add/force/ignore/remove)

# Space between close brace and else
sp_brace_else                           = force         # string (add/force/ignore/remove)

# Space between close parenthesis and open brace
sp_paren_brace                          = force         # string (add/force/ignore/remove)

# Space between closing brace and catch
sp_brace_catch                          = add           # string (add/force/ignore/remove)

# Space between closing brace and finally
sp_brace_finally                        = add           # string (add/force/ignore/remove)

# Space between closing parenthesis and open brace
sp_fparen_brace                         = force         # string (add/force/ignore/remove)

# Space between else and open brace
sp_else_brace                           = force         # string (add/force/ignore/remove)

# Space between finally and open brace
sp_finally_brace                        = add           # string (add/force/ignore/remove)

# Space between function name and open parenthesis
sp_func_call_paren                      = remove        # string (add/force/ignore/remove)

# Space between function name and open parenthesis in declaration
sp_func_proto_paren                     = remove        # string (add/force/ignore/remove)

# Space between function name and open parenthesis in function definition
sp_func_def_paren                       = remove        # string (add/force/ignore/remove)

# Space between pointer stars
sp_between_ptr_star                     = remove        # string (add/force/ignore/remove)

# Space between sizeof and open parenthesis
sp_sizeof_paren                         = remove        # string (add/force/ignore/remove)

# Space between try and open brace
sp_try_brace                            = add           # string (add/force/ignore/remove)

## Space Inside

# Space inside @selector() parens
sp_inside_oc_at_sel_parens              = remove        # string (add/force/ignore/remove)

# Space inside braces
sp_inside_braces                        = add           # string (add/force/ignore/remove)

# Space inside cast parentheses
sp_inside_paren_cast                    = remove        # string (add/force/ignore/remove)

# Space inside enum braces
sp_inside_braces_enum                   = add           # string (add/force/ignore/remove)

# Space inside function parentheses
sp_inside_fparen                        = remove        # string (add/force/ignore/remove)

# Space inside if-condition parentheses
sp_inside_sparen                        = remove        # string (add/force/ignore/remove)

# Space inside parentheses
sp_inside_paren                         = remove        # string (add/force/ignore/remove)

# Space inside parentheses in function type
sp_inside_tparen                        = remove        # string (add/force/ignore/remove)

# Space inside struct/union braces
sp_inside_braces_struct                 = add           # string (add/force/ignore/remove)

Based on https://gist.github.com/ryanmaxwell/4242629, with the following changes:

• Newline between function signature and open brace: force
• Newline after for: ignore
• Newline after if: ignore
• Newline after while: ignore
• Newline after switch: ignore
• Newline after do: ignore
• Newline after return: false
• Newline before for: ignore
• Newline before if: ignore
• Newline before while: ignore
• Newline before switch: ignore
• Newline before do: ignore
• Newline before case statement: true
• Newline between close brace and else: force
• Newline between close brace and catch: force
• Newline between close brace and finally: force
• Newline count after variable definition block: 0
• Maximum consecutive newlines: 2
• Space after not operator: force
• Space after pointer star followed by function: remove
• Indent ObjC block: true
• Indentation size for ObjC blocks: 0
• Place ObjC message parameters on new lines: false
• Align span [insert all options here]: 0
• Align macros wrapped with backslash and newline: true
• Align variable definitions: false
• Braces on single-line do statement: force
• Braces on single-line else statement: force
• Braces on single-line for statement: force
• Braces on single-line while statement: force
• Collapse empty blocks between braces: true

The result obtained when using this configuration file with Uncrustify is not the same as the result produced by using the same configuration file through the BBUncrustifyPlugin-Xcode Xcode plugin. The reason is that the plugin pastes the result into Xcode, giving it a chance to fix indentation according to rules not available through Uncrustify, e.g. smart indentation (see benoitsan/BBUncrustifyPlugin-Xcode#8).

For this reason, when run through the Xcode plugin, the uncrustified result is different in the following cases (Xcode formatting wins):

• Plain Uncrustify preserves macro indentation. When the BBUncrustify plugin pastes this result into Xcode, all indentation is lost (Xcode left-aligns macros)
• // comments broken on several lines can be correctly aligned by Uncrustify. But when the BBUncrustify plugin pastes this result into Xcode, comments are aligned again according to Xcode behavior. If you want a consistent behavior, open Xcode preferences and check Syntax-aware indenting and Align consecutive // comments options

Here are a few Objective-C oriented Uncrustify settings which could be added by contributing to the official project:

• Spacing between * and const qualifiers cannot be set separately and is controlled through usual star positioning options. A dedicated option would be welcome
• The degenerated ternary operator ?: is governed by the same rules as the ? and the :. If spacing is forced around ? and :, degenerated ternary operators will get an additional space as well: ? :. Being able to control spacing for this special version of the ternary operator would be welcome

Here are a few Objective-C oriented Uncrustify bugs which could be fixed by contributing to the official project. To debug, use uncrustify -p log_file.txt -c input_config.cfg -f file.m and have a look at log_file.txt:

• Even if spacing is forced around the ternary condition colon, the expression [obj setHidden:visible ? YES : NO] is not transformed correctly (spaces around : are discarded)
• The expression [*pExistingError hasCode:NSValidationMultipleErrorsError withinDomain:NSCocoaErrorDomain] is not correctly parsed (but is correctly parsed if we remove the dereference operator *). Colons are namely incorrectly identified as bit field colons. Same issue with [obj displayMessage:success ? @"OK " : @"KO"]
• The expression [(UIViewController<HLSValidable> *) viewController validate] is not correctly parsed (< and > are incorrectly identified as comparison operators, not as angle brackets)