Source/DebuggerController.m

   1 /*
   2  * MacGDBp
   3  * Copyright (c) 2007 - 2010, Blue Static <http://www.bluestatic.org>
   4  *
   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.
   8  *
   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.
  12  *
  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
  15  */
  16
  17 #import "DebuggerController.h"
  18 #import "NSXMLElementAdditions.h"
  19 #import "AppDelegate.h"
  20 #import "BreakpointManager.h"
  21
  22 @interface DebuggerController (Private)
  23 - (void)updateSourceViewer;
  24 - (void)updateStackViewer;
  25 - (void)expandVariables;
  26 @end
  27
  28 @implementation DebuggerController
  29
  30 @synthesize connection, sourceViewer, inspector;
  31
  32 /**
  33  * Initializes the window controller and sets the connection using preference
  34  * values
  35  */
  36 - (id)init
  37 {
  38   if (self = [super initWithWindowNibName:@"Debugger"])
  39   {
  40     stackController = [[StackController alloc] init];
  41     pendingProperties_ = [[NSMutableDictionary alloc] init];
  42
  43     NSUserDefaults* defaults = [NSUserDefaults standardUserDefaults];
  44
  45     connection = [[DebuggerProcessor alloc] initWithPort:[defaults integerForKey:@"Port"]];
  46     connection.delegate = self;
  47     expandedVariables = [[NSMutableSet alloc] init];
  48     [[self window] makeKeyAndOrderFront:nil];
  49     [[self window] setDelegate:self];
  50
  51     if ([[NSUserDefaults standardUserDefaults] boolForKey:@"InspectorWindowVisible"])
  52       [inspector orderFront:self];
  53   }
  54   return self;
  55 }
  56
  57 /**
  58  * Dealloc
  59  */
  60 - (void)dealloc
  61 {
  62   [connection release];
  63   [expandedVariables release];
  64   [stackController release];
  65   [pendingProperties_ release];
  66   [super dealloc];
  67 }
  68
  69 /**
  70  * Before the display get's comfortable, set up the NSTextView to scroll horizontally
  71  */
  72 - (void)awakeFromNib
  73 {
  74   [[self window] setExcludedFromWindowsMenu:YES];
  75   [[self window] setTitle:[NSString stringWithFormat:@"GDBp @ %@:%d", [connection remoteHost], [connection port]]];
  76   [sourceViewer setDelegate:self];
  77   [stackArrayController setSortDescriptors:[NSArray arrayWithObject:[[[NSSortDescriptor alloc] initWithKey:@"index" ascending:YES] autorelease]]];
  78   self.connection.attached = [attachedCheckbox_ state] == NSOnState;
  79 }
  80
  81 /**
  82  * Validates the menu items for the "Debugger" menu
  83  */
  84 - (BOOL)validateUserInterfaceItem:(id <NSValidatedUserInterfaceItem>)anItem
  85 {
  86   SEL action = [anItem action];
  87
  88   if (action == @selector(stepOut:))
  89     return ([connection isConnected] && [stackController.stack count] > 1);
  90   else if (action == @selector(stepIn:) || action == @selector(stepOver:) || action == @selector(run:))
  91     return [connection isConnected];
  92
  93   return [[self window] validateUserInterfaceItem:anItem];
  94 }
  95
  96 /**
  97  * Shows the inspector window
  98  */
  99 - (IBAction)showInspectorWindow:(id)sender
 100 {
 101   if (![inspector isVisible])
 102     [inspector makeKeyAndOrderFront:sender];
 103   else
 104     [inspector orderOut:sender];
 105 }
 106
 107 /**
 108  * Resets all the displays to be empty
 109  */
 110 - (void)resetDisplays
 111 {
 112   [variablesTreeController setContent:nil];
 113   [stackController.stack removeAllObjects];
 114   [stackArrayController rearrangeObjects];
 115   [[sourceViewer textView] setString:@""];
 116   sourceViewer.file = nil;
 117 }
 118
 119 /**
 120  * Sets the status to be "Error" and then displays the error message
 121  */
 122 - (void)setError:(NSString*)anError
 123 {
 124   [errormsg setStringValue:anError];
 125   [errormsg setHidden:NO];
 126 }
 127
 128 /**
 129  * Handles a GDBpConnection error
 130  */
 131 - (void)errorEncountered:(NSString*)error
 132 {
 133   [self setError:error];
 134 }
 135
 136 /**
 137  * Delegate function for GDBpConnection for when the debugger connects.
 138  */
 139 - (void)debuggerConnected
 140 {
 141   [errormsg setHidden:YES];
 142   [self startDebugger];
 143 }
 144
 145 /**
 146  * Called once the socket accepts and MacGDBp is connected to the debugger
 147  */
 148 - (void)startDebugger
 149 {
 150   if ([[NSUserDefaults standardUserDefaults] boolForKey:@"BreakOnFirstLine"])
 151     [self stepIn:self];
 152 }
 153
 154 /**
 155  * Called once the debugger disconnects.
 156  */
 157 - (void)debuggerDisconnected
 158 {
 159   // Invalidate the marked line so we don't look like we're still running.
 160   sourceViewer.markedLine = -1;
 161   [sourceViewer setNeedsDisplay:YES];
 162 }
 163
 164 /**
 165  * Forwards the message to run script execution to the connection
 166  */
 167 - (IBAction)run:(id)sender
 168 {
 169   [connection run];
 170 }
 171
 172 - (IBAction)attachedToggled:(id)sender
 173 {
 174   connection.attached = [sender state] == NSOnState;
 175 }
 176
 177 /**
 178  * Forwards the message to "step in" to the connection
 179  */
 180 - (IBAction)stepIn:(id)sender
 181 {
 182   if ([[variablesTreeController selectedObjects] count] > 0)
 183     selectedVariable = [[variablesTreeController selectedObjects] objectAtIndex:0];
 184
 185   [connection stepIn];
 186 }
 187
 188 /**
 189  * Forwards the message to "step out" to the connection
 190  */
 191 - (IBAction)stepOut:(id)sender
 192 {
 193   if ([[variablesTreeController selectedObjects] count] > 0)
 194     selectedVariable = [[variablesTreeController selectedObjects] objectAtIndex:0];
 195
 196   [connection stepOut];
 197 }
 198
 199 /**
 200  * Forwards the message to "step over" to the connection
 201  */
 202 - (IBAction)stepOver:(id)sender
 203 {
 204   if ([[variablesTreeController selectedObjects] count] > 0)
 205     selectedVariable = [[variablesTreeController selectedObjects] objectAtIndex:0];
 206
 207   [connection stepOver];
 208 }
 209
 210 - (void)fetchChildProperties:(VariableNode*)node
 211 {
 212   NSArray* selection = [stackArrayController selectedObjects];
 213   assert([selection count] == 1);
 214   NSInteger depth = [[selection objectAtIndex:0] index];
 215   NSInteger txn = [connection getChildrenOfProperty:node atDepth:depth];
 216   [pendingProperties_ setObject:node forKey:[NSNumber numberWithInt:txn]];
 217 }
 218
 219 /**
 220  * NSTableView delegate method that informs the controller that the stack selection did change and that
 221  * we should update the source viewer
 222  */
 223 - (void)tableViewSelectionDidChange:(NSNotification*)notif
 224 {
 225   [self updateSourceViewer];
 226   [self expandVariables];
 227 }
 228
 229 /**
 230  * Called whenver an item is expanded. This allows us to determine if we need to fetch deeper
 231  */
 232 - (void)outlineViewItemDidExpand:(NSNotification*)notif
 233 {
 234   NSTreeNode* node = [[notif userInfo] objectForKey:@"NSObject"];
 235   [expandedVariables addObject:[[node representedObject] fullName]];
 236 }
 237
 238 /**
 239  * Called when an item was collapsed. This allows us to remove it from the list of expanded items
 240  */
 241 - (void)outlineViewItemDidCollapse:(NSNotification*)notif
 242 {
 243   [expandedVariables removeObject:[[[[notif userInfo] objectForKey:@"NSObject"] representedObject] fullName]];
 244 }
 245
 246 #pragma mark Private
 247
 248 /**
 249  * Does the actual updating of the source viewer by reading in the file
 250  */
 251 - (void)updateSourceViewer
 252 {
 253   NSArray* selection = [stackArrayController selectedObjects];
 254   if (!selection || [selection count] < 1)
 255     return;
 256   if ([selection count] > 1)
 257     NSLog(@"INVALID SELECTION");
 258   StackFrame* frame = [selection objectAtIndex:0];
 259
 260   if (!frame.loaded) {
 261     [connection loadStackFrame:frame];
 262     return;
 263   }
 264
 265   // Get the filename.
 266   NSString* filename = [[NSURL URLWithString:frame.filename] path];
 267   if ([filename isEqualToString:@""])
 268     return;
 269
 270   // Replace the source if necessary.
 271   if (frame.source && ![sourceViewer.file isEqualToString:filename])
 272   {
 273     [sourceViewer setString:frame.source asFile:filename];
 274
 275     NSSet* breakpoints = [NSSet setWithArray:[[BreakpointManager sharedManager] breakpointsForFile:filename]];
 276     [[sourceViewer numberView] setMarkers:breakpoints];
 277   }
 278
 279   [sourceViewer setMarkedLine:frame.lineNumber];
 280   [sourceViewer scrollToLine:frame.lineNumber];
 281
 282   [[sourceViewer textView] display];
 283 }
 284
 285 /**
 286  * Does some house keeping to the stack viewer
 287  */
 288 - (void)updateStackViewer
 289 {
 290   [stackArrayController rearrangeObjects];
 291   [stackArrayController setSelectionIndex:0];
 292   [self expandVariables];
 293 }
 294
 295 /**
 296  * Expands the variables based on the stored set
 297  */
 298 - (void)expandVariables
 299 {
 300   NSString* selection = [selectedVariable fullName];
 301
 302   for (int i = 0; i < [variablesOutlineView numberOfRows]; i++)
 303   {
 304     NSTreeNode* node = [variablesOutlineView itemAtRow:i];
 305     NSString* fullName = [[node representedObject] fullName];
 306
 307     // see if it needs expanding
 308     if ([expandedVariables containsObject:fullName])
 309       [variablesOutlineView expandItem:node];
 310
 311     // select it if we had it selected before
 312     if ([fullName isEqualToString:selection])
 313       [variablesTreeController setSelectionIndexPath:[node indexPath]];
 314   }
 315 }
 316
 317 #pragma mark BSSourceView Delegate
 318
 319 /**
 320  * The gutter was clicked, which indicates that a breakpoint needs to be changed
 321  */
 322 - (void)gutterClickedAtLine:(int)line forFile:(NSString*)file
 323 {
 324   BreakpointManager* mngr = [BreakpointManager sharedManager];
 325
 326   if ([mngr hasBreakpointAt:line inFile:file])
 327   {
 328     [mngr removeBreakpointAt:line inFile:file];
 329   }
 330   else
 331   {
 332     Breakpoint* bp = [[Breakpoint alloc] initWithLine:line inFile:file];
 333     [mngr addBreakpoint:bp];
 334     [bp release];
 335   }
 336
 337   [[sourceViewer numberView] setMarkers:[NSSet setWithArray:[mngr breakpointsForFile:file]]];
 338   [[sourceViewer numberView] setNeedsDisplay:YES];
 339 }
 340
 341 #pragma mark GDBpConnectionDelegate
 342
 343 - (void)clobberStack
 344 {
 345   aboutToClobber_ = YES;
 346   [pendingProperties_ removeAllObjects];
 347 }
 348
 349 - (void)newStackFrame:(StackFrame*)frame
 350 {
 351   if (aboutToClobber_)
 352   {
 353     [stackController.stack removeAllObjects];
 354     aboutToClobber_ = NO;
 355   }
 356   [stackController push:frame];
 357   [self updateStackViewer];
 358   [self updateSourceViewer];
 359 }
 360
 361 - (void)sourceUpdated:(StackFrame*)frame
 362 {
 363   [self updateSourceViewer];
 364 }
 365
 366 - (void)receivedProperties:(NSArray*)properties forTransaction:(NSInteger)transaction
 367 {
 368   NSNumber* key = [NSNumber numberWithInt:transaction];
 369   VariableNode* node = [pendingProperties_ objectForKey:key];
 370   if (node) {
 371     [node setChildrenFromXMLChildren:properties];
 372     [variablesTreeController rearrangeObjects];
 373     [pendingProperties_ removeObjectForKey:key];
 374   }
 375 }
 376
 377 @end