1 /*
2 * Copyright (c) 2005, 2017, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26 package com.sun.tools.javac.code;
27
28 import java.util.Arrays;
29 import java.util.EnumSet;
30 import java.util.Map;
31 import java.util.concurrent.ConcurrentHashMap;
32
33 import com.sun.tools.javac.code.Symbol.*;
34 import com.sun.tools.javac.main.Option;
35 import com.sun.tools.javac.util.Context;
36 import com.sun.tools.javac.util.List;
37 import com.sun.tools.javac.util.Options;
38 import com.sun.tools.javac.util.Pair;
39
40 /**
41 * A class for handling -Xlint suboptions and @SuppresssWarnings.
42 *
43 * <p><b>This is NOT part of any supported API.
44 * If you write code that depends on this, you do so at your own risk.
45 * This code and its internal interfaces are subject to change or
46 * deletion without notice.</b>
47 */
48 public class Lint
49 {
50 /** The context key for the root Lint object. */
51 protected static final Context.Key<Lint> lintKey = new Context.Key<>();
52
53 /** Get the root Lint instance. */
54 public static Lint instance(Context context) {
55 Lint instance = context.get(lintKey);
56 if (instance == null)
57 instance = new Lint(context);
58 return instance;
59 }
60
61 /**
62 * Returns the result of combining the values in this object with
63 * the given annotation.
64 */
65 public Lint augment(Attribute.Compound attr) {
66 return augmentor.augment(this, attr);
67 }
68
69
70 /**
71 * Returns the result of combining the values in this object with
72 * the metadata on the given symbol.
73 */
74 public Lint augment(Symbol sym) {
75 Lint l = augmentor.augment(this, sym.getDeclarationAttributes());
76 if (sym.isDeprecated()) {
77 if (l == this)
78 l = new Lint(this);
79 l.values.remove(LintCategory.DEPRECATION);
80 l.suppressedValues.add(LintCategory.DEPRECATION);
81 }
82 return l;
83 }
84
85 /**
86 * Returns a new Lint that has the given LintCategorys suppressed.
87 * @param lc one or more categories to be suppressed
88 */
89 public Lint suppress(LintCategory... lc) {
90 Lint l = new Lint(this);
91 l.values.removeAll(Arrays.asList(lc));
92 l.suppressedValues.addAll(Arrays.asList(lc));
93 return l;
94 }
95
96 private final AugmentVisitor augmentor;
97
98 private final EnumSet<LintCategory> values;
99 private final EnumSet<LintCategory> suppressedValues;
100
101 private static final Map<String, LintCategory> map = new ConcurrentHashMap<>(20);
102
103 protected Lint(Context context) {
104 // initialize values according to the lint options
105 Options options = Options.instance(context);
106
107 if (options.isSet(Option.XLINT) || options.isSet(Option.XLINT_CUSTOM, "all")) {
108 // If -Xlint or -Xlint:all is given, enable all categories by default
109 values = EnumSet.allOf(LintCategory.class);
110 } else if (options.isSet(Option.XLINT_CUSTOM, "none")) {
111 // if -Xlint:none is given, disable all categories by default
112 values = EnumSet.noneOf(LintCategory.class);
113 } else {
114 // otherwise, enable on-by-default categories
115 values = EnumSet.noneOf(LintCategory.class);
116
117 Source source = Source.instance(context);
118 if (source.compareTo(Source.JDK1_9) >= 0) {
119 values.add(LintCategory.DEP_ANN);
120 }
121 values.add(LintCategory.REQUIRES_TRANSITIVE_AUTOMATIC);
122 values.add(LintCategory.OPENS);
123 values.add(LintCategory.MODULE);
124 values.add(LintCategory.REMOVAL);
125 values.add(LintCategory.FUTURE);
126 }
127
128 // Look for specific overrides
129 for (LintCategory lc : LintCategory.values()) {
130 if (options.isSet(Option.XLINT_CUSTOM, lc.option)) {
131 values.add(lc);
132 } else if (options.isSet(Option.XLINT_CUSTOM, "-" + lc.option)) {
133 values.remove(lc);
134 }
135 }
136
137 suppressedValues = EnumSet.noneOf(LintCategory.class);
138
139 context.put(lintKey, this);
140 augmentor = new AugmentVisitor(context);
141 }
142
143 protected Lint(Lint other) {
144 this.augmentor = other.augmentor;
145 this.values = other.values.clone();
146 this.suppressedValues = other.suppressedValues.clone();
147 }
148
149 @Override
150 public String toString() {
151 return "Lint:[values" + values + " suppressedValues" + suppressedValues + "]";
152 }
153
154 /**
155 * Categories of warnings that can be generated by the compiler.
156 */
157 public enum LintCategory {
158 /**
159 * Warn when code refers to a auxiliary class that is hidden in a source file (ie source file name is
160 * different from the class name, and the type is not properly nested) and the referring code
161 * is not located in the same source file.
162 */
163 AUXILIARYCLASS("auxiliaryclass"),
164
165 /**
166 * Warn about use of unnecessary casts.
167 */
168 CAST("cast"),
169
170 /**
171 * Warn about issues related to classfile contents
172 */
173 CLASSFILE("classfile"),
174
175 /**
176 * Warn about use of deprecated items.
177 */
178 DEPRECATION("deprecation"),
179
180 /**
181 * Warn about items which are documented with an {@code @deprecated} JavaDoc
182 * comment, but which do not have {@code @Deprecated} annotation.
183 */
184 DEP_ANN("dep-ann"),
185
186 /**
187 * Warn about division by constant integer 0.
188 */
189 DIVZERO("divzero"),
190
191 /**
192 * Warn about empty statement after if.
193 */
194 EMPTY("empty"),
195
196 /**
197 * Warn about issues regarding module exports.
198 */
199 EXPORTS("exports"),
200
201 /**
202 * Warn about falling through from one case of a switch statement to the next.
203 */
204 FALLTHROUGH("fallthrough"),
205
206 /**
207 * Warn about finally clauses that do not terminate normally.
208 */
209 FINALLY("finally"),
210
211 /**
212 * Warn about module system related issues.
213 */
214 MODULE("module"),
215
216 /**
217 * Warn about issues regarding module opens.
218 */
219 OPENS("opens"),
220
221 /**
222 * Warn about issues relating to use of command line options
223 */
224 OPTIONS("options"),
225
226 /**
227 * Warn about issues regarding method overloads.
228 */
229 OVERLOADS("overloads"),
230
231 /**
232 * Warn about issues regarding method overrides.
233 */
234 OVERRIDES("overrides"),
235
236 /**
237 * Warn about invalid path elements on the command line.
238 * Such warnings cannot be suppressed with the SuppressWarnings
239 * annotation.
240 */
241 PATH("path"),
242
243 /**
244 * Warn about issues regarding annotation processing.
245 */
246 PROCESSING("processing"),
247
248 /**
249 * Warn about unchecked operations on raw types.
250 */
251 RAW("rawtypes"),
252
253 /**
254 * Warn about use of deprecated-for-removal items.
255 */
256 REMOVAL("removal"),
257
258 /**
259 * Warn about use of automatic modules in the requires clauses.
260 */
261 REQUIRES_AUTOMATIC("requires-automatic"),
262
263 /**
264 * Warn about automatic modules in requires transitive.
265 */
266 REQUIRES_TRANSITIVE_AUTOMATIC("requires-transitive-automatic"),
267
268 /**
269 * Warn about Serializable classes that do not provide a serial version ID.
270 */
271 SERIAL("serial"),
272
273 /**
274 * Warn about issues relating to use of statics
275 */
276 STATIC("static"),
277
278 /**
279 * Warn about issues relating to use of try blocks (i.e. try-with-resources)
280 */
281 TRY("try"),
282
283 /**
284 * Warn about unchecked operations on raw types.
285 */
286 UNCHECKED("unchecked"),
287
288 /**
289 * Warn about source structures that may be illegal or
290 * questionable in future source versions.
291 */
292 FUTURE("future"),
293
294 /**
295 * Warn about potentially unsafe vararg methods
296 */
297 VARARGS("varargs");
298
299 LintCategory(String option) {
300 this(option, false);
301 }
302
303 LintCategory(String option, boolean hidden) {
304 this.option = option;
305 this.hidden = hidden;
306 map.put(option, this);
307 }
308
309 static LintCategory get(String option) {
310 return map.get(option);
311 }
312
313 public final String option;
314 public final boolean hidden;
315 }
316
317 /**
318 * Checks if a warning category is enabled. A warning category may be enabled
319 * on the command line, or by default, and can be temporarily disabled with
320 * the SuppressWarnings annotation.
321 */
322 public boolean isEnabled(LintCategory lc) {
323 return values.contains(lc);
324 }
325
326 /**
327 * Checks is a warning category has been specifically suppressed, by means
328 * of the SuppressWarnings annotation, or, in the case of the deprecated
329 * category, whether it has been implicitly suppressed by virtue of the
330 * current entity being itself deprecated.
331 */
332 public boolean isSuppressed(LintCategory lc) {
333 return suppressedValues.contains(lc);
334 }
335
336 protected static class AugmentVisitor implements Attribute.Visitor {
337 private final Context context;
338 private Symtab syms;
339 private Lint parent;
340 private Lint lint;
341
342 AugmentVisitor(Context context) {
343 // to break an ugly sequence of initialization dependencies,
344 // we defer the initialization of syms until it is needed
345 this.context = context;
346 }
347
348 Lint augment(Lint parent, Attribute.Compound attr) {
349 initSyms();
350 this.parent = parent;
351 lint = null;
352 attr.accept(this);
353 return (lint == null ? parent : lint);
354 }
355
356 Lint augment(Lint parent, List<Attribute.Compound> attrs) {
357 initSyms();
358 this.parent = parent;
359 lint = null;
360 for (Attribute.Compound a: attrs) {
361 a.accept(this);
362 }
363 return (lint == null ? parent : lint);
364 }
365
366 private void initSyms() {
367 if (syms == null)
368 syms = Symtab.instance(context);
369 }
370
371 private void suppress(LintCategory lc) {
372 if (lint == null)
373 lint = new Lint(parent);
374 lint.suppressedValues.add(lc);
375 lint.values.remove(lc);
376 }
377
378 public void visitConstant(Attribute.Constant value) {
379 if (value.type.tsym == syms.stringType.tsym) {
380 LintCategory lc = LintCategory.get((String) (value.value));
381 if (lc != null)
382 suppress(lc);
383 }
384 }
385
386 public void visitClass(Attribute.Class clazz) {
387 }
388
389 // If we find a @SuppressWarnings annotation, then we continue
390 // walking the tree, in order to suppress the individual warnings
391 // specified in the @SuppressWarnings annotation.
392 public void visitCompound(Attribute.Compound compound) {
393 if (compound.type.tsym == syms.suppressWarningsType.tsym) {
394 for (List<Pair<MethodSymbol,Attribute>> v = compound.values;
395 v.nonEmpty(); v = v.tail) {
396 Pair<MethodSymbol,Attribute> value = v.head;
397 if (value.fst.name.toString().equals("value"))
398 value.snd.accept(this);
399 }
400
401 }
402 }
403
404 public void visitArray(Attribute.Array array) {
405 for (Attribute value : array.values)
406 value.accept(this);
407 }
408
409 public void visitEnum(Attribute.Enum e) {
410 }
411
412 public void visitError(Attribute.Error e) {
413 }
414 }
415 }