3 * Copyright (c) 2002 - 2007, 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 "DebuggerConnection.h"
18 #import "AppDelegate.h"
20 @interface DebuggerConnection (Private
)
22 - (NSString
*)createCommand
:(NSString
*)cmd
;
26 @implementation DebuggerConnection
29 * Creates a new DebuggerConnection and initializes the socket from the given connection
32 - (id)initWithPort
:(int)aPort session
:(NSString
*)aSession
34 if (self = [super init
])
37 session
= [aSession retain
];
40 windowController
= [[DebuggerWindowController alloc
] initWithConnection
:self];
41 [[windowController window
] makeKeyAndOrderFront
:self];
43 // now that we have our host information, open the socket
44 socket
= [[SocketWrapper alloc
] initWithPort
:port
];
45 [socket setDelegate
:self];
46 [windowController setStatus
:@
"Connecting"];
53 * This is a forwarded message from DebuggerWindowController that tells the connection to prepare to
56 - (void)windowDidClose
58 [[NSApp delegate
] unregisterConnection
:self];
62 * Releases all of the object's data members and closes the streams
68 [windowController release
];
74 * Gets the port number
82 * Gets the session name
90 * Returns the name of the remote host
92 - (NSString
*)remoteHost
96 return @
"(DISCONNECTED)";
98 return [socket remoteHost
];
102 * Returns whether or not we have an active connection
110 * SocketWrapper delegate method that is called whenever new data is received
112 - (void)dataReceived
:(NSData
*)response deliverTo
:(SEL)selector
114 NSXMLDocument
*doc
= [[NSXMLDocument alloc
] initWithData
:response options
:NSXMLDocumentTidyXML error
:nil];
116 // check and see if there's an error
117 NSArray
*error
= [[doc rootElement
] elementsForName
:@
"error"];
118 if ([error count
] > 0)
120 [windowController setError
:[[[[error objectAtIndex
:0] children
] objectAtIndex
:0] stringValue
]];
124 // if the caller of [_socket receive:] specified a deliverTo, just forward the message to them
127 [self performSelector
:selector withObject
:doc
];
134 * SocketWrapper delegate method that is called after data is sent. This really
135 * isn't useful for much.
137 - (void)dataSent
:(NSString
*)data
141 * Called by SocketWrapper after the connection is successful. This immediately calls
142 * -[SocketWrapper receive] to clear the way for communication
144 - (void)socketDidAccept
147 [socket receive
:@selector(handshake
:)];
151 * Receives errors from the SocketWrapper and updates the display
153 - (void)errorEncountered
:(NSError
*)error
155 [windowController setError
:[error domain
]];
159 * The initial packet handshake. This allows us to set things like the title of the window
160 * and glean information about hte server we are debugging
162 - (void)handshake
:(NSXMLDocument
*)doc
164 [self refreshStatus
];
168 * Handler used by dataReceived:deliverTo: for anytime the status command is issued. It sets
169 * the window controller's status text
171 - (void)updateStatus
:(NSXMLDocument
*)doc
173 NSString
*status
= [[[doc rootElement
] attributeForName
:@
"status"] stringValue
];
174 [windowController setStatus
:[status capitalizedString
]];
176 if ([status isEqualToString
:@
"break"])
178 [self updateStackTraceAndRegisters
];
183 * Tells the debugger to continue running the script
187 [socket send
:[self createCommand
:@
"run"]];
188 [self refreshStatus
];
192 * Method that runs tells the debugger to give us its status. This will call _updateStatus
193 * and will update the status text on the window
195 - (void)refreshStatus
197 [socket send
:[self createCommand
:@
"status"]];
198 [socket receive
:@selector(updateStatus
:)];
202 * Tells the debugger to step into the current command.
206 [socket send
:[self createCommand
:@
"step_into"]];
207 [socket receive
:nil];
208 [self refreshStatus
];
212 * Tells the debugger to step out of the current context
216 [socket send
:[self createCommand
:@
"step_out"]];
217 [socket receive
:nil];
218 [self refreshStatus
];
222 * Tells the debugger to step over the current function
226 [socket send
:[self createCommand
:@
"step_over"]];
227 [socket receive
:nil];
228 [self refreshStatus
];
232 * This function queries the debug server for the current stacktrace and all the registers on
233 * level one. If a user then tries to expand past level one... TOOD: HOLY CRAP WHAT DO WE DO PAST LEVEL 1?
235 - (void)updateStackTraceAndRegisters
237 [socket send
:[self createCommand
:@
"stack_get"]];
238 [socket receive
:@selector(stackReceived
:)];
240 [socket send
:[self createCommand
:@
"context_get"]];
241 [socket receive
:@selector(registerReceived
:)];
245 * Called by the dataReceived delivery delegate. This updates the window controller's data
246 * for the stack trace
248 - (void)stackReceived
:(NSXMLDocument
*)doc
250 NSArray
*children
= [[doc rootElement
] children
];
251 NSMutableArray
*stack
= [NSMutableArray array
];
252 NSMutableDictionary
*dict
= [NSMutableDictionary dictionary
];
253 for (int i
= 0; i
< [children count
]; i
++)
255 NSArray
*attrs
= [[children objectAtIndex
:i
] attributes
];
256 for (int j
= 0; j
< [attrs count
]; j
++)
258 [dict setValue
:[[attrs objectAtIndex
:j
] stringValue
] forKey
:[[attrs objectAtIndex
:j
] name
]];
260 [stack addObject
:dict
];
261 dict
= [NSMutableDictionary dictionary
];
263 [windowController setStack
:stack
];
267 * Called when we have a new register to display
269 - (void)registerReceived
:(NSXMLDocument
*)doc
271 [windowController setRegister
:doc
];
275 * Tells the debugger engine to get a specifc property. This also takes in the NSXMLElement
276 * that requested it so that the child can be attached in the delivery.
278 - (void)getProperty
:(NSString
*)property forElement
:(NSXMLElement
*)elm
280 [socket send
:[self createCommand
:[NSString stringWithFormat
:@
"property_get -n \"%@\"", property
]]];
281 depthFetchElement
= elm
;
282 [socket receive
:@selector(propertyReceived
:)];
286 * Called when a property is received. This then adds the result as children to the passed object
288 - (void)propertyReceived
:(NSXMLDocument
*)doc
292 <property> <!-- this is the one we requested -->
293 <property ... /> <!-- these are what we want -->
298 // we now have to detach all the children so we can insert them into another document
299 NSXMLElement
*parent
= (NSXMLElement
*)[[doc rootElement
] childAtIndex
:0];
300 NSArray
*children
= [parent children
];
301 [parent setChildren
:nil];
302 [windowController addChildren
:children toNode
:depthFetchElement
];
303 depthFetchElement
= nil;
307 * Helper method to create a string command with the -i <session> automatically tacked on
309 - (NSString
*)createCommand
:(NSString
*)cmd
311 return [NSString stringWithFormat
:@
"%@ -i %@", cmd
, session
];