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 "DebuggerProcessor.h"
19 #import "AppDelegate.h"
21 // GDBpConnection (Private) ////////////////////////////////////////////////////
23 @interface DebuggerProcessor ()
24 @property (readwrite
, copy
) NSString
* status
;
26 - (void)recordCallback
:(SEL)callback forTransaction
:(NSNumber
*)txn
;
28 - (void)updateStatus
:(NSXMLDocument
*)response
;
29 - (void)debuggerStep
:(NSXMLDocument
*)response
;
30 - (void)rebuildStack
:(NSXMLDocument
*)response
;
31 - (void)getStackFrame
:(NSXMLDocument
*)response
;
32 - (void)setSource
:(NSXMLDocument
*)response
;
33 - (void)contextsReceived
:(NSXMLDocument
*)response
;
34 - (void)variablesReceived
:(NSXMLDocument
*)response
;
35 - (void)propertiesReceived
:(NSXMLDocument
*)response
;
39 // GDBpConnection //////////////////////////////////////////////////////////////
41 @implementation DebuggerProcessor
47 * Creates a new DebuggerConnection and initializes the socket from the given connection
50 - (id)initWithPort
:(NSUInteger
)aPort
52 if (self = [super init
])
54 stackFrames_
= [[NSMutableDictionary alloc
] init
];
55 callbackContext_
= [NSMutableDictionary
new];
56 callTable_
= [NSMutableDictionary
new];
58 [[BreakpointManager sharedManager
] setConnection
:self];
59 connection_
= [[DebuggerConnection alloc
] initWithPort
:aPort
];
60 connection_.delegate
= self;
61 [connection_ connect
];
67 * Deallocates the object
72 [stackFrames_ release
];
74 [callbackContext_ release
];
79 // Getters /////////////////////////////////////////////////////////////////////
83 * Gets the port number
87 return [connection_ port
];
91 * Returns the name of the remote host
93 - (NSString
*)remoteHost
95 if (![connection_ connected
])
96 return @
"(DISCONNECTED)";
98 // TODO: Either impl or remove.
103 * Returns whether or not we have an active connection
107 return [connection_ connected
];
110 // Commands ////////////////////////////////////////////////////////////////////
111 #pragma mark Commands
114 * Reestablishes communication with the remote debugger so that a new connection doesn't have to be
115 * created every time you want to debug a page
120 self.status
= @
"Connecting";
121 [connection_ connect
];
125 * Tells the debugger to continue running the script. Returns the current stack frame.
129 NSNumber
* tx
= [connection_ sendCommandWithFormat
:@
"run"];
130 [self recordCallback
:@selector(debuggerStep
:) forTransaction
:tx
];
134 * Tells the debugger to step into the current command.
138 NSNumber
* tx
= [connection_ sendCommandWithFormat
:@
"step_into"];
139 [self recordCallback
:@selector(debuggerStep
:) forTransaction
:tx
];
143 * Tells the debugger to step out of the current context
147 NSNumber
* tx
= [connection_ sendCommandWithFormat
:@
"step_out"];
148 [self recordCallback
:@selector(debuggerStep
:) forTransaction
:tx
];
152 * Tells the debugger to step over the current function
156 NSNumber
* tx
= [connection_ sendCommandWithFormat
:@
"step_over"];
157 [self recordCallback
:@selector(debuggerStep
:) forTransaction
:tx
];
161 * Tells the debugger engine to get a specifc property. This also takes in the NSXMLElement
162 * that requested it so that the child can be attached.
164 - (NSInteger
)getProperty
:(NSString
*)property
166 NSNumber
* tx
= [connection_ sendCommandWithFormat
:@
"property_get -n \"%@\"", property
];
167 [self recordCallback
:@selector(propertiesReceived
:) forTransaction
:tx
];
170 - (void)loadStackFrame
:(StackFrame
*)frame
175 NSNumber
* routingNumber
= [NSNumber numberWithInt
:frame.routingID
];
177 // Get the source code of the file. Escape % in URL chars.
178 NSString
* escapedFilename
= [frame.filename stringByReplacingOccurrencesOfString
:@
"%" withString
:@
"%%"];
179 NSNumber
* transaction
= [connection_ sendCommandWithFormat
:@
"source -f %@", escapedFilename
];
180 [self recordCallback
:@selector(setSource
:) forTransaction
:transaction
];
181 [callbackContext_ setObject
:routingNumber forKey
:transaction
];
183 // Get the names of all the contexts.
184 transaction
= [connection_ sendCommandWithFormat
:@
"context_names -d %d", frame.index
];
185 [self recordCallback
:@selector(contextsReceived
:) forTransaction
:transaction
];
186 [callbackContext_ setObject
:routingNumber forKey
:transaction
];
188 // This frame will be fully loaded.
192 // Breakpoint Management ///////////////////////////////////////////////////////
193 #pragma mark Breakpoints
196 * Send an add breakpoint command
198 - (void)addBreakpoint
:(Breakpoint
*)bp
200 if (![connection_ connected
])
203 NSString
* file
= [connection_ escapedURIPath
:[bp transformedPath
]];
204 NSNumber
* tx
= [connection_ sendCommandWithFormat
:@
"breakpoint_set -t line -f %@ -n %i", file
, [bp line
]];
205 [self recordCallback
:@selector(breakpointReceived
:) forTransaction
:tx
];
206 [callbackContext_ setObject
:bp forKey
:tx
];
210 * Removes a breakpoint
212 - (void)removeBreakpoint
:(Breakpoint
*)bp
214 if (![connection_ connected
])
217 [connection_ sendCommandWithFormat
:@
"breakpoint_remove -d %i", [bp debuggerId
]];
220 // Specific Response Handlers //////////////////////////////////////////////////
221 #pragma mark Response Handlers
224 * Initial packet received. We've started a brand-new connection to the engine.
226 - (void)handleInitialResponse
:(NSXMLDocument
*)response
228 // Register any breakpoints that exist offline.
229 for (Breakpoint
* bp
in [[BreakpointManager sharedManager
] breakpoints
])
230 [self addBreakpoint
:bp
];
232 // Load the debugger to make it look active.
233 [delegate debuggerConnected
];
235 // TODO: update the status.
238 - (void)handleResponse
:(NSXMLDocument
*)response
240 NSInteger transactionID
= [connection_ transactionIDFromResponse
:response
];
241 NSNumber
* key
= [NSNumber numberWithInt
:transactionID
];
242 NSString
* callbackStr
= [callTable_ objectForKey
:key
];
245 SEL callback
= NSSelectorFromString(callbackStr
);
246 [self performSelector
:callback withObject
:response
];
248 [callTable_ removeObjectForKey
:key
];
252 * Receiver for status updates. This just freshens up the UI.
254 - (void)updateStatus
:(NSXMLDocument
*)response
256 self.status
= [[[[response rootElement
] attributeForName
:@
"status"] stringValue
] capitalizedString
];
257 if (status
== nil ||
[status isEqualToString
:@
"Stopped"] ||
[status isEqualToString
:@
"Stopping"])
260 [delegate debuggerDisconnected
];
262 self.status
= @
"Stopped";
267 * Step in/out/over and run all take this path. We first get the status of the
268 * debugger and then request fresh stack information.
270 - (void)debuggerStep
:(NSXMLDocument
*)response
272 [self updateStatus
:response
];
273 if (![connection_ connected
])
276 // If this is the run command, tell the delegate that a bunch of updates
277 // are coming. Also remove all existing stack routes and request a new stack.
278 // TODO: figure out if we can not clobber the stack every time.
279 NSString
* command
= [[[response rootElement
] attributeForName
:@
"command"] stringValue
];
280 if (YES ||
[command isEqualToString
:@
"run"])
282 if ([delegate respondsToSelector
:@selector(clobberStack
)])
283 [delegate clobberStack
];
284 [stackFrames_ removeAllObjects
];
285 NSNumber
* tx
= [connection_ sendCommandWithFormat
:@
"stack_depth"];
286 [self recordCallback
:@selector(rebuildStack
:) forTransaction
:tx
];
287 stackFirstTransactionID_
= [tx intValue
];
292 * We ask for the stack_depth and now we clobber the stack and start rebuilding
295 - (void)rebuildStack
:(NSXMLDocument
*)response
297 NSInteger depth
= [[[[response rootElement
] attributeForName
:@
"depth"] stringValue
] intValue
];
299 if (stackFirstTransactionID_
== [connection_ transactionIDFromResponse
:response
])
302 // We now need to alloc a bunch of stack frames and get the basic information
304 for (NSInteger i
= 0; i
< depth
; i
++)
306 // Use the transaction ID to create a routing path.
307 NSNumber
* routingID
= [connection_ sendCommandWithFormat
:@
"stack_get -d %d", i
];
308 [self recordCallback
:@selector(getStackFrame
:) forTransaction
:routingID
];
309 [stackFrames_ setObject
:[[StackFrame
new] autorelease
] forKey
:routingID
];
314 * The initial rebuild of the stack frame. We now have enough to initialize
315 * a StackFrame object.
317 - (void)getStackFrame
:(NSXMLDocument
*)response
319 // Get the routing information.
320 NSInteger routingID
= [connection_ transactionIDFromResponse
:response
];
321 if (routingID
< stackFirstTransactionID_
)
323 NSNumber
* routingNumber
= [NSNumber numberWithInt
:routingID
];
325 // Make sure we initialized this frame in our last |-rebuildStack:|.
326 StackFrame
* frame
= [stackFrames_ objectForKey
:routingNumber
];
330 NSXMLElement
* xmlframe
= [[[response rootElement
] children
] objectAtIndex
:0];
332 // Initialize the stack frame.
333 frame.index
= [[[xmlframe attributeForName
:@
"level"] stringValue
] intValue
];
334 frame.filename
= [[xmlframe attributeForName
:@
"filename"] stringValue
];
335 frame.lineNumber
= [[[xmlframe attributeForName
:@
"lineno"] stringValue
] intValue
];
336 frame.function
= [[xmlframe attributeForName
:@
"where"] stringValue
];
337 frame.routingID
= routingID
;
339 // Only get the complete frame for the first level. The other frames will get
340 // information loaded lazily when the user clicks on one.
341 if (frame.index
== 0) {
342 [self loadStackFrame
:frame
];
345 if ([delegate respondsToSelector
:@selector(newStackFrame
:)])
346 [delegate newStackFrame
:frame
];
350 * Callback for setting the source of a file while rebuilding a specific stack
353 - (void)setSource
:(NSXMLDocument
*)response
355 NSNumber
* transaction
= [NSNumber numberWithInt
:[connection_ transactionIDFromResponse
:response
]];
356 if ([transaction intValue
] < stackFirstTransactionID_
)
358 NSNumber
* routingNumber
= [callbackContext_ objectForKey
:transaction
];
362 [callbackContext_ removeObjectForKey
:transaction
];
363 StackFrame
* frame
= [stackFrames_ objectForKey
:routingNumber
];
367 frame.source
= [[response rootElement
] value
];
369 if ([delegate respondsToSelector
:@selector(sourceUpdated
:)])
370 [delegate sourceUpdated
:frame
];
374 * Enumerates all the contexts of a given stack frame. We then in turn get the
375 * contents of each one of these contexts.
377 - (void)contextsReceived
:(NSXMLDocument
*)response
379 // Get the stack frame's routing ID and use it again.
380 NSNumber
* receivedTransaction
= [NSNumber numberWithInt
:[connection_ transactionIDFromResponse
:response
]];
381 if ([receivedTransaction intValue
] < stackFirstTransactionID_
)
383 NSNumber
* routingID
= [callbackContext_ objectForKey
:receivedTransaction
];
387 // Get the stack frame by the |routingID|.
388 StackFrame
* frame
= [stackFrames_ objectForKey
:routingID
];
390 NSXMLElement
* contextNames
= [response rootElement
];
391 for (NSXMLElement
* context
in [contextNames children
])
393 NSInteger cid
= [[[context attributeForName
:@
"id"] stringValue
] intValue
];
395 // Fetch each context's variables.
396 NSNumber
* tx
= [connection_ sendCommandWithFormat
:@
"context_get -d %d -c %d", frame.index
, cid
];
397 [self recordCallback
:@selector(variablesReceived
:) forTransaction
:tx
];
398 [callbackContext_ setObject
:routingID forKey
:tx
];
403 * Receives the variables from the context and attaches them to the stack frame.
405 - (void)variablesReceived
:(NSXMLDocument
*)response
407 // Get the stack frame's routing ID and use it again.
408 NSInteger transaction
= [connection_ transactionIDFromResponse
:response
];
409 if (transaction
< stackFirstTransactionID_
)
411 NSNumber
* receivedTransaction
= [NSNumber numberWithInt
:transaction
];
412 NSNumber
* routingID
= [callbackContext_ objectForKey
:receivedTransaction
];
416 // Get the stack frame by the |routingID|.
417 StackFrame
* frame
= [stackFrames_ objectForKey
:routingID
];
419 NSMutableArray
* variables
= [NSMutableArray array
];
421 // Merge the frame's existing variables.
423 [variables addObjectsFromArray
:frame.variables
];
425 // Add these new variables.
426 NSArray
* addVariables
= [[response rootElement
] children
];
428 [variables addObjectsFromArray
:addVariables
];
430 frame.variables
= variables
;
434 * Callback from a |-getProperty:| request.
436 - (void)propertiesReceived
:(NSXMLDocument
*)response
438 NSInteger transaction
= [connection_ transactionIDFromResponse
:response
];
442 <property> <!-- this is the one we requested -->
443 <property ... /> <!-- these are what we want -->
448 // Detach all the children so we can insert them into another document.
449 NSXMLElement
* parent
= (NSXMLElement
*)[[response rootElement
] childAtIndex
:0];
450 NSArray
* children
= [parent children
];
451 [parent setChildren
:nil];
453 [delegate receivedProperties
:children forTransaction
:transaction
];
457 * Callback for setting a breakpoint.
459 - (void)breakpointReceived
:(NSXMLDocument
*)response
461 NSNumber
* transaction
= [NSNumber numberWithInt
:[connection_ transactionIDFromResponse
:response
]];
462 Breakpoint
* bp
= [callbackContext_ objectForKey
:transaction
];
466 [callbackContext_ removeObjectForKey
:callbackContext_
];
467 [bp setDebuggerId
:[[[[response rootElement
] attributeForName
:@
"id"] stringValue
] intValue
]];
470 // Private /////////////////////////////////////////////////////////////////////
472 - (void)recordCallback
:(SEL)callback forTransaction
:(NSNumber
*)txn
474 [callTable_ setObject
:NSStringFromSelector(callback
) forKey
:txn
];