Move WebCoreScriptDebugger up to WebKit
[WebKit-https.git] / WebKit / mac / WebView / WebCoreScriptDebugger.h
1 /*
2  * Copyright (C) 2005 Apple Computer, Inc.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer. 
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution. 
13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission. 
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 // FIXME: This file and the classes in it should have the prefix "Web" instead
30 // of "WebCore". The best way to fix this is to merge WebCoreScriptCallFrame
31 // with WebScriptCallFrame and WebCoreScriptDebugger with WebScriptDebugger.
32
33 @class WebScriptObject;         // from JavaScriptCore
34 @class WebCoreScriptCallFrame;  // below
35
36 #ifdef __cplusplus
37 class WebCoreScriptDebuggerImp;
38 namespace KJS { class ExecState; }
39 using KJS::ExecState;
40 #else
41 @class WebCoreScriptDebuggerImp;
42 @class ExecState;
43 #endif
44
45
46
47 // "WebScriptDebugger" protocol - must be implemented by a delegate
48
49 @protocol WebScriptDebugger
50
51 - (WebScriptObject *)globalObject;                          // return the WebView's windowScriptObject
52 - (id)newWrapperForFrame:(WebCoreScriptCallFrame *)frame;   // return a (retained) stack-frame object
53
54 // debugger callbacks
55 - (void)parsedSource:(NSString *)source fromURL:(NSURL *)url sourceId:(int)sid startLine:(int)startLine errorLine:(int)errorLine errorMessage:(NSString *)errorMessage;
56 - (void)enteredFrame:(WebCoreScriptCallFrame *)frame sourceId:(int)sid line:(int)lineno;
57 - (void)hitStatement:(WebCoreScriptCallFrame *)frame sourceId:(int)sid line:(int)lineno;
58 - (void)leavingFrame:(WebCoreScriptCallFrame *)frame sourceId:(int)sid line:(int)lineno;
59 - (void)exceptionRaised:(WebCoreScriptCallFrame *)frame sourceId:(int)sid line:(int)lineno;
60
61 @end
62
63
64
65 @interface WebCoreScriptDebugger : NSObject
66 {
67 @private
68     id<WebScriptDebugger>     _delegate;      // interface to WebKit (not retained)
69     WebScriptObject          *_globalObj;     // the global object's proxy (not retained)
70     WebCoreScriptCallFrame   *_current;       // top of stack
71     WebCoreScriptDebuggerImp *_debugger;      // [KJS::Debugger]
72 }
73
74 - (WebCoreScriptDebugger *)initWithDelegate:(id<WebScriptDebugger>)delegate;
75 - (id<WebScriptDebugger>)delegate;
76
77 @end
78
79
80
81 @interface WebCoreScriptCallFrame : NSObject
82 {
83 @private
84     id                        _wrapper;       // WebKit's version of this object
85     WebScriptObject          *_globalObj;     // the global object's proxy (not retained)
86     WebCoreScriptCallFrame   *_caller;        // previous stack frame
87     ExecState                *_state;         // [KJS::ExecState]
88 }
89
90 - (id)wrapper;
91 - (WebCoreScriptCallFrame *)caller;
92
93 - (NSArray *)scopeChain;
94 - (NSString *)functionName;
95 - (id)exception;
96 - (id)evaluateWebScript:(NSString *)script;
97
98 @end