refactored functionality out of FieldGen into Type.Class.Field
[org.ibex.classgen.git] / src / org / ibex / classgen / Type.java
index 067e611..08c346f 100644 (file)
@@ -3,51 +3,55 @@ package org.ibex.classgen;
 import java.util.StringTokenizer;
 import java.util.Hashtable;
 
-public class Type implements CGConst {
+public abstract class Type implements CGConst {
 
     private static Hashtable instances = new Hashtable();  // this has to appear at the top of the file
 
     // Public API //////////////////////////////////////////////////////////////////////////////
 
-    public static final Type VOID = new Type("V", "void");
-    public static final Type INT = new Type("I", "int");
-    public static final Type LONG = new Type("J", "long");
-    public static final Type BOOLEAN = new Type("Z", "boolean");
-    public static final Type DOUBLE = new Type("D", "double");
-    public static final Type FLOAT = new Type("F", "float");
-    public static final Type BYTE = new Type("B", "byte");
-    public static final Type CHAR = new Type("C", "char");
-    public static final Type SHORT = new Type("S", "short");
+    public static final Type VOID = new Primitive("V", "void");
+    public static final Type INT = new Primitive("I", "int");
+    public static final Type LONG = new Primitive("J", "long");
+    public static final Type BOOLEAN = new Primitive("Z", "boolean");
+    public static final Type DOUBLE = new Primitive("D", "double");
+    public static final Type FLOAT = new Primitive("F", "float");
+    public static final Type BYTE = new Primitive("B", "byte");
+    public static final Type CHAR = new Primitive("C", "char");
+    public static final Type SHORT = new Primitive("S", "short");
     
-    public static final Type.Class OBJECT = new Type.Class("java.lang.Object");
-    public static final Type.Class STRING = new Type.Class("java.lang.String");
-    public static final Type.Class STRINGBUFFER = new Type.Class("java.lang.StringBuffer");
-    public static final Type.Class INTEGER_OBJECT = new Type.Class("java.lang.Integer");
-    public static final Type.Class DOUBLE_OBJECT = new Type.Class("java.lang.Double");
-    public static final Type.Class FLOAT_OBJECT = new Type.Class("java.lang.Float");
+    public static final Type.Class OBJECT = Type.Class.instance("java.lang.Object");
+    public static final Type.Class STRING = Type.Class.instance("java.lang.String");
+    public static final Type.Class STRINGBUFFER = Type.Class.instance("java.lang.StringBuffer");
+    public static final Type.Class INTEGER_OBJECT = Type.Class.instance("java.lang.Integer");
+    public static final Type.Class DOUBLE_OBJECT = Type.Class.instance("java.lang.Double");
+    public static final Type.Class FLOAT_OBJECT = Type.Class.instance("java.lang.Float");
     
     /** A zero element Type[] array (can be passed as the "args" param when a method takes no arguments */
     public static final Type[] NO_ARGS = new Type[0];
     
-    /** guarantee: there will only be one instance of Type for a given descriptor ==> equals() and == are interchangeable */
-    public static Type instance(String d) {
+    /** 
+     *  A "descriptor" is the classfile-mangled text representation of a type (see JLS section 4.3)
+     *  guarantee: there will only be one instance of Type for a given descriptor ==> equals() and == are interchangeable
+     */
+    public static Type fromDescriptor(String d) {
         Type ret = (Type)instances.get(d);
         if (ret != null) return ret;
-        if (d.startsWith("[")) return new Type.Array(instance(d.substring(1)));
+        if (d.startsWith("[")) return new Type.Array(Type.fromDescriptor(d.substring(1)));
         return new Type.Class(d);
     }
 
-    public       String  toString() { return toString; }
-    public       String  debugToString() { return toString; }
+    public final String  toString() { return super.toString(); }
+    public abstract String debugToString();
+    
     public final String  getDescriptor() { return descriptor; }
 
-    public Type.Array  makeArray() { return (Type.Array)instance("["+descriptor); }
+    public Type.Array  makeArray() { return (Type.Array)Type.fromDescriptor("["+descriptor); }
     public Type.Array  makeArray(int i) { return i==0 ? (Type.Array)this : makeArray().makeArray(i-1); }
 
     public Type.Ref    asRef()       { throw new RuntimeException("attempted to use "+this+" as a Type.Ref, which it is not"); }
     public Type.Class  asClass()     { throw new RuntimeException("attempted to use "+this+" as a Type.Class, which it is not"); }
     public Type.Array  asArray()     { throw new RuntimeException("attempted to use "+this+" as a Type.Array, which it is not"); }
-    public boolean     isPrimitive() { return !isRef(); }
+    public boolean     isPrimitive() { return false; }
     public boolean     isRef()       { return false; }
     public boolean     isClass()     { return false; }
     public boolean     isArray()     { return false; }
@@ -55,44 +59,55 @@ public class Type implements CGConst {
     // Protected/Private //////////////////////////////////////////////////////////////////////////////
 
     protected final String descriptor;
-    protected final String toString;
-    protected Type(String descriptor) { this(descriptor, descriptor); }
-    protected Type(String descriptor, String humanReadable) {
-        this.toString = humanReadable;
-        instances.put(this.descriptor = descriptor, this);
+    
+    protected Type(String descriptor) {
+        this.descriptor = descriptor;
+        instances.put(descriptor, this);
     }
 
-    public static class Ref extends Type {
+    public static class Primitive extends Type {
+        private String humanReadable;
+        Primitive(String descriptor, String humanReadable) {
+            super(descriptor);
+            this.humanReadable = humanReadable;
+        }
+        public String debugToString() { return humanReadable; }
+        public boolean     isPrimitive() { return true; }
+    }
+    
+    public abstract static class Ref extends Type {
         protected Ref(String descriptor) { super(descriptor); }
-        protected Ref(String descriptor, String humanReadable) { super(descriptor, humanReadable); }
+        public abstract String debugToString();
         public    Type.Ref asRef() { return this; }
         public    boolean  isRef() { return true; }
     }
 
     public static class Array extends Type.Ref {
-        protected Array(Type t) { super("[" + t.getDescriptor(), t.toString() + "[]"); }
+        public final Type base;
+        protected Array(Type t) { super("[" + t.getDescriptor()); base = t; }
         public Type.Array asArray() { return this; }
         public boolean isArray() { return true; }
-        public int dimension() { return getDescriptor().lastIndexOf('['); }
-        public Type getElementType() { return Type.instance(getDescriptor().substring(0, getDescriptor().length()-1)); }
+        public String debugToString() { return base.debugToString() + "[]"; }
+        public Type getElementType() { return Type.fromDescriptor(getDescriptor().substring(0, getDescriptor().length()-1)); }
     }
 
     public static class Class extends Type.Ref {
-        protected Class(String s) { super(_initHelper(s), _initHelper2(s)); }
+        protected Class(String s) { super(_initHelper(s)); }
         public Type.Class asClass() { return this; }
         public boolean isClass() { return true; }
-        public String getShortName() { return toString.substring(toString.lastIndexOf('.')+1); }
-        public String getName() { return toString(); }
+        public static Type.Class instance(String className) {
+            return (Type.Class)Type.fromDescriptor("L"+className.replace('.', '/')+";"); }
         //public boolean extendsOrImplements(Type.Class c, Context cx) { }
         String internalForm() { return descriptor.substring(1, descriptor.length()-1); }
+        public String debugToString() { return internalForm().replace('/','.'); }
+        public String getShortName() {
+            int p = descriptor.lastIndexOf('/');
+            return p == -1 ? descriptor.substring(1,descriptor.length()-1) : descriptor.substring(p+1,descriptor.length()-1);
+        }
         private static String _initHelper(String s) {
             if (!s.startsWith("L") || !s.endsWith(";")) s = "L" + s.replace('.', '/') + ";";
             return s;
         }
-        private static String _initHelper2(String s) {
-            if (s.startsWith("L") && s.endsWith(";")) s = s.substring(1, s.length()-1);
-            return s.replace('/', '.');
-        }
         String[] components() {
             StringTokenizer st = new StringTokenizer(descriptor.substring(1, descriptor.length()-1), "/");
             String[] a = new String[st.countTokens()];
@@ -100,16 +115,19 @@ public class Type implements CGConst {
             return a;
         }
 
+        public Field field(String name, Type type) { return new Field(name, type); }
         public abstract class Body extends HasFlags {
         }
 
-        public Field  field(String name, Type type) { return new Field(name, type); }
         public Method method(String name, Type returnType, Type[] argTypes) { return new Method(name, returnType, argTypes); }
+        public Method method(String leftCrap, String rightCrap) { return method(leftCrap+rightCrap); }
+
+        /** see JVM Spec section 2.10.2 */
         public Method method(String signature) {
             // FEATURE: This parser is ugly but it works (and shouldn't be a problem) might want to clean it up though
-            String s = signature;
-            String name = s.startsWith("(") ? "" : s.substring(0, s.indexOf('('));
-            s = s.substring(s.indexOf('('));
+            String name = signature.substring(0, signature.indexOf('('));
+            String s = signature.substring(signature.indexOf('('));
+            if(!s.startsWith("(")) throw new IllegalArgumentException("invalid method type descriptor");
             int p = s.indexOf(')');
             if(p == -1) throw new IllegalArgumentException("invalid method type descriptor");
             String argsDesc = s.substring(1,p);
@@ -123,33 +141,37 @@ public class Type implements CGConst {
                     p = argsDesc.indexOf(';');
                     if(p == -1) throw new IllegalArgumentException("invalid method type descriptor");
                 }
-                argsBuf[i] = Type.instance(argsDesc.substring(0,p+1));
+                argsBuf[i] = Type.fromDescriptor(argsDesc.substring(0,p+1));
                 argsDesc = argsDesc.substring(p+1);
             }
             Type args[] = new Type[i];
             System.arraycopy(argsBuf,0,args,0,i);
-            return method(name, Type.instance(retDesc), args);
+            return method(name, Type.fromDescriptor(retDesc), args);
         }
 
         public abstract class Member {
             public final String name;
             private Member(String name) { this.name = name; }
             public Type.Class getDeclaringClass() { return Type.Class.this; }
-            public abstract String getDescriptor();
-            public String toString() { return debugToString(); }
+            public String getName() { return name; }
+            public abstract String getTypeDescriptor();
             public abstract String debugToString();
         }
     
         public class Field extends Member {
             public final Type type;
             private Field(String name, Type t) { super(name); this.type = t; }
-            public String getDescriptor() { return type.getDescriptor(); }
+            public String getTypeDescriptor() { return type.getDescriptor(); }
             public Type getType() { return type; }
-            public String debugToString() { return getDeclaringClass()+"."+name+"["+type+"]"; }
+            public String debugToString() { return getDeclaringClass().debugToString()+"."+name+"["+type.debugToString()+"]"; }
             public class Body extends HasFlags {
                 public final int flags;
-                public Body(int flags) { this.flags = flags; }
+                public Body(int flags) {
+                    if ((flags & ~VALID_FIELD_FLAGS) != 0) throw new IllegalArgumentException("invalid flags");
+                    this.flags = flags;
+                }
                 public int getFlags() { return flags; }
+                public Field getField() { return Field.this; }
             }
         }
 
@@ -164,7 +186,6 @@ public class Type implements CGConst {
                 System.arraycopy(argTypes, 0, ret, 0, ret.length);
                 return ret;
             }
-
             public boolean isConstructor() { return getName().equals("<init>"); }
             public boolean isClassInitializer() { return getName().equals("<clinit>"); }
             public String debugToString() {
@@ -174,7 +195,7 @@ public class Type implements CGConst {
                     if (name.equals("<init>"))
                         sb.append(Class.this.getShortName());
                     else
-                        sb.append(returnType).append(" ").append(name);
+                        sb.append(returnType.debugToString()).append(".").append(name);
                     sb.append("(");
                     for(int i=0; i<argTypes.length; i++)
                         sb.append((i==0?"":", ")+argTypes[i].debugToString());
@@ -188,7 +209,7 @@ public class Type implements CGConst {
                 this.returnType = returnType;
             }
             //public Method.Body getBody(Context cx) { }
-            public String getDescriptor() {
+            public String getTypeDescriptor() {
                 StringBuffer sb = new StringBuffer(argTypes.length*4);
                 sb.append("(");
                 for(int i=0;i<argTypes.length;i++) sb.append(argTypes[i].getDescriptor());