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