5eba76d09adecdfed6181719f5f9d4864a3fbd3d
[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 {
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     public       int     hashCode() { return descriptor.hashCode(); }
44     public       boolean equals(java.lang.Object o) { return this==o; }
45
46     public Type.Array  makeArray() { return (Type.Array)instance("["+descriptor); }
47     public Type.Array  makeArray(int i) { return i==0 ? this : makeArray().makeArray(i-1); }
48
49     public Type.Ref    asRef()       { throw new RuntimeException("attempted to use "+this+" as a Type.Ref, which it is not"); }
50     public Type.Class  asClass()     { throw new RuntimeException("attempted to use "+this+" as a Type.Class, which it is not"); }
51     public Type.Array  asArray()     { throw new RuntimeException("attempted to use "+this+" as a Type.Array, which it is not"); }
52     public boolean     isPrimitive() { return !isRef(); }
53     public boolean     isRef()       { return false; }
54     public boolean     isClass()     { return false; }
55     public boolean     isArray()     { return false; }
56
57     // Protected/Private //////////////////////////////////////////////////////////////////////////////
58
59     protected final String descriptor;
60     protected final String toString;
61     protected Type(String descriptor) { this(descriptor, descriptor); }
62     protected Type(String descriptor, String humanReadable) {
63         this.toString = humanReadable;
64         instances.put(this.descriptor = descriptor, this);
65     }
66
67     public static class Ref extends Type {
68         protected Ref(String descriptor) { super(descriptor); }
69         protected Ref(String descriptor, String humanReadable) { super(descriptor, humanReadable); }
70         public    Type.Ref asRef() { return this; }
71         public    boolean  isRef() { return true; }
72     }
73
74     public static class Array extends Type.Ref {
75         protected Array(Type t) { super("[" + t.getDescriptor(), t.toString() + "[]"); }
76         public Type.Array asArray() { return this; }
77         public boolean isArray() { return true; }
78         public int dimension() { return getDescriptor().lastIndexOf('['); }
79     }
80
81     public static class Class extends Type.Ref {
82         protected Class(String s) { super(_initHelper(s), _initHelper2(s)); }
83         public Type.Class asClass() { return this; }
84         public boolean isClass() { return true; }
85         public String getShortName() { return toString.substring(toString.lastIndexOf('.')+1); }
86         String internalForm() { return descriptor.substring(1, descriptor.length()-1); }
87         private static String _initHelper(String s) {
88             if (!s.startsWith("L") || !s.endsWith(";")) s = "L" + s.replace('.', '/') + ";";
89             return s;
90         }
91         private static String _initHelper2(String s) {
92             if (s.startsWith("L") && s.endsWith(";")) s = s.substring(1, s.length()-1);
93             return s.replace('/', '.');
94         }
95         String[] components() {
96             StringTokenizer st = new StringTokenizer(descriptor.substring(1, descriptor.length()-1), "/");
97             String[] a = new String[st.countTokens()];
98             for(int i=0;st.hasMoreTokens();i++) a[i] = st.nextToken();
99             return a;
100         }
101
102         public Field  field(String name, Type type) { return new Field(name, type); }
103         public Method method(String name, Type returnType, Type[] argTypes) { return new Method(name, returnType, argTypes); }
104         public Method method(String signature) {
105             // FEATURE: This parser is ugly but it works (and shouldn't be a problem) might want to clean it up though
106             String s = signature;
107             String name = s.startsWith("(") ? "" : s.substring(0, s.indexOf('('));
108             s = s.substring(s.indexOf('('));
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         }
144     
145         public class Field extends Member {
146             public final Type type;
147             private Field(String name, Type t) { super(name); this.type = t; }
148             public String getDescriptor() { return name; }
149         }
150
151         public class Method extends Member {
152             final Type[] argTypes;
153             public final Type   returnType;
154             public Type getArgType(int i) { return argTypes[i]; }
155             public int  getNumArgs()      { return argTypes.length; }
156             public String debugToString() {
157                 StringBuffer sb = new StringBuffer();
158                 if (name.equals("<clinit>")) sb.append("static ");
159                 else {
160                     if (name.equals("<init>"))
161                         sb.append(Class.this.getShortName());
162                     else
163                         sb.append(returnType).append(" ").append(name);
164                     sb.append("(");
165                     for(int i=0; i<argTypes.length; i++)
166                         sb.append((i==0?"":", ")+argTypes[i].debugToString());
167                     sb.append(") ");
168                 }
169                 return sb.toString();
170             }
171             private Method(String name, Type returnType, Type[] argTypes) {
172                 super(name);
173                 this.argTypes = argTypes;
174                 this.returnType = returnType;
175             }
176             public String getDescriptor() {
177                 StringBuffer sb = new StringBuffer(argTypes.length*4);
178                 sb.append("(");
179                 for(int i=0;i<argTypes.length;i++) sb.append(argTypes[i].getDescriptor());
180                 sb.append(")");
181                 sb.append(returnType.getDescriptor());
182                 return sb.toString();
183             }
184         }
185     }
186     
187     // FEATURE: This probably isn't the best place for these
188     static String methodTypeDescriptor(Type[] argTypes, Type returnType) {
189         StringBuffer sb = new StringBuffer(argTypes.length*4);
190         sb.append("(");
191         for(int i=0;i<argTypes.length;i++) sb.append(argTypes[i].getDescriptor());
192         sb.append(")");
193         sb.append(returnType.getDescriptor());
194         return sb.toString();
195     }
196
197 }