duke@1: /*
jjg@1358:  * Copyright (c) 1999, 2012, Oracle and/or its affiliates. All rights reserved.
duke@1:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1:  *
duke@1:  * This code is free software; you can redistribute it and/or modify it
duke@1:  * under the terms of the GNU General Public License version 2 only, as
ohair@554:  * published by the Free Software Foundation.  Oracle designates this
duke@1:  * particular file as subject to the "Classpath" exception as provided
ohair@554:  * by Oracle in the LICENSE file that accompanied this code.
duke@1:  *
duke@1:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@1:  * version 2 for more details (a copy is included in the LICENSE file that
duke@1:  * accompanied this code).
duke@1:  *
duke@1:  * You should have received a copy of the GNU General Public License version
duke@1:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@1:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1:  *
ohair@554:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554:  * or visit www.oracle.com if you need additional information or have any
ohair@554:  * questions.
duke@1:  */
duke@1: 
duke@1: package com.sun.tools.javac.code;
duke@1: 
jjg@1374: import com.sun.source.tree.Tree.Kind;
jjg@1374: 
jjg@1374: import javax.lang.model.type.TypeKind;
duke@1: 
duke@1: /** An interface for type tag values, which distinguish between different
duke@1:  *  sorts of types.
duke@1:  *
jjg@581:  *  <p><b>This is NOT part of any supported API.
jjg@581:  *  If you write code that depends on this, you do so at your own risk.
duke@1:  *  This code and its internal interfaces are subject to change or
duke@1:  *  deletion without notice.</b>
duke@1:  */
jjg@1374: public enum TypeTag {
duke@1:     /** The tag of the basic type `byte'.
duke@1:      */
jjg@1374:     BYTE(1),
duke@1: 
duke@1:     /** The tag of the basic type `char'.
duke@1:      */
jjg@1374:     CHAR(2),
duke@1: 
duke@1:     /** The tag of the basic type `short'.
duke@1:      */
jjg@1374:     SHORT(3),
duke@1: 
duke@1:     /** The tag of the basic type `int'.
duke@1:      */
jjg@1374:     INT(4),
duke@1: 
duke@1:     /** The tag of the basic type `long'.
duke@1:      */
jjg@1374:     LONG(5),
duke@1: 
duke@1:     /** The tag of the basic type `float'.
duke@1:      */
jjg@1374:     FLOAT(6),
duke@1: 
duke@1:     /** The tag of the basic type `double'.
duke@1:      */
jjg@1374:     DOUBLE(7),
duke@1: 
duke@1:     /** The tag of the basic type `boolean'.
duke@1:      */
jjg@1374:     BOOLEAN,
duke@1: 
duke@1:     /** The tag of the type `void'.
duke@1:      */
jjg@1374:     VOID,
duke@1: 
duke@1:     /** The tag of all class and interface types.
duke@1:      */
jjg@1374:     CLASS,
duke@1: 
duke@1:     /** The tag of all array types.
duke@1:      */
jjg@1374:     ARRAY,
duke@1: 
duke@1:     /** The tag of all (monomorphic) method types.
duke@1:      */
jjg@1374:     METHOD,
duke@1: 
duke@1:     /** The tag of all package "types".
duke@1:      */
jjg@1374:     PACKAGE,
duke@1: 
duke@1:     /** The tag of all (source-level) type variables.
duke@1:      */
jjg@1374:     TYPEVAR,
duke@1: 
duke@1:     /** The tag of all type arguments.
duke@1:      */
jjg@1374:     WILDCARD,
duke@1: 
duke@1:     /** The tag of all polymorphic (method-) types.
duke@1:      */
jjg@1374:     FORALL,
duke@1: 
mcimadamore@1347:     /** The tag of deferred expression types in method context
mcimadamore@1347:      */
jjg@1374:     DEFERRED,
mcimadamore@1347: 
jjg@1381:     /** The tag of the bottom type {@code <null>}.
duke@1:      */
jjg@1374:     BOT,
duke@1: 
duke@1:     /** The tag of a missing type.
duke@1:      */
jjg@1374:     NONE,
duke@1: 
duke@1:     /** The tag of the error type.
duke@1:      */
jjg@1374:     ERROR,
duke@1: 
duke@1:     /** The tag of an unknown type
duke@1:      */
jjg@1374:     UNKNOWN,
duke@1: 
duke@1:     /** The tag of all instantiatable type variables.
duke@1:      */
jjg@1374:     UNDETVAR,
duke@1: 
jjg@1374:     /** Pseudo-types, these are special tags
duke@1:      */
jjg@1374:     UNINITIALIZED_THIS,
duke@1: 
jjg@1374:     UNINITIALIZED_OBJECT;
jjg@1374: 
jjg@1374:     /** This field will only be used for tags related with numeric types for
jjg@1374:      *  optimization reasons.
duke@1:      */
vromero@1442:     private final int order;
duke@1: 
vromero@1442:     private TypeTag() {
vromero@1442:         this(0);
vromero@1442:     }
jjg@1374: 
jjg@1374:     private TypeTag(int order) {
jjg@1374:         this.order = order;
jjg@1374:     }
jjg@1374: 
jjg@1374:     private static final int MIN_NUMERIC_TAG_ORDER = 1;
jjg@1374:     private static final int MAX_NUMERIC_TAG_ORDER = 7;
jjg@1374: 
jjg@1374:     /** Returns the number of type tags.
duke@1:      */
jjg@1374:     public static int getTypeTagCount() {
jjg@1374:         // last two tags are not included in the total as long as they are pseudo-types
jjg@1374:         return (UNDETVAR.ordinal() + 1);
jjg@1374:     }
jjg@1374: 
jjg@1374:     public boolean isSubRangeOf(TypeTag range) {
jjg@1374:         return (this == range) || isStrictSubRangeOf(range);
jjg@1374:     }
jjg@1374: 
jjg@1374:     public boolean isStrictSubRangeOf(TypeTag range) {
jjg@1374:         if (this.order >= MIN_NUMERIC_TAG_ORDER && this.order <= MAX_NUMERIC_TAG_ORDER &&
jjg@1374:             range.order >= MIN_NUMERIC_TAG_ORDER && this.order <= MAX_NUMERIC_TAG_ORDER) {
jjg@1374:             if (this == range)
jjg@1374:                 return false;
jjg@1374:             switch (this) {
jjg@1374:                 case BYTE:
jjg@1374:                     return true;
jjg@1374:                 case CHAR: case SHORT: case INT:
jjg@1374:                 case LONG: case FLOAT:
jjg@1374:                     return this.order < range.order && range.order <= MAX_NUMERIC_TAG_ORDER;
jjg@1374:                 default:
jjg@1374:                     return false;
jjg@1374:             }
jjg@1374:         }
jjg@1374:         else
jjg@1374:             return false;
jjg@1374:     }
jjg@1374: 
jjg@1374:     public Kind getKindLiteral() {
jjg@1374:         switch (this) {
jjg@1374:         case INT:
jjg@1374:             return Kind.INT_LITERAL;
jjg@1374:         case LONG:
jjg@1374:             return Kind.LONG_LITERAL;
jjg@1374:         case FLOAT:
jjg@1374:             return Kind.FLOAT_LITERAL;
jjg@1374:         case DOUBLE:
jjg@1374:             return Kind.DOUBLE_LITERAL;
jjg@1374:         case BOOLEAN:
jjg@1374:             return Kind.BOOLEAN_LITERAL;
jjg@1374:         case CHAR:
jjg@1374:             return Kind.CHAR_LITERAL;
jjg@1374:         case CLASS:
jjg@1374:             return Kind.STRING_LITERAL;
jjg@1374:         case BOT:
jjg@1374:             return Kind.NULL_LITERAL;
jjg@1374:         default:
jjg@1374:             throw new AssertionError("unknown literal kind " + this);
jjg@1374:         }
jjg@1374:     }
jjg@1374: 
jjg@1374:     public TypeKind getPrimitiveTypeKind() {
jjg@1374:         switch (this) {
jjg@1374:         case BOOLEAN:
jjg@1374:             return TypeKind.BOOLEAN;
jjg@1374:         case BYTE:
jjg@1374:             return TypeKind.BYTE;
jjg@1374:         case SHORT:
jjg@1374:             return TypeKind.SHORT;
jjg@1374:         case INT:
jjg@1374:             return TypeKind.INT;
jjg@1374:         case LONG:
jjg@1374:             return TypeKind.LONG;
jjg@1374:         case CHAR:
jjg@1374:             return TypeKind.CHAR;
jjg@1374:         case FLOAT:
jjg@1374:             return TypeKind.FLOAT;
jjg@1374:         case DOUBLE:
jjg@1374:             return TypeKind.DOUBLE;
jjg@1374:         case VOID:
jjg@1374:             return TypeKind.VOID;
jjg@1374:         default:
jjg@1374:             throw new AssertionError("unknown primitive type " + this);
jjg@1374:         }
jjg@1374:     }
duke@1: }