Clean up debug APIs

js/rhino/org/mozilla/javascript/InterpretedFunction.java

@@ -1,109 +0,0 @@
-/* -*- Mode: java; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*-
- *
- * The contents of this file are subject to the Netscape Public
- * License Version 1.1 (the "License"); you may not use this file
- * except in compliance with the License. You may obtain a copy of
- * the License at http://www.mozilla.org/NPL/
- *
- * Software distributed under the License is distributed on an "AS
- * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express oqr
- * implied. See the License for the specific language governing
- * rights and limitations under the License.
- *
- * The Original Code is Rhino code, released
- * May 6, 1999.
- *
- * The Initial Developer of the Original Code is Netscape
- * Communications Corporation.  Portions created by Netscape are
- * Copyright (C) 1997-2000 Netscape Communications Corporation. All
- * Rights Reserved.
- *
- * Contributor(s): 
- * Roger Lawrence
- *
- * Alternatively, the contents of this file may be used under the
- * terms of the GNU Public License (the "GPL"), in which case the
- * provisions of the GPL are applicable instead of those above.
- * If you wish to allow use of your version of this file only
- * under the terms of the GPL and not to allow others to use your
- * version of this file under the NPL, indicate your decision by
- * deleting the provisions above and replace them with the notice
- * and other provisions required by the GPL.  If you do not delete
- * the provisions above, a recipient may use your version of this
- * file under either the NPL or the GPL.
- */
-
-package org.mozilla.javascript;
-
-import java.util.*;
-import org.mozilla.javascript.debug.DebuggableScript;
-
-class InterpretedFunction extends NativeFunction implements DebuggableScript {
-    
-    InterpretedFunction(InterpreterData theData, Context cx)
-    {
-        itsData = theData;
-        init(cx);
-    }
-    
-    void init(Context cx)
-    {
-// probably too much copying going on from theData to the InterpretedFunction object
-// should pass them as parameters - unless we need them in the data block anyway?
-
-        names = new String[itsData.itsVariableTable.size() + 1];
-        names[0] = itsData.itsName;
-        for (int i = 0; i < itsData.itsVariableTable.size(); i++)
-            names[i + 1] = itsData.itsVariableTable.getName(i);
-        argCount = (short)itsData.itsVariableTable.getParameterCount();
-        source = itsData.itsSource;
-        nestedFunctions = itsData.itsNestedFunctions;
-        if (cx != null)
-            version = (short)cx.getLanguageVersion();
-    }
-    
-    InterpretedFunction(InterpretedFunction theOther,
-                        Scriptable theScope, Context cx)
-    {
-        itsData = theOther.itsData;
-        itsClosure = theScope;
-        init(cx);
-    }
-    
-    public Object call(Context cx, Scriptable scope, Scriptable thisObj,
-                       Object[] args)
-        throws JavaScriptException
-    {            
-        if (itsClosure != null)
-            scope = itsClosure;
-        else if (!itsData.itsUseDynamicScope)
-            scope = getParentScope();
-        if (itsData.itsNeedsActivation)
-            scope = ScriptRuntime.initVarObj(cx, scope, this, thisObj, args);
-        return Interpreter.interpret(cx, scope, thisObj, args, this, itsData);
-    }
-    
-    public Scriptable getScriptable() {
-        return this;
-    }
-    
-    public String getSourceName() {
-        return itsData.itsSourceFile;
-    }
-    
-    public Enumeration getLineNumbers() { 
-        return itsData.itsLineNumberTable.keys();
-    }
-    
-    public boolean placeBreakpoint(int line) { // XXX throw exn?
-        return itsData.placeBreakpoint(line);
-    }
-    
-    public boolean removeBreakpoint(int line) {
-        return itsData.removeBreakpoint(line);
-    }
-    
-    InterpreterData itsData;
-    Scriptable itsClosure;
-}
-    

js/rhino/org/mozilla/javascript/InterpretedScript.java

@@ -1,92 +0,0 @@
-/* -*- Mode: java; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*-
- *
- * The contents of this file are subject to the Netscape Public
- * License Version 1.1 (the "License"); you may not use this file
- * except in compliance with the License. You may obtain a copy of
- * the License at http://www.mozilla.org/NPL/
- *
- * Software distributed under the License is distributed on an "AS
- * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express oqr
- * implied. See the License for the specific language governing
- * rights and limitations under the License.
- *
- * The Original Code is Rhino code, released
- * May 6, 1999.
- *
- * The Initial Developer of the Original Code is Netscape
- * Communications Corporation.  Portions created by Netscape are
- * Copyright (C) 1997-1999 Netscape Communications Corporation. All
- * Rights Reserved.
- *
- * Contributor(s): 
- * Roger Lawrence
- *
- * Alternatively, the contents of this file may be used under the
- * terms of the GNU Public License (the "GPL"), in which case the
- * provisions of the GPL are applicable instead of those above.
- * If you wish to allow use of your version of this file only
- * under the terms of the GPL and not to allow others to use your
- * version of this file under the NPL, indicate your decision by
- * deleting the provisions above and replace them with the notice
- * and other provisions required by the GPL.  If you do not delete
- * the provisions above, a recipient may use your version of this
- * file under either the NPL or the GPL.
- */
-
-package org.mozilla.javascript;
-
-import org.mozilla.javascript.debug.*;
-
-import java.util.*;
-
-public class InterpretedScript extends NativeScript implements DebuggableScript {
-
-    InterpretedScript(InterpreterData theData, Context cx)
-    {
-        itsData = theData;
-        names = new String[itsData.itsVariableTable.size() + 1];
-        names[0] = "";
-        for (int i = 0; i < itsData.itsVariableTable.size(); i++)
-            names[i + 1] = itsData.itsVariableTable.getName(i);
-        nestedFunctions = itsData.itsNestedFunctions;
-        version = (short)cx.getLanguageVersion();   
-    }
-    
-    public Object exec(Context cx, Scriptable scope)
-        throws JavaScriptException
-    {
-        return call(cx, scope, scope, null);    
-    }
-
-    public Object call(Context cx, Scriptable scope, 
-                       Scriptable thisObj, Object[] args)
-        throws JavaScriptException
-    {
-        scope = ScriptRuntime.initScript(cx, scope, this, thisObj, 
-                                         itsData.itsFromEvalCode);
-        return Interpreter.interpret(cx, scope, thisObj, args, this, itsData);    
-    }
-    
-    public Scriptable getScriptable() {
-        return this;
-    }
-    
-    public String getSourceName() {
-        return itsData.itsSourceFile;
-    }
-    
-    public Enumeration getLineNumbers() {
-        return itsData.itsLineNumberTable.keys();
-    }
-    
-    public boolean placeBreakpoint(int line) { // XXX throw exn?
-        return itsData.placeBreakpoint(line);
-    }
-    
-    public boolean removeBreakpoint(int line) {
-        return itsData.removeBreakpoint(line);
-    }
-    
-    InterpreterData itsData;
-}
-

js/rhino/org/mozilla/javascript/debug/DebuggableEngine.java

@@ -40,15 +40,53 @@ package org.mozilla.javascript.debug;
 
 public interface DebuggableEngine {
 
-    public void setLineStep(boolean isLineStep);
+    /**
+     * Set whether the engine should break when it encounters
+     * the next line.
+     * <p>
+     * The engine will call the attached debugger's handleBreakpointHit
+     * method on the next line it executes if isLineStep is true.
+     * May be used from another thread to interrupt execution.
+     * 
+     * @param isLineStep if true, break next line
+     */
+    public void setBreakNextLine(boolean isLineStep);
     
-    public boolean getLineStep();
+    /**
+     * Return the value of the breakNextLine flag.
+     * @return true if the engine will break on execution of the 
+     * next line.
+     */
+    public boolean getBreakNextLine();
     
+    /**
+     * Set the associated debugger.
+     * @param debugger the debugger to be used on callbacks from
+     * the engine.
+     */
     public void setDebugger(Debugger debugger);
     
+    /**
+     * Return the current debugger.
+     * @return the debugger, or null if none is attached.
+     */
     public Debugger getDebugger();
     
-    public Frame getFrame(int frameNumber);
+    /**
+     * Return the number of frames in current execution.
+     * @return the count of current frames
+     */
+    public int getFrameCount();
     
-    //public void haltExecution();
+    /**
+     * Return a frame from the current execution.
+     * Frames are numbered starting from 0 for the innermost
+     * frame.
+     * @param frameNumber the number of the frame in the range
+     *        [0,frameCount-1]
+     * @return the relevant Frame, or null if frameNumber is out
+     *         of range or the engine isn't currently saving 
+     *         frames
+     */
+    public Frame getFrame(int frameNumber);
 }

js/rhino/org/mozilla/javascript/debug/DebuggableScript.java

@@ -1,82 +0,0 @@
-/* -*- Mode: java; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*-
- *
- * The contents of this file are subject to the Netscape Public
- * License Version 1.1 (the "License"); you may not use this file
- * except in compliance with the License. You may obtain a copy of
- * the License at http://www.mozilla.org/NPL/
- *
- * Software distributed under the License is distributed on an "AS
- * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express oqr
- * implied. See the License for the specific language governing
- * rights and limitations under the License.
- *
- * The Original Code is Rhino code, released
- * May 6, 1999.
- *
- * The Initial Developer of the Original Code is Netscape
- * Communications Corporation.  Portions created by Netscape are
- * Copyright (C) 1997-2000 Netscape Communications Corporation. All
- * Rights Reserved.
- *
- * Contributor(s): 
- * Norris Boyd
- *
- * Alternatively, the contents of this file may be used under the
- * terms of the GNU Public License (the "GPL"), in which case the
- * provisions of the GPL are applicable instead of those above.
- * If you wish to allow use of your version of this file only
- * under the terms of the GPL and not to allow others to use your
- * version of this file under the NPL, indicate your decision by
- * deleting the provisions above and replace them with the notice
- * and other provisions required by the GPL.  If you do not delete
- * the provisions above, a recipient may use your version of this
- * file under either the NPL or the GPL.
- */
-
-// API class
-
-package org.mozilla.javascript.debug;
-
-import org.mozilla.javascript.*;
-
-import java.util.Enumeration;
-
-/**
- * This interface exposes debugging information from executable 
- * code (either functions or top-level scripts).
- */
-public interface DebuggableScript {
-  
-    //public boolean isFunction();  // XXX
-    
-    /**
-     * Get the Scriptable object (Function or Script) that is 
-     * described by this DebuggableScript object.
-     */
-    public Scriptable getScriptable();
-
-    /**
-     * Get the name of the source (usually filename or URL)
-     * of the script.
-     */
-    public String getSourceName();
-    
-    /**
-     * Get an enumeration containing the line numbers that 
-     * can have breakpoints placed on them.
-     * XXX - array?
-     */
-    public Enumeration getLineNumbers();
-    
-    /**
-     * Place a breakpoint at the given line.
-     * @return true if the breakpoint was successfully set.
-     */
-    public boolean placeBreakpoint(int line);
-    
-    /**
-     * Remove a breakpoint from the given line.
-     * @return true if there was a breakpoint at the given line.
-     */
-    public boolean removeBreakpoint(int line);
-}

js/rhino/src/org/mozilla/javascript/InterpretedFunction.java

@@ -40,8 +40,7 @@ import org.mozilla.javascript.debug.DebuggableScript;
 
 class InterpretedFunction extends NativeFunction implements DebuggableScript {
     
-    InterpretedFunction(InterpreterData theData, Context cx)
-    {
+    InterpretedFunction(InterpreterData theData, Context cx) {
         itsData = theData;
         init(cx);
     }
@@ -83,6 +82,10 @@ class InterpretedFunction extends NativeFunction implements DebuggableScript {
         return Interpreter.interpret(cx, scope, thisObj, args, this, itsData);
     }
     
+    public boolean isFunction() {
+        return true;
+    }
+    
     public Scriptable getScriptable() {
         return this;
     }

js/rhino/src/org/mozilla/javascript/InterpretedScript.java

@@ -67,6 +67,10 @@ public class InterpretedScript extends NativeScript implements DebuggableScript
         return Interpreter.interpret(cx, scope, thisObj, args, this, itsData);    
     }
     
+    public boolean isFunction() {
+        return false;
+    }
+    
     public Scriptable getScriptable() {
         return this;
     }

js/rhino/src/org/mozilla/javascript/debug/DebuggableEngine.java

@@ -40,15 +40,53 @@ package org.mozilla.javascript.debug;
 
 public interface DebuggableEngine {
 
-    public void setLineStep(boolean isLineStep);
+    /**
+     * Set whether the engine should break when it encounters
+     * the next line.
+     * <p>
+     * The engine will call the attached debugger's handleBreakpointHit
+     * method on the next line it executes if isLineStep is true.
+     * May be used from another thread to interrupt execution.
+     * 
+     * @param isLineStep if true, break next line
+     */
+    public void setBreakNextLine(boolean isLineStep);
     
-    public boolean getLineStep();
+    /**
+     * Return the value of the breakNextLine flag.
+     * @return true if the engine will break on execution of the 
+     * next line.
+     */
+    public boolean getBreakNextLine();
     
+    /**
+     * Set the associated debugger.
+     * @param debugger the debugger to be used on callbacks from
+     * the engine.
+     */
     public void setDebugger(Debugger debugger);
     
+    /**
+     * Return the current debugger.
+     * @return the debugger, or null if none is attached.
+     */
     public Debugger getDebugger();
     
-    public Frame getFrame(int frameNumber);
+    /**
+     * Return the number of frames in current execution.
+     * @return the count of current frames
+     */
+    public int getFrameCount();
     
-    //public void haltExecution();
+    /**
+     * Return a frame from the current execution.
+     * Frames are numbered starting from 0 for the innermost
+     * frame.
+     * @param frameNumber the number of the frame in the range
+     *        [0,frameCount-1]
+     * @return the relevant Frame, or null if frameNumber is out
+     *         of range or the engine isn't currently saving 
+     *         frames
+     */
+    public Frame getFrame(int frameNumber);
 }

js/rhino/src/org/mozilla/javascript/debug/DebuggableScript.java

@@ -47,7 +47,10 @@ import java.util.Enumeration;
  */
 public interface DebuggableScript {
   
-    //public boolean isFunction();  // XXX
+    /**
+     * Returns true if this is a function, false if it is a script.
+     */
+    public boolean isFunction();
     
     /**
      * Get the Scriptable object (Function or Script) that is