001////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code for adherence to a set of rules.
003// Copyright (C) 2001-2018 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 for loops.
027 *
028 * @author jrichard
029 */
030public class ForHandler extends BlockParentHandler {
031
032    /**
033     * Construct an instance of this handler with the given indentation check,
034     * abstract syntax tree, and parent handler.
035     *
036     * @param indentCheck   the indentation check
037     * @param ast           the abstract syntax tree
038     * @param parent        the parent handler
039     */
040    public ForHandler(IndentationCheck indentCheck,
041        DetailAST ast, AbstractExpressionHandler parent) {
042        super(indentCheck, "for", ast, parent);
043    }
044
045    /**
046     * Check the indentation of the parameters of the 'for' loop.
047     */
048    private void checkForParams() {
049        final IndentLevel expected =
050            new IndentLevel(getIndent(), getBasicOffset());
051        final DetailAST init = getMainAst().findFirstToken(TokenTypes.FOR_INIT);
052
053        if (init == null) {
054            // for each
055            final DetailAST forEach =
056                    getMainAst().findFirstToken(TokenTypes.FOR_EACH_CLAUSE);
057            checkExpressionSubtree(forEach, expected, false, false);
058        }
059        else {
060            checkExpressionSubtree(init, expected, false, false);
061
062            final DetailAST cond =
063                    getMainAst().findFirstToken(TokenTypes.FOR_CONDITION);
064            checkExpressionSubtree(cond, expected, false, false);
065
066            final DetailAST forIterator =
067                    getMainAst().findFirstToken(TokenTypes.FOR_ITERATOR);
068            checkExpressionSubtree(forIterator, expected, false, false);
069        }
070    }
071
072    @Override
073    public void checkIndentation() {
074        checkForParams();
075        super.checkIndentation();
076        checkWrappingIndentation(getMainAst(), getForLoopRightParen(getMainAst()));
077    }
078
079    /**
080     * Returns right parenthesis of for-loop statement.
081     * @param literalForAst
082     *          literal-for ast node(TokenTypes.LITERAL_FOR)
083     * @return right parenthesis of for-loop statement.
084     */
085    private static DetailAST getForLoopRightParen(DetailAST literalForAst) {
086        return literalForAst.findFirstToken(TokenTypes.RPAREN);
087    }
088
089}