Source/DebuggerController.m

   1 /*
   2  * MacGDBp
   3  * Copyright (c) 2007 - 2009, 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 "GDBpConnection.h"
  19 #import "NSXMLElementAdditions.h"
  20 #import "AppDelegate.h"
  21 #import "BreakpointManager.h"
  22
  23 @interface DebuggerController (Private)
  24 - (void)updateSourceViewer;
  25 - (void)updateStackViewer;
  26 - (void)expandVariables;
  27 @end
  28
  29 @implementation DebuggerController
  30
  31 @synthesize connection, sourceViewer, inspector;
  32
  33 /**
  34  * Initializes the window controller and sets the connection using preference
  35  * values
  36  */
  37 - (id)init
  38 {
  39         if (self = [super initWithWindowNibName:@"Debugger"])
  40         {
  41                 stackController = [[StackController alloc] init];
  42
  43                 NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
  44                 connection = [[GDBpConnection alloc] initWithPort:[defaults integerForKey:@"Port"] session:[defaults stringForKey:@"IDEKey"]];
  45                 expandedVariables = [[NSMutableSet alloc] init];
  46                 [[self window] makeKeyAndOrderFront:nil];
  47                 [[self window] setDelegate:self];
  48
  49                 [[NSNotificationCenter defaultCenter]
  50                         addObserver:self
  51                         selector:@selector(handleConnectionError:)
  52                         name:kErrorOccurredNotif
  53                         object:connection
  54                 ];
  55
  56                 if ([[NSUserDefaults standardUserDefaults] boolForKey:@"InspectorWindowVisible"])
  57                         [inspector orderFront:self];
  58         }
  59         return self;
  60 }
  61
  62 /**
  63  * Dealloc
  64  */
  65 - (void)dealloc
  66 {
  67         [connection release];
  68         [expandedVariables release];
  69         [stackController release];
  70         [super dealloc];
  71 }
  72
  73 /**
  74  * Before the display get's comfortable, set up the NSTextView to scroll horizontally
  75  */
  76 - (void)awakeFromNib
  77 {
  78         [[self window] setExcludedFromWindowsMenu:YES];
  79         [[self window] setTitle:[NSString stringWithFormat:@"GDBp @ %@:%d/%@", [connection remoteHost], [connection port], [connection session]]];
  80         [sourceViewer setDelegate:self];
  81         [stackArrayController setSortDescriptors:[NSArray arrayWithObject:[[[NSSortDescriptor alloc] initWithKey:@"index" ascending:YES] autorelease]]];
  82 }
  83
  84 /**
  85  * Called right before the window closes so that we can tell the socket to close down
  86  */
  87 - (void)windowWillClose:(NSNotification *)notif
  88 {
  89         [[connection socket] close];
  90 }
  91
  92 /**
  93  * Validates the menu items for the "Debugger" menu
  94  */
  95 - (BOOL)validateUserInterfaceItem:(id <NSValidatedUserInterfaceItem>)anItem
  96 {
  97         SEL action = [anItem action];
  98
  99         if (action == @selector(stepOut:))
 100                 return ([connection isConnected] && [stackController.stack count] > 1);
 101         else if (action == @selector(stepIn:) || action == @selector(stepOver:) || action == @selector(run:))
 102                 return [connection isConnected];
 103         else if (action == @selector(reconnect:))
 104                 return ![connection isConnected];
 105
 106         return [[self window] validateUserInterfaceItem:anItem];
 107 }
 108
 109 /**
 110  * Resets all the displays to be empty
 111  */
 112 - (void)resetDisplays
 113 {
 114         [variablesTreeController setContent:nil];
 115         [stackController.stack removeAllObjects];
 116         [[sourceViewer textView] setString:@""];
 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)handleConnectionError:(NSNotification *)notif
 132 {
 133         [self setError:[[notif userInfo] valueForKey:@"NSString"]];
 134 }
 135
 136 /**
 137  * Called once the socket accepts and MacGDBp is connected to the debugger
 138  */
 139 - (void)startDebugger
 140 {
 141         [self stepIn:self];
 142 }
 143
 144 /**
 145  * Forwards the message to run script execution to the connection
 146  */
 147 - (IBAction)run:(id)sender
 148 {
 149         StackFrame *frame = [connection run];
 150         [stackController pop];
 151
 152         if ([connection isConnected] && frame != nil)
 153         {
 154                 [stackController push:frame];
 155                 [self updateStackViewer];
 156         }
 157 }
 158
 159 /**
 160  * Tells the connection to ask the server to reconnect
 161  */
 162 - (IBAction)reconnect:(id)sender
 163 {
 164         [connection reconnect];
 165         [self resetDisplays];
 166 }
 167
 168 /**
 169  * Forwards the message to "step in" to the connection
 170  */
 171 - (IBAction)stepIn:(id)sender
 172 {
 173         selectedVariable = [[variablesTreeController selectedObjects] objectAtIndex:0];
 174
 175         StackFrame *frame = [connection stepIn];
 176         if ([frame isShiftedFrame:[stackController peek]])
 177                 [stackController pop];
 178         [stackController push:frame];
 179         [self updateStackViewer];
 180 }
 181
 182 /**
 183  * Forwards the message to "step out" to the connection
 184  */
 185 - (IBAction)stepOut:(id)sender
 186 {
 187         selectedVariable = [[variablesTreeController selectedObjects] objectAtIndex:0];
 188
 189         StackFrame *frame = [connection stepOut];
 190         [stackController pop]; // frame we were out of
 191         [stackController pop]; // frame we are returning to
 192         [stackController push:frame];
 193         [self updateStackViewer];
 194 }
 195
 196 /**
 197  * Forwards the message to "step over" to the connection
 198  */
 199 - (IBAction)stepOver:(id)sender
 200 {
 201         selectedVariable = [[variablesTreeController selectedObjects] objectAtIndex:0];
 202
 203         StackFrame *frame = [connection stepOver];
 204         [stackController pop];
 205         [stackController push:frame];
 206         [self updateStackViewer];
 207 }
 208
 209 /**
 210  * NSTableView delegate method that informs the controller that the stack selection did change and that
 211  * we should update the source viewer
 212  */
 213 - (void)tableViewSelectionDidChange:(NSNotification *)notif
 214 {
 215         [self updateSourceViewer];
 216         [self expandVariables];
 217 }
 218
 219 /**
 220  * Called whenver an item is expanded. This allows us to determine if we need to fetch deeper
 221  */
 222 - (void)outlineViewItemDidExpand:(NSNotification *)notif
 223 {
 224         NSTreeNode *node = [[notif userInfo] objectForKey:@"NSObject"];
 225         [expandedVariables addObject:[[node representedObject] fullname]];
 226 }
 227
 228 /**
 229  * Called when an item was collapsed. This allows us to remove it from the list of expanded items
 230  */
 231 - (void)outlineViewItemDidCollapse:(NSNotification *)notif
 232 {
 233         [expandedVariables removeObject:[[[[notif userInfo] objectForKey:@"NSObject"] representedObject] fullname]];
 234 }
 235
 236 #pragma mark Private
 237
 238 /**
 239  * Does the actual updating of the source viewer by reading in the file
 240  */
 241 - (void)updateSourceViewer
 242 {
 243         id selection = [stackArrayController selection];
 244         if ([selection valueForKey:@"filename"] == NSNoSelectionMarker)
 245                 return;
 246
 247         // get the filename
 248         NSString *filename = [selection valueForKey:@"filename"];
 249         filename = [[NSURL URLWithString:filename] path];
 250         if ([filename isEqualToString:@""])
 251                 return;
 252
 253         // replace the source if necessary
 254         if (![sourceViewer.file isEqualToString:filename])
 255         {
 256                 NSString *source = [selection valueForKey:@"source"];
 257                 [sourceViewer setString:source asFile:filename];
 258
 259                 NSSet *breakpoints = [NSSet setWithArray:[[BreakpointManager sharedManager] breakpointsForFile:filename]];
 260                 [[sourceViewer numberView] setMarkers:breakpoints];
 261         }
 262
 263         int line = [[selection valueForKey:@"lineNumber"] intValue];
 264         [sourceViewer setMarkedLine:line];
 265         [sourceViewer scrollToLine:line];
 266
 267         [[sourceViewer textView] display];
 268 }
 269
 270 /**
 271  * Does some house keeping to the stack viewer
 272  */
 273 - (void)updateStackViewer
 274 {
 275         [stackArrayController rearrangeObjects];
 276         [stackArrayController setSelectionIndex:0];
 277         [self expandVariables];
 278 }
 279
 280 /**
 281  * Expands the variables based on the stored set
 282  */
 283 - (void)expandVariables
 284 {
 285         NSString *selection = [selectedVariable fullname];
 286
 287         for (int i = 0; i < [variablesOutlineView numberOfRows]; i++)
 288         {
 289                 NSTreeNode *node = [variablesOutlineView itemAtRow:i];
 290                 NSString *fullname = [[node representedObject] fullname];
 291
 292                 // see if it needs expanding
 293                 if ([expandedVariables containsObject:fullname])
 294                         [variablesOutlineView expandItem:node];
 295
 296                 // select it if we had it selected before
 297                 if ([fullname isEqualToString:selection])
 298                         [variablesTreeController setSelectionIndexPath:[node indexPath]];
 299         }
 300 }
 301
 302 #pragma mark BSSourceView Delegate
 303
 304 /**
 305  * The gutter was clicked, which indicates that a breakpoint needs to be changed
 306  */
 307 - (void)gutterClickedAtLine:(int)line forFile:(NSString *)file
 308 {
 309         BreakpointManager *mngr = [BreakpointManager sharedManager];
 310
 311         if ([mngr hasBreakpointAt:line inFile:file])
 312         {
 313                 [mngr removeBreakpointAt:line inFile:file];
 314         }
 315         else
 316         {
 317                 Breakpoint *bp = [[Breakpoint alloc] initWithLine:line inFile:file];
 318                 [mngr addBreakpoint:bp];
 319                 [bp release];
 320         }
 321
 322         [[sourceViewer numberView] setMarkers:[NSSet setWithArray:[mngr breakpointsForFile:file]]];
 323         [[sourceViewer numberView] setNeedsDisplay:YES];
 324 }
 325
 326 @end