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:@"MacGDBp @ %d", [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   if (!self.connection.attached)
 143     return;
 144   [self startDebugger];
 145 }
 146
 147 /**
 148  * Called once the socket accepts and MacGDBp is connected to the debugger
 149  */
 150 - (void)startDebugger
 151 {
 152   if ([[NSUserDefaults standardUserDefaults] boolForKey:@"BreakOnFirstLine"])
 153     [self stepIn:self];
 154 }
 155
 156 /**
 157  * Called once the debugger disconnects.
 158  */
 159 - (void)debuggerDisconnected
 160 {
 161   // Invalidate the marked line so we don't look like we're still running.
 162   sourceViewer.markedLine = -1;
 163   [sourceViewer setNeedsDisplay:YES];
 164 }
 165
 166 /**
 167  * Forwards the message to run script execution to the connection
 168  */
 169 - (IBAction)run:(id)sender
 170 {
 171   [connection run];
 172 }
 173
 174 - (IBAction)attachedToggled:(id)sender
 175 {
 176   connection.attached = [sender state] == NSOnState;
 177 }
 178
 179 /**
 180  * Forwards the message to "step in" to the connection
 181  */
 182 - (IBAction)stepIn:(id)sender
 183 {
 184   if ([[variablesTreeController selectedObjects] count] > 0)
 185     selectedVariable = [[variablesTreeController selectedObjects] objectAtIndex:0];
 186
 187   [connection stepIn];
 188 }
 189
 190 /**
 191  * Forwards the message to "step out" to the connection
 192  */
 193 - (IBAction)stepOut:(id)sender
 194 {
 195   if ([[variablesTreeController selectedObjects] count] > 0)
 196     selectedVariable = [[variablesTreeController selectedObjects] objectAtIndex:0];
 197
 198   [connection stepOut];
 199 }
 200
 201 /**
 202  * Forwards the message to "step over" to the connection
 203  */
 204 - (IBAction)stepOver:(id)sender
 205 {
 206   if ([[variablesTreeController selectedObjects] count] > 0)
 207     selectedVariable = [[variablesTreeController selectedObjects] objectAtIndex:0];
 208
 209   [connection stepOver];
 210 }
 211
 212 - (void)fetchChildProperties:(VariableNode*)node
 213 {
 214   NSArray* selection = [stackArrayController selectedObjects];
 215   assert([selection count] == 1);
 216   NSInteger depth = [[selection objectAtIndex:0] index];
 217   NSInteger txn = [connection getChildrenOfProperty:node atDepth:depth];
 218   [pendingProperties_ setObject:node forKey:[NSNumber numberWithInt:txn]];
 219 }
 220
 221 /**
 222  * NSTableView delegate method that informs the controller that the stack selection did change and that
 223  * we should update the source viewer
 224  */
 225 - (void)tableViewSelectionDidChange:(NSNotification*)notif
 226 {
 227   [self updateSourceViewer];
 228   [self expandVariables];
 229 }
 230
 231 /**
 232  * Called whenver an item is expanded. This allows us to determine if we need to fetch deeper
 233  */
 234 - (void)outlineViewItemDidExpand:(NSNotification*)notif
 235 {
 236   NSTreeNode* node = [[notif userInfo] objectForKey:@"NSObject"];
 237   [expandedVariables addObject:[[node representedObject] fullName]];
 238 }
 239
 240 /**
 241  * Called when an item was collapsed. This allows us to remove it from the list of expanded items
 242  */
 243 - (void)outlineViewItemDidCollapse:(NSNotification*)notif
 244 {
 245   [expandedVariables removeObject:[[[[notif userInfo] objectForKey:@"NSObject"] representedObject] fullName]];
 246 }
 247
 248 #pragma mark Private
 249
 250 /**
 251  * Does the actual updating of the source viewer by reading in the file
 252  */
 253 - (void)updateSourceViewer
 254 {
 255   NSArray* selection = [stackArrayController selectedObjects];
 256   if (!selection || [selection count] < 1)
 257     return;
 258   if ([selection count] > 1)
 259     NSLog(@"INVALID SELECTION");
 260   StackFrame* frame = [selection objectAtIndex:0];
 261
 262   if (!frame.loaded) {
 263     [connection loadStackFrame:frame];
 264     return;
 265   }
 266
 267   // Get the filename.
 268   NSString* filename = [[NSURL URLWithString:frame.filename] path];
 269   if ([filename isEqualToString:@""])
 270     return;
 271
 272   // Replace the source if necessary.
 273   if (frame.source && ![sourceViewer.file isEqualToString:filename])
 274   {
 275     [sourceViewer setString:frame.source asFile:filename];
 276
 277     NSSet* breakpoints = [NSSet setWithArray:[[BreakpointManager sharedManager] breakpointsForFile:filename]];
 278     [[sourceViewer numberView] setMarkers:breakpoints];
 279   }
 280
 281   [sourceViewer setMarkedLine:frame.lineNumber];
 282   [sourceViewer scrollToLine:frame.lineNumber];
 283
 284   [[sourceViewer textView] display];
 285 }
 286
 287 /**
 288  * Does some house keeping to the stack viewer
 289  */
 290 - (void)updateStackViewer
 291 {
 292   [stackArrayController rearrangeObjects];
 293   [stackArrayController setSelectionIndex:0];
 294   [self expandVariables];
 295 }
 296
 297 /**
 298  * Expands the variables based on the stored set
 299  */
 300 - (void)expandVariables
 301 {
 302   NSString* selection = [selectedVariable fullName];
 303
 304   for (int i = 0; i < [variablesOutlineView numberOfRows]; i++)
 305   {
 306     NSTreeNode* node = [variablesOutlineView itemAtRow:i];
 307     NSString* fullName = [[node representedObject] fullName];
 308
 309     // see if it needs expanding
 310     if ([expandedVariables containsObject:fullName])
 311       [variablesOutlineView expandItem:node];
 312
 313     // select it if we had it selected before
 314     if ([fullName isEqualToString:selection])
 315       [variablesTreeController setSelectionIndexPath:[node indexPath]];
 316   }
 317 }
 318
 319 #pragma mark BSSourceView Delegate
 320
 321 /**
 322  * The gutter was clicked, which indicates that a breakpoint needs to be changed
 323  */
 324 - (void)gutterClickedAtLine:(int)line forFile:(NSString*)file
 325 {
 326   BreakpointManager* mngr = [BreakpointManager sharedManager];
 327
 328   if ([mngr hasBreakpointAt:line inFile:file])
 329   {
 330     [mngr removeBreakpointAt:line inFile:file];
 331   }
 332   else
 333   {
 334     Breakpoint* bp = [[Breakpoint alloc] initWithLine:line inFile:file];
 335     [mngr addBreakpoint:bp];
 336     [bp release];
 337   }
 338
 339   [[sourceViewer numberView] setMarkers:[NSSet setWithArray:[mngr breakpointsForFile:file]]];
 340   [[sourceViewer numberView] setNeedsDisplay:YES];
 341 }
 342
 343 #pragma mark GDBpConnectionDelegate
 344
 345 - (void)clobberStack
 346 {
 347   aboutToClobber_ = YES;
 348   [pendingProperties_ removeAllObjects];
 349 }
 350
 351 - (void)newStackFrame:(StackFrame*)frame
 352 {
 353   if (aboutToClobber_)
 354   {
 355     [stackController.stack removeAllObjects];
 356     aboutToClobber_ = NO;
 357   }
 358   [stackController push:frame];
 359   [self updateStackViewer];
 360   [self updateSourceViewer];
 361 }
 362
 363 - (void)sourceUpdated:(StackFrame*)frame
 364 {
 365   [self updateSourceViewer];
 366 }
 367
 368 - (void)receivedProperties:(NSArray*)properties forTransaction:(NSInteger)transaction
 369 {
 370   NSNumber* key = [NSNumber numberWithInt:transaction];
 371   VariableNode* node = [pendingProperties_ objectForKey:key];
 372   if (node) {
 373     [node setChildrenFromXMLChildren:properties];
 374     [variablesTreeController rearrangeObjects];
 375     [pendingProperties_ removeObjectForKey:key];
 376   }
 377 }
 378
 379 @end