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 *idfile;
 136
 137 size_t pointer_size = 0;
 138
 139 time_t now;
 140
 141 enum {
 142     OLDNAMES_OPTION = CHAR_MAX + 1,
 143     DLLDATA_OPTION,
 144     DLLDATA_ONLY_OPTION,
 145     LOCAL_STUBS_OPTION,
 146     PREFIX_ALL_OPTION,
 147     PREFIX_CLIENT_OPTION,
 148     PREFIX_SERVER_OPTION,
 149     WIN32_OPTION,
 150     WIN64_OPTION
 151 };
 152
 153 static const char short_options[] =
 154     "cC:d:D:EhH:I:NpP:sS:tT:uU:VW";
 155 static const struct option long_options[] = {
 156     { "dlldata", 1, 0, DLLDATA_OPTION },
 157     { "dlldata-only", 0, 0, DLLDATA_ONLY_OPTION },
 158     { "local-stubs", 1, 0, LOCAL_STUBS_OPTION },
 159     { "oldnames", 0, 0, OLDNAMES_OPTION },
 160     { "prefix-all", 1, 0, PREFIX_ALL_OPTION },
 161     { "prefix-client", 1, 0, PREFIX_CLIENT_OPTION },
 162     { "prefix-server", 1, 0, PREFIX_SERVER_OPTION },
 163     { "win32", 0, 0, WIN32_OPTION },
 164     { "win64", 0, 0, WIN64_OPTION },
 165     { 0, 0, 0, 0 }
 166 };
 167
 168 static void rm_tempfile(void);
 169
 170 static char *make_token(const char *name)
 171 {
 172   char *token;
 173   char *slash;
 174   int i;
 175
 176   slash = strrchr(name, '/');
 177   if(!slash)
 178     slash = strrchr(name, '\\');
 179
 180   if (slash) name = slash + 1;
 181
 182   token = xstrdup(name);
 183   for (i=0; token[i]; i++) {
 184     if (!isalnum(token[i])) token[i] = '_';
 185     else token[i] = toupper(token[i]);
 186   }
 187   return token;
 188 }
 189
 190 /* duplicate a basename into a valid C token */
 191 static char *dup_basename_token(const char *name, const char *ext)
 192 {
 193     char *p, *ret = dup_basename( name, ext );
 194     /* map invalid characters to '_' */
 195     for (p = ret; *p; p++) if (!isalnum(*p)) *p = '_';
 196     return ret;
 197 }
 198
 199 static void add_widl_version_define(void)
 200 {
 201     unsigned int version;
 202     const char *p = PACKAGE_VERSION;
 203
 204     /* major */
 205     version = atoi(p) * 0x10000;
 206     p = strchr(p, '.');
 207
 208     /* minor */
 209     if (p)
 210     {
 211         version += atoi(p + 1) * 0x100;
 212         p = strchr(p + 1, '.');
 213     }
 214
 215     /* build */
 216     if (p)
 217         version += atoi(p + 1);
 218
 219     if (version != 0)
 220     {
 221         char version_str[11];
 222         snprintf(version_str, sizeof(version_str), "0x%x", version);
 223         wpp_add_define("__WIDL__", version_str);
 224     }
 225     else
 226         wpp_add_define("__WIDL__", NULL);
 227 }
 228
 229 /* clean things up when aborting on a signal */
 230 static void exit_on_signal( int sig )
 231 {
 232     exit(1);  /* this will call the atexit functions */
 233 }
 234
 235 static void set_everything(int x)
 236 {
 237   do_header = x;
 238   do_typelib = x;
 239   do_proxies = x;
 240   do_client = x;
 241   do_server = x;
 242   do_idfile = x;
 243   do_dlldata = x;
 244 }
 245
 246 void start_cplusplus_guard(FILE *fp)
 247 {
 248   fprintf(fp, "#ifdef __cplusplus\n");
 249   fprintf(fp, "extern \"C\" {\n");
 250   fprintf(fp, "#endif\n\n");
 251 }
 252
 253 void end_cplusplus_guard(FILE *fp)
 254 {
 255   fprintf(fp, "#ifdef __cplusplus\n");
 256   fprintf(fp, "}\n");
 257   fprintf(fp, "#endif\n\n");
 258 }
 259
 260 typedef struct
 261 {
 262   char *filename;
 263   struct list link;
 264 } filename_node_t;
 265
 266 static void add_filename_node(struct list *list, const char *name)
 267 {
 268   filename_node_t *node = xmalloc(sizeof *node);
 269   node->filename = dup_basename( name, ".idl" );
 270   list_add_tail(list, &node->link);
 271 }
 272
 273 static void free_filename_nodes(struct list *list)
 274 {
 275   filename_node_t *node, *next;
 276   LIST_FOR_EACH_ENTRY_SAFE(node, next, list, filename_node_t, link) {
 277     list_remove(&node->link);
 278     free(node->filename);
 279     free(node);
 280   }
 281 }
 282
 283 static void write_dlldata_list(struct list *filenames)
 284 {
 285   FILE *dlldata;
 286   filename_node_t *node;
 287
 288   dlldata = fopen(dlldata_name, "w");
 289   if (!dlldata)
 290     error("couldn't open %s: %s\n", dlldata_name, strerror(errno));
 291
 292   fprintf(dlldata, "/*** Autogenerated by WIDL %s ", PACKAGE_VERSION);
 293   fprintf(dlldata, "- Do not edit ***/\n\n");
 294   fprintf(dlldata, "#include <objbase.h>\n");
 295   fprintf(dlldata, "#include <rpcproxy.h>\n\n");
 296   start_cplusplus_guard(dlldata);
 297
 298   LIST_FOR_EACH_ENTRY(node, filenames, filename_node_t, link)
 299     fprintf(dlldata, "EXTERN_PROXY_FILE(%s)\n", node->filename);
 300
 301   fprintf(dlldata, "\nPROXYFILE_LIST_START\n");
 302   fprintf(dlldata, "/* Start of list */\n");
 303   LIST_FOR_EACH_ENTRY(node, filenames, filename_node_t, link)
 304     fprintf(dlldata, "  REFERENCE_PROXY_FILE(%s),\n", node->filename);
 305   fprintf(dlldata, "/* End of list */\n");
 306   fprintf(dlldata, "PROXYFILE_LIST_END\n\n");
 307
 308   fprintf(dlldata, "DLLDATA_ROUTINES(aProxyFileList, GET_DLL_CLSID)\n\n");
 309   end_cplusplus_guard(dlldata);
 310   fclose(dlldata);
 311 }
 312
 313 static char *eat_space(char *s)
 314 {
 315   while (isspace((unsigned char) *s))
 316     ++s;
 317   return s;
 318 }
 319
 320 void write_dlldata(const statement_list_t *stmts)
 321 {
 322   struct list filenames = LIST_INIT(filenames);
 323   filename_node_t *node;
 324   FILE *dlldata;
 325
 326   if (!do_dlldata || !need_proxy_file(stmts))
 327     return;
 328
 329   dlldata = fopen(dlldata_name, "r");
 330   if (dlldata) {
 331     static char marker[] = "REFERENCE_PROXY_FILE";
 332     char *line = NULL;
 333     size_t len = 0;
 334
 335     while (widl_getline(&line, &len, dlldata)) {
 336       char *start, *end;
 337       start = eat_space(line);
 338       if (strncmp(start, marker, sizeof marker - 1) == 0) {
 339         start = eat_space(start + sizeof marker - 1);
 340         if (*start != '(')
 341           continue;
 342         end = start = eat_space(start + 1);
 343         while (*end && *end != ')')
 344           ++end;
 345         if (*end != ')')
 346           continue;
 347         while (isspace((unsigned char) end[-1]))
 348           --end;
 349         *end = '\0';
 350         if (start < end)
 351           add_filename_node(&filenames, start);
 352       }
 353     }
 354
 355     if (ferror(dlldata))
 356       error("couldn't read from %s: %s\n", dlldata_name, strerror(errno));
 357
 358     free(line);
 359     fclose(dlldata);
 360   }
 361
 362   LIST_FOR_EACH_ENTRY(node, &filenames, filename_node_t, link)
 363     if (strcmp(proxy_token, node->filename) == 0) {
 364       /* We're already in the list, no need to regenerate this file.  */
 365       free_filename_nodes(&filenames);
 366       return;
 367     }
 368
 369   add_filename_node(&filenames, proxy_token);
 370   write_dlldata_list(&filenames);
 371   free_filename_nodes(&filenames);
 372 }
 373
 374 static void write_id_data_stmts(const statement_list_t *stmts)
 375 {
 376   const statement_t *stmt;
 377   if (stmts) LIST_FOR_EACH_ENTRY( stmt, stmts, const statement_t, entry )
 378   {
 379     if (stmt->type == STMT_TYPE)
 380     {
 381       const type_t *type = stmt->u.type;
 382       if (type_get_type(type) == TYPE_INTERFACE)
 383       {
 384         const UUID *uuid;
 385         if (!is_object(type->attrs) && !is_attr(type->attrs, ATTR_DISPINTERFACE))
 386           continue;
 387         uuid = get_attrp(type->attrs, ATTR_UUID);
 388         write_guid(idfile, is_attr(type->attrs, ATTR_DISPINTERFACE) ? "DIID" : "IID",
 389                    type->name, uuid);
 390       }
 391       else if (type_get_type(type) == TYPE_COCLASS)
 392       {
 393         const UUID *uuid = get_attrp(type->attrs, ATTR_UUID);
 394         write_guid(idfile, "CLSID", type->name, uuid);
 395       }
 396     }
 397     else if (stmt->type == STMT_LIBRARY)
 398     {
 399       const UUID *uuid = get_attrp(stmt->u.lib->attrs, ATTR_UUID);
 400       write_guid(idfile, "LIBID", stmt->u.lib->name, uuid);
 401       write_id_data_stmts(stmt->u.lib->stmts);
 402     }
 403   }
 404 }
 405
 406 void write_id_data(const statement_list_t *stmts)
 407 {
 408   if (!do_idfile) return;
 409
 410   idfile_token = make_token(idfile_name);
 411
 412   idfile = fopen(idfile_name, "w");
 413   if (! idfile) {
 414     error("Could not open %s for output\n", idfile_name);
 415     return;
 416   }
 417
 418   fprintf(idfile, "/*** Autogenerated by WIDL %s ", PACKAGE_VERSION);
 419   fprintf(idfile, "from %s - Do not edit ***/\n\n", input_name);
 420   fprintf(idfile, "#include <rpc.h>\n");
 421   fprintf(idfile, "#include <rpcndr.h>\n\n");
 422   fprintf(idfile, "#include <initguid.h>\n\n");
 423   start_cplusplus_guard(idfile);
 424
 425   write_id_data_stmts(stmts);
 426
 427   fprintf(idfile, "\n");
 428   end_cplusplus_guard(idfile);
 429
 430   fclose(idfile);
 431 }
 432
 433 int main(int argc,char *argv[])
 434 {
 435   extern char* optarg;
 436   extern int   optind;
 437   int optc;
 438   int ret = 0;
 439   int opti = 0;
 440
 441   signal( SIGTERM, exit_on_signal );
 442   signal( SIGINT, exit_on_signal );
 443 #ifdef SIGHUP
 444   signal( SIGHUP, exit_on_signal );
 445 #endif
 446
 447   now = time(NULL);
 448
 449   while((optc = getopt_long(argc, argv, short_options, long_options, &opti)) != EOF) {
 450     switch(optc) {
 451     case DLLDATA_OPTION:
 452       dlldata_name = xstrdup(optarg);
 453       break;
 454     case DLLDATA_ONLY_OPTION:
 455       do_everything = 0;
 456       do_dlldata = 1;
 457       break;
 458     case LOCAL_STUBS_OPTION:
 459       do_everything = 0;
 460       local_stubs_name = xstrdup(optarg);
 461       break;
 462     case OLDNAMES_OPTION:
 463       old_names = 1;
 464       break;
 465     case PREFIX_ALL_OPTION:
 466       prefix_client = xstrdup(optarg);
 467       prefix_server = xstrdup(optarg);
 468       break;
 469     case PREFIX_CLIENT_OPTION:
 470       prefix_client = xstrdup(optarg);
 471       break;
 472     case PREFIX_SERVER_OPTION:
 473       prefix_server = xstrdup(optarg);
 474       break;
 475     case WIN32_OPTION:
 476       do_win32 = 1;
 477       do_win64 = 0;
 478       break;
 479     case WIN64_OPTION:
 480       do_win32 = 0;
 481       do_win64 = 1;
 482       break;
 483     case 'c':
 484       do_everything = 0;
 485       do_client = 1;
 486       break;
 487     case 'C':
 488       client_name = xstrdup(optarg);
 489       break;
 490     case 'd':
 491       debuglevel = strtol(optarg, NULL, 0);
 492       break;
 493     case 'D':
 494       wpp_add_cmdline_define(optarg);
 495       break;
 496     case 'E':
 497       do_everything = 0;
 498       preprocess_only = 1;
 499       break;
 500     case 'h':
 501       do_everything = 0;
 502       do_header = 1;
 503       break;
 504     case 'H':
 505       header_name = xstrdup(optarg);
 506       break;
 507     case 'I':
 508       wpp_add_include_path(optarg);
 509       break;
 510     case 'N':
 511       no_preprocess = 1;
 512       break;
 513     case 'p':
 514       do_everything = 0;
 515       do_proxies = 1;
 516       break;
 517     case 'P':
 518       proxy_name = xstrdup(optarg);
 519       break;
 520     case 's':
 521       do_everything = 0;
 522       do_server = 1;
 523       break;
 524     case 'S':
 525       server_name = xstrdup(optarg);
 526       break;
 527     case 't':
 528       do_everything = 0;
 529       do_typelib = 1;
 530       break;
 531     case 'T':
 532       typelib_name = xstrdup(optarg);
 533       break;
 534     case 'u':
 535       do_everything = 0;
 536       do_idfile = 1;
 537       break;
 538     case 'U':
 539       idfile_name = xstrdup(optarg);
 540       break;
 541     case 'V':
 542       printf("%s", version_string);
 543       return 0;
 544     case 'W':
 545       pedantic = 1;
 546       break;
 547     default:
 548       fprintf(stderr, "%s", usage);
 549       return 1;
 550     }
 551   }
 552
 553   if(do_everything) {
 554     set_everything(TRUE);
 555   }
 556
 557   if (!dlldata_name && do_dlldata)
 558     dlldata_name = xstrdup("dlldata.c");
 559
 560   if(optind < argc) {
 561     if (do_dlldata && !do_everything) {
 562       struct list filenames = LIST_INIT(filenames);
 563       for ( ; optind < argc; ++optind)
 564         add_filename_node(&filenames, argv[optind]);
 565
 566       write_dlldata_list(&filenames);
 567       free_filename_nodes(&filenames);
 568       return 0;
 569     }
 570     else if (optind != argc - 1) {
 571       fprintf(stderr, "%s", usage);
 572       return 1;
 573     }
 574     else
 575       input_name = xstrdup(argv[optind]);
 576   }
 577   else {
 578     fprintf(stderr, "%s", usage);
 579     return 1;
 580   }
 581
 582   if(debuglevel)
 583   {
 584     setbuf(stdout,0);
 585     setbuf(stderr,0);
 586   }
 587
 588   parser_debug = debuglevel & DEBUGLEVEL_TRACE ? 1 : 0;
 589   yy_flex_debug = debuglevel & DEBUGLEVEL_TRACE ? 1 : 0;
 590
 591   wpp_set_debug( (debuglevel & DEBUGLEVEL_PPLEX) != 0,
 592                  (debuglevel & DEBUGLEVEL_PPTRACE) != 0,
 593                  (debuglevel & DEBUGLEVEL_PPMSG) != 0 );
 594
 595   if (!header_name) {
 596     header_name = dup_basename(input_name, ".idl");
 597     strcat(header_name, ".h");
 598   }
 599
 600   if (!typelib_name && do_typelib) {
 601     typelib_name = dup_basename(input_name, ".idl");
 602     strcat(typelib_name, ".tlb");
 603   }
 604
 605   if (!proxy_name && do_proxies) {
 606     proxy_name = dup_basename(input_name, ".idl");
 607     strcat(proxy_name, "_p.c");
 608   }
 609
 610   if (!client_name && do_client) {
 611     client_name = dup_basename(input_name, ".idl");
 612     strcat(client_name, "_c.c");
 613   }
 614
 615   if (!server_name && do_server) {
 616     server_name = dup_basename(input_name, ".idl");
 617     strcat(server_name, "_s.c");
 618   }
 619
 620   if (!idfile_name && do_idfile) {
 621     idfile_name = dup_basename(input_name, ".idl");
 622     strcat(idfile_name, "_i.c");
 623   }
 624
 625   if (do_proxies) proxy_token = dup_basename_token(proxy_name,"_p.c");
 626   if (do_client) client_token = dup_basename_token(client_name,"_c.c");
 627   if (do_server) server_token = dup_basename_token(server_name,"_s.c");
 628
 629   add_widl_version_define();
 630
 631   atexit(rm_tempfile);
 632   if (!no_preprocess)
 633   {
 634     chat("Starting preprocess\n");
 635
 636     if (!preprocess_only)
 637     {
 638         ret = wpp_parse_temp( input_name, header_name, &temp_name );
 639     }
 640     else
 641     {
 642         ret = wpp_parse( input_name, stdout );
 643     }
 644
 645     if(ret) exit(1);
 646     if(preprocess_only) exit(0);
 647     if(!(parser_in = fopen(temp_name, "r"))) {
 648       fprintf(stderr, "Could not open %s for input\n", temp_name);
 649       return 1;
 650     }
 651   }
 652   else {
 653     if(!(parser_in = fopen(input_name, "r"))) {
 654       fprintf(stderr, "Could not open %s for input\n", input_name);
 655       return 1;
 656     }
 657   }
 658
 659   header_token = make_token(header_name);
 660
 661   init_types();
 662   ret = parser_parse();
 663
 664   fclose(parser_in);
 665
 666   if(ret) {
 667     exit(1);
 668   }
 669
 670   /* Everything has been done successfully, don't delete any files.  */
 671   set_everything(FALSE);
 672   local_stubs_name = NULL;
 673
 674   return 0;
 675 }
 676
 677 static void rm_tempfile(void)
 678 {
 679   abort_import();
 680   if(temp_name)
 681     unlink(temp_name);
 682   if (do_header)
 683     unlink(header_name);
 684   if (local_stubs_name)
 685     unlink(local_stubs_name);
 686   if (do_client)
 687     unlink(client_name);
 688   if (do_server)
 689     unlink(server_name);
 690   if (do_idfile)
 691     unlink(idfile_name);
 692   if (do_proxies)
 693     unlink(proxy_name);
 694   if (do_typelib)
 695     unlink(typelib_name);
 696 }