Source/DebuggerProcessor.h

   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 <Cocoa/Cocoa.h>
  18
  19 #import "Breakpoint.h"
  20 #import "DebuggerConnection.h"
  21 #import "StackFrame.h"
  22
  23 @protocol DebuggerProcessorDelegate;
  24
  25 // The DebuggerConnection is the communication layer between the application
  26 // and the Xdebug engine. Clients can issue debugger commands using this class,
  27 // which are sent in an asynchronous manner. Reads are also asynchronous and
  28 // the primary client of this class should set itself as the delegate. The
  29 // primary unit that this class deals with is the StackFrame; clients should
  30 // maintain a stack structure and the Connection will inform the delegate when
  31 // a new frame is created or the stack should be destroyed.
  32 @interface DebuggerProcessor : NSObject <DebuggerConnectionDelegate>
  33 {
  34         // The connection to the debugger engine.
  35         DebuggerConnection* connection_;
  36
  37         // Human-readable status of the connection.
  38         NSString* status;
  39
  40         // The connection's delegate.
  41         id <DebuggerProcessorDelegate> delegate;
  42
  43         // A dictionary that maps routingIDs to StackFrame objects.
  44         NSMutableDictionary* stackFrames_;
  45         // The stack depth for the current build of |stackFrames_|.
  46         NSInteger stackDepth_;
  47         // The earliest transaction ID for the current build of |stackFrames_|.
  48         NSInteger stackFirstTransactionID_;
  49
  50         // Callback table. This maps transaction IDs to selectors. When the engine
  51         // returns a response to the debugger, we will dispatch the response XML to
  52         // the selector, based on transaction_id.
  53         NSMutableDictionary* callTable_;
  54
  55         // This stores additional context information for the callback selector.
  56         // This dictionary is keyed by the same transaction IDs in |callTable_|, but
  57         // also stores some other object that can be accessed in the callback.
  58         NSMutableDictionary* callbackContext_;
  59 }
  60
  61 @property (readonly, copy) NSString* status;
  62 @property (assign) id <DebuggerProcessorDelegate> delegate;
  63
  64 // initializer
  65 - (id)initWithPort:(NSUInteger)aPort;
  66
  67 // getter
  68 - (NSUInteger)port;
  69 - (NSString*)remoteHost;
  70 - (BOOL)isConnected;
  71
  72 // communication
  73 - (void)reconnect;
  74 - (void)run;
  75 - (void)stepIn;
  76 - (void)stepOut;
  77 - (void)stepOver;
  78 - (void)addBreakpoint:(Breakpoint*)bp;
  79 - (void)removeBreakpoint:(Breakpoint*)bp;
  80
  81 // Gets a property by name from the debugger engine. Returns a transaction ID
  82 // which used in the delegate callback.
  83 - (NSInteger)getProperty:(NSString*)property;
  84
  85 // Takes a partially loaded stack frame and fetches the rest of the information.
  86 - (void)loadStackFrame:(StackFrame*)frame;
  87
  88 @end
  89
  90 // Delegate ////////////////////////////////////////////////////////////////////
  91
  92 @protocol DebuggerProcessorDelegate <NSObject>
  93
  94 // Passes up errors from SocketWrapper and any other errors generated by the
  95 // GDBpConnection.
  96 - (void)errorEncountered:(NSString*)error;
  97
  98 // Called when the socket connects. Passed up from SocketWrapper.
  99 - (void)debuggerConnected;
 100
 101 // Called when we disconnect.
 102 - (void)debuggerDisconnected;
 103
 104 // Tells the debugger to destroy the current stack display.
 105 - (void)clobberStack;
 106
 107 // Tells the debugger that a new stack frame is avaliable.
 108 - (void)newStackFrame:(StackFrame*)frame;
 109
 110 // Tells the debugger that new source is available for the given frame.
 111 // TODO: rename to |-frameUpdated:|.
 112 - (void)sourceUpdated:(StackFrame*)frame;
 113
 114 // Callback from |-getProperty:|.
 115 - (void)receivedProperties:(NSArray*)properties forTransaction:(NSInteger)transaction;
 116
 117 @end
 118