Thu, 02 Oct 2008 19:58:40 -0700
6754988: Update copyright year
Summary: Update for files that have been modified starting July 2008
Reviewed-by: ohair, tbell
1 /*
2 * Copyright 1999-2008 Sun Microsystems, Inc. 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. Sun designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
26 package com.sun.tools.javac.code;
28 import java.util.EnumSet;
29 import java.util.ResourceBundle;
31 import com.sun.tools.javac.api.Formattable;
33 import static com.sun.tools.javac.code.TypeTags.*;
34 import static com.sun.tools.javac.code.Flags.*;
36 /** Internal symbol kinds, which distinguish between elements of
37 * different subclasses of Symbol. Symbol kinds are organized so they can be
38 * or'ed to sets.
39 *
40 * <p><b>This is NOT part of any API supported by Sun Microsystems. If
41 * you write code that depends on this, you do so at your own risk.
42 * This code and its internal interfaces are subject to change or
43 * deletion without notice.</b>
44 */
45 public class Kinds {
47 private Kinds() {} // uninstantiable
49 /** The empty set of kinds.
50 */
51 public final static int NIL = 0;
53 /** The kind of package symbols.
54 */
55 public final static int PCK = 1 << 0;
57 /** The kind of type symbols (classes, interfaces and type variables).
58 */
59 public final static int TYP = 1 << 1;
61 /** The kind of variable symbols.
62 */
63 public final static int VAR = 1 << 2;
65 /** The kind of values (variables or non-variable expressions), includes VAR.
66 */
67 public final static int VAL = (1 << 3) | VAR;
69 /** The kind of methods.
70 */
71 public final static int MTH = 1 << 4;
73 /** The error kind, which includes all other kinds.
74 */
75 public final static int ERR = (1 << 5) - 1;
77 /** The set of all kinds.
78 */
79 public final static int AllKinds = ERR;
81 /** Kinds for erroneous symbols that complement the above
82 */
83 public static final int ERRONEOUS = 1 << 6;
84 public static final int AMBIGUOUS = ERRONEOUS+1; // ambiguous reference
85 public static final int HIDDEN = ERRONEOUS+2; // hidden method or field
86 public static final int STATICERR = ERRONEOUS+3; // nonstatic member from static context
87 public static final int ABSENT_VAR = ERRONEOUS+4; // missing variable
88 public static final int WRONG_MTHS = ERRONEOUS+5; // methods with wrong arguments
89 public static final int WRONG_MTH = ERRONEOUS+6; // one method with wrong arguments
90 public static final int ABSENT_MTH = ERRONEOUS+7; // missing method
91 public static final int ABSENT_TYP = ERRONEOUS+8; // missing type
93 public enum KindName implements Formattable {
94 ANNOTATION("kindname.interface"),
95 CONSTRUCTOR("kindname.constructor"),
96 INTERFACE("kindname.interface"),
97 STATIC("kindname.static"),
98 TYPEVAR("kindname.type.variable"),
99 BOUND("kindname.type.variable.bound"),
100 VAR("kindname.variable"),
101 VAL("kindname.value"),
102 METHOD("kindname.method"),
103 CLASS("kindname.class"),
104 PACKAGE("kindname.package");
106 private String name;
108 KindName(String name) {
109 this.name = name;
110 }
112 public String toString() {
113 return name;
114 }
116 public String getKind() {
117 return "Kindname";
118 }
120 public String toString(ResourceBundle bundle) {
121 String s = toString();
122 return bundle.getString("compiler.misc." + s);
123 }
124 }
126 /** A KindName representing a given symbol kind
127 */
128 public static KindName kindName(int kind) {
129 switch (kind) {
130 case PCK: return KindName.PACKAGE;
131 case TYP: return KindName.CLASS;
132 case VAR: return KindName.VAR;
133 case VAL: return KindName.VAL;
134 case MTH: return KindName.METHOD;
135 default : throw new AssertionError("Unexpected kind: "+kind);
136 }
137 }
139 /** A KindName representing a given symbol
140 */
141 public static KindName kindName(Symbol sym) {
142 switch (sym.getKind()) {
143 case PACKAGE:
144 return KindName.PACKAGE;
146 case ENUM:
147 case ANNOTATION_TYPE:
148 case INTERFACE:
149 case CLASS:
150 return KindName.CLASS;
152 case TYPE_PARAMETER:
153 return KindName.TYPEVAR;
155 case ENUM_CONSTANT:
156 case FIELD:
157 case PARAMETER:
158 case LOCAL_VARIABLE:
159 case EXCEPTION_PARAMETER:
160 return KindName.VAR;
162 case METHOD:
163 case CONSTRUCTOR:
164 case STATIC_INIT:
165 case INSTANCE_INIT:
166 return KindName.METHOD;
168 default:
169 if (sym.kind == VAL)
170 // I don't think this can happen but it can't harm
171 // playing it safe --ahe
172 return KindName.VAL;
173 else
174 throw new AssertionError("Unexpected kind: "+sym.getKind());
175 }
176 }
178 /** A set of KindName(s) representing a set of symbol's kinds.
179 */
180 public static EnumSet<KindName> kindNames(int kind) {
181 EnumSet<KindName> kinds = EnumSet.noneOf(KindName.class);
182 if ((kind & VAL) != 0)
183 kinds.add(((kind & VAL) == VAR) ? KindName.VAR : KindName.VAL);
184 if ((kind & MTH) != 0) kinds.add(KindName.METHOD);
185 if ((kind & TYP) != 0) kinds.add(KindName.CLASS);
186 if ((kind & PCK) != 0) kinds.add(KindName.PACKAGE);
187 return kinds;
188 }
190 /** A KindName representing the kind of a given class/interface type.
191 */
192 public static KindName typeKindName(Type t) {
193 if (t.tag == TYPEVAR ||
194 t.tag == CLASS && (t.tsym.flags() & COMPOUND) != 0)
195 return KindName.BOUND;
196 else if (t.tag == PACKAGE)
197 return KindName.PACKAGE;
198 else if ((t.tsym.flags_field & ANNOTATION) != 0)
199 return KindName.ANNOTATION;
200 else if ((t.tsym.flags_field & INTERFACE) != 0)
201 return KindName.INTERFACE;
202 else
203 return KindName.CLASS;
204 }
206 /** A KindName representing the kind of a a missing symbol, given an
207 * error kind.
208 * */
209 public static KindName absentKind(int kind) {
210 switch (kind) {
211 case ABSENT_VAR:
212 return KindName.VAR;
213 case WRONG_MTHS: case WRONG_MTH: case ABSENT_MTH:
214 return KindName.METHOD;
215 case ABSENT_TYP:
216 return KindName.CLASS;
217 default:
218 throw new AssertionError("Unexpected kind: "+kind);
219 }
220 }
221 }