com.redhat.ceylon.langtools.tools.javac.jvm.ClassWriter Maven / Gradle / Ivy
/*
* Copyright (c) 1999, 2011, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package com.redhat.ceylon.langtools.tools.javac.jvm;
import java.io.*;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.Set;
import java.util.HashSet;
import com.redhat.ceylon.javax.tools.FileObject;
import com.redhat.ceylon.javax.tools.JavaFileManager;
import com.redhat.ceylon.javax.tools.JavaFileObject;
import com.redhat.ceylon.langtools.tools.javac.code.*;
import com.redhat.ceylon.langtools.tools.javac.code.Attribute.RetentionPolicy;
import com.redhat.ceylon.langtools.tools.javac.code.Symbol.*;
import com.redhat.ceylon.langtools.tools.javac.code.Type.*;
import com.redhat.ceylon.langtools.tools.javac.file.BaseFileObject;
import com.redhat.ceylon.langtools.tools.javac.jvm.Pool.DynamicMethod;
import com.redhat.ceylon.langtools.tools.javac.jvm.Pool.MethodHandle;
import com.redhat.ceylon.langtools.tools.javac.util.*;
import static com.redhat.ceylon.javax.tools.StandardLocation.CLASS_OUTPUT;
import static com.redhat.ceylon.langtools.tools.javac.code.BoundKind.*;
import static com.redhat.ceylon.langtools.tools.javac.code.Flags.*;
import static com.redhat.ceylon.langtools.tools.javac.code.Kinds.*;
import static com.redhat.ceylon.langtools.tools.javac.code.TypeTags.*;
import static com.redhat.ceylon.langtools.tools.javac.jvm.UninitializedType.*;
import static com.redhat.ceylon.langtools.tools.javac.main.OptionName.*;
/** This class provides operations to map an internal symbol table graph
* rooted in a ClassSymbol into a classfile.
*
* This is NOT part of any supported API.
* If you write code that depends on this, you do so at your own risk.
* This code and its internal interfaces are subject to change or
* deletion without notice.
*/
public class ClassWriter extends ClassFile {
protected static final Context.Key classWriterKey =
new Context.Key();
private final Symtab syms;
private final Options options;
/** Switch: verbose output.
*/
private boolean verbose;
/** Switch: scrable private names.
*/
private boolean scramble;
/** Switch: scrable private names.
*/
private boolean scrambleAll;
/** Switch: retrofit mode.
*/
private boolean retrofit;
/** Switch: emit source file attribute.
*/
private boolean emitSourceFile;
/** Switch: generate CharacterRangeTable attribute.
*/
private boolean genCrt;
/** Switch: describe the generated stackmap
*/
boolean debugstackmap;
/**
* Target class version.
*/
private Target target;
/**
* Source language version.
*/
private Source source;
/** Type utilities. */
private Types types;
/** The initial sizes of the data and constant pool buffers.
* sizes are increased when buffers get full.
*/
static final int DATA_BUF_SIZE = 0x0fff0;
static final int POOL_BUF_SIZE = 0x1fff0;
/** An output buffer for member info.
*/
ByteBuffer databuf = new ByteBuffer(DATA_BUF_SIZE);
/** An output buffer for the constant pool.
*/
ByteBuffer poolbuf = new ByteBuffer(POOL_BUF_SIZE);
/** An output buffer for type signatures.
*/
ByteBuffer sigbuf = new ByteBuffer();
/** The constant pool.
*/
Pool pool;
/** The inner classes to be written, as a set.
*/
Set innerClasses;
/** The inner classes to be written, as a queue where
* enclosing classes come first.
*/
ListBuffer innerClassesQueue;
// Backported by Ceylon from JDK8
/** The bootstrap methods to be written in the corresponding class attribute
* (one for each invokedynamic)
*/
Map bootstrapMethods;
/** The log to use for verbose output.
*/
private final Log log;
/** The name table. */
private final Names names;
/** Access to files. */
private final JavaFileManager fileManager;
/** The tags and constants used in compressed stackmap. */
static final int SAME_FRAME_SIZE = 64;
static final int SAME_LOCALS_1_STACK_ITEM_EXTENDED = 247;
static final int SAME_FRAME_EXTENDED = 251;
static final int FULL_FRAME = 255;
static final int MAX_LOCAL_LENGTH_DIFF = 4;
/** Get the ClassWriter instance for this context. */
public static ClassWriter instance(Context context) {
ClassWriter instance = context.get(classWriterKey);
if (instance == null)
instance = new ClassWriter(context);
return instance;
}
/** Construct a class writer, given an options table.
*/
protected ClassWriter(Context context) {
context.put(classWriterKey, this);
log = Log.instance(context);
names = Names.instance(context);
syms = Symtab.instance(context);
options = Options.instance(context);
target = Target.instance(context);
source = Source.instance(context);
types = Types.instance(context);
fileManager = context.get(JavaFileManager.class);
verbose = options.isSet(VERBOSE);
scramble = options.isSet("-scramble");
scrambleAll = options.isSet("-scrambleAll");
retrofit = options.isSet("-retrofit");
genCrt = options.isSet(XJCOV);
debugstackmap = options.isSet("debugstackmap");
emitSourceFile = options.isUnset(G_CUSTOM) ||
options.isSet(G_CUSTOM, "source");
String dumpModFlags = options.get("dumpmodifiers");
dumpClassModifiers =
(dumpModFlags != null && dumpModFlags.indexOf('c') != -1);
dumpFieldModifiers =
(dumpModFlags != null && dumpModFlags.indexOf('f') != -1);
dumpInnerClassModifiers =
(dumpModFlags != null && dumpModFlags.indexOf('i') != -1);
dumpMethodModifiers =
(dumpModFlags != null && dumpModFlags.indexOf('m') != -1);
}
/******************************************************************
* Diagnostics: dump generated class names and modifiers
******************************************************************/
/** Value of option 'dumpmodifiers' is a string
* indicating which modifiers should be dumped for debugging:
* 'c' -- classes
* 'f' -- fields
* 'i' -- innerclass attributes
* 'm' -- methods
* For example, to dump everything:
* javac -XDdumpmodifiers=cifm MyProg.java
*/
private final boolean dumpClassModifiers; // -XDdumpmodifiers=c
private final boolean dumpFieldModifiers; // -XDdumpmodifiers=f
private final boolean dumpInnerClassModifiers; // -XDdumpmodifiers=i
private final boolean dumpMethodModifiers; // -XDdumpmodifiers=m
/** Return flags as a string, separated by " ".
*/
public static String flagNames(long flags) {
StringBuilder sbuf = new StringBuilder();
int i = 0;
long f = flags & StandardFlags;
while (f != 0) {
if ((f & 1) != 0) {
sbuf.append(" ");
sbuf.append(flagName[i]);
}
f = f >> 1;
i++;
}
return sbuf.toString();
}
//where
private final static String[] flagName = {
"PUBLIC", "PRIVATE", "PROTECTED", "STATIC", "FINAL",
"SUPER", "VOLATILE", "TRANSIENT", "NATIVE", "INTERFACE",
"ABSTRACT", "STRICTFP"};
/******************************************************************
* Output routines
******************************************************************/
/** Write a character into given byte buffer;
* byte buffer will not be grown.
*/
void putChar(ByteBuffer buf, int op, int x) {
buf.elems[op ] = (byte)((x >> 8) & 0xFF);
buf.elems[op+1] = (byte)((x ) & 0xFF);
}
/** Write an integer into given byte buffer;
* byte buffer will not be grown.
*/
void putInt(ByteBuffer buf, int adr, int x) {
buf.elems[adr ] = (byte)((x >> 24) & 0xFF);
buf.elems[adr+1] = (byte)((x >> 16) & 0xFF);
buf.elems[adr+2] = (byte)((x >> 8) & 0xFF);
buf.elems[adr+3] = (byte)((x ) & 0xFF);
}
/******************************************************************
* Signature Generation
******************************************************************/
/** Assemble signature of given type in string buffer.
*/
void assembleSig(Type type) {
switch (type.tag) {
case BYTE:
sigbuf.appendByte('B');
break;
case SHORT:
sigbuf.appendByte('S');
break;
case CHAR:
sigbuf.appendByte('C');
break;
case INT:
sigbuf.appendByte('I');
break;
case LONG:
sigbuf.appendByte('J');
break;
case FLOAT:
sigbuf.appendByte('F');
break;
case DOUBLE:
sigbuf.appendByte('D');
break;
case BOOLEAN:
sigbuf.appendByte('Z');
break;
case VOID:
sigbuf.appendByte('V');
break;
case CLASS:
sigbuf.appendByte('L');
assembleClassSig(type);
sigbuf.appendByte(';');
break;
case ARRAY:
ArrayType at = (ArrayType)type;
sigbuf.appendByte('[');
assembleSig(at.elemtype);
break;
case METHOD:
MethodType mt = (MethodType)type;
sigbuf.appendByte('(');
assembleSig(mt.argtypes);
sigbuf.appendByte(')');
assembleSig(mt.restype);
if (hasTypeVar(mt.thrown)) {
for (List l = mt.thrown; l.nonEmpty(); l = l.tail) {
sigbuf.appendByte('^');
assembleSig(l.head);
}
}
break;
case WILDCARD: {
WildcardType ta = (WildcardType) type;
switch (ta.kind) {
case SUPER:
sigbuf.appendByte('-');
assembleSig(ta.type);
break;
case EXTENDS:
sigbuf.appendByte('+');
assembleSig(ta.type);
break;
case UNBOUND:
sigbuf.appendByte('*');
break;
default:
throw new AssertionError(ta.kind);
}
break;
}
case TYPEVAR:
sigbuf.appendByte('T');
sigbuf.appendName(type.tsym.name);
sigbuf.appendByte(';');
break;
case FORALL:
ForAll ft = (ForAll)type;
assembleParamsSig(ft.tvars);
assembleSig(ft.qtype);
break;
case UNINITIALIZED_THIS:
case UNINITIALIZED_OBJECT:
// we don't yet have a spec for uninitialized types in the
// local variable table
assembleSig(types.erasure(((UninitializedType)type).qtype));
break;
default:
throw new AssertionError("typeSig " + type.tag);
}
}
boolean hasTypeVar(List l) {
while (l.nonEmpty()) {
if (l.head.tag == TypeTags.TYPEVAR) return true;
l = l.tail;
}
return false;
}
void assembleClassSig(Type type) {
ClassType ct = (ClassType)type;
ClassSymbol c = (ClassSymbol)ct.tsym;
enterInner(c);
Type outer = ct.getEnclosingType();
if (outer.allparams().nonEmpty()) {
boolean rawOuter =
c.owner.kind == MTH || // either a local class
c.name == names.empty; // or anonymous
assembleClassSig(rawOuter
? types.erasure(outer)
: outer);
// Ceylon: rawOuter represents local/anonymous types
// If we generate member types with '$' we get exceptions at runtime in reflection in
// sun.reflect.generics.parser.SignatureParser.parsePackageNameAndSimpleClassTypeSignature()
// And if we generate local types with '.' we get the same exception, so be careful
sigbuf.appendByte(rawOuter ? '$' : '.');
Assert.check(c.flatname.startsWith(c.owner.enclClass().flatname));
sigbuf.appendName(rawOuter
? c.flatname.subName(c.owner.enclClass().flatname.getByteLength()+1,c.flatname.getByteLength())
: c.name);
} else {
sigbuf.appendBytes(externalize(c.flatname));
}
if (ct.getTypeArguments().nonEmpty()) {
sigbuf.appendByte('<');
assembleSig(ct.getTypeArguments());
sigbuf.appendByte('>');
}
}
void assembleSig(List types) {
for (List ts = types; ts.nonEmpty(); ts = ts.tail)
assembleSig(ts.head);
}
void assembleParamsSig(List typarams) {
sigbuf.appendByte('<');
for (List ts = typarams; ts.nonEmpty(); ts = ts.tail) {
TypeVar tvar = (TypeVar)ts.head;
sigbuf.appendName(tvar.tsym.name);
List bounds = types.getBounds(tvar);
if ((bounds.head.tsym.flags() & INTERFACE) != 0) {
sigbuf.appendByte(':');
}
for (List l = bounds; l.nonEmpty(); l = l.tail) {
sigbuf.appendByte(':');
assembleSig(l.head);
}
}
sigbuf.appendByte('>');
}
/** Return signature of given type
*/
Name typeSig(Type type) {
Assert.check(sigbuf.length == 0);
//- System.out.println(" ? " + type);
assembleSig(type);
Name n = sigbuf.toName(names);
sigbuf.reset();
//- System.out.println(" " + n);
return n;
}
/** Given a type t, return the extended class name of its erasure in
* external representation.
*/
public Name xClassName(Type t) {
if (t.tag == CLASS) {
return names.fromUtf(externalize(t.tsym.flatName()));
} else if (t.tag == ARRAY) {
return typeSig(types.erasure(t));
} else {
throw new AssertionError("xClassName");
}
}
/******************************************************************
* Writing the Constant Pool
******************************************************************/
/** Thrown when the constant pool is over full.
*/
public static class PoolOverflow extends Exception {
private static final long serialVersionUID = 0;
public PoolOverflow() {}
}
public static class StringOverflow extends Exception {
private static final long serialVersionUID = 0;
public final String value;
public StringOverflow(String s) {
value = s;
}
}
/** Write constant pool to pool buffer.
* Note: during writing, constant pool
* might grow since some parts of constants still need to be entered.
*/
void writePool(Pool pool) throws PoolOverflow, StringOverflow {
int poolCountIdx = poolbuf.length;
poolbuf.appendChar(0);
int i = 1;
while (i < pool.pp) {
Object value = pool.pool[i];
Assert.checkNonNull(value);
if (value instanceof Pool.Method)
value = ((Pool.Method)value).m;
else if (value instanceof Pool.Variable)
value = ((Pool.Variable)value).v;
if (value instanceof MethodSymbol) {
MethodSymbol m = (MethodSymbol)value;
// Backported by Ceylon from JDK8
if (!m.isDynamic()) {
poolbuf.appendByte((m.owner.flags() & INTERFACE) != 0
? CONSTANT_InterfaceMethodref
: CONSTANT_Methodref);
poolbuf.appendChar(pool.put(m.owner));
poolbuf.appendChar(pool.put(nameType(m)));
} else {
//invokedynamic
DynamicMethodSymbol dynSym = (DynamicMethodSymbol)m;
MethodHandle handle = new MethodHandle(dynSym.bsmKind, dynSym.bsm);
DynamicMethod dynMeth = new DynamicMethod(dynSym);
bootstrapMethods.put(dynMeth, handle);
//init cp entries
pool.put(names.BootstrapMethods);
pool.put(handle);
for (Object staticArg : dynSym.staticArgs) {
pool.put(staticArg);
}
poolbuf.appendByte(CONSTANT_InvokeDynamic);
poolbuf.appendChar(bootstrapMethods.size() - 1);
poolbuf.appendChar(pool.put(nameType(dynSym)));
}
} else if (value instanceof VarSymbol) {
VarSymbol v = (VarSymbol)value;
poolbuf.appendByte(CONSTANT_Fieldref);
poolbuf.appendChar(pool.put(v.owner));
poolbuf.appendChar(pool.put(nameType(v)));
} else if (value instanceof Name) {
poolbuf.appendByte(CONSTANT_Utf8);
byte[] bs = ((Name)value).toUtf();
poolbuf.appendChar(bs.length);
poolbuf.appendBytes(bs, 0, bs.length);
if (bs.length > Pool.MAX_STRING_LENGTH)
throw new StringOverflow(value.toString());
} else if (value instanceof ClassSymbol) {
ClassSymbol c = (ClassSymbol)value;
if (c.owner.kind == TYP) pool.put(c.owner);
poolbuf.appendByte(CONSTANT_Class);
if (c.type.tag == ARRAY) {
poolbuf.appendChar(pool.put(typeSig(c.type)));
} else {
poolbuf.appendChar(pool.put(names.fromUtf(externalize(c.flatname))));
enterInner(c);
}
} else if (value instanceof NameAndType) {
NameAndType nt = (NameAndType)value;
poolbuf.appendByte(CONSTANT_NameandType);
poolbuf.appendChar(pool.put(nt.name));
poolbuf.appendChar(pool.put(typeSig(nt.type)));
} else if (value instanceof Integer) {
poolbuf.appendByte(CONSTANT_Integer);
poolbuf.appendInt(((Integer)value).intValue());
} else if (value instanceof Long) {
poolbuf.appendByte(CONSTANT_Long);
poolbuf.appendLong(((Long)value).longValue());
i++;
} else if (value instanceof Float) {
poolbuf.appendByte(CONSTANT_Float);
poolbuf.appendFloat(((Float)value).floatValue());
} else if (value instanceof Double) {
poolbuf.appendByte(CONSTANT_Double);
poolbuf.appendDouble(((Double)value).doubleValue());
i++;
} else if (value instanceof String) {
poolbuf.appendByte(CONSTANT_String);
poolbuf.appendChar(pool.put(names.fromString((String)value)));
} else if (value instanceof Type) {
Type type = (Type)value;
// Backported by Ceylon from JDK8
if (type instanceof MethodType) {
poolbuf.appendByte(CONSTANT_MethodType);
poolbuf.appendChar(pool.put(typeSig((MethodType)type)));
} else {
if (type.tag == CLASS) enterInner((ClassSymbol)type.tsym);
poolbuf.appendByte(CONSTANT_Class);
poolbuf.appendChar(pool.put(xClassName(type)));
}
// Backported by Ceylon from JDK8
} else if (value instanceof MethodHandle) {
MethodHandle ref = (MethodHandle)value;
poolbuf.appendByte(CONSTANT_MethodHandle);
poolbuf.appendByte(ref.refKind);
poolbuf.appendChar(pool.put(ref.refSym));
} else {
Assert.error("writePool " + value);
}
i++;
}
if (pool.pp > Pool.MAX_ENTRIES)
throw new PoolOverflow();
putChar(poolbuf, poolCountIdx, pool.pp);
}
/** Given a field, return its name.
*/
Name fieldName(Symbol sym) {
if (scramble && (sym.flags() & PRIVATE) != 0 ||
scrambleAll && (sym.flags() & (PROTECTED | PUBLIC)) == 0)
return names.fromString("_$" + sym.name.getIndex());
else
return sym.name;
}
/** Given a symbol, return its name-and-type.
*/
NameAndType nameType(Symbol sym) {
return new NameAndType(fieldName(sym),
retrofit
? sym.erasure(types)
: sym.externalType(types));
// if we retrofit, then the NameAndType has been read in as is
// and no change is necessary. If we compile normally, the
// NameAndType is generated from a symbol reference, and the
// adjustment of adding an additional this$n parameter needs to be made.
}
/******************************************************************
* Writing Attributes
******************************************************************/
/** Write header for an attribute to data buffer and return
* position past attribute length index.
*/
int writeAttr(Name attrName) {
databuf.appendChar(pool.put(attrName));
databuf.appendInt(0);
return databuf.length;
}
/** Fill in attribute length.
*/
void endAttr(int index) {
putInt(databuf, index - 4, databuf.length - index);
}
/** Leave space for attribute count and return index for
* number of attributes field.
*/
int beginAttrs() {
databuf.appendChar(0);
return databuf.length;
}
/** Fill in number of attributes.
*/
void endAttrs(int index, int count) {
putChar(databuf, index - 2, count);
}
/** Write the EnclosingMethod attribute if needed.
* Returns the number of attributes written (0 or 1).
*/
int writeEnclosingMethodAttribute(ClassSymbol c) {
if (!target.hasEnclosingMethodAttribute() ||
c.owner.kind != MTH && // neither a local class
c.name != names.empty) // nor anonymous
return 0;
int alenIdx = writeAttr(names.EnclosingMethod);
ClassSymbol enclClass = c.owner.enclClass();
MethodSymbol enclMethod =
(c.owner.type == null // local to init block
|| c.owner.kind != MTH) // or member init
? null
: (MethodSymbol)c.owner;
databuf.appendChar(pool.put(enclClass));
databuf.appendChar(enclMethod == null ? 0 : pool.put(nameType(c.owner)));
endAttr(alenIdx);
return 1;
}
/** Write flag attributes; return number of attributes written.
*/
int writeFlagAttrs(long flags) {
int acount = 0;
if ((flags & DEPRECATED) != 0) {
int alenIdx = writeAttr(names.Deprecated);
endAttr(alenIdx);
acount++;
}
if ((flags & ENUM) != 0 && !target.useEnumFlag()) {
int alenIdx = writeAttr(names.Enum);
endAttr(alenIdx);
acount++;
}
if ((flags & SYNTHETIC) != 0 && !target.useSyntheticFlag()) {
int alenIdx = writeAttr(names.Synthetic);
endAttr(alenIdx);
acount++;
}
if ((flags & BRIDGE) != 0 && !target.useBridgeFlag()) {
int alenIdx = writeAttr(names.Bridge);
endAttr(alenIdx);
acount++;
}
if ((flags & VARARGS) != 0 && !target.useVarargsFlag()) {
int alenIdx = writeAttr(names.Varargs);
endAttr(alenIdx);
acount++;
}
if ((flags & ANNOTATION) != 0 && !target.useAnnotationFlag()) {
int alenIdx = writeAttr(names.Annotation);
endAttr(alenIdx);
acount++;
}
return acount;
}
/** Write member (field or method) attributes;
* return number of attributes written.
*/
int writeMemberAttrs(Symbol sym) {
int acount = writeFlagAttrs(sym.flags());
long flags = sym.flags();
if (source.allowGenerics() &&
(flags & (SYNTHETIC|BRIDGE)) != SYNTHETIC &&
(flags & ANONCONSTR) == 0 &&
(!types.isSameType(sym.type, sym.erasure(types)) ||
hasTypeVar(sym.type.getThrownTypes()))) {
// note that a local class with captured variables
// will get a signature attribute
int alenIdx = writeAttr(names.Signature);
databuf.appendChar(pool.put(typeSig(sym.type)));
endAttr(alenIdx);
acount++;
}
acount += writeJavaAnnotations(sym.getAnnotationMirrors());
return acount;
}
/** Write method parameter annotations;
* return number of attributes written.
*/
int writeParameterAttrs(MethodSymbol m) {
boolean hasVisible = false;
boolean hasInvisible = false;
if (m.params != null) for (VarSymbol s : m.params) {
for (Attribute.Compound a : s.getAnnotationMirrors()) {
switch (types.getRetention(a)) {
case SOURCE: break;
case CLASS: hasInvisible = true; break;
case RUNTIME: hasVisible = true; break;
default: ;// /* fail soft */ throw new AssertionError(vis);
}
}
}
int attrCount = 0;
if (hasVisible) {
int attrIndex = writeAttr(names.RuntimeVisibleParameterAnnotations);
databuf.appendByte(m.params.length());
for (VarSymbol s : m.params) {
ListBuffer buf = new ListBuffer();
for (Attribute.Compound a : s.getAnnotationMirrors())
if (types.getRetention(a) == RetentionPolicy.RUNTIME)
buf.append(a);
databuf.appendChar(buf.length());
for (Attribute.Compound a : buf)
writeCompoundAttribute(a);
}
endAttr(attrIndex);
attrCount++;
}
if (hasInvisible) {
int attrIndex = writeAttr(names.RuntimeInvisibleParameterAnnotations);
databuf.appendByte(m.params.length());
for (VarSymbol s : m.params) {
ListBuffer buf = new ListBuffer();
for (Attribute.Compound a : s.getAnnotationMirrors())
if (types.getRetention(a) == RetentionPolicy.CLASS)
buf.append(a);
databuf.appendChar(buf.length());
for (Attribute.Compound a : buf)
writeCompoundAttribute(a);
}
endAttr(attrIndex);
attrCount++;
}
return attrCount;
}
/**********************************************************************
* Writing Java-language annotations (aka metadata, attributes)
**********************************************************************/
/** Write Java-language annotations; return number of JVM
* attributes written (zero or one).
*/
int writeJavaAnnotations(List attrs) {
if (attrs.isEmpty()) return 0;
ListBuffer visibles = new ListBuffer();
ListBuffer invisibles = new ListBuffer();
for (Attribute.Compound a : attrs) {
switch (types.getRetention(a)) {
case SOURCE: break;
case CLASS: invisibles.append(a); break;
case RUNTIME: visibles.append(a); break;
default: ;// /* fail soft */ throw new AssertionError(vis);
}
}
int attrCount = 0;
if (visibles.length() != 0) {
int attrIndex = writeAttr(names.RuntimeVisibleAnnotations);
databuf.appendChar(visibles.length());
for (Attribute.Compound a : visibles)
writeCompoundAttribute(a);
endAttr(attrIndex);
attrCount++;
}
if (invisibles.length() != 0) {
int attrIndex = writeAttr(names.RuntimeInvisibleAnnotations);
databuf.appendChar(invisibles.length());
for (Attribute.Compound a : invisibles)
writeCompoundAttribute(a);
endAttr(attrIndex);
attrCount++;
}
return attrCount;
}
/** A visitor to write an attribute including its leading
* single-character marker.
*/
class AttributeWriter implements Attribute.Visitor {
public void visitConstant(Attribute.Constant _value) {
Object value = _value.value;
switch (_value.type.tag) {
case BYTE:
databuf.appendByte('B');
break;
case CHAR:
databuf.appendByte('C');
break;
case SHORT:
databuf.appendByte('S');
break;
case INT:
databuf.appendByte('I');
break;
case LONG:
databuf.appendByte('J');
break;
case FLOAT:
databuf.appendByte('F');
break;
case DOUBLE:
databuf.appendByte('D');
break;
case BOOLEAN:
databuf.appendByte('Z');
break;
case CLASS:
Assert.check(value instanceof String);
databuf.appendByte('s');
value = names.fromString(value.toString()); // CONSTANT_Utf8
break;
default:
throw new AssertionError(_value.type);
}
databuf.appendChar(pool.put(value));
}
public void visitEnum(Attribute.Enum e) {
databuf.appendByte('e');
databuf.appendChar(pool.put(typeSig(e.value.type)));
databuf.appendChar(pool.put(e.value.name));
}
public void visitClass(Attribute.Class clazz) {
databuf.appendByte('c');
databuf.appendChar(pool.put(typeSig(clazz.type)));
}
public void visitCompound(Attribute.Compound compound) {
databuf.appendByte('@');
writeCompoundAttribute(compound);
}
public void visitError(Attribute.Error x) {
throw new AssertionError(x);
}
public void visitArray(Attribute.Array array) {
databuf.appendByte('[');
databuf.appendChar(array.values.length);
for (Attribute a : array.values) {
a.accept(this);
}
}
}
AttributeWriter awriter = new AttributeWriter();
/** Write a compound attribute excluding the '@' marker. */
void writeCompoundAttribute(Attribute.Compound c) {
databuf.appendChar(pool.put(typeSig(c.type)));
databuf.appendChar(c.values.length());
for (Pair p : c.values) {
databuf.appendChar(pool.put(p.fst.name));
p.snd.accept(awriter);
}
}
/**********************************************************************
* Writing Objects
**********************************************************************/
/** Enter an inner class into the `innerClasses' set/queue.
*/
void enterInner(ClassSymbol c) {
if (c.type.isCompound()) {
throw new AssertionError("Unexpected intersection type: " + c.type);
}
try {
c.complete();
} catch (CompletionFailure ex) {
System.err.println("error: " + c + ": " + ex.getMessage());
throw ex;
}
if (c.type.tag != CLASS) return; // arrays
if (pool != null && // pool might be null if called from xClassName
c.owner.kind != PCK &&
(innerClasses == null || !innerClasses.contains(c))) {
// log.errWriter.println("enter inner " + c);//DEBUG
if (c.owner.kind == TYP) enterInner((ClassSymbol)c.owner);
pool.put(c);
pool.put(c.name);
if (innerClasses == null) {
innerClasses = new HashSet();
innerClassesQueue = new ListBuffer();
pool.put(names.InnerClasses);
}
innerClasses.add(c);
innerClassesQueue.append(c);
}
}
/** Write "inner classes" attribute.
*/
void writeInnerClasses() {
int alenIdx = writeAttr(names.InnerClasses);
databuf.appendChar(innerClassesQueue.length());
for (List l = innerClassesQueue.toList();
l.nonEmpty();
l = l.tail) {
ClassSymbol inner = l.head;
char flags = (char) adjustFlags(inner.flags_field);
if ((flags & INTERFACE) != 0) flags |= ABSTRACT; // Interfaces are always ABSTRACT
if (inner.name.isEmpty()) flags &= ~FINAL; // Anonymous class: unset FINAL flag
if (dumpInnerClassModifiers) {
log.errWriter.println("INNERCLASS " + inner.name);
log.errWriter.println("---" + flagNames(flags));
}
databuf.appendChar(pool.get(inner));
databuf.appendChar(
inner.owner.kind == TYP ? pool.get(inner.owner) : 0);
databuf.appendChar(
!inner.name.isEmpty() ? pool.get(inner.name) : 0);
databuf.appendChar(flags);
}
endAttr(alenIdx);
}
// Backported by Ceylon from JDK8
/** Write "bootstrapMethods" attribute.
*/
void writeBootstrapMethods() {
int alenIdx = writeAttr(names.BootstrapMethods);
databuf.appendChar(bootstrapMethods.size());
for (Map.Entry entry : bootstrapMethods.entrySet()) {
DynamicMethod dmeth = entry.getKey();
DynamicMethodSymbol dsym = (DynamicMethodSymbol)dmeth.baseSymbol();
//write BSM handle
databuf.appendChar(pool.get(entry.getValue()));
//write static args length
databuf.appendChar(dsym.staticArgs.length);
//write static args array
Object[] uniqueArgs = dmeth.uniqueStaticArgs;
for (Object o : uniqueArgs) {
databuf.appendChar(pool.get(o));
}
}
endAttr(alenIdx);
}
/** Write field symbol, entering all references into constant pool.
*/
void writeField(VarSymbol v) {
int flags = adjustFlags(v.flags());
databuf.appendChar(flags);
if (dumpFieldModifiers) {
log.errWriter.println("FIELD " + fieldName(v));
log.errWriter.println("---" + flagNames(v.flags()));
}
databuf.appendChar(pool.put(fieldName(v)));
databuf.appendChar(pool.put(typeSig(v.erasure(types))));
int acountIdx = beginAttrs();
int acount = 0;
if (v.getConstValue() != null) {
int alenIdx = writeAttr(names.ConstantValue);
databuf.appendChar(pool.put(v.getConstValue()));
endAttr(alenIdx);
acount++;
}
acount += writeMemberAttrs(v);
endAttrs(acountIdx, acount);
}
/** Write method symbol, entering all references into constant pool.
*/
void writeMethod(MethodSymbol m) {
int flags = adjustFlags(m.flags());
databuf.appendChar(flags);
if (dumpMethodModifiers) {
log.errWriter.println("METHOD " + fieldName(m));
log.errWriter.println("---" + flagNames(m.flags()));
}
databuf.appendChar(pool.put(fieldName(m)));
databuf.appendChar(pool.put(typeSig(m.externalType(types))));
int acountIdx = beginAttrs();
int acount = 0;
if (m.code != null) {
int alenIdx = writeAttr(names.Code);
writeCode(m.code);
m.code = null; // to conserve space
endAttr(alenIdx);
acount++;
}
List thrown = m.erasure(types).getThrownTypes();
if (thrown.nonEmpty()) {
int alenIdx = writeAttr(names.Exceptions);
databuf.appendChar(thrown.length());
for (List l = thrown; l.nonEmpty(); l = l.tail)
databuf.appendChar(pool.put(l.head.tsym));
endAttr(alenIdx);
acount++;
}
if (m.defaultValue != null) {
int alenIdx = writeAttr(names.AnnotationDefault);
m.defaultValue.accept(awriter);
endAttr(alenIdx);
acount++;
}
acount += writeMemberAttrs(m);
acount += writeParameterAttrs(m);
endAttrs(acountIdx, acount);
}
/** Write code attribute of method.
*/
void writeCode(Code code) {
databuf.appendChar(code.max_stack);
databuf.appendChar(code.max_locals);
databuf.appendInt(code.cp);
databuf.appendBytes(code.code, 0, code.cp);
databuf.appendChar(code.catchInfo.length());
for (List l = code.catchInfo.toList();
l.nonEmpty();
l = l.tail) {
for (int i = 0; i < l.head.length; i++)
databuf.appendChar(l.head[i]);
}
int acountIdx = beginAttrs();
int acount = 0;
if (code.lineInfo.nonEmpty()) {
int alenIdx = writeAttr(names.LineNumberTable);
databuf.appendChar(code.lineInfo.length());
for (List l = code.lineInfo.reverse();
l.nonEmpty();
l = l.tail)
for (int i = 0; i < l.head.length; i++)
databuf.appendChar(l.head[i]);
endAttr(alenIdx);
acount++;
}
if (genCrt && (code.crt != null)) {
CRTable crt = code.crt;
int alenIdx = writeAttr(names.CharacterRangeTable);
int crtIdx = beginAttrs();
int crtEntries = crt.writeCRT(databuf, code.lineMap, log);
endAttrs(crtIdx, crtEntries);
endAttr(alenIdx);
acount++;
}
// counter for number of generic local variables
int nGenericVars = 0;
if (code.varBufferSize > 0) {
int alenIdx = writeAttr(names.LocalVariableTable);
databuf.appendChar(code.varBufferSize);
for (int i=0; i= 0
&& var.start_pc <= code.cp);
databuf.appendChar(var.start_pc);
Assert.check(var.length >= 0
&& (var.start_pc + var.length) <= code.cp);
databuf.appendChar(var.length);
VarSymbol sym = var.sym;
databuf.appendChar(pool.put(sym.name));
Type vartype = sym.erasure(types);
if (needsLocalVariableTypeEntry(sym.type))
nGenericVars++;
databuf.appendChar(pool.put(typeSig(vartype)));
databuf.appendChar(var.reg);
}
endAttr(alenIdx);
acount++;
}
if (nGenericVars > 0) {
int alenIdx = writeAttr(names.LocalVariableTypeTable);
databuf.appendChar(nGenericVars);
int count = 0;
for (int i=0; i 0) {
if (debugstackmap) System.out.println("Stack map for " + code.meth);
int alenIdx = writeAttr(code.stackMap.getAttributeName(names));
writeStackMap(code);
endAttr(alenIdx);
acount++;
}
endAttrs(acountIdx, acount);
}
//where
private boolean needsLocalVariableTypeEntry(Type t) {
//a local variable needs a type-entry if its type T is generic
//(i.e. |T| != T) and if it's not an intersection type (not supported
//in signature attribute grammar)
return (!types.isSameType(t, types.erasure(t)) &&
!t.isCompound());
}
void writeStackMap(Code code) {
int nframes = code.stackMapBufferSize;
if (debugstackmap) System.out.println(" nframes = " + nframes);
databuf.appendChar(nframes);
switch (code.stackMap) {
case CLDC:
for (int i=0; i();
Type supertype = types.supertype(c.type);
List interfaces = types.interfaces(c.type);
List typarams = c.type.getTypeArguments();
int flags = adjustFlags(c.flags());
if ((flags & PROTECTED) != 0) flags |= PUBLIC;
flags = flags & ClassFlags & ~STRICTFP;
if ((flags & INTERFACE) == 0) flags |= ACC_SUPER;
if (c.isInner() && c.name.isEmpty()) flags &= ~FINAL;
if (dumpClassModifiers) {
log.errWriter.println();
log.errWriter.println("CLASSFILE " + c.getQualifiedName());
log.errWriter.println("---" + flagNames(flags));
}
databuf.appendChar(flags);
databuf.appendChar(pool.put(c));
databuf.appendChar(supertype.tag == CLASS ? pool.put(supertype.tsym) : 0);
databuf.appendChar(interfaces.length());
for (List l = interfaces; l.nonEmpty(); l = l.tail)
databuf.appendChar(pool.put(l.head.tsym));
int fieldsCount = 0;
int methodsCount = 0;
for (Scope.Entry e = c.members().elems; e != null; e = e.sibling) {
switch (e.sym.kind) {
case VAR: fieldsCount++; break;
case MTH: if ((e.sym.flags() & HYPOTHETICAL) == 0) methodsCount++;
break;
case TYP: enterInner((ClassSymbol)e.sym); break;
default : Assert.error();
}
}
databuf.appendChar(fieldsCount);
writeFields(c.members().elems);
databuf.appendChar(methodsCount);
writeMethods(c.members().elems);
int acountIdx = beginAttrs();
int acount = 0;
boolean sigReq =
typarams.length() != 0 || supertype.allparams().length() != 0;
for (List l = interfaces; !sigReq && l.nonEmpty(); l = l.tail)
sigReq = l.head.allparams().length() != 0;
if (sigReq) {
Assert.check(source.allowGenerics());
int alenIdx = writeAttr(names.Signature);
if (typarams.length() != 0) assembleParamsSig(typarams);
assembleSig(supertype);
for (List l = interfaces; l.nonEmpty(); l = l.tail)
assembleSig(l.head);
databuf.appendChar(pool.put(sigbuf.toName(names)));
sigbuf.reset();
endAttr(alenIdx);
acount++;
}
if (c.sourcefile != null && emitSourceFile) {
int alenIdx = writeAttr(names.SourceFile);
// WHM 6/29/1999: Strip file path prefix. We do it here at
// the last possible moment because the sourcefile may be used
// elsewhere in error diagnostics. Fixes 4241573.
//databuf.appendChar(c.pool.put(c.sourcefile));
String simpleName = BaseFileObject.getSimpleName(c.sourcefile);
databuf.appendChar(c.pool.put(names.fromString(simpleName)));
endAttr(alenIdx);
acount++;
}
if (genCrt) {
// Append SourceID attribute
int alenIdx = writeAttr(names.SourceID);
databuf.appendChar(c.pool.put(names.fromString(Long.toString(getLastModified(c.sourcefile)))));
endAttr(alenIdx);
acount++;
// Append CompilationID attribute
alenIdx = writeAttr(names.CompilationID);
databuf.appendChar(c.pool.put(names.fromString(Long.toString(System.currentTimeMillis()))));
endAttr(alenIdx);
acount++;
}
acount += writeFlagAttrs(c.flags());
acount += writeJavaAnnotations(c.getAnnotationMirrors());
acount += writeEnclosingMethodAttribute(c);
poolbuf.appendInt(JAVA_MAGIC);
poolbuf.appendChar(target.minorVersion);
poolbuf.appendChar(target.majorVersion);
writePool(c.pool);
if (innerClasses != null) {
writeInnerClasses();
acount++;
}
// Backported by Ceylon from JDK8
if (!bootstrapMethods.isEmpty()) {
writeBootstrapMethods();
acount++;
}
endAttrs(acountIdx, acount);
poolbuf.appendBytes(databuf.elems, 0, databuf.length);
out.write(poolbuf.elems, 0, poolbuf.length);
pool = c.pool = null; // to conserve space
}
int adjustFlags(final long flags) {
int result = (int)flags;
if ((flags & SYNTHETIC) != 0 && !target.useSyntheticFlag())
result &= ~SYNTHETIC;
if ((flags & ENUM) != 0 && !target.useEnumFlag())
result &= ~ENUM;
if ((flags & ANNOTATION) != 0 && !target.useAnnotationFlag())
result &= ~ANNOTATION;
if ((flags & BRIDGE) != 0 && target.useBridgeFlag())
result |= ACC_BRIDGE;
if ((flags & VARARGS) != 0 && target.useVarargsFlag())
result |= ACC_VARARGS;
return result;
}
long getLastModified(FileObject filename) {
long mod = 0;
try {
mod = filename.getLastModified();
} catch (SecurityException e) {
throw new AssertionError("CRT: couldn't get source file modification date: " + e.getMessage());
}
return mod;
}
}