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 [[BreakpointManager sharedManager
] setConnection
:self];
58 * Deallocates the object
68 * Gets the port number
76 * Gets the session name
84 * Returns the name of the remote host
86 - (NSString
*)remoteHost
90 return @
"(DISCONNECTED)";
92 return [socket remoteHost
];
96 * Returns whether or not we have an active connection
104 * Called by SocketWrapper after the connection is successful. This immediately calls
105 * -[SocketWrapper receive] to clear the way for communication, though the information
106 * could be useful server information that we don't use right now.
108 - (void)socketDidAccept
:(id)obj
114 // register any breakpoints that exist offline
115 for (Breakpoint
*bp
in [[BreakpointManager sharedManager
] breakpoints
])
117 [self addBreakpoint
:bp
];
122 * Receives errors from the SocketWrapper and updates the display
124 - (void)errorEncountered
:(NSString
*)error
126 [[NSNotificationCenter defaultCenter
]
127 postNotificationName
:kErrorOccurredNotif
129 userInfo
:[NSDictionary
130 dictionaryWithObject
:error
137 * Reestablishes communication with the remote debugger so that a new connection doesn't have to be
138 * created every time you want to debug a page
143 self.status
= @
"Connecting";
148 * Tells the debugger to continue running the script
152 [socket send
:[self createCommand
:@
"run"]];
158 * Tells the debugger to step into the current command.
160 - (StackFrame
*)stepIn
162 [socket send
:[self createCommand
:@
"step_into"]];
165 StackFrame
*frame
= [self createStackFrame
];
172 * Tells the debugger to step out of the current context
174 - (StackFrame
*)stepOut
176 [socket send
:[self createCommand
:@
"step_out"]];
179 StackFrame
*frame
= [self createStackFrame
];
186 * Tells the debugger to step over the current function
188 - (StackFrame
*)stepOver
190 [socket send
:[self createCommand
:@
"step_over"]];
193 StackFrame
*frame
= [self createStackFrame
];
200 * Tells the debugger engine to get a specifc property. This also takes in the NSXMLElement
201 * that requested it so that the child can be attached.
203 - (NSArray
*)getProperty
:(NSString
*)property
205 [socket send
:[self createCommand
:[NSString stringWithFormat
:@
"property_get -n \"%@\"", property
]]];
207 NSXMLDocument
*doc
= [self processData
:[socket receive
]];
211 <property> <!-- this is the one we requested -->
212 <property ... /> <!-- these are what we want -->
217 // we now have to detach all the children so we can insert them into another document
218 NSXMLElement
*parent
= (NSXMLElement
*)[[doc rootElement
] childAtIndex
:0];
219 NSArray
*children
= [parent children
];
220 [parent setChildren
:nil];
224 #pragma mark Breakpoints
227 * Send an add breakpoint command
229 - (void)addBreakpoint
:(Breakpoint
*)bp
236 NSString
*cmd
= [self createCommand
:[NSString stringWithFormat
:@
"breakpoint_set -t line -f %@ -n %i", [bp file
], [bp line
]]];
238 NSXMLDocument
*info
= [self processData
:[socket receive
]];
239 [bp setDebuggerId
:[[[[info rootElement
] attributeForName
:@
"id"] stringValue
] intValue
]];
243 * Removes a breakpoint
245 - (void)removeBreakpoint
:(Breakpoint
*)bp
252 [socket send
:[self createCommand
:[NSString stringWithFormat
:@
"breakpoint_remove -d %i", [bp debuggerId
]]]];
259 * Helper method to create a string command with the -i <session> automatically tacked on
261 - (NSString
*)createCommand
:(NSString
*)cmd
263 return [NSString stringWithFormat
:@
"%@ -i %@", cmd
, session
];
267 * Helper function to parse the NSData into an NSXMLDocument
269 - (NSXMLDocument
*)processData
:(NSString
*)data
271 NSError
*parseError
= nil;
272 NSXMLDocument
*doc
= [[NSXMLDocument alloc
] initWithXMLString
:data options
:0 error
:&parseError
];
275 NSLog(@
"Could not parse XML? --- %@", parseError
);
276 NSLog(@
"Error UserInfo: %@", [parseError userInfo
]);
277 NSLog(@
"This is the XML Document: %@", data
);
281 // check and see if there's an error
282 NSArray
*error
= [[doc rootElement
] elementsForName
:@
"error"];
283 if ([error count
] > 0)
285 [self errorEncountered
:[[[[error objectAtIndex
:0] children
] objectAtIndex
:0] stringValue
]];
289 return [doc autorelease
];
293 * Creates a StackFrame based on the current position in the debugger
295 - (StackFrame
*)createStackFrame
297 // get the stack frame
298 [socket send
:[self createCommand
:@
"stack_get -d 0"]];
299 NSXMLDocument
*doc
= [self processData
:[socket receive
]];
301 // get the names of all the contexts
302 [socket send
:[self createCommand
:@
"context_names -d 0"]];
303 NSXMLElement
*contextNames
= [[self processData
:[socket receive
]] rootElement
];
304 NSMutableDictionary
*contexts
= [NSMutableDictionary dictionary
];
305 for (NSXMLElement
*context
in [contextNames children
])
307 NSString
*name
= [[context attributeForName
:@
"name"] stringValue
];
308 int cid
= [[[context attributeForName
:@
"id"] stringValue
] intValue
];
310 // fetch the contexts
311 [socket send
:[self createCommand
:[NSString stringWithFormat
:@
"context_get -d 0 -c %d", cid
]]];
312 NSArray
*variables
= [[[self processData
:[socket receive
]] rootElement
] children
];
313 if (variables
!= nil && name
!= nil)
314 [contexts setObject
:variables forKey
:name
];
317 NSXMLElement
*xmlframe
= [[[doc rootElement
] children
] objectAtIndex
:0];
318 StackFrame
*frame
= [[StackFrame alloc
]
320 withFilename
:[[xmlframe attributeForName
:@
"filename"] stringValue
]
322 atLine
:[[[xmlframe attributeForName
:@
"lineno"] stringValue
] intValue
]
323 inFunction
:[[xmlframe attributeForName
:@
"where"] stringValue
]
324 withContexts
:contexts
327 return [frame autorelease
];
331 * Fetches the value of and sets the status instance variable
335 [socket send
:[self createCommand
:@
"status"]];
336 NSXMLDocument
*doc
= [self processData
:[socket receive
]];
337 self.status
= [[[[doc rootElement
] attributeForName
:@
"status"] stringValue
] capitalizedString
];
339 if ([status isEqualToString
:@
"Stopped"] ||
[status isEqualToString
:@
"Stopping"])
343 self.status
= @
"Stopped";