3 * Copyright (c) 2007 - 2010, 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 "DebuggerBackEnd.h"
19 #import "AppDelegate.h"
20 #import "NSXMLElementAdditions.h"
22 // GDBpConnection (Private) ////////////////////////////////////////////////////
24 @interface DebuggerBackEnd ()
25 @property (readwrite
, copy
) NSString
* status
;
27 - (void)recordCallback
:(SEL)callback forTransaction
:(NSNumber
*)txn
;
29 - (void)updateStatus
:(NSXMLDocument
*)response
;
30 - (void)debuggerStep
:(NSXMLDocument
*)response
;
31 - (void)rebuildStack
:(NSXMLDocument
*)response
;
32 - (void)getStackFrame
:(NSXMLDocument
*)response
;
33 - (void)setSource
:(NSXMLDocument
*)response
;
34 - (void)contextsReceived
:(NSXMLDocument
*)response
;
35 - (void)variablesReceived
:(NSXMLDocument
*)response
;
36 - (void)propertiesReceived
:(NSXMLDocument
*)response
;
40 // GDBpConnection //////////////////////////////////////////////////////////////
42 @implementation DebuggerBackEnd
45 @synthesize attached
= attached_
;
49 * Creates a new DebuggerBackEnd and initializes the socket from the given connection
52 - (id)initWithPort
:(NSUInteger
)aPort
54 if (self = [super init
])
56 stackFrames_
= [[NSMutableDictionary alloc
] init
];
57 callbackContext_
= [NSMutableDictionary
new];
58 callTable_
= [NSMutableDictionary
new];
60 [[BreakpointManager sharedManager
] setConnection
:self];
61 connection_
= [[NetworkConnection alloc
] initWithPort
:aPort
];
62 connection_.delegate
= self;
63 [connection_ connect
];
69 * Deallocates the object
74 [stackFrames_ release
];
76 [callbackContext_ release
];
81 // Getters /////////////////////////////////////////////////////////////////////
85 * Gets the port number
89 return [connection_ port
];
93 * Returns whether or not we have an active connection
97 return [connection_ connected
] && active_
;
100 // Commands ////////////////////////////////////////////////////////////////////
101 #pragma mark Commands
104 * Tells the debugger to continue running the script. Returns the current stack frame.
108 NSNumber
* tx
= [connection_ sendCommandWithFormat
:@
"run"];
109 [self recordCallback
:@selector(debuggerStep
:) forTransaction
:tx
];
113 * Tells the debugger to step into the current command.
117 NSNumber
* tx
= [connection_ sendCommandWithFormat
:@
"step_into"];
118 [self recordCallback
:@selector(debuggerStep
:) forTransaction
:tx
];
122 * Tells the debugger to step out of the current context
126 NSNumber
* tx
= [connection_ sendCommandWithFormat
:@
"step_out"];
127 [self recordCallback
:@selector(debuggerStep
:) forTransaction
:tx
];
131 * Tells the debugger to step over the current function
135 NSNumber
* tx
= [connection_ sendCommandWithFormat
:@
"step_over"];
136 [self recordCallback
:@selector(debuggerStep
:) forTransaction
:tx
];
140 * Tells the debugger engine to get a specifc property. This also takes in the NSXMLElement
141 * that requested it so that the child can be attached.
143 - (NSInteger
)getChildrenOfProperty
:(VariableNode
*)property atDepth
:(NSInteger
)depth
;
145 NSNumber
* tx
= [connection_ sendCommandWithFormat
:@
"property_get -d %d -n %@", depth
, [property fullName
]];
146 [self recordCallback
:@selector(propertiesReceived
:) forTransaction
:tx
];
147 return [tx intValue
];
150 - (void)loadStackFrame
:(StackFrame
*)frame
155 NSNumber
* routingNumber
= [NSNumber numberWithInt
:frame.routingID
];
156 NSNumber
* transaction
= nil;
158 // Get the source code of the file. Escape % in URL chars.
159 if ([frame.filename length
]) {
160 NSString
* escapedFilename
= [frame.filename stringByReplacingOccurrencesOfString
:@
"%" withString
:@
"%%"];
161 transaction
= [connection_ sendCommandWithFormat
:@
"source -f %@", escapedFilename
];
162 [self recordCallback
:@selector(setSource
:) forTransaction
:transaction
];
163 [callbackContext_ setObject
:routingNumber forKey
:transaction
];
166 // Get the names of all the contexts.
167 transaction
= [connection_ sendCommandWithFormat
:@
"context_names -d %d", frame.index
];
168 [self recordCallback
:@selector(contextsReceived
:) forTransaction
:transaction
];
169 [callbackContext_ setObject
:routingNumber forKey
:transaction
];
171 // This frame will be fully loaded.
175 // Breakpoint Management ///////////////////////////////////////////////////////
176 #pragma mark Breakpoints
179 * Send an add breakpoint command
181 - (void)addBreakpoint
:(Breakpoint
*)bp
183 if (![connection_ connected
])
186 NSString
* file
= [connection_ escapedURIPath
:[bp transformedPath
]];
187 NSNumber
* tx
= [connection_ sendCommandWithFormat
:@
"breakpoint_set -t line -f %@ -n %i", file
, [bp line
]];
188 [self recordCallback
:@selector(breakpointReceived
:) forTransaction
:tx
];
189 [callbackContext_ setObject
:bp forKey
:tx
];
193 * Removes a breakpoint
195 - (void)removeBreakpoint
:(Breakpoint
*)bp
197 if (![connection_ connected
])
200 [connection_ sendCommandWithFormat
:@
"breakpoint_remove -d %i", [bp debuggerId
]];
203 // Specific Response Handlers //////////////////////////////////////////////////
204 #pragma mark Response Handlers
206 - (void)connectionDidAccept
:(NetworkConnection
*)cx
209 [connection_ sendCommandWithFormat
:@
"detach"];
212 - (void)errorEncountered
:(NSString
*)error
214 [delegate errorEncountered
:error
];
218 * Initial packet received. We've started a brand-new connection to the engine.
220 - (void)handleInitialResponse
:(NSXMLDocument
*)response
224 // Register any breakpoints that exist offline.
225 for (Breakpoint
* bp
in [[BreakpointManager sharedManager
] breakpoints
])
226 [self addBreakpoint
:bp
];
228 // Load the debugger to make it look active.
229 [delegate debuggerConnected
];
231 // TODO: update the status.
234 - (void)handleResponse
:(NSXMLDocument
*)response
236 NSInteger transactionID
= [connection_ transactionIDFromResponse
:response
];
237 NSNumber
* key
= [NSNumber numberWithInt
:transactionID
];
238 NSString
* callbackStr
= [callTable_ objectForKey
:key
];
241 SEL callback
= NSSelectorFromString(callbackStr
);
242 [self performSelector
:callback withObject
:response
];
244 [callTable_ removeObjectForKey
:key
];
248 * Receiver for status updates. This just freshens up the UI.
250 - (void)updateStatus
:(NSXMLDocument
*)response
252 self.status
= [[[[response rootElement
] attributeForName
:@
"status"] stringValue
] capitalizedString
];
254 if (!status ||
[status isEqualToString
:@
"Stopped"]) {
255 [delegate debuggerDisconnected
];
257 } else if ([status isEqualToString
:@
"Stopping"]) {
258 [connection_ sendCommandWithFormat
:@
"stop"];
264 * Step in/out/over and run all take this path. We first get the status of the
265 * debugger and then request fresh stack information.
267 - (void)debuggerStep
:(NSXMLDocument
*)response
269 [self updateStatus
:response
];
270 if (![self isConnected
])
273 // If this is the run command, tell the delegate that a bunch of updates
274 // are coming. Also remove all existing stack routes and request a new stack.
275 if ([delegate respondsToSelector
:@selector(clobberStack
)])
276 [delegate clobberStack
];
277 [stackFrames_ removeAllObjects
];
278 NSNumber
* tx
= [connection_ sendCommandWithFormat
:@
"stack_depth"];
279 [self recordCallback
:@selector(rebuildStack
:) forTransaction
:tx
];
280 stackFirstTransactionID_
= [tx intValue
];
284 * We ask for the stack_depth and now we clobber the stack and start rebuilding
287 - (void)rebuildStack
:(NSXMLDocument
*)response
289 NSInteger depth
= [[[[response rootElement
] attributeForName
:@
"depth"] stringValue
] intValue
];
291 if (stackFirstTransactionID_
== [connection_ transactionIDFromResponse
:response
])
294 // We now need to alloc a bunch of stack frames and get the basic information
296 for (NSInteger i
= 0; i
< depth
; i
++)
298 // Use the transaction ID to create a routing path.
299 NSNumber
* routingID
= [connection_ sendCommandWithFormat
:@
"stack_get -d %d", i
];
300 [self recordCallback
:@selector(getStackFrame
:) forTransaction
:routingID
];
301 [stackFrames_ setObject
:[[StackFrame
new] autorelease
] forKey
:routingID
];
306 * The initial rebuild of the stack frame. We now have enough to initialize
307 * a StackFrame object.
309 - (void)getStackFrame
:(NSXMLDocument
*)response
311 // Get the routing information.
312 NSInteger routingID
= [connection_ transactionIDFromResponse
:response
];
313 if (routingID
< stackFirstTransactionID_
)
315 NSNumber
* routingNumber
= [NSNumber numberWithInt
:routingID
];
317 // Make sure we initialized this frame in our last |-rebuildStack:|.
318 StackFrame
* frame
= [stackFrames_ objectForKey
:routingNumber
];
322 NSXMLElement
* xmlframe
= [[[response rootElement
] children
] objectAtIndex
:0];
324 // Initialize the stack frame.
325 frame.index
= [[[xmlframe attributeForName
:@
"level"] stringValue
] intValue
];
326 frame.filename
= [[xmlframe attributeForName
:@
"filename"] stringValue
];
327 frame.lineNumber
= [[[xmlframe attributeForName
:@
"lineno"] stringValue
] intValue
];
328 frame.function
= [[xmlframe attributeForName
:@
"where"] stringValue
];
329 frame.routingID
= routingID
;
331 // Only get the complete frame for the first level. The other frames will get
332 // information loaded lazily when the user clicks on one.
333 if (frame.index
== 0) {
334 [self loadStackFrame
:frame
];
337 if ([delegate respondsToSelector
:@selector(newStackFrame
:)])
338 [delegate newStackFrame
:frame
];
342 * Callback for setting the source of a file while rebuilding a specific stack
345 - (void)setSource
:(NSXMLDocument
*)response
347 NSNumber
* transaction
= [NSNumber numberWithInt
:[connection_ transactionIDFromResponse
:response
]];
348 if ([transaction intValue
] < stackFirstTransactionID_
)
350 NSNumber
* routingNumber
= [callbackContext_ objectForKey
:transaction
];
354 [callbackContext_ removeObjectForKey
:transaction
];
355 StackFrame
* frame
= [stackFrames_ objectForKey
:routingNumber
];
359 frame.source
= [[response rootElement
] base64DecodedValue
];
361 if ([delegate respondsToSelector
:@selector(sourceUpdated
:)])
362 [delegate sourceUpdated
:frame
];
366 * Enumerates all the contexts of a given stack frame. We then in turn get the
367 * contents of each one of these contexts.
369 - (void)contextsReceived
:(NSXMLDocument
*)response
371 // Get the stack frame's routing ID and use it again.
372 NSNumber
* receivedTransaction
= [NSNumber numberWithInt
:[connection_ transactionIDFromResponse
:response
]];
373 if ([receivedTransaction intValue
] < stackFirstTransactionID_
)
375 NSNumber
* routingID
= [callbackContext_ objectForKey
:receivedTransaction
];
379 // Get the stack frame by the |routingID|.
380 StackFrame
* frame
= [stackFrames_ objectForKey
:routingID
];
382 NSXMLElement
* contextNames
= [response rootElement
];
383 for (NSXMLElement
* context
in [contextNames children
])
385 NSInteger cid
= [[[context attributeForName
:@
"id"] stringValue
] intValue
];
387 // Fetch each context's variables.
388 NSNumber
* tx
= [connection_ sendCommandWithFormat
:@
"context_get -d %d -c %d", frame.index
, cid
];
389 [self recordCallback
:@selector(variablesReceived
:) forTransaction
:tx
];
390 [callbackContext_ setObject
:routingID forKey
:tx
];
395 * Receives the variables from the context and attaches them to the stack frame.
397 - (void)variablesReceived
:(NSXMLDocument
*)response
399 // Get the stack frame's routing ID and use it again.
400 NSInteger transaction
= [connection_ transactionIDFromResponse
:response
];
401 if (transaction
< stackFirstTransactionID_
)
403 NSNumber
* receivedTransaction
= [NSNumber numberWithInt
:transaction
];
404 NSNumber
* routingID
= [callbackContext_ objectForKey
:receivedTransaction
];
408 // Get the stack frame by the |routingID|.
409 StackFrame
* frame
= [stackFrames_ objectForKey
:routingID
];
411 NSMutableArray
* variables
= [NSMutableArray array
];
413 // Merge the frame's existing variables.
415 [variables addObjectsFromArray
:frame.variables
];
417 // Add these new variables.
418 NSArray
* addVariables
= [[response rootElement
] children
];
420 for (NSXMLElement
* elm
in addVariables
) {
421 VariableNode
* node
= [[VariableNode alloc
] initWithXMLNode
:elm
];
422 [variables addObject
:[node autorelease
]];
426 frame.variables
= variables
;
430 * Callback from a |-getProperty:| request.
432 - (void)propertiesReceived
:(NSXMLDocument
*)response
434 NSInteger transaction
= [connection_ transactionIDFromResponse
:response
];
438 <property> <!-- this is the one we requested -->
439 <property ... /> <!-- these are what we want -->
444 // Detach all the children so we can insert them into another document.
445 NSXMLElement
* parent
= (NSXMLElement
*)[[response rootElement
] childAtIndex
:0];
446 NSArray
* children
= [parent children
];
447 [parent setChildren
:nil];
449 [delegate receivedProperties
:children forTransaction
:transaction
];
453 * Callback for setting a breakpoint.
455 - (void)breakpointReceived
:(NSXMLDocument
*)response
457 NSNumber
* transaction
= [NSNumber numberWithInt
:[connection_ transactionIDFromResponse
:response
]];
458 Breakpoint
* bp
= [callbackContext_ objectForKey
:transaction
];
462 [callbackContext_ removeObjectForKey
:callbackContext_
];
463 [bp setDebuggerId
:[[[[response rootElement
] attributeForName
:@
"id"] stringValue
] intValue
]];
466 // Private /////////////////////////////////////////////////////////////////////
468 - (void)recordCallback
:(SEL)callback forTransaction
:(NSNumber
*)txn
470 [callTable_ setObject
:NSStringFromSelector(callback
) forKey
:txn
];