Mon, 29 Nov 2010 14:15:36 -0800
6900037: javac should warn if earlier -source is used and bootclasspath not set
Reviewed-by: darcy
1 /*
2 * Copyright (c) 2005, 2008, 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 */
26 package com.sun.tools.javac.code;
28 import java.util.EnumSet;
29 import java.util.HashMap;
30 import java.util.Map;
31 import com.sun.tools.javac.code.Symbol.*;
32 import com.sun.tools.javac.util.Context;
33 import com.sun.tools.javac.util.List;
34 import com.sun.tools.javac.util.Options;
35 import com.sun.tools.javac.util.Pair;
36 import static com.sun.tools.javac.code.Flags.*;
39 /**
40 * A class for handling -Xlint suboptions and @SuppresssWarnings.
41 *
42 * <p><b>This is NOT part of any supported API.
43 * If you write code that depends on this, you do so at your own risk.
44 * This code and its internal interfaces are subject to change or
45 * deletion without notice.</b>
46 */
47 public class Lint
48 {
49 /** The context key for the root Lint object. */
50 protected static final Context.Key<Lint> lintKey = new Context.Key<Lint>();
52 /** Get the root Lint instance. */
53 public static Lint instance(Context context) {
54 Lint instance = context.get(lintKey);
55 if (instance == null)
56 instance = new Lint(context);
57 return instance;
58 }
60 /**
61 * Returns the result of combining the values in this object with
62 * the given annotation.
63 */
64 public Lint augment(Attribute.Compound attr) {
65 return augmentor.augment(this, attr);
66 }
69 /**
70 * Returns the result of combining the values in this object with
71 * the given annotations.
72 */
73 public Lint augment(List<Attribute.Compound> attrs) {
74 return augmentor.augment(this, attrs);
75 }
77 /**
78 * Returns the result of combining the values in this object with
79 * the given annotations and flags.
80 */
81 public Lint augment(List<Attribute.Compound> attrs, long flags) {
82 Lint l = augmentor.augment(this, attrs);
83 if ((flags & DEPRECATED) != 0) {
84 if (l == this)
85 l = new Lint(this);
86 l.values.remove(LintCategory.DEPRECATION);
87 l.suppressedValues.add(LintCategory.DEPRECATION);
88 }
89 return l;
90 }
93 private final AugmentVisitor augmentor;
95 private final EnumSet<LintCategory> values;
96 private final EnumSet<LintCategory> suppressedValues;
98 private static Map<String, LintCategory> map = new HashMap<String,LintCategory>();
101 protected Lint(Context context) {
102 // initialize values according to the lint options
103 Options options = Options.instance(context);
104 values = EnumSet.noneOf(LintCategory.class);
105 for (Map.Entry<String, LintCategory> e: map.entrySet()) {
106 if (options.lint(e.getKey()))
107 values.add(e.getValue());
108 }
110 suppressedValues = EnumSet.noneOf(LintCategory.class);
112 context.put(lintKey, this);
113 augmentor = new AugmentVisitor(context);
114 }
116 protected Lint(Lint other) {
117 this.augmentor = other.augmentor;
118 this.values = other.values.clone();
119 this.suppressedValues = other.suppressedValues.clone();
120 }
122 @Override
123 public String toString() {
124 return "Lint:[values" + values + " suppressedValues" + suppressedValues + "]";
125 }
127 /**
128 * Categories of warnings that can be generated by the compiler.
129 */
130 public enum LintCategory {
131 /**
132 * Warn about use of unnecessary casts.
133 */
134 CAST("cast"),
136 /**
137 * Warn about use of deprecated items.
138 */
139 DEPRECATION("deprecation"),
141 /**
142 * Warn about items which are documented with an {@code @deprecated} JavaDoc
143 * comment, but which do not have {@code @Deprecated} annotation.
144 */
145 DEP_ANN("dep-ann"),
147 /**
148 * Warn about division by constant integer 0.
149 */
150 DIVZERO("divzero"),
152 /**
153 * Warn about empty statement after if.
154 */
155 EMPTY("empty"),
157 /**
158 * Warn about falling through from one case of a switch statement to the next.
159 */
160 FALLTHROUGH("fallthrough"),
162 /**
163 * Warn about finally clauses that do not terminate normally.
164 */
165 FINALLY("finally"),
167 /**
168 * Warn about issues relating to use of command line options
169 */
170 OPTIONS("options"),
172 /**
173 * Warn about issues regarding method overrides.
174 */
175 OVERRIDES("overrides"),
177 /**
178 * Warn about invalid path elements on the command line.
179 * Such warnings cannot be suppressed with the SuppressWarnings
180 * annotation.
181 */
182 PATH("path"),
184 /**
185 * Warn about issues regarding annotation processing.
186 */
187 PROCESSING("processing"),
189 /**
190 * Warn about unchecked operations on raw types.
191 */
192 RAW("rawtypes"),
194 /**
195 * Warn about Serializable classes that do not provide a serial version ID.
196 */
197 SERIAL("serial"),
199 /**
200 * Warn about issues relating to use of statics
201 */
202 STATIC("static"),
204 /**
205 * Warn about proprietary API that may be removed in a future release.
206 */
207 SUNAPI("sunapi", true),
209 /**
210 * Warn about issues relating to use of try blocks (i.e. try-with-resources)
211 */
212 TRY("try"),
214 /**
215 * Warn about unchecked operations on raw types.
216 */
217 UNCHECKED("unchecked"),
219 /**
220 * Warn about potentially unsafe vararg methods
221 */
222 VARARGS("varargs");
224 LintCategory(String option) {
225 this(option, false);
226 }
228 LintCategory(String option, boolean hidden) {
229 this.option = option;
230 this.hidden = hidden;
231 map.put(option, this);
232 }
234 static LintCategory get(String option) {
235 return map.get(option);
236 }
238 public final String option;
239 public final boolean hidden;
240 };
242 /**
243 * Checks if a warning category is enabled. A warning category may be enabled
244 * on the command line, or by default, and can be temporarily disabled with
245 * the SuppressWarnings annotation.
246 */
247 public boolean isEnabled(LintCategory lc) {
248 return values.contains(lc);
249 }
251 /**
252 * Checks is a warning category has been specifically suppressed, by means
253 * of the SuppressWarnings annotation, or, in the case of the deprecated
254 * category, whether it has been implicitly suppressed by virtue of the
255 * current entity being itself deprecated.
256 */
257 public boolean isSuppressed(LintCategory lc) {
258 return suppressedValues.contains(lc);
259 }
261 protected static class AugmentVisitor implements Attribute.Visitor {
262 private final Context context;
263 private Symtab syms;
264 private Lint parent;
265 private Lint lint;
267 AugmentVisitor(Context context) {
268 // to break an ugly sequence of initialization dependencies,
269 // we defer the initialization of syms until it is needed
270 this.context = context;
271 }
273 Lint augment(Lint parent, Attribute.Compound attr) {
274 initSyms();
275 this.parent = parent;
276 lint = null;
277 attr.accept(this);
278 return (lint == null ? parent : lint);
279 }
281 Lint augment(Lint parent, List<Attribute.Compound> attrs) {
282 initSyms();
283 this.parent = parent;
284 lint = null;
285 for (Attribute.Compound a: attrs) {
286 a.accept(this);
287 }
288 return (lint == null ? parent : lint);
289 }
291 private void initSyms() {
292 if (syms == null)
293 syms = Symtab.instance(context);
294 }
296 private void suppress(LintCategory lc) {
297 if (lint == null)
298 lint = new Lint(parent);
299 lint.suppressedValues.add(lc);
300 lint.values.remove(lc);
301 }
303 public void visitConstant(Attribute.Constant value) {
304 if (value.type.tsym == syms.stringType.tsym) {
305 LintCategory lc = LintCategory.get((String) (value.value));
306 if (lc != null)
307 suppress(lc);
308 }
309 }
311 public void visitClass(Attribute.Class clazz) {
312 }
314 // If we find a @SuppressWarnings annotation, then we continue
315 // walking the tree, in order to suppress the individual warnings
316 // specified in the @SuppressWarnings annotation.
317 public void visitCompound(Attribute.Compound compound) {
318 if (compound.type.tsym == syms.suppressWarningsType.tsym) {
319 for (List<Pair<MethodSymbol,Attribute>> v = compound.values;
320 v.nonEmpty(); v = v.tail) {
321 Pair<MethodSymbol,Attribute> value = v.head;
322 if (value.fst.name.toString().equals("value"))
323 value.snd.accept(this);
324 }
326 }
327 }
329 public void visitArray(Attribute.Array array) {
330 for (Attribute value : array.values)
331 value.accept(this);
332 }
334 public void visitEnum(Attribute.Enum e) {
335 }
337 public void visitError(Attribute.Error e) {
338 }
339 };
340 }