src/org/mozilla/javascript/debug/DebuggableScript.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 import org.mozilla.javascript.*;\r
  41 \r
  42 import java.util.Enumeration;\r
  43 \r
  44 /**\r
  45  * This interface exposes debugging information from executable \r
  46  * code (either functions or top-level scripts).\r
  47  */\r
  48 public interface DebuggableScript {\r
  49   \r
  50     /**\r
  51      * Returns true if this is a function, false if it is a script.\r
  52      */\r
  53     public boolean isFunction();\r
  54     \r
  55     /**\r
  56      * Get the Scriptable object (Function or Script) that is \r
  57      * described by this DebuggableScript object.\r
  58      */\r
  59     public Scriptable getScriptable();\r
  60 \r
  61     /**\r
  62      * Get the name of the source (usually filename or URL)\r
  63      * of the script.\r
  64      */\r
  65     public String getSourceName();\r
  66     \r
  67     /**\r
  68      * Get array containing the line numbers that \r
  69      * can have breakpoints placed on them.\r
  70      */\r
  71     public int[] getLineNumbers();\r
  72     \r
  73     /**\r
  74      * Place a breakpoint at the given line.\r
  75      * @return true if the breakpoint was successfully set.\r
  76      */\r
  77     public boolean placeBreakpoint(int line);\r
  78     \r
  79     /**\r
  80      * Remove a breakpoint from the given line.\r
  81      * @return true if there was a breakpoint at the given line.\r
  82      */\r
  83     public boolean removeBreakpoint(int line);\r
  84 }\r