Name the WebKit build phase script that generates WebKit.LP64.exp.
[WebKit-https.git] / WebKit / mac / WebView / WebScriptDebugDelegate.mm
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 #import "WebScriptDebugDelegatePrivate.h"
30
31 #import "WebCoreScriptDebugger.h"
32 #import "WebDataSource.h"
33 #import "WebDataSourceInternal.h"
34 #import "WebFrameBridge.h"
35 #import "WebFrameInternal.h"
36 #import "WebScriptDebugServerPrivate.h"
37 #import "WebViewInternal.h"
38 #import <JavaScriptCore/ExecState.h>
39 #import <JavaScriptCore/JSGlobalObject.h>
40 #import <JavaScriptCore/function.h>
41 #import <JavaScriptCore/interpreter.h>
42 #import <WebCore/Frame.h>
43 #import <WebCore/WebScriptObjectPrivate.h>
44
45 using namespace KJS;
46 using namespace WebCore;
47
48 // FIXME: these error strings should be public for future use by WebScriptObject and in WebScriptObject.h
49 NSString * const WebScriptErrorDomain = @"WebScriptErrorDomain";
50 NSString * const WebScriptErrorDescriptionKey = @"WebScriptErrorDescription";
51 NSString * const WebScriptErrorLineNumberKey = @"WebScriptErrorLineNumber";
52
53 @interface WebScriptCallFrame (WebScriptDebugDelegateInternal)
54
55 - (WebScriptCallFrame *)_initWithGlobalObject:(WebScriptObject *)globalObj caller:(WebScriptCallFrame *)caller state:(ExecState *)state;
56 - (id)_convertValueToObjcValue:(JSValue *)value;
57
58 @end
59
60 @implementation WebScriptDebugger
61
62 - (WebScriptDebugger *)initWithWebFrame:(WebFrame *)webFrame
63 {
64     if ((self = [super init])) {
65         _webFrame = webFrame;
66         _debugger = [[WebCoreScriptDebugger alloc] initWithDelegate:self];
67     }
68     return self;
69 }
70
71 - (void)dealloc
72 {
73     [_debugger release];
74     [super dealloc];
75 }
76
77 - (WebScriptObject *)globalObject
78 {
79     return core(_webFrame)->windowScriptObject();
80 }
81
82 - (WebScriptCallFrame *)newFrameWithGlobalObject:(WebScriptObject *)globalObj caller:(WebScriptCallFrame *)caller state:(ExecState*)state
83 {
84     return [[WebScriptCallFrame alloc] _initWithGlobalObject:globalObj caller:caller state:state];
85 }
86
87 - (void)parsedSource:(NSString *)source fromURL:(NSURL *)url sourceId:(int)sid startLine:(int)startLine errorLine:(int)errorLine errorMessage:(NSString *)errorMessage
88 {
89     WebView *webView = [_webFrame webView];
90     if (errorLine == -1) {
91         [[webView _scriptDebugDelegateForwarder] webView:webView didParseSource:source baseLineNumber:startLine fromURL:url sourceId:sid forWebFrame:_webFrame];
92         [[webView _scriptDebugDelegateForwarder] webView:webView didParseSource:source fromURL:[url absoluteString] sourceId:sid forWebFrame:_webFrame]; // deprecated delegate method
93         if ([WebScriptDebugServer listenerCount])
94             [[WebScriptDebugServer sharedScriptDebugServer] webView:webView didParseSource:source baseLineNumber:startLine fromURL:url sourceId:sid forWebFrame:_webFrame];
95     } else {
96         NSDictionary *info = [[NSDictionary alloc] initWithObjectsAndKeys:errorMessage, WebScriptErrorDescriptionKey, [NSNumber numberWithUnsignedInt:errorLine], WebScriptErrorLineNumberKey, nil];
97         NSError *error = [[NSError alloc] initWithDomain:WebScriptErrorDomain code:WebScriptGeneralErrorCode userInfo:info];
98         [[webView _scriptDebugDelegateForwarder] webView:webView failedToParseSource:source baseLineNumber:startLine fromURL:url withError:error forWebFrame:_webFrame];
99         if ([WebScriptDebugServer listenerCount])
100             [[WebScriptDebugServer sharedScriptDebugServer] webView:webView failedToParseSource:source baseLineNumber:startLine fromURL:url withError:error forWebFrame:_webFrame];
101         [error release];
102         [info release];
103     }
104 }
105
106 - (void)enteredFrame:(WebScriptCallFrame *)frame sourceId:(int)sid line:(int)lineno
107 {
108     WebView *webView = [_webFrame webView];
109     [[webView _scriptDebugDelegateForwarder] webView:webView didEnterCallFrame:frame sourceId:sid line:lineno forWebFrame:_webFrame];
110     if ([WebScriptDebugServer listenerCount])
111         [[WebScriptDebugServer sharedScriptDebugServer] webView:webView didEnterCallFrame:frame sourceId:sid line:lineno forWebFrame:_webFrame];
112 }
113
114 - (void)hitStatement:(WebScriptCallFrame *)frame sourceId:(int)sid line:(int)lineno
115 {
116     WebView *webView = [_webFrame webView];
117     [[webView _scriptDebugDelegateForwarder] webView:webView willExecuteStatement:frame sourceId:sid line:lineno forWebFrame:_webFrame];
118     if ([WebScriptDebugServer listenerCount])
119         [[WebScriptDebugServer sharedScriptDebugServer] webView:webView willExecuteStatement:frame sourceId:sid line:lineno forWebFrame:_webFrame];
120 }
121
122 - (void)leavingFrame:(WebScriptCallFrame *)frame sourceId:(int)sid line:(int)lineno
123 {
124     WebView *webView = [_webFrame webView];
125     [[webView _scriptDebugDelegateForwarder] webView:webView willLeaveCallFrame:frame sourceId:sid line:lineno forWebFrame:_webFrame];
126     if ([WebScriptDebugServer listenerCount])
127         [[WebScriptDebugServer sharedScriptDebugServer] webView:webView willLeaveCallFrame:frame sourceId:sid line:lineno forWebFrame:_webFrame];
128 }
129
130 - (void)exceptionRaised:(WebScriptCallFrame *)frame sourceId:(int)sid line:(int)lineno
131 {
132     WebView *webView = [_webFrame webView];
133     [[webView _scriptDebugDelegateForwarder] webView:webView exceptionWasRaised:frame sourceId:sid line:lineno forWebFrame:_webFrame];
134     if ([WebScriptDebugServer listenerCount])
135         [[WebScriptDebugServer sharedScriptDebugServer] webView:webView exceptionWasRaised:frame sourceId:sid line:lineno forWebFrame:_webFrame];
136 }
137
138 @end
139
140 @interface WebScriptCallFramePrivate : NSObject {
141 @public
142     WebScriptObject        *globalObject;   // the global object's proxy (not retained)
143     WebScriptCallFrame     *caller;         // previous stack frame
144     KJS::ExecState         *state;
145 }
146 @end
147
148 @implementation WebScriptCallFramePrivate
149 - (void)dealloc
150 {
151     [caller release];
152     [super dealloc];
153 }
154 @end
155
156 // WebScriptCallFrame
157 //
158 // One of these is created to represent each stack frame.  Additionally, there is a "global"
159 // frame to represent the outermost scope.  This global frame is always the last frame in
160 // the chain of callers.
161 //
162 // The delegate can assign a "wrapper" to each frame object so it can relay calls through its
163 // own exported interface.  This class is private to WebCore (and the delegate).
164
165 @implementation WebScriptCallFrame (WebScriptDebugDelegateInternal)
166
167 - (WebScriptCallFrame *)_initWithGlobalObject:(WebScriptObject *)globalObj caller:(WebScriptCallFrame *)caller state:(ExecState *)state
168 {
169     if ((self = [super init])) {
170         _private = [[WebScriptCallFramePrivate alloc] init];
171         _private->globalObject = globalObj;
172         _private->caller = caller; // (already retained)
173         _private->state = state;
174     }
175     return self;
176 }
177
178 - (id)_convertValueToObjcValue:(JSValue *)value
179 {
180     if (!value)
181         return nil;
182
183     WebScriptObject *globalObject = _private->globalObject;
184     if (value == [globalObject _imp])
185         return globalObject;
186
187     Bindings::RootObject* root1 = [globalObject _originRootObject];
188     if (!root1)
189         return nil;
190
191     Bindings::RootObject* root2 = [globalObject _rootObject];
192     if (!root2)
193         return nil;
194
195     return [WebScriptObject _convertValueToObjcValue:value originRootObject:root1 rootObject:root2];
196 }
197
198 @end
199
200
201
202 @implementation WebScriptCallFrame
203
204 - (void) dealloc
205 {
206     [_userInfo release];
207     [_private release];
208     [super dealloc];
209 }
210
211 - (void)setUserInfo:(id)userInfo
212 {
213     if (userInfo != _userInfo) {
214         [_userInfo release];
215         _userInfo = [userInfo retain];
216     }
217 }
218
219 - (id)userInfo
220 {
221     return _userInfo;
222 }
223
224 - (WebScriptCallFrame *)caller
225 {
226     return _private->caller;
227 }
228
229 // Returns an array of scope objects (most local first).
230 // The properties of each scope object are the variables for that scope.
231 // Note that the last entry in the array will _always_ be the global object (windowScriptObject),
232 // whose properties are the global variables.
233
234 - (NSArray *)scopeChain
235 {
236     ExecState* state = _private->state;
237     if (!state->scopeNode())  // global frame
238         return [NSArray arrayWithObject:_private->globalObject];
239
240     ScopeChain      chain  = state->scopeChain();
241     NSMutableArray *scopes = [[NSMutableArray alloc] init];
242
243     while (!chain.isEmpty()) {
244         [scopes addObject:[self _convertValueToObjcValue:chain.top()]];
245         chain.pop();
246     }
247
248     NSArray *result = [NSArray arrayWithArray:scopes];
249     [scopes release];
250     return result;
251 }
252
253 // Returns the name of the function for this frame, if available.
254 // Returns nil for anonymous functions and for the global frame.
255
256 - (NSString *)functionName
257 {
258     ExecState* state = _private->state;
259     if (!state->scopeNode())
260         return nil;
261
262     FunctionImp* func = state->function();
263     if (!func)
264         return nil;
265
266     Identifier fn = func->functionName();
267     return toNSString(fn.ustring());
268 }
269
270 // Returns the pending exception for this frame (nil if none).
271
272 - (id)exception
273 {
274     ExecState* state = _private->state;
275     if (!state->hadException())
276         return nil;
277     return [self _convertValueToObjcValue:state->exception()];
278 }
279
280 // Evaluate some JavaScript code in the context of this frame.
281 // The code is evaluated as if by "eval", and the result is returned.
282 // If there is an (uncaught) exception, it is returned as though _it_ were the result.
283 // Calling this method on the global frame is not quite the same as calling the WebScriptObject
284 // method of the same name, due to the treatment of exceptions.
285
286 // FIXME: If "script" contains var declarations, the machinery to handle local variables
287 // efficiently in JavaScriptCore will not work properly. This could lead to crashes or
288 // incorrect variable values. So this is not appropriate for evaluating arbitrary script.
289 - (id)evaluateWebScript:(NSString *)script
290 {
291     JSLock lock;
292
293     UString code = String(script);
294
295     ExecState* state = _private->state;
296     JSGlobalObject* globalObject = state->dynamicGlobalObject();
297
298     // find "eval"
299     JSObject* eval = NULL;
300     if (state->scopeNode()) {  // "eval" won't work without context (i.e. at global scope)
301         JSValue* v = globalObject->get(state, "eval");
302         if (v->isObject() && static_cast<JSObject*>(v)->implementsCall())
303             eval = static_cast<JSObject*>(v);
304         else
305             // no "eval" - fallback operates on global exec state
306             state = globalObject->globalExec();
307     }
308
309     JSValue* savedException = state->exception();
310     state->clearException();
311
312     // evaluate
313     JSValue* result;
314     if (eval) {
315         List args;
316         args.append(jsString(code));
317         result = eval->call(state, 0, args);
318     } else
319         // no "eval", or no context (i.e. global scope) - use global fallback
320         result = Interpreter::evaluate(state, UString(), 0, code.data(), code.size(), globalObject).value();
321
322     if (state->hadException())
323         result = state->exception();    // (may be redundant depending on which eval path was used)
324     state->setException(savedException);
325
326     return [self _convertValueToObjcValue:result];
327 }
328
329 @end