01: /* -*- Mode: java; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*-
02: *
03: * ***** BEGIN LICENSE BLOCK *****
04: * Version: MPL 1.1/GPL 2.0
05: *
06: * The contents of this file are subject to the Mozilla Public License Version
07: * 1.1 (the "License"); you may not use this file except in compliance with
08: * the License. You may obtain a copy of the License at
09: * http://www.mozilla.org/MPL/
10: *
11: * Software distributed under the License is distributed on an "AS IS" basis,
12: * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
13: * for the specific language governing rights and limitations under the
14: * License.
15: *
16: * The Original Code is Rhino code, released
17: * May 6, 1999.
18: *
19: * The Initial Developer of the Original Code is
20: * Netscape Communications Corporation.
21: * Portions created by the Initial Developer are Copyright (C) 1997-2000
22: * the Initial Developer. All Rights Reserved.
23: *
24: * Contributor(s):
25: * Norris Boyd
26: *
27: * Alternatively, the contents of this file may be used under the terms of
28: * the GNU General Public License Version 2 or later (the "GPL"), in which
29: * case the provisions of the GPL are applicable instead of those above. If
30: * you wish to allow use of your version of this file only under the terms of
31: * the GPL and not to allow others to use your version of this file under the
32: * MPL, indicate your decision by deleting the provisions above and replacing
33: * them with the notice and other provisions required by the GPL. If you do
34: * not delete the provisions above, a recipient may use your version of this
35: * file under either the MPL or the GPL.
36: *
37: * ***** END LICENSE BLOCK ***** */
38:
39: // API class
40: package org.mozilla.javascript.debug;
41:
42: import org.mozilla.javascript.Context;
43: import org.mozilla.javascript.Scriptable;
44:
45: /**
46: Interface to implement if the application is interested in receiving debug
47: information during execution of a particular script or function.
48: */
49: public interface DebugFrame {
50:
51: /**
52: Called when execution is ready to start bytecode interpretation for entered a particular function or script.
53:
54: @param cx current Context for this thread
55: @param activation the activation scope for the function or script.
56: @param thisObj value of the JavaScript <code>this</code> object
57: @param args the array of arguments
58: */
59: public void onEnter(Context cx, Scriptable activation,
60: Scriptable this Obj, Object[] args);
61:
62: /**
63: Called when executed code reaches new line in the source.
64: @param cx current Context for this thread
65: @param lineNumber current line number in the script source
66: */
67: public void onLineChange(Context cx, int lineNumber);
68:
69: /**
70: Called when thrown exception is handled by the function or script.
71: @param cx current Context for this thread
72: @param ex exception object
73: */
74: public void onExceptionThrown(Context cx, Throwable ex);
75:
76: /**
77: Called when the function or script for this frame is about to return.
78: @param cx current Context for this thread
79: @param byThrow if true function will leave by throwing exception, otherwise it
80: will execute normal return
81: @param resultOrException function result in case of normal return or
82: exception object if about to throw exception
83: */
84: public void onExit(Context cx, boolean byThrow,
85: Object resultOrException);
86:
87: /**
88: Called when the function or script executes a 'debugger' statement.
89: @param cx current Context for this thread
90: */
91: public void onDebuggerStatement(Context cx);
92: }
|