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 "DebuggerController.h"
18 #import "GDBpConnection.h"
19 #import "NSXMLElementAdditions.h"
20 #import "AppDelegate.h"
21 #import "BreakpointManager.h"
23 @interface DebuggerController (Private
)
24 - (void)updateSourceViewer
;
25 - (void)updateStackViewer
;
28 @implementation DebuggerController
30 @synthesize connection
, sourceViewer
;
33 * Initializes the window controller and sets the connection using preference
38 if (self = [super initWithWindowNibName
:@
"Debugger"])
40 stackController
= [[StackController alloc
] init
];
42 NSUserDefaults
*defaults
= [NSUserDefaults standardUserDefaults
];
43 connection
= [[GDBpConnection alloc
] initWithPort
:[defaults integerForKey
:@
"Port"] session
:[defaults stringForKey
:@
"IDEKey"]];
44 expandedRegisters
= [[NSMutableSet alloc
] init
];
45 [[self window
] makeKeyAndOrderFront
:nil];
46 [[self window
] setDelegate
:self];
48 [[NSNotificationCenter defaultCenter
]
50 selector
:@selector(handleConnectionError
:)
51 name
:kErrorOccurredNotif
64 [expandedRegisters release
];
65 [stackController release
];
70 * Before the display get's comfortable, set up the NSTextView to scroll horizontally
74 [self setStatus
:@
"Connecting"];
75 [[self window
] setExcludedFromWindowsMenu
:YES
];
76 [sourceViewer setDelegate
:self];
77 [stackArrayController setSortDescriptors
:[NSArray arrayWithObject
:[[[NSSortDescriptor alloc
] initWithKey
:@
"index" ascending
:YES
] autorelease
]]];
81 * Called right before the window closes so that we can tell the socket to close down
83 - (void)windowWillClose
:(NSNotification
*)notif
85 [[connection socket
] close
];
89 * Validates the menu items for the "Debugger" menu
91 - (BOOL)validateUserInterfaceItem
:(id <NSValidatedUserInterfaceItem
>)anItem
93 SEL action
= [anItem action
];
95 if (action
== @selector(stepOut
:))
96 return ([connection isConnected
] && [stackController.stack count
] > 1);
97 else if (action
== @selector(stepIn
:) || action
== @selector(stepOver
:) || action
== @selector(run
:))
98 return [connection isConnected
];
100 return [[self window
] validateUserInterfaceItem
:anItem
];
104 * Resets all the displays to be empty
106 - (void)resetDisplays
108 [registerController setContent
:nil];
109 [[sourceViewer textView
] setString
:@
""];
113 * Sets the status and clears any error message
115 - (void)setStatus
:(NSString
*)aStatus
117 [errormsg setHidden
:YES
];
118 [statusmsg setStringValue
:aStatus
];
119 [[self window
] setTitle
:[NSString stringWithFormat
:@
"GDBp @ %@:%d/%@", [connection remoteHost
], [connection port
], [connection session
]]];
121 [stepInButton setEnabled
:NO
];
122 [stepOutButton setEnabled
:NO
];
123 [stepOverButton setEnabled
:NO
];
124 [runButton setEnabled
:NO
];
125 [reconnectButton setEnabled
:NO
];
127 if ([connection isConnected
])
129 if ([aStatus isEqualToString
:@
"Starting"])
131 [stepInButton setEnabled
:YES
];
132 [runButton setEnabled
:YES
];
137 [reconnectButton setEnabled
:YES
];
142 * Sets the status to be "Error" and then displays the error message
144 - (void)setError
:(NSString
*)anError
146 [errormsg setStringValue
:anError
];
147 [self setStatus
:@
"Error"];
148 [errormsg setHidden
:NO
];
152 * Handles a GDBpConnection error
154 - (void)handleConnectionError
:(NSNotification
*)notif
156 [self setError
:[[notif userInfo
] valueForKey
:@
"NSString"]];
160 * Sets the stack root element so that the NSOutlineView can display it
162 - (void)setRegister
:(NSXMLDocument
*)elm
164 // XXX: Doing anything short of this will cause bindings to crash spectacularly for no reason whatsoever, and
165 // in seemingly arbitrary places. The class that crashes is _NSKeyValueObservationInfoCreateByRemoving.
166 // http://boredzo.org/blog/archives/2006-01-29/have-you-seen-this-crash says that this means nothing is
167 // being observed, but I doubt that he was using an NSOutlineView which seems to be one f!cking piece of
168 // sh!t when used with NSTreeController. http://www.cocoadev.com/index.pl?NSTreeControllerBugOrDeveloperError
169 // was the inspiration for this fix (below) but the author says that inserting does not work too well, but
170 // that's okay for us as we just need to replace the entire thing.
171 [registerController setContent
:nil];
172 [registerController setContent
:[[elm rootElement
] children
]];
174 for (int i
= 0; i
< [registerView numberOfRows
]; i
++)
176 NSTreeNode
*node
= [registerView itemAtRow
:i
];
177 if ([expandedRegisters containsObject
:[[node representedObject
] fullname
]])
179 [registerView expandItem
:node
];
185 * Forwards the message to run script execution to the connection
187 - (IBAction
)run
:(id)sender
193 * Tells the connection to ask the server to reconnect
195 - (IBAction
)reconnect
:(id)sender
197 [connection reconnect
];
201 * Forwards the message to "step in" to the connection
203 - (IBAction
)stepIn
:(id)sender
205 StackFrame
*frame
= [connection stepIn
];
206 if ([frame isShiftedFrame
:[stackController peek
]])
207 [stackController pop
];
208 [stackController push
:frame
];
209 [self updateStackViewer
];
213 * Forwards the message to "step out" to the connection
215 - (IBAction
)stepOut
:(id)sender
217 StackFrame
*frame
= [connection stepOut
];
218 [stackController pop
]; // frame we were out of
219 [stackController pop
]; // frame we are returning to
220 [stackController push
:frame
];
221 [self updateStackViewer
];
225 * Forwards the message to "step over" to the connection
227 - (IBAction
)stepOver
:(id)sender
229 StackFrame
*frame
= [connection stepOver
];
230 [stackController pop
];
231 [stackController push
:frame
];
232 [self updateStackViewer
];
236 * NSTableView delegate method that informs the controller that the stack selection did change and that
237 * we should update the source viewer
239 - (void)tableViewSelectionDidChange
:(NSNotification
*)notif
241 [self updateSourceViewer
];
245 * Called whenver an item is expanded. This allows us to determine if we need to fetch deeper
247 - (void)outlineViewItemDidExpand
:(NSNotification
*)notif
249 NSTreeNode
*node
= [[notif userInfo
] objectForKey
:@
"NSObject"];
250 [expandedRegisters addObject
:[[node representedObject
] fullname
]];
254 * Called when an item was collapsed. This allows us to remove it from the list of expanded items
256 - (void)outlineViewItemDidCollapse
:(NSNotification
*)notif
258 [expandedRegisters removeObject
:[[[[notif userInfo
] objectForKey
:@
"NSObject"] representedObject
] fullname
]];
264 * Does the actual updating of the source viewer by reading in the file
266 - (void)updateSourceViewer
268 id selection
= [stackArrayController selection
];
269 if ([selection valueForKey
:@
"filename"] == NSNoSelectionMarker
)
271 [[sourceViewer textView
] setString
:@
""];
275 // get the filename and then set the text
276 NSString
*filename
= [selection valueForKey
:@
"filename"];
277 filename
= [[NSURL URLWithString
:filename
] path
];
278 if ([filename isEqualToString
:@
""])
283 [sourceViewer setFile
:filename
];
285 int line
= [[selection valueForKey
:@
"lineNumber"] intValue
];
286 [sourceViewer setMarkedLine
:line
];
287 [sourceViewer scrollToLine
:line
];
289 // make sure the font stays Monaco
290 //[sourceViewer setFont:[NSFont fontWithName:@"Monaco" size:10.0]];
294 * Does some house keeping to the stack viewer
296 - (void)updateStackViewer
298 [stackArrayController rearrangeObjects
];
299 [stackArrayController setSelectionIndex
:0];
301 [stepInButton setEnabled
:YES
];
302 [stepOverButton setEnabled
:YES
];
303 [runButton setEnabled
:YES
];
306 #pragma mark BSSourceView Delegate
309 * The gutter was clicked, which indicates that a breakpoint needs to be changed
311 - (void)gutterClickedAtLine
:(int)line forFile
:(NSString
*)file
313 BreakpointManager
*mngr
= [BreakpointManager sharedManager
];
315 if ([mngr hasBreakpointAt
:line inFile
:file
])
317 [mngr removeBreakpointAt
:line inFile
:file
];
321 Breakpoint
*bp
= [[Breakpoint alloc
] initWithLine
:line inFile
:file
];
322 [mngr addBreakpoint
:bp
];
326 [[sourceViewer numberView
] setMarkers
:[NSSet setWithArray
:[mngr breakpointsForFile
:file
]]];
327 [[sourceViewer numberView
] setNeedsDisplay
:YES
];