2 * We don't use input, so don't generate code for it.
7 * We don't use unput, so don't generate code for it.
12 * We don't read from the terminal.
14 %option never-interactive
17 * The language we're scanning is case-insensitive.
22 * We use start condition stacks.
27 * Prefix scanner routines with "DiamDict" rather than "yy", so this scanner
28 * can coexist with other scanners.
30 %option prefix="DiamDict"
32 %option outfile="diam_dict.c"
37 ** Diameter Dictionary Import Routines
39 ** (c) 2007, Luis E. Garcia Ontanon <luis@ontanon.org>
41 ** This library is free software; you can redistribute it and/or
42 ** modify it under the terms of the GNU Library General Public
43 ** License as published by the Free Software Foundation; either
44 ** version 2 of the License, or (at your option) any later version.
46 ** This library is distributed in the hope that it will be useful,
47 ** but WITHOUT ANY WARRANTY; without even the implied warranty of
48 ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
49 ** Library General Public License for more details.
51 ** You should have received a copy of the GNU Library General Public
52 ** License along with this library; if not, write to the Free Software
53 ** Foundation, Inc., 51 Franklin Street, Fifth Floor,
54 ** Boston, MA 02110-1301, USA.
65 #include "diam_dict.h"
66 #include "diam_dict_lex.h"
67 #include <epan/to_str.h>
68 #include <wsutil/file_util.h>
70 typedef struct entity_t {
73 struct entity_t* next;
76 #define ATTR_UINT(cont) do { D(("attr_uint " #cont "\t" )); attr_uint = &(cont); yy_push_state(GET_UINT_ATTR); } while(0)
77 #define ATTR_STR(cont) do { D(("attr_str " #cont "\t" )); attr_str = &(cont); yy_push_state(GET_ATTR); } while(0)
78 #define IGNORE() do { D(("ignore: %s\t",yytext)); yy_push_state(IGNORE_ATTR); } while(0)
80 #define D(args) ddict_debug args
82 #define MAX_INCLUDE_DEPTH 10
83 #define YY_INPUT(buf,result,max_size) { result = current_yyinput(buf,max_size); }
85 #define APPEND(txt,len) append_to_buffer(txt,len)
88 static YY_BUFFER_STATE include_stack[MAX_INCLUDE_DEPTH];
89 static int include_stack_ptr = 0;
90 static size_t (*current_yyinput)(char*,size_t);
91 static const char* sys_dir;
93 static ddict_application_t* appl;
94 static ddict_avp_t* avp;
95 static ddict_enum_t* enumitem;
96 static ddict_gavp_t* gavp;
97 static ddict_typedefn_t* typedefn;
98 static ddict_cmd_t* cmd;
99 static ddict_vendor_t* vnd;
100 static ddict_xmlpi_t* xmlpi;
102 static ddict_application_t* last_appl;
103 static ddict_avp_t* last_avp;
104 static ddict_enum_t* last_enumitem;
105 static ddict_gavp_t* last_gavp;
106 static ddict_typedefn_t* last_typedefn;
107 static ddict_cmd_t* last_cmd;
108 static ddict_vendor_t* last_vnd;
109 static ddict_xmlpi_t* last_xmlpi;
111 static char** attr_str;
112 static unsigned* attr_uint;
114 static void ddict_debug(const char* fmt, ...);
115 static void append_to_buffer(const char* txt, unsigned len);
116 static FILE* ddict_open(const char*, const char*);
121 xmlpi_start [[:blank:] \r\n]*<\?[[:blank:] \r\n]*
122 xmlpi_end [[:blank:] \r\n]*\?>[[:blank:] \r\n]*
123 xmlpi_key_attr [[:blank:] \r\n]*key[[:blank:] \r\n]*=[[:blank:] \r\n]*\042
124 xmlpi_value_attr [[:blank:] \r\n]*value[[:blank:] \r\n]*=[[:blank:] \r\n]*\042
126 comment_start [[:blank:] \r\n]*<!--[[:blank:] \r\n]*
127 comment_end [[:blank:] \r\n]*-->[[:blank:] \r\n]*
128 open_tag [[:blank:] \r\n]*<[[:blank:] \r\n]*
129 end_tag [[:blank:] \r\n]*\/>[[:blank:] \r\n]*
130 close_tag [[:blank:] \r\n]*>[[:blank:] \r\n]*
131 open_closetag [[:blank:] \r\n]*<\/[[:blank:] \r\n]*
132 equals [[:blank:] \r\n]*=[[:blank:] \r\n]*
133 whitespace [[:blank:] \r\n]*
134 dquoted \042[^\042]*\042
136 doctype [[:blank:] \r\n]*<!DOCTYPE[^\[]*\[[[:blank:] \r\n]*
137 doctype_end [[:blank:] \r\n]*\][[:blank:] \r\n]*>[[:blank:] \r\n]*
139 start_entity [[:blank:] \r\n]*<\!ENTITY[[:blank:] \r\n]*
140 system [[:blank:] \r\n]*SYSTEM[[:blank:] \r\n]*\042
141 entityname [a-z0-9-]+
143 end_entity \042[[:blank:] \r\n]*>[[:blank:] \r\n]*
157 dictionary_start <dictionary>
158 dictionary_end <\/dictionary>
160 base_start <base[^>*]*>
163 application_start <application
164 application_end<\/application>
166 command_start <command
167 command_end<\/command>
169 typedefn_start <typedefn
177 grouped_start <grouped>
178 grouped_end <\/grouped>
183 ignored_attr [a-z0-9-]+=
184 ignored_quoted \042[^\042]*\042
189 vendor_attr vendor-id=\042
190 typename_attr type-name=\042
191 typeparent_attr type-parent=\042
192 description_attr description=\042
196 %S LOADING LOADING_COMMENT LOADING_XMLPI ENTITY GET_SYSTEM GET_FILE END_ENTITY
197 %S GET_ATTR GET_UINT_ATTR END_ATTR OUTSIDE IN_DICT IN_APPL IN_AVP APPL_ATTRS IGNORE_ATTR
198 %S TYPE_ATTRS GAVP_ATTRS ENUM_ATTRS AVP_ATTRS VENDOR_ATTRS COMMAND_ATTRS TYPEDEFN_ATTRS
199 %S XMLPI_ATTRS XMLPI_GETKEY XMLPI_GETVAL XMLPI_ENDATTR
202 <LOADING>{doctype_end} ;
204 <LOADING>{comment_start} BEGIN LOADING_COMMENT;
206 <LOADING_COMMENT>{comment_end} BEGIN LOADING;
208 <LOADING>{xmlpi_start} BEGIN LOADING_XMLPI;
209 <LOADING_XMLPI>{whitespace} ;
210 <LOADING_XMLPI>{entityname} {
211 xmlpi = g_new(ddict_xmlpi_t,1);
212 xmlpi->name = g_strdup(yytext);
217 if (!dict->xmlpis) last_xmlpi = dict->xmlpis = xmlpi;
218 else last_xmlpi = last_xmlpi->next = xmlpi;
223 <XMLPI_ATTRS>{xmlpi_key_attr} BEGIN XMLPI_GETKEY;
224 <XMLPI_GETKEY>{ndquot} { xmlpi->key = strdup(yytext); BEGIN XMLPI_ATTRS; }
226 <XMLPI_ATTRS>{xmlpi_value_attr} BEGIN XMLPI_GETVAL;
227 <XMLPI_GETVAL>{ndquot} { xmlpi->value = strdup(yytext); BEGIN XMLPI_ATTRS; }
230 <XMLPI_ATTRS>{xmlpi_end} BEGIN LOADING;
233 <LOADING>{start_entity} BEGIN ENTITY;
234 <ENTITY>{entityname} {
235 entity_t* e = g_new(entity_t,1);
236 e->name = strdup(yytext);
241 <GET_SYSTEM>{system} BEGIN GET_FILE;
243 ents.next->file = strdup(yytext);
246 <END_ENTITY>{end_entity} BEGIN LOADING;
248 <LOADING>{open_tag} APPEND("<",1);
250 <LOADING>{close_tag} APPEND(">",1);
252 <LOADING>{end_tag} APPEND("/>",2);
254 <LOADING>{open_closetag} APPEND("</",2);
256 <LOADING>{whitespace} APPEND(" ",1);
258 <LOADING>{dquoted} APPEND(yytext, (unsigned) yyleng);
260 <LOADING>{equals} APPEND("=",1);
262 <LOADING>{any} APPEND(yytext, (unsigned) yyleng);
268 while(*p != ';') p++;
272 D(("looking for entity: %s\n",yytext));
274 if ( include_stack_ptr >= MAX_INCLUDE_DEPTH ) {
275 fprintf(stderr, "included files nested to deeply\n");
279 for (e = ents.next; e; e = e->next) {
280 if (strcmp(e->name,yytext) == 0) {
281 yyin = ddict_open(sys_dir,e->file);
282 D(("entity: %s filename: %s yyin: %p\n",e->name,e->file,yyin));
285 fprintf(stderr, "Could not open file: '%s', error: %s\n", e->file, g_strerror(errno) );
287 fprintf(stderr, "Could not open file: '%s', error unknown (errno == 0)\n", e->file );
290 include_stack[include_stack_ptr++] = YY_CURRENT_BUFFER;
291 yy_switch_to_buffer(yy_create_buffer( yyin, YY_BUF_SIZE ) );
299 fprintf(stderr, "Could not find entity: '%s'\n", yytext );
306 if (!yyin) yyterminate();
309 D(("closing: %p %i\n",yyin,include_stack_ptr));
311 if ( --include_stack_ptr < 0 ) {
312 D(("DONE READING\n"));
316 yy_delete_buffer( YY_CURRENT_BUFFER );
317 yy_switch_to_buffer(include_stack[include_stack_ptr]);
324 *attr_str = strdup(yytext);
330 <GET_UINT_ATTR>{number} {
331 *attr_uint = (unsigned) strtoul(yytext,NULL,10);
337 <END_ATTR>{dquot} { yy_pop_state(); }
344 <IGNORE_ATTR>{ignored_quoted} {
345 D(("=>%s<=\n",yytext));
349 <OUTSIDE>{dictionary_start} {
350 D(("dictionary_start\n"));
355 <IN_DICT>{base_start} {
360 <IN_DICT>{application_start} {
361 D(("application_start\n"));
363 appl = g_new(ddict_application_t,1);
368 if (!dict->applications) last_appl = dict->applications = appl;
369 else last_appl = last_appl->next = appl;
374 <APPL_ATTRS>{name_attr} { ATTR_STR(appl->name); }
375 <APPL_ATTRS>{id_attr} { ATTR_UINT(appl->code); }
377 <APPL_ATTRS>{stop} BEGIN IN_APPL;
378 <APPL_ATTRS>{stop_end} BEGIN IN_DICT;
380 <IN_APPL>{command_end} ;
382 <IN_APPL>{command_start} {
383 D(("command_start\n"));
385 cmd = g_new(ddict_cmd_t,1);
391 if (!dict->cmds) last_cmd = dict->cmds = cmd;
392 else last_cmd = last_cmd->next = cmd;
397 <COMMAND_ATTRS>{name_attr} { ATTR_STR(cmd->name); }
398 <COMMAND_ATTRS>{vendor_attr} { ATTR_STR(cmd->vendor); }
399 <COMMAND_ATTRS>{code_attr} { ATTR_UINT(cmd->code); }
400 <COMMAND_ATTRS>{stop} |
401 <COMMAND_ATTRS>{stop_end} { BEGIN IN_APPL; }
403 <IN_APPL>{vendor_start} {
404 D(("vendor_start\n"));
406 vnd = g_new(ddict_vendor_t,1);
411 if (!dict->vendors) last_vnd = dict->vendors = vnd;
412 else last_vnd = last_vnd->next = vnd;
417 <VENDOR_ATTRS>{name_attr} { ATTR_STR(vnd->desc); }
418 <VENDOR_ATTRS>{vendor_attr} { ATTR_STR(vnd->name); }
419 <VENDOR_ATTRS>{code_attr} { ATTR_UINT(vnd->code); }
420 <VENDOR_ATTRS>{stop} |
421 <VENDOR_ATTRS>{stop_end} { BEGIN IN_APPL; }
423 <IN_APPL>{typedefn_start} {
424 D(("typedefn_start\n"));
426 typedefn = g_new(ddict_typedefn_t,1);
427 typedefn->name = NULL;
428 typedefn->parent = NULL;
429 typedefn->next = NULL;
431 if (!dict->typedefns) last_typedefn = dict->typedefns = typedefn;
432 else last_typedefn = last_typedefn->next = typedefn;
434 BEGIN TYPEDEFN_ATTRS;
437 <TYPEDEFN_ATTRS>{typename_attr} { ATTR_STR(typedefn->name); }
438 <TYPEDEFN_ATTRS>{typeparent_attr} { ATTR_STR(typedefn->parent); }
439 <TYPEDEFN_ATTRS>{stop} |
440 <TYPEDEFN_ATTRS>{stop_end} { BEGIN IN_APPL; }
443 <IN_APPL>{avp_start} {
446 avp = g_new(ddict_avp_t,1);
448 avp->description = NULL;
456 if (! dict->avps ) last_avp = dict->avps = avp;
457 else last_avp = last_avp->next = avp;
462 <AVP_ATTRS>{name_attr} { ATTR_STR(avp->name); }
463 <AVP_ATTRS>{description_attr} { ATTR_STR(avp->description); }
464 <AVP_ATTRS>{vendor_attr} { ATTR_STR(avp->vendor); }
465 <AVP_ATTRS>{code_attr} { ATTR_UINT(avp->code); }
466 <AVP_ATTRS>{stop} { BEGIN IN_AVP; }
467 <AVP_ATTRS>{stop_end} { BEGIN IN_APPL; }
470 <IN_AVP>{grouped_start} { avp->type = strdup("Grouped"); };
471 <IN_AVP>{grouped_end} ;
473 <IN_AVP>{type_start} { BEGIN TYPE_ATTRS; }
474 <TYPE_ATTRS>{typename_attr} { ATTR_STR(avp->type); }
476 <IN_AVP>{gavp_start} {
479 gavp = g_new(ddict_gavp_t,1);
484 if (!avp->gavps) last_gavp = avp->gavps = gavp;
485 else last_gavp = last_gavp->next = gavp;
491 <GAVP_ATTRS>{name_attr} { ATTR_STR(gavp->name); }
494 <IN_AVP>{enum_start} {
497 enumitem = g_new(ddict_enum_t,1);
498 enumitem->name = NULL;
500 enumitem->next = NULL;
502 if (!avp->enums) last_enumitem = avp->enums = enumitem;
503 else last_enumitem = last_enumitem->next = enumitem;
509 <ENUM_ATTRS>{name_attr} { ATTR_STR(enumitem->name); }
510 <ENUM_ATTRS>{code_attr} { ATTR_UINT(enumitem->code); }
512 <TYPE_ATTRS,GAVP_ATTRS,ENUM_ATTRS>{stop} { BEGIN IN_AVP; }
513 <TYPE_ATTRS,GAVP_ATTRS,ENUM_ATTRS>{stop_end} { BEGIN IN_AVP; }
515 <IN_AVP>{avp_end} { D(("avp_end")); BEGIN IN_APPL; }
517 <IN_APPL>{application_end} |
518 <IN_APPL>{base_end} {
522 <IN_DICT>{dictionary_end} {
526 <AVP_ATTRS,ENUM_ATTRS,GAVP_ATTRS,TYPE_ATTRS,TYPEDEFN_ATTRS,VENDOR_ATTRS,APPL_ATTRS,COMMAND_ATTRS>{ignored_attr} IGNORE();
537 static int debugging = 0;
539 static void ddict_debug(const char* fmt, ...) {
543 if (debugging) vfprintf(stderr, fmt, ap);
550 static char* strbuf = NULL;
551 static char* write_ptr = NULL;
552 static char* read_ptr = NULL;
554 static unsigned size_strbuf = 8192;
555 static unsigned len_strbuf = 0;
557 extern void ddict_unused(void);
558 void ddict_unused(void) {
562 static void append_to_buffer(const char* txt, unsigned len) {
564 if (strbuf == NULL) {
565 read_ptr = write_ptr = strbuf = (char*)g_malloc(size_strbuf);
568 if ( (len_strbuf + len) >= size_strbuf ) {
569 read_ptr = strbuf = (char*)g_realloc(strbuf,size_strbuf *= 2);
572 write_ptr = strbuf + len_strbuf;
573 strncpy(write_ptr,txt,len);
578 static size_t file_input(char* buf, size_t max) {
581 read_cnt = fread(buf,1,max,yyin);
583 if ( read_cnt == max ) {
585 } else if (read_cnt > 0) {
593 static size_t string_input(char* buf, size_t max) {
594 if (read_ptr >= write_ptr ) {
596 } else if ( read_ptr + max > write_ptr ) {
597 max = write_ptr - read_ptr;
600 memcpy(buf,read_ptr,max);
606 static FILE* ddict_open(const char* system_directory, const char* filename) {
609 if (system_directory) {
610 fname = g_strdup_printf("%s" G_DIR_SEPARATOR_S "%s",
611 system_directory,filename);
613 fname = g_strdup(filename);
616 fh = ws_fopen(fname,"r");
618 D(("fname: %s fh: %p\n",fname,fh));
626 ddict_t* ddict_scan(const char* system_directory, const char* filename, int dbg) {
630 sys_dir = system_directory;
632 yyin = ddict_open(sys_dir,filename);
635 D(("unable to open %s\n", filename));
642 dict = g_new(ddict_t,1);
643 dict->applications = NULL;
645 dict->vendors = NULL;
646 dict->typedefns = NULL;
661 last_enumitem = NULL;
663 last_typedefn = NULL;
669 current_yyinput = file_input;
673 D(("\n---------------\n%s\n------- %u -------\n",strbuf,len_strbuf));
675 current_yyinput = string_input;
687 void ddict_free(ddict_t* d) {
688 ddict_application_t *p, *pn;
689 ddict_vendor_t *v, *vn;
691 ddict_typedefn_t *t, *tn;
694 #define FREE_NAMEANDOBJ(n) do { if(n->name) g_free(n->name); g_free(n); } while(0)
696 for (p = d->applications; p; p = pn ) {
701 for (v = d->vendors; v; v = vn) {
703 if (!v->desc) g_free(v->desc);
707 for (c = d->cmds; c; c = cn ) {
712 for (t = d->typedefns; t; t = tn) {
714 if (!t->parent) g_free(t->parent);
718 for (a = d->avps; a; a = an) {
719 ddict_gavp_t* g, *gn;
720 ddict_enum_t* e, *en;
723 for (g = a->gavps; g; g = gn) {
728 for (e = a->enums; e; e = en) {
733 if (!a->vendor) g_free(a->vendor);
734 if (!a->type) g_free(a->type);
735 if (!a->description) g_free(a->description);
742 void ddict_print(FILE* fh, ddict_t* d) {
743 ddict_application_t* p;
750 for (p = d->applications; p; p = p->next) {
751 fprintf(fh,"Application: %s[%u]:\n",
752 p->name ? p->name : "-",
756 for (v = d->vendors; v; v = v->next) {
757 fprintf(fh,"Vendor: %s[%u]:\n",
758 v->name ? v->name : "-",
762 for (c = d->cmds; c; c = c->next) {
763 fprintf(fh,"Command: %s[%u] \n",
764 c->name ? c->name : "-",
768 for (t = d->typedefns; t; t = t->next) {
769 fprintf(fh,"Type: %s -> %s \n",
770 t->name ? t->name : "-",
771 t->parent ? t->parent : "" );
774 for (a = d->avps; a; a = a->next) {
777 fprintf(fh,"AVP: %s[%u:%s] %s %s\n",
778 a->name ? a->name : "-",
780 a->vendor ? a->vendor : "None",
781 a->type ? a->type : "-",
782 a->description ? a->description : "");
784 for (g = a->gavps; g; g = g->next) {
785 fprintf(fh,"\tGAVP: %s\n",
786 g->name ? g->name : "-" );
789 for (e = a->enums; e; e = e->next) {
790 fprintf(fh,"\tEnum: %s[%u]\n",
791 e->name ? e->name : "-",
798 * We want to stop processing when we get to the end of the input.
799 * (%option noyywrap is not used because if used then
800 * some flex versions (eg: 2.5.35) generate code which causes
801 * warnings by the Windows VC compiler).
808 #ifdef TEST_DIAM_DICT_STANDALONE
809 int main(int argc, char** argv) {
822 fprintf(stderr,"%s: usage [dictionary_dir] dictionary_filename\n",argv[0]);
826 d = ddict_scan(dname,fname,1);
828 fprintf(stderr, "Can't open dictionary\n");
832 ddict_print(stdout, d);