001///////////////////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code and other text files for adherence to a set of rules.
003// Copyright (C) 2001-2026 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;
026import com.puppycrawl.tools.checkstyle.utils.TokenUtil;
027
028/**
029 * <div>
030 * Checks for over-complicated boolean expressions. Currently, it finds code like
031 * {@code if (b == true)}, {@code b || true}, {@code !false},
032 * {@code boolean a = q > 12 ? true : false},
033 * etc.
034 * </div>
035 *
036 * <p>
037 * Rationale: Complex boolean logic makes code hard to understand and maintain.
038 * </p>
039 *
040 * @since 3.0
041 */
042@StatelessCheck
043public class SimplifyBooleanExpressionCheck extends AbstractCheck {
044
045    /**
046     * A key is pointing to the warning message text in "messages.properties" file.
047     */
048    public static final String MSG_KEY = "simplify.expression";
049
050    /**
051     * Creates a new {@code SimplifyBooleanExpressionCheck} instance.
052     */
053    public SimplifyBooleanExpressionCheck() {
054        // no code by default
055    }
056
057    @Override
058    public int[] getDefaultTokens() {
059        return getRequiredTokens();
060    }
061
062    @Override
063    public int[] getAcceptableTokens() {
064        return getRequiredTokens();
065    }
066
067    @Override
068    public int[] getRequiredTokens() {
069        return new int[] {TokenTypes.LITERAL_TRUE, TokenTypes.LITERAL_FALSE};
070    }
071
072    @Override
073    public void visitToken(DetailAST ast) {
074        final DetailAST parent = ast.getParent();
075        switch (parent.getType()) {
076            case TokenTypes.NOT_EQUAL,
077                 TokenTypes.EQUAL,
078                 TokenTypes.LNOT,
079                 TokenTypes.LOR,
080                 TokenTypes.LAND -> log(parent, MSG_KEY);
081
082            case TokenTypes.QUESTION -> {
083                final DetailAST firstChild = skipParentheses(parent.getFirstChild());
084                final DetailAST nextSibling = skipParentheses(ast.getNextSibling());
085                if (TokenUtil.isBooleanLiteralType(firstChild.getType())
086                        || nextSibling != null
087                        && TokenUtil.isBooleanLiteralType(
088                                skipParentheses(nextSibling.getNextSibling()).getType())) {
089                    log(parent, MSG_KEY);
090                }
091            }
092
093            default -> {
094                // do nothing
095            }
096        }
097    }
098
099    /**
100     * Iterates sibling nodes, skipping parentheses.
101     *
102     * @param node The starting node.
103     * @return The first sibling not of type {@code TokenTypes.LPAREN} or
104     *     {@code TokenTypes.RPAREN}, or {@code null} if no such node exists.
105     */
106    private static DetailAST skipParentheses(DetailAST node) {
107        DetailAST result = node;
108        while (TokenUtil.isOfType(result, TokenTypes.LPAREN, TokenTypes.RPAREN)) {
109            result = result.getNextSibling();
110        }
111        return result;
112    }
113
114}