3 * Copyright (c) 2007 - 2011, 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 "Breakpoint.h"
21 #import "DebuggerModel.h"
22 #import "NSXMLElementAdditions.h"
23 #import "StackFrame.h"
25 @implementation DebuggerBackEnd
{
26 // The connection to the debugger engine.
28 ProtocolClient
* _client
;
31 - (instancetype
)initWithModel
:(DebuggerModel
*)model
32 port
:(NSUInteger
)aPort
33 autoAttach
:(BOOL)doAttach
35 if (self = [super init
]) {
38 _client
= [[ProtocolClient alloc
] initWithDelegate
:self];
40 [self setAutoAttach
:doAttach
];
45 // Getters /////////////////////////////////////////////////////////////////////
49 * Gets the port number
56 * Sets the attached state of the debugger. This will open and close the
57 * connection as appropriate.
59 - (void)setAutoAttach
:(BOOL)flag
{
60 if (flag
== _autoAttach
)
71 // Commands ////////////////////////////////////////////////////////////////////
75 * Tells the debugger to continue running the script. Returns the current stack frame.
78 [_client sendCommandWithFormat
:@
"run" handler
:^
(NSXMLDocument
* message
) {
79 [self debuggerStep
:message
];
84 * Tells the debugger to step into the current command.
87 [_client sendCommandWithFormat
:@
"step_into" handler
:^
(NSXMLDocument
* message
) {
88 [self debuggerStep
:message
];
93 * Tells the debugger to step out of the current context
96 [_client sendCommandWithFormat
:@
"step_out" handler
:^
(NSXMLDocument
* message
) {
97 [self debuggerStep
:message
];
102 * Tells the debugger to step over the current function
105 [_client sendCommandWithFormat
:@
"step_over" handler
:^
(NSXMLDocument
* message
) {
106 [self debuggerStep
:message
];
111 * Halts execution of the script.
114 [_client disconnect
];
115 self.model.status
= @
"Stopped";
119 * Ends the current debugging session.
122 [_client sendCommandWithFormat
:@
"detach"];
123 self.model.status
= @
"Stopped";
126 - (void)loadStackFrame
:(StackFrame
*)frame
{
130 // Get the source code of the file. Escape % in URL chars.
131 if ([frame.filename length
]) {
132 ProtocolClientMessageHandler handler
= ^
(NSXMLDocument
* message
) {
133 frame.source
= [[message rootElement
] base64DecodedValue
];
135 [_client sendCommandWithFormat
:@
"source -f %@" handler
:handler
, frame.filename
];
138 // Get the names of all the contexts.
139 ProtocolClientMessageHandler handler
= ^
(NSXMLDocument
* message
) {
140 [self loadContexts
:message forFrame
:frame
];
142 [_client sendCommandWithFormat
:@
"context_names -d %d" handler
:handler
, frame.index
];
144 // This frame will be fully loaded.
148 - (void)loadVariableNode
:(VariableNode
*)variable
149 forStackFrame
:(StackFrame
*)frame
{
150 if (variable.children.count
== variable.childCount
)
153 [self loadVariableNode
:variable forStackFrame
:frame dataPage
:0 loadedData
:@
[]];
156 - (void)loadVariableNode
:(VariableNode
*)variable
157 forStackFrame
:(StackFrame
*)frame
158 dataPage
:(unsigned int)dataPage
159 loadedData
:(NSArray
*)loadedData
{
160 ProtocolClientMessageHandler handler
= ^
(NSXMLDocument
* message
) {
163 <property> <!-- this is the one we requested -->
164 <property ... /> <!-- these are what we want -->
169 // Detach all the children so we can insert them into another document.
170 NSXMLElement
* parent
= (NSXMLElement
*)[[message rootElement
] childAtIndex
:0];
171 NSArray
* children
= [parent children
];
172 [parent setChildren
:nil];
174 // Check to see if there are more children to load.
175 NSArray
* newLoadedData
= [loadedData arrayByAddingObjectsFromArray
:children
];
177 NSInteger totalChildren
= [[[parent attributeForName
:@
"numchildren"] stringValue
] integerValue
];
178 if ([newLoadedData count
] < (NSUInteger
)totalChildren
) {
179 [self loadVariableNode
:variable
181 dataPage
:dataPage
+ 1
182 loadedData
:newLoadedData
];
184 [variable setChildrenFromXMLChildren
:newLoadedData
];
187 [_client sendCommandWithFormat
:@
"property_get -d %d -n %@ -p %u" handler
:handler
, frame.index
, variable.fullName
, dataPage
];
190 // Breakpoint Management ///////////////////////////////////////////////////////
191 #pragma mark Breakpoints
194 * Send an add breakpoint command
196 - (void)addBreakpoint
:(Breakpoint
*)bp
{
197 if (!self.model.connected
)
200 ProtocolClientMessageHandler handler
= ^
(NSXMLDocument
* message
) {
201 [bp setDebuggerId
:[[[[message rootElement
] attributeForName
:@
"id"] stringValue
] intValue
]];
203 if (bp.type
== kBreakpointTypeFile
) {
204 NSString
* file
= [ProtocolClient escapedFilePathURI
:[bp transformedPath
]];
205 [_client sendCommandWithFormat
:@
"breakpoint_set -t line -f %@ -n %i" handler
:handler
, file
, [bp line
]];
206 } else if (bp.type
== kBreakpointTypeFunctionEntry
) {
207 [_client sendCommandWithFormat
:@
"breakpoint_set -t call -m %@" handler
:handler
, bp.functionName
];
212 * Removes a breakpoint
214 - (void)removeBreakpoint
:(Breakpoint
*)bp
{
215 if (!self.model.connected
)
218 [_client sendCommandWithFormat
:@
"breakpoint_remove -d %i", [bp debuggerId
]];
222 * Sends a string to be evaluated by the engine.
224 - (void)evalScript
:(NSString
*)str callback
:(void (^
)(NSString
*))callback
{
225 if (!self.model.connected
)
228 NSData
* stringData
= [str dataUsingEncoding
:NSUTF8StringEncoding
];
229 ProtocolClientMessageHandler handler
= ^
(NSXMLDocument
* message
) {
230 NSXMLElement
* parent
= (NSXMLElement
*)[[message rootElement
] childAtIndex
:0];
231 NSString
* value
= [parent base64DecodedValue
];
234 [_client sendCustomCommandWithFormat
:@
"eval -i {txn} -- %@"
235 handler
:handler
, [stringData base64EncodedStringWithOptions
:0]];
238 // Protocol Client Delegate ////////////////////////////////////////////////////
239 #pragma mark Protocol Client Delegate
241 - (void)debuggerEngineConnected
:(ProtocolClient
*)client
{
242 [_model onNewConnection
];
246 * Called when the connection is finally closed. This will reopen the listening
247 * socket if the debugger remains attached.
249 - (void)debuggerEngineDisconnected
:(ProtocolClient
*)client
{
250 [_model onDisconnect
];
256 - (void)protocolClient
:(ProtocolClient
*)client receivedInitialMessage
:(NSXMLDocument
*)message
{
257 [self handleInitialResponse
:message
];
260 - (void)protocolClient
:(ProtocolClient
*)client receivedErrorMessage
:(NSXMLDocument
*)message
{
261 NSArray
* error
= [[message rootElement
] elementsForName
:@
"error"];
262 if ([error count
] > 0) {
263 NSLog(@
"Xdebug error: %@", error
);
264 NSString
* errorMessage
= [[[[error objectAtIndex
:0] children
] objectAtIndex
:0] stringValue
];
265 _model.lastError
= errorMessage
;
269 // Specific Response Handlers //////////////////////////////////////////////////
270 #pragma mark Response Handlers
273 * Initial packet received. We've started a brand-new connection to the engine.
275 - (void)handleInitialResponse
:(NSXMLDocument
*)response
{
276 if (!self.autoAttach
) {
277 [_client sendCommandWithFormat
:@
"detach"];
281 // Register any breakpoints that exist offline.
282 for (Breakpoint
* bp
in self.model.breakpointManager.breakpoints
)
283 [self addBreakpoint
:bp
];
285 // TODO: update the status.
289 * Receiver for status updates. This just freshens up the UI.
291 - (void)updateStatus
:(NSXMLDocument
*)response
{
292 NSString
* status
= [[[[response rootElement
] attributeForName
:@
"status"] stringValue
] capitalizedString
];
293 self.model.status
= status
;
294 if (!status ||
[status isEqualToString
:@
"Stopped"]) {
295 [_model onDisconnect
];
296 } else if ([status isEqualToString
:@
"Stopping"]) {
297 [_client sendCommandWithFormat
:@
"stop"];
302 * Step in/out/over and run all take this path. We first get the status of the
303 * debugger and then request fresh stack information.
305 - (void)debuggerStep
:(NSXMLDocument
*)response
{
306 [self updateStatus
:response
];
307 if (!self.model.connected
)
310 [_client sendCommandWithFormat
:@
"stack_depth" handler
:^
(NSXMLDocument
* message
) {
311 [self rebuildStack
:message
];
316 * We ask for the stack_depth and now we clobber the stack and start rebuilding
319 - (void)rebuildStack
:(NSXMLDocument
*)response
{
320 NSUInteger depth
= [[[[response rootElement
] attributeForName
:@
"depth"] stringValue
] intValue
];
322 // Send a request to get each frame of the stack, which will be added to this
323 // array. When the final frame arrives, the |tempStack| is released.
324 __block NSMutableArray
* tempStack
= [[NSMutableArray alloc
] init
];
326 for (NSUInteger i
= 0; i
< depth
; ++i
) {
327 ProtocolClientMessageHandler handler
= ^
(NSXMLDocument
* message
) {
328 [tempStack addObject
:[self transformXMLToStackFrame
:message
]];
329 if (i
== depth
- 1) {
330 [self.model updateStack
:tempStack
];
333 [_client sendCommandWithFormat
:@
"stack_get -d %d" handler
:handler
, i
];
338 * Creates a StackFrame object from an NSXMLDocument response from the "stack_get"
341 - (StackFrame
*)transformXMLToStackFrame
:(NSXMLDocument
*)response
{
342 NSXMLElement
* xmlframe
= (NSXMLElement
*)[[[response rootElement
] children
] objectAtIndex
:0];
343 StackFrame
* frame
= [[StackFrame alloc
] init
];
344 frame.index
= [[[xmlframe attributeForName
:@
"level"] stringValue
] intValue
];
345 frame.filename
= [[xmlframe attributeForName
:@
"filename"] stringValue
];
346 frame.lineNumber
= [[[xmlframe attributeForName
:@
"lineno"] stringValue
] intValue
];
347 frame.function
= [[xmlframe attributeForName
:@
"where"] stringValue
];
352 * Enumerates all the contexts of a given stack frame. We then in turn get the
353 * contents of each one of these contexts.
355 - (void)loadContexts
:(NSXMLDocument
*)response forFrame
:(StackFrame
*)frame
{
356 NSXMLElement
* contextNames
= [response rootElement
];
357 for (NSXMLElement
* context
in [contextNames children
]) {
358 NSInteger cid
= [[[context attributeForName
:@
"id"] stringValue
] intValue
];
360 // Fetch each context's variables.
361 ProtocolClientMessageHandler handler
= ^
(NSXMLDocument
* message
) {
362 NSMutableArray
* variables
= [NSMutableArray array
];
364 // Merge the frame's existing variables.
366 [variables addObjectsFromArray
:frame.variables
];
368 // Add these new variables.
369 NSArray
* addVariables
= [[message rootElement
] children
];
371 for (NSXMLElement
* elm
in addVariables
) {
372 VariableNode
* node
= [[VariableNode alloc
] initWithXMLNode
:elm
];
373 [variables addObject
:node
];
377 frame.variables
= variables
;
379 [_client sendCommandWithFormat
:@
"context_get -d %d -c %d" handler
:handler
, frame.index
, cid
];
383 // Private /////////////////////////////////////////////////////////////////////
387 [_client connectOnPort
:_port
];
388 [_model onListeningOnPort
:_port
];