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  * Tells the debugger to continue running the script
 154  */
 155 - (StackFrame *)run
 156 {
 157         [socket send:[self createCommand:@"run"]];
 158         [socket receive];
 159
 160         [self updateStatus];
 161
 162         if (!connected)
 163                 return nil;
 164
 165         return [self createCurrentStackFrame];
 166 }
 167
 168 /**
 169  * Tells the debugger to step into the current command.
 170  */
 171 - (StackFrame *)stepIn
 172 {
 173         [socket send:[self createCommand:@"step_into"]];
 174         [socket receive];
 175
 176         [self updateStatus];
 177
 178         if (!connected)
 179                 return nil;
 180
 181         return [self createCurrentStackFrame];
 182 }
 183
 184 /**
 185  * Tells the debugger to step out of the current context
 186  */
 187 - (StackFrame *)stepOut
 188 {
 189         [socket send:[self createCommand:@"step_out"]];
 190         [socket receive];
 191
 192         [self updateStatus];
 193
 194         if (!connected)
 195                 return nil;
 196
 197         return [self createCurrentStackFrame];
 198 }
 199
 200 /**
 201  * Tells the debugger to step over the current function
 202  */
 203 - (StackFrame *)stepOver
 204 {
 205         [socket send:[self createCommand:@"step_over"]];
 206         [socket receive];
 207
 208         [self updateStatus];
 209
 210         if (!connected)
 211                 return nil;
 212
 213         return [self createCurrentStackFrame];
 214 }
 215
 216 /**
 217  * Tells the debugger engine to get a specifc property. This also takes in the NSXMLElement
 218  * that requested it so that the child can be attached.
 219  */
 220 - (NSArray *)getProperty:(NSString *)property
 221 {
 222         [socket send:[self createCommand:[NSString stringWithFormat:@"property_get -n \"%@\"", property]]];
 223
 224         NSXMLDocument *doc = [self processData:[socket receive]];
 225
 226         /*
 227          <response>
 228                 <property> <!-- this is the one we requested -->
 229                         <property ... /> <!-- these are what we want -->
 230                 </property>
 231          </repsonse>
 232          */
 233
 234         // we now have to detach all the children so we can insert them into another document
 235         NSXMLElement *parent = (NSXMLElement *)[[doc rootElement] childAtIndex:0];
 236         NSArray *children = [parent children];
 237         [parent setChildren:nil];
 238         return children;
 239 }
 240
 241 #pragma mark Breakpoints
 242
 243 /**
 244  * Send an add breakpoint command
 245  */
 246 - (void)addBreakpoint:(Breakpoint *)bp
 247 {
 248         if (!connected)
 249         {
 250                 return;
 251         }
 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         return [NSString stringWithFormat:@"%@ -i %@", [format autorelease], session];
 288 }
 289
 290 /**
 291  * Helper function to parse the NSData into an NSXMLDocument
 292  */
 293 - (NSXMLDocument *)processData:(NSString *)data
 294 {
 295         if (data == nil)
 296                 return nil;
 297
 298         NSError *parseError = nil;
 299         NSXMLDocument *doc = [[NSXMLDocument alloc] initWithXMLString:data options:0 error:&parseError];
 300         if (parseError)
 301         {
 302                 NSLog(@"Could not parse XML? --- %@", parseError);
 303                 NSLog(@"Error UserInfo: %@", [parseError userInfo]);
 304                 NSLog(@"This is the XML Document: %@", data);
 305                 return nil;
 306         }
 307
 308         // check and see if there's an error
 309         NSArray *error = [[doc rootElement] elementsForName:@"error"];
 310         if ([error count] > 0)
 311         {
 312                 NSLog(@"Xdebug error: %@", error);
 313                 [self errorEncountered:[[[[error objectAtIndex:0] children] objectAtIndex:0] stringValue]];
 314                 return nil;
 315         }
 316
 317         return [doc autorelease];
 318 }
 319
 320 /**
 321  * Generates a stack frame for the given depth
 322  */
 323 - (StackFrame *)createStackFrame:(int)stackDepth
 324 {
 325         // get the stack frame
 326         [socket send:[self createCommand:@"stack_get -d %d", stackDepth]];
 327         NSXMLDocument *doc = [self processData:[socket receive]];
 328         if (doc == nil)
 329                 return nil;
 330
 331         NSXMLElement *xmlframe = [[[doc rootElement] children] objectAtIndex:0];
 332
 333         // get the names of all the contexts
 334         [socket send:[self createCommand:@"context_names -d 0"]];
 335         NSXMLElement *contextNames = [[self processData:[socket receive]] rootElement];
 336         NSMutableArray *variables = [NSMutableArray array];
 337         for (NSXMLElement *context in [contextNames children])
 338         {
 339                 NSString *name = [[context attributeForName:@"name"] stringValue];
 340                 int cid = [[[context attributeForName:@"id"] stringValue] intValue];
 341
 342                 // fetch the contexts
 343                 [socket send:[self createCommand:[NSString stringWithFormat:@"context_get -d %d -c %d", stackDepth, cid]]];
 344                 NSArray *addVars = [[[self processData:[socket receive]] rootElement] children];
 345                 if (addVars != nil && name != nil)
 346                         [variables addObjectsFromArray:addVars];
 347         }
 348
 349         // get the source
 350         NSString *filename = [[xmlframe attributeForName:@"filename"] stringValue];
 351         [socket send:[self createCommand:[NSString stringWithFormat:@"source -f %@", filename]]];
 352         NSString *source = [[[self processData:[socket receive]] rootElement] value]; // decode base64
 353
 354         // create stack frame
 355         StackFrame *frame = [[StackFrame alloc]
 356                 initWithIndex:0
 357                 withFilename:filename
 358                 withSource:source
 359                 atLine:[[[xmlframe attributeForName:@"lineno"] stringValue] intValue]
 360                 inFunction:[[xmlframe attributeForName:@"where"] stringValue]
 361                 withVariables:variables
 362         ];
 363
 364         return [frame autorelease];
 365 }
 366
 367 /**
 368  * Creates a StackFrame based on the current position in the debugger
 369  */
 370 - (StackFrame *)createCurrentStackFrame
 371 {
 372         return [self createStackFrame:0];
 373 }
 374
 375 /**
 376  * Fetches the value of and sets the status instance variable
 377  */
 378 - (void)updateStatus
 379 {
 380         [socket send:[self createCommand:@"status"]];
 381         NSXMLDocument *doc = [self processData:[socket receive]];
 382         self.status = [[[[doc rootElement] attributeForName:@"status"] stringValue] capitalizedString];
 383
 384         if (status == nil || [status isEqualToString:@"Stopped"] || [status isEqualToString:@"Stopping"])
 385         {
 386                 connected = NO;
 387                 [socket close];
 388                 self.status = @"Stopped";
 389         }
 390 }
 391
 392 @end