Member.getDescriptor
[org.ibex.classgen.git] / src / org / ibex / classgen / Type.java
1 package org.ibex.classgen;
2
3 import java.util.StringTokenizer;
4 import java.util.Hashtable;
5
6 public class Type implements CGConst {
7
8     private static Hashtable instances = new Hashtable();  // this has to appear at the top of the file
9
10     // Public API //////////////////////////////////////////////////////////////////////////////
11
12     public static final Type VOID = new Type("V", "void");
13     public static final Type INT = new Type("I", "int");
14     public static final Type LONG = new Type("J", "long");
15     public static final Type BOOLEAN = new Type("Z", "boolean");
16     public static final Type DOUBLE = new Type("D", "double");
17     public static final Type FLOAT = new Type("F", "float");
18     public static final Type BYTE = new Type("B", "byte");
19     public static final Type CHAR = new Type("C", "char");
20     public static final Type SHORT = new Type("S", "short");
21     
22     public static final Type.Class OBJECT = new Type.Class("java.lang.Object");
23     public static final Type.Class STRING = new Type.Class("java.lang.String");
24     public static final Type.Class STRINGBUFFER = new Type.Class("java.lang.StringBuffer");
25     public static final Type.Class INTEGER_OBJECT = new Type.Class("java.lang.Integer");
26     public static final Type.Class DOUBLE_OBJECT = new Type.Class("java.lang.Double");
27     public static final Type.Class FLOAT_OBJECT = new Type.Class("java.lang.Float");
28     
29     /** A zero element Type[] array (can be passed as the "args" param when a method takes no arguments */
30     public static final Type[] NO_ARGS = new Type[0];
31     
32     /** guarantee: there will only be one instance of Type for a given descriptor ==> equals() and == are interchangeable */
33     public static Type instance(String d) {
34         Type ret = (Type)instances.get(d);
35         if (ret != null) return ret;
36         if (d.startsWith("[")) return new Type.Array(instance(d.substring(1)));
37         return new Type.Class(d);
38     }
39
40     public       String  toString() { return toString; }
41     public       String  debugToString() { return toString; }
42     public final String  getDescriptor() { return descriptor; }
43
44     public Type.Array  makeArray() { return (Type.Array)instance("["+descriptor); }
45     public Type.Array  makeArray(int i) { return i==0 ? (Type.Array)this : makeArray().makeArray(i-1); }
46
47     public Type.Ref    asRef()       { throw new RuntimeException("attempted to use "+this+" as a Type.Ref, which it is not"); }
48     public Type.Class  asClass()     { throw new RuntimeException("attempted to use "+this+" as a Type.Class, which it is not"); }
49     public Type.Array  asArray()     { throw new RuntimeException("attempted to use "+this+" as a Type.Array, which it is not"); }
50     public boolean     isPrimitive() { return !isRef(); }
51     public boolean     isRef()       { return false; }
52     public boolean     isClass()     { return false; }
53     public boolean     isArray()     { return false; }
54
55     // Protected/Private //////////////////////////////////////////////////////////////////////////////
56
57     protected final String descriptor;
58     protected final String toString;
59     protected Type(String descriptor) { this(descriptor, descriptor); }
60     protected Type(String descriptor, String humanReadable) {
61         this.toString = humanReadable;
62         instances.put(this.descriptor = descriptor, this);
63     }
64
65     public static class Ref extends Type {
66         protected Ref(String descriptor) { super(descriptor); }
67         protected Ref(String descriptor, String humanReadable) { super(descriptor, humanReadable); }
68         public    Type.Ref asRef() { return this; }
69         public    boolean  isRef() { return true; }
70     }
71
72     public static class Array extends Type.Ref {
73         protected Array(Type t) { super("[" + t.getDescriptor(), t.toString() + "[]"); }
74         public Type.Array asArray() { return this; }
75         public boolean isArray() { return true; }
76         public int dimension() { return getDescriptor().lastIndexOf('['); }
77         public Type getElementType() { return Type.instance(getDescriptor().substring(0, getDescriptor().length()-1)); }
78     }
79
80     public static class Class extends Type.Ref {
81         protected Class(String s) { super(_initHelper(s), _initHelper2(s)); }
82         public Type.Class asClass() { return this; }
83         public boolean isClass() { return true; }
84         public String getShortName() { return toString.substring(toString.lastIndexOf('.')+1); }
85         public String getName() { return toString(); }
86         //public boolean extendsOrImplements(Type.Class c, Context cx) { }
87         String internalForm() { return descriptor.substring(1, descriptor.length()-1); }
88         private static String _initHelper(String s) {
89             if (!s.startsWith("L") || !s.endsWith(";")) s = "L" + s.replace('.', '/') + ";";
90             return s;
91         }
92         private static String _initHelper2(String s) {
93             if (s.startsWith("L") && s.endsWith(";")) s = s.substring(1, s.length()-1);
94             return s.replace('/', '.');
95         }
96         String[] components() {
97             StringTokenizer st = new StringTokenizer(descriptor.substring(1, descriptor.length()-1), "/");
98             String[] a = new String[st.countTokens()];
99             for(int i=0;st.hasMoreTokens();i++) a[i] = st.nextToken();
100             return a;
101         }
102
103         public Field  field(String name, Type type) { return new Field(name, type); }
104         public Method method(String name, Type returnType, Type[] argTypes) { return new Method(name, returnType, argTypes); }
105         public Method method(String name, String typeDescriptor) {
106             // FEATURE: This parser is ugly but it works (and shouldn't be a problem) might want to clean it up though
107             String s = typeDescriptor;
108             if(!s.startsWith("(")) throw new IllegalArgumentException("invalid method type descriptor");
109             int p = s.indexOf(')');
110             if(p == -1) throw new IllegalArgumentException("invalid method type descriptor");
111             String argsDesc = s.substring(1,p);
112             String retDesc = s.substring(p+1);
113             Type[] argsBuf = new Type[argsDesc.length()];
114             int i;
115             for(i=0,p=0;argsDesc.length() > 0;i++,p=0) {
116                 while(p < argsDesc.length() && argsDesc.charAt(p) == '[') p++;
117                 if(p == argsDesc.length())  throw new IllegalArgumentException("invalid method type descriptor");
118                 if(argsDesc.charAt(p) == 'L') {
119                     p = argsDesc.indexOf(';');
120                     if(p == -1) throw new IllegalArgumentException("invalid method type descriptor");
121                 }
122                 argsBuf[i] = Type.instance(argsDesc.substring(0,p+1));
123                 argsDesc = argsDesc.substring(p+1);
124             }
125             Type args[] = new Type[i];
126             System.arraycopy(argsBuf,0,args,0,i);
127             return method(name, Type.instance(retDesc), args);
128         }
129
130         public abstract class Member {
131             public final String name;
132             private Member(String name) { this.name = name; }
133             public Type.Class getDeclaringClass() { return Type.Class.this; }
134             public abstract String getDescriptor();
135             public boolean equals(Object o_) {
136                 if(!(o_ instanceof Member)) return false;
137                 Member o = (Member) o_;
138                 return o.getDeclaringClass().equals(getDeclaringClass()) &&
139                     o.name.equals(name) &&
140                     o.getDescriptor().equals(getDescriptor());
141             }
142             public int hashCode() { return getDeclaringClass().hashCode() ^ name.hashCode() ^ getDescriptor().hashCode(); }
143             public String toString() { return debugToString(); }
144             public abstract String debugToString();
145         }
146     
147         public class Field extends Member {
148             public final Type type;
149             private Field(String name, Type t) { super(name); this.type = t; }
150             public String getTypeDescriptor() { return type.getDescriptor(); }
151             public Type getType() { return type; }
152             public String debugToString() { return getDeclaringClass()+"."+name+"["+type+"]"; }
153             public class Body extends HasFlags {
154                 public final int flags;
155                 public Body(int flags) { this.flags = flags; }
156                 public int getFlags() { return flags; }
157             }
158         }
159
160         public class Method extends Member {
161             final Type[] argTypes;
162             public final Type   returnType;
163             public Type getReturnType()   { return returnType; }
164             public int  getNumArgs()      { return argTypes.length; }
165             public Type getArgType(int i) { return argTypes[i]; }
166             public Type[] getArgTypes()   {
167                 Type[] ret = new Type[argTypes.length];
168                 System.arraycopy(argTypes, 0, ret, 0, ret.length);
169                 return ret;
170             }
171
172             public boolean isConstructor() { return getName().equals("<init>"); }
173             public boolean isClassInitializer() { return getName().equals("<clinit>"); }
174             public String debugToString() {
175                 StringBuffer sb = new StringBuffer();
176                 if (name.equals("<clinit>")) sb.append("static ");
177                 else {
178                     if (name.equals("<init>"))
179                         sb.append(Class.this.getShortName());
180                     else
181                         sb.append(returnType).append(" ").append(name);
182                     sb.append("(");
183                     for(int i=0; i<argTypes.length; i++)
184                         sb.append((i==0?"":", ")+argTypes[i].debugToString());
185                     sb.append(") ");
186                 }
187                 return sb.toString();
188             }
189             private Method(String name, Type returnType, Type[] argTypes) {
190                 super(name);
191                 this.argTypes = argTypes;
192                 this.returnType = returnType;
193             }
194             public String getDescriptor() {
195                 StringBuffer sb = new StringBuffer(argTypes.length*4);
196                 sb.append("(");
197                 for(int i=0;i<argTypes.length;i++) sb.append(argTypes[i].getDescriptor());
198                 sb.append(")");
199                 sb.append(returnType.getDescriptor());
200                 return sb.toString();
201             }
202             public abstract class Body extends HasFlags {
203                 public abstract java.util.Hashtable getThrownExceptions();
204                 public abstract void debugBodyToString(StringBuffer sb);
205                 public void debugToString(StringBuffer sb, String constructorName) {
206                     int flags = getFlags();
207                     sb.append("  ").append(ClassFile.flagsToString(flags,false));
208                     sb.append(Method.this.debugToString());
209                     java.util.Hashtable thrownExceptions = getThrownExceptions();
210                     if (thrownExceptions.size() > 0) {
211                         sb.append("throws");
212                         for(java.util.Enumeration e = thrownExceptions.keys();e.hasMoreElements();)
213                             sb.append(" ").append(((Type.Class)e.nextElement()).debugToString()).append(",");
214                         sb.setLength(sb.length()-1);
215                         sb.append(" ");
216                     }
217                     if ((flags & (NATIVE|ABSTRACT))==0) {
218                         sb.append("{\n");
219                         debugBodyToString(sb);
220                         sb.append("  }\n");
221                     } else {
222                         sb.append(";");
223                     }
224                 }
225             }
226         }
227     }
228     
229     // FEATURE: This probably isn't the best place for these
230     static String methodTypeDescriptor(Type[] argTypes, Type returnType) {
231         StringBuffer sb = new StringBuffer(argTypes.length*4);
232         sb.append("(");
233         for(int i=0;i<argTypes.length;i++) sb.append(argTypes[i].getDescriptor());
234         sb.append(")");
235         sb.append(returnType.getDescriptor());
236         return sb.toString();
237     }
238
239 }