src/share/classes/com/sun/tools/javac/code/Flags.java

Thu, 02 Oct 2008 19:58:40 -0700

author
xdono
date
Thu, 02 Oct 2008 19:58:40 -0700
changeset 117
24a47c3062fe
parent 80
5c9cdeb740f2
child 482
699ecefbdd4e
permissions
-rw-r--r--

6754988: Update copyright year
Summary: Update for files that have been modified starting July 2008
Reviewed-by: ohair, tbell

duke@1 1 /*
xdono@117 2 * Copyright 1999-2008 Sun Microsystems, Inc. All Rights Reserved.
duke@1 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1 4 *
duke@1 5 * This code is free software; you can redistribute it and/or modify it
duke@1 6 * under the terms of the GNU General Public License version 2 only, as
duke@1 7 * published by the Free Software Foundation. Sun designates this
duke@1 8 * particular file as subject to the "Classpath" exception as provided
duke@1 9 * by Sun in the LICENSE file that accompanied this code.
duke@1 10 *
duke@1 11 * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@1 14 * version 2 for more details (a copy is included in the LICENSE file that
duke@1 15 * accompanied this code).
duke@1 16 *
duke@1 17 * You should have received a copy of the GNU General Public License version
duke@1 18 * 2 along with this work; if not, write to the Free Software Foundation,
duke@1 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1 20 *
duke@1 21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
duke@1 22 * CA 95054 USA or visit www.sun.com if you need additional information or
duke@1 23 * have any questions.
duke@1 24 */
duke@1 25
duke@1 26 package com.sun.tools.javac.code;
duke@1 27
mcimadamore@80 28 import java.util.EnumSet;
duke@1 29 import java.util.Collections;
duke@1 30 import java.util.Map;
duke@1 31 import java.util.Set;
duke@1 32 import javax.lang.model.element.Modifier;
duke@1 33
duke@1 34 /** Access flags and other modifiers for Java classes and members.
duke@1 35 *
duke@1 36 * <p><b>This is NOT part of any API supported by Sun Microsystems. If
duke@1 37 * you write code that depends on this, you do so at your own risk.
duke@1 38 * This code and its internal interfaces are subject to change or
duke@1 39 * deletion without notice.</b>
duke@1 40 */
duke@1 41 public class Flags {
duke@1 42
duke@1 43 private Flags() {} // uninstantiable
duke@1 44
duke@1 45 public static String toString(long flags) {
duke@1 46 StringBuffer buf = new StringBuffer();
mcimadamore@80 47 String sep = "";
mcimadamore@80 48 for (Flag s : asFlagSet(flags)) {
mcimadamore@80 49 buf.append(sep);
mcimadamore@80 50 buf.append(s);
mcimadamore@80 51 sep = " ";
mcimadamore@80 52 }
duke@1 53 return buf.toString();
duke@1 54 }
duke@1 55
mcimadamore@80 56 public static EnumSet<Flag> asFlagSet(long mask) {
mcimadamore@80 57 EnumSet<Flag> flags = EnumSet.noneOf(Flag.class);
mcimadamore@80 58 if ((mask&PUBLIC) != 0) flags.add(Flag.PUBLIC);
mcimadamore@80 59 if ((mask&PRIVATE) != 0) flags.add(Flag.PRIVATE);
mcimadamore@80 60 if ((mask&PROTECTED) != 0) flags.add(Flag.PROTECTED);
mcimadamore@80 61 if ((mask&STATIC) != 0) flags.add(Flag.STATIC);
mcimadamore@80 62 if ((mask&FINAL) != 0) flags.add(Flag.FINAL);
mcimadamore@80 63 if ((mask&SYNCHRONIZED) != 0) flags.add(Flag.SYNCHRONIZED);
mcimadamore@80 64 if ((mask&VOLATILE) != 0) flags.add(Flag.VOLATILE);
mcimadamore@80 65 if ((mask&TRANSIENT) != 0) flags.add(Flag.TRANSIENT);
mcimadamore@80 66 if ((mask&NATIVE) != 0) flags.add(Flag.NATIVE);
mcimadamore@80 67 if ((mask&INTERFACE) != 0) flags.add(Flag.INTERFACE);
mcimadamore@80 68 if ((mask&ABSTRACT) != 0) flags.add(Flag.ABSTRACT);
mcimadamore@80 69 if ((mask&STRICTFP) != 0) flags.add(Flag.STRICTFP);
mcimadamore@80 70 if ((mask&BRIDGE) != 0) flags.add(Flag.BRIDGE);
mcimadamore@80 71 if ((mask&SYNTHETIC) != 0) flags.add(Flag.SYNTHETIC);
mcimadamore@80 72 if ((mask&DEPRECATED) != 0) flags.add(Flag.DEPRECATED);
mcimadamore@80 73 if ((mask&HASINIT) != 0) flags.add(Flag.HASINIT);
mcimadamore@80 74 if ((mask&ENUM) != 0) flags.add(Flag.ENUM);
mcimadamore@80 75 if ((mask&IPROXY) != 0) flags.add(Flag.IPROXY);
mcimadamore@80 76 if ((mask&NOOUTERTHIS) != 0) flags.add(Flag.NOOUTERTHIS);
mcimadamore@80 77 if ((mask&EXISTS) != 0) flags.add(Flag.EXISTS);
mcimadamore@80 78 if ((mask&COMPOUND) != 0) flags.add(Flag.COMPOUND);
mcimadamore@80 79 if ((mask&CLASS_SEEN) != 0) flags.add(Flag.CLASS_SEEN);
mcimadamore@80 80 if ((mask&SOURCE_SEEN) != 0) flags.add(Flag.SOURCE_SEEN);
mcimadamore@80 81 if ((mask&LOCKED) != 0) flags.add(Flag.LOCKED);
mcimadamore@80 82 if ((mask&UNATTRIBUTED) != 0) flags.add(Flag.UNATTRIBUTED);
mcimadamore@80 83 if ((mask&ANONCONSTR) != 0) flags.add(Flag.ANONCONSTR);
mcimadamore@80 84 if ((mask&ACYCLIC) != 0) flags.add(Flag.ACYCLIC);
mcimadamore@80 85 if ((mask&PARAMETER) != 0) flags.add(Flag.PARAMETER);
mcimadamore@80 86 if ((mask&VARARGS) != 0) flags.add(Flag.VARARGS);
mcimadamore@80 87 return flags;
mcimadamore@80 88 }
mcimadamore@80 89
duke@1 90 /* Standard Java flags.
duke@1 91 */
duke@1 92 public static final int PUBLIC = 1<<0;
duke@1 93 public static final int PRIVATE = 1<<1;
duke@1 94 public static final int PROTECTED = 1<<2;
duke@1 95 public static final int STATIC = 1<<3;
duke@1 96 public static final int FINAL = 1<<4;
duke@1 97 public static final int SYNCHRONIZED = 1<<5;
duke@1 98 public static final int VOLATILE = 1<<6;
duke@1 99 public static final int TRANSIENT = 1<<7;
duke@1 100 public static final int NATIVE = 1<<8;
duke@1 101 public static final int INTERFACE = 1<<9;
duke@1 102 public static final int ABSTRACT = 1<<10;
duke@1 103 public static final int STRICTFP = 1<<11;
duke@1 104
duke@1 105 /* Flag that marks a symbol synthetic, added in classfile v49.0. */
duke@1 106 public static final int SYNTHETIC = 1<<12;
duke@1 107
duke@1 108 /** Flag that marks attribute interfaces, added in classfile v49.0. */
duke@1 109 public static final int ANNOTATION = 1<<13;
duke@1 110
duke@1 111 /** An enumeration type or an enumeration constant, added in
duke@1 112 * classfile v49.0. */
duke@1 113 public static final int ENUM = 1<<14;
duke@1 114
duke@1 115 public static final int StandardFlags = 0x0fff;
duke@1 116
duke@1 117 // Because the following access flags are overloaded with other
duke@1 118 // bit positions, we translate them when reading and writing class
duke@1 119 // files into unique bits positions: ACC_SYNTHETIC <-> SYNTHETIC,
duke@1 120 // for example.
duke@1 121 public static final int ACC_SUPER = 0x0020;
duke@1 122 public static final int ACC_BRIDGE = 0x0040;
duke@1 123 public static final int ACC_VARARGS = 0x0080;
duke@1 124
duke@1 125 /*****************************************
duke@1 126 * Internal compiler flags (no bits in the lower 16).
duke@1 127 *****************************************/
duke@1 128
duke@1 129 /** Flag is set if symbol is deprecated.
duke@1 130 */
duke@1 131 public static final int DEPRECATED = 1<<17;
duke@1 132
duke@1 133 /** Flag is set for a variable symbol if the variable's definition
duke@1 134 * has an initializer part.
duke@1 135 */
duke@1 136 public static final int HASINIT = 1<<18;
duke@1 137
duke@1 138 /** Flag is set for compiler-generated anonymous method symbols
duke@1 139 * that `own' an initializer block.
duke@1 140 */
duke@1 141 public static final int BLOCK = 1<<20;
duke@1 142
duke@1 143 /** Flag is set for compiler-generated abstract methods that implement
duke@1 144 * an interface method (Miranda methods).
duke@1 145 */
duke@1 146 public static final int IPROXY = 1<<21;
duke@1 147
duke@1 148 /** Flag is set for nested classes that do not access instance members
duke@1 149 * or `this' of an outer class and therefore don't need to be passed
duke@1 150 * a this$n reference. This flag is currently set only for anonymous
duke@1 151 * classes in superclass constructor calls and only for pre 1.4 targets.
duke@1 152 * todo: use this flag for optimizing away this$n parameters in
duke@1 153 * other cases.
duke@1 154 */
duke@1 155 public static final int NOOUTERTHIS = 1<<22;
duke@1 156
duke@1 157 /** Flag is set for package symbols if a package has a member or
duke@1 158 * directory and therefore exists.
duke@1 159 */
duke@1 160 public static final int EXISTS = 1<<23;
duke@1 161
duke@1 162 /** Flag is set for compiler-generated compound classes
duke@1 163 * representing multiple variable bounds
duke@1 164 */
duke@1 165 public static final int COMPOUND = 1<<24;
duke@1 166
duke@1 167 /** Flag is set for class symbols if a class file was found for this class.
duke@1 168 */
duke@1 169 public static final int CLASS_SEEN = 1<<25;
duke@1 170
duke@1 171 /** Flag is set for class symbols if a source file was found for this
duke@1 172 * class.
duke@1 173 */
duke@1 174 public static final int SOURCE_SEEN = 1<<26;
duke@1 175
duke@1 176 /* State flags (are reset during compilation).
duke@1 177 */
duke@1 178
duke@1 179 /** Flag for class symbols is set and later re-set as a lock in
duke@1 180 * Enter to detect cycles in the superclass/superinterface
duke@1 181 * relations. Similarly for constructor call cycle detection in
duke@1 182 * Attr.
duke@1 183 */
duke@1 184 public static final int LOCKED = 1<<27;
duke@1 185
duke@1 186 /** Flag for class symbols is set and later re-set to indicate that a class
duke@1 187 * has been entered but has not yet been attributed.
duke@1 188 */
duke@1 189 public static final int UNATTRIBUTED = 1<<28;
duke@1 190
duke@1 191 /** Flag for synthesized default constructors of anonymous classes.
duke@1 192 */
duke@1 193 public static final int ANONCONSTR = 1<<29;
duke@1 194
duke@1 195 /** Flag for class symbols to indicate it has been checked and found
duke@1 196 * acyclic.
duke@1 197 */
duke@1 198 public static final int ACYCLIC = 1<<30;
duke@1 199
duke@1 200 /** Flag that marks bridge methods.
duke@1 201 */
duke@1 202 public static final long BRIDGE = 1L<<31;
duke@1 203
duke@1 204 /** Flag that marks formal parameters.
duke@1 205 */
duke@1 206 public static final long PARAMETER = 1L<<33;
duke@1 207
duke@1 208 /** Flag that marks varargs methods.
duke@1 209 */
duke@1 210 public static final long VARARGS = 1L<<34;
duke@1 211
duke@1 212 /** Flag for annotation type symbols to indicate it has been
duke@1 213 * checked and found acyclic.
duke@1 214 */
duke@1 215 public static final long ACYCLIC_ANN = 1L<<35;
duke@1 216
duke@1 217 /** Flag that marks a generated default constructor.
duke@1 218 */
duke@1 219 public static final long GENERATEDCONSTR = 1L<<36;
duke@1 220
duke@1 221 /** Flag that marks a hypothetical method that need not really be
duke@1 222 * generated in the binary, but is present in the symbol table to
duke@1 223 * simplify checking for erasure clashes.
duke@1 224 */
duke@1 225 public static final long HYPOTHETICAL = 1L<<37;
duke@1 226
duke@1 227 /**
duke@1 228 * Flag that marks a Sun proprietary class.
duke@1 229 */
duke@1 230 public static final long PROPRIETARY = 1L<<38;
duke@1 231
duke@1 232 /** Modifier masks.
duke@1 233 */
duke@1 234 public static final int
duke@1 235 AccessFlags = PUBLIC | PROTECTED | PRIVATE,
duke@1 236 LocalClassFlags = FINAL | ABSTRACT | STRICTFP | ENUM | SYNTHETIC,
duke@1 237 MemberClassFlags = LocalClassFlags | INTERFACE | AccessFlags,
duke@1 238 ClassFlags = LocalClassFlags | INTERFACE | PUBLIC | ANNOTATION,
duke@1 239 InterfaceVarFlags = FINAL | STATIC | PUBLIC,
duke@1 240 VarFlags = AccessFlags | FINAL | STATIC |
duke@1 241 VOLATILE | TRANSIENT | ENUM,
duke@1 242 ConstructorFlags = AccessFlags,
duke@1 243 InterfaceMethodFlags = ABSTRACT | PUBLIC,
duke@1 244 MethodFlags = AccessFlags | ABSTRACT | STATIC | NATIVE |
duke@1 245 SYNCHRONIZED | FINAL | STRICTFP;
duke@1 246 public static final long
duke@1 247 LocalVarFlags = FINAL | PARAMETER;
duke@1 248
duke@1 249 public static Set<Modifier> asModifierSet(long flags) {
duke@1 250 Set<Modifier> modifiers = modifierSets.get(flags);
duke@1 251 if (modifiers == null) {
duke@1 252 modifiers = java.util.EnumSet.noneOf(Modifier.class);
duke@1 253 if (0 != (flags & PUBLIC)) modifiers.add(Modifier.PUBLIC);
duke@1 254 if (0 != (flags & PROTECTED)) modifiers.add(Modifier.PROTECTED);
duke@1 255 if (0 != (flags & PRIVATE)) modifiers.add(Modifier.PRIVATE);
duke@1 256 if (0 != (flags & ABSTRACT)) modifiers.add(Modifier.ABSTRACT);
duke@1 257 if (0 != (flags & STATIC)) modifiers.add(Modifier.STATIC);
duke@1 258 if (0 != (flags & FINAL)) modifiers.add(Modifier.FINAL);
duke@1 259 if (0 != (flags & TRANSIENT)) modifiers.add(Modifier.TRANSIENT);
duke@1 260 if (0 != (flags & VOLATILE)) modifiers.add(Modifier.VOLATILE);
duke@1 261 if (0 != (flags & SYNCHRONIZED))
duke@1 262 modifiers.add(Modifier.SYNCHRONIZED);
duke@1 263 if (0 != (flags & NATIVE)) modifiers.add(Modifier.NATIVE);
duke@1 264 if (0 != (flags & STRICTFP)) modifiers.add(Modifier.STRICTFP);
duke@1 265 modifiers = Collections.unmodifiableSet(modifiers);
duke@1 266 modifierSets.put(flags, modifiers);
duke@1 267 }
duke@1 268 return modifiers;
duke@1 269 }
duke@1 270
duke@1 271 // Cache of modifier sets.
duke@1 272 private static Map<Long, Set<Modifier>> modifierSets =
duke@1 273 new java.util.concurrent.ConcurrentHashMap<Long, Set<Modifier>>(64);
duke@1 274
duke@1 275 public static boolean isStatic(Symbol symbol) {
duke@1 276 return (symbol.flags() & STATIC) != 0;
duke@1 277 }
duke@1 278
duke@1 279 public static boolean isEnum(Symbol symbol) {
duke@1 280 return (symbol.flags() & ENUM) != 0;
duke@1 281 }
duke@1 282
duke@1 283 public static boolean isConstant(Symbol.VarSymbol symbol) {
duke@1 284 return symbol.getConstValue() != null;
duke@1 285 }
mcimadamore@80 286
mcimadamore@80 287 public enum Flag {
mcimadamore@80 288
mcimadamore@80 289 PUBLIC("public"),
mcimadamore@80 290 PRIVATE("private"),
mcimadamore@80 291 PROTECTED("protected"),
mcimadamore@80 292 STATIC("static"),
mcimadamore@80 293 FINAL("final"),
mcimadamore@80 294 SYNCHRONIZED("synchronized"),
mcimadamore@80 295 VOLATILE("volatile"),
mcimadamore@80 296 TRANSIENT("transient"),
mcimadamore@80 297 NATIVE("native"),
mcimadamore@80 298 INTERFACE("interface"),
mcimadamore@80 299 ABSTRACT("abstract"),
mcimadamore@80 300 STRICTFP("strictfp"),
mcimadamore@80 301 BRIDGE("bridge"),
mcimadamore@80 302 SYNTHETIC("synthetic"),
mcimadamore@80 303 DEPRECATED("deprecated"),
mcimadamore@80 304 HASINIT("hasinit"),
mcimadamore@80 305 ENUM("enum"),
mcimadamore@80 306 IPROXY("iproxy"),
mcimadamore@80 307 NOOUTERTHIS("noouterthis"),
mcimadamore@80 308 EXISTS("exists"),
mcimadamore@80 309 COMPOUND("compound"),
mcimadamore@80 310 CLASS_SEEN("class_seen"),
mcimadamore@80 311 SOURCE_SEEN("source_seen"),
mcimadamore@80 312 LOCKED("locked"),
mcimadamore@80 313 UNATTRIBUTED("unattributed"),
mcimadamore@80 314 ANONCONSTR("anonconstr"),
mcimadamore@80 315 ACYCLIC("acyclic"),
mcimadamore@80 316 PARAMETER("parameter"),
mcimadamore@80 317 VARARGS("varargs"),
mcimadamore@80 318 PACKAGE("package");
mcimadamore@80 319
mcimadamore@80 320 String name;
mcimadamore@80 321
mcimadamore@80 322 Flag(String name) {
mcimadamore@80 323 this.name = name;
mcimadamore@80 324 }
mcimadamore@80 325
mcimadamore@80 326 public String toString() {
mcimadamore@80 327 return name;
mcimadamore@80 328 }
mcimadamore@80 329 }
duke@1 330 }

mercurial