1 /* windres.c -- a program to manipulate Windows resources
2 Copyright 1997, 1998, 1999 Free Software Foundation, Inc.
3 Written by Ian Lance Taylor, Cygnus Support.
5 This file is part of GNU Binutils.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 This program 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
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
22 /* This program can read and write Windows resources in various
23 formats. In particular, it can act like the rc resource compiler
24 program, and it can act like the cvtres res to COFF conversion
27 It is based on information taken from the following sources:
29 * Microsoft documentation.
31 * The rcl program, written by Gunther Ebert
32 <gunther.ebert@ixos-leipzig.de>.
34 * The res2coff program, written by Pedro A. Aranda <paag@tid.es>.
41 #include "libiberty.h"
49 /* used by resrc.c at least */
53 /* An enumeration of format types. */
59 /* Textual RC file. */
61 /* Binary RES file. */
67 /* A structure used to map between format types and strings. */
72 enum res_format format;
75 /* A mapping between names and format types. */
77 static const struct format_map format_names[] =
79 { "rc", RES_FORMAT_RC },
80 { "res", RES_FORMAT_RES },
81 { "coff", RES_FORMAT_COFF },
82 { NULL, RES_FORMAT_UNKNOWN }
85 /* A mapping from file extensions to format types. */
87 static const struct format_map format_fileexts[] =
89 { "rc", RES_FORMAT_RC },
90 { "res", RES_FORMAT_RES },
91 { "exe", RES_FORMAT_COFF },
92 { "obj", RES_FORMAT_COFF },
93 { "o", RES_FORMAT_COFF },
94 { NULL, RES_FORMAT_UNKNOWN }
97 /* A list of include directories. */
101 struct include_dir *next;
105 static struct include_dir *include_dirs;
109 /* 150 isn't special; it's just an arbitrary non-ASCII char value. */
111 #define OPTION_DEFINE 150
112 #define OPTION_HELP (OPTION_DEFINE + 1)
113 #define OPTION_INCLUDE_DIR (OPTION_HELP + 1)
114 #define OPTION_LANGUAGE (OPTION_INCLUDE_DIR + 1)
115 #define OPTION_PREPROCESSOR (OPTION_LANGUAGE + 1)
116 #define OPTION_USE_TEMP_FILE (OPTION_PREPROCESSOR + 1)
117 #define OPTION_NO_USE_TEMP_FILE (OPTION_USE_TEMP_FILE + 1)
118 #define OPTION_VERSION (OPTION_NO_USE_TEMP_FILE + 1)
119 #define OPTION_YYDEBUG (OPTION_VERSION + 1)
121 static const struct option long_options[] =
123 {"define", required_argument, 0, OPTION_DEFINE},
124 {"help", no_argument, 0, OPTION_HELP},
125 {"include-dir", required_argument, 0, OPTION_INCLUDE_DIR},
126 {"input-format", required_argument, 0, 'I'},
127 {"language", required_argument, 0, OPTION_LANGUAGE},
128 {"output-format", required_argument, 0, 'O'},
129 {"preprocessor", required_argument, 0, OPTION_PREPROCESSOR},
130 {"target", required_argument, 0, 'F'},
131 {"use-temp-file", no_argument, 0, OPTION_USE_TEMP_FILE},
132 {"no-use-temp-file", no_argument, 0, OPTION_NO_USE_TEMP_FILE},
133 {"verbose", no_argument, 0, 'v'},
134 {"version", no_argument, 0, OPTION_VERSION},
135 {"yydebug", no_argument, 0, OPTION_YYDEBUG},
136 {0, no_argument, 0, 0}
139 /* Static functions. */
141 static void res_init PARAMS ((void));
142 static int extended_menuitems PARAMS ((const struct menuitem *));
143 static enum res_format format_from_name PARAMS ((const char *));
144 static enum res_format format_from_filename PARAMS ((const char *, int));
145 static void usage PARAMS ((FILE *, int));
146 static int cmp_res_entry PARAMS ((const PTR, const PTR));
147 static struct res_directory *sort_resources PARAMS ((struct res_directory *));
149 /* When we are building a resource tree, we allocate everything onto
150 an obstack, so that we can free it all at once if we want. */
152 #define obstack_chunk_alloc xmalloc
153 #define obstack_chunk_free free
155 /* The resource building obstack. */
157 static struct obstack res_obstack;
159 /* Initialize the resource building obstack. */
164 obstack_init (&res_obstack);
167 /* Allocate space on the resource building obstack. */
173 return (PTR) obstack_alloc (&res_obstack, bytes);
176 /* We also use an obstack to save memory used while writing out a set
179 static struct obstack reswr_obstack;
181 /* Initialize the resource writing obstack. */
186 obstack_init (&reswr_obstack);
189 /* Allocate space on the resource writing obstack. */
195 return (PTR) obstack_alloc (&reswr_obstack, bytes);
198 /* Open a file using the include directory search list. */
201 open_file_search (filename, mode, errmsg, real_filename)
202 const char *filename;
205 char **real_filename;
208 struct include_dir *d;
210 e = fopen (filename, mode);
213 *real_filename = xstrdup (filename);
219 for (d = include_dirs; d != NULL; d = d->next)
223 n = (char *) xmalloc (strlen (d->dir) + strlen (filename) + 2);
224 sprintf (n, "%s/%s", d->dir, filename);
237 fatal (_("can't open %s `%s': %s"), errmsg, filename, strerror (errno));
239 /* Return a value to avoid a compiler warning. */
243 /* Compare two resource ID's. We consider name entries to come before
244 numeric entries, because that is how they appear in the COFF .rsrc
258 else if (a.u.id < b.u.id)
265 unichar *as, *ase, *bs, *bse;
271 ase = as + a.u.n.length;
273 bse = bs + b.u.n.length;
281 i = (int) *as - (int) *bs;
295 /* Print a resource ID. */
298 res_id_print (stream, id, quote)
304 fprintf (stream, "%lu", id.u.id);
309 unicode_print (stream, id.u.n.name, id.u.n.length);
315 /* Print a list of resource ID's. */
318 res_ids_print (stream, cids, ids)
321 const struct res_id *ids;
325 for (i = 0; i < cids; i++)
327 res_id_print (stream, ids[i], 1);
329 fprintf (stream, ": ");
333 /* Convert an ASCII string to a resource ID. */
336 res_string_to_id (res_id, string)
337 struct res_id *res_id;
341 unicode_from_ascii (&res_id->u.n.length, &res_id->u.n.name, string);
344 /* Define a resource. The arguments are the resource tree, RESOURCES,
345 and the location at which to put it in the tree, CIDS and IDS.
346 This returns a newly allocated res_resource structure, which the
347 caller is expected to initialize. If DUPOK is non-zero, then if a
348 resource with this ID exists, it is returned. Otherwise, a warning
349 is issued, and a new resource is created replacing the existing
352 struct res_resource *
353 define_resource (resources, cids, ids, dupok)
354 struct res_directory **resources;
356 const struct res_id *ids;
359 struct res_entry *re = NULL;
363 for (i = 0; i < cids; i++)
365 struct res_entry **pp;
367 if (*resources == NULL)
369 static unsigned long timeval;
371 /* Use the same timestamp for every resource created in a
374 timeval = time (NULL);
376 *resources = ((struct res_directory *)
377 res_alloc (sizeof **resources));
378 (*resources)->characteristics = 0;
379 (*resources)->time = timeval;
380 (*resources)->major = 0;
381 (*resources)->minor = 0;
382 (*resources)->entries = NULL;
385 for (pp = &(*resources)->entries; *pp != NULL; pp = &(*pp)->next)
386 if (res_id_cmp ((*pp)->id, ids[i]) == 0)
393 re = (struct res_entry *) res_alloc (sizeof *re);
414 fprintf (stderr, "%s: ", program_name);
415 res_ids_print (stderr, i, ids);
416 fprintf (stderr, _(": expected to be a directory\n"));
420 resources = &re->u.dir;
426 fprintf (stderr, "%s: ", program_name);
427 res_ids_print (stderr, cids, ids);
428 fprintf (stderr, _(": expected to be a leaf\n"));
432 if (re->u.res != NULL)
437 fprintf (stderr, _("%s: warning: "), program_name);
438 res_ids_print (stderr, cids, ids);
439 fprintf (stderr, _(": duplicate value\n"));
442 re->u.res = ((struct res_resource *)
443 res_alloc (sizeof (struct res_resource)));
445 re->u.res->type = RES_TYPE_UNINITIALIZED;
446 memset (&re->u.res->res_info, 0, sizeof (struct res_res_info));
447 memset (&re->u.res->coff_info, 0, sizeof (struct res_coff_info));
452 /* Define a standard resource. This is a version of define_resource
453 that just takes type, name, and language arguments. */
455 struct res_resource *
456 define_standard_resource (resources, type, name, language, dupok)
457 struct res_directory **resources;
469 a[2].u.id = language;
470 return define_resource (resources, 3, a, dupok);
473 /* Comparison routine for resource sorting. */
476 cmp_res_entry (p1, p2)
480 const struct res_entry **re1, **re2;
482 re1 = (const struct res_entry **) p1;
483 re2 = (const struct res_entry **) p2;
484 return res_id_cmp ((*re1)->id, (*re2)->id);
487 /* Sort the resources. */
489 static struct res_directory *
490 sort_resources (resdir)
491 struct res_directory *resdir;
494 struct res_entry *re;
495 struct res_entry **a;
497 if (resdir->entries == NULL)
501 for (re = resdir->entries; re != NULL; re = re->next)
504 /* This is a recursive routine, so using xmalloc is probably better
506 a = (struct res_entry **) xmalloc (c * sizeof (struct res_entry *));
508 for (i = 0, re = resdir->entries; re != NULL; re = re->next, i++)
511 qsort (a, c, sizeof (struct res_entry *), cmp_res_entry);
513 resdir->entries = a[0];
514 for (i = 0; i < c - 1; i++)
515 a[i]->next = a[i + 1];
520 /* Now sort the subdirectories. */
522 for (re = resdir->entries; re != NULL; re = re->next)
524 re->u.dir = sort_resources (re->u.dir);
529 /* Return whether the dialog resource DIALOG is a DIALOG or a
533 extended_dialog (dialog)
534 const struct dialog *dialog;
536 const struct dialog_control *c;
538 if (dialog->ex != NULL)
541 for (c = dialog->controls; c != NULL; c = c->next)
542 if (c->data != NULL || c->help != 0)
548 /* Return whether MENUITEMS are a MENU or a MENUEX. */
552 const struct menu *menu;
554 return extended_menuitems (menu->items);
558 extended_menuitems (menuitems)
559 const struct menuitem *menuitems;
561 const struct menuitem *mi;
563 for (mi = menuitems; mi != NULL; mi = mi->next)
565 if (mi->help != 0 || mi->state != 0)
567 if (mi->popup != NULL && mi->id != 0)
570 & ~ (MENUITEM_CHECKED
574 | MENUITEM_MENUBARBREAK
575 | MENUITEM_MENUBREAK))
578 if (mi->popup != NULL)
580 if (extended_menuitems (mi->popup))
588 /* Convert a string to a format type, or exit if it can't be done. */
590 static enum res_format
591 format_from_name (name)
594 const struct format_map *m;
596 for (m = format_names; m->name != NULL; m++)
597 if (strcasecmp (m->name, name) == 0)
602 fprintf (stderr, _("%s: unknown format type `%s'\n"), program_name, name);
603 fprintf (stderr, _("%s: supported formats:"), program_name);
604 for (m = format_names; m->name != NULL; m++)
605 fprintf (stderr, " %s", m->name);
606 fprintf (stderr, "\n");
613 /* Work out a format type given a file name. If INPUT is non-zero,
614 it's OK to look at the file itself. */
616 static enum res_format
617 format_from_filename (filename, input)
618 const char *filename;
623 unsigned char b1, b2, b3, b4, b5;
626 /* If we have an extension, see if we recognize it as implying a
627 particular format. */
628 ext = strrchr (filename, '.');
631 const struct format_map *m;
634 for (m = format_fileexts; m->name != NULL; m++)
635 if (strcasecmp (m->name, ext) == 0)
639 /* If we don't recognize the name of an output file, assume it's a
643 return RES_FORMAT_COFF;
645 /* Read the first few bytes of the file to see if we can guess what
648 e = fopen (filename, FOPEN_RB);
650 fatal ("%s: %s", filename, strerror (errno));
660 /* A PE executable starts with 0x4d 0x5a. */
661 if (b1 == 0x4d && b2 == 0x5a)
662 return RES_FORMAT_COFF;
664 /* A COFF .o file starts with a COFF magic number. */
665 magic = (b2 << 8) | b1;
668 case 0x14c: /* i386 */
669 case 0x166: /* MIPS */
670 case 0x184: /* Alpha */
671 case 0x268: /* 68k */
672 case 0x1f0: /* PowerPC */
674 return RES_FORMAT_COFF;
677 /* A RES file starts with 0x0 0x0 0x0 0x0 0x20 0x0 0x0 0x0. */
678 if (b1 == 0 && b2 == 0 && b3 == 0 && b4 == 0 && b5 == 0x20)
679 return RES_FORMAT_RES;
681 /* If every character is printable or space, assume it's an RC file. */
682 if ((isprint (b1) || isspace (b1))
683 && (isprint (b2) || isspace (b2))
684 && (isprint (b3) || isspace (b3))
685 && (isprint (b4) || isspace (b4))
686 && (isprint (b5) || isspace (b5)))
687 return RES_FORMAT_RC;
689 /* Otherwise, we give up. */
690 fatal (_("can not determine type of file `%s'; use the -I option"),
693 /* Return something to silence the compiler warning. */
694 return RES_FORMAT_UNKNOWN;
697 /* Print a usage message and exit. */
700 usage (stream, status)
704 fprintf (stream, _("Usage: %s [options] [input-file] [output-file]\n"),
706 fprintf (stream, _("\
708 -i FILE, --input FILE Name input file\n\
709 -o FILE, --output FILE Name output file\n\
710 -I FORMAT, --input-format FORMAT\n\
711 Specify input format\n\
712 -O FORMAT, --output-format FORMAT\n\
713 Specify output format\n\
714 -F TARGET, --target TARGET Specify COFF target\n\
715 --preprocessor PROGRAM Program to use to preprocess rc file\n\
716 --include-dir DIR Include directory when preprocessing rc file\n\
717 -DSYM[=VAL], --define SYM[=VAL]\n\
718 Define SYM when preprocessing rc file\n\
719 -v Verbose - tells you what it's doing\n\
720 --language VAL Set language when reading rc file\n\
721 --use-temp-file Use a temporary file instead of popen to read\n\
722 the preprocessor output\n\
723 --no-use-temp-file Use popen (default)\n"));
725 fprintf (stream, _("\
726 --yydebug Turn on parser debugging\n"));
728 fprintf (stream, _("\
729 --help Print this help message\n\
730 --version Print version information\n"));
731 fprintf (stream, _("\
732 FORMAT is one of rc, res, or coff, and is deduced from the file name\n\
733 extension if not specified. A single file name is an input file.\n\
734 No input-file is stdin, default rc. No output-file is stdout, default rc.\n"));
735 list_supported_targets (program_name, stream);
737 fprintf (stream, _("Report bugs to bug-gnu-utils@gnu.org\n"));
741 /* Quote characters that will confuse the shell when we run the preprocessor */
742 static const char *quot (string)
745 static char *buf = 0;
746 static int buflen = 0;
747 int slen = strlen (string);
751 if ((buflen < slen * 2 + 2) || !buf)
753 buflen = slen * 2 + 2;
756 buf = (char *) xmalloc (buflen);
759 for (src=string, dest=buf; *src; src++, dest++)
761 if (*src == '(' || *src == ')' || *src == ' ')
769 /* The main function. */
777 char *input_filename;
778 char *output_filename;
779 enum res_format input_format;
780 enum res_format output_format;
784 const char *quotedarg;
786 struct res_directory *resources;
789 #if defined (HAVE_SETLOCALE) && defined (HAVE_LC_MESSAGES)
790 setlocale (LC_MESSAGES, "");
792 bindtextdomain (PACKAGE, LOCALEDIR);
793 textdomain (PACKAGE);
795 program_name = argv[0];
796 xmalloc_set_program_name (program_name);
799 set_default_bfd_target ();
803 input_filename = NULL;
804 output_filename = NULL;
805 input_format = RES_FORMAT_UNKNOWN;
806 output_format = RES_FORMAT_UNKNOWN;
813 while ((c = getopt_long (argc, argv, "i:o:I:O:F:D:v", long_options,
819 input_filename = optarg;
823 output_filename = optarg;
827 input_format = format_from_name (optarg);
831 output_format = format_from_name (optarg);
838 case OPTION_PREPROCESSOR:
839 preprocessor = optarg;
844 if (preprocargs == NULL)
846 quotedarg = quot (optarg);
847 preprocargs = xmalloc (strlen (quotedarg) + 3);
848 sprintf (preprocargs, "-D%s", quotedarg);
854 quotedarg = quot (optarg);
855 n = xmalloc (strlen (preprocargs) + strlen (quotedarg) + 4);
856 sprintf (n, "%s -D%s", preprocargs, quotedarg);
866 case OPTION_INCLUDE_DIR:
867 if (preprocargs == NULL)
869 quotedarg = quot (optarg);
870 preprocargs = xmalloc (strlen (quotedarg) + 3);
871 sprintf (preprocargs, "-I%s", quotedarg);
877 quotedarg = quot (optarg);
878 n = xmalloc (strlen (preprocargs) + strlen (quotedarg) + 4);
879 sprintf (n, "%s -I%s", preprocargs, quotedarg);
885 struct include_dir *n, **pp;
887 n = (struct include_dir *) xmalloc (sizeof *n);
891 for (pp = &include_dirs; *pp != NULL; pp = &(*pp)->next)
898 case OPTION_LANGUAGE:
899 language = strtol (optarg, (char **) NULL, 16);
902 case OPTION_USE_TEMP_FILE:
906 case OPTION_NO_USE_TEMP_FILE:
921 print_version ("windres");
930 if (input_filename == NULL && optind < argc)
932 input_filename = argv[optind];
936 if (output_filename == NULL && optind < argc)
938 output_filename = argv[optind];
945 if (input_format == RES_FORMAT_UNKNOWN)
947 if (input_filename == NULL)
948 input_format = RES_FORMAT_RC;
950 input_format = format_from_filename (input_filename, 1);
953 if (output_format == RES_FORMAT_UNKNOWN)
955 if (output_filename == NULL)
956 output_format = RES_FORMAT_RC;
958 output_format = format_from_filename (output_filename, 0);
961 /* Read the input file. */
963 switch (input_format)
968 resources = read_rc_file (input_filename, preprocessor, preprocargs,
969 language, use_temp_file);
972 resources = read_res_file (input_filename);
974 case RES_FORMAT_COFF:
975 resources = read_coff_rsrc (input_filename, target);
979 if (resources == NULL)
980 fatal (_("no resources"));
982 /* Sort the resources. This is required for COFF, convenient for
983 rc, and unimportant for res. */
985 resources = sort_resources (resources);
987 /* Write the output file. */
991 switch (output_format)
996 write_rc_file (output_filename, resources);
999 write_res_file (output_filename, resources);
1001 case RES_FORMAT_COFF:
1002 write_coff_file (output_filename, target, resources);