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