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;
021
022import com.puppycrawl.tools.checkstyle.StatelessCheck;
023import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
024import com.puppycrawl.tools.checkstyle.api.DetailAST;
025import com.puppycrawl.tools.checkstyle.api.TokenTypes;
026
027/**
028 * Checks the style of array type definitions.
029 * Some like Java-style: {@code public static void main(String[] args)}
030 * and some like C-style: public static void main(String args[])
031 *
032 * <p>By default the Check enforces Java style.
033 */
034@StatelessCheck
035public class ArrayTypeStyleCheck extends AbstractCheck {
036
037    /**
038     * A key is pointing to the warning message text in "messages.properties"
039     * file.
040     */
041    public static final String MSG_KEY = "array.type.style";
042
043    /** Controls whether to use Java or C style. */
044    private boolean javaStyle = true;
045
046    @Override
047    public int[] getDefaultTokens() {
048        return getRequiredTokens();
049    }
050
051    @Override
052    public int[] getAcceptableTokens() {
053        return getRequiredTokens();
054    }
055
056    @Override
057    public int[] getRequiredTokens() {
058        return new int[] {TokenTypes.ARRAY_DECLARATOR};
059    }
060
061    @Override
062    public void visitToken(DetailAST ast) {
063        final DetailAST typeAST = ast.getParent();
064        if (typeAST.getType() == TokenTypes.TYPE
065                // Do not check method's return type.
066                // We have no alternatives here.
067                && typeAST.getParent().getType() != TokenTypes.METHOD_DEF) {
068            final DetailAST variableAST = typeAST.getNextSibling();
069            if (variableAST != null) {
070                final boolean isJavaStyle =
071                    variableAST.getLineNo() > ast.getLineNo()
072                    || variableAST.getColumnNo() - ast.getColumnNo() > -1;
073
074                if (isJavaStyle != javaStyle) {
075                    log(ast, MSG_KEY);
076                }
077            }
078        }
079    }
080
081    /**
082     * Controls whether to check for Java or C style.
083     * @param javaStyle true if Java style should be used.
084     */
085    public void setJavaStyle(boolean javaStyle) {
086        this.javaStyle = javaStyle;
087    }
088
089}