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 }
  79
  80 /**
  81  * Validates the menu items for the "Debugger" menu
  82  */
  83 - (BOOL)validateUserInterfaceItem:(id <NSValidatedUserInterfaceItem>)anItem
  84 {
  85   SEL action = [anItem action];
  86
  87   if (action == @selector(stepOut:))
  88     return ([connection isConnected] && [stackController.stack count] > 1);
  89   else if (action == @selector(stepIn:) || action == @selector(stepOver:) || action == @selector(run:))
  90     return [connection isConnected];
  91   else if (action == @selector(reconnect:))
  92     return ![connection isConnected];
  93
  94   return [[self window] validateUserInterfaceItem:anItem];
  95 }
  96
  97 /**
  98  * Shows the inspector window
  99  */
 100 - (IBAction)showInspectorWindow:(id)sender
 101 {
 102   if (![inspector isVisible])
 103     [inspector makeKeyAndOrderFront:sender];
 104   else
 105     [inspector orderOut:sender];
 106 }
 107
 108 /**
 109  * Resets all the displays to be empty
 110  */
 111 - (void)resetDisplays
 112 {
 113   [variablesTreeController setContent:nil];
 114   [stackController.stack removeAllObjects];
 115   [stackArrayController rearrangeObjects];
 116   [[sourceViewer textView] setString:@""];
 117   sourceViewer.file = nil;
 118 }
 119
 120 /**
 121  * Sets the status to be "Error" and then displays the error message
 122  */
 123 - (void)setError:(NSString*)anError
 124 {
 125   [errormsg setStringValue:anError];
 126   [errormsg setHidden:NO];
 127 }
 128
 129 /**
 130  * Handles a GDBpConnection error
 131  */
 132 - (void)errorEncountered:(NSString*)error
 133 {
 134   [self setError:error];
 135 }
 136
 137 /**
 138  * Delegate function for GDBpConnection for when the debugger connects.
 139  */
 140 - (void)debuggerConnected
 141 {
 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   if ([[NSUserDefaults standardUserDefaults] boolForKey:@"AutoReconnect"])
 160     [self reconnect:self];
 161
 162   // Invalidate the marked line so we don't look like we're still running.
 163   sourceViewer.markedLine = -1;
 164   [sourceViewer setNeedsDisplay:YES];
 165 }
 166
 167 /**
 168  * Forwards the message to run script execution to the connection
 169  */
 170 - (IBAction)run:(id)sender
 171 {
 172   [connection run];
 173 }
 174
 175 /**
 176  * Tells the connection to ask the server to reconnect
 177  */
 178 - (IBAction)reconnect:(id)sender
 179 {
 180   [connection reconnect];
 181   [self resetDisplays];
 182 }
 183
 184 /**
 185  * Forwards the message to "step in" to the connection
 186  */
 187 - (IBAction)stepIn:(id)sender
 188 {
 189   if ([[variablesTreeController selectedObjects] count] > 0)
 190     selectedVariable = [[variablesTreeController selectedObjects] objectAtIndex:0];
 191
 192   [connection stepIn];
 193 }
 194
 195 /**
 196  * Forwards the message to "step out" to the connection
 197  */
 198 - (IBAction)stepOut:(id)sender
 199 {
 200   if ([[variablesTreeController selectedObjects] count] > 0)
 201     selectedVariable = [[variablesTreeController selectedObjects] objectAtIndex:0];
 202
 203   [connection stepOut];
 204 }
 205
 206 /**
 207  * Forwards the message to "step over" to the connection
 208  */
 209 - (IBAction)stepOver:(id)sender
 210 {
 211   if ([[variablesTreeController selectedObjects] count] > 0)
 212     selectedVariable = [[variablesTreeController selectedObjects] objectAtIndex:0];
 213
 214   [connection stepOver];
 215 }
 216
 217 - (void)fetchProperty:(NSString*)property forNode:(VariableNode*)node
 218 {
 219   NSInteger txn = [connection getProperty:property];
 220   [pendingProperties_ setObject:node forKey:[NSNumber numberWithInt:txn]];
 221 }
 222
 223 /**
 224  * NSTableView delegate method that informs the controller that the stack selection did change and that
 225  * we should update the source viewer
 226  */
 227 - (void)tableViewSelectionDidChange:(NSNotification*)notif
 228 {
 229   [self updateSourceViewer];
 230   [self expandVariables];
 231 }
 232
 233 /**
 234  * Called whenver an item is expanded. This allows us to determine if we need to fetch deeper
 235  */
 236 - (void)outlineViewItemDidExpand:(NSNotification*)notif
 237 {
 238   NSTreeNode* node = [[notif userInfo] objectForKey:@"NSObject"];
 239   [expandedVariables addObject:[[node representedObject] fullName]];
 240 }
 241
 242 /**
 243  * Called when an item was collapsed. This allows us to remove it from the list of expanded items
 244  */
 245 - (void)outlineViewItemDidCollapse:(NSNotification*)notif
 246 {
 247   [expandedVariables removeObject:[[[[notif userInfo] objectForKey:@"NSObject"] representedObject] fullName]];
 248 }
 249
 250 #pragma mark Private
 251
 252 /**
 253  * Does the actual updating of the source viewer by reading in the file
 254  */
 255 - (void)updateSourceViewer
 256 {
 257   NSArray* selection = [stackArrayController selectedObjects];
 258   if (!selection || [selection count] < 1)
 259     return;
 260   if ([selection count] > 1)
 261     NSLog(@"INVALID SELECTION");
 262   StackFrame* frame = [selection objectAtIndex:0];
 263
 264   if (!frame.loaded) {
 265     [connection loadStackFrame:frame];
 266     return;
 267   }
 268
 269   // Get the filename.
 270   NSString* filename = [[NSURL URLWithString:frame.filename] path];
 271   if ([filename isEqualToString:@""])
 272     return;
 273
 274   // Replace the source if necessary.
 275   if (frame.source && ![sourceViewer.file isEqualToString:filename])
 276   {
 277     [sourceViewer setString:frame.source asFile:filename];
 278
 279     NSSet* breakpoints = [NSSet setWithArray:[[BreakpointManager sharedManager] breakpointsForFile:filename]];
 280     [[sourceViewer numberView] setMarkers:breakpoints];
 281   }
 282
 283   [sourceViewer setMarkedLine:frame.lineNumber];
 284   [sourceViewer scrollToLine:frame.lineNumber];
 285
 286   [[sourceViewer textView] display];
 287 }
 288
 289 /**
 290  * Does some house keeping to the stack viewer
 291  */
 292 - (void)updateStackViewer
 293 {
 294   [stackArrayController rearrangeObjects];
 295   [stackArrayController setSelectionIndex:0];
 296   [self expandVariables];
 297 }
 298
 299 /**
 300  * Expands the variables based on the stored set
 301  */
 302 - (void)expandVariables
 303 {
 304   NSString* selection = [selectedVariable fullName];
 305
 306   for (int i = 0; i < [variablesOutlineView numberOfRows]; i++)
 307   {
 308     NSTreeNode* node = [variablesOutlineView itemAtRow:i];
 309     NSString* fullName = [[node representedObject] fullName];
 310
 311     // see if it needs expanding
 312     if ([expandedVariables containsObject:fullName])
 313       [variablesOutlineView expandItem:node];
 314
 315     // select it if we had it selected before
 316     if ([fullName isEqualToString:selection])
 317       [variablesTreeController setSelectionIndexPath:[node indexPath]];
 318   }
 319 }
 320
 321 #pragma mark BSSourceView Delegate
 322
 323 /**
 324  * The gutter was clicked, which indicates that a breakpoint needs to be changed
 325  */
 326 - (void)gutterClickedAtLine:(int)line forFile:(NSString*)file
 327 {
 328   BreakpointManager* mngr = [BreakpointManager sharedManager];
 329
 330   if ([mngr hasBreakpointAt:line inFile:file])
 331   {
 332     [mngr removeBreakpointAt:line inFile:file];
 333   }
 334   else
 335   {
 336     Breakpoint* bp = [[Breakpoint alloc] initWithLine:line inFile:file];
 337     [mngr addBreakpoint:bp];
 338     [bp release];
 339   }
 340
 341   [[sourceViewer numberView] setMarkers:[NSSet setWithArray:[mngr breakpointsForFile:file]]];
 342   [[sourceViewer numberView] setNeedsDisplay:YES];
 343 }
 344
 345 #pragma mark GDBpConnectionDelegate
 346
 347 - (void)clobberStack
 348 {
 349   aboutToClobber_ = YES;
 350   [pendingProperties_ removeAllObjects];
 351 }
 352
 353 - (void)newStackFrame:(StackFrame*)frame
 354 {
 355   if (aboutToClobber_)
 356   {
 357     [stackController.stack removeAllObjects];
 358     aboutToClobber_ = NO;
 359   }
 360   [stackController push:frame];
 361   [self updateStackViewer];
 362   [self updateSourceViewer];
 363 }
 364
 365 - (void)sourceUpdated:(StackFrame*)frame
 366 {
 367   [self updateSourceViewer];
 368 }
 369
 370 - (void)receivedProperties:(NSArray*)properties forTransaction:(NSInteger)transaction
 371 {
 372   NSNumber* key = [NSNumber numberWithInt:transaction];
 373   VariableNode* node = [pendingProperties_ objectForKey:key];
 374   if (node) {
 375     [node setChildrenFromXMLChildren:properties];
 376     [variablesTreeController rearrangeObjects];
 377     [pendingProperties_ removeObjectForKey:key];
 378   }
 379 }
 380
 381 @end