remove no-longer-necessary equals() and hashCode() methods
[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         String internalForm() { return descriptor.substring(1, descriptor.length()-1); }
86         private static String _initHelper(String s) {
87             if (!s.startsWith("L") || !s.endsWith(";")) s = "L" + s.replace('.', '/') + ";";
88             return s;
89         }
90         private static String _initHelper2(String s) {
91             if (s.startsWith("L") && s.endsWith(";")) s = s.substring(1, s.length()-1);
92             return s.replace('/', '.');
93         }
94         String[] components() {
95             StringTokenizer st = new StringTokenizer(descriptor.substring(1, descriptor.length()-1), "/");
96             String[] a = new String[st.countTokens()];
97             for(int i=0;st.hasMoreTokens();i++) a[i] = st.nextToken();
98             return a;
99         }
100
101         public Field  field(String name, Type type) { return new Field(name, type); }
102         public Method method(String name, Type returnType, Type[] argTypes) { return new Method(name, returnType, argTypes); }
103         public Method method(String signature) {
104             // FEATURE: This parser is ugly but it works (and shouldn't be a problem) might want to clean it up though
105             String s = signature;
106             String name = s.startsWith("(") ? "" : s.substring(0, s.indexOf('('));
107             s = s.substring(s.indexOf('('));
108             int p = s.indexOf(')');
109             if(p == -1) throw new IllegalArgumentException("invalid method type descriptor");
110             String argsDesc = s.substring(1,p);
111             String retDesc = s.substring(p+1);
112             Type[] argsBuf = new Type[argsDesc.length()];
113             int i;
114             for(i=0,p=0;argsDesc.length() > 0;i++,p=0) {
115                 while(p < argsDesc.length() && argsDesc.charAt(p) == '[') p++;
116                 if(p == argsDesc.length())  throw new IllegalArgumentException("invalid method type descriptor");
117                 if(argsDesc.charAt(p) == 'L') {
118                     p = argsDesc.indexOf(';');
119                     if(p == -1) throw new IllegalArgumentException("invalid method type descriptor");
120                 }
121                 argsBuf[i] = Type.instance(argsDesc.substring(0,p+1));
122                 argsDesc = argsDesc.substring(p+1);
123             }
124             Type args[] = new Type[i];
125             System.arraycopy(argsBuf,0,args,0,i);
126             return method(name, Type.instance(retDesc), args);
127         }
128
129         public abstract class Member {
130             public final String name;
131             private Member(String name) { this.name = name; }
132             public Type.Class getDeclaringClass() { return Type.Class.this; }
133             public abstract String getDescriptor();
134             public String toString() { return debugToString(); }
135             public abstract String debugToString();
136         }
137     
138         public class Field extends Member {
139             public final Type type;
140             private Field(String name, Type t) { super(name); this.type = t; }
141             public String getDescriptor() { return type.getDescriptor(); }
142             public Type getType() { return type; }
143             public String debugToString() { return getDeclaringClass()+"."+name+"["+type+"]"; }
144         }
145
146         public class Method extends Member {
147             final Type[] argTypes;
148             public final Type   returnType;
149             public Type getArgType(int i) { return argTypes[i]; }
150             public int  getNumArgs()      { return argTypes.length; }
151             public Type getReturnType()   { return returnType; }
152             public String debugToString() {
153                 StringBuffer sb = new StringBuffer();
154                 if (name.equals("<clinit>")) sb.append("static ");
155                 else {
156                     if (name.equals("<init>"))
157                         sb.append(Class.this.getShortName());
158                     else
159                         sb.append(returnType).append(" ").append(name);
160                     sb.append("(");
161                     for(int i=0; i<argTypes.length; i++)
162                         sb.append((i==0?"":", ")+argTypes[i].debugToString());
163                     sb.append(") ");
164                 }
165                 return sb.toString();
166             }
167             private Method(String name, Type returnType, Type[] argTypes) {
168                 super(name);
169                 this.argTypes = argTypes;
170                 this.returnType = returnType;
171             }
172             public String getDescriptor() {
173                 StringBuffer sb = new StringBuffer(argTypes.length*4);
174                 sb.append("(");
175                 for(int i=0;i<argTypes.length;i++) sb.append(argTypes[i].getDescriptor());
176                 sb.append(")");
177                 sb.append(returnType.getDescriptor());
178                 return sb.toString();
179             }
180             public abstract class Body implements HasFlags {
181                 public abstract java.util.Hashtable getThrownExceptions();
182                 public abstract void debugBodyToString(StringBuffer sb);
183                 public void debugToString(StringBuffer sb, String constructorName) {
184                     int flags = getFlags();
185                     sb.append("  ").append(ClassFile.flagsToString(flags,false));
186                     sb.append(Method.this.debugToString());
187                     java.util.Hashtable thrownExceptions = getThrownExceptions();
188                     if (thrownExceptions.size() > 0) {
189                         sb.append("throws");
190                         for(java.util.Enumeration e = thrownExceptions.keys();e.hasMoreElements();)
191                             sb.append(" ").append(((Type.Class)e.nextElement()).debugToString()).append(",");
192                         sb.setLength(sb.length()-1);
193                         sb.append(" ");
194                     }
195                     if ((flags & (NATIVE|ABSTRACT))==0) {
196                         sb.append("{\n");
197                         debugBodyToString(sb);
198                         sb.append("  }\n");
199                     } else {
200                         sb.append(";");
201                     }
202                 }
203             }
204         }
205     }
206     
207     // FEATURE: This probably isn't the best place for these
208     static String methodTypeDescriptor(Type[] argTypes, Type returnType) {
209         StringBuffer sb = new StringBuffer(argTypes.length*4);
210         sb.append("(");
211         for(int i=0;i<argTypes.length;i++) sb.append(argTypes[i].getDescriptor());
212         sb.append(")");
213         sb.append(returnType.getDescriptor());
214         return sb.toString();
215     }
216
217 }