(Trivial) Fix spellling in a comment.
[metze/wireshark/wip.git] / epan / dtd_parse.l
1 /*
2  * We don't use input, so don't generate code for it.
3  */
4 %option noinput
5
6 /*
7  * We don't use unput, so don't generate code for it.
8  */
9 %option nounput
10
11 /*
12  * We don't read from the terminal.
13  */
14 %option never-interactive
15
16 /*
17  * Prefix scanner routines with "Dtd_Parse_" rather than "yy", so this scanner
18  * can coexist with other scanners.
19  */
20 %option prefix="Dtd_Parse_"
21
22 %option outfile="dtd_parse.c"
23
24 %{
25
26         /* dtd_parse.l
27         * an XML dissector for Wireshark
28         * lexical analyzer for DTDs
29         *
30         * Copyright 2004, Luis E. Garcia Ontanon <luis@ontanon.org>
31         *
32         * $Id$
33         *
34         * Wireshark - Network traffic analyzer
35         * By Gerald Combs <gerald@wireshark.org>
36         * Copyright 1998 Gerald Combs
37         *
38         * This program is free software; you can redistribute it and/or
39         * modify it under the terms of the GNU General Public License
40         * as published by the Free Software Foundation; either version 2
41         * of the License, or (at your option) any later version.
42         *
43         * This program is distributed in the hope that it will be useful,
44         * but WITHOUT ANY WARRANTY; without even the implied warranty of
45         * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
46         * GNU General Public License for more details.
47         *
48         * You should have received a copy of the GNU General Public License
49         * along with this program; if not, write to the Free Software
50         * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
51         */
52
53 #include <glib.h>
54 #include <string.h>
55
56 #include "dtd.h"
57 #include "dtd_grammar.h"
58 #include "dtd_parse.h"
59 #include "dtd_parse_lex.h"
60
61         struct _proto_xmlpi_attr {
62                 const gchar* name;
63                 void (*act)(gchar*);
64         };
65
66         static void* pParser;
67         static GString* input_string;
68         static guint offsetx;
69         static guint len;
70         static gchar* location;
71         static gchar* attr_name;
72
73         static size_t my_yyinput(char* buff,size_t size);
74
75         static dtd_token_data_t* new_token(gchar*);
76
77         static dtd_build_data_t* build_data;
78
79         static void set_proto_name (gchar* val) { if(build_data->proto_name) g_free(build_data->proto_name); build_data->proto_name = g_strdup(val); }
80         static void set_media_type (gchar* val) { if(build_data->media_type) g_free(build_data->media_type); build_data->media_type = g_strdup(val); }
81         static void set_proto_root (gchar* val) { if(build_data->proto_root) g_free(build_data->proto_root); build_data->proto_root = g_strdup(val); }
82         static void set_description (gchar* val) { if(build_data->description) g_free(build_data->description); build_data->description = g_strdup(val); }
83         static void set_recursive (gchar* val) { build_data->recursion = ( g_ascii_strcasecmp(val,"yes") == 0 ) ? TRUE : FALSE; }
84
85         static struct _proto_xmlpi_attr proto_attrs[] =
86         {
87                 { "proto_name", set_proto_name },
88                 { "media", set_media_type },
89                 { "root", set_proto_root },
90                 { "description", set_description },
91                 { "hierarchy", set_recursive },
92                 {NULL,NULL}
93         };
94
95 #ifdef DEBUG_DTD_PARSER
96 #define DEBUG_DTD_TOKEN fprintf(stderr,"->%s (%i)%s\n",location,token_type,yytext)
97 #else
98 #define DEBUG_DTD_TOKEN
99 #endif
100
101 #define DTD_PARSE(token_type) \
102         {   DEBUG_DTD_TOKEN; \
103                 DtdParse(pParser, (token_type), new_token(yytext), build_data); \
104                 if(build_data->error->len > 0) yyterminate(); \
105         }
106
107
108 #define YY_INPUT(buff,result,max_size) ( (result) = my_yyinput((buff),(max_size)) )
109
110 /*
111  * Flex (v 2.5.35) uses this symbol to "exclude" unistd.h
112  */
113 #ifdef _WIN32
114 #define YY_NO_UNISTD_H
115 #endif
116
117 %}
118
119 comment_start "<!--"
120 comment_stop "-->"
121
122 start_xmlpi "<?"
123
124 location_xmlpi "wireshark:location"
125 protocol_xmlpi "wireshark:protocol"
126
127 get_attr_quote =[:blank:]*["]
128 avoid_editor_bug ["]
129
130 get_location_xmlpi  [^[:blank:]]+
131
132 stop_xmlpi "?>"
133
134 notation_tag       "<!"[:blank:]*NOTATION
135
136 special_start  "<!"
137 special_stop   ">"
138 whitespace     [[:blank:]\r\n]+
139 newline        \n
140 attlist_kw     ATTLIST
141 doctype_kw     DOCTYPE
142 element_kw     ELEMENT
143
144 pcdata         #PCDATA
145 any            ANY
146 cdata          #CDATA
147
148 iD             ID
149 idref          IDREF
150 idrefs         IDREFS
151 nmtoken        NMTOKEN
152 nmtokens       NMTOKENS
153 entity         ENTITY
154 entities       ENTITIES
155 notation       NOTATION
156 cdata_t        CDATA
157
158 empty          EMPTY
159 defaulT        #DEFAULT
160 fixed          #FIXED
161 required       #REQUIRED
162 implied        #IMPLIED
163
164 star           "*"
165 question       "?"
166 plus           "+"
167 open_parens    "("
168 close_parens   ")"
169 open_bracket   "["
170 close_bracket  "]"
171 comma          ","
172 pipe           "|"
173 dquote         ["]
174
175 name           [A-Za-z0-9][-a-zA-Z0-9_]*
176 dquoted        ["][^\"]*["]
177 squoted        ['][^\']*[']
178
179 %START DTD XMLPI LOCATION DONE PROTOCOL GET_ATTR_QUOTE GET_ATTR_VAL GET_ATTR_CLOSE_QUOTE IN_COMMENT IN_NOTATION
180 %%
181
182 {whitespace}            ;
183
184
185 <DTD>{comment_start}            { BEGIN IN_COMMENT; }
186 <IN_COMMENT>[^-]?                               |
187 <IN_COMMENT>[-]                                 ;
188 <IN_COMMENT>{comment_stop}              { BEGIN DTD; }
189
190 <DTD>{notation_tag} { BEGIN IN_NOTATION; }
191 <IN_NOTATION>[^>]  ;
192 <IN_NOTATION>{special_stop} { BEGIN DTD; }
193
194 <DTD>{start_xmlpi}              {
195         BEGIN XMLPI;
196 }
197
198 <XMLPI>{location_xmlpi} {
199         BEGIN LOCATION;
200 }
201
202 <XMLPI>{protocol_xmlpi} {
203         BEGIN PROTOCOL;
204 }
205
206 <XMLPI><.> ;
207 <XMLPI>{stop_xmlpi} BEGIN DTD;
208
209 <LOCATION>{get_location_xmlpi} {
210     if(location) g_free(location);
211         location = g_strdup(yytext);
212         BEGIN DONE;
213 }
214
215 <DONE>{stop_xmlpi}  BEGIN DTD;
216
217 <PROTOCOL>{name} {
218         attr_name = g_ascii_strdown(yytext, -1);
219         BEGIN GET_ATTR_QUOTE;
220 }
221
222 <GET_ATTR_QUOTE>{get_attr_quote} { BEGIN GET_ATTR_VAL; }
223
224 <GET_ATTR_QUOTE>. {
225         g_string_append_printf(build_data->error,
226                                         "error in wireshark:protocol xmpli at %s : could not find attribute value!",
227                                         location);
228         yyterminate();
229 }
230
231 <GET_ATTR_VAL>[^"]+ {
232         /*"*/
233         struct _proto_xmlpi_attr* pa;
234         gboolean got_it = FALSE;
235
236         for(pa = proto_attrs; pa->name; pa++) {
237                 if (g_ascii_strcasecmp(attr_name,pa->name) == 0) {
238                         pa->act(yytext);
239                         got_it = TRUE;
240                         break;
241                 }
242         }
243
244         if (! got_it) {
245                 g_string_append_printf(build_data->error,
246                                                 "error in wireshark:protocol xmpli at %s : no such parameter %s!",
247                                                 location, attr_name);
248                 g_free(attr_name);
249                 yyterminate();
250         }
251
252         g_free(attr_name);
253
254         BEGIN GET_ATTR_CLOSE_QUOTE;
255 }
256
257 <GET_ATTR_CLOSE_QUOTE>{dquote} { BEGIN PROTOCOL;}
258
259 <PROTOCOL>{stop_xmlpi} BEGIN DTD;
260
261 <DTD>{special_start}         { DTD_PARSE(TOKEN_TAG_START); }
262 <DTD>{special_stop}          { DTD_PARSE(TOKEN_TAG_STOP); }
263
264 <DTD>{attlist_kw}            { DTD_PARSE(TOKEN_ATTLIST_KW); }
265 <DTD>{element_kw}            { DTD_PARSE(TOKEN_ELEMENT_KW); }
266 <DTD>{doctype_kw}            { DTD_PARSE(TOKEN_DOCTYPE_KW); }
267
268 <DTD>{pcdata}                { DTD_PARSE(TOKEN_ELEM_DATA); }
269 <DTD>{any}                   { DTD_PARSE(TOKEN_ELEM_DATA); }
270 <DTD>{cdata}                 { DTD_PARSE(TOKEN_ELEM_DATA); }
271 <DTD>{empty}                             { DTD_PARSE(TOKEN_EMPTY_KW); }
272
273 <DTD>{iD}                                { DTD_PARSE(TOKEN_ATT_TYPE); }
274 <DTD>{idref}                 { DTD_PARSE(TOKEN_ATT_TYPE); }
275 <DTD>{idrefs}                { DTD_PARSE(TOKEN_ATT_TYPE); }
276 <DTD>{nmtoken}               { DTD_PARSE(TOKEN_ATT_TYPE); }
277 <DTD>{nmtokens}              { DTD_PARSE(TOKEN_ATT_TYPE); }
278 <DTD>{entity}                { DTD_PARSE(TOKEN_ATT_TYPE); }
279 <DTD>{entities}              { DTD_PARSE(TOKEN_ATT_TYPE); }
280 <DTD>{notation}              { DTD_PARSE(TOKEN_ATT_TYPE); }
281 <DTD>{cdata_t}               { DTD_PARSE(TOKEN_ATT_TYPE); }
282 <DTD>{defaulT}               { DTD_PARSE(TOKEN_ATT_DEF_WITH_VALUE); }
283 <DTD>{fixed}                 { DTD_PARSE(TOKEN_ATT_DEF_WITH_VALUE); }
284 <DTD>{required}              { DTD_PARSE(TOKEN_ATT_DEF); }
285 <DTD>{implied}               { DTD_PARSE(TOKEN_ATT_DEF); }
286
287 <DTD>{star}                  { DTD_PARSE(TOKEN_STAR); }
288 <DTD>{question}              { DTD_PARSE(TOKEN_QUESTION); }
289 <DTD>{plus}                  { DTD_PARSE(TOKEN_PLUS); }
290 <DTD>{comma}                  { DTD_PARSE(TOKEN_COMMA); }
291 <DTD>{open_parens}           { DTD_PARSE(TOKEN_OPEN_PARENS); }
292 <DTD>{close_parens}          { DTD_PARSE(TOKEN_CLOSE_PARENS); }
293 <DTD>{open_bracket}          { DTD_PARSE(TOKEN_OPEN_BRACKET); }
294 <DTD>{close_bracket}         { DTD_PARSE(TOKEN_CLOSE_BRACKET); }
295 <DTD>{pipe}                  { DTD_PARSE(TOKEN_PIPE); }
296
297 <DTD>{dquoted}               |
298 <DTD>{squoted}               { DTD_PARSE(TOKEN_QUOTED); }
299 <DTD>{name}                  { DTD_PARSE(TOKEN_NAME); }
300
301 %%
302
303 static dtd_token_data_t* new_token(gchar* text) {
304         dtd_token_data_t* t = g_new(dtd_token_data_t,1);
305
306         t->text = g_strdup(text);
307         t->location = g_strdup(location);
308
309         return t;
310 }
311
312
313 static size_t my_yyinput(char* buff, size_t size) {
314
315         if (offsetx >= len ) {
316                 return YY_NULL;
317         } else if ( offsetx + size <= len ) {
318                 memcpy(buff, input_string->str + offsetx,size);
319                 offsetx += size;
320                 return size;
321         } else {
322                 size = len - offsetx;
323                 memcpy(buff, input_string->str + offsetx,size);
324                 offsetx = len;
325                 return size;
326         }
327 }
328
329 extern dtd_build_data_t* dtd_parse(GString* s) {
330
331         input_string = s;
332         offsetx = 0;
333         len = (guint) input_string->len;
334
335         pParser = DtdParseAlloc(g_malloc);
336
337 #ifdef DEBUG_DTD_PARSER
338         DtdParseTrace(stderr, ">>");
339 #endif
340
341         build_data = g_new(dtd_build_data_t,1);
342
343         build_data->proto_name = NULL;
344         build_data->media_type = NULL;
345         build_data->description = NULL;
346         build_data->proto_root = NULL;
347         build_data->recursion = FALSE;
348
349         build_data->elements = g_ptr_array_new();
350         build_data->attributes = g_ptr_array_new();
351
352         build_data->error = g_string_new("");
353
354         location = NULL;
355
356         BEGIN DTD;
357
358         yylex();
359
360         DtdParse(pParser, 0, NULL,build_data);
361
362         yyrestart(NULL);
363
364         if (location) g_free(location);
365
366         location = NULL;
367
368         DtdParseFree(pParser, g_free );
369
370         return build_data;
371 }
372
373 /*
374  * We want to stop processing when we get to the end of the input.
375  * (%option noyywrap is not used because if used then
376  * some flex versions (eg: 2.5.35) generate code which causes
377  * warnings by the Windows VC compiler).
378  */
379
380 int yywrap(void) {
381     return 1;
382 }