Source/ProtocolClient.m

   1 /*
   2  * MacGDBp
   3  * Copyright (c) 2013, 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 "ProtocolClient.h"
  18
  19 #import "AppDelegate.h"
  20 #import "LoggingController.h"
  21
  22 @implementation ProtocolClient {
  23   // The object responsible for the actual communication with the debug server.
  24   MessageQueue* _messageQueue;
  25
  26   // The delegate of this class, which receives high-level messages about the
  27   // state of the debugger.
  28   id<ProtocolClientDelegate> _delegate;  // weak
  29
  30   // A map between transaction ID and handler block for that message.
  31   NSMutableDictionary<NSNumber*, ProtocolClientMessageHandler>* _dispatchTable;
  32
  33   // The next transaction ID to assign.
  34   int _nextID;
  35
  36   // Records the last read and written transaction IDs. These are only used in
  37   // creating LogEntry objects.
  38   NSInteger _lastReadID;
  39   NSInteger _lastWrittenID;
  40 }
  41
  42 - (id)initWithDelegate:(id<ProtocolClientDelegate>)delegate {
  43   if ((self = [super init])) {
  44     _delegate = delegate;
  45     _dispatchTable = [[NSMutableDictionary alloc] init];
  46   }
  47   return self;
  48 }
  49
  50 - (void)dealloc {
  51   [_dispatchTable release];
  52   [super dealloc];
  53 }
  54
  55 - (BOOL)isConnected {
  56   return [_messageQueue isConnected];
  57 }
  58
  59 - (void)connectOnPort:(NSUInteger)port {
  60   assert(!_messageQueue);
  61   _messageQueue = [[MessageQueue alloc] initWithPort:port delegate:self];
  62   [_messageQueue connect];
  63 }
  64
  65 - (void)disconnect {
  66   [_messageQueue disconnect];
  67 }
  68
  69 - (NSNumber*)sendCommandWithFormat:(NSString*)format, ... {
  70   // Collect varargs and format command.
  71   va_list args;
  72   va_start(args, format);
  73   NSString* command = [[NSString alloc] initWithFormat:format arguments:args];
  74   va_end(args);
  75
  76   NSNumber* callbackKey = [NSNumber numberWithInt:_nextID++];
  77   NSString* taggedCommand = [NSString stringWithFormat:@"%@ -i %@", [command autorelease], callbackKey];
  78
  79   assert(_messageQueue);
  80   [_messageQueue sendMessage:taggedCommand];
  81   return callbackKey;
  82 }
  83
  84 - (void)sendCommandWithFormat:(NSString*)format
  85                       handler:(ProtocolClientMessageHandler)handler, ... {
  86   // Collect varargs and format command.
  87   va_list args;
  88   va_start(args, handler);
  89   NSString* command = [[NSString alloc] initWithFormat:format arguments:args];
  90   va_end(args);
  91
  92   int transaction = _nextID++;
  93   NSString* taggedCommand = [NSString stringWithFormat:@"%@ -i %d", [command autorelease], transaction];
  94
  95   assert(_messageQueue);
  96   [_dispatchTable setObject:[[handler copy] autorelease] forKey:@(transaction)];
  97   [_messageQueue sendMessage:taggedCommand];
  98 }
  99
 100 - (NSNumber*)sendCustomCommandWithFormat:(NSString*)format, ... {
 101   // Collect varargs and format command.
 102   va_list args;
 103   va_start(args, format);
 104   NSString* command = [[[NSString alloc] initWithFormat:format arguments:args] autorelease];
 105   va_end(args);
 106
 107   NSNumber* callbackKey = [NSNumber numberWithInt:_nextID++];
 108   NSString* taggedCommand = [command stringByReplacingOccurrencesOfString:@"{txn}"
 109                                                                withString:[callbackKey stringValue]];
 110
 111   [_messageQueue sendMessage:taggedCommand];
 112   return callbackKey;
 113 }
 114
 115 - (NSInteger)transactionIDFromResponse:(NSXMLDocument*)response {
 116   return [[[[response rootElement] attributeForName:@"transaction_id"] stringValue] intValue];
 117 }
 118
 119 - (NSInteger)transactionIDFromCommand:(NSString*)command {
 120   NSRange occurrence = [command rangeOfString:@"-i "];
 121   if (occurrence.location == NSNotFound)
 122     return NSNotFound;
 123   NSString* transaction = [command substringFromIndex:occurrence.location + occurrence.length];
 124   return [transaction intValue];
 125 }
 126
 127 + (NSString*)escapedFilePathURI:(NSString*)path {
 128   // Custon GDBp paths are fine.
 129   if ([[path substringToIndex:4] isEqualToString:@"gdbp"])
 130     return path;
 131
 132   // Create a temporary URL that will escape all the nasty characters.
 133   NSURL* url = [NSURL fileURLWithPath:path];
 134   NSString* urlString = [url absoluteString];
 135
 136   // Remove the host because this is a file:// URL;
 137   NSString* host = [url host];
 138   if (host)
 139     urlString = [urlString stringByReplacingOccurrencesOfString:[url host] withString:@""];
 140
 141   // Escape % for use in printf-style NSString formatters.
 142   urlString = [urlString stringByReplacingOccurrencesOfString:@"%" withString:@"%%"];
 143   return urlString;
 144 }
 145
 146 // MessageQueueDelegate ////////////////////////////////////////////////////////
 147
 148 - (void)messageQueue:(MessageQueue*)queue error:(NSError*)error {
 149   NSLog(@"error = %@", error);
 150 }
 151
 152 - (void)messageQueueDidConnect:(MessageQueue*)queue {
 153   _nextID = 0;
 154   _lastReadID = 0;
 155   _lastWrittenID = 0;
 156
 157   [_delegate debuggerEngineConnected:self];
 158 }
 159
 160 - (void)messageQueueDidDisconnect:(MessageQueue*)queue {
 161   [_messageQueue release];
 162   _messageQueue = nil;
 163   [_dispatchTable removeAllObjects];
 164   [_delegate debuggerEngineDisconnected:self];
 165 }
 166
 167 // Callback for when a message has been sent.
 168 - (void)messageQueue:(MessageQueue*)queue didSendMessage:(NSString*)message {
 169   NSInteger tag = [self transactionIDFromCommand:message];
 170   _lastWrittenID = tag;
 171
 172   LoggingController* logger = [[AppDelegate instance] loggingController];
 173   LogEntry* entry = [LogEntry newSendEntry:message];
 174   entry.lastReadTransactionID = _lastReadID;
 175   entry.lastWrittenTransactionID = _lastWrittenID;
 176   [logger recordEntry:entry];
 177 }
 178
 179 // Callback with the message content when one has been receieved.
 180 - (void)messageQueue:(MessageQueue*)queue didReceiveMessage:(NSString*)message {
 181   // Record this message in the transaction log.
 182   LoggingController* logger = [[AppDelegate instance] loggingController];
 183   LogEntry* entry = [LogEntry newReceiveEntry:message];
 184   entry.lastReadTransactionID = _lastReadID;
 185   entry.lastWrittenTransactionID = _lastWrittenID;
 186   [logger recordEntry:entry];
 187
 188   // Parse the XML and test for errors.
 189   NSError* error = nil;
 190   NSXMLDocument* xml = [[NSXMLDocument alloc] initWithXMLString:message
 191                                                         options:NSXMLDocumentTidyXML
 192                                                           error:&error];
 193   if (error) {
 194     [self messageQueue:queue error:error];
 195     return;
 196   }
 197   int transactionID = [self transactionIDFromResponse:xml];
 198
 199   _lastReadID = transactionID;
 200   entry.lastReadTransactionID = _lastReadID;
 201
 202   if ([[[xml rootElement] elementsForName:@"error"] count] > 0) {
 203     // Handle back-end errors.
 204     [_delegate protocolClient:self receivedErrorMessage:xml];
 205   } else if ([[[xml rootElement] name] isEqualToString:@"init"]) {
 206     // Handle the initial connection message.
 207     [_delegate protocolClient:self receivedInitialMessage:xml];
 208   } else {
 209     // Dispatch the handler for the message.
 210     ProtocolClientMessageHandler handler = [_dispatchTable objectForKey:@(transactionID)];
 211     if (handler) {
 212       handler(xml);
 213       [_dispatchTable removeObjectForKey:@(transactionID)];
 214     } else {
 215       // TODO(rsesek): Remove this path once the backend rewrite is complete.
 216       [_delegate debuggerEngine:self receivedMessage:xml];
 217     }
 218   }
 219 }
 220
 221 @end