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