/
DebuggerController.m
414 lines (359 loc) · 12.4 KB
/
DebuggerController.m
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
/*
* MacGDBp
* Copyright (c) 2007 - 2011, Blue Static <http://www.bluestatic.org>
*
* This program is free software; you can redistribute it and/or modify it under the terms of the GNU
* General Public License as published by the Free Software Foundation; either version 2 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
* even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License along with this program; if not,
* write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#import "DebuggerController.h"
#import "AppDelegate.h"
#import "BSSourceView.h"
#import "BreakpointController.h"
#import "BreakpointManager.h"
#import "DebuggerBackEnd.h"
#import "DebuggerModel.h"
#import "EvalController.h"
#import "PreferenceNames.h"
#import "NSXMLElementAdditions.h"
#import "StackFrame.h"
@interface DebuggerController (Private)
- (void)updateSourceViewer;
- (void)expandVariables;
@end
@implementation DebuggerController {
BreakpointController* _breakpointsController;
}
@synthesize connection, sourceViewer, inspector;
/**
* Initializes the window controller and sets the connection using preference
* values
*/
- (id)init
{
if (self = [super initWithWindowNibName:@"Debugger"])
{
NSUserDefaults* defaults = [NSUserDefaults standardUserDefaults];
_model = [[DebuggerModel alloc] init];
[_model addObserver:self
forKeyPath:@"connected"
options:NSKeyValueObservingOptionNew
context:nil];
connection = [[DebuggerBackEnd alloc] initWithPort:[defaults integerForKey:kPrefPort]
autoAttach:[defaults boolForKey:kPrefDebuggerAttached]];
connection.model = _model;
expandedVariables = [[NSMutableSet alloc] init];
[[self window] makeKeyAndOrderFront:nil];
[[self window] setDelegate:self];
if ([defaults boolForKey:kPrefInspectorWindowVisible])
[inspector orderFront:self];
}
return self;
}
/**
* Dealloc
*/
- (void)dealloc
{
[connection release];
[_model release];
[_breakpointsController release];
[expandedVariables release];
[super dealloc];
}
/**
* Before the display get's comfortable, set up the NSTextView to scroll horizontally
*/
- (void)awakeFromNib
{
[[self window] setExcludedFromWindowsMenu:YES];
[[self window] setTitle:[NSString stringWithFormat:@"MacGDBp @ %d", [connection port]]];
[sourceViewer setDelegate:self];
[stackArrayController setSortDescriptors:@[ [[[NSSortDescriptor alloc] initWithKey:@"index" ascending:YES] autorelease] ]];
[stackArrayController addObserver:self
forKeyPath:@"selectedObjects"
options:NSKeyValueObservingOptionNew
context:nil];
[stackArrayController addObserver:self
forKeyPath:@"selection.source"
options:NSKeyValueObservingOptionNew
context:nil];
[[_segmentControl cell] addObserver:self
forKeyPath:@"selectedSegment"
options:NSKeyValueObservingOptionNew
context:nil];
self.connection.autoAttach = [attachedCheckbox_ state] == NSOnState;
_breakpointsController = [[BreakpointController alloc] init];
[[self.tabView tabViewItemAtIndex:1] setView:_breakpointsController.view];
[self updateSegmentControl];
}
/**
* Key-value observation routine.
*/
- (void)observeValueForKeyPath:(NSString*)keyPath
ofObject:(id)object
change:(NSDictionary<NSString*,id>*)change
context:(void*)context {
if (object == stackArrayController && [keyPath isEqualToString:@"selectedObjects"]) {
for (StackFrame* frame in stackArrayController.selectedObjects)
[connection loadStackFrame:frame];
} else if (object == stackArrayController && [keyPath isEqualToString:@"selection.source"]) {
[self updateSourceViewer];
} else if (object == _model && [keyPath isEqualToString:@"connected"]) {
if ([change[NSKeyValueChangeNewKey] boolValue])
[self debuggerConnected];
else
[self debuggerDisconnected];
} else if (object == self.segmentControl.cell) {
[self.tabView selectTabViewItemAtIndex:self.segmentControl.selectedSegment - 1];
} else {
[super observeValueForKeyPath:keyPath ofObject:object change:change context:context];
}
}
/**
* Validates the menu items for the "Debugger" menu
*/
- (BOOL)validateUserInterfaceItem:(id <NSValidatedUserInterfaceItem>)anItem
{
SEL action = [anItem action];
if (action == @selector(stepOut:)) {
return _model.connected && _model.stackDepth > 1;
} else if (action == @selector(stepIn:) ||
action == @selector(stepOver:) ||
action == @selector(run:) ||
action == @selector(stop:) ||
action == @selector(showEvalWindow:)) {
return _model.connected;
}
return [[self window] validateUserInterfaceItem:anItem];
}
/**
* Shows the inspector window
*/
- (IBAction)showInspectorWindow:(id)sender
{
if (![inspector isVisible])
[inspector makeKeyAndOrderFront:sender];
else
[inspector orderOut:sender];
}
/**
* Runs the eval window sheet.
*/
- (IBAction)showEvalWindow:(id)sender
{
// The |controller| will release itself on close.
EvalController* controller = [[EvalController alloc] initWithBackEnd:connection];
[controller runModalForWindow:[self window]];
}
/**
* Resets all the displays to be empty
*/
- (void)resetDisplays
{
[variablesTreeController setContent:nil];
[stackArrayController rearrangeObjects];
[[sourceViewer textView] setString:@""];
sourceViewer.file = nil;
}
/**
* Sets the status to be "Error" and then displays the error message
*/
- (void)setError:(NSString*)anError
{
[errormsg setStringValue:anError];
[errormsg setHidden:NO];
}
/**
* Delegate function for GDBpConnection for when the debugger connects.
*/
- (void)debuggerConnected
{
[errormsg setHidden:YES];
if (!self.connection.autoAttach)
return;
if ([[NSUserDefaults standardUserDefaults] boolForKey:kPrefBreakOnFirstLine])
[self stepIn:self];
// Do not cache the file between debugger executions.
sourceViewer.file = nil;
}
/**
* Called once the debugger disconnects.
*/
- (void)debuggerDisconnected
{
// Invalidate the marked line so we don't look like we're still running.
sourceViewer.markedLine = -1;
[sourceViewer setNeedsDisplay:YES];
}
/**
* Forwards the message to run script execution to the connection
*/
- (IBAction)run:(id)sender
{
[connection run];
}
- (IBAction)attachedToggled:(id)sender
{
connection.autoAttach = [sender state] == NSOnState;
}
/**
* Forwards the message to "step in" to the connection
*/
- (IBAction)stepIn:(id)sender
{
if ([[variablesTreeController selectedObjects] count] > 0)
selectedVariable = [[variablesTreeController selectedObjects] objectAtIndex:0];
[connection stepIn];
}
/**
* Forwards the message to "step out" to the connection
*/
- (IBAction)stepOut:(id)sender
{
if ([[variablesTreeController selectedObjects] count] > 0)
selectedVariable = [[variablesTreeController selectedObjects] objectAtIndex:0];
[connection stepOut];
}
/**
* Forwards the message to "step over" to the connection
*/
- (IBAction)stepOver:(id)sender
{
if ([[variablesTreeController selectedObjects] count] > 0)
selectedVariable = [[variablesTreeController selectedObjects] objectAtIndex:0];
[connection stepOver];
}
/**
* Forwards the detach/"stop" message to the back end.
*/
- (IBAction)stop:(id)sender
{
[connection stop];
}
/**
* NSTableView delegate method that informs the controller that the stack selection did change and that
* we should update the source viewer
*/
- (void)tableViewSelectionDidChange:(NSNotification*)notif
{
// TODO: This is very, very hacky because it's nondeterministic. The issue
// is that calling |-[NSOutlineView expandItem:]| while the table is still
// doing its redraw will translate to a no-op. Instead, we need to restructure
// this controller so that when everything has been laid out we call
// |-expandVariables|; but NSOutlineView doesn't have a |-didFinishDoingCrap:|
// method. The other issue is that we need to call this method from
// selectionDidChange but ONLY when it was the result of a user-initiated
// action and not the stack viewer updating causing a selection change.
// If it happens in the latter, then we run into the same issue that causes
// this to no-op.
[self performSelector:@selector(expandVariables) withObject:nil afterDelay:0.05];
}
/**
* Called whenver an item is expanded. This allows us to determine if we need to fetch deeper
*/
- (void)outlineViewItemDidExpand:(NSNotification*)notif
{
NSTreeNode* node = [[notif userInfo] objectForKey:@"NSObject"];
[expandedVariables addObject:[[node representedObject] fullName]];
[connection loadVariableNode:[node representedObject]
forStackFrame:[[stackArrayController selectedObjects] lastObject]];
}
/**
* Called when an item was collapsed. This allows us to remove it from the list of expanded items
*/
- (void)outlineViewItemDidCollapse:(NSNotification*)notif
{
[expandedVariables removeObject:[[[[notif userInfo] objectForKey:@"NSObject"] representedObject] fullName]];
}
#pragma mark Private
/**
* Does the actual updating of the source viewer by reading in the file
*/
- (void)updateSourceViewer
{
NSArray* selection = [stackArrayController selectedObjects];
if (!selection || [selection count] < 1)
return;
if ([selection count] > 1)
NSLog(@"INVALID SELECTION");
StackFrame* frame = [selection objectAtIndex:0];
if (!frame.loaded) {
[connection loadStackFrame:frame];
return;
}
// Get the filename.
NSString* filename = [[NSURL URLWithString:frame.filename] path];
if ([filename isEqualToString:@""])
return;
// Replace the source if necessary.
if (frame.source && ![sourceViewer.file isEqualToString:filename])
{
[sourceViewer setString:frame.source asFile:filename];
NSSet* breakpoints = [NSSet setWithArray:[[BreakpointManager sharedManager] breakpointsForFile:filename]];
[sourceViewer setMarkers:breakpoints];
}
[sourceViewer setMarkedLine:frame.lineNumber];
[sourceViewer scrollToLine:frame.lineNumber];
[[sourceViewer textView] setNeedsDisplay:YES];
}
/**
* Expands the variables based on the stored set
*/
- (void)expandVariables
{
NSString* selection = [selectedVariable fullName];
for (NSInteger i = 0; i < [variablesOutlineView numberOfRows]; i++) {
NSTreeNode* node = [variablesOutlineView itemAtRow:i];
NSString* fullName = [[node representedObject] fullName];
// see if it needs expanding
if ([expandedVariables containsObject:fullName])
[variablesOutlineView expandItem:node];
// select it if we had it selected before
if ([fullName isEqualToString:selection])
[variablesTreeController setSelectionIndexPath:[node indexPath]];
}
}
/**
* Sets the widths of the segmented control.
*/
- (void)updateSegmentControl {
NSRect containerFrame = [[_segmentControl superview] frame];
CGFloat containerWidth = NSWidth(containerFrame);
CGFloat segmentSizes = 0;
for (NSInteger i = 1; i < [_segmentControl segmentCount] - 1; ++i) {
segmentSizes += [_segmentControl widthForSegment:i];
}
CGFloat spacerWidth = (containerWidth - segmentSizes) / 2;
[_segmentControl setWidth:spacerWidth forSegment:0];
[_segmentControl setWidth:spacerWidth forSegment:[_segmentControl segmentCount] - 1];
[_segmentControl setFrame:NSMakeRect(-1, NSHeight(containerFrame) - 27, containerWidth + 2, 30)];
}
#pragma mark BSSourceView Delegate
/**
* The gutter was clicked, which indicates that a breakpoint needs to be changed
*/
- (void)gutterClickedAtLine:(int)line forFile:(NSString*)file
{
BreakpointManager* mngr = [BreakpointManager sharedManager];
if ([mngr hasBreakpointAt:line inFile:file])
{
[mngr removeBreakpointAt:line inFile:file];
}
else
{
Breakpoint* bp = [[Breakpoint alloc] initWithLine:line inFile:file];
[mngr addBreakpoint:bp];
[bp release];
}
[sourceViewer setMarkers:[NSSet setWithArray:[mngr breakpointsForFile:file]]];
[sourceViewer setNeedsDisplay:YES];
}
@end