3 * Copyright (c) 2007 - 2008, 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 "GDBpConnection.h"
18 #import "AppDelegate.h"
20 NSString
*kErrorOccurredNotif
= @
"GDBpConnection_ErrorOccured_Notification";
22 @interface GDBpConnection()
23 @property(readwrite
, copy
) NSString
*status
;
25 - (NSString
*)createCommand
:(NSString
*)cmd
;
26 - (NSXMLDocument
*)processData
:(NSString
*)data
;
27 - (StackFrame
*)createStackFrame
;
31 @implementation GDBpConnection
33 @synthesize socket
, status
;
36 * Creates a new DebuggerConnection and initializes the socket from the given connection
39 - (id)initWithPort
:(int)aPort session
:(NSString
*)aSession
;
41 if (self = [super init
])
44 session
= [aSession retain
];
47 // now that we have our host information, open the socket
48 socket
= [[SocketWrapper alloc
] initWithConnection
:self];
49 [socket setDelegate
:self];
52 self.status
= @
"Connecting";
54 [[BreakpointManager sharedManager
] setConnection
:self];
60 * Deallocates the object
70 * Gets the port number
78 * Gets the session name
86 * Returns the name of the remote host
88 - (NSString
*)remoteHost
92 return @
"(DISCONNECTED)";
94 return [socket remoteHost
];
98 * Returns whether or not we have an active connection
106 * Called by SocketWrapper after the connection is successful. This immediately calls
107 * -[SocketWrapper receive] to clear the way for communication, though the information
108 * could be useful server information that we don't use right now.
110 - (void)socketDidAccept
:(id)obj
116 // register any breakpoints that exist offline
117 for (Breakpoint
*bp
in [[BreakpointManager sharedManager
] breakpoints
])
119 [self addBreakpoint
:bp
];
124 * Receives errors from the SocketWrapper and updates the display
126 - (void)errorEncountered
:(NSString
*)error
128 [[NSNotificationCenter defaultCenter
]
129 postNotificationName
:kErrorOccurredNotif
131 userInfo
:[NSDictionary
132 dictionaryWithObject
:error
139 * Reestablishes communication with the remote debugger so that a new connection doesn't have to be
140 * created every time you want to debug a page
145 self.status
= @
"Connecting";
150 * Tells the debugger to continue running the script
154 [socket send
:[self createCommand
:@
"run"]];
160 * Tells the debugger to step into the current command.
162 - (StackFrame
*)stepIn
164 [socket send
:[self createCommand
:@
"step_into"]];
167 StackFrame
*frame
= [self createStackFrame
];
174 * Tells the debugger to step out of the current context
176 - (StackFrame
*)stepOut
178 [socket send
:[self createCommand
:@
"step_out"]];
181 StackFrame
*frame
= [self createStackFrame
];
188 * Tells the debugger to step over the current function
190 - (StackFrame
*)stepOver
192 [socket send
:[self createCommand
:@
"step_over"]];
195 StackFrame
*frame
= [self createStackFrame
];
202 * Tells the debugger engine to get a specifc property. This also takes in the NSXMLElement
203 * that requested it so that the child can be attached.
205 - (NSArray
*)getProperty
:(NSString
*)property
207 [socket send
:[self createCommand
:[NSString stringWithFormat
:@
"property_get -n \"%@\"", property
]]];
209 NSXMLDocument
*doc
= [self processData
:[socket receive
]];
213 <property> <!-- this is the one we requested -->
214 <property ... /> <!-- these are what we want -->
219 // we now have to detach all the children so we can insert them into another document
220 NSXMLElement
*parent
= (NSXMLElement
*)[[doc rootElement
] childAtIndex
:0];
221 NSArray
*children
= [parent children
];
222 [parent setChildren
:nil];
226 #pragma mark Breakpoints
229 * Send an add breakpoint command
231 - (void)addBreakpoint
:(Breakpoint
*)bp
238 NSString
*cmd
= [self createCommand
:[NSString stringWithFormat
:@
"breakpoint_set -t line -f %@ -n %i", [bp file
], [bp line
]]];
240 NSXMLDocument
*info
= [self processData
:[socket receive
]];
241 [bp setDebuggerId
:[[[[info rootElement
] attributeForName
:@
"id"] stringValue
] intValue
]];
245 * Removes a breakpoint
247 - (void)removeBreakpoint
:(Breakpoint
*)bp
254 [socket send
:[self createCommand
:[NSString stringWithFormat
:@
"breakpoint_remove -d %i", [bp debuggerId
]]]];
261 * Helper method to create a string command with the -i <session> automatically tacked on
263 - (NSString
*)createCommand
:(NSString
*)cmd
265 return [NSString stringWithFormat
:@
"%@ -i %@", cmd
, session
];
269 * Helper function to parse the NSData into an NSXMLDocument
271 - (NSXMLDocument
*)processData
:(NSString
*)data
273 NSError
*parseError
= nil;
274 NSXMLDocument
*doc
= [[NSXMLDocument alloc
] initWithXMLString
:data options
:0 error
:&parseError
];
277 NSLog(@
"Could not parse XML? --- %@", parseError
);
278 NSLog(@
"Error UserInfo: %@", [parseError userInfo
]);
279 NSLog(@
"This is the XML Document: %@", data
);
283 // check and see if there's an error
284 NSArray
*error
= [[doc rootElement
] elementsForName
:@
"error"];
285 if ([error count
] > 0)
287 [self errorEncountered
:[[[[error objectAtIndex
:0] children
] objectAtIndex
:0] stringValue
]];
291 return [doc autorelease
];
295 * Creates a StackFrame based on the current position in the debugger
297 - (StackFrame
*)createStackFrame
299 // get the stack frame
300 [socket send
:[self createCommand
:@
"stack_get -d 0"]];
301 NSXMLDocument
*doc
= [self processData
:[socket receive
]];
303 // get the names of all the contexts
304 [socket send
:[self createCommand
:@
"context_names -d 0"]];
305 NSXMLElement
*contextNames
= [[self processData
:[socket receive
]] rootElement
];
306 NSMutableDictionary
*contexts
= [NSMutableDictionary dictionary
];
307 for (NSXMLElement
*context
in [contextNames children
])
309 NSString
*name
= [[context attributeForName
:@
"name"] stringValue
];
310 int cid
= [[[context attributeForName
:@
"id"] stringValue
] intValue
];
312 // fetch the contexts
313 [socket send
:[self createCommand
:[NSString stringWithFormat
:@
"context_get -d 0 -c %d", cid
]]];
314 NSArray
*variables
= [[[self processData
:[socket receive
]] rootElement
] children
];
315 if (variables
!= nil && name
!= nil)
316 [contexts setObject
:variables forKey
:name
];
319 NSXMLElement
*xmlframe
= [[[doc rootElement
] children
] objectAtIndex
:0];
320 StackFrame
*frame
= [[StackFrame alloc
]
322 withFilename
:[[xmlframe attributeForName
:@
"filename"] stringValue
]
324 atLine
:[[[xmlframe attributeForName
:@
"lineno"] stringValue
] intValue
]
325 inFunction
:[[xmlframe attributeForName
:@
"where"] stringValue
]
326 withContexts
:contexts
329 return [frame autorelease
];
333 * Fetches the value of and sets the status instance variable
337 [socket send
:[self createCommand
:@
"status"]];
338 NSXMLDocument
*doc
= [self processData
:[socket receive
]];
339 self.status
= [[[[doc rootElement
] attributeForName
:@
"status"] stringValue
] capitalizedString
];
341 if ([status isEqualToString
:@
"Stopped"] ||
[status isEqualToString
:@
"Stopping"])
345 self.status
= @
"Stopped";