Kinds.java revision 2673:bf8500822576 
1/*
2 * Copyright (c) 1999, 2013, 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
26package com.sun.tools.javac.code;
27
28import java.util.EnumSet;
29import java.util.Set;
30import java.util.Locale;
31
32import com.sun.source.tree.MemberReferenceTree;
33import com.sun.tools.javac.api.Formattable;
34import com.sun.tools.javac.api.Messages;
35
36import static com.sun.tools.javac.code.Flags.*;
37import static com.sun.tools.javac.code.TypeTag.CLASS;
38import static com.sun.tools.javac.code.TypeTag.PACKAGE;
39import static com.sun.tools.javac.code.TypeTag.TYPEVAR;
40
41/** Internal symbol kinds, which distinguish between elements of
42 *  different subclasses of Symbol. Symbol kinds are organized so they can be
43 *  or'ed to sets.
44 *
45 *  <p><b>This is NOT part of any supported API.
46 *  If you write code that depends on this, you do so at your own risk.
47 *  This code and its internal interfaces are subject to change or
48 *  deletion without notice.</b>
49 */
50public class Kinds {
51
52    private Kinds() {} // uninstantiable
53
54    /**
55     * Kind of symbols.
56     *
57     * IMPORTANT: This is an ordered type.  The ordering of
58     * declarations in this enum matters.  Be careful when changing
59     * it.
60     */
61    public enum Kind {
62        NIL(Category.BASIC, KindSelector.NIL),
63        PCK(Category.BASIC, KindName.PACKAGE, KindSelector.PCK),
64        TYP(Category.BASIC, KindName.CLASS, KindSelector.TYP),
65        VAR(Category.BASIC, KindName.VAR, KindSelector.VAR),
66        MTH(Category.BASIC, KindName.METHOD, KindSelector.MTH),
67        POLY(Category.BASIC, KindSelector.POLY),
68        ERR(Category.ERROR, KindSelector.ERR),
69        AMBIGUOUS(Category.OVERLOAD),
70        HIDDEN(Category.OVERLOAD),
71        STATICERR(Category.OVERLOAD),
72        MISSING_ENCL(Category.OVERLOAD),
73        ABSENT_VAR(Category.OVERLOAD, KindName.VAR),
74        WRONG_MTHS(Category.OVERLOAD, KindName.METHOD),
75        WRONG_MTH(Category.OVERLOAD, KindName.METHOD),
76        ABSENT_MTH(Category.OVERLOAD, KindName.METHOD),
77        ABSENT_TYP(Category.OVERLOAD, KindName.CLASS),
78        WRONG_STATICNESS(Category.OVERLOAD, KindName.METHOD);
79
80        // There are essentially two "levels" to the Kind datatype.
81        // The first is a totally-ordered set of categories of
82        // solutions.  Within each category, we have more
83        // possibilities.
84        private enum Category {
85            BASIC, ERROR, OVERLOAD;
86        }
87
88        private final KindName kindName;
89        private final KindName absentKind;
90        private final KindSelector selector;
91        private final Category category;
92
93        private Kind(Category category) {
94            this(category, null, null, null);
95        }
96
97        private Kind(Category category,
98                     KindSelector selector) {
99            this(category, null, null, selector);
100        }
101
102        private Kind(Category category,
103                     KindName absentKind) {
104            this(category, null, absentKind, null);
105        }
106
107        private Kind(Category category,
108                     KindName kindName,
109                     KindSelector selector) {
110            this(category, kindName, null, selector);
111        }
112
113        private Kind(Category category,
114                     KindName kindName,
115                     KindName absentKind,
116                     KindSelector selector) {
117            this.category = category;
118            this.kindName = kindName;
119            this.absentKind = absentKind;
120            this.selector = selector;
121        }
122
123        public KindSelector toSelector() {
124            return selector;
125        }
126
127        public boolean matches(KindSelector kindSelectors) {
128            return selector.contains(kindSelectors);
129        }
130
131        public boolean isOverloadError() {
132            return category == Category.OVERLOAD;
133        }
134
135        public boolean isValid() {
136            return category == Category.BASIC;
137        }
138
139        public boolean betterThan(Kind other) {
140            return ordinal() < other.ordinal();
141        }
142
143        public KindName kindName() {
144            if (kindName == null) {
145                throw new AssertionError("Unexpected kind: " + this);
146            } else {
147                return kindName;
148            }
149        }
150
151        public KindName absentKind() {
152            if (absentKind == null) {
153                throw new AssertionError("Unexpected kind: " + this);
154            } else {
155                return absentKind;
156            }
157        }
158    }
159
160    public static class KindSelector {
161
162        //basic selectors
163        public static final KindSelector NIL = new KindSelector(0);
164        public static final KindSelector PCK = new KindSelector(0x01);
165        public static final KindSelector TYP = new KindSelector(0x02);
166        public static final KindSelector VAR = new KindSelector(0x04);
167        public static final KindSelector VAL = new KindSelector(0x0c);
168        public static final KindSelector MTH = new KindSelector(0x10);
169        public static final KindSelector ERR = new KindSelector(0x3f);
170        public static final KindSelector POLY = new KindSelector(0x20);
171
172        //common derived selectors
173        public static final KindSelector TYP_PCK = of(TYP, PCK);
174        public static final KindSelector VAL_MTH = of(VAL, MTH);
175        public static final KindSelector VAL_POLY = of(VAL, POLY);
176        public static final KindSelector VAL_TYP = of(VAL, TYP);
177        public static final KindSelector VAL_TYP_PCK = of(VAL, TYP, PCK);
178
179        private final byte data;
180
181        private KindSelector(int data) {
182            this.data = (byte) data;
183        }
184
185        public static KindSelector of(KindSelector... kindSelectors) {
186            byte newData = 0;
187            for (KindSelector kindSel : kindSelectors) {
188                newData |= kindSel.data;
189            }
190            return new KindSelector(newData);
191        }
192
193        public boolean subset(KindSelector other) {
194            return (data & ~other.data) == 0;
195        }
196
197        public boolean contains(KindSelector other) {
198            return (data & other.data) != 0;
199        }
200
201        /** A set of KindName(s) representing a set of symbol's kinds. */
202        public Set<KindName> kindNames() {
203            EnumSet<KindName> kinds = EnumSet.noneOf(KindName.class);
204            if ((data & VAL.data) != 0) {
205                if ((data & VAL.data) == VAR.data) kinds.add(KindName.VAR);
206                else kinds.add(KindName.VAL);
207            }
208            if ((data & MTH.data) != 0) kinds.add(KindName.METHOD);
209            if ((data & TYP.data) != 0) kinds.add(KindName.CLASS);
210            if ((data & PCK.data) != 0) kinds.add(KindName.PACKAGE);
211            return kinds;
212        }
213    }
214
215    public enum KindName implements Formattable {
216        ANNOTATION("kindname.annotation"),
217        CONSTRUCTOR("kindname.constructor"),
218        INTERFACE("kindname.interface"),
219        ENUM("kindname.enum"),
220        STATIC("kindname.static"),
221        TYPEVAR("kindname.type.variable"),
222        BOUND("kindname.type.variable.bound"),
223        VAR("kindname.variable"),
224        VAL("kindname.value"),
225        METHOD("kindname.method"),
226        CLASS("kindname.class"),
227        STATIC_INIT("kindname.static.init"),
228        INSTANCE_INIT("kindname.instance.init"),
229        PACKAGE("kindname.package");
230
231        private final String name;
232
233        KindName(String name) {
234            this.name = name;
235        }
236
237        public String toString() {
238            return name;
239        }
240
241        public String getKind() {
242            return "Kindname";
243        }
244
245        public String toString(Locale locale, Messages messages) {
246            String s = toString();
247            return messages.getLocalizedString(locale, "compiler.misc." + s);
248        }
249    }
250
251    public static KindName kindName(MemberReferenceTree.ReferenceMode mode) {
252        switch (mode) {
253            case INVOKE: return KindName.METHOD;
254            case NEW: return KindName.CONSTRUCTOR;
255            default : throw new AssertionError("Unexpected mode: "+ mode);
256        }
257    }
258
259    /** A KindName representing a given symbol
260     */
261    public static KindName kindName(Symbol sym) {
262        switch (sym.getKind()) {
263        case PACKAGE:
264            return KindName.PACKAGE;
265
266        case ENUM:
267            return KindName.ENUM;
268
269        case ANNOTATION_TYPE:
270        case CLASS:
271            return KindName.CLASS;
272
273        case INTERFACE:
274            return KindName.INTERFACE;
275
276        case TYPE_PARAMETER:
277            return KindName.TYPEVAR;
278
279        case ENUM_CONSTANT:
280        case FIELD:
281        case PARAMETER:
282        case LOCAL_VARIABLE:
283        case EXCEPTION_PARAMETER:
284        case RESOURCE_VARIABLE:
285            return KindName.VAR;
286
287        case CONSTRUCTOR:
288            return KindName.CONSTRUCTOR;
289
290        case METHOD:
291            return KindName.METHOD;
292        case STATIC_INIT:
293            return KindName.STATIC_INIT;
294        case INSTANCE_INIT:
295            return KindName.INSTANCE_INIT;
296
297        default:
298                throw new AssertionError("Unexpected kind: "+sym.getKind());
299        }
300    }
301
302    /** A KindName representing the kind of a given class/interface type.
303     */
304    public static KindName typeKindName(Type t) {
305        if (t.hasTag(TYPEVAR) ||
306            t.hasTag(CLASS) && (t.tsym.flags() & COMPOUND) != 0)
307            return KindName.BOUND;
308        else if (t.hasTag(PACKAGE))
309            return KindName.PACKAGE;
310        else if ((t.tsym.flags_field & ANNOTATION) != 0)
311            return KindName.ANNOTATION;
312        else if ((t.tsym.flags_field & INTERFACE) != 0)
313            return KindName.INTERFACE;
314        else
315            return KindName.CLASS;
316    }
317
318}
319