Source/DebuggerProcessor.m

   1 /*
   2  * MacGDBp
   3  * Copyright (c) 2007 - 2010, Blue Static <http://www.bluestatic.org>
   4  *
   5  * This program is free software; you can redistribute it and/or modify it under the terms of the GNU
   6  * General Public License as published by the Free Software Foundation; either version 2 of the
   7  * License, or (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
  10  * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11  * General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along with this program; if not,
  14  * write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  15  */
  16
  17 #import "DebuggerProcessor.h"
  18
  19 #import "AppDelegate.h"
  20
  21 // GDBpConnection (Private) ////////////////////////////////////////////////////
  22
  23 @interface DebuggerProcessor ()
  24 @property (readwrite, copy) NSString* status;
  25
  26 - (void)recordCallback:(SEL)callback forTransaction:(NSNumber*)txn;
  27
  28 - (void)updateStatus:(NSXMLDocument*)response;
  29 - (void)debuggerStep:(NSXMLDocument*)response;
  30 - (void)rebuildStack:(NSXMLDocument*)response;
  31 - (void)getStackFrame:(NSXMLDocument*)response;
  32 - (void)setSource:(NSXMLDocument*)response;
  33 - (void)contextsReceived:(NSXMLDocument*)response;
  34 - (void)variablesReceived:(NSXMLDocument*)response;
  35 - (void)propertiesReceived:(NSXMLDocument*)response;
  36
  37 @end
  38
  39 // GDBpConnection //////////////////////////////////////////////////////////////
  40
  41 @implementation DebuggerProcessor
  42
  43 @synthesize status;
  44 @synthesize delegate;
  45
  46 /**
  47  * Creates a new DebuggerConnection and initializes the socket from the given connection
  48  * paramters.
  49  */
  50 - (id)initWithPort:(NSUInteger)aPort
  51 {
  52         if (self = [super init])
  53         {
  54                 stackFrames_ = [[NSMutableDictionary alloc] init];
  55                 callbackContext_ = [NSMutableDictionary new];
  56                 callTable_ = [NSMutableDictionary new];
  57
  58                 [[BreakpointManager sharedManager] setConnection:self];
  59                 connection_ = [[DebuggerConnection alloc] initWithPort:aPort];
  60                 connection_.delegate = self;
  61                 [connection_ connect];
  62         }
  63         return self;
  64 }
  65
  66 /**
  67  * Deallocates the object
  68  */
  69 - (void)dealloc
  70 {
  71         [connection_ close];
  72         [stackFrames_ release];
  73         [callTable_ release];
  74         [callbackContext_ release];
  75         [super dealloc];
  76 }
  77
  78
  79 // Getters /////////////////////////////////////////////////////////////////////
  80 #pragma mark Getters
  81
  82 /**
  83  * Gets the port number
  84  */
  85 - (NSUInteger)port
  86 {
  87         return [connection_ port];
  88 }
  89
  90 /**
  91  * Returns the name of the remote host
  92  */
  93 - (NSString*)remoteHost
  94 {
  95         if (![connection_ connected])
  96                 return @"(DISCONNECTED)";
  97
  98         // TODO: Either impl or remove.
  99         return @"";
 100 }
 101
 102 /**
 103  * Returns whether or not we have an active connection
 104  */
 105 - (BOOL)isConnected
 106 {
 107         return [connection_ connected];
 108 }
 109
 110 // Commands ////////////////////////////////////////////////////////////////////
 111 #pragma mark Commands
 112
 113 /**
 114  * Reestablishes communication with the remote debugger so that a new connection doesn't have to be
 115  * created every time you want to debug a page
 116  */
 117 - (void)reconnect
 118 {
 119         [connection_ close];
 120         self.status = @"Connecting";
 121         [connection_ connect];
 122 }
 123
 124 /**
 125  * Tells the debugger to continue running the script. Returns the current stack frame.
 126  */
 127 - (void)run
 128 {
 129         NSNumber* tx = [connection_ sendCommandWithFormat:@"run"];
 130         [self recordCallback:@selector(debuggerStep:) forTransaction:tx];
 131 }
 132
 133 /**
 134  * Tells the debugger to step into the current command.
 135  */
 136 - (void)stepIn
 137 {
 138         NSNumber* tx = [connection_ sendCommandWithFormat:@"step_into"];
 139         [self recordCallback:@selector(debuggerStep:) forTransaction:tx];
 140 }
 141
 142 /**
 143  * Tells the debugger to step out of the current context
 144  */
 145 - (void)stepOut
 146 {
 147         NSNumber* tx = [connection_ sendCommandWithFormat:@"step_out"];
 148         [self recordCallback:@selector(debuggerStep:) forTransaction:tx];
 149 }
 150
 151 /**
 152  * Tells the debugger to step over the current function
 153  */
 154 - (void)stepOver
 155 {
 156         NSNumber* tx = [connection_ sendCommandWithFormat:@"step_over"];
 157         [self recordCallback:@selector(debuggerStep:) forTransaction:tx];
 158 }
 159
 160 /**
 161  * Tells the debugger engine to get a specifc property. This also takes in the NSXMLElement
 162  * that requested it so that the child can be attached.
 163  */
 164 - (NSInteger)getProperty:(NSString*)property
 165 {
 166         NSNumber* tx = [connection_ sendCommandWithFormat:@"property_get -n \"%@\"", property];
 167         [self recordCallback:@selector(propertiesReceived:) forTransaction:tx];
 168 }
 169
 170 // Breakpoint Management ///////////////////////////////////////////////////////
 171 #pragma mark Breakpoints
 172
 173 /**
 174  * Send an add breakpoint command
 175  */
 176 - (void)addBreakpoint:(Breakpoint*)bp
 177 {
 178         if (![connection_ connected])
 179                 return;
 180
 181         NSString* file = [connection_ escapedURIPath:[bp transformedPath]];
 182         NSNumber* tx = [connection_ sendCommandWithFormat:@"breakpoint_set -t line -f %@ -n %i", file, [bp line]];
 183         [self recordCallback:@selector(breakpointReceived:) forTransaction:tx];
 184         [callbackContext_ setObject:bp forKey:tx];
 185 }
 186
 187 /**
 188  * Removes a breakpoint
 189  */
 190 - (void)removeBreakpoint:(Breakpoint*)bp
 191 {
 192         if (![connection_ connected])
 193                 return;
 194
 195         [connection_ sendCommandWithFormat:@"breakpoint_remove -d %i", [bp debuggerId]];
 196 }
 197
 198 // Specific Response Handlers //////////////////////////////////////////////////
 199 #pragma mark Response Handlers
 200
 201 /**
 202  * Initial packet received. We've started a brand-new connection to the engine.
 203  */
 204 - (void)handleInitialResponse:(NSXMLDocument*)response
 205 {
 206         // Register any breakpoints that exist offline.
 207         for (Breakpoint* bp in [[BreakpointManager sharedManager] breakpoints])
 208                 [self addBreakpoint:bp];
 209
 210         // Load the debugger to make it look active.
 211         [delegate debuggerConnected];
 212
 213         // TODO: update the status.
 214 }
 215
 216 - (void)handleResponse:(NSXMLDocument*)response
 217 {
 218         NSInteger transactionID = [connection_ transactionIDFromResponse:response];
 219         NSNumber* key = [NSNumber numberWithInt:transactionID];
 220         NSString* callbackStr = [callTable_ objectForKey:key];
 221         if (callbackStr)
 222         {
 223                 SEL callback = NSSelectorFromString(callbackStr);
 224                 [self performSelector:callback withObject:response];
 225         }
 226         [callTable_ removeObjectForKey:key];
 227 }
 228
 229 /**
 230  * Receiver for status updates. This just freshens up the UI.
 231  */
 232 - (void)updateStatus:(NSXMLDocument*)response
 233 {
 234         self.status = [[[[response rootElement] attributeForName:@"status"] stringValue] capitalizedString];
 235         if (status == nil || [status isEqualToString:@"Stopped"] || [status isEqualToString:@"Stopping"])
 236         {
 237                 [connection_ close];
 238                 [delegate debuggerDisconnected];
 239
 240                 self.status = @"Stopped";
 241         }
 242 }
 243
 244 /**
 245  * Step in/out/over and run all take this path. We first get the status of the
 246  * debugger and then request fresh stack information.
 247  */
 248 - (void)debuggerStep:(NSXMLDocument*)response
 249 {
 250         [self updateStatus:response];
 251         if (![connection_ connected])
 252                 return;
 253
 254         // If this is the run command, tell the delegate that a bunch of updates
 255         // are coming. Also remove all existing stack routes and request a new stack.
 256         // TODO: figure out if we can not clobber the stack every time.
 257         NSString* command = [[[response rootElement] attributeForName:@"command"] stringValue];
 258         if (YES || [command isEqualToString:@"run"])
 259         {
 260                 if ([delegate respondsToSelector:@selector(clobberStack)])
 261                         [delegate clobberStack];
 262                 [stackFrames_ removeAllObjects];
 263                 NSNumber* tx = [connection_ sendCommandWithFormat:@"stack_depth"];
 264                 [self recordCallback:@selector(rebuildStack:) forTransaction:tx];
 265                 stackFirstTransactionID_ = [tx intValue];
 266         }
 267 }
 268
 269 /**
 270  * We ask for the stack_depth and now we clobber the stack and start rebuilding
 271  * it.
 272  */
 273 - (void)rebuildStack:(NSXMLDocument*)response
 274 {
 275         NSInteger depth = [[[[response rootElement] attributeForName:@"depth"] stringValue] intValue];
 276
 277         if (stackFirstTransactionID_ == [connection_ transactionIDFromResponse:response])
 278                 stackDepth_ = depth;
 279
 280         // We now need to alloc a bunch of stack frames and get the basic information
 281         // for them.
 282         for (NSInteger i = 0; i < depth; i++)
 283         {
 284                 // Use the transaction ID to create a routing path.
 285                 NSNumber* routingID = [connection_ sendCommandWithFormat:@"stack_get -d %d", i];
 286                 [self recordCallback:@selector(getStackFrame:) forTransaction:routingID];
 287                 [stackFrames_ setObject:[StackFrame alloc] forKey:routingID];
 288         }
 289 }
 290
 291 /**
 292  * The initial rebuild of the stack frame. We now have enough to initialize
 293  * a StackFrame object.
 294  */
 295 - (void)getStackFrame:(NSXMLDocument*)response
 296 {
 297         // Get the routing information.
 298         NSInteger routingID = [connection_ transactionIDFromResponse:response];
 299         if (routingID < stackFirstTransactionID_)
 300                 return;
 301         NSNumber* routingNumber = [NSNumber numberWithInt:routingID];
 302
 303         // Make sure we initialized this frame in our last |-rebuildStack:|.
 304         StackFrame* frame = [stackFrames_ objectForKey:routingNumber];
 305         if (!frame)
 306                 return;
 307
 308         NSXMLElement* xmlframe = [[[response rootElement] children] objectAtIndex:0];
 309
 310         // Initialize the stack frame.
 311         [frame initWithIndex:[[[xmlframe attributeForName:@"level"] stringValue] intValue]
 312                         withFilename:[[xmlframe attributeForName:@"filename"] stringValue]
 313                           withSource:nil
 314                                   atLine:[[[xmlframe attributeForName:@"lineno"] stringValue] intValue]
 315                           inFunction:[[xmlframe attributeForName:@"where"] stringValue]
 316                    withVariables:nil];
 317
 318         // Only get the complete frame for the first level. The other frames will get
 319         // information loaded lazily when the user clicks on one.
 320         if (frame.index == 0) {
 321                 // Get the source code of the file. Escape % in URL chars.
 322                 NSString* escapedFilename = [frame.filename stringByReplacingOccurrencesOfString:@"%" withString:@"%%"];
 323                 NSNumber* transaction = [connection_ sendCommandWithFormat:@"source -f %@", escapedFilename];
 324                 [self recordCallback:@selector(setSource:) forTransaction:transaction];
 325                 [callbackContext_ setObject:routingNumber forKey:transaction];
 326
 327                 // Get the names of all the contexts.
 328                 transaction = [connection_ sendCommandWithFormat:@"context_names -d %d", frame.index];
 329                 [self recordCallback:@selector(contextsReceived:) forTransaction:transaction];
 330                 [callbackContext_ setObject:routingNumber forKey:transaction];
 331         }
 332
 333         if ([delegate respondsToSelector:@selector(newStackFrame:)])
 334                 [delegate newStackFrame:frame];
 335 }
 336
 337 /**
 338  * Callback for setting the source of a file while rebuilding a specific stack
 339  * frame.
 340  */
 341 - (void)setSource:(NSXMLDocument*)response
 342 {
 343         NSNumber* transaction = [NSNumber numberWithInt:[connection_ transactionIDFromResponse:response]];
 344         if ([transaction intValue] < stackFirstTransactionID_)
 345                 return;
 346         NSNumber* routingNumber = [callbackContext_ objectForKey:transaction];
 347         if (!routingNumber)
 348                 return;
 349
 350         [callbackContext_ removeObjectForKey:transaction];
 351         StackFrame* frame = [stackFrames_ objectForKey:routingNumber];
 352         if (!frame)
 353                 return;
 354
 355         frame.source = [[response rootElement] value];
 356
 357         if ([delegate respondsToSelector:@selector(sourceUpdated:)])
 358                 [delegate sourceUpdated:frame];
 359 }
 360
 361 /**
 362  * Enumerates all the contexts of a given stack frame. We then in turn get the
 363  * contents of each one of these contexts.
 364  */
 365 - (void)contextsReceived:(NSXMLDocument*)response
 366 {
 367         // Get the stack frame's routing ID and use it again.
 368         NSNumber* receivedTransaction = [NSNumber numberWithInt:[connection_ transactionIDFromResponse:response]];
 369         if ([receivedTransaction intValue] < stackFirstTransactionID_)
 370                 return;
 371         NSNumber* routingID = [callbackContext_ objectForKey:receivedTransaction];
 372         if (!routingID)
 373                 return;
 374
 375         // Get the stack frame by the |routingID|.
 376         StackFrame* frame = [stackFrames_ objectForKey:routingID];
 377
 378         NSXMLElement* contextNames = [response rootElement];
 379         for (NSXMLElement* context in [contextNames children])
 380         {
 381                 NSInteger cid = [[[context attributeForName:@"id"] stringValue] intValue];
 382
 383                 // Fetch each context's variables.
 384                 NSNumber* tx = [connection_ sendCommandWithFormat:@"context_get -d %d -c %d", frame.index, cid];
 385                 [self recordCallback:@selector(variablesReceived:) forTransaction:tx];
 386                 [callbackContext_ setObject:routingID forKey:tx];
 387         }
 388 }
 389
 390 /**
 391  * Receives the variables from the context and attaches them to the stack frame.
 392  */
 393 - (void)variablesReceived:(NSXMLDocument*)response
 394 {
 395         // Get the stack frame's routing ID and use it again.
 396         NSInteger transaction = [connection_ transactionIDFromResponse:response];
 397         if (transaction < stackFirstTransactionID_)
 398                 return;
 399         NSNumber* receivedTransaction = [NSNumber numberWithInt:transaction];
 400         NSNumber* routingID = [callbackContext_ objectForKey:receivedTransaction];
 401         if (!routingID)
 402                 return;
 403
 404         // Get the stack frame by the |routingID|.
 405         StackFrame* frame = [stackFrames_ objectForKey:routingID];
 406
 407         NSMutableArray* variables = [NSMutableArray array];
 408
 409         // Merge the frame's existing variables.
 410         if (frame.variables)
 411                 [variables addObjectsFromArray:frame.variables];
 412
 413         // Add these new variables.
 414         NSArray* addVariables = [[response rootElement] children];
 415         if (addVariables)
 416                 [variables addObjectsFromArray:addVariables];
 417
 418         frame.variables = variables;
 419 }
 420
 421 /**
 422  * Callback from a |-getProperty:| request.
 423  */
 424 - (void)propertiesReceived:(NSXMLDocument*)response
 425 {
 426         NSInteger transaction = [connection_ transactionIDFromResponse:response];
 427
 428         /*
 429          <response>
 430                  <property> <!-- this is the one we requested -->
 431                          <property ... /> <!-- these are what we want -->
 432                  </property>
 433          </repsonse>
 434          */
 435
 436         // Detach all the children so we can insert them into another document.
 437         NSXMLElement* parent = (NSXMLElement*)[[response rootElement] childAtIndex:0];
 438         NSArray* children = [parent children];
 439         [parent setChildren:nil];
 440
 441         [delegate receivedProperties:children forTransaction:transaction];
 442 }
 443
 444 /**
 445  * Callback for setting a breakpoint.
 446  */
 447 - (void)breakpointReceived:(NSXMLDocument*)response
 448 {
 449         NSNumber* transaction = [NSNumber numberWithInt:[connection_ transactionIDFromResponse:response]];
 450         Breakpoint* bp = [callbackContext_ objectForKey:transaction];
 451         if (!bp)
 452                 return;
 453
 454         [callbackContext_ removeObjectForKey:callbackContext_];
 455         [bp setDebuggerId:[[[[response rootElement] attributeForName:@"id"] stringValue] intValue]];
 456 }
 457
 458 // Private /////////////////////////////////////////////////////////////////////
 459
 460 - (void)recordCallback:(SEL)callback forTransaction:(NSNumber*)txn
 461 {
 462         [callTable_ setObject:NSStringFromSelector(callback) forKey:txn];
 463 }
 464
 465 @end