001////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code for adherence to a set of rules.
003// Copyright (C) 2001-2017 the original author or authors.
004//
005// This library is free software; you can redistribute it and/or
006// modify it under the terms of the GNU Lesser General Public
007// License as published by the Free Software Foundation; either
008// version 2.1 of the License, or (at your option) any later version.
009//
010// This library is distributed in the hope that it will be useful,
011// but WITHOUT ANY WARRANTY; without even the implied warranty of
012// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
013// Lesser General Public License for more details.
014//
015// You should have received a copy of the GNU Lesser General Public
016// License along with this library; if not, write to the Free Software
017// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
018////////////////////////////////////////////////////////////////////////////////
019
020package com.puppycrawl.tools.checkstyle.checks.coding;
021
022import com.puppycrawl.tools.checkstyle.StatelessCheck;
023import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
024import com.puppycrawl.tools.checkstyle.api.DetailAST;
025import com.puppycrawl.tools.checkstyle.api.TokenTypes;
026
027/**
028 * <p>
029 * Checks for overly complicated boolean expressions. Currently finds code like
030 * {@code if (b == true)}, {@code b || true}, {@code !false},
031 * etc.
032 * </p>
033 * <p>
034 * Rationale: Complex boolean logic makes code hard to understand and maintain.
035 * </p>
036 * <p>
037 * An example of how to configure the check is:
038 * </p>
039 * <pre>
040 * &lt;module name="SimplifyBooleanExpression"/&gt;
041 * </pre>
042 * @author lkuehne
043 */
044@StatelessCheck
045public class SimplifyBooleanExpressionCheck
046        extends AbstractCheck {
047
048    /**
049     * A key is pointing to the warning message text in "messages.properties"
050     * file.
051     */
052    public static final String MSG_KEY = "simplify.expression";
053
054    @Override
055    public int[] getDefaultTokens() {
056        return getRequiredTokens();
057    }
058
059    @Override
060    public int[] getAcceptableTokens() {
061        return getRequiredTokens();
062    }
063
064    @Override
065    public int[] getRequiredTokens() {
066        return new int[] {TokenTypes.LITERAL_TRUE, TokenTypes.LITERAL_FALSE};
067    }
068
069    @Override
070    public void visitToken(DetailAST ast) {
071        final DetailAST parent = ast.getParent();
072        switch (parent.getType()) {
073            case TokenTypes.NOT_EQUAL:
074            case TokenTypes.EQUAL:
075            case TokenTypes.LNOT:
076            case TokenTypes.LOR:
077            case TokenTypes.LAND:
078                log(parent.getLineNo(), parent.getColumnNo(),
079                    MSG_KEY);
080                break;
081            default:
082                break;
083        }
084    }
085}