001///////////////////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code and other text files for adherence to a set of rules.
003// Copyright (C) 2001-2024 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.indentation;
021
022import com.puppycrawl.tools.checkstyle.api.DetailAST;
023import com.puppycrawl.tools.checkstyle.api.TokenTypes;
024
025/**
026 * Handler for do...while blocks.
027 *
028 */
029public class DoWhileHandler extends BlockParentHandler {
030
031    /**
032     * Construct an instance of this handler with the given indentation check,
033     * abstract syntax tree, and parent handler.
034     *
035     * @param indentCheck   the indentation check
036     * @param ast           the abstract syntax tree
037     * @param parent        the parent handler
038     */
039    public DoWhileHandler(IndentationCheck indentCheck,
040            DetailAST ast, AbstractExpressionHandler parent) {
041        super(indentCheck, "do..while", ast, parent);
042    }
043
044    /**
045     * Check the indentation level of the while and conditional expression.
046     */
047    private void checkWhileExpr() {
048        // check while statement alone
049
050        final DetailAST whileAst = getMainAst().findFirstToken(TokenTypes.DO_WHILE);
051
052        if (isOnStartOfLine(whileAst)
053                && !getIndent().isAcceptable(expandedTabsColumnNo(whileAst))) {
054            logError(whileAst, "while", expandedTabsColumnNo(whileAst));
055        }
056
057        // check condition alone
058
059        final DetailAST condAst = getMainAst().findFirstToken(TokenTypes.LPAREN).getNextSibling();
060
061        checkExpressionSubtree(condAst, getIndent(), false, false);
062    }
063
064    @Override
065    protected DetailAST getNonListChild() {
066        return getMainAst().getFirstChild();
067    }
068
069    @Override
070    public void checkIndentation() {
071        super.checkIndentation();
072        checkWhileExpr();
073    }
074
075}