kernel32/tests: Use shared Windows directory on TS to find regedit.exe.
[wine] / tools / widl / widl.c
1 /*
2  * IDL Compiler
3  *
4  * Copyright 2002 Ove Kaaven
5  * based on WRC code by Bertho Stultiens
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this library; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
20  */
21
22 #include "config.h"
23 #include "wine/port.h"
24
25 #include <errno.h>
26 #include <limits.h>
27 #include <stdio.h>
28 #include <stdlib.h>
29 #ifdef HAVE_UNISTD_H
30 # include <unistd.h>
31 #endif
32 #include <string.h>
33 #include <assert.h>
34 #include <ctype.h>
35 #include <signal.h>
36 #ifdef HAVE_GETOPT_H
37 # include <getopt.h>
38 #endif
39
40 #include "widl.h"
41 #include "utils.h"
42 #include "parser.h"
43 #include "wine/wpp.h"
44 #include "header.h"
45
46 /* future options to reserve characters for: */
47 /* a = alignment of structures */
48 /* A = ACF input filename */
49 /* J = do not search standard include path */
50 /* O = generate interpreted stubs */
51 /* w = select win16/win32 output (?) */
52
53 static const char usage[] =
54 "Usage: widl [options...] infile.idl\n"
55 "   or: widl [options...] --dlldata-only name1 [name2...]\n"
56 "   -c          Generate client stub\n"
57 "   -C file     Name of client stub file (default is infile_c.c)\n"
58 "   -d n        Set debug level to 'n'\n"
59 "   -D id[=val] Define preprocessor identifier id=val\n"
60 "   --dlldata=file  Name of the dlldata file (default is dlldata.c)\n"
61 "   -E          Preprocess only\n"
62 "   -h          Generate headers\n"
63 "   -H file     Name of header file (default is infile.h)\n"
64 "   -I path     Set include search dir to path (multiple -I allowed)\n"
65 "   --local-stubs=file  Write empty stubs for call_as/local methods to file\n"
66 "   -N          Do not preprocess input\n"
67 "   --oldnames  Use old naming conventions\n"
68 "   -p          Generate proxy\n"
69 "   -P file     Name of proxy file (default is infile_p.c)\n"
70 "   --prefix-all=p  Prefix names of client stubs / server functions with 'p'\n"
71 "   --prefix-client=p  Prefix names of client stubs with 'p'\n"
72 "   --prefix-server=p  Prefix names of server functions with 'p'\n"
73 "   -s          Generate server stub\n"
74 "   -S file     Name of server stub file (default is infile_s.c)\n"
75 "   -t          Generate typelib\n"
76 "   -T file     Name of typelib file (default is infile.tlb)\n"
77 "   -u          Generate interface identifiers file\n"
78 "   -U file     Name of interface identifiers file (default is infile_i.c)\n"
79 "   -V          Print version and exit\n"
80 "   -W          Enable pedantic warnings\n"
81 "   --win32     Only generate 32-bit code\n"
82 "   --win64     Only generate 64-bit code\n"
83 "Debug level 'n' is a bitmask with following meaning:\n"
84 "    * 0x01 Tell which resource is parsed (verbose mode)\n"
85 "    * 0x02 Dump internal structures\n"
86 "    * 0x04 Create a parser trace (yydebug=1)\n"
87 "    * 0x08 Preprocessor messages\n"
88 "    * 0x10 Preprocessor lex messages\n"
89 "    * 0x20 Preprocessor yacc trace\n"
90 ;
91
92 static const char version_string[] = "Wine IDL Compiler version " PACKAGE_VERSION "\n"
93                         "Copyright 2002 Ove Kaaven\n";
94
95 int win32 = 1;
96 int debuglevel = DEBUGLEVEL_NONE;
97 int parser_debug, yy_flex_debug;
98
99 int pedantic = 0;
100 int do_everything = 1;
101 int preprocess_only = 0;
102 int do_header = 0;
103 int do_typelib = 0;
104 int do_proxies = 0;
105 int do_client = 0;
106 int do_server = 0;
107 int do_idfile = 0;
108 int do_dlldata = 0;
109 int no_preprocess = 0;
110 int old_names = 0;
111 int do_win32 = 1;
112 int do_win64 = 1;
113
114 char *input_name;
115 char *header_name;
116 char *local_stubs_name;
117 char *header_token;
118 char *typelib_name;
119 char *dlldata_name;
120 char *proxy_name;
121 char *proxy_token;
122 char *client_name;
123 char *client_token;
124 char *server_name;
125 char *server_token;
126 char *idfile_name;
127 char *idfile_token;
128 char *temp_name;
129 const char *prefix_client = "";
130 const char *prefix_server = "";
131
132 int line_number = 1;
133
134 FILE *header;
135 FILE *local_stubs;
136 FILE *proxy;
137 FILE *idfile;
138
139 size_t pointer_size = 0;
140
141 time_t now;
142
143 enum {
144     OLDNAMES_OPTION = CHAR_MAX + 1,
145     DLLDATA_OPTION,
146     DLLDATA_ONLY_OPTION,
147     LOCAL_STUBS_OPTION,
148     PREFIX_ALL_OPTION,
149     PREFIX_CLIENT_OPTION,
150     PREFIX_SERVER_OPTION,
151     WIN32_OPTION,
152     WIN64_OPTION
153 };
154
155 static const char short_options[] =
156     "cC:d:D:EhH:I:NpP:sS:tT:uU:VW";
157 static const struct option long_options[] = {
158     { "dlldata", 1, 0, DLLDATA_OPTION },
159     { "dlldata-only", 0, 0, DLLDATA_ONLY_OPTION },
160     { "local-stubs", 1, 0, LOCAL_STUBS_OPTION },
161     { "oldnames", 0, 0, OLDNAMES_OPTION },
162     { "prefix-all", 1, 0, PREFIX_ALL_OPTION },
163     { "prefix-client", 1, 0, PREFIX_CLIENT_OPTION },
164     { "prefix-server", 1, 0, PREFIX_SERVER_OPTION },
165     { "win32", 0, 0, WIN32_OPTION },
166     { "win64", 0, 0, WIN64_OPTION },
167     { 0, 0, 0, 0 }
168 };
169
170 static void rm_tempfile(void);
171
172 static char *make_token(const char *name)
173 {
174   char *token;
175   char *slash;
176   int i;
177
178   slash = strrchr(name, '/');
179   if(!slash)
180     slash = strrchr(name, '\\');
181
182   if (slash) name = slash + 1;
183
184   token = xstrdup(name);
185   for (i=0; token[i]; i++) {
186     if (!isalnum(token[i])) token[i] = '_';
187     else token[i] = toupper(token[i]);
188   }
189   return token;
190 }
191
192 /* duplicate a basename into a valid C token */
193 static char *dup_basename_token(const char *name, const char *ext)
194 {
195     char *p, *ret = dup_basename( name, ext );
196     /* map invalid characters to '_' */
197     for (p = ret; *p; p++) if (!isalnum(*p)) *p = '_';
198     return ret;
199 }
200
201 /* clean things up when aborting on a signal */
202 static void exit_on_signal( int sig )
203 {
204     exit(1);  /* this will call the atexit functions */
205 }
206
207 static void set_everything(int x)
208 {
209   do_header = x;
210   do_typelib = x;
211   do_proxies = x;
212   do_client = x;
213   do_server = x;
214   do_idfile = x;
215   do_dlldata = x;
216 }
217
218 static void start_cplusplus_guard(FILE *fp)
219 {
220   fprintf(fp, "#ifdef __cplusplus\n");
221   fprintf(fp, "extern \"C\" {\n");
222   fprintf(fp, "#endif\n\n");
223 }
224
225 static void end_cplusplus_guard(FILE *fp)
226 {
227   fprintf(fp, "#ifdef __cplusplus\n");
228   fprintf(fp, "}\n");
229   fprintf(fp, "#endif\n\n");
230 }
231
232 typedef struct
233 {
234   char *filename;
235   struct list link;
236 } filename_node_t;
237
238 static void add_filename_node(struct list *list, const char *name)
239 {
240   filename_node_t *node = xmalloc(sizeof *node);
241   node->filename = dup_basename( name, ".idl" );
242   list_add_tail(list, &node->link);
243 }
244
245 static void free_filename_nodes(struct list *list)
246 {
247   filename_node_t *node, *next;
248   LIST_FOR_EACH_ENTRY_SAFE(node, next, list, filename_node_t, link) {
249     list_remove(&node->link);
250     free(node->filename);
251     free(node);
252   }
253 }
254
255 static void write_dlldata_list(struct list *filenames)
256 {
257   FILE *dlldata;
258   filename_node_t *node;
259
260   dlldata = fopen(dlldata_name, "w");
261   if (!dlldata)
262     error("couldn't open %s: %s\n", dlldata_name, strerror(errno));
263
264   fprintf(dlldata, "/*** Autogenerated by WIDL %s ", PACKAGE_VERSION);
265   fprintf(dlldata, "- Do not edit ***/\n\n");
266   fprintf(dlldata, "#include <objbase.h>\n");
267   fprintf(dlldata, "#include <rpcproxy.h>\n\n");
268   start_cplusplus_guard(dlldata);
269
270   LIST_FOR_EACH_ENTRY(node, filenames, filename_node_t, link)
271     fprintf(dlldata, "EXTERN_PROXY_FILE(%s)\n", node->filename);
272
273   fprintf(dlldata, "\nPROXYFILE_LIST_START\n");
274   fprintf(dlldata, "/* Start of list */\n");
275   LIST_FOR_EACH_ENTRY(node, filenames, filename_node_t, link)
276     fprintf(dlldata, "  REFERENCE_PROXY_FILE(%s),\n", node->filename);
277   fprintf(dlldata, "/* End of list */\n");
278   fprintf(dlldata, "PROXYFILE_LIST_END\n\n");
279
280   fprintf(dlldata, "DLLDATA_ROUTINES(aProxyFileList, GET_DLL_CLSID)\n\n");
281   end_cplusplus_guard(dlldata);
282   fclose(dlldata);
283 }
284
285 static char *eat_space(char *s)
286 {
287   while (isspace((unsigned char) *s))
288     ++s;
289   return s;
290 }
291
292 void write_dlldata(const statement_list_t *stmts)
293 {
294   struct list filenames = LIST_INIT(filenames);
295   filename_node_t *node;
296   FILE *dlldata;
297
298   if (!do_dlldata || !need_proxy_file(stmts))
299     return;
300
301   dlldata = fopen(dlldata_name, "r");
302   if (dlldata) {
303     static char marker[] = "REFERENCE_PROXY_FILE";
304     char *line = NULL;
305     size_t len = 0;
306
307     while (widl_getline(&line, &len, dlldata)) {
308       char *start, *end;
309       start = eat_space(line);
310       if (strncmp(start, marker, sizeof marker - 1) == 0) {
311         start = eat_space(start + sizeof marker - 1);
312         if (*start != '(')
313           continue;
314         end = start = eat_space(start + 1);
315         while (*end && *end != ')')
316           ++end;
317         if (*end != ')')
318           continue;
319         while (isspace((unsigned char) end[-1]))
320           --end;
321         *end = '\0';
322         if (start < end)
323           add_filename_node(&filenames, start);
324       }
325     }
326
327     if (ferror(dlldata))
328       error("couldn't read from %s: %s\n", dlldata_name, strerror(errno));
329
330     free(line);
331     fclose(dlldata);
332   }
333
334   LIST_FOR_EACH_ENTRY(node, &filenames, filename_node_t, link)
335     if (strcmp(proxy_token, node->filename) == 0) {
336       /* We're already in the list, no need to regenerate this file.  */
337       free_filename_nodes(&filenames);
338       return;
339     }
340
341   add_filename_node(&filenames, proxy_token);
342   write_dlldata_list(&filenames);
343   free_filename_nodes(&filenames);
344 }
345
346 int main(int argc,char *argv[])
347 {
348   extern char* optarg;
349   extern int   optind;
350   int optc;
351   int ret = 0;
352   int opti = 0;
353
354   signal( SIGTERM, exit_on_signal );
355   signal( SIGINT, exit_on_signal );
356 #ifdef SIGHUP
357   signal( SIGHUP, exit_on_signal );
358 #endif
359
360   now = time(NULL);
361
362   while((optc = getopt_long(argc, argv, short_options, long_options, &opti)) != EOF) {
363     switch(optc) {
364     case DLLDATA_OPTION:
365       dlldata_name = xstrdup(optarg);
366       break;
367     case DLLDATA_ONLY_OPTION:
368       do_everything = 0;
369       do_dlldata = 1;
370       break;
371     case LOCAL_STUBS_OPTION:
372       do_everything = 0;
373       local_stubs_name = xstrdup(optarg);
374       break;
375     case OLDNAMES_OPTION:
376       old_names = 1;
377       break;
378     case PREFIX_ALL_OPTION:
379       prefix_client = xstrdup(optarg);
380       prefix_server = xstrdup(optarg);
381       break;
382     case PREFIX_CLIENT_OPTION:
383       prefix_client = xstrdup(optarg);
384       break;
385     case PREFIX_SERVER_OPTION:
386       prefix_server = xstrdup(optarg);
387       break;
388     case WIN32_OPTION:
389       do_win32 = 1;
390       do_win64 = 0;
391       break;
392     case WIN64_OPTION:
393       do_win32 = 0;
394       do_win64 = 1;
395       break;
396     case 'c':
397       do_everything = 0;
398       do_client = 1;
399       break;
400     case 'C':
401       client_name = xstrdup(optarg);
402       break;
403     case 'd':
404       debuglevel = strtol(optarg, NULL, 0);
405       break;
406     case 'D':
407       wpp_add_cmdline_define(optarg);
408       break;
409     case 'E':
410       do_everything = 0;
411       preprocess_only = 1;
412       break;
413     case 'h':
414       do_everything = 0;
415       do_header = 1;
416       break;
417     case 'H':
418       header_name = xstrdup(optarg);
419       break;
420     case 'I':
421       wpp_add_include_path(optarg);
422       break;
423     case 'N':
424       no_preprocess = 1;
425       break;
426     case 'p':
427       do_everything = 0;
428       do_proxies = 1;
429       break;
430     case 'P':
431       proxy_name = xstrdup(optarg);
432       break;
433     case 's':
434       do_everything = 0;
435       do_server = 1;
436       break;
437     case 'S':
438       server_name = xstrdup(optarg);
439       break;
440     case 't':
441       do_everything = 0;
442       do_typelib = 1;
443       break;
444     case 'T':
445       typelib_name = xstrdup(optarg);
446       break;
447     case 'u':
448       do_everything = 0;
449       do_idfile = 1;
450       break;
451     case 'U':
452       idfile_name = xstrdup(optarg);
453       break;
454     case 'V':
455       printf("%s", version_string);
456       return 0;
457     case 'W':
458       pedantic = 1;
459       break;
460     default:
461       fprintf(stderr, "%s", usage);
462       return 1;
463     }
464   }
465
466   if(do_everything) {
467     set_everything(TRUE);
468   }
469
470   if (!dlldata_name && do_dlldata)
471     dlldata_name = xstrdup("dlldata.c");
472
473   if(optind < argc) {
474     if (do_dlldata && !do_everything) {
475       struct list filenames = LIST_INIT(filenames);
476       for ( ; optind < argc; ++optind)
477         add_filename_node(&filenames, argv[optind]);
478
479       write_dlldata_list(&filenames);
480       free_filename_nodes(&filenames);
481       return 0;
482     }
483     else if (optind != argc - 1) {
484       fprintf(stderr, "%s", usage);
485       return 1;
486     }
487     else
488       input_name = xstrdup(argv[optind]);
489   }
490   else {
491     fprintf(stderr, "%s", usage);
492     return 1;
493   }
494
495   if(debuglevel)
496   {
497     setbuf(stdout,0);
498     setbuf(stderr,0);
499   }
500
501   parser_debug = debuglevel & DEBUGLEVEL_TRACE ? 1 : 0;
502   yy_flex_debug = debuglevel & DEBUGLEVEL_TRACE ? 1 : 0;
503
504   wpp_set_debug( (debuglevel & DEBUGLEVEL_PPLEX) != 0,
505                  (debuglevel & DEBUGLEVEL_PPTRACE) != 0,
506                  (debuglevel & DEBUGLEVEL_PPMSG) != 0 );
507
508   if (!header_name) {
509     header_name = dup_basename(input_name, ".idl");
510     strcat(header_name, ".h");
511   }
512
513   if (!typelib_name && do_typelib) {
514     typelib_name = dup_basename(input_name, ".idl");
515     strcat(typelib_name, ".tlb");
516   }
517
518   if (!proxy_name && do_proxies) {
519     proxy_name = dup_basename(input_name, ".idl");
520     strcat(proxy_name, "_p.c");
521   }
522
523   if (!client_name && do_client) {
524     client_name = dup_basename(input_name, ".idl");
525     strcat(client_name, "_c.c");
526   }
527
528   if (!server_name && do_server) {
529     server_name = dup_basename(input_name, ".idl");
530     strcat(server_name, "_s.c");
531   }
532
533   if (!idfile_name && do_idfile) {
534     idfile_name = dup_basename(input_name, ".idl");
535     strcat(idfile_name, "_i.c");
536   }
537
538   if (do_proxies) proxy_token = dup_basename_token(proxy_name,"_p.c");
539   if (do_client) client_token = dup_basename_token(client_name,"_c.c");
540   if (do_server) server_token = dup_basename_token(server_name,"_s.c");
541
542   wpp_add_cmdline_define("__WIDL__");
543
544   atexit(rm_tempfile);
545   if (!no_preprocess)
546   {
547     chat("Starting preprocess\n");
548
549     if (!preprocess_only)
550     {
551         ret = wpp_parse_temp( input_name, header_name, &temp_name );
552     }
553     else
554     {
555         ret = wpp_parse( input_name, stdout );
556     }
557
558     if(ret) exit(1);
559     if(preprocess_only) exit(0);
560     if(!(parser_in = fopen(temp_name, "r"))) {
561       fprintf(stderr, "Could not open %s for input\n", temp_name);
562       return 1;
563     }
564   }
565   else {
566     if(!(parser_in = fopen(input_name, "r"))) {
567       fprintf(stderr, "Could not open %s for input\n", input_name);
568       return 1;
569     }
570   }
571
572   if(do_header) {
573     header_token = make_token(header_name);
574
575     if(!(header = fopen(header_name, "w"))) {
576       fprintf(stderr, "Could not open %s for output\n", header_name);
577       return 1;
578     }
579     fprintf(header, "/*** Autogenerated by WIDL %s from %s - Do not edit ***/\n", PACKAGE_VERSION, input_name);
580     fprintf(header, "#include <rpc.h>\n" );
581     fprintf(header, "#include <rpcndr.h>\n\n" );
582     fprintf(header, "#ifndef __WIDL_%s\n", header_token);
583     fprintf(header, "#define __WIDL_%s\n", header_token);
584     start_cplusplus_guard(header);
585   }
586
587   if (local_stubs_name) {
588     local_stubs = fopen(local_stubs_name, "w");
589     if (!local_stubs) {
590       fprintf(stderr, "Could not open %s for output\n", local_stubs_name);
591       return 1;
592     }
593     fprintf(local_stubs, "/* call_as/local stubs for %s */\n\n", input_name);
594     fprintf(local_stubs, "#include <objbase.h>\n");
595     fprintf(local_stubs, "#include \"%s\"\n\n", header_name);
596   }
597
598   if (do_idfile) {
599     idfile_token = make_token(idfile_name);
600
601     idfile = fopen(idfile_name, "w");
602     if (! idfile) {
603       fprintf(stderr, "Could not open %s for output\n", idfile_name);
604       return 1;
605     }
606
607     fprintf(idfile, "/*** Autogenerated by WIDL %s ", PACKAGE_VERSION);
608     fprintf(idfile, "from %s - Do not edit ***/\n\n", input_name);
609     fprintf(idfile, "#include <rpc.h>\n");
610     fprintf(idfile, "#include <rpcndr.h>\n\n");
611     fprintf(idfile, "#include <initguid.h>\n\n");
612     start_cplusplus_guard(idfile);
613   }
614
615   init_types();
616   ret = parser_parse();
617
618   if(do_header) {
619     fprintf(header, "/* Begin additional prototypes for all interfaces */\n");
620     fprintf(header, "\n");
621     write_user_types();
622     write_generic_handle_routines();
623     write_context_handle_rundowns();
624     fprintf(header, "\n");
625     fprintf(header, "/* End additional prototypes */\n");
626     fprintf(header, "\n");
627     end_cplusplus_guard(header);
628     fprintf(header, "#endif /* __WIDL_%s */\n", header_token);
629     fclose(header);
630   }
631
632   if (local_stubs) {
633     fclose(local_stubs);
634   }
635
636   if (do_idfile) {
637     fprintf(idfile, "\n");
638     end_cplusplus_guard(idfile);
639
640     fclose(idfile);
641   }
642
643   fclose(parser_in);
644
645   if(ret) {
646     exit(1);
647   }
648
649   /* Everything has been done successfully, don't delete any files.  */
650   set_everything(FALSE);
651   local_stubs_name = NULL;
652
653   return 0;
654 }
655
656 static void rm_tempfile(void)
657 {
658   abort_import();
659   if(temp_name)
660     unlink(temp_name);
661   if (do_header)
662     unlink(header_name);
663   if (local_stubs_name)
664     unlink(local_stubs_name);
665   if (do_client)
666     unlink(client_name);
667   if (do_server)
668     unlink(server_name);
669   if (do_idfile)
670     unlink(idfile_name);
671   if (do_proxies)
672     unlink(proxy_name);
673   if (do_typelib)
674     unlink(typelib_name);
675 }