001///////////////////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code and other text files for adherence to a set of rules.
003// Copyright (C) 2001-2026 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.utils.CodePointUtil;
028import com.puppycrawl.tools.checkstyle.utils.CommonUtil;
029
030/**
031 * <div>Abstract class for checking the padding of parentheses. That is whether a
032 * space is required after a left parenthesis and before a right parenthesis,
033 * or such spaces are forbidden.
034 * </div>
035 */
036@StatelessCheck
037public abstract class AbstractParenPadCheck
038    extends AbstractCheck {
039
040    /** Open parenthesis literal. */
041    private static final char OPEN_PARENTHESIS = '(';
042
043    /** Close parenthesis literal. */
044    private static final char CLOSE_PARENTHESIS = ')';
045
046    /** Message key for followed whitespace. */
047    private final String msgWsFollowed;
048
049    /** Message key for not followed whitespace. */
050    private final String msgWsNotFollowed;
051
052    /** Message key for preceded whitespace. */
053    private final String msgWsPreceded;
054
055    /** Message key for not preceded whitespace. */
056    private final String msgWsNotPreceded;
057
058    /** The policy to enforce. */
059    private PadOption option = PadOption.NOSPACE;
060
061    /**
062     * Creates a new {@code AbstractParenPadCheck} instance.
063     *
064     * @param msgWsFollowed message key for followed whitespace
065     * @param msgWsNotFollowed message key for not followed whitespace
066     * @param msgWsPreceded message key for preceded whitespace
067     * @param msgWsNotPreceded message key for not preceded whitespace
068     */
069    protected AbstractParenPadCheck(String msgWsFollowed, String msgWsNotFollowed,
070                                    String msgWsPreceded, String msgWsNotPreceded) {
071        this.msgWsFollowed = msgWsFollowed;
072        this.msgWsNotFollowed = msgWsNotFollowed;
073        this.msgWsPreceded = msgWsPreceded;
074        this.msgWsNotPreceded = msgWsNotPreceded;
075    }
076
077    /**
078     * Specify policy on how to pad parentheses.
079     *
080     * @param optionStr string to decode option from
081     * @throws IllegalArgumentException if unable to decode
082     */
083    public void setOption(String optionStr) {
084        option = PadOption.valueOf(optionStr.trim().toUpperCase(Locale.ENGLISH));
085    }
086
087    /**
088     * Process a token representing a left parentheses.
089     *
090     * @param ast the token representing a left parentheses
091     */
092    protected void processLeft(DetailAST ast) {
093        final int[] line = getLineCodePoints(ast.getLineNo() - 1);
094        final int after = ast.getColumnNo() + 1;
095
096        if (after < line.length) {
097            final boolean hasWhitespaceAfter =
098                    CommonUtil.isCodePointWhitespace(line, after);
099            if (option == PadOption.NOSPACE && hasWhitespaceAfter) {
100                log(ast, msgWsFollowed, OPEN_PARENTHESIS);
101            }
102            else if (option == PadOption.SPACE && !hasWhitespaceAfter
103                     && line[after] != CLOSE_PARENTHESIS) {
104                log(ast, msgWsNotFollowed, OPEN_PARENTHESIS);
105            }
106        }
107    }
108
109    /**
110     * Process a token representing a right parentheses.
111     *
112     * @param ast the token representing a right parentheses
113     */
114    protected void processRight(DetailAST ast) {
115        final int before = ast.getColumnNo() - 1;
116        if (before >= 0) {
117            final int[] line = getLineCodePoints(ast.getLineNo() - 1);
118            final boolean hasPrecedingWhitespace =
119                    CommonUtil.isCodePointWhitespace(line, before);
120
121            if (option == PadOption.NOSPACE && hasPrecedingWhitespace
122                && !CodePointUtil.hasWhitespaceBefore(before, line)) {
123                log(ast, msgWsPreceded, CLOSE_PARENTHESIS);
124            }
125            else if (option == PadOption.SPACE && !hasPrecedingWhitespace
126                && line[before] != OPEN_PARENTHESIS) {
127                log(ast, msgWsNotPreceded, CLOSE_PARENTHESIS);
128            }
129        }
130    }
131
132}