1 package org.ibex.classgen;
6 /** Class generation object representing the whole classfile */
7 public class ClassGen implements CGConst {
8 private final Type.Object thisType;
9 private final Type.Object superType;
10 private final Type.Object[] interfaces;
15 private String sourceFile;
16 private final Vector fields = new Vector();
17 private final Vector methods = new Vector();
20 private final AttrGen attributes;
22 public static String flagsToString(int flags) {
24 if ((flags & ACC_PUBLIC) != 0) ret += "public ";
25 if ((flags & ACC_PRIVATE) != 0) ret += "private ";
26 if ((flags & ACC_PROTECTED) != 0) ret += "protected ";
27 if ((flags & ACC_STATIC) != 0) ret += "static ";
28 if ((flags & ACC_FINAL) != 0) ret += "final ";
29 if ((flags & ACC_ABSTRACT) != 0) ret += "abstract ";
30 if ((flags & ACC_SYNCHRONIZED) != 0) ret += "synchronized ";
31 if ((flags & ACC_NATIVE) != 0) ret += "native ";
32 if ((flags & ACC_STRICT) != 0) ret += "strictfp ";
33 if ((flags & ACC_VOLATILE) != 0) ret += "volatile ";
34 if ((flags & ACC_TRANSIENT) != 0) ret += "transient ";
38 public String toString() { StringBuffer sb = new StringBuffer(); toString(sb); return sb.toString(); }
39 public void toString(StringBuffer sb) {
40 sb.append(flagsToString(flags));
41 sb.append((flags & ACC_INTERFACE) != 0 ? "interface " : "class ");
43 if (superType != null) sb.append(" extends " + superType);
44 if (interfaces != null && interfaces.length > 0) sb.append(" implements");
45 for(int i=0; i<interfaces.length; i++) sb.append((i==0?" ":", ")+interfaces[i]);
47 sb.append(" // [jcf v"+major+"."+minor+"]");
48 if (sourceFile != null) sb.append(" from " + sourceFile);
50 for(int i=0; i<fields.size(); i++) {
52 ((FieldGen)fields.elementAt(i)).toString(sb);
55 for(int i=0; i<methods.size(); i++) {
57 ((MethodGen)methods.elementAt(i)).toString(sb, thisType.getShortName());
63 /** @see #ClassGen(Type.Object, Type.Object, int) */
64 public ClassGen(String name, String superName, int flags) {
65 this(Type.fromDescriptor(name).asObject(), Type.fromDescriptor(superName).asObject(), flags);
68 /** @see #ClassGen(Type.Object, Type.Object, int, Type.Object[]) */
69 public ClassGen(Type.Object thisType, Type.Object superType, int flags) {
70 this(thisType, superType, flags, null);
73 /** Creates a new ClassGen object
74 @param thisType The type of the class to generate
75 @param superType The superclass of the generated class (commonly Type.OBJECT)
76 @param flags The access flags for this class (ACC_PUBLIC, ACC_FINAL, ACC_SUPER, ACC_INTERFACE, and ACC_ABSTRACT)
78 public ClassGen(Type.Object thisType, Type.Object superType, int flags, Type.Object[] interfaces) {
79 if((flags & ~(ACC_PUBLIC|ACC_FINAL|ACC_SUPER|ACC_INTERFACE|ACC_ABSTRACT)) != 0)
80 throw new IllegalArgumentException("invalid flags");
81 this.thisType = thisType;
82 this.superType = superType;
83 this.interfaces = interfaces;
89 attributes = new AttrGen(cp);
92 /** Adds a new method to this class
93 @param name The name of the method (not the signature, just the name)
94 @param ret The return type of the method
95 @param args The arguments to the method
96 @param flags The flags for the method
97 (ACC_PUBLIC, ACC_PRIVATE, ACC_PROTECTED, ACC_STATIC, ACC_SYNCHRONIZED, ACC_NATIVE, ACC_ABSTRACT, ACC_STRICT)
98 @return A new MethodGen object for the method
99 @exception IllegalArgumentException if illegal flags are specified
103 public final MethodGen addMethod(String name, Type ret, Type[] args, int flags) {
104 MethodGen mg = new MethodGen(this, name, ret, args, flags);
105 methods.addElement(mg);
109 /** Adds a new field to this class
110 @param name The name of the filed (not the signature, just the name)
111 @param type The type of the field
112 @param flags The flags for the field
113 (ACC_PUBLIC, ACC_PRIVATE, ACC_PROTECTED, ACC_STATIC, ACC_FINAL, ACC_VOLATILE, ACC_TRANSIENT)
114 @return A new FieldGen object for the method
115 @exception IllegalArgumentException if illegal flags are specified
119 public final FieldGen addField(String name, Type type, int flags) {
120 FieldGen fg = new FieldGen(this, name, type, flags);
121 fields.addElement(fg);
125 /** Sets the source value of the SourceFile attribute of this class
126 @param sourceFile The string to be uses as the SourceFile of this class
128 public void setSourceFile(String sourceFile) { this.sourceFile = sourceFile; }
130 /** Writes the classfile data to the file specifed
131 @see ClassGen#dump(OutputStream)
133 public void dump(String file) throws IOException { dump(new File(file)); }
135 /** Writes the classfile data to the file specified
136 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)
137 @see ClassGen#dump(OutputStream)
139 public void dump(File f) throws IOException {
140 if(f.isDirectory()) {
141 String[] a = thisType.components();
143 for(i=0;i<a.length-1;i++) {
144 f = new File(f, a[i]);
147 f = new File(f, a[i] + ".class");
149 OutputStream os = new FileOutputStream(f);
154 /** Writes the classfile data to the outputstream specified
155 @param os The stream to write the class to
156 @exception IOException if an IOException occures while writing the class data
157 @exception IllegalStateException if the data for a method is in an inconsistent state (required arguments missing, etc)
158 @exception Exn if the classfile could not be written for any other reason (constant pool full, etc)
160 public void dump(OutputStream os) throws IOException {
161 DataOutputStream dos = new DataOutputStream(new BufferedOutputStream(os));
166 private void _dump(DataOutput o) throws IOException {
172 if(interfaces != null) for(int i=0;i<interfaces.length;i++) cp.add(interfaces[i]);
173 if(sourceFile != null && !attributes.contains("SourceFile")) attributes.add("SourceFile", cp.addUtf8(sourceFile));
175 for(int i=0;i<methods.size();i++) ((MethodGen)methods.elementAt(i)).finish();
176 for(int i=0;i<fields.size();i++) ((FieldGen)fields.elementAt(i)).finish();
180 o.writeInt(0xcafebabe); // magic
181 o.writeShort(minor); // minor_version
182 o.writeShort(major); // major_version
184 cp.dump(o); // constant_pool
187 o.writeShort(cp.getIndex(thisType)); // this_class
188 o.writeShort(cp.getIndex(superType)); // super_class
190 o.writeShort(interfaces==null ? 0 : interfaces.length); // interfaces_count
191 if(interfaces != null) for(int i=0;i<interfaces.length;i++) o.writeShort(cp.getIndex(interfaces[i])); // interfaces
193 o.writeShort(fields.size()); // fields_count
194 for(int i=0;i<fields.size();i++) ((FieldGen)fields.elementAt(i)).dump(o); // fields
196 o.writeShort(methods.size()); // methods_count
197 for(int i=0;i<methods.size();i++) ((MethodGen)methods.elementAt(i)).dump(o); // methods
199 o.writeShort(attributes.size()); // attributes_count
200 attributes.dump(o); // attributes
203 public ClassGen read(File f) throws ClassReadExn, IOException {
204 InputStream is = new FileInputStream(f);
205 ClassGen ret = read(is);
210 public ClassGen read(InputStream is) throws ClassReadExn, IOException {
211 return new ClassGen(new DataInputStream(new BufferedInputStream(is)));
214 ClassGen(DataInput i) throws ClassReadExn, IOException {
215 int magic = i.readInt();
216 if (magic != 0xcafebabe) throw new ClassReadExn("invalid magic: " + Long.toString(0xffffffffL & magic, 16));
217 minor = i.readShort();
218 //if (minor != 3) throw new ClassReadExn("invalid minor version: " + minor);
219 major = i.readShort();
220 //if (major != 45 && major != 46) throw new ClassReadExn("invalid major version");
222 flags = i.readShort();
223 thisType = (Type.Object)cp.getType(i.readShort());
224 superType = (Type.Object)cp.getType(i.readShort());
225 interfaces = new Type.Object[i.readShort()];
226 for(int j=0; j<interfaces.length; j++) interfaces[j] = (Type.Object)cp.getType(i.readShort());
227 int numFields = i.readShort();
228 for(int j=0; j<numFields; j++) fields.add(new FieldGen(cp, i));
229 int numMethods = i.readShort();
230 for(int j=0; j<numMethods; j++) methods.add(new MethodGen(cp, i));
231 attributes = new AttrGen(cp, i);
232 sourceFile = (String)attributes.get("SourceFile");
235 /** Thrown when class generation fails for a reason not under the control of the user
236 (IllegalStateExceptions are thrown in those cases */
237 public static class Exn extends RuntimeException {
238 public Exn(String s) { super(s); }
241 public static class ClassReadExn extends IOException {
242 public ClassReadExn(String s) { super(s); }
245 /** A class representing a field or method reference. This is used as an argument to the INVOKE*, GET*, and PUT* bytecodes
251 public static abstract class FieldOrMethodRef {
256 FieldOrMethodRef(Type.Object klass, String name, String descriptor) { this.klass = klass; this.name = name; this.descriptor = descriptor; }
257 FieldOrMethodRef(FieldOrMethodRef o) { this.klass = o.klass; this.name = o.name; this.descriptor = o.descriptor; }
258 public boolean equals(Object o_) {
259 if(!(o_ instanceof FieldOrMethodRef)) return false;
260 FieldOrMethodRef o = (FieldOrMethodRef) o_;
261 return o.klass.equals(klass) && o.name.equals(name) && o.descriptor.equals(descriptor);
263 public int hashCode() { return klass.hashCode() ^ name.hashCode() ^ descriptor.hashCode(); }
266 static class AttrGen {
267 private final CPGen cp;
268 private final Hashtable ht = new Hashtable();
270 public AttrGen(CPGen cp) { this.cp = cp; }
271 public AttrGen(CPGen cp, DataInput in) throws IOException {
273 int size = in.readShort();
274 for(int i=0; i<size; i++) {
276 int idx = in.readShort();
277 CPGen.Ent e = cp.getByIndex(idx);
278 Object key = e.key();
279 if (key instanceof String) name = (String)key;
280 else name = ((Type)key).getDescriptor();
282 int length = in.readInt();
283 if (length==2) { // FIXME might be wrong assumption
284 ht.put(name, cp.getByIndex(in.readShort()));
286 byte[] buf = new byte[length];
293 public Object get(String s) {
294 Object ret = ht.get(s);
295 if (ret instanceof CPGen.Utf8Ent) return ((CPGen.Utf8Ent)ret).s;
299 public void add(String s, Object data) {
304 public boolean contains(String s) { return ht.get(s) != null; }
306 public int size() { return ht.size(); }
308 public void dump(DataOutput o) throws IOException {
309 for(Enumeration e = ht.keys(); e.hasMoreElements();) {
310 String name = (String) e.nextElement();
311 Object val = ht.get(name);
312 o.writeShort(cp.getUtf8Index(name));
313 if(val instanceof byte[]) {
314 byte[] buf = (byte[]) val;
315 o.writeInt(buf.length);
317 } else if(val instanceof CPGen.Ent) {
319 o.writeShort(cp.getIndex((CPGen.Ent)val));
321 throw new Error("should never happen");
327 public static void main(String[] args) throws Exception {
328 if (args.length==1) {
329 if (args[0].endsWith(".class")) {
330 System.out.println(new ClassGen(new DataInputStream(new FileInputStream(args[0]))));
332 InputStream is = Class.forName(args[0]).getClassLoader().getResourceAsStream(args[0].replace('.', '/')+".class");
333 System.out.println(new ClassGen(new DataInputStream(is)));
337 Type.Object me = new Type.Object("Test");
338 ClassGen cg = new ClassGen("Test", "java.lang.Object", ACC_PUBLIC|ACC_SUPER|ACC_FINAL);
339 FieldGen fg = cg.addField("foo", Type.INT, ACC_PUBLIC|ACC_STATIC);
341 MethodGen mg = cg.addMethod("main", Type.VOID, new Type[]{Type.arrayType(Type.STRING)}, ACC_STATIC|ACC_PUBLIC);
345 mg.add(PUTSTATIC, fieldRef(me, "foo", Type.INT));
347 mg.add(GETSTATIC, cg.fieldRef(new Type.Object("java.lang.System"), "out", new Type.Object("java.io.PrintStream")));
349 mg.add(GETSTATIC, cg.fieldRef(me, "foo", Type.INT));
350 mg.add(INVOKEVIRTUAL, cg.methodRef(new Type.Object("java.io.PrintStream"), "println",
351 Type.VOID, new Type[]{Type.INT}));
352 //mg.add(IINC, new int[]{0, 1});
354 mg.add(GETSTATIC, cg.fieldRef(me, "foo", Type.INT));
358 mg.add(PUTSTATIC, cg.fieldRef(me, "foo", Type.INT));
360 mg.add(IF_ICMPLT, top);
362 cg.dump("Test.class");