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