tools/wrc/wrc.c

   1 /*
   2  * Copyright 1994 Martin von Loewis
   3  * Copyright 1998 Bertho A. Stultiens (BS)
   4  * Copyright 2003 Dimitrie O. Paun
   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  *
  20  */
  21
  22 #include "config.h"
  23 #include "wine/port.h"
  24
  25 #include <stdio.h>
  26 #include <stdlib.h>
  27 #ifdef HAVE_UNISTD_H
  28 # include <unistd.h>
  29 #endif
  30 #include <string.h>
  31 #include <assert.h>
  32 #include <ctype.h>
  33 #include <signal.h>
  34 #ifdef HAVE_GETOPT_H
  35 # include <getopt.h>
  36 #endif
  37
  38 #include "wrc.h"
  39 #include "utils.h"
  40 #include "readres.h"
  41 #include "dumpres.h"
  42 #include "genres.h"
  43 #include "newstruc.h"
  44 #include "parser.h"
  45 #include "wine/wpp.h"
  46
  47 #ifdef WORDS_BIGENDIAN
  48 #define ENDIAN  "big"
  49 #else
  50 #define ENDIAN  "little"
  51 #endif
  52
  53 static const char usage[] =
  54         "Usage: wrc [options...] [infile[.rc|.res]]\n"
  55         "   -b, --target=TARGET        Specify target CPU and platform when cross-compiling\n"
  56         "   -D, --define id[=val]      Define preprocessor identifier id=val\n"
  57         "   --debug=nn                 Set debug level to 'nn'\n"
  58         "   -E                         Preprocess only\n"
  59         "   --endianness=e             Set output byte-order e={n[ative], l[ittle], b[ig]}\n"
  60         "                              (win32 only; default is " ENDIAN "-endian)\n"
  61         "   -F TARGET                  Synonym for -b for compatibility with windres\n"
  62         "   -fo FILE                   Synonym for -o for compatibility with windres\n"
  63         "   -h, --help                 Prints this summary\n"
  64         "   -i, --input=FILE           The name of the input file\n"
  65         "   -I, --include-dir=PATH     Set include search dir to path (multiple -I allowed)\n"
  66         "   -J, --input-format=FORMAT  The input format (either `rc' or `rc16')\n"
  67         "   -l, --language=LANG        Set default language to LANG (default is neutral {0, 0})\n"
  68         "   -m16, -m32, -m64           Build for 16-bit, 32-bit resp. 64-bit platforms\n"
  69         "   --no-use-temp-file         Ignored for compatibility with windres\n"
  70         "   --nostdinc                 Disables searching the standard include path\n"
  71         "   -o, --output=FILE          Output to file (default is infile.res)\n"
  72         "   -O, --output-format=FORMAT The output format (`po', `pot', `res', or `res16`)\n"
  73         "   --pedantic                 Enable pedantic warnings\n"
  74         "   --po-dir=DIR               Directory containing po files for translations\n"
  75         "   --preprocessor             Specifies the preprocessor to use, including arguments\n"
  76         "   -r                         Ignored for compatibility with rc\n"
  77         "   -U, --undefine id          Undefine preprocessor identifier id\n"
  78         "   --use-temp-file            Ignored for compatibility with windres\n"
  79         "   -v, --verbose              Enable verbose mode\n"
  80         "   --verify-translations      Check the status of the various translations\n"
  81         "   --version                  Print version and exit\n"
  82         "Input is taken from stdin if no sourcefile specified.\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         "If no input filename is given and the output name is not overridden\n"
  91         "with -o, then the output is written to \"wrc.tab.res\"\n"
  92         ;
  93
  94 static const char version_string[] = "Wine Resource Compiler version " PACKAGE_VERSION "\n"
  95                         "Copyright 1998-2000 Bertho A. Stultiens\n"
  96                         "          1994 Martin von Loewis\n";
  97
  98 /*
  99  * Set if compiling in 32bit mode (default).
 100  */
 101 int win32 = 1;
 102
 103 /*
 104  * debuglevel == DEBUGLEVEL_NONE        Don't bother
 105  * debuglevel & DEBUGLEVEL_CHAT         Say what's done
 106  * debuglevel & DEBUGLEVEL_DUMP         Dump internal structures
 107  * debuglevel & DEBUGLEVEL_TRACE        Create parser trace
 108  * debuglevel & DEBUGLEVEL_PPMSG        Preprocessor messages
 109  * debuglevel & DEBUGLEVEL_PPLEX        Preprocessor lex trace
 110  * debuglevel & DEBUGLEVEL_PPTRACE      Preprocessor yacc trace
 111  */
 112 int debuglevel = DEBUGLEVEL_NONE;
 113
 114 /*
 115  * Recognize win32 keywords if set (-w 32 enforces this),
 116  * otherwise set with -e option.
 117  */
 118 int extensions = 1;
 119
 120 /*
 121  * Language setting for resources (-l option)
 122  */
 123 static language_t *defaultlanguage;
 124 language_t *currentlanguage = NULL;
 125
 126 /*
 127  * Set when extra warnings should be generated (-W option)
 128  */
 129 int pedantic = 0;
 130
 131 /*
 132  * The output byte-order of resources (set with -B)
 133  */
 134 int byteorder = WRC_BO_NATIVE;
 135
 136 /*
 137  * Set when _only_ to run the preprocessor (-E option)
 138  */
 139 int preprocess_only = 0;
 140
 141 /*
 142  * Set when _not_ to run the preprocessor (-P cat option)
 143  */
 144 int no_preprocess = 0;
 145
 146 int check_utf8 = 1;  /* whether to check for valid utf8 */
 147
 148 static int pointer_size = sizeof(void *);
 149
 150 static int verify_translations_mode;
 151
 152 static char *output_name;       /* The name given by the -o option */
 153 char *input_name = NULL;        /* The name given on the command-line */
 154 static char *temp_name = NULL;  /* Temporary file for preprocess pipe */
 155
 156 int line_number = 1;            /* The current line */
 157 int char_number = 1;            /* The current char pos within the line */
 158
 159 char *cmdline;                  /* The entire commandline */
 160
 161 int parser_debug, yy_flex_debug;
 162
 163 resource_t *resource_top;       /* The top of the parsed resources */
 164
 165 int getopt (int argc, char *const *argv, const char *optstring);
 166 static void cleanup_files(void);
 167 static void segvhandler(int sig);
 168
 169 enum long_options_values
 170 {
 171     LONG_OPT_NOSTDINC = 1,
 172     LONG_OPT_TMPFILE,
 173     LONG_OPT_NOTMPFILE,
 174     LONG_OPT_PO_DIR,
 175     LONG_OPT_PREPROCESSOR,
 176     LONG_OPT_VERSION,
 177     LONG_OPT_DEBUG,
 178     LONG_OPT_ENDIANNESS,
 179     LONG_OPT_PEDANTIC,
 180     LONG_OPT_VERIFY_TRANSL
 181 };
 182
 183 static const char short_options[] =
 184         "b:D:Ef:F:hi:I:J:l:m:o:O:rU:v";
 185 static const struct option long_options[] = {
 186         { "debug", 1, NULL, LONG_OPT_DEBUG },
 187         { "define", 1, NULL, 'D' },
 188         { "endianness", 1, NULL, LONG_OPT_ENDIANNESS },
 189         { "help", 0, NULL, 'h' },
 190         { "include-dir", 1, NULL, 'I' },
 191         { "input", 1, NULL, 'i' },
 192         { "input-format", 1, NULL, 'J' },
 193         { "language", 1, NULL, 'l' },
 194         { "no-use-temp-file", 0, NULL, LONG_OPT_NOTMPFILE },
 195         { "nostdinc", 0, NULL, LONG_OPT_NOSTDINC },
 196         { "output", 1, NULL, 'o' },
 197         { "output-format", 1, NULL, 'O' },
 198         { "pedantic", 0, NULL, LONG_OPT_PEDANTIC },
 199         { "po-dir", 1, NULL, LONG_OPT_PO_DIR },
 200         { "preprocessor", 1, NULL, LONG_OPT_PREPROCESSOR },
 201         { "target", 1, NULL, 'F' },
 202         { "undefine", 1, NULL, 'U' },
 203         { "use-temp-file", 0, NULL, LONG_OPT_TMPFILE },
 204         { "verbose", 0, NULL, 'v' },
 205         { "verify-translations", 0, NULL, LONG_OPT_VERIFY_TRANSL },
 206         { "version", 0, NULL, LONG_OPT_VERSION },
 207         { NULL, 0, NULL, 0 }
 208 };
 209
 210 static void set_version_defines(void)
 211 {
 212     char *version = xstrdup( PACKAGE_VERSION );
 213     char *major, *minor, *patchlevel;
 214     char buffer[100];
 215
 216     if ((minor = strchr( version, '.' )))
 217     {
 218         major = version;
 219         *minor++ = 0;
 220         if ((patchlevel = strchr( minor, '.' ))) *patchlevel++ = 0;
 221     }
 222     else  /* pre 0.9 version */
 223     {
 224         major = NULL;
 225         patchlevel = version;
 226     }
 227     sprintf( buffer, "__WRC__=%s", major ? major : "0" );
 228     wpp_add_cmdline_define(buffer);
 229     sprintf( buffer, "__WRC_MINOR__=%s", minor ? minor : "0" );
 230     wpp_add_cmdline_define(buffer);
 231     sprintf( buffer, "__WRC_PATCHLEVEL__=%s", patchlevel ? patchlevel : "0" );
 232     wpp_add_cmdline_define(buffer);
 233     free( version );
 234 }
 235
 236 /* clean things up when aborting on a signal */
 237 static void exit_on_signal( int sig )
 238 {
 239     exit(1);  /* this will call the atexit functions */
 240 }
 241
 242 /* load a single input file */
 243 static int load_file( const char *input_name, const char *output_name )
 244 {
 245     int ret;
 246
 247     /* Run the preprocessor on the input */
 248     if(!no_preprocess)
 249     {
 250         FILE *output;
 251         int ret, fd;
 252         char *name;
 253
 254         /*
 255          * Preprocess the input to a temp-file, or stdout if
 256          * no output was given.
 257          */
 258
 259         if (preprocess_only)
 260         {
 261             if (output_name)
 262             {
 263                 if (!(output = fopen( output_name, "w" )))
 264                     fatal_perror( "Could not open %s for writing", output_name );
 265                 ret = wpp_parse( input_name, output );
 266                 fclose( output );
 267             }
 268             else ret = wpp_parse( input_name, stdout );
 269
 270             if (ret) return ret;
 271             output_name = NULL;
 272             exit(0);
 273         }
 274
 275         if (output_name && output_name[0]) name = strmake( "%s.XXXXXX", output_name );
 276         else name = xstrdup( "wrc.XXXXXX" );
 277
 278         if ((fd = mkstemps( name, 0 )) == -1)
 279             error("Could not generate a temp name from %s\n", name);
 280
 281         temp_name = name;
 282         if (!(output = fdopen(fd, "wt")))
 283             error("Could not open fd %s for writing\n", name);
 284
 285         ret = wpp_parse( input_name, output );
 286         fclose( output );
 287         if (ret) return ret;
 288         input_name = name;
 289     }
 290
 291     /* Reset the language */
 292     currentlanguage = dup_language( defaultlanguage );
 293     check_utf8 = 1;
 294
 295     /* Go from .rc to .res */
 296     chat("Starting parse\n");
 297
 298     if(!(parser_in = fopen(input_name, "rb")))
 299         fatal_perror("Could not open %s for input", input_name);
 300
 301     ret = parser_parse();
 302     fclose(parser_in);
 303     parser_lex_destroy();
 304     if (temp_name)
 305     {
 306         unlink( temp_name );
 307         temp_name = NULL;
 308     }
 309     free( currentlanguage );
 310     return ret;
 311 }
 312
 313 static void set_target( const char *target )
 314 {
 315     char *p, *cpu = xstrdup( target );
 316
 317     /* target specification is in the form CPU-MANUFACTURER-OS or CPU-MANUFACTURER-KERNEL-OS */
 318     if (!(p = strchr( cpu, '-' ))) error( "Invalid target specification '%s'\n", target );
 319     *p = 0;
 320     if (!strcmp( cpu, "amd64" ) || !strcmp( cpu, "x86_64" ) ||
 321         !strcmp( cpu, "ia64" ) || !strcmp( cpu, "aarch64" ))
 322         pointer_size = 8;
 323     else
 324         pointer_size = 4;
 325     free( cpu );
 326 }
 327
 328 int main(int argc,char *argv[])
 329 {
 330         extern char* optarg;
 331         extern int   optind;
 332         int optc;
 333         int opti = 0;
 334         int stdinc = 1;
 335         int lose = 0;
 336         int nb_files = 0;
 337         int i;
 338         int cmdlen;
 339         int po_mode = 0;
 340         char *po_dir = NULL;
 341         char **files = xmalloc( argc * sizeof(*files) );
 342
 343         signal(SIGSEGV, segvhandler);
 344         signal( SIGTERM, exit_on_signal );
 345         signal( SIGINT, exit_on_signal );
 346 #ifdef SIGHUP
 347         signal( SIGHUP, exit_on_signal );
 348 #endif
 349
 350         /* Set the default defined stuff */
 351         set_version_defines();
 352         wpp_add_cmdline_define("RC_INVOKED=1");
 353         /* Microsoft RC always searches current directory */
 354         wpp_add_include_path(".");
 355
 356         /* First rebuild the commandline to put in destination */
 357         /* Could be done through env[], but not all OS-es support it */
 358         cmdlen = 4; /* for "wrc " */
 359         for(i = 1; i < argc; i++)
 360                 cmdlen += strlen(argv[i]) + 1;
 361         cmdline = xmalloc(cmdlen);
 362         strcpy(cmdline, "wrc ");
 363         for(i = 1; i < argc; i++)
 364         {
 365                 strcat(cmdline, argv[i]);
 366                 if(i < argc-1)
 367                         strcat(cmdline, " ");
 368         }
 369
 370         while((optc = getopt_long(argc, argv, short_options, long_options, &opti)) != EOF)
 371         {
 372                 switch(optc)
 373                 {
 374                 case LONG_OPT_NOSTDINC:
 375                         stdinc = 0;
 376                         break;
 377                 case LONG_OPT_TMPFILE:
 378                         if (debuglevel) warning("--use-temp-file option not yet supported, ignored.\n");
 379                         break;
 380                 case LONG_OPT_NOTMPFILE:
 381                         if (debuglevel) warning("--no-use-temp-file option not yet supported, ignored.\n");
 382                         break;
 383                 case LONG_OPT_PO_DIR:
 384                         po_dir = xstrdup( optarg );
 385                         break;
 386                 case LONG_OPT_PREPROCESSOR:
 387                         if (strcmp(optarg, "cat") == 0) no_preprocess = 1;
 388                         else fprintf(stderr, "-P option not yet supported, ignored.\n");
 389                         break;
 390                 case LONG_OPT_VERSION:
 391                         printf(version_string);
 392                         exit(0);
 393                         break;
 394                 case LONG_OPT_DEBUG:
 395                         debuglevel = strtol(optarg, NULL, 0);
 396                         break;
 397                 case LONG_OPT_ENDIANNESS:
 398                         switch(optarg[0])
 399                         {
 400                         case 'n':
 401                         case 'N':
 402                                 byteorder = WRC_BO_NATIVE;
 403                                 break;
 404                         case 'l':
 405                         case 'L':
 406                                 byteorder = WRC_BO_LITTLE;
 407                                 break;
 408                         case 'b':
 409                         case 'B':
 410                                 byteorder = WRC_BO_BIG;
 411                                 break;
 412                         default:
 413                                 fprintf(stderr, "Byte ordering must be n[ative], l[ittle] or b[ig]\n");
 414                                 lose++;
 415                         }
 416                         break;
 417                 case LONG_OPT_PEDANTIC:
 418                         pedantic = 1;
 419                         wpp_set_pedantic(1);
 420                         break;
 421                 case LONG_OPT_VERIFY_TRANSL:
 422                         verify_translations_mode = 1;
 423                         break;
 424                 case 'D':
 425                         wpp_add_cmdline_define(optarg);
 426                         break;
 427                 case 'E':
 428                         preprocess_only = 1;
 429                         break;
 430                 case 'b':
 431                 case 'F':
 432                         set_target( optarg );
 433                         break;
 434                 case 'h':
 435                         printf(usage);
 436                         exit(0);
 437                 case 'i':
 438                         files[nb_files++] = optarg;
 439                         break;
 440                 case 'I':
 441                         wpp_add_include_path(optarg);
 442                         break;
 443                 case 'J':
 444                         if (strcmp(optarg, "rc16") == 0)  extensions = 0;
 445                         else if (strcmp(optarg, "rc")) error("Output format %s not supported.\n", optarg);
 446                         break;
 447                 case 'l':
 448                         {
 449                                 int lan;
 450                                 lan = strtol(optarg, NULL, 0);
 451                                 if (get_language_codepage(PRIMARYLANGID(lan), SUBLANGID(lan)) == -1)
 452                                         error("Language %04x is not supported\n", lan);
 453                                 defaultlanguage = new_language(PRIMARYLANGID(lan), SUBLANGID(lan));
 454                         }
 455                         break;
 456                 case 'm':
 457                         if (!strcmp( optarg, "16" )) win32 = 0;
 458                         else if (!strcmp( optarg, "32" )) { win32 = 1; pointer_size = 4; }
 459                         else if (!strcmp( optarg, "64" )) { win32 = 1; pointer_size = 8; }
 460                         break;
 461                 case 'f':
 462                         if (*optarg != 'o') error("Unknown option: -f%s\n",  optarg);
 463                         optarg++;
 464                         /* fall through */
 465                 case 'o':
 466                         if (!output_name) output_name = strdup(optarg);
 467                         else error("Too many output files.\n");
 468                         break;
 469                 case 'O':
 470                         if (strcmp(optarg, "po") == 0) po_mode = 1;
 471                         else if (strcmp(optarg, "pot") == 0) po_mode = 2;
 472                         else if (strcmp(optarg, "res16") == 0) win32 = 0;
 473                         else if (strcmp(optarg, "res")) warning("Output format %s not supported.\n", optarg);
 474                         break;
 475                 case 'r':
 476                         /* ignored for compatibility with rc */
 477                         break;
 478                 case 'U':
 479                         wpp_del_define(optarg);
 480                         break;
 481                 case 'v':
 482                         debuglevel = DEBUGLEVEL_CHAT;
 483                         break;
 484                 default:
 485                         lose++;
 486                         break;
 487                 }
 488         }
 489
 490         if(lose)
 491         {
 492                 fprintf(stderr, usage);
 493                 return 1;
 494         }
 495
 496         if (win32)
 497         {
 498                 wpp_add_cmdline_define("_WIN32=1");
 499                 if (pointer_size == 8) wpp_add_cmdline_define("_WIN64=1");
 500         }
 501
 502         /* If we do need to search standard includes, add them to the path */
 503         if (stdinc)
 504         {
 505                 wpp_add_include_path(INCLUDEDIR"/msvcrt");
 506                 wpp_add_include_path(INCLUDEDIR"/windows");
 507         }
 508
 509         /* Kill io buffering when some kind of debuglevel is enabled */
 510         if(debuglevel)
 511         {
 512                 setbuf(stdout, NULL);
 513                 setbuf(stderr, NULL);
 514         }
 515
 516         parser_debug = debuglevel & DEBUGLEVEL_TRACE ? 1 : 0;
 517         yy_flex_debug = debuglevel & DEBUGLEVEL_TRACE ? 1 : 0;
 518
 519         wpp_set_debug( (debuglevel & DEBUGLEVEL_PPLEX) != 0,
 520                        (debuglevel & DEBUGLEVEL_PPTRACE) != 0,
 521                        (debuglevel & DEBUGLEVEL_PPMSG) != 0 );
 522
 523         /* Check if the user set a language, else set default */
 524         if(!defaultlanguage)
 525                 defaultlanguage = new_language(0, 0);
 526
 527         atexit(cleanup_files);
 528
 529         while (optind < argc) files[nb_files++] = argv[optind++];
 530
 531         for (i = 0; i < nb_files; i++)
 532         {
 533             input_name = files[i];
 534             if (load_file( input_name, output_name )) exit(1);
 535         }
 536         /* stdin special case. NULL means "stdin" for wpp. */
 537         if (nb_files == 0 && load_file( NULL, output_name )) exit(1);
 538
 539         if(debuglevel & DEBUGLEVEL_DUMP)
 540                 dump_resources(resource_top);
 541
 542         if(verify_translations_mode)
 543         {
 544                 verify_translations(resource_top);
 545                 exit(0);
 546         }
 547         if (po_mode)
 548         {
 549             if (po_mode == 2)  /* pot file */
 550             {
 551                 if (!output_name)
 552                 {
 553                     output_name = dup_basename( nb_files ? files[0] : NULL, ".rc" );
 554                     strcat( output_name, ".pot" );
 555                 }
 556                 write_pot_file( output_name );
 557             }
 558             else write_po_files( output_name );
 559             output_name = NULL;
 560             exit(0);
 561         }
 562         add_translations( po_dir );
 563
 564         /* Convert the internal lists to binary data */
 565         resources2res(resource_top);
 566
 567         chat("Writing .res-file\n");
 568         if (!output_name)
 569         {
 570             output_name = dup_basename( nb_files ? files[0] : NULL, ".rc" );
 571             strcat(output_name, ".res");
 572         }
 573         write_resfile(output_name, resource_top);
 574         output_name = NULL;
 575
 576         return 0;
 577 }
 578
 579
 580 static void cleanup_files(void)
 581 {
 582         if (output_name) unlink(output_name);
 583         if (temp_name) unlink(temp_name);
 584 }
 585
 586 static void segvhandler(int sig)
 587 {
 588         fprintf(stderr, "\n%s:%d: Oops, segment violation\n", input_name, line_number);
 589         fflush(stdout);
 590         fflush(stderr);
 591         abort();
 592 }