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

   1 /* -*- Mode: java; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*-\r
   2  *\r
   3  * The contents of this file are subject to the Netscape Public\r
   4  * License Version 1.1 (the "License"); you may not use this file\r
   5  * except in compliance with the License. You may obtain a copy of\r
   6  * the License at http://www.mozilla.org/NPL/\r
   7  *\r
   8  * Software distributed under the License is distributed on an "AS\r
   9  * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express oqr\r
  10  * implied. See the License for the specific language governing\r
  11  * rights and limitations under the License.\r
  12  *\r
  13  * The Original Code is Rhino code, released\r
  14  * May 6, 1999.\r
  15  *\r
  16  * The Initial Developer of the Original Code is Netscape\r
  17  * Communications Corporation.  Portions created by Netscape are\r
  18  * Copyright (C) 1997-2000 Netscape Communications Corporation. All\r
  19  * Rights Reserved.\r
  20  *\r
  21  * Contributor(s): \r
  22  * Norris Boyd\r
  23  *\r
  24  * Alternatively, the contents of this file may be used under the\r
  25  * terms of the GNU Public License (the "GPL"), in which case the\r
  26  * provisions of the GPL are applicable instead of those above.\r
  27  * If you wish to allow use of your version of this file only\r
  28  * under the terms of the GPL and not to allow others to use your\r
  29  * version of this file under the NPL, indicate your decision by\r
  30  * deleting the provisions above and replace them with the notice\r
  31  * and other provisions required by the GPL.  If you do not delete\r
  32  * the provisions above, a recipient may use your version of this\r
  33  * file under either the NPL or the GPL.\r
  34  */\r
  35 \r
  36 // API class\r
  37 \r
  38 package org.mozilla.javascript.debug;\r
  39 \r
  40 \r
  41 public interface DebuggableEngine {\r
  42 \r
  43     /**\r
  44      * Set whether the engine should break when it encounters\r
  45      * the next line.\r
  46      * <p>\r
  47      * The engine will call the attached debugger's handleBreakpointHit\r
  48      * method on the next line it executes if isLineStep is true.\r
  49      * May be used from another thread to interrupt execution.\r
  50      * \r
  51      * @param isLineStep if true, break next line\r
  52      */\r
  53     public void setBreakNextLine(boolean isLineStep);\r
  54     \r
  55     /**\r
  56      * Return the value of the breakNextLine flag.\r
  57      * @return true if the engine will break on execution of the \r
  58      * next line.\r
  59      */\r
  60     public boolean getBreakNextLine();\r
  61     \r
  62     /**\r
  63      * Set the associated debugger.\r
  64      * @param debugger the debugger to be used on callbacks from\r
  65      * the engine.\r
  66      */\r
  67     public void setDebugger(Debugger debugger);\r
  68     \r
  69     /**\r
  70      * Return the current debugger.\r
  71      * @return the debugger, or null if none is attached.\r
  72      */\r
  73     public Debugger getDebugger();\r
  74     \r
  75     /**\r
  76      * Return the number of frames in current execution.\r
  77      * @return the count of current frames\r
  78      */\r
  79     public int getFrameCount();\r
  80     \r
  81     /**\r
  82      * Return a frame from the current execution.\r
  83      * Frames are numbered starting from 0 for the innermost\r
  84      * frame.\r
  85      * @param frameNumber the number of the frame in the range\r
  86      *        [0,frameCount-1]\r
  87      * @return the relevant Frame, or null if frameNumber is out\r
  88      *         of range or the engine isn't currently saving \r
  89      *         frames\r
  90      */\r
  91     public DebugFrame getFrame(int frameNumber);\r
  92 }\r