Source/GDBpConnection.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 "StackFrame.h"
  21
  22 @protocol GDBpConnectionDelegate;
  23
  24 @interface GDBpConnection : NSObject
  25 {
  26         int port;
  27         BOOL connected;
  28
  29         /**
  30          * An ever-increasing integer that gives each transaction a unique ID for
  31          * the debugging engine. Managed by |-createCommand:|.
  32          */
  33         int transactionID;
  34
  35         /**
  36          * Human-readable status of the connection
  37          */
  38         NSString* status;
  39
  40         // The raw CFSocket on which the two streams are based. Strong.
  41         CFSocketRef socket_;
  42
  43         // The read stream that is scheduled on the main run loop. Weak.
  44         CFReadStreamRef readStream_;
  45         NSMutableString* currentPacket_;
  46         int packetSize_;
  47         int currentPacketIndex_;
  48
  49         // To prevent blocked writing, we enqueue all writes and then wait for the
  50         // write stream to tell us it's ready. We store the pending commands in this
  51         // array. We use this as a stack (FIFO), with index 0 being first.
  52         NSMutableArray* queuedWrites_;
  53
  54         // The write stream. Weak.
  55         CFWriteStreamRef writeStream_;
  56
  57         // A dictionary that maps routingIDs to StackFrame objects.
  58         NSMutableDictionary* stackFrames_;
  59
  60         id <GDBpConnectionDelegate> delegate;
  61 }
  62
  63 @property (readonly, copy) NSString* status;
  64 @property (assign) id <GDBpConnectionDelegate> delegate;
  65
  66 // initializer
  67 - (id)initWithPort:(int)aPort;
  68
  69 // getter
  70 - (int)port;
  71 - (NSString*)remoteHost;
  72 - (BOOL)isConnected;
  73 - (NSArray*)getCurrentStack;
  74
  75 // communication
  76 - (void)reconnect;
  77 - (void)run;
  78 - (void)stepIn;
  79 - (void)stepOut;
  80 - (void)stepOver;
  81 - (void)addBreakpoint:(Breakpoint*)bp;
  82 - (void)removeBreakpoint:(Breakpoint*)bp;
  83
  84 // helpers
  85 - (NSArray*)getProperty:(NSString*)property;
  86
  87 @end
  88
  89 @protocol GDBpConnectionDelegate <NSObject>
  90
  91 // Passes up errors from SocketWrapper and any other errors generated by the
  92 // GDBpConnection.
  93 - (void)errorEncountered:(NSString*)error;
  94
  95 // Called when the socket connects. Passed up from SocketWrapper.
  96 - (void)debuggerConnected;
  97
  98 // Called when we disconnect.
  99 - (void)debuggerDisconnected;
 100
 101 // Tells the debugger to destroy the current stack display.
 102 - (void)clobberStack;
 103
 104 // Tells the debugger that a new stack frame is avaliable.
 105 - (void)newStackFrame:(StackFrame*)frame;
 106
 107 // A simple step has occurred. Pop the top frame the new current one is provided.
 108 - (void)popStackFrame:(StackFrame*)frame;
 109
 110 @end
 111