src/org/xwt/js/JS.java

   1 // Copyright 2003 Adam Megacz, see the COPYING file for licensing [GPL]
   2
   3 package org.xwt.js;
   4 import org.xwt.util.*;
   5 import java.io.*;
   6 import java.util.*;
   7
   8 /**
   9  *  The public API for the JS engine.  JS itself is actually a class
  10  *  implementing the absolute minimal amount of functionality for an
  11  *  Object which can be manipulated by JavaScript code.  The static
  12  *  methods, fields, and inner classes of JS define the publicly
  13  *  visible API for the XWT JavaScript engine; code outside this
  14  *  package should never depend on anything not defined in this file.
  15  */
  16 public abstract class JS {
  17
  18
  19     // Public Helper Methods //////////////////////////////////////////////////////////////////////
  20
  21     /** parse and compile a function */
  22     public static CompiledFunction parse(String sourceName, int firstLine, Reader sourceCode) throws IOException {
  23         return new CompiledFunction(sourceName, firstLine, sourceCode, null);
  24     }
  25
  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;
  36         }
  37         if (o instanceof String) return ((String)o).length() != 0;
  38         return true;
  39     }
  40
  41     /** coerce an object to a Long */
  42     public static long toLong(Object o) { return toNumber(o).longValue(); }
  43
  44     /** coerce an object to an Int */
  45     public static int toInt(Object o) { return toNumber(o).intValue(); }
  46
  47     /** coerce an object to a Double */
  48     public static double toDouble(Object o) { return toNumber(o).doubleValue(); }
  49
  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);
  54         // FIXME: There are about 3 pages of rules in ecma262 about string to number conversions
  55         // We aren't even close to following all those rules
  56         if (o instanceof String) try { return new Double((String)o); } catch (NumberFormatException e) { return new Double(Double.NaN); }
  57         if (o instanceof Boolean) return ((Boolean)o).booleanValue() ? new Long(1) : new Long(0);
  58         if (o instanceof JS) return ((JS)o).coerceToNumber();
  59         throw new Error("toNumber() got object of type " + o.getClass().getName() + " which we don't know how to handle");
  60     }
  61
  62
  63     // Instance Methods ////////////////////////////////////////////////////////////////////
  64
  65     public abstract Object get(Object key) throws JS.Exn;
  66     public abstract void put(Object key, Object val) throws JS.Exn;
  67     public abstract Object[] keys();
  68
  69     public Number coerceToNumber() { throw new Error("you cannot coerce a " + this.getClass().getName() + " into a Number"); }
  70     public String coerceToString() { throw new Error("you cannot coerce a " + this.getClass().getName() + " into a String"); }
  71     public boolean coerceToBoolean() { throw new Error("you cannot coerce a " + this.getClass().getName() + " into a Boolean"); }
  72
  73
  74     // Inner Classes /////////////////////////////////////////////////////////////////////////
  75
  76     /** A sensible implementation of the abstract methods in the JS class */
  77     public static class Obj extends JS {
  78         private Hash entries = new Hash();
  79         private boolean sealed = false;
  80         public Obj() { this(false); }
  81         public Obj(boolean sealed) { this.sealed = sealed; }
  82         /** a sealed object cannot have its properties modified */
  83         public void setSeal(boolean sealed) { this.sealed = sealed; }
  84         public Object get(Object key) { return entries.get(key); }
  85         public void put(Object key, Object val) { if (!sealed) entries.put(key, val); }
  86         public Object[] keys() { return(entries.keys()); }
  87     }
  88
  89     /** An exception which can be thrown and caught by JavaScript code */
  90     public static class Exn extends RuntimeException {
  91         private Object js = null;
  92         public Exn(Object js) { this.js = js; }
  93         public String toString() { return "JS.Exn: " + js; }
  94         public String getMessage() { return toString(); }
  95         public Object getObject() { return js; }
  96     }
  97
  98     /** The publicly-visible face of JavaScript Array objects */
  99     public static class Array extends ArrayImpl {
 100         public Array() { }
 101         public Array(int size) { super(size); }
 102         public void setSize(int i) { super.setSize(i); }
 103         public int length() { return super.length(); }
 104         public Object elementAt(int i) { return super.elementAt(i); }
 105         public void addElement(Object o) { super.addElement(o); }
 106         public void setElementAt(Object o, int i) { super.setElementAt(o, i); }
 107         public Object get(Object key) { return super._get(key); }
 108         public void put(Object key, Object val) { super._put(key, val); }
 109     }
 110
 111     /** Any object which becomes part of the scope chain must support this interface */
 112     public static class Scope extends ScopeImpl {
 113         public Scope(Scope parentScope) { this(parentScope, false); }
 114         public Scope(Scope parentScope, boolean sealed) { super(parentScope, sealed); }
 115         /** transparent scopes are not returned by THIS */
 116         public boolean isTransparent() { return super.isTransparent(); }
 117         public boolean has(Object key) { return super.has(key); }
 118         public Object get(Object key) { return super._get(key); }
 119         public void put(Object key, Object val) { super._put(key, val); }
 120         public void declare(String s) { super.declare(s); }
 121     }
 122
 123     /** anything that is callable with the () operator */
 124     public static abstract class Callable extends JS.Obj {
 125         public abstract Object call(JS.Array args) throws JS.Exn;
 126     }
 127
 128     /** a Callable which was compiled from JavaScript code */
 129     public static class CompiledFunction extends CompiledFunctionImpl {
 130         CompiledFunction(String sourceName, int firstLine, Reader sourceCode, Scope scope) throws IOException {
 131             super(sourceName, firstLine, sourceCode, scope);
 132         }
 133     }
 134
 135     public static final JS Math = new org.xwt.js.Math();
 136
 137     /** encapsulates a single JavaScript thread; the JS.Thread->java.lang.Thread mapping is 1:1 */
 138     public static class Thread {
 139
 140         CompiledFunction currentCompiledFunction = null;
 141         Vec stack = new Vec();
 142         int line = -1;
 143
 144         /** binds this thread to the current Java Thread */
 145         public void bindToCurrentJavaThread() { javaThreadToJSThread.put(java.lang.Thread.currentThread(), this); }
 146
 147         /** returns the line of code that is currently executing */
 148         public int getLine() { return line; }
 149
 150         /** returns the name of the source code file which declared the currently executing function */
 151         public String getSourceName() { return currentCompiledFunction == null ? null : currentCompiledFunction.getSourceName();  }
 152
 153         /** fetches the currently-executing javascript function */
 154         public JS.CompiledFunction getCurrentCompiledFunction() { return currentCompiledFunction; }
 155
 156
 157         // Statics ///////////////////////////////////////////////////////////////////////
 158
 159         private static Hashtable javaThreadToJSThread = new Hashtable();
 160
 161         /** returns the JS thread for a given Java thread, creating one if necessary */
 162         public static JS.Thread fromJavaThread(java.lang.Thread t) {
 163             JS.Thread ret = (JS.Thread)javaThreadToJSThread.get(t);
 164             if (ret == null) {
 165                 ret = new JS.Thread();
 166                 ret.bindToCurrentJavaThread();
 167             }
 168             return ret;
 169         }
 170
 171     }
 172 }
 173
 174
 175
 176