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