de.unkrig.cscontrib.checks.ParenPad 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 java.util.Locale;
import java.util.regex.Pattern;

import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.checks.whitespace.PadOption;
import com.puppycrawl.tools.checkstyle.checks.whitespace.ParenPadCheck;

import de.unkrig.commons.nullanalysis.NotNullByDefault;
import de.unkrig.cscontrib.compat.Cs820;
import de.unkrig.csdoclet.annotation.Message;
import de.unkrig.csdoclet.annotation.Rule;
import de.unkrig.csdoclet.annotation.SingleSelectRuleProperty;

/**
 * Enhanced version of "ParenPad": NOSPACE now allows C++ comments after the openining parenthesis.
 * 
 *   This check is superseded by {@code de.unkrig.Whitespace}.
 * 
 */
@Rule(
    group     = "%Whitespace.group",
    groupName = "Whitespace",
    name      = "de.unkrig: Parenthesis padding",
    parent    = "TreeWalker"
)
@NotNullByDefault(false) public
class ParenPad extends ParenPadCheck {

    @Message("''{0}'' is followed by whitespace")
    private static final String
    MESSAGE_KEY_FOLLOWED_BY_WHITESPACE = "ParenPad.followedByWhitespace";

    @Message("''{0}'' is not followed by whitespace")
    private static final String
    MESSAGE_KEY_NOT_FOLLOWED_BY_WHITESPACE = "ParenPad.notFollowedByWhitespace";

    private static final Pattern NOSPACE_PATTERN = Pattern.compile(
        "[^\\s].*"   // '(' + non-space
        + "|"
        + "\\s*//.*" // '(' + space + end-of-line-comment
        + "|"
        + ""         // '(' + line-break
    );
    private static final Pattern SPACE_PATTERN = Pattern.compile(
        "\\s.*"    // '(' + Space
        + "|"
        + "\\).*"  // '(' + ')'
        + "|"
        + ""       // '(' + line-break
    );

    private PadOption option;

    /**
     * Whether space is required or forbidden.
     */
    @SingleSelectRuleProperty(optionProvider = PadOption.class, defaultValue = "nospace")
    @Override public void
    setOption(String option) {

        try {
          this.option = PadOption.valueOf(option.trim().toUpperCase(Locale.ENGLISH));
        } catch (IllegalArgumentException iae) {
          throw new IllegalArgumentException("unable to parse " + option, iae);
        }

        super.setOption(option);
    }

    @Override protected void
    processLeft(DetailAST ast) {
        final String line  = this.getLines()[Cs820.getLineNo(ast) - 1];
        final int    after = Cs820.getColumnNo(ast) + 1;

        String rest = line.substring(after);
        if (
            this.option == PadOption.NOSPACE
            && !ParenPad.NOSPACE_PATTERN.matcher(rest).matches()
        ) {
            this.log(Cs820.getLineNo(ast), after, ParenPad.MESSAGE_KEY_FOLLOWED_BY_WHITESPACE, "(");
        } else if (
            this.option == PadOption.SPACE
            && !ParenPad.SPACE_PATTERN.matcher(rest).matches()
        ) {
            this.log(Cs820.getLineNo(ast), after, ParenPad.MESSAGE_KEY_NOT_FOLLOWED_BY_WHITESPACE, "(");
        }
    }
}