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"
19 @interface DebuggerConnection (Private
)
21 - (NSString
*)createCommand
: (NSString
*)cmd
;
25 @implementation DebuggerConnection
28 * Creates a new DebuggerConnection and initializes the socket from the given connection
31 - (id)initWithPort
: (int)port session
: (NSString
*)session
33 if (self = [super init
])
36 _session
= [session retain
];
39 _windowController
= [[DebuggerWindowController alloc
] initWithConnection
: self];
40 [[_windowController window
] makeKeyAndOrderFront
: self];
42 // now that we have our host information, open the socket
43 _socket
= [[SocketWrapper alloc
] initWithPort
: port
];
44 [_socket setDelegate
: self];
45 [_windowController setStatus
: @
"Connecting"];
48 // clean up after ourselves
49 [[NSNotificationCenter defaultCenter
] addObserver
: self
50 selector
: @selector(applicationWillTerminate
:)
51 name
: NSApplicationWillTerminateNotification
58 * Release ourselves when we're about to die
60 - (void)applicationWillTerminate
: (NSNotification
*)notif
66 * Releases all of the object's data members and closes the streams
77 * Gets the port number
85 * Gets the session name
93 * Returns the name of the remote host
95 - (NSString
*)remoteHost
99 return @
"(DISCONNECTED)";
101 return [_socket remoteHost
];
105 * Returns whether or not we have an active connection
113 * SocketWrapper delegate method that is called whenever new data is received
115 - (void)dataReceived
: (NSData
*)response deliverTo
: (SEL)selector
117 // if the caller of [_socket receive:] specified a deliverTo, just forward the message to them
120 [self performSelector
: selector withObject
: response
];
125 * SocketWrapper delegate method that is called after data is sent. This really
126 * isn't useful for much.
128 - (void)dataSent
: (NSString
*)data
130 NSLog(@
"send = %@", data
);
134 * Called by SocketWrapper after the connection is successful. This immediately calls
135 * -[SocketWrapper receive] to clear the way for communication
137 - (void)socketDidAccept
140 [_socket receive
: @selector(handshake
:)];
144 * Receives errors from the SocketWrapper and updates the display
146 - (void)errorEncountered
: (NSError
*)error
148 [_windowController setError
: [error domain
]];
152 * The initial packet handshake. This allows us to set things like the title of the window
153 * and glean information about hte server we are debugging
155 - (void)handshake
: (NSData
*)packet
157 [self refreshStatus
];
161 * Handler used by dataReceived:deliverTo: for anytime the status command is issued. It sets
162 * the window controller's status text
164 - (void)updateStatus
: (NSData
*)packet
166 NSXMLDocument
*doc
= [[NSXMLDocument alloc
] initWithData
: packet options
: NSXMLDocumentTidyXML error
: nil];
167 [_windowController setStatus
: [[[[doc rootElement
] attributeForName
: @
"status"] stringValue
] capitalizedString
]];
172 * Tells the debugger to continue running the script
176 [_socket send
: [self createCommand
: @
"run"]];
177 [self refreshStatus
];
181 * Method that runs tells the debugger to give us its status. This will call _updateStatus
182 * and will update the status text on the window
184 - (void)refreshStatus
186 [_socket send
: [self createCommand
: @
"status"]];
187 [_socket receive
: @selector(updateStatus
:)];
191 * Tells the debugger to step into the current command.
195 [_socket send
: [self createCommand
: @
"step_into"]];
196 [_socket receive
: nil];
197 [self refreshStatus
];
198 [self updateStackTraceAndRegisters
];
202 * Tells the debugger to step out of the current context
206 [_socket send
: [self createCommand
: @
"step_out"]];
207 [_socket receive
: nil];
208 [self refreshStatus
];
209 [self updateStackTraceAndRegisters
];
213 * Tells the debugger to step over the current function
217 [_socket send
: [self createCommand
: @
"step_over"]];
218 [_socket receive
: nil];
219 [self refreshStatus
];
220 [self updateStackTraceAndRegisters
];
224 * This function queries the debug server for the current stacktrace and all the registers on
225 * level one. If a user then tries to expand past level one... TOOD: HOLY CRAP WHAT DO WE DO PAST LEVEL 1?
227 - (void)updateStackTraceAndRegisters
229 [_socket send
: [self createCommand
: @
"stack_get"]];
230 [_socket receive
: @selector(stackReceived
:)];
232 [_socket send
: [self createCommand
: @
"context_get"]];
233 [_socket receive
: @selector(registerReceived
:)];
237 * Called by the dataReceived delivery delegate. This updates the window controller's data
238 * for the stack trace
240 - (void)stackReceived
: (NSData
*)packet
242 NSXMLDocument
*doc
= [[NSXMLDocument alloc
] initWithData
: packet options
: NSXMLDocumentTidyXML error
: nil];
243 NSArray
*children
= [[doc rootElement
] children
];
244 NSMutableArray
*stack
= [NSMutableArray array
];
245 NSMutableDictionary
*dict
= [NSMutableDictionary dictionary
];
246 for (int i
= 0; i
< [children count
]; i
++)
248 NSArray
*attrs
= [[children objectAtIndex
: i
] attributes
];
249 for (int j
= 0; j
< [attrs count
]; j
++)
251 [dict setValue
: [[attrs objectAtIndex
: j
] stringValue
] forKey
: [[attrs objectAtIndex
: j
] name
]];
253 [stack addObject
: dict
];
254 dict
= [NSMutableDictionary dictionary
];
256 [_windowController setStack
: stack
];
261 * Called when we have a new register to display
263 - (void)registerReceived
: (NSData
*)packet
265 NSXMLDocument
*doc
= [[NSXMLDocument alloc
] initWithData
: packet options
: NSXMLDocumentTidyXML error
: nil];
266 [_windowController setRegister
: [doc rootElement
]];
271 * Tells the debugger engine to get a specifc property. This also takes in the NSXMLElement
272 * that requested it so that the child can be attached in the delivery.
274 - (void)getProperty
: (NSString
*)property forElement
: (NSXMLElement
*)elm
276 [_socket send
: [self createCommand
: [NSString stringWithFormat
: @
"property_get -n \"%@\"", property
]]];
277 _depthFetchElement
= elm
;
278 [_socket receive
: @selector(propertyReceived
:)];
282 * Called when a property is received. This then adds the result as children to the passed object
284 - (void)propertyReceived
: (NSData
*)packet
286 NSXMLDocument
*doc
= [[NSXMLDocument alloc
] initWithData
: packet options
: NSXMLDocumentTidyXML error
: nil];
289 <property> <!-- this is the one we requested -->
290 <property ... /> <!-- these are what we want -->
295 // we now have to detach all the children so we can insert them into another document
296 NSXMLElement
*parent
= [[doc rootElement
] childAtIndex
: 0];
297 NSArray
*children
= [parent children
];
298 [parent setChildren
: nil];
299 [_windowController addChildren
: children toNode
: _depthFetchElement
];
300 _depthFetchElement
= nil;
305 * Helper method to create a string command with the -i <session> automatically tacked on
307 - (NSString
*)createCommand
: (NSString
*)cmd
309 return [NSString stringWithFormat
: @
"%@ -i %@", cmd
, _session
];