widl: Generate class forward declaration for coclasses.
[wine.git] / tools / widl / parser.l
blobe80616792b45cd8c9e7f331b905f04abe866a2d8
1 /* -*-C-*-
2  * IDL Compiler
3  *
4  * Copyright 2002 Ove Kaaven
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
19  */
21 %option stack
22 %option noinput nounput noyy_top_state
23 %option 8bit never-interactive prefix="parser_"
25 nl      \r?\n
26 ws      [ \f\t\r]
27 cident  [a-zA-Z_][0-9a-zA-Z_]*
28 u_suffix        (u|U)
29 l_suffix        (l|L)
30 int     [0-9]+({l_suffix}?{u_suffix}?|{u_suffix}?{l_suffix}?)?
31 hexd    [0-9a-fA-F]
32 hex     0(x|X){hexd}+({l_suffix}?{u_suffix}?|{u_suffix}?{l_suffix}?)?
33 uuid    {hexd}{8}-{hexd}{4}-{hexd}{4}-{hexd}{4}-{hexd}{12}
34 double  [0-9]+\.[0-9]+([eE][+-]?[0-9]+)*
36 %x QUOTE
37 %x WSTRQUOTE
38 %x ATTR
39 %x PP_LINE
40 %x SQUOTE
44 #include "config.h"
45 #include "wine/port.h"
47 #include <stdio.h>
48 #include <stdlib.h>
49 #include <string.h>
50 #include <ctype.h>
51 #include <assert.h>
52 #include <errno.h>
53 #include <limits.h>
55 #ifdef HAVE_UNISTD_H
56 #include <unistd.h>
57 #else
58 #define YY_NO_UNISTD_H
59 #endif
61 #include "widl.h"
62 #include "utils.h"
63 #include "parser.h"
64 #include "wine/wpp.h"
66 #include "parser.tab.h"
68 static void addcchar(char c);
69 static char *get_buffered_cstring(void);
71 static char *cbuffer;
72 static int cbufidx;
73 static int cbufalloc = 0;
75 static int kw_token(const char *kw);
76 static int attr_token(const char *kw);
78 #define MAX_IMPORT_DEPTH 10
79 struct {
80   YY_BUFFER_STATE state;
81   char *input_name;
82   int   line_number;
83   char *temp_name;
84 } import_stack[MAX_IMPORT_DEPTH];
85 int import_stack_ptr = 0;
87 /* converts an integer in string form to an unsigned long and prints an error
88  * on overflow */
89 static unsigned int xstrtoul(const char *nptr, char **endptr, int base)
91     unsigned long val;
93     errno = 0;
94     val = strtoul(nptr, endptr, base);
95     if ((val == ULONG_MAX && errno == ERANGE) || ((unsigned int)val != val))
96         error_loc("integer constant %s is too large\n", nptr);
97     return val;
100 UUID *parse_uuid(const char *u)
102   UUID* uuid = xmalloc(sizeof(UUID));
103   char b[3];
104   /* it would be nice to use UuidFromStringA */
105   uuid->Data1 = strtoul(u, NULL, 16);
106   uuid->Data2 = strtoul(u+9, NULL, 16);
107   uuid->Data3 = strtoul(u+14, NULL, 16);
108   b[2] = 0;
109   memcpy(b, u+19, 2); uuid->Data4[0] = strtoul(b, NULL, 16);
110   memcpy(b, u+21, 2); uuid->Data4[1] = strtoul(b, NULL, 16);
111   memcpy(b, u+24, 2); uuid->Data4[2] = strtoul(b, NULL, 16);
112   memcpy(b, u+26, 2); uuid->Data4[3] = strtoul(b, NULL, 16);
113   memcpy(b, u+28, 2); uuid->Data4[4] = strtoul(b, NULL, 16);
114   memcpy(b, u+30, 2); uuid->Data4[5] = strtoul(b, NULL, 16);
115   memcpy(b, u+32, 2); uuid->Data4[6] = strtoul(b, NULL, 16);
116   memcpy(b, u+34, 2); uuid->Data4[7] = strtoul(b, NULL, 16);
117   return uuid;
123  **************************************************************************
124  * The flexer starts here
125  **************************************************************************
126  */
128 <INITIAL,ATTR>^{ws}*\#{ws}*     yy_push_state(PP_LINE);
129 <PP_LINE>[^\n]*         {
130                             int lineno;
131                             char *cptr, *fname;
132                             yy_pop_state();
133                             lineno = (int)strtol(yytext, &cptr, 10);
134                             if(!lineno)
135                                 error_loc("Malformed '#...' line-directive; invalid linenumber\n");
136                             fname = strchr(cptr, '"');
137                             if(!fname)
138                                 error_loc("Malformed '#...' line-directive; missing filename\n");
139                             fname++;
140                             cptr = strchr(fname, '"');
141                             if(!cptr)
142                                 error_loc("Malformed '#...' line-directive; missing terminating \"\n");
143                             *cptr = '\0';
144                             line_number = lineno - 1;  /* We didn't read the newline */
145                             input_name = xstrdup(fname);
146                         }
147 <INITIAL,ATTR>\"        yy_push_state(QUOTE); cbufidx = 0;
148 <QUOTE>\"               {
149                                 yy_pop_state();
150                                 parser_lval.str = get_buffered_cstring();
151                                 return aSTRING;
152                         }
153 <INITIAL,ATTR>L\"       yy_push_state(WSTRQUOTE); cbufidx = 0;
154 <WSTRQUOTE>\"           {
155                                 yy_pop_state();
156                                 parser_lval.str = get_buffered_cstring();
157                                 return aWSTRING;
158                         }
159 <INITIAL,ATTR>\'        yy_push_state(SQUOTE); cbufidx = 0;
160 <SQUOTE>\'              {
161                                 yy_pop_state();
162                                 parser_lval.str = get_buffered_cstring();
163                                 return aSQSTRING;
164                         }
165 <QUOTE,WSTRQUOTE,SQUOTE>\\\\    |
166 <QUOTE,WSTRQUOTE>\\\"   addcchar(yytext[1]);
167 <SQUOTE>\\\'    addcchar(yytext[1]);
168 <QUOTE,WSTRQUOTE,SQUOTE>\\.     addcchar('\\'); addcchar(yytext[1]);
169 <QUOTE,WSTRQUOTE,SQUOTE>.       addcchar(yytext[0]);
170 <INITIAL,ATTR>\[        yy_push_state(ATTR); return '[';
171 <ATTR>\]                yy_pop_state(); return ']';
172 <ATTR>{cident}          return attr_token(yytext);
173 <ATTR>{uuid}                    {
174                                 parser_lval.uuid = parse_uuid(yytext);
175                                 return aUUID;
176                         }
177 <INITIAL,ATTR>{hex}     {
178                                 parser_lval.num = xstrtoul(yytext, NULL, 0);
179                                 return aHEXNUM;
180                         }
181 <INITIAL,ATTR>{int}     {
182                                 parser_lval.num = xstrtoul(yytext, NULL, 0);
183                                 return aNUM;
184                         }
185 <INITIAL>{double}       {
186                                 parser_lval.dbl = strtod(yytext, NULL);
187                                 return aDOUBLE;
188                         }
189 SAFEARRAY{ws}*/\(       return tSAFEARRAY;
190 {cident}                return kw_token(yytext);
191 <INITIAL,ATTR>\n        line_number++;
192 <INITIAL,ATTR>{ws}
193 <INITIAL,ATTR>\<\<      return SHL;
194 <INITIAL,ATTR>\>\>      return SHR;
195 <INITIAL,ATTR>\-\>      return MEMBERPTR;
196 <INITIAL,ATTR>==        return EQUALITY;
197 <INITIAL,ATTR>!=        return INEQUALITY;
198 <INITIAL,ATTR>\>=       return GREATEREQUAL;
199 <INITIAL,ATTR>\<=       return LESSEQUAL;
200 <INITIAL,ATTR>\|\|      return LOGICALOR;
201 <INITIAL,ATTR>&&        return LOGICALAND;
202 <INITIAL,ATTR>\.\.\.    return ELLIPSIS;
203 <INITIAL,ATTR>.         return yytext[0];
204 <<EOF>>                 {
205                                 if (import_stack_ptr)
206                                         return aEOF;
207                                 else yyterminate();
208                         }
211 #ifndef parser_wrap
212 int parser_wrap(void)
214         return 1;
216 #endif
218 struct keyword {
219         const char *kw;
220         int token;
223 /* This table MUST be alphabetically sorted on the kw field */
224 static const struct keyword keywords[] = {
225         {"FALSE",                       tFALSE},
226         {"NULL",                        tNULL},
227         {"TRUE",                        tTRUE},
228         {"__cdecl",                     tCDECL},
229         {"__fastcall",                  tFASTCALL},
230         {"__int3264",                   tINT3264},
231         {"__int64",                     tINT64},
232         {"__pascal",                    tPASCAL},
233         {"__stdcall",                   tSTDCALL},
234         {"_cdecl",                      tCDECL},
235         {"_fastcall",                   tFASTCALL},
236         {"_pascal",                     tPASCAL},
237         {"_stdcall",                    tSTDCALL},
238         {"boolean",                     tBOOLEAN},
239         {"byte",                        tBYTE},
240         {"case",                        tCASE},
241         {"cdecl",                       tCDECL},
242         {"char",                        tCHAR},
243         {"coclass",                     tCOCLASS},
244         {"const",                       tCONST},
245         {"cpp_quote",                   tCPPQUOTE},
246         {"default",                     tDEFAULT},
247         {"dispinterface",               tDISPINTERFACE},
248         {"double",                      tDOUBLE},
249         {"enum",                        tENUM},
250         {"error_status_t",              tERRORSTATUST},
251         {"extern",                      tEXTERN},
252         {"float",                       tFLOAT},
253         {"handle_t",                    tHANDLET},
254         {"hyper",                       tHYPER},
255         {"import",                      tIMPORT},
256         {"importlib",                   tIMPORTLIB},
257         {"inline",                      tINLINE},
258         {"int",                         tINT},
259         {"interface",                   tINTERFACE},
260         {"library",                     tLIBRARY},
261         {"long",                        tLONG},
262         {"methods",                     tMETHODS},
263         {"module",                      tMODULE},
264         {"pascal",                      tPASCAL},
265         {"properties",                  tPROPERTIES},
266         {"register",                    tREGISTER},
267         {"short",                       tSHORT},
268         {"signed",                      tSIGNED},
269         {"sizeof",                      tSIZEOF},
270         {"small",                       tSMALL},
271         {"static",                      tSTATIC},
272         {"stdcall",                     tSTDCALL},
273         {"struct",                      tSTRUCT},
274         {"switch",                      tSWITCH},
275         {"typedef",                     tTYPEDEF},
276         {"union",                       tUNION},
277         {"unsigned",                    tUNSIGNED},
278         {"void",                        tVOID},
279         {"wchar_t",                     tWCHAR},
281 #define NKEYWORDS (sizeof(keywords)/sizeof(keywords[0]))
283 /* keywords only recognized in attribute lists
284  * This table MUST be alphabetically sorted on the kw field
285  */
286 static const struct keyword attr_keywords[] =
288         {"aggregatable",                tAGGREGATABLE},
289         {"allocate",                    tALLOCATE},
290         {"annotation",                  tANNOTATION},
291         {"apartment",                   tAPARTMENT},
292         {"appobject",                   tAPPOBJECT},
293         {"async",                       tASYNC},
294         {"async_uuid",                  tASYNCUUID},
295         {"auto_handle",                 tAUTOHANDLE},
296         {"bindable",                    tBINDABLE},
297         {"both",                        tBOTH},
298         {"broadcast",                   tBROADCAST},
299         {"byte_count",                  tBYTECOUNT},
300         {"call_as",                     tCALLAS},
301         {"callback",                    tCALLBACK},
302         {"code",                        tCODE},
303         {"comm_status",                 tCOMMSTATUS},
304         {"context_handle",              tCONTEXTHANDLE},
305         {"context_handle_noserialize",  tCONTEXTHANDLENOSERIALIZE},
306         {"context_handle_serialize",    tCONTEXTHANDLENOSERIALIZE},
307         {"control",                     tCONTROL},
308         {"decode",                      tDECODE},
309         {"defaultbind",                 tDEFAULTBIND},
310         {"defaultcollelem",             tDEFAULTCOLLELEM},
311         {"defaultvalue",                tDEFAULTVALUE},
312         {"defaultvtable",               tDEFAULTVTABLE},
313         {"disable_consistency_check",   tDISABLECONSISTENCYCHECK},
314         {"displaybind",                 tDISPLAYBIND},
315         {"dllname",                     tDLLNAME},
316         {"dual",                        tDUAL},
317         {"enable_allocate",             tENABLEALLOCATE},
318         {"encode",                      tENCODE},
319         {"endpoint",                    tENDPOINT},
320         {"entry",                       tENTRY},
321         {"explicit_handle",             tEXPLICITHANDLE},
322         {"fault_status",                tFAULTSTATUS},
323         {"force_allocate",              tFORCEALLOCATE},
324         {"free",                        tFREE},
325         {"handle",                      tHANDLE},
326         {"helpcontext",                 tHELPCONTEXT},
327         {"helpfile",                    tHELPFILE},
328         {"helpstring",                  tHELPSTRING},
329         {"helpstringcontext",           tHELPSTRINGCONTEXT},
330         {"helpstringdll",               tHELPSTRINGDLL},
331         {"hidden",                      tHIDDEN},
332         {"id",                          tID},
333         {"idempotent",                  tIDEMPOTENT},
334         {"ignore",                      tIGNORE},
335         {"iid_is",                      tIIDIS},
336         {"immediatebind",               tIMMEDIATEBIND},
337         {"implicit_handle",             tIMPLICITHANDLE},
338         {"in",                          tIN},
339         {"in_line",                     tIN_LINE},
340         {"input_sync",                  tINPUTSYNC},
341         {"lcid",                        tLCID},
342         {"length_is",                   tLENGTHIS},
343         {"licensed",                    tLICENSED},
344         {"local",                       tLOCAL},
345         {"maybe",                       tMAYBE},
346         {"message",                     tMESSAGE},
347         {"neutral",                     tNEUTRAL},
348         {"nocode",                      tNOCODE},
349         {"nonbrowsable",                tNONBROWSABLE},
350         {"noncreatable",                tNONCREATABLE},
351         {"nonextensible",               tNONEXTENSIBLE},
352         {"notify",                      tNOTIFY},
353         {"notify_flag",                 tNOTIFYFLAG},
354         {"object",                      tOBJECT},
355         {"odl",                         tODL},
356         {"oleautomation",               tOLEAUTOMATION},
357         {"optimize",                    tOPTIMIZE},
358         {"optional",                    tOPTIONAL},
359         {"out",                         tOUT},
360         {"partial_ignore",              tPARTIALIGNORE},
361         {"pointer_default",             tPOINTERDEFAULT},
362         {"progid",                      tPROGID},
363         {"propget",                     tPROPGET},
364         {"propput",                     tPROPPUT},
365         {"propputref",                  tPROPPUTREF},
366         {"proxy",                       tPROXY},
367         {"ptr",                         tPTR},
368         {"public",                      tPUBLIC},
369         {"range",                       tRANGE},
370         {"readonly",                    tREADONLY},
371         {"ref",                         tREF},
372         {"represent_as",                tREPRESENTAS},
373         {"requestedit",                 tREQUESTEDIT},
374         {"restricted",                  tRESTRICTED},
375         {"retval",                      tRETVAL},
376         {"single",                      tSINGLE},
377         {"size_is",                     tSIZEIS},
378         {"source",                      tSOURCE},
379         {"strict_context_handle",       tSTRICTCONTEXTHANDLE},
380         {"string",                      tSTRING},
381         {"switch_is",                   tSWITCHIS},
382         {"switch_type",                 tSWITCHTYPE},
383         {"threading",                   tTHREADING},
384         {"transmit_as",                 tTRANSMITAS},
385         {"uidefault",                   tUIDEFAULT},
386         {"unique",                      tUNIQUE},
387         {"user_marshal",                tUSERMARSHAL},
388         {"usesgetlasterror",            tUSESGETLASTERROR},
389         {"uuid",                        tUUID},
390         {"v1_enum",                     tV1ENUM},
391         {"vararg",                      tVARARG},
392         {"version",                     tVERSION},
393         {"vi_progid",                   tVIPROGID},
394         {"wire_marshal",                tWIREMARSHAL},
397 /* attributes TODO:
398     custom
399     first_is
400     last_is
401     max_is
402     min_is
405 #define KWP(p) ((const struct keyword *)(p))
407 static int kw_cmp_func(const void *s1, const void *s2)
409         return strcmp(KWP(s1)->kw, KWP(s2)->kw);
412 static int kw_token(const char *kw)
414         struct keyword key, *kwp;
415         key.kw = kw;
416         kwp = bsearch(&key, keywords, NKEYWORDS, sizeof(keywords[0]), kw_cmp_func);
417         if (kwp) {
418                 parser_lval.str = xstrdup(kwp->kw);
419                 return kwp->token;
420         }
421         parser_lval.str = xstrdup(kw);
422         return is_type(kw) ? aKNOWNTYPE : aIDENTIFIER;
425 static int attr_token(const char *kw)
427         struct keyword key, *kwp;
428         key.kw = kw;
429         kwp = bsearch(&key, attr_keywords, sizeof(attr_keywords)/sizeof(attr_keywords[0]),
430                       sizeof(attr_keywords[0]), kw_cmp_func);
431         if (kwp) {
432             parser_lval.str = xstrdup(kwp->kw);
433             return kwp->token;
434         }
435         return kw_token(kw);
438 static void addcchar(char c)
440         if(cbufidx >= cbufalloc)
441         {
442                 cbufalloc += 1024;
443                 cbuffer = xrealloc(cbuffer, cbufalloc * sizeof(cbuffer[0]));
444                 if(cbufalloc > 65536)
445                         parser_warning("Reallocating string buffer larger than 64kB\n");
446         }
447         cbuffer[cbufidx++] = c;
450 static char *get_buffered_cstring(void)
452         addcchar(0);
453         return xstrdup(cbuffer);
456 void pop_import(void)
458         int ptr = import_stack_ptr-1;
460         fclose(yyin);
461         yy_delete_buffer( YY_CURRENT_BUFFER );
462         yy_switch_to_buffer( import_stack[ptr].state );
463         if (temp_name) {
464                 unlink(temp_name);
465                 free(temp_name);
466         }
467         temp_name = import_stack[ptr].temp_name;
468         input_name = import_stack[ptr].input_name;
469         line_number = import_stack[ptr].line_number;
470         import_stack_ptr--;
473 struct imports {
474         char *name;
475         struct imports *next;
476 } *first_import;
478 int do_import(char *fname)
480         FILE *f;
481         char *path, *name;
482         struct imports *import;
483         int ptr = import_stack_ptr;
484         int ret, fd;
486         import = first_import;
487         while (import && strcmp(import->name, fname))
488                 import = import->next;
489         if (import) return 0; /* already imported */
491         import = xmalloc(sizeof(struct imports));
492         import->name = xstrdup(fname);
493         import->next = first_import;
494         first_import = import;
496         /* don't search for a file name with a path in the include directories,
497          * for compatibility with MIDL */
498         if (strchr( fname, '/' ) || strchr( fname, '\\' ))
499             path = xstrdup( fname );
500         else if (!(path = wpp_find_include( fname, input_name )))
501             error_loc("Unable to open include file %s\n", fname);
503         import_stack[ptr].temp_name = temp_name;
504         import_stack[ptr].input_name = input_name;
505         import_stack[ptr].line_number = line_number;
506         import_stack_ptr++;
507         input_name = path;
508         line_number = 1;
510         name = xstrdup( "widl.XXXXXX" );
511         if((fd = mkstemps( name, 0 )) == -1)
512             error("Could not generate a temp name from %s\n", name);
514         temp_name = name;
515         if (!(f = fdopen(fd, "wt")))
516             error("Could not open fd %s for writing\n", name);
518         ret = wpp_parse( path, f );
519         fclose( f );
520         if (ret) exit(1);
522         if((f = fopen(temp_name, "r")) == NULL)
523                 error_loc("Unable to open %s\n", temp_name);
525         import_stack[ptr].state = YY_CURRENT_BUFFER;
526         yy_switch_to_buffer(yy_create_buffer(f, YY_BUF_SIZE));
527         return 1;
530 void abort_import(void)
532         int ptr;
534         for (ptr=0; ptr<import_stack_ptr; ptr++)
535                 unlink(import_stack[ptr].temp_name);