checkstyle (or formatter instead of just checker)

[colonelfazackerley]

I am experimenting with using checkstyle to report on rabbit escape. I have spent a few min tweaking the config xml (starting with sun style). It looks promising. Would there be interest in having a checkstyle makefile target?

tweaked config so far is below (search 'rabbit' to find my changes). output is starting to look useful.

<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
          "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
          "https://checkstyle.org/dtds/configuration_1_3.dtd">

<!--

  Checkstyle configuration that checks the sun coding conventions from:

    - the Java Language Specification at
      http://java.sun.com/docs/books/jls/second_edition/html/index.html

    - the Sun Code Conventions at http://java.sun.com/docs/codeconv/

    - the Javadoc guidelines at
      http://java.sun.com/j2se/javadoc/writingdoccomments/index.html

    - the JDK Api documentation http://java.sun.com/j2se/docs/api/index.html

    - some best practices

    - rabbit escape guidelines
      https://github.com/andybalaam/rabbit-escape/wiki/Code-style-and-version

  Checkstyle is very configurable. Be sure to read the documentation at
  http://checkstyle.sf.net (or in your downloaded distribution).

  Most Checks are configurable, be sure to consult the documentation.

  To completely disable a check, just comment it out or delete it from the file.

  Finally, it is worth reading the documentation.

-->

<module name="Checker">
    <!--
        If you set the basedir property below, then all reported file
        names will be relative to the specified directory. See
        https://checkstyle.org/5.x/config.html#Checker

        <property name="basedir" value="${basedir}"/>
    -->

    <property name="fileExtensions" value="java, properties, xml"/>

    <!-- Checks that a package-info.java file exists for each package.     -->
    <!-- See http://checkstyle.sf.net/config_javadoc.html#JavadocPackage -->
    <module name="JavadocPackage"/>

    <!-- Checks whether files end with a new line.                        -->
    <!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile -->
    <module name="NewlineAtEndOfFile"/>

    <!-- Checks that property files contain the same keys.         -->
    <!-- See http://checkstyle.sf.net/config_misc.html#Translation -->
    <module name="Translation"/>

    <!-- Checks for Size Violations.                    -->
    <!-- See http://checkstyle.sf.net/config_sizes.html -->
    <module name="FileLength"/>

    <!-- Checks for whitespace                               -->
    <!-- See http://checkstyle.sf.net/config_whitespace.html -->
    <module name="FileTabCharacter"/>

    <!-- Miscellaneous other checks.                   -->
    <!-- See http://checkstyle.sf.net/config_misc.html -->
    <module name="RegexpSingleline">
       <property name="format" value="\s+$"/>
       <property name="minimum" value="0"/>
       <property name="maximum" value="0"/>
       <property name="message" value="Line has trailing spaces."/>
    </module>

    <!-- Checks for Headers                                -->
    <!-- See http://checkstyle.sf.net/config_header.html   -->
    <!-- <module name="Header"> -->
    <!--   <property name="headerFile" value="${checkstyle.header.file}"/> -->
    <!--   <property name="fileExtensions" value="java"/> -->
    <!-- </module> -->

    <module name="TreeWalker">

        <!-- Checks for Javadoc comments.                     -->
        <!-- See http://checkstyle.sf.net/config_javadoc.html -->
        <!-- rabbit escape currently not fussy about javadoc
        <module name="JavadocMethod"/>
        <module name="JavadocType"/>
        <module name="JavadocVariable"/>
        <module name="JavadocStyle"/>
        -->

        <!-- Checks for Naming Conventions.                  -->
        <!-- See http://checkstyle.sf.net/config_naming.html -->
        <module name="ConstantName"/>
        <module name="LocalFinalVariableName"/>
        <module name="LocalVariableName"/>
        <module name="MemberName"/>
        <module name="MethodName"/>
        <module name="PackageName"/>
        <module name="ParameterName">
            <!-- rabbit escape: start lower case, allow underscore -->
            <property name="format" value="^[a-z][_a-zA-Z0-9]*$"/>
        </module>
        <module name="StaticVariableName"/>
        <module name="TypeName"/>

        <!-- Checks for imports                              -->
        <!-- See http://checkstyle.sf.net/config_import.html -->
        <module name="AvoidStarImport"/>
        <module name="IllegalImport"/> <!-- defaults to sun.* packages -->
        <module name="RedundantImport"/>
        <module name="UnusedImports">
            <property name="processJavadoc" value="false"/>
        </module>

        <!-- Checks for Size Violations.                    -->
        <!-- See http://checkstyle.sf.net/config_sizes.html -->
        <module name="LineLength"/>
        <module name="MethodLength"/>
        <module name="ParameterNumber"/>

        <!-- Checks for whitespace                               -->
        <!-- See http://checkstyle.sf.net/config_whitespace.html -->
        <module name="EmptyForIteratorPad"/>
        <module name="GenericWhitespace"/>
        <module name="MethodParamPad"/>
        <module name="NoWhitespaceAfter"/>
        <module name="NoWhitespaceBefore"/>
        <module name="OperatorWrap"/>
        <module name="ParenPad">
            <!-- rabbit escape has space padding for parentheses -->
            <property name="option" value="space"/>
        </module>
        <module name="TypecastParenPad"/>
        <module name="WhitespaceAfter"/>
        <module name="WhitespaceAround"/>

        <!-- Modifier Checks                                    -->
        <!-- See http://checkstyle.sf.net/config_modifiers.html -->
        <module name="ModifierOrder"/>
        <module name="RedundantModifier"/>

        <!-- Checks for blocks. You know, those {}'s         -->
        <!-- See http://checkstyle.sf.net/config_blocks.html -->
        <module name="AvoidNestedBlocks"/>
        <module name="EmptyBlock"/>
        <module name="LeftCurly">
            <!-- rabbit escape has left curly brace on new line (nl) -->
            <property name="option" value="nl"/>
        </module>
        <module name="NeedBraces"/>
        <module name="RightCurly">
            <!-- rabbit escape has right curly brace alone on a line -->
            <property name="option" value="alone"/>
        </module>

        <!-- Checks for common coding problems               -->
        <!-- See http://checkstyle.sf.net/config_coding.html -->
        <module name="AvoidInlineConditionals"/>
        <module name="EmptyStatement"/>
        <module name="EqualsHashCode"/>
        <module name="HiddenField"/>
        <module name="IllegalInstantiation"/>
        <module name="InnerAssignment"/>
        <module name="MagicNumber"/>
        <module name="MissingSwitchDefault"/>
        <module name="SimplifyBooleanExpression"/>
        <module name="SimplifyBooleanReturn"/>

        <!-- Checks for class design                         -->
        <!-- See http://checkstyle.sf.net/config_design.html -->
        <module name="DesignForExtension"/>
        <module name="FinalClass"/>
        <module name="HideUtilityClassConstructor"/>
        <module name="InterfaceIsType"/>
        <module name="VisibilityModifier"/>

        <!-- Miscellaneous other checks.                   -->
        <!-- See http://checkstyle.sf.net/config_misc.html -->
        <module name="ArrayTypeStyle"/>
        <module name="FinalParameters"/>
        <module name="TodoComment"/>
        <module name="UpperEll"/>

    </module>

</module>

[andybalaam]

What benefits do you see from this?

I am have a personal dislike of checkstyle for code formatting, because it doesn't correct your code, only complains about it, and sometimes in ways that are hard to apply. So, for code formatting, I'd prefer a formatting tool such as Google Java Formatter with the --aosp argument because it fixes your code instead of just complaining about it.

I also personally see little value in "warnings" that don't fail the build because they tend to rot, so if we introduced something like this I would always want it to be part of a feasible plan to fix all warnings and then make any new warnings fail the build. [Note: this falls down if different operating systems or Java versions cause different warnings, so if that was the case I'd be less favourable towards doing it.]

[colonelfazackerley]

I noticed we have a lot of deviations from the code style (whitespace, line length), and I'm introducing more by accident. checkstyle also does a few things to make bugs less likely or make code clearer (eg pointing out where variables can be declared final).

I was looking for something to help pick them up. I can look at Google's. I agree that having the option to make it fix the code is useful.

[colonelfazackerley]

Looks like Google's is not configurable, and Google style is quite different (curly brace position, line length, ... ).

[colonelfazackerley]

maybe astyle https://sourceforge.net/projects/astyle/

[andybalaam]

I took some time to look into code formatters a few years ago and found none that I thought were good enough to use. Google's seems better, but we would have to change the style to fit it. I could live with that.

[andybalaam]

See #357

[colonelfazackerley]

maybe uncrustify https://github.com/uncrustify/uncrustify

ha, I joined in the chat for the previous discussion: forgot completely.

I prefer Google's java style to the current rabbit style.

[colonelfazackerley]

uncrustify looks promising. I am trawling through the config.

[andybalaam]

I prefer Google's java style to the current rabbit style.

I can live with it.

[tttppp]

Fwiw I'd be happy with the Google Java style.

[colonelfazackerley]

Despite preferring Google style, I have been fiddling with making uncrustify do rabbit style.

click to expand uncrustify config

```cfg # Uncrustify 0.58 # # General options # # The type of line endings newlines = auto # auto/lf/crlf/cr # The original size of tabs in the input input_tab_size = 4 # number # Allow interpreting '>=' and '>>=' as part of a template in 'void f(list>=val);'. # If true (default), 'assert(x<0 && y>=3)' will be broken. # Improvements to template detection may make this option obsolete. tok_split_gte = false # false/true # # Indenting # # The number of columns to indent per level. # Usually 2, 3, 4, or 8. indent_columns = 4 # number # The continuation indent. If non-zero, this overrides the indent of '(' and '=' continuation indents. # For FreeBSD, this is set to 4. indent_continue = 0 # number # How to use tabs when indenting code # 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 indent_with_tabs = 0 # number # Whether to indent strings broken by '\' so that they line up indent_align_string = true # false/true # The number of spaces to indent multi-line XML strings. # Requires indent_align_string=True indent_xml_string = 2 # number # Spaces to indent '{' from level indent_brace = 0 # number # Whether braces are indented to the body level indent_braces = false # false/true # Disabled indenting function braces if indent_braces is true indent_braces_no_func = false # false/true # Disabled indenting class braces if indent_braces is true indent_braces_no_class = false # false/true # Disabled indenting struct braces if indent_braces is true indent_braces_no_struct = false # false/true # Indent based on the size of the brace parent, i.e. 'if' => 3 spaces, 'for' => 4 spaces, etc. indent_brace_parent = false # false/true # Whether the 'namespace' body is indented indent_namespace = false # false/true # The number of spaces to indent a namespace block indent_namespace_level = 0 # number # 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_namespace_limit = 0 # number # Whether the 'extern "C"' body is indented indent_extern = false # false/true # Whether the 'class' body is indented indent_class = true # false/true # Whether to indent the stuff after a leading class colon indent_class_colon = false # false/true # False=treat 'else\nif' as 'else if' for indenting purposes # True=indent the 'if' one level indent_else_if = true # false/true # Amount to indent variable declarations after a open brace. neg=relative, pos=absolute indent_var_def_blk = 0 # number # Indent continued variable declarations instead of aligning. indent_var_def_cont = true # false/true # True: indent continued function call parameters one indent level # False: align parameters under the open paren indent_func_call_param = true # false/true # Same as indent_func_call_param, but for function defs indent_func_def_param = true # false/true # Same as indent_func_call_param, but for function protos indent_func_proto_param = true # false/true # Same as indent_func_call_param, but for class declarations indent_func_class_param = true # false/true # Same as indent_func_call_param, but for class variable constructors indent_func_ctor_var_param = true # false/true # Same as indent_func_call_param, but for templates indent_template_param = true # false/true # Double the indent for indent_func_xxx_param options indent_func_param_double = false # false/true # Indentation column for standalone 'const' function decl/proto qualifier indent_func_const = 0 # number # Indentation column for standalone 'throw' function decl/proto qualifier indent_func_throw = 0 # number # The number of spaces to indent a continued '->' or '.' # Usually set to 0, 1, or indent_columns. indent_member = 4 # number # Spaces to indent single line ('//') comments on lines before code indent_sing_line_comments = 0 # number # If set, will indent trailing single line ('//') comments relative # to the code instead of trying to keep the same absolute column indent_relative_single_line_comments = false # false/true # Spaces to indent 'case' from 'switch' # Usually 0 or indent_columns. indent_switch_case = 0 # number # Spaces to shift the 'case' line, without affecting any other lines # Usually 0. indent_case_shift = 0 # number # Spaces to indent '{' from 'case'. # By default, the brace will appear under the 'c' in case. # Usually set to 0 or indent_columns. indent_case_brace = 0 # number # Whether to indent comments found in first column indent_col1_comment = false # false/true # How to indent goto labels # >0 : absolute column where 1 is the leftmost column # <=0 : subtract from brace indent indent_label = -4 # number # Same as indent_label, but for access specifiers that are followed by a colon indent_access_spec = -4 # number # Indent the code after an access specifier by one level. # If set, this option forces 'indent_access_spec=0' indent_access_spec_body = true # false/true # 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_nl = false # false/true # 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_paren_close = 0 # number # Controls the indent of a comma when inside a paren.If TRUE, aligns under the open paren indent_comma_paren = false # false/true # Controls the indent of a BOOL operator when inside a paren.If TRUE, aligns under the open paren indent_bool_paren = false # false/true # If 'indent_bool_paren' is true, controls the indent of the first expression. If TRUE, aligns the first expression to the following ones indent_first_bool_expr = false # false/true # 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_square_nl = false # false/true # Don't change the relative indent of ESQL/C 'EXEC SQL' bodies indent_preserve_sql = false # false/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_align_assign = false # false/true # # Spacing options # # Add or remove space around arithmetic operator '+', '-', '/', '*', etc sp_arith = force # ignore/add/remove/force # Add or remove space around assignment operator '=', '+=', etc sp_assign = force # ignore/add/remove/force # Add or remove space around assignment operator '=' in a prototype sp_assign_default = force # ignore/add/remove/force # Add or remove space before assignment operator '=', '+=', etc. Overrides sp_assign. sp_before_assign = force # ignore/add/remove/force # Add or remove space after assignment operator '=', '+=', etc. Overrides sp_assign. sp_after_assign = force # ignore/add/remove/force # Add or remove space around assignment '=' in enum sp_enum_assign = force # ignore/add/remove/force # Add or remove space before assignment '=' in enum. Overrides sp_enum_assign. sp_enum_before_assign = force # ignore/add/remove/force # Add or remove space after assignment '=' in enum. Overrides sp_enum_assign. sp_enum_after_assign = force # ignore/add/remove/force # Add or remove space around boolean operators '&&' and '||' sp_bool = force # ignore/add/remove/force # Add or remove space around compare operator '<', '>', '==', etc sp_compare = force # ignore/add/remove/force # Add or remove space inside '(' and ')' sp_inside_paren = force # ignore/add/remove/force # Add or remove space between nested parens sp_paren_paren = force # ignore/add/remove/force # Whether to balance spaces inside nested parens sp_balance_nested_parens = false # false/true # Add or remove space between ')' and '{' sp_paren_brace = force # ignore/add/remove/force # Add or remove space between type and word. Default=Force sp_after_type = force # ignore/add/remove/force # Add or remove space in 'template <' vs 'template<'. # If set to ignore, sp_before_angle is used. sp_template_angle = remove # ignore/add/remove/force # Add or remove space before '<>' sp_before_angle = remove # ignore/add/remove/force # Add or remove space inside '<' and '>' sp_inside_angle = remove # ignore/add/remove/force # Add or remove space after '<>' sp_after_angle = remove # ignore/add/remove/force # Add or remove space between '<>' and '(' as found in 'new List();' sp_angle_paren = remove # ignore/add/remove/force # Add or remove space between '<>' and a word as in 'List m;' sp_angle_word = force # ignore/add/remove/force # Add or remove space between '>' and '>' in '>>' (template stuff C++/C# only). Default=Add sp_angle_shift = force # ignore/add/remove/force # Add or remove space before '(' of 'if', 'for', 'switch', and 'while' sp_before_sparen = force # ignore/add/remove/force # Add or remove space inside if-condition '(' and ')' sp_inside_sparen = force # ignore/add/remove/force # Add or remove space before if-condition ')'. Overrides sp_inside_sparen. sp_inside_sparen_close = force # ignore/add/remove/force # Add or remove space after ')' of 'if', 'for', 'switch', and 'while' sp_after_sparen = force # ignore/add/remove/force # Add or remove space between ')' and '{' of 'if', 'for', 'switch', and 'while' sp_sparen_brace = force # ignore/add/remove/force # Add or remove space between 'invariant' and '(' in the D language. sp_invariant_paren = remove # ignore/add/remove/force # Add or remove space after the ')' in 'invariant (C) c' in the D language. sp_after_invariant_paren = force # ignore/add/remove/force # Add or remove space before empty statement ';' on 'if', 'for' and 'while' sp_special_semi = remove # ignore/add/remove/force # Add or remove space before ';'. Default=Remove sp_before_semi = remove # ignore/add/remove/force # Add or remove space before ';' in non-empty 'for' statements sp_before_semi_for = remove # ignore/add/remove/force # Add or remove space before a semicolon of an empty part of a for statement. sp_before_semi_for_empty = remove # ignore/add/remove/force # Add or remove space after ';', except when followed by a comment. Default=Add sp_after_semi = force # ignore/add/remove/force # Add or remove space after ';' in non-empty 'for' statements. Default=Force sp_after_semi_for = force # ignore/add/remove/force # Add or remove space after the final semicolon of an empty part of a for statement: for ( ; ; ). sp_after_semi_for_empty = remove # ignore/add/remove/force # Add or remove space before '[' (except '[]') sp_before_square = remove # ignore/add/remove/force # Add or remove space before '[]' sp_before_squares = remove # ignore/add/remove/force # Add or remove space inside '[' and ']' sp_inside_square = remove # ignore/add/remove/force # Add or remove space after ',' sp_after_comma = force # ignore/add/remove/force # Add or remove space before ',' sp_before_comma = remove # ignore/add/remove/force # Add or remove space between an open paren and comma: '(,' vs '( ,' sp_paren_comma = force # ignore/add/remove/force # Add or remove space before the variadic '...' when preceded by a non-punctuator sp_before_ellipsis = force # ignore/add/remove/force # Add or remove space after class ':' sp_after_class_colon = force # ignore/add/remove/force # Add or remove space before class ':' sp_before_class_colon = remove # ignore/add/remove/force # Add or remove space before case ':'. Default=Remove sp_before_case_colon = remove # ignore/add/remove/force # Add or remove space between 'operator' and operator sign sp_after_operator = force # ignore/add/remove/force # Add or remove space between the operator symbol and the open paren, as in 'operator ++(' sp_after_operator_sym = remove # ignore/add/remove/force # Add or remove space after C/D cast, i.e. 'cast(int)a' vs 'cast(int) a' or '(int)a' vs '(int) a' sp_after_cast = remove # ignore/add/remove/force # Add or remove spaces inside cast parens sp_inside_paren_cast = remove # ignore/add/remove/force # Add or remove space between the type and open paren in a C++ cast, i.e. 'int(exp)' vs 'int (exp)' sp_cpp_cast_paren = remove # ignore/add/remove/force # Add or remove space between 'sizeof' and '(' sp_sizeof_paren = force # ignore/add/remove/force # Add or remove space after the tag keyword (Pawn) sp_after_tag = force # ignore/add/remove/force # Add or remove space inside enum '{' and '}' sp_inside_braces_enum = force # ignore/add/remove/force # Add or remove space inside struct/union '{' and '}' sp_inside_braces_struct = force # ignore/add/remove/force # Add or remove space inside '{' and '}' sp_inside_braces = force # ignore/add/remove/force # Add or remove space inside '{}' sp_inside_braces_empty = remove # ignore/add/remove/force # Add or remove space between return type and function name # A minimum of 1 is forced except for pointer return types. sp_type_func = remove # ignore/add/remove/force # Add or remove space between function name and '(' on function declaration sp_func_proto_paren = remove # ignore/add/remove/force # Add or remove space between function name and '(' on function definition sp_func_def_paren = remove # ignore/add/remove/force # Add or remove space inside empty function '()' sp_inside_fparens = remove # ignore/add/remove/force # Add or remove space inside function '(' and ')' sp_inside_fparen = force # ignore/add/remove/force # Add or remove space between ']' and '(' when part of a function call. sp_square_fparen = remove # ignore/add/remove/force # Add or remove space between ')' and '{' of function sp_fparen_brace = force # ignore/add/remove/force # Add or remove space between function name and '(' on function calls sp_func_call_paren = remove # ignore/add/remove/force # 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. sp_func_call_paren_empty = remove # ignore/add/remove/force # Add or remove space 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_call_user_paren = remove # ignore/add/remove/force # Add or remove space between a constructor/destructor and the open paren sp_func_class_paren = remove # ignore/add/remove/force # Add or remove space between 'return' and '(' sp_return_paren = force # ignore/add/remove/force # Add or remove space between '__attribute__' and '(' sp_attribute_paren = force # ignore/add/remove/force # Add or remove space between 'defined' and '(' in '#if defined (FOO)' sp_defined_paren = remove # ignore/add/remove/force # Add or remove space between 'throw' and '(' in 'throw (something)' sp_throw_paren = force # ignore/add/remove/force # Add or remove space between 'catch' and '(' in 'catch (something) { }' # If set to ignore, sp_before_sparen is used. sp_catch_paren = force # ignore/add/remove/force # Add or remove space between 'else' and '{' if on the same line sp_else_brace = force # ignore/add/remove/force # Add or remove space between '}' and 'else' if on the same line sp_brace_else = force # ignore/add/remove/force # Add or remove space between '}' and the name of a typedef on the same line sp_brace_typedef = force # ignore/add/remove/force # Add or remove space between 'catch' and '{' if on the same line sp_catch_brace = force # ignore/add/remove/force # Add or remove space between '}' and 'catch' if on the same line sp_brace_catch = force # ignore/add/remove/force # Add or remove space between 'finally' and '{' if on the same line sp_finally_brace = force # ignore/add/remove/force # Add or remove space between '}' and 'finally' if on the same line sp_brace_finally = force # ignore/add/remove/force # Add or remove space between 'try' and '{' if on the same line sp_try_brace = force # ignore/add/remove/force # Add or remove space between get/set and '{' if on the same line sp_getset_brace = force # ignore/add/remove/force # Add or remove space after the '!' (not) operator. Default=Remove sp_not = remove # ignore/add/remove/force # Add or remove space after the '~' (invert) operator. Default=Remove sp_inv = remove # ignore/add/remove/force # Add or remove space after '+' or '-', as in 'x = -5' or 'y = +7'. Default=Remove sp_sign = remove # ignore/add/remove/force # Add or remove space before or after '++' and '--', as in '(--x)' or 'y++;'. Default=Remove sp_incdec = remove # ignore/add/remove/force # Add or remove space before a backslash-newline at the end of a line. Default=Add sp_before_nl_cont = force # ignore/add/remove/force # Add or remove space around the ':' in 'b ? t : f' sp_cond_colon = force # ignore/add/remove/force # Add or remove space around the '?' in 'b ? t : f' sp_cond_question = force # ignore/add/remove/force # Fix the spacing between 'case' and the label. Only 'ignore' and 'force' make sense here. sp_case_label = force # ignore/add/remove/force # Control the space around the D '..' operator. sp_range = force # ignore/add/remove/force # Control the space after the opening of a C++ comment '// A' vs '//A' sp_cmt_cpp_start = force # ignore/add/remove/force # # Code alignment (not left column spaces/tabs) # # Whether to keep non-indenting tabs align_keep_tabs = true # false/true # Whether to use tabs for aligning align_with_tabs = true # false/true # Whether to bump out to the next tab when aligning align_on_tabstop = true # false/true # Align variable definitions in prototypes and functions align_func_params = false # false/true # Align parameters in single-line functions that have the same name. # The function names must already be aligned with each other. align_same_func_call_params = false # false/true # The span for aligning variable definitions (0=don't align) align_var_def_span = 2 # number # 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_star_style = 1 # number # How to align the '&' in variable definitions. # 0=Part of the type # 1=Part of the variable # 2=Dangling align_var_def_amp_style = 1 # number # The threshold for aligning variable definitions (0=no limit) align_var_def_thresh = 20 # number # The gap for aligning variable definitions align_var_def_gap = 0 # number # Whether to align the colon in struct bit fields align_var_def_colon = false # false/true # Whether to align any attribute after the variable name align_var_def_attribute = false # false/true # Whether to align inline struct/enum/union variable definitions align_var_def_inline = false # false/true # The span for aligning on '=' in assignments (0=don't align) align_assign_span = 0 # number # The threshold for aligning on '=' in assignments (0=no limit) align_assign_thresh = 0 # number # The span for aligning on '=' in enums (0=don't align) align_enum_equ_span = 0 # number # The threshold for aligning on '=' in enums (0=no limit) align_enum_equ_thresh = 0 # number # The span for aligning struct/union (0=don't align) align_var_struct_span = 1 # number # The threshold for aligning struct/union member definitions (0=no limit) align_var_struct_thresh = 0 # number # The gap for aligning struct/union member definitions align_var_struct_gap = 0 # number # The span for aligning struct initializer values (0=don't align) align_struct_init_span = 0 # number # The minimum space between the type and the synonym of a typedef align_typedef_gap = 1 # number # The span for aligning single-line typedefs (0=don't align) align_typedef_span = 2 # number # 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 = 0 # number # Controls the positioning of the '*' in typedefs. Just try it. # 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 = 1 # number # Controls the positioning of the '&' in typedefs. Just try it. # 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 = 1 # number # The span for aligning comments that end lines (0=don't align) align_right_cmt_span = 1 # number # If aligning comments, mix with comments after '}' and #endif with less than 3 spaces before the comment align_right_cmt_mix = false # false/true # 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_gap = 1 # number # Align trailing comment at or beyond column N; 'pulls in' comments as a bonus side effect (0=ignore) align_right_cmt_at_col = 41 # number # The span for aligning function prototypes (0=don't align) align_func_proto_span = 0 # number # Minimum gap between the return type and the function name. align_func_proto_gap = 0 # number # Align function protos on the 'operator' keyword instead of what follows align_on_operator = false # false/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_mix_var_proto = false # false/true # Align single-line functions with function prototypes, uses align_func_proto_span align_single_line_func = true # false/true # Aligning the open brace of single-line functions. # Requires align_single_line_func=true, uses align_func_proto_span align_single_line_brace = false # false/true # Gap for align_single_line_brace. align_single_line_brace_gap = 0 # number # Align lines that start with '<<' with previous '<<'. Default=true align_left_shift = true # false/true # Span for aligning parameters in an Obj-C message call on the ':' (0=don't align) align_oc_msg_colon_span = 0 # number # Aligning parameters in an Obj-C '+' or '-' declaration on the ':' align_oc_decl_colon = false # false/true # # Newline adding and removing options # # Whether to collapse empty blocks between '{' and '}' nl_collapse_empty_body = true # false/true # Don't split one-line braced assignments - 'foo_t f = { 1, 2 };' nl_assign_leave_one_liners = true # false/true # Don't split one-line braced statements inside a class xx { } body nl_class_leave_one_liners = true # false/true # Don't split one-line enums: 'enum foo { BAR = 15 };' nl_enum_leave_one_liners = true # false/true # Don't split one-line get or set functions nl_getset_leave_one_liners = true # false/true # Don't split one-line function definitions - 'int foo() { return 0; }' nl_func_leave_one_liners = true # false/true # Don't split one-line if/else statements - 'if(a) b++;' nl_if_leave_one_liners = false # false/true # Add or remove newlines at the start of the file nl_start_of_file = remove # ignore/add/remove/force # The number of newlines at the start of the file (only used if nl_start_of_file is 'add' or 'force' nl_start_of_file_min = 0 # number # Add or remove newline at the end of the file nl_end_of_file = force # ignore/add/remove/force # The number of newlines at the end of the file (only used if nl_end_of_file is 'add' or 'force') nl_end_of_file_min = 1 # number # Add or remove newline between '=' and '{' nl_assign_brace = remove # ignore/add/remove/force # Add or remove newline between '=' and '[' (D only) nl_assign_square = remove # ignore/add/remove/force # Add or remove newline after '= [' (D only). Will also affect the newline before the ']' nl_after_square_assign = remove # ignore/add/remove/force # The number of blank lines after a block of variable definitions nl_func_var_def_blk = 1 # number # Add or remove newline between a function call's ')' and '{', as in: # list_for_each(item, &list) { } nl_fcall_brace = remove # ignore/add/remove/force # Add or remove newline between 'enum' and '{' nl_enum_brace = force # ignore/add/remove/force # Add or remove newline between 'struct and '{' nl_struct_brace = force # ignore/add/remove/force # Add or remove newline between 'union' and '{' nl_union_brace = force # ignore/add/remove/force # Add or remove newline between 'if' and '{' nl_if_brace = force # ignore/add/remove/force # Add or remove newline between '}' and 'else' nl_brace_else = force # ignore/add/remove/force # Add or remove newline between 'else if' and '{' # If set to ignore, nl_if_brace is used instead nl_elseif_brace = force # ignore/add/remove/force # Add or remove newline between 'else' and '{' nl_else_brace = force # ignore/add/remove/force # Add or remove newline between 'else' and 'if' nl_else_if = remove # ignore/add/remove/force # Add or remove newline between '}' and 'finally' nl_brace_finally = force # ignore/add/remove/force # Add or remove newline between 'finally' and '{' nl_finally_brace = force # ignore/add/remove/force # Add or remove newline between 'try' and '{' nl_try_brace = force # ignore/add/remove/force # Add or remove newline between get/set and '{' nl_getset_brace = remove # ignore/add/remove/force # Add or remove newline between 'for' and '{' nl_for_brace = force # ignore/add/remove/force # Add or remove newline between 'catch' and '{' nl_catch_brace = force # ignore/add/remove/force # Add or remove newline between '}' and 'catch' nl_brace_catch = force # ignore/add/remove/force # Add or remove newline between 'while' and '{' nl_while_brace = force # ignore/add/remove/force # Add or remove newline between 'using' and '{' nl_using_brace = force # ignore/add/remove/force # Add or remove newline between two open or close braces. # Due to general newline/brace handling, REMOVE may not work. nl_brace_brace = force # ignore/add/remove/force # Add or remove newline between 'do' and '{' nl_do_brace = force # ignore/add/remove/force # Add or remove newline between '}' and 'while' of 'do' statement nl_brace_while = force # ignore/add/remove/force # Add or remove newline between 'switch' and '{' nl_switch_brace = force # ignore/add/remove/force # 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. nl_multi_line_cond = false # false/true # Whether to put a newline before 'case' statement nl_before_case = true # false/true # Add or remove newline between ')' and 'throw' nl_before_throw = remove # ignore/add/remove/force # Whether to put a newline after 'case' statement nl_after_case = true # false/true # Add or remove newline between 'template<>' and whatever follows. nl_template_class = ignore # ignore/add/remove/force # Add or remove newline between 'class' and '{' nl_class_brace = force # ignore/add/remove/force # Add or remove newline after each ',' in the constructor member initialization nl_class_init_args = remove # ignore/add/remove/force # Add or remove newline between return type and function name in a function definition nl_func_type_name = remove # ignore/add/remove/force # Add or remove newline between return type and function name inside a class {} # Uses nl_func_type_name or nl_func_proto_type_name if set to ignore. nl_func_type_name_class = remove # ignore/add/remove/force # Add or remove newline between a function name and the opening '(' nl_func_paren = remove # ignore/add/remove/force # Add or remove newline between a function name and the opening '(' in the definition nl_func_def_paren = remove # ignore/add/remove/force # Add or remove newline after '(' in a function declaration nl_func_decl_start = remove # ignore/add/remove/force # Add or remove newline after '(' in a function definition nl_func_def_start = remove # ignore/add/remove/force # Overrides nl_func_decl_start when there is only one parameter. nl_func_decl_start_single = remove # ignore/add/remove/force # Overrides nl_func_def_start when there is only one parameter. nl_func_def_start_single = remove # ignore/add/remove/force # Add or remove newline after each ',' in a function declaration nl_func_decl_args = remove # ignore/add/remove/force # Add or remove newline after each ',' in a function definition nl_func_def_args = remove # ignore/add/remove/force # Add or remove newline before the ')' in a function declaration nl_func_decl_end = remove # ignore/add/remove/force # Add or remove newline before the ')' in a function definition nl_func_def_end = remove # ignore/add/remove/force # Overrides nl_func_decl_end when there is only one parameter. nl_func_decl_end_single = remove # ignore/add/remove/force # Overrides nl_func_def_end when there is only one parameter. nl_func_def_end_single = remove # ignore/add/remove/force # Add or remove newline between '()' in a function definition. nl_func_def_empty = remove # ignore/add/remove/force # Add or remove newline between function signature and '{' nl_fdef_brace = force # ignore/add/remove/force # Whether to put a newline after 'return' statement nl_after_return = false # false/true # Add or remove a newline between the return keyword and return expression. nl_return_expr = remove # ignore/add/remove/force # Whether to put a newline after semicolons, except in 'for' statements nl_after_semicolon = true # false/true # Whether to put a newline after brace open. # This also adds a newline before the matching brace close. nl_after_brace_open = true # false/true # If nl_after_brace_open and nl_after_brace_open_cmt are true, a newline is # placed between the open brace and a trailing single-line comment. nl_after_brace_open_cmt = false # false/true # Whether to put a newline after a virtual brace open with a non-empty body. # These occur in un-braced if/while/do/for statement bodies. nl_after_vbrace_open = true # false/true # Whether to put a newline after a virtual brace open with an empty body. # These occur in un-braced if/while/do/for statement bodies. nl_after_vbrace_open_empty = true # false/true # Whether to put a newline after a brace close. # Does not apply if followed by a necessary ';'. nl_after_brace_close = true # false/true # Whether to put a newline after a virtual brace close. # Would add a newline before return in: 'if (foo) a++; return;' nl_after_vbrace_close = true # false/true # Whether to alter newlines in '#define' macros nl_define_macro = false # false/true # Whether to not put blanks after '#ifxx', '#elxx', or before '#endif' nl_squeeze_ifdef = true # false/true # Add or remove blank line before 'if' nl_before_if = remove # ignore/add/remove/force # Add or remove blank line after 'if' statement nl_after_if = remove # ignore/add/remove/force # Add or remove blank line before 'for' nl_before_for = remove # ignore/add/remove/force # Add or remove blank line after 'for' statement nl_after_for = remove # ignore/add/remove/force # Add or remove blank line before 'while' nl_before_while = remove # ignore/add/remove/force # Add or remove blank line after 'while' statement nl_after_while = remove # ignore/add/remove/force # Add or remove blank line before 'switch' nl_before_switch = remove # ignore/add/remove/force # Add or remove blank line after 'switch' statement nl_after_switch = remove # ignore/add/remove/force # Add or remove blank line before 'do' nl_before_do = remove # ignore/add/remove/force # Add or remove blank line after 'do/while' statement nl_after_do = remove # ignore/add/remove/force # Whether to double-space commented-entries in struct/enum nl_ds_struct_enum_cmt = false # false/true # Whether to double-space before the close brace of a struct/union/enum # (lower priority than 'eat_blanks_before_close_brace') nl_ds_struct_enum_close_brace = false # false/true # Add or remove a newline around a class colon. # Related to pos_class_colon, nl_class_init_args, and pos_comma. nl_class_colon = remove # ignore/add/remove/force # Change simple unbraced if statements into a one-liner # 'if(b)\n i++;' => 'if(b) i++;' nl_create_if_one_liner = false # false/true # Change simple unbraced for statements into a one-liner # 'for (i=0;i<5;i++)\n foo(i);' => 'for (i=0;i<5;i++) foo(i);' nl_create_for_one_liner = false # false/true # Change simple unbraced while statements into a one-liner # 'while (i<5)\n foo(i++);' => 'while (i<5) foo(i++);' nl_create_while_one_liner = false # false/true # # Positioning options # # The position of arithmetic operators in wrapped expressions pos_arith = trail # ignore/lead/lead_break/lead_force/trail/trail_break/trail_force # The position of assignment in wrapped expressions. # Do not affect '=' followed by '{' pos_assign = trail # ignore/lead/lead_break/lead_force/trail/trail_break/trail_force # The position of boolean operators in wrapped expressions pos_bool = trail # ignore/lead/lead_break/lead_force/trail/trail_break/trail_force # The position of comparison operators in wrapped expressions pos_compare = trail # ignore/lead/lead_break/lead_force/trail/trail_break/trail_force # The position of conditional (b ? t : f) operators in wrapped expressions pos_conditional = trail # ignore/lead/lead_break/lead_force/trail/trail_break/trail_force # The position of the comma in wrapped expressions pos_comma = trail # ignore/lead/lead_break/lead_force/trail/trail_break/trail_force # The position of the comma in the constructor initialization list pos_class_comma = trail # ignore/lead/lead_break/lead_force/trail/trail_break/trail_force # The position of colons between constructor and member initialization pos_class_colon = trail # ignore/lead/lead_break/lead_force/trail/trail_break/trail_force # # Line Splitting options # # Try to limit code width to N number of columns code_width = 80 # number # Whether to fully split long 'for' statements at semi-colons ls_for_split_full = false # false/true # Whether to fully split long function protos/calls at commas ls_func_split_full = false # false/true # # Blank line options # # The maximum consecutive newlines nl_max = 2 # number # The number of newlines after a function prototype, if followed by another function prototype nl_after_func_proto = 1 # number # The number of newlines after a function prototype, if not followed by another function prototype nl_after_func_proto_group = 2 # number # The number of newlines after '}' of a multi-line function body nl_after_func_body = 2 # number # The number of newlines after '}' of a single line function body nl_after_func_body_one_liner = 1 # number # The minimum number of newlines before a multi-line comment. # Doesn't apply if after a brace open or another multi-line comment. nl_before_block_comment = 2 # number # 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. nl_before_c_comment = 1 # number # The minimum number of newlines before a CPP comment. # Doesn't apply if after a brace open or other CPP comments. nl_before_cpp_comment = 1 # number # Whether to force a newline after a multi-line comment. nl_after_multiline_comment = false # false/true # The number of newlines before a 'private:', 'public:', 'protected:', 'signals:', or 'slots:' label. # Will not change the newline count if after a brace open. # 0 = No change. nl_before_access_spec = 2 # number # The number of newlines after a 'private:', 'public:', 'protected:', 'signals:', or 'slots:' label. # 0 = No change. nl_after_access_spec = 1 # number # The number of newlines between a function def and the function comment. # 0 = No change. nl_comment_func_def = 1 # number # The number of newlines after a try-catch-finally block that isn't followed by a brace close. # 0 = No change. nl_after_try_catch_finally = 1 # number # The number of newlines before and after a property, indexer or event decl. # 0 = No change. nl_around_cs_property = 1 # number # The number of newlines between the get/set/add/remove handlers in C#. # 0 = No change. nl_between_get_set = 1 # number # Whether to remove blank lines after '{' eat_blanks_after_open_brace = true # false/true # Whether to remove blank lines before '}' eat_blanks_before_close_brace = true # false/true # # Code modifying options (non-whitespace) # # Add or remove braces on single-line 'do' statement mod_full_brace_do = force # ignore/add/remove/force # Add or remove braces on single-line 'for' statement mod_full_brace_for = force # ignore/add/remove/force # Add or remove braces on single-line 'if' statement. Will not remove the braces if they contain an 'else'. mod_full_brace_if = add # ignore/add/remove/force # Make all if/elseif/else statements in a chain be braced or not. 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 # false/true # Don't remove braces around statements that span N newlines mod_full_brace_nl = 2 # number # Add or remove braces on single-line 'while' statement mod_full_brace_while = force # ignore/add/remove/force # Add or remove braces on single-line 'using ()' statement mod_full_brace_using = force # ignore/add/remove/force # Add or remove unnecessary paren on 'return' statement mod_paren_on_return = remove # ignore/add/remove/force # Whether to change optional semicolons to real semicolons mod_pawn_semicolon = false # false/true # Add parens on 'while' and 'if' statement around bools mod_full_paren_if_bool = true # false/true # Whether to remove superfluous semicolons mod_remove_extra_semicolon = true # false/true # 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_function_closebrace_comment = 0 # number # 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_switch_closebrace_comment = 0 # number # 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_endif_comment = 0 # number # 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_add_long_ifdef_else_comment = 0 # number # If TRUE, will sort consecutive single-line 'import' statements [Java, D] mod_sort_import = true # false/true # If TRUE, will sort consecutive single-line 'using' statements [C#] mod_sort_using = true # false/true # If TRUE, will sort consecutive single-line '#include' statements [C/C++] and '#import' statements [Obj-C] # This is generally a bad idea, as it may break your code. mod_sort_include = false # false/true # If TRUE, it will move a 'break' that appears after a fully braced 'case' before the close brace. mod_move_case_break = false # false/true # 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_case_brace = ignore # ignore/add/remove/force # If TRUE, it will remove a void 'return;' that appears as the last statement in a function. mod_remove_empty_return = true # false/true # # Comment modifications # # Try to wrap comments at cmt_width columns cmt_width = 80 # number # 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_reflow_mode = 1 # number # If false, disable all multi-line comment changes, including cmt_width. keyword substitution, and leading chars. # Default is true. cmt_indent_multi = true # false/true # Whether to group c-comments that look like they are in a block cmt_c_group = true # false/true # Whether to put an empty '/*' on the first line of the combined c-comment cmt_c_nl_start = true # false/true # Whether to put a newline before the closing '*/' of the combined c-comment cmt_c_nl_end = true # false/true # Whether to group cpp-comments that look like they are in a block cmt_cpp_group = true # false/true # Whether to put an empty '/*' on the first line of the combined cpp-comment cmt_cpp_nl_start = true # false/true # Whether to put a newline before the closing '*/' of the combined cpp-comment cmt_cpp_nl_end = true # false/true # Whether to change cpp-comments into c-comments cmt_cpp_to_c = false # false/true # Whether to put a star on subsequent comment lines cmt_star_cont = true # false/true # The number of spaces to insert at the start of subsequent comment lines cmt_sp_before_star_cont = 0 # number # The number of spaces to insert after the star on subsequent comment lines cmt_sp_after_star_cont = 0 # number # 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 cmt_multi_check_last = false # false/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 = "" # string # 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 = "" # string # 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 = "" # string # 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 = "" # string # The filename that contains text to insert before a Obj-C message specification if the method isn't preceeded 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 = "" # string # 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 # false/true # # Preprocessor options # # Control indent of preprocessors inside #if blocks at brace level 0 pp_indent = ignore # ignore/add/remove/force # Whether to indent #if/#else/#endif at the brace level (true) or from column 1 (false) pp_indent_at_level = false # false/true # If pp_indent_at_level=false, specifies the number of columns to indent per level. Default=1. pp_indent_count = 1 # number # Add or remove space after # based on pp_level of #if blocks pp_space = remove # ignore/add/remove/force # Sets the number of spaces added with pp_space pp_space_count = 1 # number # The indent for #region and #endregion in C# and '#pragma region' in C/C++ pp_indent_region = 0 # number # Whether to indent the code between #region and #endregion pp_region_indent_code = false # false/true # If pp_indent_at_level=true, sets the indent for #if, #else, and #endif when not at file-level pp_indent_if = 0 # number # Control whether to indent the code between #if, #else and #endif when not at file-level pp_if_indent_code = false # false/true # Whether to indent '#define' at the brace level (true) or from column 1 (false) pp_define_at_level = false # false/true # You can force a token to be a type with the 'type' option. # Example: # type myfoo1 myfoo2 # # You can create custom macro-based indentation using macro-open, # macro-else and macro-close. # Example: # macro-open BEGIN_TEMPLATE_MESSAGE_MAP # macro-open BEGIN_MESSAGE_MAP # macro-close END_MESSAGE_MAP # # You can assign any keyword to any type with the set option. # set func_call_user _ N_ # # The full syntax description of all custom definition config entries # is shown below: # # define custom tokens as: # - embed whitespace in token using '' escape character, or # put token in quotes # - these: ' " and ` are recognized as quote delimiters # # type token1 token2 token3 ... # ^ optionally specify multiple tokens on a single line # define def_token output_token # ^ output_token is optional, then NULL is assumed # macro-open token # macro-close token # macro-else token # set id token1 token2 ... # ^ optionally specify multiple tokens on a single line # ^ id is one of the names in token_enum.h sans the CT_ prefix, # e.g. PP_PRAGMA # # all tokens are separated by any mix of ',' commas, '=' equal signs # and whitespace (space, tab) # type byte cchar uchar ushort word uint ulong llong ullong type int8 uint8 int16 uint16 int32 uint32 int64 uint64 type BOOL BSTR BYTE CHAR DWORD DWORD64 DWORD_PTR FLOAT HANDLE HKEY HRESULT HWND type INT LONG LONG64 LONG_PTR type LPARAM LPSTR LPCSTR LPCWSTR LPTSTR LPVOID LPWSTR PSZ type SHORT UCHAR UINT UINT_PTR ULONG ULONG64 ULONG_PTR USHORT type WCHAR WORD WORD_PTR WPARAM ```

diff example after running on WaterRegionRenderer. Perhaps not perfect yet, but good. Anything here not correct? I can look in the config and try to adjust.

diff --git a/rabbit-escape-render/src/rabbitescape/render/WaterRegionRenderer.java b/rabbit-escape-render/src/rabbitescape/render/WaterRegionRenderer.java
index c503e67f..c58eced8 100644
--- a/rabbit-escape-render/src/rabbitescape/render/WaterRegionRenderer.java
+++ b/rabbit-escape-render/src/rabbitescape/render/WaterRegionRenderer.java
@@ -6,28 +6,27 @@ import java.util.List;

 import rabbitescape.engine.Block;
 import rabbitescape.engine.CellularDirection;
-import static rabbitescape.engine.CellularDirection.UP;
-import static rabbitescape.engine.CellularDirection.DOWN;
-import static rabbitescape.engine.CellularDirection.LEFT;
-import static rabbitescape.engine.CellularDirection.RIGHT;
 import rabbitescape.engine.Pipe;
-import rabbitescape.engine.Thing;
-import rabbitescape.engine.WaterRegion;
-import rabbitescape.engine.World;
 import rabbitescape.engine.textworld.BlockRenderer;
+import rabbitescape.engine.Thing;
 import rabbitescape.engine.util.CellDebugPrint;
 import rabbitescape.engine.util.LookupItem2D;
 import rabbitescape.engine.util.MathUtil;
 import rabbitescape.engine.util.Position;
 import rabbitescape.engine.util.WaterUtil;
+import rabbitescape.engine.WaterRegion;
+import rabbitescape.engine.World;
 import rabbitescape.render.gameloop.WaterAnimation;
+import static rabbitescape.engine.CellularDirection.DOWN;
+import static rabbitescape.engine.CellularDirection.LEFT;
+import static rabbitescape.engine.CellularDirection.RIGHT;
+import static rabbitescape.engine.CellularDirection.UP;

 import static rabbitescape.engine.BehaviourTools.*;
 import static rabbitescape.engine.CellularDirection.*;

 public class WaterRegionRenderer implements LookupItem2D
 {
-
     private static final int maxHeightChange = 1;

     public WaterRegion region;
@@ -38,13 +37,14 @@ public class WaterRegionRenderer implements LookupItem2D

     private int targetParticleCount = 0;
     private int particleCount = 0;
-    public final ArrayList<WaterParticle> particles = new ArrayList<WaterParticle>();                                                                            
+    public final ArrayList<WaterParticle> particles =
+        new ArrayList<WaterParticle>();

     private final World world;
     private final WaterAnimation waterAnimation;

-    public WaterRegionRenderer(WaterRegion region, World world,
-                               WaterAnimation waterAnimation )
+    public WaterRegionRenderer( WaterRegion region, World world,
+        WaterAnimation waterAnimation )
     {
         this.region = region;
         this.world = world;
@@ -53,7 +53,8 @@ public class WaterRegionRenderer implements LookupItem2D

     public WaterRegionRenderer adjacentRenderer( CellularDirection d )
     {
-        return waterAnimation.lookupRenderer.getItemAt( region.x + d.xOffset, region.y + d.yOffset );                                                            
+        return waterAnimation.lookupRenderer.getItemAt( region.x + d.xOffset,
+            region.y + d.yOffset );
     }

     public boolean adjacentIsNull( CellularDirection d )
@@ -64,6 +65,7 @@ public class WaterRegionRenderer implements LookupItem2D
     public boolean adjacentWaterIsFalling( CellularDirection d )
     {
         WaterRegionRenderer adj = adjacentRenderer( d );
+
         if ( null == adj )
         {
             return false;
@@ -88,7 +90,7 @@ public class WaterRegionRenderer implements LookupItem2D
         }
         targetParticleCount = 0;
         Block block = world.getBlockAt( region.x, region.y );
-        if ( null == block || isBridge( block ))
+        if ( ( null == block ) || isBridge( block ) )
         {
             targetWaterHeight = region.getContents() / 32;
         }
@@ -109,19 +111,20 @@ public class WaterRegionRenderer implements LookupItem2D
      */
     private void adjustParticleCount()
     {
-        targetParticleCount = region.getContents() / waterAnimation.contentsPerParticle;                                                                         
-        int particleDeficit = targetParticleCount  - particles.size();
-        if ( particleDeficit < 0 ) // Need to remove some: start fading
+        targetParticleCount = region.getContents() /
+            waterAnimation.contentsPerParticle;
+        int particleDeficit = targetParticleCount - particles.size();
+        if ( particleDeficit < 0 )      // Need to remove some: start fading
         {
-            for ( int i = 0 ; i < -particleDeficit ; i++)
+            for ( int i = 0; i < -particleDeficit; i++ )
             {
                 WaterParticle p = particles.get( i );
                 p.alphaStep = -p.alphaStepMagnitude;
             }
         }
-        else if (particleDeficit > 0 ) // Need to add some
+        else if ( particleDeficit > 0 ) // Need to add some
         {
-            for ( int i = 0 ; i < particleDeficit ; i++)
+            for ( int i = 0; i < particleDeficit; i++ )
             {
                 particles.add( new WaterParticle( this ) );
             }
@@ -135,8 +138,8 @@ public class WaterRegionRenderer implements LookupItem2D
     public void setWaterHeight()
     {
         height = MathUtil.constrain( targetWaterHeight,
-                                     lastHeight - maxHeightChange ,
-                                     lastHeight + maxHeightChange );
+                lastHeight - maxHeightChange,
+                lastHeight + maxHeightChange );
         lastHeight = height;
     }

@@ -147,20 +150,20 @@ public class WaterRegionRenderer implements LookupItem2D
     private void checkParticlesInRegion()
     {
         // make temporary list to iterate, so we can transfer ownership of items
-        for ( WaterParticle p : new ArrayList<WaterParticle>(particles) )
+        for ( WaterParticle p : new ArrayList<WaterParticle>( particles ) )
         {
             if ( p.outOfRegion( this ) )
             {
-                WaterRegionRenderer newRend = p.rendererByPosition( waterAnimation );                                                                            
-                if ( newRend == null )
-                { // no water here: accelerate fading
+                WaterRegionRenderer newRend = p.rendererByPosition(
+                        waterAnimation );
+                if ( newRend == null )  // no water here: accelerate fading
+                {
                     p.alphaStep = p.alphaStep - p.alphaStepMagnitude;
                     continue;
                 }
-                if ( isFull( newRend.region.x, newRend.region.y ) )
-                {   // particle has moved to full cell: delete immediately
-                    // block cells count as full too
-                    particles.remove(p);
+                if ( isFull( newRend.region.x, newRend.region.y ) )     // particle has moved to full cell: delete immediately                                   
+                {                       // block cells count as full too
+                    particles.remove( p );
                     continue;
                 }
                 // transfer ownership to other renderer
@@ -170,18 +173,19 @@ public class WaterRegionRenderer implements LookupItem2D
         }
         // now particles are in the correct cell remove those that have
         // fallen below the water level.
-        for ( WaterParticle p : new ArrayList<WaterParticle>(particles) )
+        for ( WaterParticle p : new ArrayList<WaterParticle>( particles ) )
         {
             WaterRegionRenderer r = p.rendererByPosition( waterAnimation );
-            if ( r == null )
-            { // particle is not in a cell with a renderer:leave it
+            if ( r == null )            // particle is not in a cell with a renderer:leave it                                                                    
+            {
                 continue;
             }
             // convert to nominal pixels (32 in a cell)
-            int heightInCell = (int)( (1.0f + Math.floor(p.y) - p.y) * 32.0f );
-            if ( heightInCell < r.targetWaterHeight )
-            { // below water level: delete immediately
-                particles.remove(p);
+            int heightInCell =
+                (int)( ( 1.0f + Math.floor( p.y ) - p.y ) * 32.0f );
+            if ( heightInCell < r.targetWaterHeight )   // below water level: delete immediately                                                                 
+            {
+                particles.remove( p );
             }
         }
     }
@@ -193,7 +197,6 @@ public class WaterRegionRenderer implements LookupItem2D
     {
         // Some particles may have left the region: update this first.
         checkParticlesInRegion();
-
         for ( WaterParticle p : particles )
         {
             p.step();
@@ -224,6 +227,7 @@ public class WaterRegionRenderer implements LookupItem2D
     public void removeHeightGaps()
     {
         WaterRegionRenderer above = adjacentRenderer( CellularDirection.UP );
+
         if ( null == above )
         {
             return;
@@ -249,30 +253,34 @@ public class WaterRegionRenderer implements LookupItem2D
      */
     public Vertex topVertex( CellPosition d )
     {
-        int x = region.x * 32, y = region.y * 32; // Local cell origin in nominal pixels.                                                                        
+        int x = region.x * 32, y = region.y * 32;       // Local cell origin in nominal pixels.                                                                  
+
         if ( 0 == height )
         {
             switch ( d )
             {
             case TOP_LEFT:
                 return new Vertex( x, y + 32 );
+
             case TOP_MIDDLE:
                 return new Vertex( x + 16, y + 32 );
+
             case TOP_RIGHT:
                 return new Vertex( x + 32, y + 32 );
+
             default:
-                throw new RuntimeException( "Can only add vertices for TOP_LEFT, TOP_MIDDLE or TOP_RIGHT cells.");                                               
+                throw new RuntimeException(
+                    "Can only add vertices for TOP_LEFT, TOP_MIDDLE or TOP_RIGHT cells." );                                                                      
             }
         }
-        Block block = world.getBlockAt( region.x, region.y );
-        int boundaryHeight = calcBoundaryHeight( d );
-        int xOffset, yOffset;
-
+        Block  block = world.getBlockAt( region.x, region.y );
+        int    boundaryHeight = calcBoundaryHeight( d );
+        int    xOffset, yOffset;
         switch ( d )
         {
         case TOP_LEFT:
             xOffset = 0;
-            if ( shapeEquals ( block, Block.Shape.UP_LEFT ) )
+            if ( shapeEquals( block, Block.Shape.UP_LEFT ) )
             {
                 yOffset = 0;
             }
@@ -281,9 +289,12 @@ public class WaterRegionRenderer implements LookupItem2D
                 yOffset = 32 - boundaryHeight;
             }
             break;
+
         case TOP_MIDDLE:
             xOffset = 16;
-            if ( shapeEquals ( block, Block.Shape.UP_LEFT ) || shapeEquals ( block, Block.Shape.UP_RIGHT ) )                                                     
+            if ( shapeEquals( block,
+                     Block.Shape.UP_LEFT ) ||
+                 shapeEquals( block, Block.Shape.UP_RIGHT ) )
             {
                 yOffset = ( 32 - height ) / 2;
             }
@@ -292,9 +303,10 @@ public class WaterRegionRenderer implements LookupItem2D
                 yOffset = 32 - height;
             }
             break;
+
         case TOP_RIGHT:
             xOffset = 32;
-            if ( shapeEquals ( block, Block.Shape.UP_RIGHT ) )
+            if ( shapeEquals( block, Block.Shape.UP_RIGHT ) )
             {
                 yOffset = 0;
             }
@@ -303,8 +315,10 @@ public class WaterRegionRenderer implements LookupItem2D
                 yOffset = 32 - boundaryHeight;
             }
             break;
+
         default:
-            throw new RuntimeException( "Can only add vertices for LEFT or RIGHT cells." );                                                                      
+            throw new RuntimeException(
+                "Can only add vertices for LEFT or RIGHT cells." );
         }
         return new Vertex( x + xOffset, y + yOffset );
     }
@@ -316,7 +330,7 @@ public class WaterRegionRenderer implements LookupItem2D
     {
         if ( region.isConnected( d ) )
         {
-            WaterRegionRenderer wrr = adjacentRenderer ( d );
+            WaterRegionRenderer wrr = adjacentRenderer( d );
             if ( null == wrr )
             {
                 return height;
@@ -328,17 +342,24 @@ public class WaterRegionRenderer implements LookupItem2D

     private int calcBoundaryHeight( CellPosition cellPosition )
     {
-        if ( cellPosition.leftRightness == null || !region.isConnected( cellPosition.leftRightness ) || isFull( region.x, region.y ) )                           
-        { // The cell in that direction is not relevant
+        if ( ( cellPosition.leftRightness == null ) ||
+             !region.isConnected( cellPosition.leftRightness ) ||
+             isFull( region.x, region.y ) )     // The cell in that direction is not relevant                                                                    
+        {
             return height;
         }
-        WaterRegionRenderer adjWrr = adjacentRenderer( cellPosition.leftRightness );                                                                             
-        if ( null == adjWrr )
-        { // Adjacent is probably empty, and this cell is probably a low level
+        WaterRegionRenderer adjWrr =
+            adjacentRenderer( cellPosition.leftRightness );
+        if ( null == adjWrr )           // Adjacent is probably empty, and this cell is probably a low level                                                     
+        {
             if ( region.isConnected( cellPosition.leftRightness ) )
             {
-                WaterRegion adjReg = world.waterTable.getItemAt( region.x + cellPosition.leftRightness.xOffset, region.y + cellPosition.leftRightness.yOffset ); 
-                if ( adjReg != null && adjReg.isConnected( CellularDirection.opposite( cellPosition.leftRightness ) ) )                                          
+                WaterRegion adjReg = world.waterTable.getItemAt(
+                        region.x + cellPosition.leftRightness.xOffset,
+                        region.y + cellPosition.leftRightness.yOffset );
+                if ( adjReg !=
+                     null && adjReg.isConnected( CellularDirection.opposite(
+                             cellPosition.leftRightness ) ) )
                 {
                     return 0;
                 }
@@ -354,13 +375,14 @@ public class WaterRegionRenderer implements LookupItem2D

     public Vertex bottomVertex( CellPosition d )
     {
-        int x = region.x * 32, y = region.y * 32; // Local cell origin in nominal pixels.                                                                        
-        int xOffset;
-        Block block = world.getBlockAt( region.x, region.y );
+        int    x = region.x * 32, y = region.y * 32;   // Local cell origin in nominal pixels.                                                                   
+        int    xOffset;
+        Block  block = world.getBlockAt( region.x, region.y );
+
         switch ( d )
         {
         case BOTTOM_LEFT:
-            if ( shapeEquals ( block, Block.Shape.UP_LEFT ) )
+            if ( shapeEquals( block, Block.Shape.UP_LEFT ) )
             {
                 xOffset = 32;
             }
@@ -369,8 +391,9 @@ public class WaterRegionRenderer implements LookupItem2D
                 xOffset = 0;
             }
             break;
+
         case BOTTOM_RIGHT:
-            if ( shapeEquals ( block, Block.Shape.UP_RIGHT ) )
+            if ( shapeEquals( block, Block.Shape.UP_RIGHT ) )
             {
                 xOffset = 0;
             }
@@ -379,32 +402,35 @@ public class WaterRegionRenderer implements LookupItem2D
                 xOffset = 32;
             }
             break;
+
         default:
-            throw new RuntimeException( "Can only add bottom vertices for BOTTOM_LEFT or BOTTOM_RIGHT cells." );                                                 
+            throw new RuntimeException(
+                "Can only add bottom vertices for BOTTOM_LEFT or BOTTOM_RIGHT cells." );                                                                         
         }
         return new Vertex( x + xOffset, y + 32 );
     }

     boolean isFalling()
     {
-        if ( isSlopeNotBridge( world.getBlockAt( region.x, region.y ) ) )
-        { // Non bridge slopes are not connected down.
+        if ( isSlopeNotBridge( world.getBlockAt( region.x, region.y ) ) )       // Non bridge slopes are not connected down.                                     
+        {
             return false;
         }
-
         return !isFull( region.x, region.y + 1 );
     }

     boolean isFull( int x, int y )
     {
         Block b = world.getBlockAt( x, y );
-        if ( s_isFlat( b ) )
-        { // Flat block cells have zero capacity: always full.
+
+        if ( s_isFlat( b ) )            // Flat block cells have zero capacity: always full.                                                                     
+        {
             return true;
         }
-        WaterRegionRenderer wrr = waterAnimation.lookupRenderer.getItemAt( x, y );                                                                               
-        if ( null == wrr )
-        { // Not full of flat block, but no region yet, empty
+        WaterRegionRenderer wrr =
+            waterAnimation.lookupRenderer.getItemAt( x, y );
+        if ( null == wrr )              // Not full of flat block, but no region yet, empty                                                                      
+        {
             return false;
         }
         return 32 == wrr.height && 32 == wrr.targetWaterHeight;
@@ -416,12 +442,13 @@ public class WaterRegionRenderer implements LookupItem2D
      */
     public int backShadeAlpha()
     {
-        Block b = world.getBlockAt( region.x, region.y );
+        Block  b = world.getBlockAt( region.x, region.y );
         // slope cells are half full of block to start with
-        int baselineContent =  isSlopeNotBridge( b ) ?
-                               WaterUtil.HALF_CAPACITY : 0;
-        int alpha = 255 * ( baselineContent + region.getContents() ) /
-                    WaterUtil.MAX_CAPACITY;
+        int    baselineContent = isSlopeNotBridge( b ) ?
+            WaterUtil.HALF_CAPACITY : 0;
+        int    alpha = 255 * ( baselineContent + region.getContents() ) /
+            WaterUtil.MAX_CAPACITY;
+
         // divide by 4 to tame it, as particles and polygons should show
         // the same thing.
         return MathUtil.constrain( alpha, 0, 255 ) / 4;
@@ -448,6 +475,7 @@ public class WaterRegionRenderer implements LookupItem2D
     public int edgeNetFlow( CellularDirection edge )
     {
         WaterRegionRenderer adj = adjacentRenderer( edge );
+
         if ( null == adj )
         {
             return region.getFlow( edge );
@@ -458,10 +486,11 @@ public class WaterRegionRenderer implements LookupItem2D

     public Vertex netFlow()
     {
-        float netX = (float)( edgeNetFlow( CellularDirection.RIGHT ) -
-                              edgeNetFlow( CellularDirection.LEFT ) );
-        float netY = (float)( edgeNetFlow( CellularDirection.DOWN ) -
-                              edgeNetFlow( CellularDirection.UP ) );
+        float  netX = (float)( edgeNetFlow( CellularDirection.RIGHT ) -
+                                edgeNetFlow( CellularDirection.LEFT ) );
+        float  netY = (float)( edgeNetFlow( CellularDirection.DOWN ) -
+                                edgeNetFlow( CellularDirection.UP ) );
+
         return new Vertex( netX, netY );
     }

@@ -478,33 +507,33 @@ public class WaterRegionRenderer implements LookupItem2D

     public void debugCellPrint( CellDebugPrint p )
     {
-        Block b = world.getBlockAt( region.x, region.y );
-        String s = null == b ? " " : "" + BlockRenderer.charForBlock( b );
+        Block  b = world.getBlockAt( region.x, region.y );
+        String s = null == b ? " " : "" + BlockRenderer.charForBlock( b );

-        String connStr = "U" + bool01( region.isConnected( UP ) ) + " " +
-                         "D" + bool01( region.isConnected( DOWN ) ) + " " +
-                         "L" + bool01( region.isConnected( LEFT ) ) + " " +
-                         "R" + bool01( region.isConnected( RIGHT ) );
+        String connStr = "U" + bool01( region.isConnected( UP ) ) + " " +
+            "D" + bool01( region.isConnected( DOWN ) ) + " " +
+            "L" + bool01( region.isConnected( LEFT ) ) + " " +
+            "R" + bool01( region.isConnected( RIGHT ) );

         p.addString( region.x, region.y, 0,
-            s  );
+            s );

         p.addString( region, 1, "cont %04d", region.getContents() );

-        p.addString( region, 4, connStr  );
+        p.addString( region, 4, connStr );

         p.addString( region, 5,
-            "falling" + bool01( isFalling() ) + " full" + isFull( region.x, region.y )  );
+            "falling" + bool01( isFalling() ) + " full" +
+            isFull( region.x, region.y ) );

-        p.addString( region, 6, "height(targ) %02d(%02d)", height, targetWaterHeight );
+        p.addString( region, 6, "height(targ) %02d(%02d)", height,
+            targetWaterHeight );

-        p.addString(  region, 7, "(%d,%d)", region.x, region.y );
+        p.addString( region, 7, "(%d,%d)", region.x, region.y );
     }

     private String bool01( boolean b )
     {
         return b ? "1" : "0";
     }
-
-
 }

[andybalaam]

Point of information: I fought uncrustify for quite a while once, before giving up on it :-(

[colonelfazackerley]

What details made you give up? It seems to do spaces lining parentheses OK, and braces. Sorting long lines is tricky, but I am surprised that you prefer to change style completely to Google instead.

[andybalaam]

It's philosophical really: I want a tool that entirely removes the human element from the layout, so there can be no disagreement or noisy diffs. The Google tool is closer to that (although it still allows more freedom than I would like).

If uncrustify gives us more consistent formatting than we have now in the same style, I would be happy with integrating it.

[colonelfazackerley]

In uncrustify many check items can be configured to 'ignore', so it doesn't make changes resulting in noisy diffs. We can get it to fix some hefty fraction of style deviations automatically. Is this an approach you tried?

I think it should help to give a more consistent style.

[andybalaam]

Go for it, don't listen to my stop energy.