1 // Copyright 2003 Adam Megacz, see the COPYING file for licensing [GPL]
10 * The public API for the JS engine. JS itself is actually a class
11 * implementing the absolute minimal amount of functionality for an
12 * Object which can be manipulated by JavaScript code. The static
13 * methods, fields, and inner classes of JS define the publicly
14 * visible API for the XWT JavaScript engine; code outside this
15 * package should never depend on anything not defined in this file.
17 public abstract class JS {
19 // Public Helper Methods //////////////////////////////////////////////////////////////////////
21 /** parse and compile a function */
22 public static Function parse(String sourceName, int firstLine, Reader sourceCode) throws IOException {
23 return new Function(sourceName, firstLine, sourceCode, null);
26 /** coerce an object to a Boolean */
27 public static boolean toBoolean(Object o) {
28 if (o == null) return false;
29 if (o instanceof Boolean) return ((Boolean)o).booleanValue();
30 if (o instanceof Long) return ((Long)o).longValue() != 0;
31 if (o instanceof Integer) return ((Integer)o).intValue() != 0;
32 if (o instanceof Number) {
33 double d = ((Number) o).doubleValue();
34 // NOTE: d == d is a test for NaN. It should be faster than Double.isNaN()
35 return d != 0.0 && d == d;
37 if (o instanceof String) return ((String)o).length() != 0;
41 /** coerce an object to a Long */
42 public static long toLong(Object o) { return toNumber(o).longValue(); }
44 /** coerce an object to an Int */
45 public static int toInt(Object o) { return toNumber(o).intValue(); }
47 /** coerce an object to a Double */
48 public static double toDouble(Object o) { return toNumber(o).doubleValue(); }
50 /** coerce an object to a Number */
51 public static Number toNumber(Object o) {
52 if (o == null) return new Long(0);
53 if (o instanceof Number) return ((Number)o);
55 // NOTE: There are about 3 pages of rules in ecma262 about string to number conversions
56 // We aren't even close to following all those rules. We probably never will be.
57 if (o instanceof String)
58 try { return new Double((String)o); } catch (NumberFormatException e) { return new Double(Double.NaN); }
59 if (o instanceof Boolean) return ((Boolean)o).booleanValue() ? new Long(1) : new Long(0);
60 if (o instanceof JS) return ((JS)o).coerceToNumber();
61 throw new Error("toNumber() got object of type " + o.getClass().getName() + " which we don't know how to handle");
64 /** coerce an object to a String */
65 public static String toString(Object o) {
66 if(o == null) return "null";
67 if(o instanceof String) return (String) o;
68 if(o instanceof Integer || o instanceof Long || o instanceof Boolean) return o.toString();
69 if(o instanceof JS) return ((JS)o).coerceToString();
70 if(o instanceof Double || o instanceof Float) {
71 double d = ((Number)o).doubleValue();
72 if((int)d == d) return Integer.toString((int)d);
78 // Instance Methods ////////////////////////////////////////////////////////////////////
80 public abstract Object get(Object key) throws JS.Exn;
81 public abstract Object put(Object key, Object val) throws JS.Exn;
82 public abstract Object[] keys();
84 public Object callMethod(Object method, Array args, boolean checkOnly) throws JS.Exn {
85 if(checkOnly) return Boolean.FALSE;
86 Object o = get(method);
87 if(o instanceof JS.Callable) {
88 return ((JS.Callable)o).call(args);
89 } else if(o == null) {
90 throw new JS.Exn("Attempted to call non-existent method: " + method);
92 throw new JS.Exn("Attempted to call a non-method: " +method);
96 public Number coerceToNumber() { throw new JS.Exn("tried to coerce a JavaScript object to a Number"); }
97 public String coerceToString() { throw new JS.Exn("tried to coerce a JavaScript object to a String"); }
98 public boolean coerceToBoolean() { throw new JS.Exn("tried to coerce a JavaScript object to a Boolean"); }
99 public String typeName() { return "object"; }
102 // Inner Classes /////////////////////////////////////////////////////////////////////////
104 /** A sensible implementation of the abstract methods in the JS class */
105 public static class Obj extends JS {
107 // FIXME: move these to an interface so they're optional
108 // this gets around a wierd fluke in the Java type checking rules for ?..:
109 public static final Object T = Boolean.TRUE;
110 public static final Object F = Boolean.FALSE;
112 // FIXME: be smart here; perhaps intern
113 public static final Number N(int i) { return new Integer(i); }
114 public static final Number N(long l) { return new Long(l); }
115 public static final Number N(double d) { return new Double(d); }
117 public static final Boolean B(boolean b) { return b ? Boolean.TRUE : Boolean.FALSE; }
119 private Hash entries = null;
120 private boolean sealed = false;
121 public Obj() { this(false); }
122 public Obj(boolean sealed) { this.sealed = sealed; }
123 public void setSeal(boolean sealed) { this.sealed = sealed; } ///< a sealed object cannot have its properties modified
124 public Object put(Object key, Object val) { put2(key, null, val); return null; }
125 protected void put2(Object key, Object key2, Object val) {
127 if (entries == null) entries = new Hash();
128 entries.put(key, key2, val); }
129 public Object[] keys() { return entries == null ? new Object[0] : entries.keys(); }
130 public Object get(Object key) { return get(key, null); }
131 protected Object get(Object key, Object key2) {
132 if (entries == null) return null;
133 if(key2 == null && callMethod((String)key, null, true) == Boolean.TRUE)
134 return new Internal.CallableStub(this, key);
135 return entries.get(key, key2);
139 /** An exception which can be thrown and caught by JavaScript code */
140 public static class Exn extends RuntimeException {
141 private Object js = null;
142 public Exn(Object js) { this.js = js; }
143 public String toString() { return "JS.Exn: " + js; }
144 public String getMessage() { return toString(); }
145 public Object getObject() { return js; }
148 /** The publicly-visible face of JavaScript Array objects */
149 public static class Array extends ArrayImpl {
151 public Array(int size) { super(size); }
152 public void setSize(int i) { super.setSize(i); }
153 public int length() { return super.length(); }
154 public Object elementAt(int i) { return super.elementAt(i); }
155 public void addElement(Object o) { super.addElement(o); }
156 public void setElementAt(Object o, int i) { super.setElementAt(o, i); }
157 public Object get(Object key) { return super._get(key); }
158 public Object put(Object key, Object val) { super._put(key, val); return null; }
161 /** Any object which becomes part of the scope chain must support this interface */
162 public static class Scope extends ScopeImpl {
163 public Scope(Scope parentScope) { this(parentScope, false); }
164 public Scope(Scope parentScope, boolean sealed) { super(parentScope, sealed); }
165 public boolean has(Object key) { return super.has(key); }
166 public Object get(Object key) { return super._get(key); }
167 public Object put(Object key, Object val) { super._put(key, val); return null; }
168 public void declare(String s) { super.declare(s); }
171 /** the result of a graft */
172 public static class Graft extends JS {
174 private Object replaced_key;
175 private Object replaced_val;
176 public Graft(JS graftee, Object key, Object val) {
177 if (graftee instanceof Array) throw new JS.Exn("can't graft onto Arrays (yet)");
178 if (graftee instanceof Callable) throw new JS.Exn("can't graft onto Callables (yet)");
179 if (graftee instanceof Scope) throw new JS.Exn("can't graft onto Scopes (yet)");
180 this.graftee = graftee;
184 public boolean equals(Object o) { return (this == o || graftee.equals(o)); }
185 public int hashCode() { return graftee.hashCode(); }
186 public Object get(Object key) { return replaced_key.equals(key) ? replaced_val : graftee.get(key); }
187 public Object put(Object key, Object val) { graftee.put(key, val); return null; }
188 public Object callMethod(Object method, Array args, boolean checkOnly) throws JS.Exn {
189 if (!replaced_key.equals(method)) return graftee.callMethod(method, args, checkOnly);
190 if (replaced_val instanceof Callable) return checkOnly ? Boolean.TRUE : ((Callable)replaced_val).call(args);
191 if (checkOnly) return Boolean.FALSE;
192 throw new JS.Exn("attempt to call non-function");
194 public Number coerceToNumber() { return graftee.coerceToNumber(); }
195 public String coerceToString() { return graftee.coerceToString(); }
196 public boolean coerceToBoolean() { return graftee.coerceToBoolean(); }
197 public String typeName() { return graftee.typeName(); }
198 public Object[] keys() {
199 Object[] ret = graftee.keys();
200 for(int i=0; i<ret.length; i++) if (replaced_key.equals(ret[i])) return ret;
201 Object[] ret2 = new Object[ret.length + 1];
202 System.arraycopy(ret, 0, ret2, 0, ret.length);
203 ret2[ret2.length - 1] = replaced_key;
208 /** anything that is callable with the () operator and wasn't compiled from JS code */
209 public static abstract class Callable extends JS.Obj {
210 public abstract Object call(JS.Array args) throws JS.Exn;
213 /** a scope that is populated with js objects and functions normally found in the global scope */
214 public static class GlobalScope extends GlobalScopeImpl {
215 public GlobalScope() { this(null); }
216 public GlobalScope(JS.Scope parent) { super(parent); }
219 public static class TailCall {
220 Function func = null;
221 JS.Array args = null;
222 public TailCall() { }
223 public TailCall set(Function func) { this.func = func; this.args = new JS.Array(); return this; }
224 public TailCall set(Function func, JS.Array args) { this.func = func; this.args = args; return this; }
227 /** encapsulates the state of a JavaScript "thread" (ie stack) */
228 public static class Context {
231 // Statics //////////////////////////////////////////////////////////////////////
234 * Return this from call/get/put in order to make the interpreter pause. The interpreter will expect a value
235 * (the return from the call or the get) to be pushed onto the stack when it is resumed.
237 public static Object pause = new Object();
239 private int getLine_() { return current().f == null ? -1 : (pc < 0 || pc >= f.size) ? -1 : f.line[pc]; }
240 public static int getLine() { return current().getLine_(); }
241 public static String getSourceName() { return current().f == null ? null : current().f.sourceName; }
243 /** fetches the currently-executing javascript function */
244 public static JS.Context current() { return (JS.Context)threadToContext.get(Thread.currentThread()); }
245 private static Hashtable threadToContext = new Hashtable();
248 // Instance members and methods //////////////////////////////////////////////////////////////////////
250 /** the currently-executing Function */
253 /** the currently-executing scope */
254 public Scope scope = null; // FIXME: do we really need this? the function should contain this info
256 /** the object stack */
257 Vec stack = new Vec();
259 /** the program counter */
262 public Context(Function function, Scope scope) {
263 if (scope == null) scope = new Scope(function.parentScope);
264 stack.push(new Function.CallMarker(this));
265 stack.push(new JS.Array());
270 public Object resume() { return resume(null); }
271 public Object resume(Object o) {
272 Thread t = Thread.currentThread();
273 Context old = (Context)threadToContext.get(t);
275 threadToContext.put(t, this);
277 return Function.eval(this);
279 if (old == null) threadToContext.remove(t);
280 else threadToContext.put(t, old);
286 public static void recurse(String indent, String name, Object o) {
287 if (!name.equals("")) name += " : ";
290 Log.logJS(indent + name + "<null>");
292 } else if (o instanceof JS.Array) {
293 Log.logJS(indent + name + "<array>");
294 JS.Array na = (JS.Array)o;
295 for(int i=0; i<na.length(); i++)
296 recurse(indent + " ", i + "", na.elementAt(i));
298 } else if (o instanceof JS) {
299 Log.logJS(indent + name + "<object>");
301 Object[] keys = s.keys();
302 for(int i=0; i<keys.length; i++)
304 recurse(indent + " ", keys[i].toString(),
305 (keys[i] instanceof Integer) ?
306 s.get(((Integer)keys[i])) : s.get(keys[i].toString()));
309 Log.logJS(indent + name + o);