2 /* Include this before everything else, for various large-file definitions */
8 * We want a reentrant scanner.
13 * We don't use input, so don't generate code for it.
18 * We don't use unput, so don't generate code for it.
23 * We don't read interactively from the terminal.
25 %option never-interactive
28 * We want to stop processing when we get to the end of the input.
33 * The type for the state we keep for a scanner.
35 %option extra-type="Dtd_PreParse_scanner_state_t *"
38 * The language we're scanning is case-insensitive.
43 * Prefix scanner routines with "Dtd_PreParse_" rather than "yy", so this
44 * scanner can coexist with other scanners.
46 %option prefix="Dtd_PreParse_"
48 %option outfile="dtd_preparse.c"
51 * We have to override the memory allocators so that we don't get
52 * "unused argument" warnings from the yyscanner argument (which
53 * we don't use, as we have a global memory allocator).
55 * We provide, as macros, our own versions of the routines generated by Flex,
56 * which just call malloc()/realloc()/free() (as the Flex versions do),
57 * discarding the extra argument.
67 * an XML dissector for wireshark
69 * DTD Preparser - import a dtd file into a GString
70 * including files, removing comments
71 * and resolving %entities;
73 * Copyright 2004, Luis E. Garcia Ontanon <luis@ontanon.org>
75 * Wireshark - Network traffic analyzer
76 * By Gerald Combs <gerald@wireshark.org>
77 * Copyright 1998 Gerald Combs
79 * This program is free software; you can redistribute it and/or
80 * modify it under the terms of the GNU General Public License
81 * as published by the Free Software Foundation; either version 2
82 * of the License, or (at your option) any later version.
84 * This program is distributed in the hope that it will be useful,
85 * but WITHOUT ANY WARRANTY; without even the implied warranty of
86 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
87 * GNU General Public License for more details.
89 * You should have received a copy of the GNU General Public License
90 * along with this program; if not, write to the Free Software
91 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
99 #include <wsutil/file_util.h>
102 * Disable diagnostics in the code generated by Flex.
106 #define ECHO g_string_append(yyextra->current,yytext);
108 struct _dtd_preparse_scanner_state {
109 const char* dtd_dirname;
110 const char* filename;
115 GHashTable* entities;
121 static const char* replace_entity(Dtd_PreParse_scanner_state_t* state, char* s);
123 #define YY_USER_INIT { \
128 * Flex (v 2.5.35) uses this symbol to "exclude" unistd.h
131 #define YY_NO_UNISTD_H
135 * Sleazy hack to suppress compiler warnings in yy_fatal_error().
137 #define YY_EXIT_FAILURE ((void)yyscanner, 2)
140 * Macros for the allocators, to discard the extra argument.
142 #define Dtd_PreParse_alloc(size, yyscanner) (void *)malloc(size)
143 #define Dtd_PreParse_realloc(ptr, size, yyscanner) (void *)realloc((char *)(ptr), (size))
144 #define Dtd_PreParse_free(ptr, yyscanner) free((char *)ptr)
156 entity_start "<!"[[:blank:]\n]*entity[[:blank:]\n]*"%"
161 name [A-Za-z][-:A-Za-z0-9_\.]*
170 entity [%&][A-Za-z][-A-Za-z0-9_]*;
172 whitespace [[blank:]]+
174 %START OUTSIDE IN_COMMENT IN_ENTITY NAMED_ENTITY IN_QUOTE ENTITY_DONE XMLPI
178 {entity} if (yyextra->current) g_string_append_printf(yyextra->current,"%s\n%s\n",replace_entity(yyextra, yytext),dtd_location(yyextra));
180 {whitespace} if (yyextra->current) g_string_append(yyextra->current," ");
182 <OUTSIDE>{xmlpi_start} { g_string_append(yyextra->current,yytext); BEGIN XMLPI; }
183 <XMLPI>{xmlpi_chars} { g_string_append(yyextra->current,yytext); }
184 <XMLPI>{newline} { g_string_append(yyextra->current,yytext); }
185 <XMLPI>{xmlpi_stop} { g_string_append(yyextra->current,yytext); BEGIN OUTSIDE; }
187 <OUTSIDE>{comment_start} { yyextra->current = NULL; BEGIN IN_COMMENT; }
190 <IN_COMMENT>{comment_stop} { yyextra->current = yyextra->output; BEGIN OUTSIDE; }
194 if (yyextra->current) g_string_append_printf(yyextra->current,"%s\n",dtd_location(yyextra));
198 <OUTSIDE>{entity_start} { BEGIN IN_ENTITY; }
199 <IN_ENTITY>{name} { yyextra->entity_name = ws_strdup_printf("%%%s;",yytext); BEGIN NAMED_ENTITY; }
200 <NAMED_ENTITY>{quote} { yyextra->current = g_string_new(dtd_location(yyextra)); BEGIN IN_QUOTE; }
201 <IN_QUOTE>{quote} { g_hash_table_insert(yyextra->entities,yyextra->entity_name,yyextra->current); BEGIN ENTITY_DONE; }
202 <IN_QUOTE>{percent} |
203 <IN_QUOTE>{non_quote} |
204 <IN_QUOTE>{escaped_quote} g_string_append(yyextra->current,yytext);
205 <NAMED_ENTITY>{system} {
206 g_string_append_printf(yyextra->error,"at %s:%u: file inclusion is not supported!", yyextra->filename, yyextra->linenum);
209 <ENTITY_DONE>{special_stop} { yyextra->current = yyextra->output; g_string_append(yyextra->current,"\n"); BEGIN OUTSIDE; }
214 * Turn diagnostics back on, so we check the code that we've written.
218 static const char* replace_entity(Dtd_PreParse_scanner_state_t* state, char* entity) {
219 GString* replacement;
223 replacement = (GString*)g_hash_table_lookup(state->entities,entity);
226 return replacement->str;
228 g_string_append_printf(state->error,"dtd_preparse: in file '%s': entity %s does not exists\n", state->filename, entity);
234 const char* dtd_location(Dtd_PreParse_scanner_state_t* state) {
235 static char* loc = NULL;
239 if (!state) return NULL;
241 loc = ws_strdup_printf("<? wireshark:location %s:%u ?>", state->filename, state->linenum);
246 static gboolean free_gstring_hash_items(void *k,void *v,void *p _U_) {
248 g_string_free((GString*)v,true);
252 extern GString* dtd_preparse(const char* dname,const char* fname, GString* err) {
253 char* fullname = ws_strdup_printf("%s%c%s",dname,G_DIR_SEPARATOR,fname);
256 Dtd_PreParse_scanner_state_t state;
258 in = ws_fopen(fullname,"r");
262 g_string_append_printf(err, "Could not open file: '%s', error: %s",fullname,g_strerror(errno));
267 if (Dtd_PreParse_lex_init(&scanner) != 0) {
269 g_string_append_printf(err, "Can't initialize scanner: %s",
276 Dtd_PreParse_set_in(in, scanner);
278 state.dtd_dirname = dname;
279 state.filename = fname;
284 state.entities = g_hash_table_new(g_str_hash,g_str_equal);
285 state.current = state.output = g_string_new(dtd_location(&state));
286 state.entity_name = NULL;
288 /* Associate the state with the scanner */
289 Dtd_PreParse_set_extra(&state, scanner);
291 Dtd_PreParse_lex(scanner);
293 Dtd_PreParse_lex_destroy(scanner);
296 g_hash_table_foreach_remove(state.entities,free_gstring_hash_items,NULL);
297 g_hash_table_destroy(state.entities);