3 * Copyright (c) 2007 - 2010, Blue Static <http://www.bluestatic.org>
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.
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.
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
17 #import <sys/socket.h>
18 #import <netinet/in.h>
20 #import "DebuggerConnection.h"
22 #import "AppDelegate.h"
23 #import "LoggingController.h"
25 // GDBpConnection (Private) ////////////////////////////////////////////////////
27 @interface DebuggerConnection ()
28 @property (readwrite
, copy
) NSString
* status
;
29 @property (assign
) CFSocketRef socket
;
30 @property (assign
) CFReadStreamRef readStream
;
31 @property NSUInteger lastReadTransaction
;
32 @property (retain
) NSMutableString
* currentPacket
;
33 @property (assign
) CFWriteStreamRef writeStream
;
34 @property NSUInteger lastWrittenTransaction
;
35 @property (retain
) NSMutableArray
* queuedWrites
;
39 - (void)socketDidAccept
;
40 - (void)socketDisconnected
;
41 - (void)readStreamHasData
;
42 - (void)send
:(NSString
*)command
;
43 - (void)performSend
:(NSString
*)command
;
44 - (void)errorEncountered
:(NSString
*)error
;
46 - (void)handleResponse
:(NSXMLDocument
*)response
;
47 - (void)handlePacket
:(NSString
*)packet
;
49 - (void)initReceived
:(NSXMLDocument
*)response
;
50 - (void)updateStatus
:(NSXMLDocument
*)response
;
51 - (void)debuggerStep
:(NSXMLDocument
*)response
;
52 - (void)rebuildStack
:(NSXMLDocument
*)response
;
53 - (void)getStackFrame
:(NSXMLDocument
*)response
;
54 - (void)setSource
:(NSXMLDocument
*)response
;
55 - (void)contextsReceived
:(NSXMLDocument
*)response
;
56 - (void)variablesReceived
:(NSXMLDocument
*)response
;
57 - (void)propertiesReceived
:(NSXMLDocument
*)response
;
59 - (NSNumber
*)sendCommandWithCallback
:(SEL)callback format
:(NSString
*)format
, ...
;
61 - (void)sendQueuedWrites
;
63 - (NSString
*)escapedURIPath
:(NSString
*)path
;
64 - (NSInteger
)transactionIDFromResponse
:(NSXMLDocument
*)response
;
65 - (NSInteger
)transactionIDFromCommand
:(NSString
*)command
;
68 // CFNetwork Callbacks /////////////////////////////////////////////////////////
70 void ReadStreamCallback(CFReadStreamRef stream
, CFStreamEventType eventType
, void* connectionRaw
)
72 DebuggerConnection
* connection
= (DebuggerConnection
*)connectionRaw
;
75 case kCFStreamEventHasBytesAvailable
:
76 [connection readStreamHasData
];
79 case kCFStreamEventErrorOccurred
:
81 CFErrorRef error
= CFReadStreamCopyError(stream
);
82 CFReadStreamUnscheduleFromRunLoop(stream
, CFRunLoopGetCurrent(), kCFRunLoopCommonModes
);
83 CFReadStreamClose(stream
);
85 [connection errorEncountered
:[[(NSError
*)error autorelease
] description
]];
89 case kCFStreamEventEndEncountered
:
90 CFReadStreamUnscheduleFromRunLoop(stream
, CFRunLoopGetCurrent(), kCFRunLoopCommonModes
);
91 CFReadStreamClose(stream
);
93 [connection socketDisconnected
];
98 void WriteStreamCallback(CFWriteStreamRef stream
, CFStreamEventType eventType
, void* connectionRaw
)
100 DebuggerConnection
* connection
= (DebuggerConnection
*)connectionRaw
;
103 case kCFStreamEventCanAcceptBytes
:
104 [connection sendQueuedWrites
];
107 case kCFStreamEventErrorOccurred
:
109 CFErrorRef error
= CFWriteStreamCopyError(stream
);
110 CFWriteStreamUnscheduleFromRunLoop(stream
, CFRunLoopGetCurrent(), kCFRunLoopCommonModes
);
111 CFWriteStreamClose(stream
);
113 [connection errorEncountered
:[[(NSError
*)error autorelease
] description
]];
117 case kCFStreamEventEndEncountered
:
118 CFWriteStreamUnscheduleFromRunLoop(stream
, CFRunLoopGetCurrent(), kCFRunLoopCommonModes
);
119 CFWriteStreamClose(stream
);
121 [connection socketDisconnected
];
126 void SocketAcceptCallback(CFSocketRef socket
,
127 CFSocketCallBackType callbackType
,
132 assert(callbackType
== kCFSocketAcceptCallBack
);
133 NSLog(@
"SocketAcceptCallback()");
135 DebuggerConnection
* connection
= (DebuggerConnection
*)connectionRaw
;
137 CFReadStreamRef readStream
;
138 CFWriteStreamRef writeStream
;
140 // Create the streams on the socket.
141 CFStreamCreatePairWithSocket(kCFAllocatorDefault
,
142 *(CFSocketNativeHandle
*)data
, // Socket handle.
143 &readStream
, // Read stream in-pointer.
144 &writeStream
); // Write stream in-pointer.
146 // Create struct to register callbacks for the stream.
147 CFStreamClientContext context
;
149 context.info
= connection
;
150 context.retain
= NULL
;
151 context.release
= NULL
;
152 context.copyDescription
= NULL
;
154 // Set the client of the read stream.
155 CFOptionFlags readFlags
=
156 kCFStreamEventOpenCompleted |
157 kCFStreamEventHasBytesAvailable |
158 kCFStreamEventErrorOccurred |
159 kCFStreamEventEndEncountered
;
160 if (CFReadStreamSetClient(readStream
, readFlags
, ReadStreamCallback
, &context
))
161 // Schedule in run loop to do asynchronous communication with the engine.
162 CFReadStreamScheduleWithRunLoop(readStream
, CFRunLoopGetCurrent(), kCFRunLoopCommonModes
);
166 // Open the stream now that it's scheduled on the run loop.
167 if (!CFReadStreamOpen(readStream
))
169 CFStreamError error
= CFReadStreamGetError(readStream
);
170 NSLog(@
"error! %@", error
);
174 // Set the client of the write stream.
175 CFOptionFlags writeFlags
=
176 kCFStreamEventOpenCompleted |
177 kCFStreamEventCanAcceptBytes |
178 kCFStreamEventErrorOccurred |
179 kCFStreamEventEndEncountered
;
180 if (CFWriteStreamSetClient(writeStream
, writeFlags
, WriteStreamCallback
, &context
))
181 // Schedule it in the run loop to receive error information.
182 CFWriteStreamScheduleWithRunLoop(writeStream
, CFRunLoopGetCurrent(), kCFRunLoopCommonModes
);
186 // Open the write stream.
187 if (!CFWriteStreamOpen(writeStream
))
189 CFStreamError error
= CFWriteStreamGetError(writeStream
);
190 NSLog(@
"error! %@", error
);
194 connection.readStream
= readStream
;
195 connection.writeStream
= writeStream
;
196 [connection socketDidAccept
];
199 // GDBpConnection //////////////////////////////////////////////////////////////
201 @implementation DebuggerConnection
202 @synthesize socket
= socket_
;
203 @synthesize readStream
= readStream_
;
204 @synthesize lastReadTransaction
= lastReadTransaction_
;
205 @synthesize currentPacket
= currentPacket_
;
206 @synthesize writeStream
= writeStream_
;
207 @synthesize lastWrittenTransaction
= lastWrittenTransaction_
;
208 @synthesize queuedWrites
= queuedWrites_
;
210 @synthesize delegate
;
213 * Creates a new DebuggerConnection and initializes the socket from the given connection
216 - (id)initWithPort
:(NSUInteger
)aPort
218 if (self = [super init
])
223 [[BreakpointManager sharedManager
] setConnection
:self];
230 * Deallocates the object
235 self.currentPacket
= nil;
241 // Getters /////////////////////////////////////////////////////////////////////
245 * Gets the port number
253 * Returns the name of the remote host
255 - (NSString
*)remoteHost
259 return @
"(DISCONNECTED)";
261 // TODO: Either impl or remove.
266 * Returns whether or not we have an active connection
273 // Commands ////////////////////////////////////////////////////////////////////
274 #pragma mark Commands
277 * Reestablishes communication with the remote debugger so that a new connection doesn't have to be
278 * created every time you want to debug a page
283 self.status
= @
"Connecting";
288 * Tells the debugger to continue running the script. Returns the current stack frame.
292 [self sendCommandWithCallback
:@selector(debuggerStep
:) format
:@
"run"];
296 * Tells the debugger to step into the current command.
300 [self sendCommandWithCallback
:@selector(debuggerStep
:) format
:@
"step_into"];
304 * Tells the debugger to step out of the current context
308 [self sendCommandWithCallback
:@selector(debuggerStep
:) format
:@
"step_out"];
312 * Tells the debugger to step over the current function
316 [self sendCommandWithCallback
:@selector(debuggerStep
:) format
:@
"step_over"];
320 * Tells the debugger engine to get a specifc property. This also takes in the NSXMLElement
321 * that requested it so that the child can be attached.
323 - (NSInteger
)getProperty
:(NSString
*)property
325 [self sendCommandWithCallback
:@selector(propertiesReceived
:) format
:@
"property_get -n \"%@\"", property
];
328 // Breakpoint Management ///////////////////////////////////////////////////////
329 #pragma mark Breakpoints
332 * Send an add breakpoint command
334 - (void)addBreakpoint
:(Breakpoint
*)bp
339 NSString
* file
= [self escapedURIPath
:[bp transformedPath
]];
340 NSNumber
* transaction
= [self sendCommandWithCallback
:@selector(breakpointReceived
:)
341 format
:@
"breakpoint_set -t line -f %@ -n %i", file
, [bp line
]];
342 [callbackContext_ setObject
:bp forKey
:transaction
];
346 * Removes a breakpoint
348 - (void)removeBreakpoint
:(Breakpoint
*)bp
355 [self sendCommandWithCallback
:nil format
:@
"breakpoint_remove -d %i", [bp debuggerId
]];
359 // Socket and Stream Callbacks /////////////////////////////////////////////////
360 #pragma mark Callbacks
363 * Called by SocketWrapper after the connection is successful. This immediately calls
364 * -[SocketWrapper receive] to clear the way for communication, though the information
365 * could be useful server information that we don't use right now.
367 - (void)socketDidAccept
371 stackFrames_
= [[NSMutableDictionary alloc
] init
];
372 self.queuedWrites
= [NSMutableArray array
];
373 writeQueueLock_
= [NSRecursiveLock
new];
374 callTable_
= [NSMutableDictionary
new];
375 callbackContext_
= [NSMutableDictionary
new];
379 * Receives errors from the SocketWrapper and updates the display
381 - (void)errorEncountered
:(NSString
*)error
383 [delegate errorEncountered
:error
];
387 * Creates, connects to, and schedules a CFSocket.
391 // Pass ourselves to the callback so we don't have to use ugly globals.
392 CFSocketContext context
;
395 context.retain
= NULL
;
396 context.release
= NULL
;
397 context.copyDescription
= NULL
;
399 // Create the address structure.
400 struct sockaddr_in address
;
401 memset(&address
, 0, sizeof(address
));
402 address.sin_len
= sizeof(address
);
403 address.sin_family
= AF_INET
;
404 address.sin_port
= htons(port
);
405 address.sin_addr.s_addr
= htonl(INADDR_ANY
);
407 // Create the socket signature.
408 CFSocketSignature signature
;
409 signature.protocolFamily
= PF_INET
;
410 signature.socketType
= SOCK_STREAM
;
411 signature.protocol
= IPPROTO_TCP
;
412 signature.address
= (CFDataRef
)[NSData dataWithBytes
:&address length
:sizeof(address
)];
414 socket_
= CFSocketCreateWithSocketSignature(kCFAllocatorDefault
,
415 &signature
, // Socket signature.
416 kCFSocketAcceptCallBack
, // Callback types.
417 SocketAcceptCallback
, // Callout function pointer.
418 &context
); // Context to pass to callout.
421 [self errorEncountered
:@
"Could not open socket."];
425 // Allow old, yet-to-be recycled sockets to be reused.
427 setsockopt(CFSocketGetNative(socket_
), SOL_SOCKET
, SO_REUSEADDR
, &yes
, sizeof(BOOL));
429 // Schedule the socket on the run loop.
430 CFRunLoopSourceRef source
= CFSocketCreateRunLoopSource(kCFAllocatorDefault
, socket_
, 0);
431 CFRunLoopAddSource(CFRunLoopGetCurrent(), source
, kCFRunLoopCommonModes
);
434 self.status
= @
"Connecting";
438 * Closes a socket and releases the ref.
442 // The socket goes down, so do the streams, which clean themselves up.
443 CFSocketInvalidate(socket_
);
445 [stackFrames_ release
];
446 self.queuedWrites
= nil;
447 [writeQueueLock_ release
];
448 [callTable_ release
];
449 [callbackContext_ release
];
453 * Notification that the socket disconnected.
455 - (void)socketDisconnected
458 [delegate debuggerDisconnected
];
462 * Callback from the CFReadStream that there is data waiting to be read.
464 - (void)readStreamHasData
466 const NSUInteger kBufferSize
= 1024;
467 UInt8 buffer
[kBufferSize
];
468 CFIndex bufferOffset
= 0; // Starting point in |buffer| to work with.
469 CFIndex bytesRead
= CFReadStreamRead(readStream_
, buffer
, kBufferSize
);
470 const char* charBuffer
= (const char*)buffer
;
472 // The read loop works by going through the buffer until all the bytes have
474 while (bufferOffset
< bytesRead
)
476 // strlen() counts to the first non-NULL character.
477 NSUInteger partLength
= MIN(strlen(charBuffer
+ bufferOffset
), kBufferSize
- bufferOffset
);
479 // If there is not a current packet, set some state.
480 if (!self.currentPacket
)
482 // Read the message header: the size. This will be |partLength| bytes.
483 packetSize_
= atoi(charBuffer
+ bufferOffset
);
484 currentPacketIndex_
= 0;
485 self.currentPacket
= [NSMutableString stringWithCapacity
:packetSize_
];
486 bufferOffset
+= partLength
+ 1; // Pass over the NULL byte.
487 continue; // Spin the loop to begin reading actual data.
490 // Substring the byte stream and append it to the packet string.
491 CFStringRef bufferString
= CFStringCreateWithBytes(kCFAllocatorDefault
,
492 buffer
+ bufferOffset
, // Byte pointer, offset by start index.
493 partLength
, // Length.
494 kCFStringEncodingUTF8
,
496 [self.currentPacket appendString
:(NSString
*)bufferString
];
497 CFRelease(bufferString
);
500 currentPacketIndex_
+= partLength
;
501 bufferOffset
+= partLength
+ 1;
503 // If this read finished the packet, handle it and reset.
504 NSLog(@
"cpi %d ps %d br %d ds %d", currentPacketIndex_
, packetSize_
, bytesRead
, partLength
);
505 if (currentPacketIndex_
>= packetSize_
)
507 [self handlePacket
:[[currentPacket_ retain
] autorelease
]];
508 self.currentPacket
= nil;
510 currentPacketIndex_
= 0;
516 * Performs the packet handling of a raw string XML packet. From this point on,
517 * the packets are associated with a transaction and are then dispatched.
519 - (void)handlePacket
:(NSString
*)packet
521 // Test if we can convert it into an NSXMLDocument.
522 NSError
* error
= nil;
523 NSXMLDocument
* xmlTest
= [[NSXMLDocument alloc
] initWithXMLString
:currentPacket_ options
:NSXMLDocumentTidyXML error
:&error
];
525 // Try to recover if we encountered an error.
528 // We do not want to starve the write queue, so manually parse out the
530 NSRange location
= [currentPacket_ rangeOfString
:@
"transaction_id"];
531 if (location.location
!= NSNotFound
)
533 NSUInteger start
= location.location
+ location.length
;
534 NSUInteger end
= start
;
536 NSCharacterSet
* numericSet
= [NSCharacterSet decimalDigitCharacterSet
];
538 // Loop over the characters after the attribute name to extract the ID.
539 while (end
< [currentPacket_ length
])
541 unichar c
= [currentPacket_ characterAtIndex
:end
];
542 if ([numericSet characterIsMember
:c
])
544 // If this character is numeric, extend the range to substring.
551 // If this character is nonnumeric and we have nothing in the
552 // range, skip this character.
558 // We've moved past the numeric ID so we should stop searching.
564 // If we were able to extract the transaction ID, update the last read.
565 NSRange substringRange
= NSMakeRange(start
, end
- start
);
566 NSString
* transactionStr
= [currentPacket_ substringWithRange
:substringRange
];
567 if ([transactionStr length
])
568 lastReadTransaction_
= [transactionStr intValue
];
571 // Otherwise, assume +1 and hope it works.
572 ++lastReadTransaction_
;
576 // See if the transaction can be parsed out.
577 NSInteger transaction
= [self transactionIDFromResponse
:xmlTest
];
578 if (transaction
< lastReadTransaction_
)
580 NSLog(@
"tx = %d vs %d", transaction
, lastReadTransaction_
);
581 NSLog(@
"out of date transaction %@", packet
);
585 if (transaction
!= lastWrittenTransaction_
)
586 NSLog(@
"txn %d(%d) <> %d doesn't match last written", transaction
, lastReadTransaction_
, lastWrittenTransaction_
);
588 lastReadTransaction_
= transaction
;
591 // Log this receive event.
592 LoggingController
* logger
= [(AppDelegate
*)[NSApp delegate
] loggingController
];
593 LogEntry
* log
= [logger recordReceive
:currentPacket_
];
595 log.lastWrittenTransactionID
= lastWrittenTransaction_
;
596 log.lastReadTransactionID
= lastReadTransaction_
;
598 // Finally, dispatch the handler for this response.
599 [self handleResponse
:[xmlTest autorelease
]];
603 * Writes a command into the write stream. If the stream is ready for writing,
604 * we do so immediately. If not, the command is queued and will be written
605 * when the stream is ready.
607 - (void)send
:(NSString
*)command
609 if (CFWriteStreamCanAcceptBytes(writeStream_
))
610 [self performSend
:command
];
612 [queuedWrites_ addObject
:command
];
613 [self sendQueuedWrites
];
617 * This performs a blocking send. This should ONLY be called when we know we
618 * have write access to the stream. We will busy wait in case we don't do a full
621 - (void)performSend
:(NSString
*)command
623 // If this is an out-of-date transaction, do not bother sending it.
624 NSInteger transaction
= [self transactionIDFromCommand
:command
];
625 if (transaction
!= NSNotFound
&& transaction
< lastWrittenTransaction_
)
630 char* string
= (char*)[command UTF8String
];
631 int stringLength
= strlen(string
);
633 // Busy wait while writing. BAADD. Should background this operation.
636 if (CFWriteStreamCanAcceptBytes(writeStream_
))
638 // Include the NULL byte in the string when we write.
639 int bytesWritten
= CFWriteStreamWrite(writeStream_
, (UInt8
*)string
, stringLength
+ 1);
640 if (bytesWritten
< 0)
642 NSLog(@
"write error");
645 else if (bytesWritten
< strlen(string
))
647 // Adjust the buffer and wait for another chance to write.
648 stringLength
-= bytesWritten
;
649 memmove(string
, string
+ bytesWritten
, stringLength
);
655 // We need to scan the string to find the transactionID.
656 if (transaction
== NSNotFound
)
658 NSLog(@
"sent %@ without a transaction ID", command
);
661 lastWrittenTransaction_
= transaction
;
666 // Log this trancation.
667 LoggingController
* logger
= [(AppDelegate
*)[NSApp delegate
] loggingController
];
668 LogEntry
* log
= [logger recordSend
:command
];
669 log.lastWrittenTransactionID
= lastWrittenTransaction_
;
670 log.lastReadTransactionID
= lastReadTransaction_
;
673 - (void)handleResponse
:(NSXMLDocument
*)response
675 // Check and see if there's an error.
676 NSArray
* error
= [[response rootElement
] elementsForName
:@
"error"];
677 if ([error count
] > 0)
679 NSLog(@
"Xdebug error: %@", error
);
680 [delegate errorEncountered
:[[[[error objectAtIndex
:0] children
] objectAtIndex
:0] stringValue
]];
683 if ([[[response rootElement
] name
] isEqualToString
:@
"init"])
685 [self initReceived
:response
];
689 NSString
* callbackStr
= [callTable_ objectForKey
:[NSNumber numberWithInt
:lastReadTransaction_
]];
692 SEL callback
= NSSelectorFromString(callbackStr
);
693 [self performSelector
:callback withObject
:response
];
696 [self sendQueuedWrites
];
699 // Specific Response Handlers //////////////////////////////////////////////////
700 #pragma mark Response Handlers
703 * Initial packet received. We've started a brand-new connection to the engine.
705 - (void)initReceived
:(NSXMLDocument
*)response
707 // Register any breakpoints that exist offline.
708 for (Breakpoint
* bp
in [[BreakpointManager sharedManager
] breakpoints
])
709 [self addBreakpoint
:bp
];
711 // Load the debugger to make it look active.
712 [delegate debuggerConnected
];
714 // TODO: update the status.
718 * Receiver for status updates. This just freshens up the UI.
720 - (void)updateStatus
:(NSXMLDocument
*)response
722 self.status
= [[[[response rootElement
] attributeForName
:@
"status"] stringValue
] capitalizedString
];
723 if (status
== nil ||
[status isEqualToString
:@
"Stopped"] ||
[status isEqualToString
:@
"Stopping"])
727 [delegate debuggerDisconnected
];
729 self.status
= @
"Stopped";
734 * Step in/out/over and run all take this path. We first get the status of the
735 * debugger and then request fresh stack information.
737 - (void)debuggerStep
:(NSXMLDocument
*)response
739 [self updateStatus
:response
];
743 // If this is the run command, tell the delegate that a bunch of updates
744 // are coming. Also remove all existing stack routes and request a new stack.
745 // TODO: figure out if we can not clobber the stack every time.
746 NSString
* command
= [[[response rootElement
] attributeForName
:@
"command"] stringValue
];
747 if (YES ||
[command isEqualToString
:@
"run"])
749 if ([delegate respondsToSelector
:@selector(clobberStack
)])
750 [delegate clobberStack
];
751 [stackFrames_ removeAllObjects
];
752 stackFirstTransactionID_
= [[self sendCommandWithCallback
:@selector(rebuildStack
:) format
:@
"stack_depth"] intValue
];
757 * We ask for the stack_depth and now we clobber the stack and start rebuilding
760 - (void)rebuildStack
:(NSXMLDocument
*)response
762 NSInteger depth
= [[[[response rootElement
] attributeForName
:@
"depth"] stringValue
] intValue
];
764 if (stackFirstTransactionID_
== [self transactionIDFromResponse
:response
])
767 // We now need to alloc a bunch of stack frames and get the basic information
769 for (NSInteger i
= 0; i
< depth
; i
++)
771 // Use the transaction ID to create a routing path.
772 NSNumber
* routingID
= [self sendCommandWithCallback
:@selector(getStackFrame
:) format
:@
"stack_get -d %d", i
];
773 [stackFrames_ setObject
:[StackFrame alloc
] forKey
:routingID
];
778 * The initial rebuild of the stack frame. We now have enough to initialize
779 * a StackFrame object.
781 - (void)getStackFrame
:(NSXMLDocument
*)response
783 // Get the routing information.
784 NSInteger routingID
= [self transactionIDFromResponse
:response
];
785 if (routingID
< stackFirstTransactionID_
)
787 NSNumber
* routingNumber
= [NSNumber numberWithInt
:routingID
];
789 // Make sure we initialized this frame in our last |-rebuildStack:|.
790 StackFrame
* frame
= [stackFrames_ objectForKey
:routingNumber
];
794 NSXMLElement
* xmlframe
= [[[response rootElement
] children
] objectAtIndex
:0];
796 // Initialize the stack frame.
797 [frame initWithIndex
:[[[xmlframe attributeForName
:@
"level"] stringValue
] intValue
]
798 withFilename
:[[xmlframe attributeForName
:@
"filename"] stringValue
]
800 atLine
:[[[xmlframe attributeForName
:@
"lineno"] stringValue
] intValue
]
801 inFunction
:[[xmlframe attributeForName
:@
"where"] stringValue
]
804 // Get the source code of the file. Escape % in URL chars.
805 NSString
* escapedFilename
= [frame.filename stringByReplacingOccurrencesOfString
:@
"%" withString
:@
"%%"];
806 NSNumber
* transaction
= [self sendCommandWithCallback
:@selector(setSource
:) format
:@
"source -f %@", escapedFilename
];
807 [callbackContext_ setObject
:routingNumber forKey
:transaction
];
809 // Get the names of all the contexts.
810 transaction
= [self sendCommandWithCallback
:@selector(contextsReceived
:) format
:@
"context_names -d %d", frame.index
];
811 [callbackContext_ setObject
:routingNumber forKey
:transaction
];
813 if ([delegate respondsToSelector
:@selector(newStackFrame
:)])
814 [delegate newStackFrame
:frame
];
818 * Callback for setting the source of a file while rebuilding a specific stack
821 - (void)setSource
:(NSXMLDocument
*)response
823 NSNumber
* transaction
= [NSNumber numberWithInt
:[self transactionIDFromResponse
:response
]];
824 if ([transaction intValue
] < stackFirstTransactionID_
)
826 NSNumber
* routingNumber
= [callbackContext_ objectForKey
:transaction
];
830 [callbackContext_ removeObjectForKey
:transaction
];
831 StackFrame
* frame
= [stackFrames_ objectForKey
:routingNumber
];
835 frame.source
= [[response rootElement
] value
];
837 if ([delegate respondsToSelector
:@selector(sourceUpdated
:)])
838 [delegate sourceUpdated
:frame
];
842 * Enumerates all the contexts of a given stack frame. We then in turn get the
843 * contents of each one of these contexts.
845 - (void)contextsReceived
:(NSXMLDocument
*)response
847 // Get the stack frame's routing ID and use it again.
848 NSNumber
* receivedTransaction
= [NSNumber numberWithInt
:[self transactionIDFromResponse
:response
]];
849 if ([receivedTransaction intValue
] < stackFirstTransactionID_
)
851 NSNumber
* routingID
= [callbackContext_ objectForKey
:receivedTransaction
];
855 // Get the stack frame by the |routingID|.
856 StackFrame
* frame
= [stackFrames_ objectForKey
:routingID
];
858 NSXMLElement
* contextNames
= [response rootElement
];
859 for (NSXMLElement
* context
in [contextNames children
])
861 NSInteger cid
= [[[context attributeForName
:@
"id"] stringValue
] intValue
];
863 // Fetch each context's variables.
864 NSNumber
* transaction
= [self sendCommandWithCallback
:@selector(variablesReceived
:)
865 format
:@
"context_get -d %d -c %d", frame.index
, cid
];
866 [callbackContext_ setObject
:routingID forKey
:transaction
];
871 * Receives the variables from the context and attaches them to the stack frame.
873 - (void)variablesReceived
:(NSXMLDocument
*)response
875 // Get the stack frame's routing ID and use it again.
876 NSInteger transaction
= [self transactionIDFromResponse
:response
];
877 if (transaction
< stackFirstTransactionID_
)
879 NSNumber
* receivedTransaction
= [NSNumber numberWithInt
:transaction
];
880 NSNumber
* routingID
= [callbackContext_ objectForKey
:receivedTransaction
];
884 // Get the stack frame by the |routingID|.
885 StackFrame
* frame
= [stackFrames_ objectForKey
:routingID
];
887 NSMutableArray
* variables
= [NSMutableArray array
];
889 // Merge the frame's existing variables.
891 [variables addObjectsFromArray
:frame.variables
];
893 // Add these new variables.
894 NSArray
* addVariables
= [[response rootElement
] children
];
896 [variables addObjectsFromArray
:addVariables
];
898 frame.variables
= variables
;
902 * Callback from a |-getProperty:| request.
904 - (void)propertiesReceived
:(NSXMLDocument
*)response
906 NSInteger transaction
= [self transactionIDFromResponse
:response
];
910 <property> <!-- this is the one we requested -->
911 <property ... /> <!-- these are what we want -->
916 // Detach all the children so we can insert them into another document.
917 NSXMLElement
* parent
= (NSXMLElement
*)[[response rootElement
] childAtIndex
:0];
918 NSArray
* children
= [parent children
];
919 [parent setChildren
:nil];
921 [delegate receivedProperties
:children forTransaction
:transaction
];
925 * Callback for setting a breakpoint.
927 - (void)breakpointReceived
:(NSXMLDocument
*)response
929 NSNumber
* transaction
= [NSNumber numberWithInt
:[self transactionIDFromResponse
:response
]];
930 Breakpoint
* bp
= [callbackContext_ objectForKey
:transaction
];
934 [callbackContext_ removeObjectForKey
:callbackContext_
];
935 [bp setDebuggerId
:[[[[response rootElement
] attributeForName
:@
"id"] stringValue
] intValue
]];
941 * This will send a command to the debugger engine. It will append the
942 * transaction ID automatically. It accepts a NSString command along with a
943 * a variable number of arguments to substitute into the command, a la
944 * +[NSString stringWithFormat:]. Returns the transaction ID as a NSNumber.
946 - (NSNumber
*)sendCommandWithCallback
:(SEL)callback format
:(NSString
*)format
, ...
948 // Collect varargs and format command.
950 va_start(args
, format
);
951 NSString
* command
= [[NSString alloc
] initWithFormat
:format arguments
:args
];
954 NSNumber
* callbackKey
= [NSNumber numberWithInt
:transactionID
++];
956 [callTable_ setObject
:NSStringFromSelector(callback
) forKey
:callbackKey
];
958 [self send
:[NSString stringWithFormat
:@
"%@ -i %@", [command autorelease
], callbackKey
]];
964 * Checks if there are unsent commands in the |queuedWrites_| queue and sends
965 * them if it's OK to do so. This will not block.
967 - (void)sendQueuedWrites
972 [writeQueueLock_ lock
];
973 if (lastReadTransaction_
>= lastWrittenTransaction_
&& [queuedWrites_ count
] > 0)
975 NSString
* command
= [queuedWrites_ objectAtIndex
:0];
977 // We don't want to block because this is called from the main thread.
978 // |-performSend:| busy waits when the stream is not ready. Bail out
979 // before we do that becuase busy waiting is BAD.
980 if (CFWriteStreamCanAcceptBytes(writeStream_
))
982 [self performSend
:command
];
983 [queuedWrites_ removeObjectAtIndex
:0];
986 [writeQueueLock_ unlock
];
990 * Given a file path, this returns a file:// URI and escapes any spaces for the
993 - (NSString
*)escapedURIPath
:(NSString
*)path
995 // Custon GDBp paths are fine.
996 if ([[path substringToIndex
:4] isEqualToString
:@
"gdbp"])
999 // Create a temporary URL that will escape all the nasty characters.
1000 NSURL
* url
= [NSURL fileURLWithPath
:path
];
1001 NSString
* urlString
= [url absoluteString
];
1003 // Remove the host because this is a file:// URL;
1004 urlString
= [urlString stringByReplacingOccurrencesOfString
:[url host
] withString
:@
""];
1006 // Escape % for use in printf-style NSString formatters.
1007 urlString
= [urlString stringByReplacingOccurrencesOfString
:@
"%" withString
:@
"%%"];
1012 * Returns the transaction_id from an NSXMLDocument.
1014 - (NSInteger
)transactionIDFromResponse
:(NSXMLDocument
*)response
1016 return [[[[response rootElement
] attributeForName
:@
"transaction_id"] stringValue
] intValue
];
1020 * Scans a command string for the transaction ID component. If it is not found,
1021 * returns NSNotFound.
1023 - (NSInteger
)transactionIDFromCommand
:(NSString
*)command
1025 NSRange occurrence
= [command rangeOfString
:@
"-i "];
1026 if (occurrence.location
== NSNotFound
)
1028 NSString
* transaction
= [command substringFromIndex
:occurrence.location
+ occurrence.length
];
1029 return [transaction intValue
];