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 member definitions.
027 *
028 * @author o_sukhodolsky
029 */
030public class MemberDefHandler extends AbstractExpressionHandler {
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 MemberDefHandler(IndentationCheck indentCheck,
041        DetailAST ast, AbstractExpressionHandler parent) {
042        super(indentCheck, "member def", ast, parent);
043    }
044
045    @Override
046    public void checkIndentation() {
047        final DetailAST modifiersNode = getMainAst().findFirstToken(TokenTypes.MODIFIERS);
048        if (modifiersNode.getChildCount() == 0) {
049            checkType();
050        }
051        else {
052            checkModifiers();
053        }
054        final DetailAST firstNode = getMainAst();
055        final DetailAST lastNode = getVarDefStatementSemicolon(firstNode);
056
057        if (lastNode != null && !isArrayDeclaration(firstNode)) {
058            checkWrappingIndentation(firstNode, lastNode);
059        }
060    }
061
062    @Override
063    public IndentLevel getSuggestedChildIndent(AbstractExpressionHandler child) {
064        return getIndent();
065    }
066
067    @Override
068    protected void checkModifiers() {
069        final DetailAST modifier = getMainAst().findFirstToken(TokenTypes.MODIFIERS);
070        if (isOnStartOfLine(modifier)
071            && !getIndent().isAcceptable(expandedTabsColumnNo(modifier))) {
072            logError(modifier, "modifier", expandedTabsColumnNo(modifier));
073        }
074    }
075
076    /**
077     * Check the indentation of the method type.
078     */
079    private void checkType() {
080        final DetailAST type = getMainAst().findFirstToken(TokenTypes.TYPE);
081        final DetailAST ident = AbstractExpressionHandler.getFirstToken(type);
082        final int columnNo = expandedTabsColumnNo(ident);
083        if (isOnStartOfLine(ident) && !getIndent().isAcceptable(columnNo)) {
084            logError(ident, "type", columnNo);
085        }
086    }
087
088    /**
089     * Checks if variable_def node is array declaration.
090     * @param variableDef current variable_def.
091     * @return true if variable_def node is array declaration.
092     */
093    private static boolean isArrayDeclaration(DetailAST variableDef) {
094        return variableDef.findFirstToken(TokenTypes.TYPE)
095            .findFirstToken(TokenTypes.ARRAY_DECLARATOR) != null;
096    }
097
098    /**
099     * Returns semicolon for variable definition statement.
100     * @param variableDef
101     *          ast node of type TokenTypes.VARIABLE_DEF
102     * @return ast node of type TokenTypes.SEMI
103     */
104    private static DetailAST getVarDefStatementSemicolon(DetailAST variableDef) {
105        DetailAST lastNode = variableDef.getLastChild();
106        if (lastNode.getType() != TokenTypes.SEMI) {
107            lastNode = variableDef.getNextSibling();
108        }
109        return lastNode;
110    }
111
112}