krnl386.exe16: Update a comment.
[wine/testsucceed.git] / tools / widl / widl.c
blobcc252018acf355ba836e374370d8e2207453a1a7
1 /*
2 * IDL Compiler
4 * Copyright 2002 Ove Kaaven
5 * based on WRC code by Bertho Stultiens
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.
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.
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
22 #include "config.h"
23 #include "wine/port.h"
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
40 #include "widl.h"
41 #include "utils.h"
42 #include "parser.h"
43 #include "wine/wpp.h"
44 #include "header.h"
46 /* future options to reserve characters for: */
47 /* A = ACF input filename */
48 /* J = do not search standard include path */
49 /* O = generate interpreted stubs */
50 /* w = select win16/win32 output (?) */
52 static const char usage[] =
53 "Usage: widl [options...] infile.idl\n"
54 " or: widl [options...] --dlldata-only name1 [name2...]\n"
55 " -b arch Set the target architecture\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 " -m32, -m64 Set the kind of typelib to build (Win32 or Win64)\n"
67 " -N Do not preprocess input\n"
68 " --oldnames Use old naming conventions\n"
69 " -p Generate proxy\n"
70 " -P file Name of proxy file (default is infile_p.c)\n"
71 " --prefix-all=p Prefix names of client stubs / server functions with 'p'\n"
72 " --prefix-client=p Prefix names of client stubs with 'p'\n"
73 " --prefix-server=p Prefix names of server functions with 'p'\n"
74 " -s Generate server stub\n"
75 " -S file Name of server stub file (default is infile_s.c)\n"
76 " -t Generate typelib\n"
77 " -T file Name of typelib file (default is infile.tlb)\n"
78 " -u Generate interface identifiers file\n"
79 " -U file Name of interface identifiers file (default is infile_i.c)\n"
80 " -V Print version and exit\n"
81 " -W Enable pedantic warnings\n"
82 " --win32 Only generate 32-bit code\n"
83 " --win64 Only generate 64-bit code\n"
84 " --win32-align n Set win32 structure alignment to 'n'\n"
85 " --win64-align n Set win64 structure alignment to 'n'\n"
86 "Debug level 'n' is a bitmask with following meaning:\n"
87 " * 0x01 Tell which resource is parsed (verbose mode)\n"
88 " * 0x02 Dump internal structures\n"
89 " * 0x04 Create a parser trace (yydebug=1)\n"
90 " * 0x08 Preprocessor messages\n"
91 " * 0x10 Preprocessor lex messages\n"
92 " * 0x20 Preprocessor yacc trace\n"
95 static const char version_string[] = "Wine IDL Compiler version " PACKAGE_VERSION "\n"
96 "Copyright 2002 Ove Kaaven\n";
98 int debuglevel = DEBUGLEVEL_NONE;
99 int parser_debug, yy_flex_debug;
101 int pedantic = 0;
102 int do_everything = 1;
103 static int preprocess_only = 0;
104 int do_header = 0;
105 int do_typelib = 0;
106 int do_proxies = 0;
107 int do_client = 0;
108 int do_server = 0;
109 int do_idfile = 0;
110 int do_dlldata = 0;
111 static int no_preprocess = 0;
112 int old_names = 0;
113 int do_win32 = 1;
114 int do_win64 = 1;
115 int win32_packing = 8;
116 int win64_packing = 8;
118 char *input_name;
119 char *header_name;
120 char *local_stubs_name;
121 char *header_token;
122 char *typelib_name;
123 char *dlldata_name;
124 char *proxy_name;
125 char *proxy_token;
126 char *client_name;
127 char *client_token;
128 char *server_name;
129 char *server_token;
130 static char *idfile_name;
131 static char *idfile_token;
132 char *temp_name;
133 const char *prefix_client = "";
134 const char *prefix_server = "";
136 int line_number = 1;
138 static FILE *idfile;
140 size_t pointer_size = 0;
141 syskind_t typelib_kind = sizeof(void*) == 8 ? SYS_WIN64 : SYS_WIN32;
143 time_t now;
145 enum {
146 OLDNAMES_OPTION = CHAR_MAX + 1,
147 DLLDATA_OPTION,
148 DLLDATA_ONLY_OPTION,
149 LOCAL_STUBS_OPTION,
150 PREFIX_ALL_OPTION,
151 PREFIX_CLIENT_OPTION,
152 PREFIX_SERVER_OPTION,
153 WIN32_OPTION,
154 WIN64_OPTION,
155 WIN32_ALIGN_OPTION,
156 WIN64_ALIGN_OPTION
159 static const char short_options[] =
160 "b:cC:d:D:EhH:I:m:NpP:sS:tT:uU:VW";
161 static const struct option long_options[] = {
162 { "dlldata", 1, NULL, DLLDATA_OPTION },
163 { "dlldata-only", 0, NULL, DLLDATA_ONLY_OPTION },
164 { "local-stubs", 1, NULL, LOCAL_STUBS_OPTION },
165 { "oldnames", 0, NULL, OLDNAMES_OPTION },
166 { "prefix-all", 1, NULL, PREFIX_ALL_OPTION },
167 { "prefix-client", 1, NULL, PREFIX_CLIENT_OPTION },
168 { "prefix-server", 1, NULL, PREFIX_SERVER_OPTION },
169 { "win32", 0, NULL, WIN32_OPTION },
170 { "win64", 0, NULL, WIN64_OPTION },
171 { "win32-align", 1, NULL, WIN32_ALIGN_OPTION },
172 { "win64-align", 1, NULL, WIN64_ALIGN_OPTION },
173 { NULL, 0, NULL, 0 }
176 static void rm_tempfile(void);
178 static char *make_token(const char *name)
180 char *token;
181 char *slash;
182 int i;
184 slash = strrchr(name, '/');
185 if(!slash)
186 slash = strrchr(name, '\\');
188 if (slash) name = slash + 1;
190 token = xstrdup(name);
191 for (i=0; token[i]; i++) {
192 if (!isalnum(token[i])) token[i] = '_';
193 else token[i] = toupper(token[i]);
195 return token;
198 /* duplicate a basename into a valid C token */
199 static char *dup_basename_token(const char *name, const char *ext)
201 char *p, *ret = dup_basename( name, ext );
202 /* map invalid characters to '_' */
203 for (p = ret; *p; p++) if (!isalnum(*p)) *p = '_';
204 return ret;
207 static void add_widl_version_define(void)
209 unsigned int version;
210 const char *p = PACKAGE_VERSION;
212 /* major */
213 version = atoi(p) * 0x10000;
214 p = strchr(p, '.');
216 /* minor */
217 if (p)
219 version += atoi(p + 1) * 0x100;
220 p = strchr(p + 1, '.');
223 /* build */
224 if (p)
225 version += atoi(p + 1);
227 if (version != 0)
229 char version_str[11];
230 snprintf(version_str, sizeof(version_str), "0x%x", version);
231 wpp_add_define("__WIDL__", version_str);
233 else
234 wpp_add_define("__WIDL__", NULL);
237 /* set the target platform */
238 static void set_target( const char *target )
240 static const struct
242 const char *name;
243 syskind_t kind;
244 } cpu_names[] =
246 { "i386", SYS_WIN32 },
247 { "i486", SYS_WIN32 },
248 { "i586", SYS_WIN32 },
249 { "i686", SYS_WIN32 },
250 { "i786", SYS_WIN32 },
251 { "amd64", SYS_WIN64 },
252 { "x86_64", SYS_WIN64 },
253 { "sparc", SYS_WIN32 },
254 { "alpha", SYS_WIN32 },
255 { "powerpc", SYS_WIN32 },
256 { "arm", SYS_WIN32 }
259 unsigned int i;
260 char *p, *spec = xstrdup( target );
262 /* target specification is in the form CPU-MANUFACTURER-OS or CPU-MANUFACTURER-KERNEL-OS */
264 if (!(p = strchr( spec, '-' ))) error( "Invalid target specification '%s'\n", target );
265 *p++ = 0;
266 for (i = 0; i < sizeof(cpu_names)/sizeof(cpu_names[0]); i++)
268 if (!strcmp( cpu_names[i].name, spec ))
270 typelib_kind = cpu_names[i].kind;
271 free( spec );
272 return;
275 error( "Unrecognized CPU '%s'\n", spec );
278 /* clean things up when aborting on a signal */
279 static void exit_on_signal( int sig )
281 exit(1); /* this will call the atexit functions */
284 static void set_everything(int x)
286 do_header = x;
287 do_typelib = x;
288 do_proxies = x;
289 do_client = x;
290 do_server = x;
291 do_idfile = x;
292 do_dlldata = x;
295 void start_cplusplus_guard(FILE *fp)
297 fprintf(fp, "#ifdef __cplusplus\n");
298 fprintf(fp, "extern \"C\" {\n");
299 fprintf(fp, "#endif\n\n");
302 void end_cplusplus_guard(FILE *fp)
304 fprintf(fp, "#ifdef __cplusplus\n");
305 fprintf(fp, "}\n");
306 fprintf(fp, "#endif\n\n");
309 typedef struct
311 char *filename;
312 struct list link;
313 } filename_node_t;
315 static void add_filename_node(struct list *list, const char *name)
317 filename_node_t *node = xmalloc(sizeof *node);
318 node->filename = dup_basename( name, ".idl" );
319 list_add_tail(list, &node->link);
322 static void free_filename_nodes(struct list *list)
324 filename_node_t *node, *next;
325 LIST_FOR_EACH_ENTRY_SAFE(node, next, list, filename_node_t, link) {
326 list_remove(&node->link);
327 free(node->filename);
328 free(node);
332 static void write_dlldata_list(struct list *filenames)
334 FILE *dlldata;
335 filename_node_t *node;
337 dlldata = fopen(dlldata_name, "w");
338 if (!dlldata)
339 error("couldn't open %s: %s\n", dlldata_name, strerror(errno));
341 fprintf(dlldata, "/*** Autogenerated by WIDL %s ", PACKAGE_VERSION);
342 fprintf(dlldata, "- Do not edit ***/\n\n");
343 fprintf(dlldata, "#include <objbase.h>\n");
344 fprintf(dlldata, "#include <rpcproxy.h>\n\n");
345 start_cplusplus_guard(dlldata);
347 LIST_FOR_EACH_ENTRY(node, filenames, filename_node_t, link)
348 fprintf(dlldata, "EXTERN_PROXY_FILE(%s)\n", node->filename);
350 fprintf(dlldata, "\nPROXYFILE_LIST_START\n");
351 fprintf(dlldata, "/* Start of list */\n");
352 LIST_FOR_EACH_ENTRY(node, filenames, filename_node_t, link)
353 fprintf(dlldata, " REFERENCE_PROXY_FILE(%s),\n", node->filename);
354 fprintf(dlldata, "/* End of list */\n");
355 fprintf(dlldata, "PROXYFILE_LIST_END\n\n");
357 fprintf(dlldata, "DLLDATA_ROUTINES(aProxyFileList, GET_DLL_CLSID)\n\n");
358 end_cplusplus_guard(dlldata);
359 fclose(dlldata);
362 static char *eat_space(char *s)
364 while (isspace((unsigned char) *s))
365 ++s;
366 return s;
369 void write_dlldata(const statement_list_t *stmts)
371 struct list filenames = LIST_INIT(filenames);
372 filename_node_t *node;
373 FILE *dlldata;
375 if (!do_dlldata || !need_proxy_file(stmts))
376 return;
378 dlldata = fopen(dlldata_name, "r");
379 if (dlldata) {
380 static char marker[] = "REFERENCE_PROXY_FILE";
381 char *line = NULL;
382 size_t len = 0;
384 while (widl_getline(&line, &len, dlldata)) {
385 char *start, *end;
386 start = eat_space(line);
387 if (strncmp(start, marker, sizeof marker - 1) == 0) {
388 start = eat_space(start + sizeof marker - 1);
389 if (*start != '(')
390 continue;
391 end = start = eat_space(start + 1);
392 while (*end && *end != ')')
393 ++end;
394 if (*end != ')')
395 continue;
396 while (isspace((unsigned char) end[-1]))
397 --end;
398 *end = '\0';
399 if (start < end)
400 add_filename_node(&filenames, start);
404 if (ferror(dlldata))
405 error("couldn't read from %s: %s\n", dlldata_name, strerror(errno));
407 free(line);
408 fclose(dlldata);
411 LIST_FOR_EACH_ENTRY(node, &filenames, filename_node_t, link)
412 if (strcmp(proxy_token, node->filename) == 0) {
413 /* We're already in the list, no need to regenerate this file. */
414 free_filename_nodes(&filenames);
415 return;
418 add_filename_node(&filenames, proxy_token);
419 write_dlldata_list(&filenames);
420 free_filename_nodes(&filenames);
423 static void write_id_data_stmts(const statement_list_t *stmts)
425 const statement_t *stmt;
426 if (stmts) LIST_FOR_EACH_ENTRY( stmt, stmts, const statement_t, entry )
428 if (stmt->type == STMT_TYPE)
430 const type_t *type = stmt->u.type;
431 if (type_get_type(type) == TYPE_INTERFACE)
433 const UUID *uuid;
434 if (!is_object(type) && !is_attr(type->attrs, ATTR_DISPINTERFACE))
435 continue;
436 uuid = get_attrp(type->attrs, ATTR_UUID);
437 write_guid(idfile, is_attr(type->attrs, ATTR_DISPINTERFACE) ? "DIID" : "IID",
438 type->name, uuid);
440 else if (type_get_type(type) == TYPE_COCLASS)
442 const UUID *uuid = get_attrp(type->attrs, ATTR_UUID);
443 write_guid(idfile, "CLSID", type->name, uuid);
446 else if (stmt->type == STMT_LIBRARY)
448 const UUID *uuid = get_attrp(stmt->u.lib->attrs, ATTR_UUID);
449 write_guid(idfile, "LIBID", stmt->u.lib->name, uuid);
450 write_id_data_stmts(stmt->u.lib->stmts);
455 void write_id_data(const statement_list_t *stmts)
457 if (!do_idfile) return;
459 idfile_token = make_token(idfile_name);
461 idfile = fopen(idfile_name, "w");
462 if (! idfile) {
463 error("Could not open %s for output\n", idfile_name);
464 return;
467 fprintf(idfile, "/*** Autogenerated by WIDL %s ", PACKAGE_VERSION);
468 fprintf(idfile, "from %s - Do not edit ***/\n\n", input_name);
469 fprintf(idfile, "#include <rpc.h>\n");
470 fprintf(idfile, "#include <rpcndr.h>\n\n");
471 fprintf(idfile, "#include <initguid.h>\n\n");
472 start_cplusplus_guard(idfile);
474 write_id_data_stmts(stmts);
476 fprintf(idfile, "\n");
477 end_cplusplus_guard(idfile);
479 fclose(idfile);
482 int main(int argc,char *argv[])
484 extern char* optarg;
485 extern int optind;
486 int optc;
487 int ret = 0;
488 int opti = 0;
490 signal( SIGTERM, exit_on_signal );
491 signal( SIGINT, exit_on_signal );
492 #ifdef SIGHUP
493 signal( SIGHUP, exit_on_signal );
494 #endif
496 now = time(NULL);
498 while((optc = getopt_long(argc, argv, short_options, long_options, &opti)) != EOF) {
499 switch(optc) {
500 case DLLDATA_OPTION:
501 dlldata_name = xstrdup(optarg);
502 break;
503 case DLLDATA_ONLY_OPTION:
504 do_everything = 0;
505 do_dlldata = 1;
506 break;
507 case LOCAL_STUBS_OPTION:
508 do_everything = 0;
509 local_stubs_name = xstrdup(optarg);
510 break;
511 case OLDNAMES_OPTION:
512 old_names = 1;
513 break;
514 case PREFIX_ALL_OPTION:
515 prefix_client = xstrdup(optarg);
516 prefix_server = xstrdup(optarg);
517 break;
518 case PREFIX_CLIENT_OPTION:
519 prefix_client = xstrdup(optarg);
520 break;
521 case PREFIX_SERVER_OPTION:
522 prefix_server = xstrdup(optarg);
523 break;
524 case WIN32_OPTION:
525 do_win32 = 1;
526 do_win64 = 0;
527 break;
528 case WIN64_OPTION:
529 do_win32 = 0;
530 do_win64 = 1;
531 break;
532 case WIN32_ALIGN_OPTION:
533 win32_packing = strtol(optarg, NULL, 0);
534 if(win32_packing != 2 && win32_packing != 4 && win32_packing != 8)
535 error("Packing must be one of 2, 4 or 8\n");
536 break;
537 case WIN64_ALIGN_OPTION:
538 win64_packing = strtol(optarg, NULL, 0);
539 if(win64_packing != 2 && win64_packing != 4 && win64_packing != 8)
540 error("Packing must be one of 2, 4 or 8\n");
541 break;
542 case 'b':
543 set_target( optarg );
544 break;
545 case 'c':
546 do_everything = 0;
547 do_client = 1;
548 break;
549 case 'C':
550 client_name = xstrdup(optarg);
551 break;
552 case 'd':
553 debuglevel = strtol(optarg, NULL, 0);
554 break;
555 case 'D':
556 wpp_add_cmdline_define(optarg);
557 break;
558 case 'E':
559 do_everything = 0;
560 preprocess_only = 1;
561 break;
562 case 'h':
563 do_everything = 0;
564 do_header = 1;
565 break;
566 case 'H':
567 header_name = xstrdup(optarg);
568 break;
569 case 'I':
570 wpp_add_include_path(optarg);
571 break;
572 case 'm':
573 if (!strcmp( optarg, "32" )) typelib_kind = SYS_WIN32;
574 else if (!strcmp( optarg, "64" )) typelib_kind = SYS_WIN64;
575 else error( "Invalid -m argument '%s'\n", optarg );
576 break;
577 case 'N':
578 no_preprocess = 1;
579 break;
580 case 'p':
581 do_everything = 0;
582 do_proxies = 1;
583 break;
584 case 'P':
585 proxy_name = xstrdup(optarg);
586 break;
587 case 's':
588 do_everything = 0;
589 do_server = 1;
590 break;
591 case 'S':
592 server_name = xstrdup(optarg);
593 break;
594 case 't':
595 do_everything = 0;
596 do_typelib = 1;
597 break;
598 case 'T':
599 typelib_name = xstrdup(optarg);
600 break;
601 case 'u':
602 do_everything = 0;
603 do_idfile = 1;
604 break;
605 case 'U':
606 idfile_name = xstrdup(optarg);
607 break;
608 case 'V':
609 printf("%s", version_string);
610 return 0;
611 case 'W':
612 pedantic = 1;
613 break;
614 default:
615 fprintf(stderr, "%s", usage);
616 return 1;
620 if(do_everything) {
621 set_everything(TRUE);
624 if (!dlldata_name && do_dlldata)
625 dlldata_name = xstrdup("dlldata.c");
627 if(optind < argc) {
628 if (do_dlldata && !do_everything) {
629 struct list filenames = LIST_INIT(filenames);
630 for ( ; optind < argc; ++optind)
631 add_filename_node(&filenames, argv[optind]);
633 write_dlldata_list(&filenames);
634 free_filename_nodes(&filenames);
635 return 0;
637 else if (optind != argc - 1) {
638 fprintf(stderr, "%s", usage);
639 return 1;
641 else
642 input_name = xstrdup(argv[optind]);
644 else {
645 fprintf(stderr, "%s", usage);
646 return 1;
649 if(debuglevel)
651 setbuf(stdout, NULL);
652 setbuf(stderr, NULL);
655 parser_debug = debuglevel & DEBUGLEVEL_TRACE ? 1 : 0;
656 yy_flex_debug = debuglevel & DEBUGLEVEL_TRACE ? 1 : 0;
658 wpp_set_debug( (debuglevel & DEBUGLEVEL_PPLEX) != 0,
659 (debuglevel & DEBUGLEVEL_PPTRACE) != 0,
660 (debuglevel & DEBUGLEVEL_PPMSG) != 0 );
662 if (!header_name) {
663 header_name = dup_basename(input_name, ".idl");
664 strcat(header_name, ".h");
667 if (!typelib_name && do_typelib) {
668 typelib_name = dup_basename(input_name, ".idl");
669 strcat(typelib_name, ".tlb");
672 if (!proxy_name && do_proxies) {
673 proxy_name = dup_basename(input_name, ".idl");
674 strcat(proxy_name, "_p.c");
677 if (!client_name && do_client) {
678 client_name = dup_basename(input_name, ".idl");
679 strcat(client_name, "_c.c");
682 if (!server_name && do_server) {
683 server_name = dup_basename(input_name, ".idl");
684 strcat(server_name, "_s.c");
687 if (!idfile_name && do_idfile) {
688 idfile_name = dup_basename(input_name, ".idl");
689 strcat(idfile_name, "_i.c");
692 if (do_proxies) proxy_token = dup_basename_token(proxy_name,"_p.c");
693 if (do_client) client_token = dup_basename_token(client_name,"_c.c");
694 if (do_server) server_token = dup_basename_token(server_name,"_s.c");
696 add_widl_version_define();
698 atexit(rm_tempfile);
699 if (!no_preprocess)
701 chat("Starting preprocess\n");
703 if (!preprocess_only)
705 FILE *output;
706 int fd;
707 char *name = xmalloc( strlen(header_name) + 8 );
709 strcpy( name, header_name );
710 strcat( name, ".XXXXXX" );
712 if ((fd = mkstemps( name, 0 )) == -1)
713 error("Could not generate a temp name from %s\n", name);
715 temp_name = name;
716 if (!(output = fdopen(fd, "wt")))
717 error("Could not open fd %s for writing\n", name);
719 ret = wpp_parse( input_name, output );
720 fclose( output );
722 else
724 ret = wpp_parse( input_name, stdout );
727 if(ret) exit(1);
728 if(preprocess_only) exit(0);
729 if(!(parser_in = fopen(temp_name, "r"))) {
730 fprintf(stderr, "Could not open %s for input\n", temp_name);
731 return 1;
734 else {
735 if(!(parser_in = fopen(input_name, "r"))) {
736 fprintf(stderr, "Could not open %s for input\n", input_name);
737 return 1;
741 header_token = make_token(header_name);
743 init_types();
744 ret = parser_parse();
746 fclose(parser_in);
748 if(ret) {
749 exit(1);
752 /* Everything has been done successfully, don't delete any files. */
753 set_everything(FALSE);
754 local_stubs_name = NULL;
756 return 0;
759 static void rm_tempfile(void)
761 abort_import();
762 if(temp_name)
763 unlink(temp_name);
764 if (do_header)
765 unlink(header_name);
766 if (local_stubs_name)
767 unlink(local_stubs_name);
768 if (do_client)
769 unlink(client_name);
770 if (do_server)
771 unlink(server_name);
772 if (do_idfile)
773 unlink(idfile_name);
774 if (do_proxies)
775 unlink(proxy_name);
776 if (do_typelib)
777 unlink(typelib_name);