Scanner EOF transitions are now taken (C/D code only).
[external/ragel.git] / rlgen-cd / fsmcodegen.h
1 /*
2  *  Copyright 2001-2006 Adrian Thurston <thurston@cs.queensu.ca>
3  *            2004 Erich Ocean <eric.ocean@ampede.com>
4  *            2005 Alan West <alan@alanz.com>
5  */
6
7 /*  This file is part of Ragel.
8  *
9  *  Ragel is free software; you can redistribute it and/or modify
10  *  it under the terms of the GNU General Public License as published by
11  *  the Free Software Foundation; either version 2 of the License, or
12  *  (at your option) any later version.
13  * 
14  *  Ragel is distributed in the hope that it will be useful,
15  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
16  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  *  GNU General Public License for more details.
18  * 
19  *  You should have received a copy of the GNU General Public License
20  *  along with Ragel; if not, write to the Free Software
21  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA 
22  */
23
24 #ifndef _FSMCODEGEN_H
25 #define _FSMCODEGEN_H
26
27 #include <iostream>
28 #include <string>
29 #include <stdio.h>
30 #include "common.h"
31 #include "gendata.h"
32
33 using std::string;
34 using std::ostream;
35
36 /* Integer array line length. */
37 #define IALL 8
38
39 /* Forwards. */
40 struct RedFsmAp;
41 struct RedStateAp;
42 struct CodeGenData;
43 struct Action;
44 struct NameInst;
45 struct InlineItem;
46 struct InlineList;
47 struct RedAction;
48 struct LongestMatch;
49 struct LongestMatchPart;
50
51 inline string itoa( int i )
52 {
53         char buf[16];
54         sprintf( buf, "%i", i );
55         return buf;
56 }
57
58 /*
59  * class FsmCodeGen
60  */
61 class FsmCodeGen : public CodeGenData
62 {
63 public:
64         FsmCodeGen( ostream &out );
65         virtual ~FsmCodeGen() {}
66
67         virtual void finishRagelDef();
68         virtual void writeInit();
69
70 protected:
71         string FSM_NAME();
72         string START_STATE_ID();
73         ostream &ACTIONS_ARRAY();
74         string GET_WIDE_KEY();
75         string GET_WIDE_KEY( RedStateAp *state );
76         string TABS( int level );
77         string KEY( Key key );
78         string LDIR_PATH( char *path );
79         void ACTION( ostream &ret, Action *action, int targState, bool inFinish );
80         void CONDITION( ostream &ret, Action *condition );
81         string ALPH_TYPE();
82         string WIDE_ALPH_TYPE();
83         string ARRAY_TYPE( unsigned long maxVal );
84
85         virtual string ARR_OFF( string ptr, string offset ) = 0;
86         virtual string CAST( string type ) = 0;
87         virtual string UINT() = 0;
88         virtual string NULL_ITEM() = 0;
89         virtual string POINTER() = 0;
90         virtual string GET_KEY();
91         virtual ostream &SWITCH_DEFAULT() = 0;
92
93         string P();
94         string PE();
95         string EOFV();
96
97         string ACCESS();
98         string CS();
99         string STACK();
100         string TOP();
101         string TOKSTART();
102         string TOKEND();
103         string ACT();
104
105         string DATA_PREFIX();
106         string PM() { return "_" + DATA_PREFIX() + "partition_map"; }
107         string C() { return "_" + DATA_PREFIX() + "cond_spaces"; }
108         string CK() { return "_" + DATA_PREFIX() + "cond_keys"; }
109         string K() { return "_" + DATA_PREFIX() + "trans_keys"; }
110         string I() { return "_" + DATA_PREFIX() + "indicies"; }
111         string CO() { return "_" + DATA_PREFIX() + "cond_offsets"; }
112         string KO() { return "_" + DATA_PREFIX() + "key_offsets"; }
113         string IO() { return "_" + DATA_PREFIX() + "index_offsets"; }
114         string CL() { return "_" + DATA_PREFIX() + "cond_lengths"; }
115         string SL() { return "_" + DATA_PREFIX() + "single_lengths"; }
116         string RL() { return "_" + DATA_PREFIX() + "range_lengths"; }
117         string A() { return "_" + DATA_PREFIX() + "actions"; }
118         string TA() { return "_" + DATA_PREFIX() + "trans_actions_wi"; }
119         string TT() { return "_" + DATA_PREFIX() + "trans_targs_wi"; }
120         string TSA() { return "_" + DATA_PREFIX() + "to_state_actions"; }
121         string FSA() { return "_" + DATA_PREFIX() + "from_state_actions"; }
122         string EA() { return "_" + DATA_PREFIX() + "eof_actions"; }
123         string ET() { return "_" + DATA_PREFIX() + "eof_trans"; }
124         string SP() { return "_" + DATA_PREFIX() + "key_spans"; }
125         string CSP() { return "_" + DATA_PREFIX() + "cond_key_spans"; }
126         string START() { return DATA_PREFIX() + "start"; }
127         string ERROR() { return DATA_PREFIX() + "error"; }
128         string FIRST_FINAL() { return DATA_PREFIX() + "first_final"; }
129         string CTXDATA() { return DATA_PREFIX() + "ctxdata"; }
130
131         void INLINE_LIST( ostream &ret, InlineList *inlineList, int targState, bool inFinish );
132         virtual void GOTO( ostream &ret, int gotoDest, bool inFinish ) = 0;
133         virtual void CALL( ostream &ret, int callDest, int targState, bool inFinish ) = 0;
134         virtual void NEXT( ostream &ret, int nextDest, bool inFinish ) = 0;
135         virtual void GOTO_EXPR( ostream &ret, InlineItem *ilItem, bool inFinish ) = 0;
136         virtual void NEXT_EXPR( ostream &ret, InlineItem *ilItem, bool inFinish ) = 0;
137         virtual void CALL_EXPR( ostream &ret, InlineItem *ilItem, 
138                         int targState, bool inFinish ) = 0;
139         virtual void RET( ostream &ret, bool inFinish ) = 0;
140         virtual void BREAK( ostream &ret, int targState ) = 0;
141         virtual void CURS( ostream &ret, bool inFinish ) = 0;
142         virtual void TARGS( ostream &ret, bool inFinish, int targState ) = 0;
143         void EXEC( ostream &ret, InlineItem *item, int targState, int inFinish );
144         void LM_SWITCH( ostream &ret, InlineItem *item, int targState, int inFinish );
145         void SET_ACT( ostream &ret, InlineItem *item );
146         void INIT_TOKSTART( ostream &ret, InlineItem *item );
147         void INIT_ACT( ostream &ret, InlineItem *item );
148         void SET_TOKSTART( ostream &ret, InlineItem *item );
149         void SET_TOKEND( ostream &ret, InlineItem *item );
150         void GET_TOKEND( ostream &ret, InlineItem *item );
151         void SUB_ACTION( ostream &ret, InlineItem *item, 
152                         int targState, bool inFinish );
153         void STATE_IDS();
154
155         string ERROR_STATE();
156         string FIRST_FINAL_STATE();
157
158         virtual string PTR_CONST() = 0;
159         virtual ostream &OPEN_ARRAY( string type, string name ) = 0;
160         virtual ostream &CLOSE_ARRAY() = 0;
161         virtual ostream &STATIC_VAR( string type, string name ) = 0;
162
163         virtual string CTRL_FLOW() = 0;
164
165         ostream &source_warning(const InputLoc &loc);
166         ostream &source_error(const InputLoc &loc);
167
168         unsigned int arrayTypeSize( unsigned long maxVal );
169
170         bool outLabelUsed;
171         bool testEofUsed;
172         bool againLabelUsed;
173         bool useIndicies;
174
175 public:
176         /* Determine if we should use indicies. */
177         virtual void calcIndexSize() {}
178 };
179
180 class CCodeGen : virtual public FsmCodeGen
181 {
182 public:
183         CCodeGen( ostream &out ) : FsmCodeGen(out) {}
184
185         virtual string NULL_ITEM();
186         virtual string POINTER();
187         virtual ostream &SWITCH_DEFAULT();
188         virtual ostream &OPEN_ARRAY( string type, string name );
189         virtual ostream &CLOSE_ARRAY();
190         virtual ostream &STATIC_VAR( string type, string name );
191         virtual string ARR_OFF( string ptr, string offset );
192         virtual string CAST( string type );
193         virtual string UINT();
194         virtual string PTR_CONST();
195         virtual string CTRL_FLOW();
196
197         virtual void writeExports();
198 };
199
200 class DCodeGen : virtual public FsmCodeGen
201 {
202 public:
203         DCodeGen( ostream &out ) : FsmCodeGen(out) {}
204
205         virtual string NULL_ITEM();
206         virtual string POINTER();
207         virtual ostream &SWITCH_DEFAULT();
208         virtual ostream &OPEN_ARRAY( string type, string name );
209         virtual ostream &CLOSE_ARRAY();
210         virtual ostream &STATIC_VAR( string type, string name );
211         virtual string ARR_OFF( string ptr, string offset );
212         virtual string CAST( string type );
213         virtual string UINT();
214         virtual string PTR_CONST();
215         virtual string CTRL_FLOW();
216
217         virtual void writeExports();
218 };
219
220 #endif /* _FSMCODEGEN_H */