1 ///////////////////////////////////////////////////////////////////////////////////////////////
2 // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3 // Copyright (C) 2001-2024 the original author or authors.
4 //
5 // This library is free software; you can redistribute it and/or
6 // modify it under the terms of the GNU Lesser General Public
7 // License as published by the Free Software Foundation; either
8 // version 2.1 of the License, or (at your option) any later version.
9 //
10 // This library is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 // Lesser General Public License for more details.
14 //
15 // You should have received a copy of the GNU Lesser General Public
16 // License along with this library; if not, write to the Free Software
17 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 ///////////////////////////////////////////////////////////////////////////////////////////////
19
20 package com.puppycrawl.tools.checkstyle.checks.coding;
21
22 import java.util.Set;
23
24 import com.puppycrawl.tools.checkstyle.StatelessCheck;
25 import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
26 import com.puppycrawl.tools.checkstyle.api.DetailAST;
27 import com.puppycrawl.tools.checkstyle.api.TokenTypes;
28 import com.puppycrawl.tools.checkstyle.utils.TokenUtil;
29
30 /**
31 * <div>
32 * Checks that switch statement has a {@code default} clause.
33 * </div>
34 *
35 * <p>
36 * Rationale: It's usually a good idea to introduce a
37 * default case in every switch statement. Even if
38 * the developer is sure that all currently possible
39 * cases are covered, this should be expressed in the
40 * default branch, e.g. by using an assertion. This way
41 * the code is protected against later changes, e.g.
42 * introduction of new types in an enumeration type.
43 * </p>
44 *
45 * <p>
46 * This check does not validate any switch expressions. Rationale:
47 * The compiler requires switch expressions to be exhaustive. This means
48 * that all possible inputs must be covered.
49 * </p>
50 *
51 * <p>
52 * This check does not validate switch statements that use pattern or null
53 * labels. Rationale: Switch statements that use pattern or null labels are
54 * checked by the compiler for exhaustiveness. This means that all possible
55 * inputs must be covered.
56 * </p>
57 *
58 * <p>
59 * See the <a href="https://docs.oracle.com/javase/specs/jls/se22/html/jls-15.html#jls-15.28">
60 * Java Language Specification</a> for more information about switch statements
61 * and expressions.
62 * </p>
63 *
64 * <p>
65 * See the <a href="https://docs.oracle.com/javase/specs/jls/se22/html/jls-14.html#jls-14.30">
66 * Java Language Specification</a> for more information about patterns.
67 * </p>
68 *
69 * <p>
70 * Parent is {@code com.puppycrawl.tools.checkstyle.TreeWalker}
71 * </p>
72 *
73 * <p>
74 * Violation Message Keys:
75 * </p>
76 * <ul>
77 * <li>
78 * {@code missing.switch.default}
79 * </li>
80 * </ul>
81 *
82 * @since 3.1
83 */
84 @StatelessCheck
85 public class MissingSwitchDefaultCheck extends AbstractCheck {
86
87 /**
88 * A key is pointing to the warning message text in "messages.properties"
89 * file.
90 */
91 public static final String MSG_KEY = "missing.switch.default";
92
93 /**
94 * Represents the possible parent tokens of a switch statement.
95 */
96 private static final Set<Integer> SWITCH_STATEMENT_PARENTS = Set.of(
97 TokenTypes.SLIST,
98 TokenTypes.LITERAL_IF,
99 TokenTypes.LITERAL_ELSE,
100 TokenTypes.LITERAL_DO,
101 TokenTypes.LITERAL_WHILE,
102 TokenTypes.LITERAL_FOR,
103 TokenTypes.LABELED_STAT
104 );
105
106 @Override
107 public int[] getDefaultTokens() {
108 return getRequiredTokens();
109 }
110
111 @Override
112 public int[] getAcceptableTokens() {
113 return getRequiredTokens();
114 }
115
116 @Override
117 public int[] getRequiredTokens() {
118 return new int[] {TokenTypes.LITERAL_SWITCH};
119 }
120
121 @Override
122 public void visitToken(DetailAST ast) {
123 if (!containsDefaultLabel(ast)
124 && !containsPatternCaseLabelElement(ast)
125 && !containsDefaultCaseLabelElement(ast)
126 && !containsNullCaseLabelElement(ast)
127 && !isSwitchExpression(ast)) {
128 log(ast, MSG_KEY);
129 }
130 }
131
132 /**
133 * Checks if the case group or its sibling contain the 'default' switch.
134 *
135 * @param detailAst first case group to check.
136 * @return true if 'default' switch found.
137 */
138 private static boolean containsDefaultLabel(DetailAST detailAst) {
139 return TokenUtil.findFirstTokenByPredicate(detailAst,
140 ast -> ast.findFirstToken(TokenTypes.LITERAL_DEFAULT) != null
141 ).isPresent();
142 }
143
144 /**
145 * Checks if a switch block contains a case label with a pattern variable definition
146 * or record pattern definition.
147 * In this situation, the compiler enforces the given switch block to cover
148 * all possible inputs, and we do not need a default label.
149 *
150 * @param detailAst first case group to check.
151 * @return true if switch block contains a pattern case label element
152 */
153 private static boolean containsPatternCaseLabelElement(DetailAST detailAst) {
154 return TokenUtil.findFirstTokenByPredicate(detailAst, ast -> {
155 return ast.getFirstChild() != null
156 && (ast.getFirstChild().findFirstToken(TokenTypes.PATTERN_VARIABLE_DEF) != null
157 || ast.getFirstChild().findFirstToken(TokenTypes.RECORD_PATTERN_DEF) != null);
158 }).isPresent();
159 }
160
161 /**
162 * Checks if a switch block contains a default case label.
163 *
164 * @param detailAst first case group to check.
165 * @return true if switch block contains default case label
166 */
167 private static boolean containsDefaultCaseLabelElement(DetailAST detailAst) {
168 return TokenUtil.findFirstTokenByPredicate(detailAst, ast -> {
169 return ast.getFirstChild() != null
170 && ast.getFirstChild().findFirstToken(TokenTypes.LITERAL_DEFAULT) != null;
171 }).isPresent();
172 }
173
174 /**
175 * Checks if a switch block contains a null case label.
176 *
177 * @param detailAst first case group to check.
178 * @return true if switch block contains null case label
179 */
180 private static boolean containsNullCaseLabelElement(DetailAST detailAst) {
181 return TokenUtil.findFirstTokenByPredicate(detailAst, ast -> {
182 return ast.getFirstChild() != null
183 && hasNullCaseLabel(ast.getFirstChild());
184 }).isPresent();
185 }
186
187 /**
188 * Checks if this LITERAL_SWITCH token is part of a switch expression.
189 *
190 * @param ast the switch statement we are checking
191 * @return true if part of a switch expression
192 */
193 private static boolean isSwitchExpression(DetailAST ast) {
194 return !TokenUtil.isOfType(ast.getParent().getType(), SWITCH_STATEMENT_PARENTS);
195 }
196
197 /**
198 * Checks if the case contains null label.
199 *
200 * @param detailAST the switch statement we are checking
201 * @return returnValue the ast of null label
202 */
203 private static boolean hasNullCaseLabel(DetailAST detailAST) {
204 return TokenUtil.findFirstTokenByPredicate(detailAST.getParent(), ast -> {
205 final DetailAST expr = ast.findFirstToken(TokenTypes.EXPR);
206 return expr != null && expr.findFirstToken(TokenTypes.LITERAL_NULL) != null;
207 }).isPresent();
208 }
209 }