propose-patch
[org.ibex.core.git] / src / org / xwt / js / ByteCodes.java
index 8e79a9a..7ba54b4 100644 (file)
@@ -1,18 +1,16 @@
-// Copyright 2003 Adam Megacz, see the COPYING file for licensing [GPL]
+// Copyright 2004 Adam Megacz, see the COPYING file for licensing [GPL]
 package org.xwt.js;
 
 /**
  *  Constants for the various JavaScript ByteCode operations.
  *
- *  Each instruction is an opcode and an optional literal literal; the
- *  arithmetic Tokens are also valid.  They are: BITOR, BITXOR, BITAND,
- *  ADD, INC, DEC, SUB, MUL, DIV, MOD, LSH, RSH, URSH, LT, LE, GT, GE,
- *  EQ, NE
+ *  Each instruction is an opcode and an optional literal literal;
+ *  some Tokens are also valid; see Tokens.java
  */
 interface ByteCodes {
 
     /** push the literal onto the stack */
-    public static final byte LITERAL = -2;       
+    public static final byte LITERAL = -2;
 
     /** push a new array onto the stack with length equal to the literal */
     public static final byte ARRAY = -3;         
@@ -23,53 +21,74 @@ interface ByteCodes {
     /** create a new instance; literal is a reference to the corresponding ForthBlock */
     public static final byte NEWFUNCTION = -5;      
 
-    /** pop a string off the stack and declare it in the current scope */
+    /** if given a non-null argument declare its argument in the current scope and push
+        it to the stack, else, declares the element on the top of the stack and leaves it
+        there */
     public static final byte DECLARE = -6;       
 
     /** push a reference to the current scope onto the stack */
     public static final byte TOPSCOPE = -7;
 
-    /** pop two elements off the stack; push stack[-1].get(stack[top]) */
+    /** if given a null literal pop two elements off the stack; push stack[-1].get(stack[top])
+        else pop one element off the stack, push stack[top].get(literal) */
     public static final byte GET = -8;           
 
     /** push stack[-1].get(stack[top]) */
-    public static final byte GET_PRESERVE = -80; 
+    public static final byte GET_PRESERVE = -9; 
 
     /** pop two elements off the stack; stack[-2].put(stack[-1], stack[top]); push stack[top] */
-    public static final byte PUT = -9;           
+    public static final byte PUT = -10;           
 
     /** literal is a relative address; pop stacktop and jump if the value is true */
-    public static final byte JT = -13;           
+    public static final byte JT = -11;           
 
     /** literal is a relative address; pop stacktop and jump if the value is false */
-    public static final byte JF = -21;           
+    public static final byte JF = -12;           
 
     /** literal is a relative address; jump to it */
-    public static final byte JMP = -22;          
+    public static final byte JMP = -13;          
 
     /** discard the top stack element */
     static public final byte POP = -14;          
 
-    /** pop two elements; call stack[-1](stack[top]) where stacktop is a JS.Array */
+    /** pop element; call stack[top](stack[-n], stack[-n+1]...) where n is the number of args to the function */
     public static final byte CALL = -15;         
 
-    /** pop an element; push a JS.Array containing the keys of the popped element */
-    public static final byte PUSHKEYS = -19;     
+    /** pop an element; push a JS.JSArray containing the keys of the popped element */
+    public static final byte PUSHKEYS = -16;     
 
-    /** swap the top two elements on the stack */
-    public static final byte SWAP = -23;         
+    /** push the top element down so that (arg) elements are on top of it; all other elements retain ordering */
+    public static final byte SWAP = -17;         
 
-    /** execute the ForthBlock pointed to by the literal in a fresh scope with parentScope==THIS */
-    public static final byte SCOPE = -30;        
+    /** execute the bytecode block pointed to by the literal in a fresh scope with parentScope==THIS */
+    public static final byte NEWSCOPE = -18;        
+
+    /** execute the bytecode block pointed to by the literal in a fresh scope with parentScope==THIS */
+    public static final byte OLDSCOPE = -19;
 
     /** push a copy of the top stack element */
-    public static final byte DUP = -50;          
+    public static final byte DUP = -20;          
 
-    /** declare a label */
-    public static final byte LABEL = -60;        
+    /** a NOP; confers a label upon the following instruction */
+    public static final byte LABEL = -21;          
 
     /** execute the ForthBlock pointed to by the literal until BREAK encountered; push TRUE onto the stack for the first iteration
      *  and FALSE for all subsequent iterations */
-    public static final byte LOOP = -40;         
-
+    public static final byte LOOP = -22;        
+     
+    /** similar effect a a GET followed by a CALL */
+    public static final byte CALLMETHOD = -23;
+
+    /** finish a finally block and carry out whatever instruction initiated the finally block */
+    public static final byte FINALLY_DONE = -24;
+    
+    /** finish a finally block and carry out whatever instruction initiated the finally block */
+    public static final byte MAKE_GRAMMAR = -25;
+    
+    public static final String[] bytecodeToString = new String[] {
+        "", "", "LITERAL", "ARRAY", "OBJECT", "NEWFUNCTION", "DECLARE", "TOPSCOPE",
+        "GET", "GET_PRESERVE", "PUT", "JT", "JF", "JMP", "POP", "CALL", "PUSHKEYS",
+        "SWAP", "NEWSCOPE", "OLDSCOPE", "DUP", "LABEL", "LOOP", "CALLMETHOD",
+        "FINALLY_DONE", "MAKE_GRAMMAR"
+    };
 }