de.unkrig.cscontrib.checks.WrapMethodCheck Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cs-contrib Show documentation
This version works with most CheckStyle versions up to and including 8.20, but not with later CS versions, because they unintentionally made a breaking change in version 8.21 (class DetailAst was changed to an interface).
The newest version!

/*
 * de.unkrig.cs-contrib - Additional checks, filters and quickfixes for CheckStyle and Eclipse-CS
 *
 * Copyright (c) 2013, Arno Unkrig
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
 * following conditions are met:
 *
 *    1. Redistributions of source code must retain the above copyright notice, this list of conditions and the
 *       following disclaimer.
 *    2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
 *       following disclaimer in the documentation and/or other materials provided with the distribution.
 *    3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote
 *       products derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package de.unkrig.cscontrib.checks;

import static de.unkrig.cscontrib.LocalTokenType.*;
import static de.unkrig.cscontrib.checks.AbstractWrapCheck.Control.*;

import com.puppycrawl.tools.checkstyle.api.DetailAST;

import de.unkrig.commons.nullanalysis.NotNullByDefault;
import de.unkrig.cscontrib.LocalTokenType;
import de.unkrig.cscontrib.compat.Cs820;
import de.unkrig.cscontrib.util.AstUtil;
import de.unkrig.csdoclet.annotation.BooleanRuleProperty;
import de.unkrig.csdoclet.annotation.Rule;
import de.unkrig.csdoclet.annotation.SingleSelectRuleProperty;

/**
 * Verifies that method declarations, parameters and call arguments are uniformly wrapped and indented.
 * 
 *   The phrase "wrap before X" means that a line break and spaces appear right before "X", such that "X" is vertically
 *   aligned with the first token in the immediately preceding line.
 * 
 */
@Rule(
    group      = "%Whitespace.group",
    groupName  = "Whitespace",
    name       = "de.unkrig: Wrap method",
    parent     = "TreeWalker",
    quickfixes = {
		"de.unkrig.cscontrib.ui.quickfixes.WrapAndIndent1",
		"de.unkrig.cscontrib.ui.quickfixes.WrapAndIndent2",
		"de.unkrig.cscontrib.ui.quickfixes.WrapAndIndent3",
	}
)
@NotNullByDefault(false) public
class WrapMethodCheck extends AbstractWrapCheck {

    // ============================================= BEGIN CONFIGURATION =============================================

    /**
     * Whether to allow a complete method declaration in one single line. Example:
     *      * private void meth() { ... }
     * 
     */
    @BooleanRuleProperty(defaultValue = WrapMethodCheck.DEFAULT_ALLOW_ONE_LINE_DECL)
    public void
    setAllowOneLineDecl(boolean value) { this.allowOneLineDecl = value; }

    private boolean
    allowOneLineDecl = WrapMethodCheck.DEFAULT_ALLOW_ONE_LINE_DECL;

    private static final boolean
    DEFAULT_ALLOW_ONE_LINE_DECL = true;

    /**
     * Whether to wrap method declarations between the return type and the method name. Example:
     *      * private static
     * myMeth(int arg1) {
     * 
     */
    @SingleSelectRuleProperty(
        optionProvider = Wrap.class,
        defaultValue   = WrapMethodCheck.DEFAULT_WRAP_DECL_BEFORE_NAME
    ) public void
    setWrapDeclBeforeName(String value) { this.wrapDeclBeforeName = AbstractWrapCheck.toWrap(value); }

    private Control
    wrapDeclBeforeName = AbstractWrapCheck.toWrap(WrapMethodCheck.DEFAULT_WRAP_DECL_BEFORE_NAME);

    private static final String
    DEFAULT_WRAP_DECL_BEFORE_NAME = "always";

    /**
     * Whether to wrap method declarations before the opening curly brace. Example:
     *      * private static myMeth(int arg1)
     * {
     * 
     */
    @SingleSelectRuleProperty(
        optionProvider = Wrap.class,
        defaultValue   = WrapMethodCheck.DEFAULT_WRAP_DECL_BEFORE_LCURLY
    ) public void
    setWrapMethodDeclBeforeLCurly(String value) { this.wrapDeclBeforeLCurly = AbstractWrapCheck.toWrap(value); }

    private Control
    wrapDeclBeforeLCurly = AbstractWrapCheck.toWrap(WrapMethodCheck.DEFAULT_WRAP_DECL_BEFORE_LCURLY);

    private static final String
    DEFAULT_WRAP_DECL_BEFORE_LCURLY = "never";

    /**
     * Whether multiple method call arguments in one line are allowed.
     */
    @BooleanRuleProperty(defaultValue = WrapMethodCheck.DEFAULT_ALLOW_MULTIPLE_ARGS_PER_LINE)
    public void
    setAllowMultipleArgsPerLine(boolean value) { this.allowMultipleArgsPerLine = value; }

    private boolean
    allowMultipleArgsPerLine = WrapMethodCheck.DEFAULT_ALLOW_MULTIPLE_ARGS_PER_LINE;

    private static final boolean
    DEFAULT_ALLOW_MULTIPLE_ARGS_PER_LINE = false;

    /**
     * Whether multiple method parameter declarations in one line are allowed.
     */
    @BooleanRuleProperty(defaultValue = WrapMethodCheck.DEFAULT_ALLOW_MULTIPLE_PARAMETERS_PER_LINE)
    public void
    setAllowMultipleParametersPerLine(boolean value) { this.allowMultipleParametersPerLine = value; }

    private boolean
    allowMultipleParametersPerLine = WrapMethodCheck.DEFAULT_ALLOW_MULTIPLE_PARAMETERS_PER_LINE;

    private static final boolean
    DEFAULT_ALLOW_MULTIPLE_PARAMETERS_PER_LINE = false;

    // ============================================= END CONFIGURATION =============================================

    @Override public int[]
    getAcceptableTokens() {
        return LocalTokenType.delocalize(
            new LocalTokenType[] { LocalTokenType.METHOD_DEF, LocalTokenType.PARAMETERS, LocalTokenType.ELIST }
        );
    }

    @Override public int[]
    getDefaultTokens() { return this.getAcceptableTokens(); }

    @Override public int[]
    getRequiredTokens() { return this.getAcceptableTokens(); }

    @Override public void
    visitToken(DetailAST ast) {
        assert ast != null;

        @SuppressWarnings("unused") AstDumper astDumper = new AstDumper(ast);

        switch (LocalTokenType.localize(Cs820.getType(ast))) {

        case METHOD_DEF:
            if (this.allowOneLineDecl && AbstractWrapCheck.isSingleLine(ast)) return;

            // SUPPRESS CHECKSTYLE WrapMethod:6
            this.checkChildren(
                ast,
                MODIFIERS, FORK1, TYPE_PARAMETERS,
                LABEL1, TYPE, this.wrapDeclBeforeName, IDENT, LPAREN, INDENT_IF_CHILDREN, PARAMETERS, UNINDENT, RPAREN, FORK2, MAY_WRAP, LITERAL_THROWS, // SUPPRESS CHECKSTYLE LineLength
                LABEL2, FORK3, this.wrapDeclBeforeLCurly, SLIST, END,
                LABEL3, SEMI, END
            );
            break;

        case PARAMETERS:

            // SUPPRESS CHECKSTYLE WrapMethod:6
            this.checkChildren(
                ast,
                FORK2, MAY_INDENT, PARAMETER_DEF, FORK2,
                LABEL1, LocalTokenType.COMMA, MAY_INDENT, PARAMETER_DEF, FORK1,
                LABEL2, END
            );
            break;

        case ELIST:

            // SUPPRESS CHECKSTYLE WrapMethod:8
            this.checkChildren(
                ast,
                FORK4,
                FORK1, MAY_INDENT, EXPR, FORK4, BRANCH2,
                LABEL1, MAY_INDENT, LAMBDA, FORK4,
                LABEL2, COMMA, FORK3, MAY_INDENT, EXPR, FORK2, END,
                LABEL3, MAY_INDENT, LAMBDA, FORK2,
                LABEL4, END
            );
            break;

        default:
            throw new IllegalArgumentException(Integer.toString(Cs820.getType(ast)));
        }
    }

    @Override protected boolean
    checkMultipleElementsPerLine(DetailAST child) {

        if (
            AstUtil.grandParentTypeIs(child, LocalTokenType.METHOD_CALL)
            && !this.allowMultipleArgsPerLine
        ) return false;

        if (
            AstUtil.parentTypeIs(child, LocalTokenType.PARAMETERS)
            && AstUtil.grandParentTypeIs(child, LocalTokenType.METHOD_DEF)
            && !this.allowMultipleParametersPerLine
        ) return false;

        return true;
    }
}