duke@1: /* duke@1: * Copyright 1999-2006 Sun Microsystems, Inc. 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 duke@1: * published by the Free Software Foundation. Sun designates this duke@1: * particular file as subject to the "Classpath" exception as provided duke@1: * by Sun 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: * duke@1: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, duke@1: * CA 95054 USA or visit www.sun.com if you need additional information or duke@1: * have any questions. duke@1: */ duke@1: duke@1: package com.sun.tools.javac.code; duke@1: duke@1: import java.util.Collections; duke@1: import java.util.Map; duke@1: import java.util.Set; duke@1: import javax.lang.model.element.Modifier; duke@1: duke@1: /** Access flags and other modifiers for Java classes and members. duke@1: * duke@1: *
This is NOT part of any API supported by Sun Microsystems. If
duke@1: * 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.
duke@1: */
duke@1: public class Flags {
duke@1:
duke@1: private Flags() {} // uninstantiable
duke@1:
duke@1: public static String toString(long flags) {
duke@1: StringBuffer buf = new StringBuffer();
duke@1: if ((flags&PUBLIC) != 0) buf.append("public ");
duke@1: if ((flags&PRIVATE) != 0) buf.append("private ");
duke@1: if ((flags&PROTECTED) != 0) buf.append("protected ");
duke@1: if ((flags&STATIC) != 0) buf.append("static ");
duke@1: if ((flags&FINAL) != 0) buf.append("final ");
duke@1: if ((flags&SYNCHRONIZED) != 0) buf.append("synchronized ");
duke@1: if ((flags&VOLATILE) != 0) buf.append("volatile ");
duke@1: if ((flags&TRANSIENT) != 0) buf.append("transient ");
duke@1: if ((flags&NATIVE) != 0) buf.append("native ");
duke@1: if ((flags&INTERFACE) != 0) buf.append("interface ");
duke@1: if ((flags&ABSTRACT) != 0) buf.append("abstract ");
duke@1: if ((flags&STRICTFP) != 0) buf.append("strictfp ");
duke@1: if ((flags&BRIDGE) != 0) buf.append("bridge ");
duke@1: if ((flags&SYNTHETIC) != 0) buf.append("synthetic ");
duke@1: if ((flags&DEPRECATED) != 0) buf.append("deprecated ");
duke@1: if ((flags&HASINIT) != 0) buf.append("hasinit ");
duke@1: if ((flags&ENUM) != 0) buf.append("enum ");
duke@1: if ((flags&IPROXY) != 0) buf.append("iproxy ");
duke@1: if ((flags&NOOUTERTHIS) != 0) buf.append("noouterthis ");
duke@1: if ((flags&EXISTS) != 0) buf.append("exists ");
duke@1: if ((flags&COMPOUND) != 0) buf.append("compound ");
duke@1: if ((flags&CLASS_SEEN) != 0) buf.append("class_seen ");
duke@1: if ((flags&SOURCE_SEEN) != 0) buf.append("source_seen ");
duke@1: if ((flags&LOCKED) != 0) buf.append("locked ");
duke@1: if ((flags&UNATTRIBUTED) != 0) buf.append("unattributed ");
duke@1: if ((flags&ANONCONSTR) != 0) buf.append("anonconstr ");
duke@1: if ((flags&ACYCLIC) != 0) buf.append("acyclic ");
duke@1: if ((flags&PARAMETER) != 0) buf.append("parameter ");
duke@1: if ((flags&VARARGS) != 0) buf.append("varargs ");
duke@1: return buf.toString();
duke@1: }
duke@1:
duke@1: /* Standard Java flags.
duke@1: */
duke@1: public static final int PUBLIC = 1<<0;
duke@1: public static final int PRIVATE = 1<<1;
duke@1: public static final int PROTECTED = 1<<2;
duke@1: public static final int STATIC = 1<<3;
duke@1: public static final int FINAL = 1<<4;
duke@1: public static final int SYNCHRONIZED = 1<<5;
duke@1: public static final int VOLATILE = 1<<6;
duke@1: public static final int TRANSIENT = 1<<7;
duke@1: public static final int NATIVE = 1<<8;
duke@1: public static final int INTERFACE = 1<<9;
duke@1: public static final int ABSTRACT = 1<<10;
duke@1: public static final int STRICTFP = 1<<11;
duke@1:
duke@1: /* Flag that marks a symbol synthetic, added in classfile v49.0. */
duke@1: public static final int SYNTHETIC = 1<<12;
duke@1:
duke@1: /** Flag that marks attribute interfaces, added in classfile v49.0. */
duke@1: public static final int ANNOTATION = 1<<13;
duke@1:
duke@1: /** An enumeration type or an enumeration constant, added in
duke@1: * classfile v49.0. */
duke@1: public static final int ENUM = 1<<14;
duke@1:
duke@1: public static final int StandardFlags = 0x0fff;
duke@1:
duke@1: // Because the following access flags are overloaded with other
duke@1: // bit positions, we translate them when reading and writing class
duke@1: // files into unique bits positions: ACC_SYNTHETIC <-> SYNTHETIC,
duke@1: // for example.
duke@1: public static final int ACC_SUPER = 0x0020;
duke@1: public static final int ACC_BRIDGE = 0x0040;
duke@1: public static final int ACC_VARARGS = 0x0080;
duke@1:
duke@1: /*****************************************
duke@1: * Internal compiler flags (no bits in the lower 16).
duke@1: *****************************************/
duke@1:
duke@1: /** Flag is set if symbol is deprecated.
duke@1: */
duke@1: public static final int DEPRECATED = 1<<17;
duke@1:
duke@1: /** Flag is set for a variable symbol if the variable's definition
duke@1: * has an initializer part.
duke@1: */
duke@1: public static final int HASINIT = 1<<18;
duke@1:
duke@1: /** Flag is set for compiler-generated anonymous method symbols
duke@1: * that `own' an initializer block.
duke@1: */
duke@1: public static final int BLOCK = 1<<20;
duke@1:
duke@1: /** Flag is set for compiler-generated abstract methods that implement
duke@1: * an interface method (Miranda methods).
duke@1: */
duke@1: public static final int IPROXY = 1<<21;
duke@1:
duke@1: /** Flag is set for nested classes that do not access instance members
duke@1: * or `this' of an outer class and therefore don't need to be passed
duke@1: * a this$n reference. This flag is currently set only for anonymous
duke@1: * classes in superclass constructor calls and only for pre 1.4 targets.
duke@1: * todo: use this flag for optimizing away this$n parameters in
duke@1: * other cases.
duke@1: */
duke@1: public static final int NOOUTERTHIS = 1<<22;
duke@1:
duke@1: /** Flag is set for package symbols if a package has a member or
duke@1: * directory and therefore exists.
duke@1: */
duke@1: public static final int EXISTS = 1<<23;
duke@1:
duke@1: /** Flag is set for compiler-generated compound classes
duke@1: * representing multiple variable bounds
duke@1: */
duke@1: public static final int COMPOUND = 1<<24;
duke@1:
duke@1: /** Flag is set for class symbols if a class file was found for this class.
duke@1: */
duke@1: public static final int CLASS_SEEN = 1<<25;
duke@1:
duke@1: /** Flag is set for class symbols if a source file was found for this
duke@1: * class.
duke@1: */
duke@1: public static final int SOURCE_SEEN = 1<<26;
duke@1:
duke@1: /* State flags (are reset during compilation).
duke@1: */
duke@1:
duke@1: /** Flag for class symbols is set and later re-set as a lock in
duke@1: * Enter to detect cycles in the superclass/superinterface
duke@1: * relations. Similarly for constructor call cycle detection in
duke@1: * Attr.
duke@1: */
duke@1: public static final int LOCKED = 1<<27;
duke@1:
duke@1: /** Flag for class symbols is set and later re-set to indicate that a class
duke@1: * has been entered but has not yet been attributed.
duke@1: */
duke@1: public static final int UNATTRIBUTED = 1<<28;
duke@1:
duke@1: /** Flag for synthesized default constructors of anonymous classes.
duke@1: */
duke@1: public static final int ANONCONSTR = 1<<29;
duke@1:
duke@1: /** Flag for class symbols to indicate it has been checked and found
duke@1: * acyclic.
duke@1: */
duke@1: public static final int ACYCLIC = 1<<30;
duke@1:
duke@1: /** Flag that marks bridge methods.
duke@1: */
duke@1: public static final long BRIDGE = 1L<<31;
duke@1:
duke@1: /** Flag that marks formal parameters.
duke@1: */
duke@1: public static final long PARAMETER = 1L<<33;
duke@1:
duke@1: /** Flag that marks varargs methods.
duke@1: */
duke@1: public static final long VARARGS = 1L<<34;
duke@1:
duke@1: /** Flag for annotation type symbols to indicate it has been
duke@1: * checked and found acyclic.
duke@1: */
duke@1: public static final long ACYCLIC_ANN = 1L<<35;
duke@1:
duke@1: /** Flag that marks a generated default constructor.
duke@1: */
duke@1: public static final long GENERATEDCONSTR = 1L<<36;
duke@1:
duke@1: /** Flag that marks a hypothetical method that need not really be
duke@1: * generated in the binary, but is present in the symbol table to
duke@1: * simplify checking for erasure clashes.
duke@1: */
duke@1: public static final long HYPOTHETICAL = 1L<<37;
duke@1:
duke@1: /**
duke@1: * Flag that marks a Sun proprietary class.
duke@1: */
duke@1: public static final long PROPRIETARY = 1L<<38;
duke@1:
duke@1: /** Modifier masks.
duke@1: */
duke@1: public static final int
duke@1: AccessFlags = PUBLIC | PROTECTED | PRIVATE,
duke@1: LocalClassFlags = FINAL | ABSTRACT | STRICTFP | ENUM | SYNTHETIC,
duke@1: MemberClassFlags = LocalClassFlags | INTERFACE | AccessFlags,
duke@1: ClassFlags = LocalClassFlags | INTERFACE | PUBLIC | ANNOTATION,
duke@1: InterfaceVarFlags = FINAL | STATIC | PUBLIC,
duke@1: VarFlags = AccessFlags | FINAL | STATIC |
duke@1: VOLATILE | TRANSIENT | ENUM,
duke@1: ConstructorFlags = AccessFlags,
duke@1: InterfaceMethodFlags = ABSTRACT | PUBLIC,
duke@1: MethodFlags = AccessFlags | ABSTRACT | STATIC | NATIVE |
duke@1: SYNCHRONIZED | FINAL | STRICTFP;
duke@1: public static final long
duke@1: LocalVarFlags = FINAL | PARAMETER;
duke@1:
duke@1: public static Set