001////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code for adherence to a set of rules.
003// Copyright (C) 2001-2014  Oliver Burn
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////////////////////////////////////////////////////////////////////////////////
019package com.puppycrawl.tools.checkstyle.checks.indentation;
020
021import com.puppycrawl.tools.checkstyle.api.DetailAST;
022import com.puppycrawl.tools.checkstyle.api.TokenTypes;
023
024/**
025 * Handler for for loops.
026 *
027 * @author jrichard
028 */
029public class ForHandler 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 ForHandler(IndentationCheck indentCheck,
040        DetailAST ast, ExpressionHandler parent)
041    {
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    {
050        final IndentLevel expected =
051            new IndentLevel(getLevel(), getBasicOffset());
052        final DetailAST init = getMainAst().findFirstToken(TokenTypes.FOR_INIT);
053
054        if (init != null) {
055            checkExpressionSubtree(init, expected, false, false);
056
057            final DetailAST cond =
058                getMainAst().findFirstToken(TokenTypes.FOR_CONDITION);
059            checkExpressionSubtree(cond, expected, false, false);
060
061            final DetailAST iter =
062                getMainAst().findFirstToken(TokenTypes.FOR_ITERATOR);
063            checkExpressionSubtree(iter, expected, false, false);
064        }
065        // for each
066        else {
067            final DetailAST forEach =
068                getMainAst().findFirstToken(TokenTypes.FOR_EACH_CLAUSE);
069            checkExpressionSubtree(forEach, expected, false, false);
070        }
071    }
072
073    @Override
074    public void checkIndentation()
075    {
076        checkForParams();
077        super.checkIndentation();
078        final LineWrappingHandler lineWrap =
079            new LineWrappingHandler(getIndentCheck(), getMainAst());
080        lineWrap.checkIndentation();
081    }
082
083    @Override
084    public IndentLevel suggestedChildLevel(ExpressionHandler child)
085    {
086        if (child instanceof ElseHandler) {
087            return getLevel();
088        }
089        return super.suggestedChildLevel(child);
090    }
091}