WebKitTools/Drosera/DebuggerDocument.m

   1 /*
   2  * Copyright (C) 2006 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 "DebuggerDocument.h"
  30
  31 static NSString *DebuggerContinueToolbarItem = @"DebuggerContinueToolbarItem";
  32 static NSString *DebuggerPauseToolbarItem = @"DebuggerPauseToolbarItem";
  33 static NSString *DebuggerStepIntoToolbarItem = @"DebuggerStepIntoToolbarItem";
  34
  35 @implementation DebuggerDocument
  36 + (BOOL)isSelectorExcludedFromWebScript:(SEL)aSelector
  37 {
  38     return NO;
  39 }
  40
  41 + (BOOL)isKeyExcludedFromWebScript:(const char *)name
  42 {
  43     return NO;
  44 }
  45
  46 #pragma mark -
  47
  48 - (id)initWithServerName:(NSString *)serverName
  49 {
  50     if ((self = [super init]))
  51         [self switchToServerNamed:serverName];
  52     return self;
  53 }
  54
  55 - (void)dealloc
  56 {
  57     [server release];
  58     [currentServerName release];
  59     [super dealloc];
  60 }
  61
  62 #pragma mark -
  63 #pragma mark Stack & Variables
  64
  65 - (WebScriptCallFrame *)currentFrame
  66 {
  67     return currentFrame;
  68 }
  69
  70 - (NSString *)currentFrameFunctionName
  71 {
  72     return [currentFrame functionName];
  73 }
  74
  75 - (NSArray *)currentFunctionStack
  76 {
  77     NSMutableArray *result = [[NSMutableArray alloc] init];
  78     WebScriptCallFrame *frame = currentFrame;
  79     while (frame) {
  80         if ([frame functionName])
  81             [result addObject:[frame functionName]];
  82         frame = [frame caller];
  83     }
  84     return [result autorelease];
  85 }
  86
  87 #pragma mark -
  88 #pragma mark Pause & Step
  89
  90 - (BOOL)isPaused
  91 {
  92     return paused;
  93 }
  94
  95 - (void)pause
  96 {
  97     paused = YES;
  98     if ([[(NSDistantObject *)server connectionForProxy] isValid])
  99         [server pause];
 100     [[NSApplication sharedApplication] activateIgnoringOtherApps:YES];
 101 }
 102
 103 - (void)resume
 104 {
 105     paused = NO;
 106     if ([[(NSDistantObject *)server connectionForProxy] isValid])
 107         [server resume];
 108 }
 109
 110 - (void)stepInto
 111 {
 112     if ([[(NSDistantObject *)server connectionForProxy] isValid])
 113         [server step];
 114 }
 115
 116 - (void)log:(NSString *)msg
 117 {
 118     NSLog(@"%@", msg);
 119 }
 120
 121 #pragma mark -
 122 #pragma mark Interface Actions
 123
 124 - (IBAction)pause:(id)sender
 125 {
 126     [[webView windowScriptObject] callWebScriptMethod:@"pause" withArguments:nil];
 127 }
 128
 129 - (IBAction)resume:(id)sender
 130 {
 131     [[webView windowScriptObject] callWebScriptMethod:@"resume" withArguments:nil];
 132 }
 133
 134 - (IBAction)stepInto:(id)sender
 135 {
 136     [[webView windowScriptObject] callWebScriptMethod:@"stepInto" withArguments:nil];
 137 }
 138
 139 #pragma mark -
 140 #pragma mark Window Controller Overrides
 141
 142 - (NSString *)windowNibName
 143 {
 144     return @"Debugger";
 145 }
 146
 147 - (void)windowDidLoad
 148 {
 149     [super windowDidLoad];
 150
 151     [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(applicationTerminating:) name:NSApplicationWillTerminateNotification object:nil];
 152
 153     NSString *path = [[NSBundle bundleForClass:[self class]] pathForResource:@"debugger" ofType:@"html" inDirectory:nil];
 154     [[webView mainFrame] loadRequest:[[[NSURLRequest alloc] initWithURL:[NSURL fileURLWithPath:path]] autorelease]];
 155
 156     NSToolbar *toolbar = [[NSToolbar alloc] initWithIdentifier:@"debugger"];
 157     [toolbar setDelegate:self];
 158     [toolbar setAllowsUserCustomization:YES];
 159     [toolbar setAutosavesConfiguration:YES];
 160     [[self window] setToolbar:toolbar];
 161     [toolbar release];
 162 }
 163
 164 - (void)windowWillClose:(NSNotification *)notification
 165 {
 166     [[webView windowScriptObject] removeWebScriptKey:@"DebuggerDocument"];
 167
 168     [[NSNotificationCenter defaultCenter] removeObserver:self name:NSApplicationWillTerminateNotification object:nil];
 169     [[NSDistributedNotificationCenter defaultCenter] removeObserver:self name:WebScriptDebugServerQueryReplyNotification object:nil];
 170     [[NSDistributedNotificationCenter defaultCenter] removeObserver:self name:WebScriptDebugServerWillUnloadNotification object:nil];
 171
 172     [self switchToServerNamed:nil];
 173
 174     [self autorelease]; // DebuggerApplication expects us to release on close
 175 }
 176
 177 #pragma mark -
 178 #pragma mark Connection Handling
 179
 180 - (void)switchToServerNamed:(NSString *)name
 181 {
 182     if (server) {
 183         [[NSNotificationCenter defaultCenter] removeObserver:self name:NSConnectionDidDieNotification object:[(NSDistantObject *)server connectionForProxy]];
 184         if ([[(NSDistantObject *)server connectionForProxy] isValid]) {
 185             [self resume];
 186             [server removeListener:self];
 187         }
 188     }
 189
 190     id old = server;
 191     server = ([name length] ? [[NSConnection rootProxyForConnectionWithRegisteredName:name host:nil] retain] : nil);
 192     [old release];
 193
 194     old = currentServerName;
 195     currentServerName = [name copy];
 196     [old release];
 197
 198     if (server) {
 199         @try {
 200             [(NSDistantObject *)server setProtocolForProxy:@protocol(WebScriptDebugServer)];
 201             [server addListener:self];
 202         } @catch (NSException *exception) {
 203             [currentServerName release];
 204             currentServerName = nil;
 205             [server release];
 206             server = nil;
 207         }
 208
 209         if (server)
 210             [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(serverConnectionDidDie:) name:NSConnectionDidDieNotification object:[(NSDistantObject *)server connectionForProxy]];
 211     }
 212 }
 213
 214 - (void)applicationTerminating:(NSNotification *)notifiction
 215 {
 216     if (server && [[(NSDistantObject *)server connectionForProxy] isValid]) {
 217         [self switchToServerNamed:nil];
 218         // call the runloop for a while to make sure our removeListener: is sent to the server
 219         [[NSRunLoop currentRunLoop] runUntilDate:[NSDate dateWithTimeIntervalSinceNow:0.25]];
 220     }
 221 }
 222
 223 - (void)serverConnectionDidDie:(NSNotification *)notifiction
 224 {
 225     [self switchToServerNamed:nil];
 226 }
 227
 228 #pragma mark -
 229 #pragma mark Toolbar Delegate
 230
 231 - (NSToolbarItem *)toolbar:(NSToolbar *)toolbar itemForItemIdentifier:(NSString *)itemIdentifier willBeInsertedIntoToolbar:(BOOL)flag
 232 {
 233     if ([itemIdentifier isEqualToString:DebuggerContinueToolbarItem]) {
 234         NSToolbarItem *item = [[NSToolbarItem alloc] initWithItemIdentifier:itemIdentifier];
 235
 236         [item setLabel:@"Continue"];
 237         [item setPaletteLabel:@"Continue"];
 238
 239         [item setToolTip:@"Continue script execution"];
 240         [item setImage:[NSImage imageNamed:@"continue"]];
 241
 242         [item setTarget:self];
 243         [item setAction:@selector(resume:)];
 244
 245         return [item autorelease];
 246     } else if ([itemIdentifier isEqualToString:DebuggerPauseToolbarItem]) {
 247         NSToolbarItem *item = [[NSToolbarItem alloc] initWithItemIdentifier:itemIdentifier];
 248
 249         [item setLabel:@"Pause"];
 250         [item setPaletteLabel:@"Pause"];
 251
 252         [item setToolTip:@"Pause script execution"];
 253         [item setImage:[NSImage imageNamed:@"pause"]];
 254
 255         [item setTarget:self];
 256         [item setAction:@selector(pause:)];
 257
 258         return [item autorelease];
 259     } else if ([itemIdentifier isEqualToString:DebuggerStepIntoToolbarItem]) {
 260         NSToolbarItem *item = [[NSToolbarItem alloc] initWithItemIdentifier:itemIdentifier];
 261
 262         [item setLabel:@"Step Into"];
 263         [item setPaletteLabel:@"Step Into"];
 264
 265         [item setToolTip:@"Step into function call"];
 266         [item setImage:[NSImage imageNamed:@"step"]];
 267
 268         [item setTarget:self];
 269         [item setAction:@selector(stepInto:)];
 270
 271         return [item autorelease];
 272     }
 273
 274     return nil;
 275 }
 276
 277 - (NSArray *)toolbarDefaultItemIdentifiers:(NSToolbar*)toolbar
 278 {
 279     return [NSArray arrayWithObjects:DebuggerContinueToolbarItem, DebuggerPauseToolbarItem,
 280         NSToolbarSeparatorItemIdentifier, DebuggerStepIntoToolbarItem, nil];
 281 }
 282
 283 - (NSArray *)toolbarAllowedItemIdentifiers:(NSToolbar*)toolbar
 284 {
 285     return [NSArray arrayWithObjects:DebuggerContinueToolbarItem, DebuggerPauseToolbarItem, DebuggerStepIntoToolbarItem,
 286         NSToolbarCustomizeToolbarItemIdentifier, NSToolbarFlexibleSpaceItemIdentifier,
 287         NSToolbarSpaceItemIdentifier, NSToolbarSeparatorItemIdentifier, nil];
 288 }
 289
 290 - (BOOL)validateUserInterfaceItem:(id <NSValidatedUserInterfaceItem>)interfaceItem
 291 {
 292     if ([interfaceItem action] == @selector(pause:))
 293         return ![self isPaused];
 294     if ([interfaceItem action] == @selector(resume:))
 295         return [self isPaused];
 296     if ([interfaceItem action] == @selector(stepInto:))
 297         return [self isPaused];
 298     return YES;
 299 }
 300
 301 #pragma mark -
 302 #pragma mark WebView Frame Load Delegate
 303
 304 - (void)webView:(WebView *)sender windowScriptObjectAvailable:(WebScriptObject *)windowScriptObject
 305 {
 306     // note: this is the Debuggers's own WebView, not the one being debugged
 307     [[sender windowScriptObject] setValue:self forKey:@"DebuggerDocument"];
 308 }
 309
 310 - (void)webView:(WebView *)sender didFinishLoadForFrame:(WebFrame *)frame
 311 {
 312     // note: this is the Debuggers's own WebView, not the one being debugged
 313     webViewLoaded = YES;
 314 }
 315
 316 #pragma mark -
 317 #pragma mark Debug Listener Callbacks
 318
 319 - (void)webView:(WebView *)view didLoadMainResourceForDataSource:(WebDataSource *)dataSource
 320 {
 321     NSString *documentSourceCopy = nil;
 322     id <WebDocumentRepresentation> rep = [dataSource representation];
 323     if ([rep canProvideDocumentSource])
 324         documentSourceCopy = [[rep documentSource] copy];
 325
 326     if (!documentSourceCopy)
 327         return;
 328
 329     NSString *urlCopy = [[[[dataSource response] URL] absoluteString] copy];
 330     NSArray *args = [NSArray arrayWithObjects:(documentSourceCopy ? documentSourceCopy : @""), (urlCopy ? urlCopy : @""), [NSNumber numberWithBool:NO], nil];
 331     [[webView windowScriptObject] callWebScriptMethod:@"updateFileSource" withArguments:args];
 332
 333     [documentSourceCopy release];
 334     [urlCopy release];
 335 }
 336
 337 - (void)webView:(WebView *)view didParseSource:(NSString *)source baseLineNumber:(unsigned)baseLine fromURL:(NSURL *)url sourceId:(int)sid forWebFrame:(WebFrame *)webFrame
 338 {
 339     if (!webViewLoaded)
 340         return;
 341
 342     NSString *sourceCopy = [source copy];
 343     if (!sourceCopy)
 344         return;
 345
 346     NSString *documentSourceCopy = nil;
 347     NSString *urlCopy = [[url absoluteString] copy];
 348
 349     WebDataSource *dataSource = [webFrame dataSource];
 350     if (!url || [[[dataSource response] URL] isEqual:url]) {
 351         id <WebDocumentRepresentation> rep = [dataSource representation];
 352         if ([rep canProvideDocumentSource])
 353             documentSourceCopy = [[rep documentSource] copy];
 354         if (!urlCopy)
 355             urlCopy = [[[[dataSource response] URL] absoluteString] copy];
 356     }
 357
 358     NSArray *args = [NSArray arrayWithObjects:sourceCopy, (documentSourceCopy ? documentSourceCopy : @""), (urlCopy ? urlCopy : @""), [NSNumber numberWithInt:sid], [NSNumber numberWithUnsignedInt:baseLine], nil];
 359     [[webView windowScriptObject] callWebScriptMethod:@"didParseScript" withArguments:args];
 360
 361     [sourceCopy release];
 362     [documentSourceCopy release];
 363     [urlCopy release];
 364 }
 365
 366 - (void)webView:(WebView *)view failedToParseSource:(NSString *)source baseLineNumber:(unsigned)baseLine fromURL:(NSURL *)url withError:(NSError *)error forWebFrame:(WebFrame *)webFrame
 367 {
 368 }
 369
 370 - (void)webView:(WebView *)view didEnterCallFrame:(WebScriptCallFrame *)frame sourceId:(int)sid line:(int)lineno forWebFrame:(WebFrame *)webFrame
 371 {
 372     if (!webViewLoaded)
 373         return;
 374
 375     id old = currentFrame;
 376     currentFrame = [frame retain];
 377     [old release];
 378
 379     NSArray *args = [NSArray arrayWithObjects:[NSNumber numberWithInt:sid], [NSNumber numberWithInt:lineno], nil];
 380     [[webView windowScriptObject] callWebScriptMethod:@"didEnterCallFrame" withArguments:args];
 381 }
 382
 383 - (void)webView:(WebView *)view willExecuteStatement:(WebScriptCallFrame *)frame sourceId:(int)sid line:(int)lineno forWebFrame:(WebFrame *)webFrame
 384 {
 385     if (!webViewLoaded)
 386         return;
 387
 388     NSArray *args = [NSArray arrayWithObjects:[NSNumber numberWithInt:sid], [NSNumber numberWithInt:lineno], nil];
 389     [[webView windowScriptObject] callWebScriptMethod:@"willExecuteStatement" withArguments:args];
 390 }
 391
 392 - (void)webView:(WebView *)view willLeaveCallFrame:(WebScriptCallFrame *)frame sourceId:(int)sid line:(int)lineno forWebFrame:(WebFrame *)webFrame
 393 {
 394     if (!webViewLoaded)
 395         return;
 396
 397     NSArray *args = [NSArray arrayWithObjects:[NSNumber numberWithInt:sid], [NSNumber numberWithInt:lineno], nil];
 398     [[webView windowScriptObject] callWebScriptMethod:@"willLeaveCallFrame" withArguments:args];
 399
 400     id old = currentFrame;
 401     currentFrame = [[frame caller] retain];
 402     [old release];
 403 }
 404 @end