001////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code for adherence to a set of rules.
003// Copyright (C) 2001-2017 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.whitespace;
021
022import java.util.Locale;
023
024import com.puppycrawl.tools.checkstyle.StatelessCheck;
025import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
026import com.puppycrawl.tools.checkstyle.api.DetailAST;
027import com.puppycrawl.tools.checkstyle.api.TokenTypes;
028
029/**
030 * <p>Checks the padding of an empty for iterator; that is whether a
031 * space is required at an empty for iterator, or such spaces are
032 * forbidden. No check occurs if there is a line wrap at the iterator, as in
033 * </p>
034 * <pre class="body">
035for (Iterator foo = very.long.line.iterator();
036      foo.hasNext();
037     )
038   </pre>
039 * <p>
040 * The policy to verify is specified using the {@link PadOption} class and
041 * defaults to {@link PadOption#NOSPACE}.
042 * </p>
043 * <p>
044 * An example of how to configure the check is:
045 * </p>
046 * <pre>
047 * &lt;module name="EmptyForIteratorPad"/&gt;
048 * </pre>
049 *
050 * @author Rick Giles
051 */
052@StatelessCheck
053public class EmptyForIteratorPadCheck
054    extends AbstractCheck {
055
056    /**
057     * A key is pointing to the warning message text in "messages.properties"
058     * file.
059     */
060    public static final String MSG_WS_FOLLOWED = "ws.followed";
061
062    /**
063     * A key is pointing to the warning message text in "messages.properties"
064     * file.
065     */
066    public static final String MSG_WS_NOT_FOLLOWED = "ws.notFollowed";
067
068    /** Semicolon literal. */
069    private static final String SEMICOLON = ";";
070
071    /** The policy to enforce. */
072    private PadOption option = PadOption.NOSPACE;
073
074    /**
075     * Set the option to enforce.
076     * @param optionStr string to decode option from
077     * @throws IllegalArgumentException if unable to decode
078     */
079    public void setOption(String optionStr) {
080        try {
081            option = PadOption.valueOf(optionStr.trim().toUpperCase(Locale.ENGLISH));
082        }
083        catch (IllegalArgumentException iae) {
084            throw new IllegalArgumentException("unable to parse " + optionStr, iae);
085        }
086    }
087
088    @Override
089    public int[] getDefaultTokens() {
090        return getRequiredTokens();
091    }
092
093    @Override
094    public int[] getAcceptableTokens() {
095        return getRequiredTokens();
096    }
097
098    @Override
099    public int[] getRequiredTokens() {
100        return new int[] {TokenTypes.FOR_ITERATOR};
101    }
102
103    @Override
104    public void visitToken(DetailAST ast) {
105        if (ast.getChildCount() == 0) {
106            //empty for iterator. test pad after semi.
107            final DetailAST semi = ast.getPreviousSibling();
108            final String line = getLines()[semi.getLineNo() - 1];
109            final int after = semi.getColumnNo() + 1;
110            //don't check if at end of line
111            if (after < line.length()) {
112                if (option == PadOption.NOSPACE
113                    && Character.isWhitespace(line.charAt(after))) {
114                    log(semi.getLineNo(), after, MSG_WS_FOLLOWED, SEMICOLON);
115                }
116                else if (option == PadOption.SPACE
117                         && !Character.isWhitespace(line.charAt(after))) {
118                    log(semi.getLineNo(), after, MSG_WS_NOT_FOLLOWED, SEMICOLON);
119                }
120            }
121        }
122    }
123}