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
  46         // The most recently received transaction ID.
  47         int lastReadTransaction_;
  48
  49         // Information about the current read loop. We append to |currentPacket_|
  50         // until |currentPacketSize_| has reached |packetSize_|.
  51         NSMutableString* currentPacket_;
  52         int packetSize_;
  53         int currentPacketIndex_;
  54
  55         // To prevent blocked writing, we enqueue all writes and then wait for the
  56         // write stream to tell us it's ready. We store the pending commands in this
  57         // array. We use this as a stack (FIFO), with index 0 being first.
  58         NSMutableArray* queuedWrites_;
  59
  60         // We send queued writes in multiple places, sometimes of a run loop event.
  61         // Because of this, we need to ensure that only one client is dequeing and
  62         // sending at a time.
  63         NSRecursiveLock* writeQueueLock_;
  64
  65         // The write stream. Weak.
  66         CFWriteStreamRef writeStream_;
  67
  68         // The last transactionID written to the stream.
  69         int lastWrittenTransaction_;
  70
  71         // A dictionary that maps routingIDs to StackFrame objects.
  72         NSMutableDictionary* stackFrames_;
  73
  74         id <GDBpConnectionDelegate> delegate;
  75 }
  76
  77 @property (readonly, copy) NSString* status;
  78 @property (assign) id <GDBpConnectionDelegate> delegate;
  79
  80 // initializer
  81 - (id)initWithPort:(int)aPort;
  82
  83 // getter
  84 - (int)port;
  85 - (NSString*)remoteHost;
  86 - (BOOL)isConnected;
  87 - (NSArray*)getCurrentStack;
  88
  89 // communication
  90 - (void)reconnect;
  91 - (void)run;
  92 - (void)stepIn;
  93 - (void)stepOut;
  94 - (void)stepOver;
  95 - (void)addBreakpoint:(Breakpoint*)bp;
  96 - (void)removeBreakpoint:(Breakpoint*)bp;
  97
  98 // helpers
  99 - (NSArray*)getProperty:(NSString*)property;
 100
 101 @end
 102
 103 @protocol GDBpConnectionDelegate <NSObject>
 104
 105 // Passes up errors from SocketWrapper and any other errors generated by the
 106 // GDBpConnection.
 107 - (void)errorEncountered:(NSString*)error;
 108
 109 // Called when the socket connects. Passed up from SocketWrapper.
 110 - (void)debuggerConnected;
 111
 112 // Called when we disconnect.
 113 - (void)debuggerDisconnected;
 114
 115 // Tells the debugger to destroy the current stack display.
 116 - (void)clobberStack;
 117
 118 // Tells the debugger that a new stack frame is avaliable.
 119 - (void)newStackFrame:(StackFrame*)frame;
 120
 121 // A simple step has occurred. Pop the top frame the new current one is provided.
 122 - (void)popStackFrame:(StackFrame*)frame;
 123
 124 @end
 125