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         NSUInteger 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         NSUInteger 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         NSUInteger 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         NSUInteger lastWrittenTransaction_;
  70
  71         // A dictionary that maps routingIDs to StackFrame objects.
  72         NSMutableDictionary* stackFrames_;
  73         // The stack depth for the current build of |stackFrames_|.
  74         NSInteger stackDepth_;
  75         // The earliest transaction ID for the current build of |stackFrames_|.
  76         NSInteger stackFirstTransactionID_;
  77
  78         // Callback table. This maps transaction IDs to selectors. When the engine
  79         // returns a response to the debugger, we will dispatch the response XML to
  80         // the selector, based on transaction_id.
  81         NSMutableDictionary* callTable_;
  82
  83         // This stores additional context information for the callback selector.
  84         // This dictionary is keyed by the same transaction IDs in |callTable_|, but
  85         // also stores some other object that can be accessed in the callback.
  86         NSMutableDictionary* callbackContext_;
  87
  88         id <GDBpConnectionDelegate> delegate;
  89 }
  90
  91 @property (readonly, copy) NSString* status;
  92 @property (assign) id <GDBpConnectionDelegate> delegate;
  93
  94 // initializer
  95 - (id)initWithPort:(NSUInteger)aPort;
  96
  97 // getter
  98 - (NSUInteger)port;
  99 - (NSString*)remoteHost;
 100 - (BOOL)isConnected;
 101 - (NSArray*)getCurrentStack;
 102
 103 // communication
 104 - (void)reconnect;
 105 - (void)run;
 106 - (void)stepIn;
 107 - (void)stepOut;
 108 - (void)stepOver;
 109 - (void)addBreakpoint:(Breakpoint*)bp;
 110 - (void)removeBreakpoint:(Breakpoint*)bp;
 111
 112 // helpers
 113 - (NSArray*)getProperty:(NSString*)property;
 114
 115 @end
 116
 117 @protocol GDBpConnectionDelegate <NSObject>
 118
 119 // Passes up errors from SocketWrapper and any other errors generated by the
 120 // GDBpConnection.
 121 - (void)errorEncountered:(NSString*)error;
 122
 123 // Called when the socket connects. Passed up from SocketWrapper.
 124 - (void)debuggerConnected;
 125
 126 // Called when we disconnect.
 127 - (void)debuggerDisconnected;
 128
 129 // Tells the debugger to destroy the current stack display.
 130 - (void)clobberStack;
 131
 132 // Tells the debugger that a new stack frame is avaliable.
 133 - (void)newStackFrame:(StackFrame*)frame;
 134
 135 // Tells the debugger that new source is available for the given frame.
 136 - (void)sourceUpdated:(StackFrame*)frame;
 137
 138 @end
 139