3 * Copyright (c) 2007 - 2009, Blue Static <http://www.bluestatic.org>
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.
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.
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
17 #import "GDBpConnection.h"
18 #import "AppDelegate.h"
20 NSString
*kErrorOccurredNotif
= @
"GDBpConnection_ErrorOccured_Notification";
22 @interface GDBpConnection()
23 @property(readwrite
, copy
) NSString
*status
;
25 - (NSString
*)createCommand
:(NSString
*)cmd
;
26 - (NSXMLDocument
*)processData
:(NSString
*)data
;
27 - (StackFrame
*)createStackFrame
;
31 @implementation GDBpConnection
33 @synthesize socket
, status
;
36 * Creates a new DebuggerConnection and initializes the socket from the given connection
39 - (id)initWithPort
:(int)aPort session
:(NSString
*)aSession
;
41 if (self = [super init
])
44 session
= [aSession retain
];
47 // now that we have our host information, open the socket
48 socket
= [[SocketWrapper alloc
] initWithConnection
:self];
49 [socket setDelegate
:self];
52 self.status
= @
"Connecting";
54 [[BreakpointManager sharedManager
] setConnection
:self];
60 * Deallocates the object
70 * Gets the port number
78 * Gets the session name
86 * Returns the name of the remote host
88 - (NSString
*)remoteHost
92 return @
"(DISCONNECTED)";
94 return [socket remoteHost
];
98 * Returns whether or not we have an active connection
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.
110 - (void)socketDidAccept
:(id)obj
116 // register any breakpoints that exist offline
117 for (Breakpoint
*bp
in [[BreakpointManager sharedManager
] breakpoints
])
119 [self addBreakpoint
:bp
];
122 [[[NSApp delegate
] debugger
] startDebugger
]; // this will just load the debugger to make it look active
126 * Receives errors from the SocketWrapper and updates the display
128 - (void)errorEncountered
:(NSString
*)error
130 [[NSNotificationCenter defaultCenter
]
131 postNotificationName
:kErrorOccurredNotif
133 userInfo
:[NSDictionary
134 dictionaryWithObject
:error
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
147 self.status
= @
"Connecting";
152 * Tells the debugger to continue running the script
156 [socket send
:[self createCommand
:@
"run"]];
162 * Tells the debugger to step into the current command.
164 - (StackFrame
*)stepIn
166 [socket send
:[self createCommand
:@
"step_into"]];
169 StackFrame
*frame
= [self createStackFrame
];
176 * Tells the debugger to step out of the current context
178 - (StackFrame
*)stepOut
180 [socket send
:[self createCommand
:@
"step_out"]];
183 StackFrame
*frame
= [self createStackFrame
];
190 * Tells the debugger to step over the current function
192 - (StackFrame
*)stepOver
194 [socket send
:[self createCommand
:@
"step_over"]];
197 StackFrame
*frame
= [self createStackFrame
];
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.
207 - (NSArray
*)getProperty
:(NSString
*)property
209 [socket send
:[self createCommand
:[NSString stringWithFormat
:@
"property_get -n \"%@\"", property
]]];
211 NSXMLDocument
*doc
= [self processData
:[socket receive
]];
215 <property> <!-- this is the one we requested -->
216 <property ... /> <!-- these are what we want -->
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];
228 #pragma mark Breakpoints
231 * Send an add breakpoint command
233 - (void)addBreakpoint
:(Breakpoint
*)bp
240 NSString
*cmd
= [self createCommand
:[NSString stringWithFormat
:@
"breakpoint_set -t line -f %@ -n %i", [bp file
], [bp line
]]];
242 NSXMLDocument
*info
= [self processData
:[socket receive
]];
243 [bp setDebuggerId
:[[[[info rootElement
] attributeForName
:@
"id"] stringValue
] intValue
]];
247 * Removes a breakpoint
249 - (void)removeBreakpoint
:(Breakpoint
*)bp
256 [socket send
:[self createCommand
:[NSString stringWithFormat
:@
"breakpoint_remove -d %i", [bp debuggerId
]]]];
263 * Helper method to create a string command with the -i <session> automatically tacked on
265 - (NSString
*)createCommand
:(NSString
*)cmd
267 return [NSString stringWithFormat
:@
"%@ -i %@", cmd
, session
];
271 * Helper function to parse the NSData into an NSXMLDocument
273 - (NSXMLDocument
*)processData
:(NSString
*)data
275 NSError
*parseError
= nil;
276 NSXMLDocument
*doc
= [[NSXMLDocument alloc
] initWithXMLString
:data options
:0 error
:&parseError
];
279 NSLog(@
"Could not parse XML? --- %@", parseError
);
280 NSLog(@
"Error UserInfo: %@", [parseError userInfo
]);
281 NSLog(@
"This is the XML Document: %@", data
);
285 // check and see if there's an error
286 NSArray
*error
= [[doc rootElement
] elementsForName
:@
"error"];
287 if ([error count
] > 0)
289 [self errorEncountered
:[[[[error objectAtIndex
:0] children
] objectAtIndex
:0] stringValue
]];
293 return [doc autorelease
];
297 * Creates a StackFrame based on the current position in the debugger
299 - (StackFrame
*)createStackFrame
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];
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
])
312 NSString
*name
= [[context attributeForName
:@
"name"] stringValue
];
313 int cid
= [[[context attributeForName
:@
"id"] stringValue
] intValue
];
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
];
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
327 // create stack frame
328 StackFrame
*frame
= [[StackFrame alloc
]
330 withFilename
:filename
332 atLine
:[[[xmlframe attributeForName
:@
"lineno"] stringValue
] intValue
]
333 inFunction
:[[xmlframe attributeForName
:@
"where"] stringValue
]
334 withVariables
:variables
337 return [frame autorelease
];
341 * Fetches the value of and sets the status instance variable
345 [socket send
:[self createCommand
:@
"status"]];
346 NSXMLDocument
*doc
= [self processData
:[socket receive
]];
347 self.status
= [[[[doc rootElement
] attributeForName
:@
"status"] stringValue
] capitalizedString
];
349 if ([status isEqualToString
:@
"Stopped"] ||
[status isEqualToString
:@
"Stopping"])
353 self.status
= @
"Stopped";