Source/GDBpConnection.m

   1 /*
   2  * MacGDBp
   3  * Copyright (c) 2007 - 2009, 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 "GDBpConnection.h"
  18 #import "AppDelegate.h"
  19
  20 NSString* kErrorOccurredNotif = @"GDBpConnection_ErrorOccured_Notification";
  21
  22 @interface GDBpConnection()
  23 @property(readwrite, copy) NSString* status;
  24
  25 - (NSString*)createCommand:(NSString*)cmd, ...;
  26 - (NSXMLDocument*)processData:(NSString*)data;
  27 - (StackFrame*)createStackFrame:(int)depth;
  28 - (StackFrame*)createCurrentStackFrame;
  29 - (void)updateStatus;
  30 @end
  31
  32 @implementation GDBpConnection
  33
  34 @synthesize socket, status;
  35
  36 /**
  37  * Creates a new DebuggerConnection and initializes the socket from the given connection
  38  * paramters.
  39  */
  40 - (id)initWithPort:(int)aPort session:(NSString*)aSession;
  41 {
  42         if (self = [super init])
  43         {
  44                 port = aPort;
  45                 session = [aSession retain];
  46                 connected = NO;
  47
  48                 // now that we have our host information, open the socket
  49                 socket = [[SocketWrapper alloc] initWithConnection:self];
  50                 [socket setDelegate:self];
  51                 [socket connect];
  52
  53                 self.status = @"Connecting";
  54
  55                 [[BreakpointManager sharedManager] setConnection:self];
  56         }
  57         return self;
  58 }
  59
  60 /**
  61  * Deallocates the object
  62  */
  63 - (void)dealloc
  64 {
  65         [socket release];
  66         [session release];
  67         [super dealloc];
  68 }
  69
  70 /**
  71  * Gets the port number
  72  */
  73 - (int)port
  74 {
  75         return port;
  76 }
  77
  78 /**
  79  * Gets the session name
  80  */
  81 - (NSString*)session
  82 {
  83         return session;
  84 }
  85
  86 /**
  87  * Returns the name of the remote host
  88  */
  89 - (NSString*)remoteHost
  90 {
  91         if (!connected)
  92         {
  93                 return @"(DISCONNECTED)";
  94         }
  95         return [socket remoteHost];
  96 }
  97
  98 /**
  99  * Returns whether or not we have an active connection
 100  */
 101 - (BOOL)isConnected
 102 {
 103         return connected;
 104 }
 105
 106 /**
 107  * Called by SocketWrapper after the connection is successful. This immediately calls
 108  * -[SocketWrapper receive] to clear the way for communication, though the information
 109  * could be useful server information that we don't use right now.
 110  */
 111 - (void)socketDidAccept:(id)obj
 112 {
 113         connected = YES;
 114         [socket receive];
 115         [self updateStatus];
 116
 117         // register any breakpoints that exist offline
 118         for (Breakpoint* bp in [[BreakpointManager sharedManager] breakpoints])
 119         {
 120                 [self addBreakpoint:bp];
 121         }
 122
 123         [[[NSApp delegate] debugger] startDebugger]; // this will just load the debugger to make it look active
 124 }
 125
 126 /**
 127  * Receives errors from the SocketWrapper and updates the display
 128  */
 129 - (void)errorEncountered:(NSString*)error
 130 {
 131         [[NSNotificationCenter defaultCenter]
 132                 postNotificationName:kErrorOccurredNotif
 133                 object:self
 134                 userInfo:[NSDictionary
 135                         dictionaryWithObject:error
 136                         forKey:@"NSString"
 137                 ]
 138         ];
 139 }
 140
 141 /**
 142  * Reestablishes communication with the remote debugger so that a new connection doesn't have to be
 143  * created every time you want to debug a page
 144  */
 145 - (void)reconnect
 146 {
 147         [socket close];
 148         self.status = @"Connecting";
 149         [socket connect];
 150 }
 151
 152 /**
 153  * Creates an entirely new stack and returns it as an array of StackFrame objects.
 154  */
 155 - (NSArray*)getCurrentStack
 156 {
 157         // get the total stack depth
 158         [socket send:[self createCommand:@"stack_depth"]];
 159         NSXMLDocument* doc = [self processData:[socket receive]];
 160         int depth = [[[[doc rootElement] attributeForName:@"depth"] stringValue] intValue];
 161
 162         // get all stack frames
 163         NSMutableArray* stack = [NSMutableArray arrayWithCapacity:depth];
 164         for (int i = 0; i < depth; i++)
 165         {
 166                 StackFrame* frame = [self createStackFrame:i];
 167                 [stack insertObject:frame atIndex:i];
 168         }
 169
 170         return stack;
 171 }
 172
 173 /**
 174  * Tells the debugger to continue running the script. Returns the current stack frame.
 175  */
 176 - (void)run
 177 {
 178         [socket send:[self createCommand:@"run"]];
 179         [socket receive];
 180
 181         [self updateStatus];
 182 }
 183
 184 /**
 185  * Tells the debugger to step into the current command.
 186  */
 187 - (void)stepIn
 188 {
 189         [socket send:[self createCommand:@"step_into"]];
 190         [socket receive];
 191
 192         [self updateStatus];
 193
 194 }
 195
 196 /**
 197  * Tells the debugger to step out of the current context
 198  */
 199 - (void)stepOut
 200 {
 201         [socket send:[self createCommand:@"step_out"]];
 202         [socket receive];
 203
 204         [self updateStatus];
 205 }
 206
 207 /**
 208  * Tells the debugger to step over the current function
 209  */
 210 - (void)stepOver
 211 {
 212         [socket send:[self createCommand:@"step_over"]];
 213         [socket receive];
 214
 215         [self updateStatus];
 216 }
 217
 218 /**
 219  * Tells the debugger engine to get a specifc property. This also takes in the NSXMLElement
 220  * that requested it so that the child can be attached.
 221  */
 222 - (NSArray*)getProperty:(NSString*)property
 223 {
 224         [socket send:[self createCommand:[NSString stringWithFormat:@"property_get -n \"%@\"", property]]];
 225
 226         NSXMLDocument* doc = [self processData:[socket receive]];
 227
 228         /*
 229          <response>
 230                 <property> <!-- this is the one we requested -->
 231                         <property ... /> <!-- these are what we want -->
 232                 </property>
 233          </repsonse>
 234          */
 235
 236         // we now have to detach all the children so we can insert them into another document
 237         NSXMLElement* parent = (NSXMLElement*)[[doc rootElement] childAtIndex:0];
 238         NSArray* children = [parent children];
 239         [parent setChildren:nil];
 240         return children;
 241 }
 242
 243 #pragma mark Breakpoints
 244
 245 /**
 246  * Send an add breakpoint command
 247  */
 248 - (void)addBreakpoint:(Breakpoint*)bp
 249 {
 250         if (!connected)
 251                 return;
 252
 253         NSString* cmd = [self createCommand:[NSString stringWithFormat:@"breakpoint_set -t line -f '%@' -n %i", [bp transformedPath], [bp line]]];
 254         [socket send:cmd];
 255         NSXMLDocument* info = [self processData:[socket receive]];
 256         [bp setDebuggerId:[[[[info rootElement] attributeForName:@"id"] stringValue] intValue]];
 257 }
 258
 259 /**
 260  * Removes a breakpoint
 261  */
 262 - (void)removeBreakpoint:(Breakpoint*)bp
 263 {
 264         if (!connected)
 265         {
 266                 return;
 267         }
 268
 269         [socket send:[self createCommand:[NSString stringWithFormat:@"breakpoint_remove -d %i", [bp debuggerId]]]];
 270         [socket receive];
 271 }
 272
 273 #pragma mark Private
 274
 275 /**
 276  * Helper method to create a string command with the -i <session> automatically tacked on. Takes
 277  * a variable number of arguments and parses the given command with +[NSString stringWithFormat:]
 278  */
 279 - (NSString*)createCommand:(NSString*)cmd, ...
 280 {
 281         // collect varargs
 282         va_list argList;
 283         va_start(argList, cmd);
 284         NSString* format = [[NSString alloc] initWithFormat:cmd arguments:argList]; // format the command
 285         va_end(argList);
 286
 287 #ifdef BLU_DEBUG
 288         NSLog(@"--> %@", format);
 289 #endif
 290
 291         return [NSString stringWithFormat:@"%@ -i %@", [format autorelease], session];
 292 }
 293
 294 /**
 295  * Helper function to parse the NSData into an NSXMLDocument
 296  */
 297 - (NSXMLDocument*)processData:(NSString*)data
 298 {
 299         if (data == nil)
 300                 return nil;
 301
 302         NSError* parseError = nil;
 303         NSXMLDocument* doc = [[NSXMLDocument alloc] initWithXMLString:data options:0 error:&parseError];
 304         if (parseError)
 305         {
 306                 NSLog(@"Could not parse XML? --- %@", parseError);
 307                 NSLog(@"Error UserInfo: %@", [parseError userInfo]);
 308                 NSLog(@"This is the XML Document: %@", data);
 309                 return nil;
 310         }
 311
 312         // check and see if there's an error
 313         NSArray* error = [[doc rootElement] elementsForName:@"error"];
 314         if ([error count] > 0)
 315         {
 316                 NSLog(@"Xdebug error: %@", error);
 317                 [self errorEncountered:[[[[error objectAtIndex:0] children] objectAtIndex:0] stringValue]];
 318                 return nil;
 319         }
 320
 321 #ifdef BLU_DEBUG
 322         NSLog(@"<-- %@", doc);
 323 #endif
 324
 325         return [doc autorelease];
 326 }
 327
 328 /**
 329  * Generates a stack frame for the given depth
 330  */
 331 - (StackFrame*)createStackFrame:(int)stackDepth
 332 {
 333         // get the stack frame
 334         [socket send:[self createCommand:@"stack_get -d %d", stackDepth]];
 335         NSXMLDocument* doc = [self processData:[socket receive]];
 336         if (doc == nil)
 337                 return nil;
 338
 339         NSXMLElement* xmlframe = [[[doc rootElement] children] objectAtIndex:0];
 340
 341         // get the names of all the contexts
 342         [socket send:[self createCommand:@"context_names -d 0"]];
 343         NSXMLElement* contextNames = [[self processData:[socket receive]] rootElement];
 344         NSMutableArray* variables = [NSMutableArray array];
 345         for (NSXMLElement* context in [contextNames children])
 346         {
 347                 NSString* name = [[context attributeForName:@"name"] stringValue];
 348                 int cid = [[[context attributeForName:@"id"] stringValue] intValue];
 349
 350                 // fetch the contexts
 351                 [socket send:[self createCommand:[NSString stringWithFormat:@"context_get -d %d -c %d", stackDepth, cid]]];
 352                 NSArray* addVars = [[[self processData:[socket receive]] rootElement] children];
 353                 if (addVars != nil && name != nil)
 354                         [variables addObjectsFromArray:addVars];
 355         }
 356
 357         // get the source
 358         NSString* filename = [[xmlframe attributeForName:@"filename"] stringValue];
 359         filename = [filename stringByReplacingOccurrencesOfString:@"%" withString:@"%%"]; // escape % in URL chars
 360         [socket send:[self createCommand:[NSString stringWithFormat:@"source -f %@", filename]]];
 361         NSString* source = [[[self processData:[socket receive]] rootElement] value]; // decode base64
 362
 363         // create stack frame
 364         StackFrame* frame = [[StackFrame alloc]
 365                 initWithIndex:stackDepth
 366                 withFilename:filename
 367                 withSource:source
 368                 atLine:[[[xmlframe attributeForName:@"lineno"] stringValue] intValue]
 369                 inFunction:[[xmlframe attributeForName:@"where"] stringValue]
 370                 withVariables:variables
 371         ];
 372
 373         return [frame autorelease];
 374 }
 375
 376 /**
 377  * Creates a StackFrame based on the current position in the debugger
 378  */
 379 - (StackFrame*)createCurrentStackFrame
 380 {
 381         return [self createStackFrame:0];
 382 }
 383
 384 /**
 385  * Fetches the value of and sets the status instance variable
 386  */
 387 - (void)updateStatus
 388 {
 389         [socket send:[self createCommand:@"status"]];
 390         NSXMLDocument* doc = [self processData:[socket receive]];
 391         self.status = [[[[doc rootElement] attributeForName:@"status"] stringValue] capitalizedString];
 392
 393         if (status == nil || [status isEqualToString:@"Stopped"] || [status isEqualToString:@"Stopping"])
 394         {
 395                 connected = NO;
 396                 [socket close];
 397                 self.status = @"Stopped";
 398         }
 399 }
 400
 401 @end