winebuild: Add possibility to generate a global resource file without running it...
[wine] / tools / winebuild / main.c
1 /*
2  * Main function
3  *
4  * Copyright 1993 Robert J. Amstadt
5  * Copyright 1995 Martin von Loewis
6  * Copyright 1995, 1996, 1997 Alexandre Julliard
7  * Copyright 1997 Eric Youngdale
8  * Copyright 1999 Ulrich Weigand
9  *
10  * This library is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU Lesser General Public
12  * License as published by the Free Software Foundation; either
13  * version 2.1 of the License, or (at your option) any later version.
14  *
15  * This library is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18  * Lesser General Public License for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public
21  * License along with this library; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
23  */
24
25 #include "config.h"
26 #include "wine/port.h"
27
28 #include <assert.h>
29 #include <stdio.h>
30 #include <signal.h>
31 #include <errno.h>
32 #include <string.h>
33 #include <stdarg.h>
34 #include <ctype.h>
35 #ifdef HAVE_GETOPT_H
36 # include <getopt.h>
37 #endif
38
39 #include "build.h"
40
41 int UsePIC = 0;
42 int nb_lib_paths = 0;
43 int nb_errors = 0;
44 int display_warnings = 0;
45 int kill_at = 0;
46 int verbose = 0;
47 int save_temps = 0;
48 int link_ext_symbols = 0;
49 int force_pointer_size = 0;
50
51 #ifdef __i386__
52 enum target_cpu target_cpu = CPU_x86;
53 #elif defined(__x86_64__)
54 enum target_cpu target_cpu = CPU_x86_64;
55 #elif defined(__sparc__)
56 enum target_cpu target_cpu = CPU_SPARC;
57 #elif defined(__ALPHA__)
58 enum target_cpu target_cpu = CPU_ALPHA;
59 #elif defined(__powerpc__)
60 enum target_cpu target_cpu = CPU_POWERPC;
61 #else
62 #error Unsupported CPU
63 #endif
64
65 #ifdef __APPLE__
66 enum target_platform target_platform = PLATFORM_APPLE;
67 #elif defined(__sun)
68 enum target_platform target_platform = PLATFORM_SOLARIS;
69 #elif defined(_WINDOWS)
70 enum target_platform target_platform = PLATFORM_WINDOWS;
71 #else
72 enum target_platform target_platform = PLATFORM_UNSPECIFIED;
73 #endif
74
75 char *target_alias = NULL;
76 char **lib_path = NULL;
77
78 char *input_file_name = NULL;
79 char *spec_file_name = NULL;
80 FILE *output_file = NULL;
81 const char *output_file_name = NULL;
82 static const char *output_file_source_name;
83
84 char *as_command = NULL;
85 char *ld_command = NULL;
86 char *nm_command = NULL;
87
88 static int nb_res_files;
89 static char **res_files;
90
91 /* execution mode */
92 enum exec_mode_values
93 {
94     MODE_NONE,
95     MODE_DLL,
96     MODE_EXE,
97     MODE_DEF,
98     MODE_RELAY16,
99     MODE_RELAY32,
100     MODE_RESOURCES
101 };
102
103 static enum exec_mode_values exec_mode = MODE_NONE;
104
105 static const struct
106 {
107     const char *name;
108     enum target_platform platform;
109 } platform_names[] =
110 {
111     { "macos",   PLATFORM_APPLE },
112     { "darwin",  PLATFORM_APPLE },
113     { "solaris", PLATFORM_SOLARIS },
114     { "windows", PLATFORM_WINDOWS },
115     { "winnt",   PLATFORM_WINDOWS }
116 };
117
118 /* set the dll file name from the input file name */
119 static void set_dll_file_name( const char *name, DLLSPEC *spec )
120 {
121     char *p;
122
123     if (spec->file_name) return;
124
125     if ((p = strrchr( name, '\\' ))) name = p + 1;
126     if ((p = strrchr( name, '/' ))) name = p + 1;
127     spec->file_name = xmalloc( strlen(name) + 5 );
128     strcpy( spec->file_name, name );
129     if ((p = strrchr( spec->file_name, '.' )))
130     {
131         if (!strcmp( p, ".spec" ) || !strcmp( p, ".def" )) *p = 0;
132     }
133 }
134
135 /* set the dll subsystem */
136 static void set_subsystem( const char *subsystem, DLLSPEC *spec )
137 {
138     char *major, *minor, *str = xstrdup( subsystem );
139
140     if ((major = strchr( str, ':' ))) *major++ = 0;
141     if (!strcmp( str, "native" )) spec->subsystem = IMAGE_SUBSYSTEM_NATIVE;
142     else if (!strcmp( str, "windows" )) spec->subsystem = IMAGE_SUBSYSTEM_WINDOWS_GUI;
143     else if (!strcmp( str, "console" )) spec->subsystem = IMAGE_SUBSYSTEM_WINDOWS_CUI;
144     else if (!strcmp( str, "win16" )) spec->type = SPEC_WIN16;
145     else fatal_error( "Invalid subsystem name '%s'\n", subsystem );
146     if (major)
147     {
148         if ((minor = strchr( major, '.' )))
149         {
150             *minor++ = 0;
151             spec->subsystem_minor = atoi( minor );
152         }
153         spec->subsystem_major = atoi( major );
154     }
155     free( str );
156 }
157
158 /* set the target CPU and platform */
159 static void set_target( const char *target )
160 {
161     unsigned int i;
162     char *p, *platform, *spec = xstrdup( target );
163
164     /* target specification is in the form CPU-MANUFACTURER-OS or CPU-MANUFACTURER-KERNEL-OS */
165
166     target_alias = xstrdup( target );
167
168     /* get the CPU part */
169
170     if (!(p = strchr( spec, '-' ))) fatal_error( "Invalid target specification '%s'\n", target );
171     *p++ = 0;
172     if ((target_cpu = get_cpu_from_name( spec )) == -1)
173         fatal_error( "Unrecognized CPU '%s'\n", spec );
174     platform = p;
175     if ((p = strrchr( p, '-' ))) platform = p + 1;
176
177     /* get the OS part */
178
179     target_platform = PLATFORM_UNSPECIFIED;  /* default value */
180     for (i = 0; i < sizeof(platform_names)/sizeof(platform_names[0]); i++)
181     {
182         if (!strncmp( platform_names[i].name, platform, strlen(platform_names[i].name) ))
183         {
184             target_platform = platform_names[i].platform;
185             break;
186         }
187     }
188
189     free( spec );
190 }
191
192 /* cleanup on program exit */
193 static void cleanup(void)
194 {
195     if (output_file_name) unlink( output_file_name );
196 }
197
198 /* clean things up when aborting on a signal */
199 static void exit_on_signal( int sig )
200 {
201     exit(1);  /* this will call atexit functions */
202 }
203
204 /*******************************************************************
205  *         command-line option handling
206  */
207 static const char usage_str[] =
208 "Usage: winebuild [OPTIONS] [FILES]\n\n"
209 "Options:\n"
210 "       --as-cmd=AS           Command to use for assembling (default: as)\n"
211 "   -b, --target=TARGET       Specify target CPU and platform for cross-compiling\n"
212 "   -d, --delay-lib=LIB       Import the specified library in delayed mode\n"
213 "   -D SYM                    Ignored for C flags compatibility\n"
214 "   -e, --entry=FUNC          Set the DLL entry point function (default: DllMain)\n"
215 "   -E, --export=FILE         Export the symbols defined in the .spec or .def file\n"
216 "       --external-symbols    Allow linking to external symbols\n"
217 "   -f FLAGS                  Compiler flags (only -fPIC is supported)\n"
218 "   -F, --filename=DLLFILE    Set the DLL filename (default: from input file name)\n"
219 "   -h, --help                Display this help message\n"
220 "   -H, --heap=SIZE           Set the heap size for a Win16 dll\n"
221 "   -i, --ignore=SYM[,SYM]    Ignore specified symbols when resolving imports\n"
222 "   -I DIR                    Ignored for C flags compatibility\n"
223 "   -k, --kill-at             Kill stdcall decorations in generated .def files\n"
224 "   -K, FLAGS                 Compiler flags (only -KPIC is supported)\n"
225 "       --large-address-aware Support an address space larger than 2Gb\n"
226 "       --ld-cmd=LD           Command to use for linking (default: ld)\n"
227 "   -l, --library=LIB         Import the specified library\n"
228 "   -L, --library-path=DIR    Look for imports libraries in DIR\n"
229 "   -m32, -m64                Force building 32-bit resp. 64-bit code\n"
230 "   -M, --main-module=MODULE  Set the name of the main module for a Win16 dll\n"
231 "       --nm-cmd=NM           Command to use to get undefined symbols (default: nm)\n"
232 "       --nxcompat=y|n        Set the NX compatibility flag (default: yes)\n"
233 "   -N, --dll-name=DLLNAME    Set the DLL name (default: from input file name)\n"
234 "   -o, --output=NAME         Set the output file name (default: stdout)\n"
235 "   -r, --res=RSRC.RES        Load resources from RSRC.RES\n"
236 "       --save-temps          Do not delete the generated intermediate files\n"
237 "       --subsystem=SUBSYS    Set the subsystem (one of native, windows, console)\n"
238 "   -u, --undefined=SYMBOL    Add an undefined reference to SYMBOL when linking\n"
239 "   -v, --verbose             Display the programs invoked\n"
240 "       --version             Print the version and exit\n"
241 "   -w, --warnings            Turn on warnings\n"
242 "\nMode options:\n"
243 "       --dll                 Build a .c file from a .spec or .def file\n"
244 "       --def                 Build a .def file from a .spec file\n"
245 "       --exe                 Build a .c file for an executable\n"
246 "       --relay16             Build the 16-bit relay assembly routines\n"
247 "       --relay32             Build the 32-bit relay assembly routines\n"
248 "       --resources           Build a .o file for the resource files\n\n"
249 "The mode options are mutually exclusive; you must specify one and only one.\n\n";
250
251 enum long_options_values
252 {
253     LONG_OPT_DLL = 1,
254     LONG_OPT_DEF,
255     LONG_OPT_EXE,
256     LONG_OPT_ASCMD,
257     LONG_OPT_EXTERNAL_SYMS,
258     LONG_OPT_LARGE_ADDRESS_AWARE,
259     LONG_OPT_LDCMD,
260     LONG_OPT_NMCMD,
261     LONG_OPT_NXCOMPAT,
262     LONG_OPT_RELAY16,
263     LONG_OPT_RELAY32,
264     LONG_OPT_RESOURCES,
265     LONG_OPT_SAVE_TEMPS,
266     LONG_OPT_SUBSYSTEM,
267     LONG_OPT_VERSION
268 };
269
270 static const char short_options[] = "C:D:E:F:H:I:K:L:M:N:b:d:e:f:hi:kl:m:o:r:u:vw";
271
272 static const struct option long_options[] =
273 {
274     { "dll",           0, 0, LONG_OPT_DLL },
275     { "def",           0, 0, LONG_OPT_DEF },
276     { "exe",           0, 0, LONG_OPT_EXE },
277     { "as-cmd",        1, 0, LONG_OPT_ASCMD },
278     { "external-symbols", 0, 0, LONG_OPT_EXTERNAL_SYMS },
279     { "large-address-aware", 0, 0, LONG_OPT_LARGE_ADDRESS_AWARE },
280     { "ld-cmd",        1, 0, LONG_OPT_LDCMD },
281     { "nm-cmd",        1, 0, LONG_OPT_NMCMD },
282     { "nxcompat",      1, 0, LONG_OPT_NXCOMPAT },
283     { "relay16",       0, 0, LONG_OPT_RELAY16 },
284     { "relay32",       0, 0, LONG_OPT_RELAY32 },
285     { "resources",     0, 0, LONG_OPT_RESOURCES },
286     { "save-temps",    0, 0, LONG_OPT_SAVE_TEMPS },
287     { "subsystem",     1, 0, LONG_OPT_SUBSYSTEM },
288     { "version",       0, 0, LONG_OPT_VERSION },
289     /* aliases for short options */
290     { "target",        1, 0, 'b' },
291     { "delay-lib",     1, 0, 'd' },
292     { "export",        1, 0, 'E' },
293     { "entry",         1, 0, 'e' },
294     { "filename",      1, 0, 'F' },
295     { "help",          0, 0, 'h' },
296     { "heap",          1, 0, 'H' },
297     { "ignore",        1, 0, 'i' },
298     { "kill-at",       0, 0, 'k' },
299     { "library",       1, 0, 'l' },
300     { "library-path",  1, 0, 'L' },
301     { "main-module",   1, 0, 'M' },
302     { "dll-name",      1, 0, 'N' },
303     { "output",        1, 0, 'o' },
304     { "res",           1, 0, 'r' },
305     { "undefined",     1, 0, 'u' },
306     { "verbose",       0, 0, 'v' },
307     { "warnings",      0, 0, 'w' },
308     { NULL,            0, 0, 0 }
309 };
310
311 static void usage( int exit_code )
312 {
313     fprintf( stderr, "%s", usage_str );
314     exit( exit_code );
315 }
316
317 static void set_exec_mode( enum exec_mode_values mode )
318 {
319     if (exec_mode != MODE_NONE) usage(1);
320     exec_mode = mode;
321 }
322
323 /* parse options from the argv array and remove all the recognized ones */
324 static char **parse_options( int argc, char **argv, DLLSPEC *spec )
325 {
326     char *p;
327     int optc;
328
329     while ((optc = getopt_long( argc, argv, short_options, long_options, NULL )) != -1)
330     {
331         switch(optc)
332         {
333         case 'D':
334             /* ignored */
335             break;
336         case 'E':
337             spec_file_name = xstrdup( optarg );
338             set_dll_file_name( optarg, spec );
339             break;
340         case 'F':
341             spec->file_name = xstrdup( optarg );
342             break;
343         case 'H':
344             if (!isdigit(optarg[0]))
345                 fatal_error( "Expected number argument with -H option instead of '%s'\n", optarg );
346             spec->heap_size = atoi(optarg);
347             if (spec->heap_size > 65535)
348                 fatal_error( "Invalid heap size %d, maximum is 65535\n", spec->heap_size );
349             break;
350         case 'I':
351             /* ignored */
352             break;
353         case 'K':
354             /* ignored, because cc generates correct code. */
355             break;
356         case 'L':
357             lib_path = xrealloc( lib_path, (nb_lib_paths+1) * sizeof(*lib_path) );
358             lib_path[nb_lib_paths++] = xstrdup( optarg );
359             break;
360         case 'm':
361             if (strcmp( optarg, "32" ) && strcmp( optarg, "64" ))
362                 fatal_error( "Invalid -m option '%s', expected -m32 or -m64\n", optarg );
363             if (!strcmp( optarg, "32" )) force_pointer_size = 4;
364             else force_pointer_size = 8;
365             break;
366         case 'M':
367             spec->main_module = xstrdup( optarg );
368             break;
369         case 'N':
370             spec->dll_name = xstrdup( optarg );
371             break;
372         case 'b':
373             set_target( optarg );
374             break;
375         case 'd':
376             add_delayed_import( optarg );
377             break;
378         case 'e':
379             spec->init_func = xstrdup( optarg );
380             if ((p = strchr( spec->init_func, '@' ))) *p = 0;  /* kill stdcall decoration */
381             break;
382         case 'f':
383             if (!strcmp( optarg, "PIC") || !strcmp( optarg, "pic")) UsePIC = 1;
384             /* ignore all other flags */
385             break;
386         case 'h':
387             usage(0);
388             break;
389         case 'i':
390             {
391                 char *str = xstrdup( optarg );
392                 char *token = strtok( str, "," );
393                 while (token)
394                 {
395                     add_ignore_symbol( token );
396                     token = strtok( NULL, "," );
397                 }
398                 free( str );
399             }
400             break;
401         case 'k':
402             kill_at = 1;
403             break;
404         case 'l':
405             add_import_dll( optarg, NULL );
406             break;
407         case 'o':
408             {
409                 char *ext = strrchr( optarg, '.' );
410
411                 if (unlink( optarg ) == -1 && errno != ENOENT)
412                     fatal_error( "Unable to create output file '%s'\n", optarg );
413                 if (ext && !strcmp( ext, ".o" ))
414                 {
415                     output_file_source_name = get_temp_file_name( optarg, ".s" );
416                     if (!(output_file = fopen( output_file_source_name, "w" )))
417                         fatal_error( "Unable to create output file '%s'\n", optarg );
418                 }
419                 else
420                 {
421                     if (!(output_file = fopen( optarg, "w" )))
422                         fatal_error( "Unable to create output file '%s'\n", optarg );
423                 }
424                 output_file_name = xstrdup(optarg);
425                 atexit( cleanup );  /* make sure we remove the output file on exit */
426             }
427             break;
428         case 'r':
429             res_files = xrealloc( res_files, (nb_res_files+1) * sizeof(*res_files) );
430             res_files[nb_res_files++] = xstrdup( optarg );
431             break;
432         case 'u':
433             add_extra_ld_symbol( optarg );
434             break;
435         case 'v':
436             verbose++;
437             break;
438         case 'w':
439             display_warnings = 1;
440             break;
441         case LONG_OPT_DLL:
442             set_exec_mode( MODE_DLL );
443             break;
444         case LONG_OPT_DEF:
445             set_exec_mode( MODE_DEF );
446             break;
447         case LONG_OPT_EXE:
448             set_exec_mode( MODE_EXE );
449             if (!spec->subsystem) spec->subsystem = IMAGE_SUBSYSTEM_WINDOWS_GUI;
450             break;
451         case LONG_OPT_ASCMD:
452             as_command = xstrdup( optarg );
453             break;
454         case LONG_OPT_EXTERNAL_SYMS:
455             link_ext_symbols = 1;
456             break;
457         case LONG_OPT_LARGE_ADDRESS_AWARE:
458             spec->characteristics |= IMAGE_FILE_LARGE_ADDRESS_AWARE;
459             break;
460         case LONG_OPT_LDCMD:
461             ld_command = xstrdup( optarg );
462             break;
463         case LONG_OPT_NMCMD:
464             nm_command = xstrdup( optarg );
465             break;
466         case LONG_OPT_NXCOMPAT:
467             if (optarg[0] == 'n' || optarg[0] == 'N')
468                 spec->dll_characteristics &= ~IMAGE_DLLCHARACTERISTICS_NX_COMPAT;
469             break;
470         case LONG_OPT_RELAY16:
471             set_exec_mode( MODE_RELAY16 );
472             break;
473         case LONG_OPT_RELAY32:
474             set_exec_mode( MODE_RELAY32 );
475             break;
476         case LONG_OPT_RESOURCES:
477             set_exec_mode( MODE_RESOURCES );
478             break;
479         case LONG_OPT_SAVE_TEMPS:
480             save_temps = 1;
481             break;
482         case LONG_OPT_SUBSYSTEM:
483             set_subsystem( optarg, spec );
484             break;
485         case LONG_OPT_VERSION:
486             printf( "winebuild version " PACKAGE_VERSION "\n" );
487             exit(0);
488         case '?':
489             usage(1);
490             break;
491         }
492     }
493
494     if (spec->file_name && !strchr( spec->file_name, '.' ))
495         strcat( spec->file_name, exec_mode == MODE_EXE ? ".exe" : ".dll" );
496
497     switch (target_cpu)
498     {
499     case CPU_x86:
500         if (force_pointer_size == 8) target_cpu = CPU_x86_64;
501         break;
502     case CPU_x86_64:
503         if (force_pointer_size == 4) target_cpu = CPU_x86;
504         break;
505     default:
506         if (force_pointer_size == 8)
507             fatal_error( "Cannot build 64-bit code for this CPU\n" );
508         break;
509     }
510
511     return &argv[optind];
512 }
513
514
515 /* load all specified resource files */
516 static void load_resources( char *argv[], DLLSPEC *spec )
517 {
518     int i;
519     char **ptr, **last;
520
521     switch (spec->type)
522     {
523     case SPEC_WIN16:
524         for (i = 0; i < nb_res_files; i++) load_res16_file( res_files[i], spec );
525         break;
526
527     case SPEC_WIN32:
528         for (i = 0; i < nb_res_files; i++)
529         {
530             if (!load_res32_file( res_files[i], spec ))
531                 fatal_error( "%s is not a valid Win32 resource file\n", res_files[i] );
532         }
533
534         /* load any resource file found in the remaining arguments */
535         for (ptr = last = argv; *ptr; ptr++)
536         {
537             if (!load_res32_file( *ptr, spec ))
538                 *last++ = *ptr; /* not a resource file, keep it in the list */
539         }
540         *last = NULL;
541         break;
542     }
543 }
544
545 /* add input files that look like import libs to the import list */
546 static void load_import_libs( char *argv[] )
547 {
548     char **ptr, **last;
549
550     for (ptr = last = argv; *ptr; ptr++)
551     {
552         if (strendswith( *ptr, ".def" ))
553             add_import_dll( NULL, *ptr );
554         else
555             *last++ = *ptr; /* not an import dll, keep it in the list */
556     }
557     *last = NULL;
558 }
559
560 static int parse_input_file( DLLSPEC *spec )
561 {
562     FILE *input_file = open_input_file( NULL, spec_file_name );
563     char *extension = strrchr( spec_file_name, '.' );
564     int result;
565
566     spec->src_name = xstrdup( input_file_name );
567     if (extension && !strcmp( extension, ".def" ))
568         result = parse_def_file( input_file, spec );
569     else
570         result = parse_spec_file( input_file, spec );
571     close_input_file( input_file );
572     return result;
573 }
574
575
576 /*******************************************************************
577  *         main
578  */
579 int main(int argc, char **argv)
580 {
581     DLLSPEC *spec = alloc_dll_spec();
582
583 #ifdef SIGHUP
584     signal( SIGHUP, exit_on_signal );
585 #endif
586     signal( SIGTERM, exit_on_signal );
587     signal( SIGINT, exit_on_signal );
588
589     output_file = stdout;
590     argv = parse_options( argc, argv, spec );
591
592     switch(exec_mode)
593     {
594     case MODE_DLL:
595         if (spec->subsystem != IMAGE_SUBSYSTEM_NATIVE)
596             spec->characteristics |= IMAGE_FILE_DLL;
597         if (!spec_file_name) fatal_error( "missing .spec file\n" );
598         if (spec->type == SPEC_WIN32 && spec->main_module)  /* embedded 16-bit module */
599         {
600             spec->type = SPEC_WIN16;
601             load_resources( argv, spec );
602             if (parse_input_file( spec )) BuildSpec16File( spec );
603             break;
604         }
605         /* fall through */
606     case MODE_EXE:
607         load_resources( argv, spec );
608         load_import_libs( argv );
609         if (spec_file_name && !parse_input_file( spec )) break;
610         read_undef_symbols( spec, argv );
611         switch (spec->type)
612         {
613             case SPEC_WIN16:
614                 output_spec16_file( spec );
615                 break;
616             case SPEC_WIN32:
617                 BuildSpec32File( spec );
618                 break;
619             default: assert(0);
620         }
621         break;
622     case MODE_DEF:
623         if (argv[0]) fatal_error( "file argument '%s' not allowed in this mode\n", argv[0] );
624         if (spec->type == SPEC_WIN16) fatal_error( "Cannot yet build .def file for 16-bit dlls\n" );
625         if (!spec_file_name) fatal_error( "missing .spec file\n" );
626         if (!parse_input_file( spec )) break;
627         BuildDef32File( spec );
628         break;
629     case MODE_RELAY16:
630         if (argv[0]) fatal_error( "file argument '%s' not allowed in this mode\n", argv[0] );
631         BuildRelays16();
632         break;
633     case MODE_RELAY32:
634         if (argv[0]) fatal_error( "file argument '%s' not allowed in this mode\n", argv[0] );
635         BuildRelays32();
636         break;
637     case MODE_RESOURCES:
638         load_resources( argv, spec );
639         output_res_o_file( spec );
640         break;
641     default:
642         usage(1);
643         break;
644     }
645     if (nb_errors) exit(1);
646     if (output_file_name)
647     {
648         if (fclose( output_file ) < 0) fatal_perror( "fclose" );
649         if (output_file_source_name) assemble_file( output_file_source_name, output_file_name );
650         output_file_name = NULL;
651     }
652     return 0;
653 }