Source/DebuggerConnection.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 @protocol DebuggerConnectionDelegate;
  20 @class LoggingController;
  21
  22 @interface DebuggerConnection : NSObject
  23 {
  24         // The port to connect on.
  25         NSUInteger port_;
  26
  27         // If the connection to the debugger engine is currently active.
  28         BOOL connected_;
  29
  30         // Reference to the message loop that the socket runs on. Weak.
  31         NSRunLoop* runLoop_;
  32
  33         // The raw CFSocket on which the two streams are based. Strong.
  34         CFSocketRef socket_;
  35
  36         // The read stream that is scheduled on the main run loop. Weak.
  37         CFReadStreamRef readStream_;
  38
  39         // The write stream. Weak.
  40         CFWriteStreamRef writeStream_;
  41
  42         // An ever-increasing integer that gives each transaction a unique ID for the
  43         // debugging engine.
  44         NSUInteger transactionID;
  45
  46         // The most recently received transaction ID.
  47         NSUInteger lastReadTransaction_;
  48
  49         // The last transactionID written to the stream.
  50         NSUInteger lastWrittenTransaction_;
  51
  52         // To prevent blocked writing, we enqueue all writes and then wait for the
  53         // write stream to tell us it's ready. We store the pending commands in this
  54         // array. We use this as a stack (FIFO), with index 0 being first.
  55         NSMutableArray* queuedWrites_;
  56
  57         // We send queued writes in multiple places, sometimes off a run loop event.
  58         // Because of this, we need to ensure that only one client is dequeing and
  59         // sending at a time.
  60         NSRecursiveLock* writeQueueLock_;
  61
  62         // Information about the current read loop. We append to |currentPacket_|
  63         // until |currentPacketSize_| has reached |packetSize_|.
  64         NSMutableString* currentPacket_;
  65         int packetSize_;
  66         int currentPacketIndex_;
  67
  68         // The delegate.
  69         id <DebuggerConnectionDelegate> delegate_;
  70 }
  71
  72 @property (readonly) NSUInteger port;
  73 @property (readonly) BOOL connected;
  74 @property (assign) id <DebuggerConnectionDelegate> delegate;
  75
  76 - (id)initWithPort:(NSUInteger)aPort;
  77
  78 - (void)connect;
  79 - (void)close;
  80 - (void)socketDidAccept;
  81 - (void)socketDisconnected;
  82 - (void)readStreamHasData;
  83 - (void)send:(NSString*)command;
  84 - (void)performSend:(NSString*)command;
  85 - (void)errorEncountered:(NSString*)error;
  86
  87 - (void)handleResponse:(NSXMLDocument*)response;
  88 - (void)handlePacket:(NSString*)packet;
  89
  90 - (NSNumber*)sendCommandWithFormat:(NSString*)format, ...;
  91
  92 - (void)sendQueuedWrites;
  93
  94 - (NSString*)escapedURIPath:(NSString*)path;
  95 - (NSInteger)transactionIDFromResponse:(NSXMLDocument*)response;
  96 - (NSInteger)transactionIDFromCommand:(NSString*)command;
  97
  98 @end
  99
 100 // Delegate ////////////////////////////////////////////////////////////////////
 101
 102 @protocol DebuggerConnectionDelegate <NSObject>
 103
 104 @optional
 105
 106 - (void)connectionDidAccept:(DebuggerConnection*)cx;
 107 - (void)connectionDidCose:(DebuggerConnection*)cx;
 108
 109 - (void)handleInitialResponse:(NSXMLDocument*)response;
 110
 111 - (void)handleResponse:(NSXMLDocument*)response;
 112
 113 - (void)errorEncountered:(NSString*)error;
 114
 115 @end
 116