1 package org.ibex.classgen;
6 /** Class generation object representing the whole classfile */
7 public class ClassFile extends Type.Class.Body {
8 private final Type.Class thisType;
9 final Type.Class superType;
10 final Type.Class[] interfaces;
11 private final short minor;
12 private final short major;
14 private final Vector fields = new Vector();
15 private final Vector methods = new Vector();
17 public Type.Class.Method.Body[] methods() {
18 Type.Class.Method.Body[] ret = new Type.Class.Method.Body[methods.size()];
19 methods.copyInto(ret);
23 public Type.Class.Field.Body[] fields() {
24 Type.Class.Field.Body[] ret = new Type.Class.Field.Body[fields.size()];
29 static String flagsToString(int flags, boolean isClass) {
30 StringBuffer sb = new StringBuffer(32);
31 if ((flags & PUBLIC) != 0) sb.append("public ");
32 if ((flags & PRIVATE) != 0) sb.append("private ");
33 if ((flags & PROTECTED) != 0) sb.append("protected ");
34 if ((flags & STATIC) != 0) sb.append("static ");
35 if ((flags & FINAL) != 0) sb.append("final ");
36 if ((flags & ABSTRACT) != 0) sb.append("abstract ");
37 if (!isClass && (flags & SYNCHRONIZED) != 0) sb.append("synchronized ");
38 if (!isClass && (flags & NATIVE) != 0) sb.append("native ");
39 if (!isClass && (flags & STRICT) != 0) sb.append("strictfp ");
40 if (!isClass && (flags & VOLATILE) != 0) sb.append("volatile ");
41 if (!isClass && (flags & TRANSIENT) != 0) sb.append("transient ");
45 public Type.Class getType() { return thisType; }
46 public int getFlags() { return flags; }
48 public String toString() { return toString(new StringBuffer(4096)).toString(); }
49 StringBuffer toString(StringBuffer sb) {
50 sb.append(flagsToString(flags,true));
51 sb.append((flags & INTERFACE) != 0 ? "interface " : "class ");
52 sb.append(thisType.toString());
53 if (superType != null) sb.append(" extends " + superType.toString());
54 if (interfaces != null && interfaces.length > 0) sb.append(" implements");
55 for(int i=0; i<interfaces.length; i++) sb.append((i==0?" ":", ")+interfaces[i].toString());
57 sb.append(" // v"+major+"."+minor);
58 ConstantPool.Utf8Key sourceFile = (ConstantPool.Utf8Key) attrs.get("SourceFile");
59 if (sourceFile != null) sb.append(" from " + sourceFile.s);
61 for(int i=0; i<fields.size(); i++) {
63 ((FieldGen)fields.elementAt(i)).toString(sb);
66 for(int i=0; i<methods.size(); i++) {
67 ((MethodGen)methods.elementAt(i)).toString(sb,thisType.getShortName());
74 public ClassFile(Type.Class thisType, Type.Class superType, int flags) { this(thisType, superType, flags, null); }
75 public ClassFile(Type.Class thisType, Type.Class superType, int flags, Type.Class[] interfaces) {
76 thisType.super(flags, new AttrGen());
77 this.thisType = thisType;
78 this.superType = superType;
79 this.interfaces = interfaces;
84 /** Adds a new method to this class
85 @param name The name of the method (not the signature, just the name)
86 @param ret The return type of the method
87 @param args The arguments to the method
88 @param flags The flags for the method
89 (PUBLIC, PRIVATE, PROTECTED, STATIC, SYNCHRONIZED, NATIVE, ABSTRACT, STRICT)
90 @return A new MethodGen object for the method
91 @exception IllegalArgumentException if illegal flags are specified
95 public final MethodGen addMethod(String name, Type ret, Type[] args, int flags) {
96 return addMethod(getType().method(name, ret, args),flags);
98 public final MethodGen addMethod(Type.Class.Method method,int flags) {
99 MethodGen mg = new MethodGen(method, flags);
100 methods.addElement(mg);
104 /** Adds a new field to this class
105 @param name The name of the filed (not the signature, just the name)
106 @param type The type of the field
107 @param flags The flags for the field
108 (PUBLIC, PRIVATE, PROTECTED, STATIC, FINAL, VOLATILE, TRANSIENT)
109 @return A new FieldGen object for the method
110 @exception IllegalArgumentException if illegal flags are specified
114 public final FieldGen addField(String name, Type type, int flags) {
115 return addField(getType().field(name,type),flags);
117 public final FieldGen addField(Type.Class.Field field, int flags) {
118 FieldGen fg = new FieldGen(field , flags);
119 fields.addElement(fg);
123 /** Sets the source value of the SourceFile attribute of this class
124 @param sourceFile The string to be uses as the SourceFile of this class
126 public void setSourceFile(String sourceFile) { attrs.put("SourceFile", new ConstantPool.Utf8Key(sourceFile)); }
128 /** Writes the classfile data to the file specifed
129 @see ClassFile#dump(OutputStream)
131 public void dump(String file) throws IOException { dump(new File(file)); }
133 /** Writes the classfile data to the file specified
134 If <i>f</i> is a directory directory components under it are created for the package the class is in (like javac's -d option)
135 @see ClassFile#dump(OutputStream)
137 public void dump(File f) throws IOException {
138 if(f.isDirectory()) {
139 String[] a = thisType.components();
141 for(i=0;i<a.length-1;i++) {
142 f = new File(f, a[i]);
145 f = new File(f, a[i] + ".class");
147 OutputStream os = new FileOutputStream(f);
152 /** Writes the classfile data to the outputstream specified
153 @param os The stream to write the class to
154 @exception IOException if an IOException occures while writing the class data
155 @exception IllegalStateException if the data for a method is in an inconsistent state (required arguments missing, etc)
156 @exception Exn if the classfile could not be written for any other reason (constant pool full, etc)
158 public void dump(OutputStream os) throws IOException {
159 DataOutputStream dos = new DataOutputStream(new BufferedOutputStream(os));
164 private void _dump(DataOutput o) throws IOException {
165 ConstantPool cp = new ConstantPool();
168 if(interfaces != null) for(int i=0;i<interfaces.length;i++) cp.add(interfaces[i]);
169 for(int i=0;i<methods.size();i++) ((MethodGen)methods.elementAt(i)).finish(cp);
170 for(int i=0;i<fields.size();i++) ((FieldGen)fields.elementAt(i)).finish(cp);
176 o.writeInt(0xcafebabe); // magic
177 o.writeShort(minor); // minor_version
178 o.writeShort(major); // major_version
180 cp.dump(o); // constant_pool
183 o.writeShort(cp.getIndex(thisType)); // this_class
184 o.writeShort(cp.getIndex(superType)); // super_class
186 o.writeShort(interfaces==null ? 0 : interfaces.length); // interfaces_count
187 if(interfaces != null) for(int i=0;i<interfaces.length;i++) o.writeShort(cp.getIndex(interfaces[i])); // interfaces
189 o.writeShort(fields.size()); // fields_count
190 for(int i=0;i<fields.size();i++) ((FieldGen)fields.elementAt(i)).dump(o,cp); // fields
192 o.writeShort(methods.size()); // methods_count
193 for(int i=0;i<methods.size();i++) ((MethodGen)methods.elementAt(i)).dump(o,cp); // methods
195 attrs.dump(o,cp); // attributes
198 public static ClassFile read(String s) throws IOException { return read(new File(s)); }
199 public static ClassFile read(File f) throws ClassReadExn, IOException {
200 InputStream is = new FileInputStream(f);
201 ClassFile ret = read(is);
206 public static ClassFile read(InputStream is) throws ClassReadExn, IOException {
208 return new ClassFile(new DataInputStream(new BufferedInputStream(is)));
209 } catch(RuntimeException e) {
211 throw new ClassReadExn("invalid constant pool entry");
215 public ClassFile(DataInput i) throws IOException { this(i, false); }
216 public ClassFile(DataInput i, boolean ssa) throws IOException {
217 this(i.readInt(), i.readShort(), i.readShort(), new ConstantPool(i), i.readShort(), i, ssa);
219 private ClassFile(int magic, short minor, short major, ConstantPool cp,
220 short flags, DataInput i, boolean ssa) throws IOException {
221 this(magic, minor, major, cp, flags, (Type.Class)cp.getKeyByIndex(i.readShort()), i, ssa);
223 private ClassFile(int magic, short minor, short major, ConstantPool cp, short flags,
224 Type.Class thisType, DataInput i, boolean ssa) throws IOException {
225 thisType.super(flags, null);
226 if (magic != 0xcafebabe) throw new ClassReadExn("invalid magic: " + Long.toString(0xffffffffL & magic, 16));
229 this.thisType = thisType;
230 superType = (Type.Class) cp.getKeyByIndex(i.readShort());
231 interfaces = new Type.Class[i.readShort()];
232 for(int j=0; j<interfaces.length; j++) interfaces[j] = (Type.Class) cp.getKeyByIndex(i.readShort());
233 int numFields = i.readShort();
234 for(int j=0; j<numFields; j++) fields.addElement(new FieldGen(this.getType(), i, cp));
235 int numMethods = i.readShort();
236 for(int j=0; j<numMethods; j++) methods.addElement(ssa
237 ? new JSSA(this.getType(), i, cp)
238 : new MethodGen(this.getType(), i, cp));
239 readAttributes(i, cp);
241 // FEATURE: Support these
242 // NOTE: Until we can support them properly we HAVE to delete them,
243 // they'll be incorrect after we rewrite the constant pool, etc
244 attrs.remove("InnerClasses");
247 /** Thrown when class generation fails for a reason not under the control of the user
248 (IllegalStateExceptions are thrown in those cases */
249 // FEATURE: This should probably be a checked exception
250 public static class Exn extends RuntimeException {
251 public Exn(String s) { super(s); }
254 public static class ClassReadExn extends IOException {
255 public ClassReadExn(String s) { super(s); }
258 static class AttrGen {
259 private final Hashtable ht = new Hashtable();
262 AttrGen(DataInput in, ConstantPool cp) throws IOException {
263 int size = in.readShort();
264 for(int i=0; i<size; i++) {
265 String name = cp.getUtf8KeyByIndex(in.readUnsignedShort());
266 int length = in.readInt();
267 if ((name.equals("SourceFile")||name.equals("ConstantValue")) && length == 2) {
268 ht.put(name, cp.getKeyByIndex(in.readUnsignedShort()));
270 byte[] buf = new byte[length];
277 public Object get(String s) { return ht.get(s); }
278 public void put(String s, Object data) { ht.put(s, data); }
279 public boolean contains(String s) { return ht.get(s) != null; }
280 public void remove(String s) { ht.remove(s); }
281 public int size() { return ht.size(); }
283 void finish(ConstantPool cp) {
284 for(Enumeration e = ht.keys(); e.hasMoreElements();) {
285 String name = (String) e.nextElement();
286 Object val = ht.get(name);
288 if(!(val instanceof byte[])) cp.add(val);
292 void dump(DataOutput o, ConstantPool cp) throws IOException {
293 o.writeShort(size());
294 for(Enumeration e = ht.keys(); e.hasMoreElements();) {
295 String name = (String) e.nextElement();
296 Object val = ht.get(name);
297 o.writeShort(cp.getUtf8Index(name));
298 if(val instanceof byte[]) {
299 byte[] buf = (byte[]) val;
300 o.writeInt(buf.length);
304 o.writeShort(cp.getIndex(val));
310 public static void main(String[] args) throws Exception {
311 if(args.length >= 2 && args[0].equals("copyto")) {
312 File dest = new File(args[1]);
314 for(int i=2;i<args.length;i++) {
315 System.err.println("Copying " + args[i]);
316 read(args[i]).dump(dest);
319 else if (args.length==1) {
320 if (args[0].endsWith(".class")) {
321 System.out.println(new ClassFile(new DataInputStream(new FileInputStream(args[0]))).toString());
323 InputStream is = Class.forName(args[0]).getClassLoader().getResourceAsStream(args[0].replace('.', '/')+".class");
324 System.out.println(new ClassFile(new DataInputStream(is)).toString());
328 Type.Class me = new Type.Class("Test");
329 ClassFile cg = new ClassFile("Test", "java.lang.Object", PUBLIC|SUPER|FINAL);
330 FieldGen fg = cg.addField("foo", Type.INT, PUBLIC|STATIC);
332 MethodGen mg = cg.addMethod("main", Type.VOID, new Type[]{Type.arrayType(Type.STRING)}, STATIC|PUBLIC);
336 mg.add(PUTSTATIC, fieldRef(me, "foo", Type.INT));
338 mg.add(GETSTATIC, cg.fieldRef(new Type.Class("java.lang.System"), "out", new Type.Class("java.io.PrintStream")));
340 mg.add(GETSTATIC, cg.fieldRef(me, "foo", Type.INT));
341 mg.add(INVOKEVIRTUAL, cg.methodRef(new Type.Class("java.io.PrintStream"), "println",
342 Type.VOID, new Type[]{Type.INT}));
343 //mg.add(IINC, new int[]{0, 1});
345 mg.add(GETSTATIC, cg.fieldRef(me, "foo", Type.INT));
349 mg.add(PUTSTATIC, cg.fieldRef(me, "foo", Type.INT));
351 mg.add(IF_ICMPLT, top);
353 cg.dump("Test.class");