View Javadoc
1   ////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code for adherence to a set of rules.
3   // Copyright (C) 2001-2017 the original author or authors.
4   //
5   // This library is free software; you can redistribute it and/or
6   // modify it under the terms of the GNU Lesser General Public
7   // License as published by the Free Software Foundation; either
8   // version 2.1 of the License, or (at your option) any later version.
9   //
10  // This library is distributed in the hope that it will be useful,
11  // but WITHOUT ANY WARRANTY; without even the implied warranty of
12  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  // Lesser General Public License for more details.
14  //
15  // You should have received a copy of the GNU Lesser General Public
16  // License along with this library; if not, write to the Free Software
17  // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18  ////////////////////////////////////////////////////////////////////////////////
19  
20  package com.puppycrawl.tools.checkstyle.checks.indentation;
21  
22  import com.puppycrawl.tools.checkstyle.api.DetailAST;
23  import com.puppycrawl.tools.checkstyle.api.TokenTypes;
24  
25  /**
26   * Handler for for loops.
27   *
28   * @author jrichard
29   */
30  public class ForHandler extends BlockParentHandler {
31      /**
32       * Construct an instance of this handler with the given indentation check,
33       * abstract syntax tree, and parent handler.
34       *
35       * @param indentCheck   the indentation check
36       * @param ast           the abstract syntax tree
37       * @param parent        the parent handler
38       */
39      public ForHandler(IndentationCheck indentCheck,
40          DetailAST ast, AbstractExpressionHandler parent) {
41          super(indentCheck, "for", ast, parent);
42      }
43  
44      /**
45       * Check the indentation of the parameters of the 'for' loop.
46       */
47      private void checkForParams() {
48          final IndentLevel expected =
49              new IndentLevel(getIndent(), getBasicOffset());
50          final DetailAST init = getMainAst().findFirstToken(TokenTypes.FOR_INIT);
51  
52          if (init == null) {
53              // for each
54              final DetailAST forEach =
55                      getMainAst().findFirstToken(TokenTypes.FOR_EACH_CLAUSE);
56              checkExpressionSubtree(forEach, expected, false, false);
57          }
58          else {
59              checkExpressionSubtree(init, expected, false, false);
60  
61              final DetailAST cond =
62                      getMainAst().findFirstToken(TokenTypes.FOR_CONDITION);
63              checkExpressionSubtree(cond, expected, false, false);
64  
65              final DetailAST forIterator =
66                      getMainAst().findFirstToken(TokenTypes.FOR_ITERATOR);
67              checkExpressionSubtree(forIterator, expected, false, false);
68          }
69      }
70  
71      @Override
72      public void checkIndentation() {
73          checkForParams();
74          super.checkIndentation();
75          checkWrappingIndentation(getMainAst(), getForLoopRightParen(getMainAst()));
76      }
77  
78      /**
79       * Returns right parenthesis of for-loop statement.
80       * @param literalForAst
81       *          literal-for ast node(TokenTypes.LITERAL_FOR)
82       * @return right parenthesis of for-loop statement.
83       */
84      private static DetailAST getForLoopRightParen(DetailAST literalForAst) {
85          return literalForAst.findFirstToken(TokenTypes.RPAREN);
86      }
87  }