xref: /aosp_15_r20/external/antlr/runtime/ObjC/Framework/DebugEventSocketProxy.h (revision 16467b971bd3e2009fad32dd79016f2c7e421deb)
1*16467b97STreehugger Robot // [The "BSD licence"]
2*16467b97STreehugger Robot // Copyright (c) 2006-2007 Kay Roepke
3*16467b97STreehugger Robot // All rights reserved.
4*16467b97STreehugger Robot //
5*16467b97STreehugger Robot // Redistribution and use in source and binary forms, with or without
6*16467b97STreehugger Robot // modification, are permitted provided that the following conditions
7*16467b97STreehugger Robot // are met:
8*16467b97STreehugger Robot // 1. Redistributions of source code must retain the above copyright
9*16467b97STreehugger Robot //    notice, this list of conditions and the following disclaimer.
10*16467b97STreehugger Robot // 2. Redistributions in binary form must reproduce the above copyright
11*16467b97STreehugger Robot //    notice, this list of conditions and the following disclaimer in the
12*16467b97STreehugger Robot //    documentation and/or other materials provided with the distribution.
13*16467b97STreehugger Robot // 3. The name of the author may not be used to endorse or promote products
14*16467b97STreehugger Robot //    derived from this software without specific prior written permission.
15*16467b97STreehugger Robot //
16*16467b97STreehugger Robot // THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17*16467b97STreehugger Robot // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18*16467b97STreehugger Robot // OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19*16467b97STreehugger Robot // IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20*16467b97STreehugger Robot // INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21*16467b97STreehugger Robot // NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22*16467b97STreehugger Robot // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23*16467b97STreehugger Robot // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24*16467b97STreehugger Robot // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25*16467b97STreehugger Robot // THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26*16467b97STreehugger Robot 
27*16467b97STreehugger Robot #import <Foundation/Foundation.h>
28*16467b97STreehugger Robot #import "Parser.h"
29*16467b97STreehugger Robot #import "DebugEventListener.h"
30*16467b97STreehugger Robot #import <sys/socket.h>
31*16467b97STreehugger Robot #import <netinet/in.h>
32*16467b97STreehugger Robot #import <netinet/tcp.h>
33*16467b97STreehugger Robot #include <arpa/inet.h>
34*16467b97STreehugger Robot 
35*16467b97STreehugger Robot // default port for ANTLRWorks
36*16467b97STreehugger Robot #define DEFAULT_DEBUGGER_PORT 49001
37*16467b97STreehugger Robot 
38*16467b97STreehugger Robot @interface DebugEventSocketProxy : NSObject <DebugEventListener> {
39*16467b97STreehugger Robot 	int serverSocket;
40*16467b97STreehugger Robot 
41*16467b97STreehugger Robot 	struct sockaddr debugger_sockaddr;
42*16467b97STreehugger Robot 	socklen_t debugger_socklen;
43*16467b97STreehugger Robot 	int debuggerSocket;
44*16467b97STreehugger Robot 	NSFileHandle *debuggerFH;
45*16467b97STreehugger Robot 
46*16467b97STreehugger Robot 	NSString *grammarName;
47*16467b97STreehugger Robot 	int debuggerPort;
48*16467b97STreehugger Robot }
49*16467b97STreehugger Robot 
50*16467b97STreehugger Robot - (id) init;
51*16467b97STreehugger Robot - (id) initWithGrammarName:(NSString *)aGrammarName debuggerPort:(NSInteger)aPort;
52*16467b97STreehugger Robot - (void) waitForDebuggerConnection;
53*16467b97STreehugger Robot - (void) waitForAck;
54*16467b97STreehugger Robot - (void) sendToDebugger:(NSString *)message;
55*16467b97STreehugger Robot - (void) sendToDebugger:(NSString *)message waitForResponse:(BOOL)wait;
56*16467b97STreehugger Robot 
57*16467b97STreehugger Robot - (NSInteger) serverSocket;
58*16467b97STreehugger Robot - (void) setServerSocket: (NSInteger) aServerSocket;
59*16467b97STreehugger Robot 
60*16467b97STreehugger Robot - (NSInteger) debuggerSocket;
61*16467b97STreehugger Robot - (void) setDebuggerSocket: (NSInteger) aDebuggerSocket;
62*16467b97STreehugger Robot 
63*16467b97STreehugger Robot - (NSString *) grammarName;
64*16467b97STreehugger Robot - (void) setGrammarName: (NSString *) aGrammarName;
65*16467b97STreehugger Robot 
66*16467b97STreehugger Robot - (NSInteger) debuggerPort;
67*16467b97STreehugger Robot - (void) setDebuggerPort: (NSInteger) aDebuggerPort;
68*16467b97STreehugger Robot 
69*16467b97STreehugger Robot - (NSString *) escapeNewlines:(NSString *)aString;
70*16467b97STreehugger Robot 
71*16467b97STreehugger Robot #pragma mark -
72*16467b97STreehugger Robot 
73*16467b97STreehugger Robot #pragma mark DebugEventListener Protocol
74*16467b97STreehugger Robot - (void) enterRule:(NSString *)ruleName;
75*16467b97STreehugger Robot - (void) enterAlt:(NSInteger)alt;
76*16467b97STreehugger Robot - (void) exitRule:(NSString *)ruleName;
77*16467b97STreehugger Robot - (void) enterSubRule:(NSInteger)decisionNumber;
78*16467b97STreehugger Robot - (void) exitSubRule:(NSInteger)decisionNumber;
79*16467b97STreehugger Robot - (void) enterDecision:(NSInteger)decisionNumber;
80*16467b97STreehugger Robot - (void) exitDecision:(NSInteger)decisionNumber;
81*16467b97STreehugger Robot - (void) consumeToken:(id<Token>)t;
82*16467b97STreehugger Robot - (void) consumeHiddenToken:(id<Token>)t;
83*16467b97STreehugger Robot - (void) LT:(NSInteger)i foundToken:(id<Token>)t;
84*16467b97STreehugger Robot - (void) mark:(NSInteger)marker;
85*16467b97STreehugger Robot - (void) rewind:(NSInteger)marker;
86*16467b97STreehugger Robot - (void) rewind;
87*16467b97STreehugger Robot - (void) beginBacktrack:(NSInteger)level;
88*16467b97STreehugger Robot - (void) endBacktrack:(NSInteger)level wasSuccessful:(BOOL)successful;
89*16467b97STreehugger Robot - (void) locationLine:(NSInteger)line column:(NSInteger)pos;
90*16467b97STreehugger Robot - (void) recognitionException:(RecognitionException *)e;
91*16467b97STreehugger Robot - (void) beginResync;
92*16467b97STreehugger Robot - (void) endResync;
93*16467b97STreehugger Robot - (void) semanticPredicate:(NSString *)predicate matched:(BOOL)result;
94*16467b97STreehugger Robot - (void) commence;
95*16467b97STreehugger Robot - (void) terminate;
96*16467b97STreehugger Robot 
97*16467b97STreehugger Robot 
98*16467b97STreehugger Robot #pragma mark Tree Parsing
99*16467b97STreehugger Robot - (void) consumeNode:(unsigned)nodeHash ofType:(NSInteger)type text:(NSString *)text;
100*16467b97STreehugger Robot - (void) LT:(NSInteger)i foundNode:(unsigned)nodeHash ofType:(NSInteger)type text:(NSString *)text;
101*16467b97STreehugger Robot 
102*16467b97STreehugger Robot 
103*16467b97STreehugger Robot #pragma mark AST Events
104*16467b97STreehugger Robot 
105*16467b97STreehugger Robot - (void) createNilNode:(unsigned)hash;
106*16467b97STreehugger Robot - (void) createNode:(unsigned)hash text:(NSString *)text type:(NSInteger)type;
107*16467b97STreehugger Robot - (void) createNode:(unsigned)hash fromTokenAtIndex:(NSInteger)tokenIndex;
108*16467b97STreehugger Robot - (void) makeNode:(unsigned)newRootHash parentOf:(unsigned)oldRootHash;
109*16467b97STreehugger Robot - (void) addChild:(unsigned)childHash toTree:(unsigned)treeHash;
110*16467b97STreehugger Robot - (void) setTokenBoundariesForTree:(unsigned)nodeHash From:(NSInteger)tokenStartIndex To:(NSInteger)tokenStopIndex;
111*16467b97STreehugger Robot 
112*16467b97STreehugger Robot @end
113