[project @ 1999-10-05 10:30:26 by simonmar]
[ghc-hetmet.git] / ghc / driver / ghc.lprl
1 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1997
2 %
3
4 This is the driver script for the Glasgow Haskell compilation system.
5 It is written in \tr{perl}.  The first section includes a long
6 ``usage'' message that describes how the driver is supposed to work.
7
8 %************************************************************************
9 %*                                                                      *
10 \section[Driver-usage]{Usage message}
11 %*                                                                      *
12 %************************************************************************
13
14 \begin{code}
15 ($Pgm = $0) =~ s|.*/||;
16 $ShortUsage  =  "\nUsage: For basic information, try the `-help' option.\n";
17 $LongUsage = "\n" . <<EOUSAGE;
18 Use of the Glorious Haskell Compilation System driver:
19
20     $Pgm [command-line-options-and-input-files]
21
22 ------------------------------------------------------------------------
23 This driver ($Pgm) guides each input file through (some of the)
24 possible phases of a compilation:
25
26     - unlit:    extract code from a "literate program"
27     - hscpp:    run code through the C pre-processor (if -cpp flag given)
28     - hsc:      run the Haskell compiler proper
29     - gcc:      run the C compiler (if compiling via C)
30     - as:       run the assembler
31     - ld:       run the linker
32
33 For each input file, the phase to START with is determined by the
34 file's suffix:
35     - .lhs      literate Haskell: unlit
36     - .hs       illiterate Haskell: hsc
37     - .hc       C from the Haskell compiler: gcc
38     - .c        C not from the Haskell compiler: gcc
39     - .s        assembly language: as
40     - other     passed directly to the linker: ld
41
42 If no files are given on the command line, input is taken from
43 standard input, and processing is as for an .hs file.  (All output is
44 to stdout or stderr, however).
45
46 The phase at which to STOP processing is determined by a command-line
47 option:
48     -E          stop after generating preprocessed, de-litted Haskell (used in conjunction with -cpp)
49     -C          stop after generating C (.hc output)
50     -S          stop after generating assembler (.s output)
51     -c          stop after generating object files (.o output)
52
53 Other commonly-used options are:
54
55     -O          An `optimising' package of compiler flags, for faster code
56
57     -prof       Compile for cost-centre profiling
58                 (add -auto for automagic cost-centres on top-level functions)
59
60     -fglasgow-exts  Allow Glasgow extensions (unboxed types, etc.)
61
62     -H14m       Increase compiler's heap size
63
64     -M          Output the Makefile rules recording the
65                 dependencies of a list of Haskell files.
66                 (ghc driver script calls upon the help of a
67                  compatible mkdependHS script to do the actual
68                  processing)
69
70 The User's Guide has more information about GHC's *many* options.
71
72 Given the above, here are some TYPICAL invocations of $Pgm:
73
74     # compile a Haskell module to a .o file, optimising:
75     % $Pgm -c -O Foo.hs
76     # link three .o files into an executable called "test":
77     % $Pgm -o test Foo.o Bar.o Baz.o
78     # compile a Haskell module to C (a .hc file), using a bigger heap:
79     % $Pgm -C -H16m Foo.hs
80     # compile Haskell-produced C (.hc) to assembly language:
81     % $Pgm -S Foo.hc
82 ------------------------------------------------------------------------
83 EOUSAGE
84 \end{code}
85
86 %************************************************************************
87 %*                                                                      *
88 \section[Driver-init]{Initialisation}
89 %*                                                                      *
90 %************************************************************************
91
92 The driver script need to be told where to find these executables, so
93 in the course of building the driver `executable', make-variables holding
94 these are prepended to the de-litted version of this file. The variables are:
95
96 \begin{verbatim}
97 INSTALLING
98
99 HOSTPLATFORM TARGETPLATFORM
100
101 ProjectName ProjectVersion ProjectVersionInt
102
103 HscMajorVersion HscMinorVersion CcMajorVersion CcMinorVersion
104
105 TOP_PWD
106
107 bindir libdir libexecdir datadir
108
109 CURRENT_DIR TMPDIR
110
111 GHC_LIB_DIR GHC_RUNTIME_DIR GHC_INCLUDE_DIR
112
113 GHC_OPT_HILEV_ASM GhcWithNativeCodeGen
114
115 GHC_UNLIT GHC_HSCPP GHC_MKDEPENDHS GHC_HSC GHC_SYSMAN
116
117 CP RM CONTEXT_DIFF
118
119 WAY_*_NAME WAY_*_REAL_OPTS
120
121 LeadingUnderscore
122
123 GhcWithRegisterised
124
125 \end{verbatim}
126
127 Establish what executables to run for the various phases, what the
128 default options are for those phases, and other similar boring stuff.
129
130 \begin{code}
131 select(STDERR); $| = 1; select(STDOUT); # no STDERR buffering, please.
132
133 $TargetPlatform = $TARGETPLATFORM;
134
135 $TopPwd            = "${TOP_PWD}";
136 $InstBinDirGhc     = "${bindir}";
137 $InstLibDirGhc     = "${libdir}";
138 #
139 # Normally the same as InstLibDirGhc, but we accommodate
140 # for it being separate.
141 #
142 $InstLibExecDirGhc = "${libexecdir}";
143 $InstDataDirGhc    = "${datadir}";
144
145 $Status  = 0; # just used for exit() status
146 $Verbose = '';
147
148 # set up signal handler
149 sub quit_upon_signal { &tidy_up_and_die(1, ''); }
150 $SIG{'INT'}  = 'quit_upon_signal';
151 $SIG{'QUIT'} = 'quit_upon_signal';
152
153 # where to get "require"d .prl files at runtime (poor man's dynamic loading)
154 #   (use LIB, not DATA, because we can't be sure of arch-independence)
155 @INC = ( ( $INSTALLING ) ? $InstLibDirGhc
156                            : "$TopPwd/${CURRENT_DIR}" );
157
158 if ( $ENV{'TMPDIR'} ) { # where to make tmp file names
159     $Tmp_prefix = ($ENV{'TMPDIR'} . "/ghc$$");
160 } else {
161     print STDERR "TMPDIR has not been set to anything useful!\n" if (${TMPDIR} eq '');
162     $Tmp_prefix ="${TMPDIR}/ghc$$"; # TMPDIR set via Makefile when booting..
163     $ENV{'TMPDIR'} = ${TMPDIR}; # set the env var as well
164 }
165
166 # Some shells run into real trouble when command line and environment
167 # gets big (e.g., cmd lines of >4K to /bin/sh causes havoc on our 
168 # Solaris-2.5.1 boxes - even though sysconf(_SC_ARG_MAX) reports 1M ...).
169 # To work around any such */bin/sh* problems, we will scribble such
170 # awfully long command lines into a temp file and exec that temp file
171 # with $(REAL_SHELL) (don't use the SHELL variable directly as this
172 # will normally get you the wrong thing when the driver is invoked
173 # from within `make'). If the REAL_SHELL variable isn't set, you'll
174 # get SHELL. This is all a terrible hack. (in case you hadn't reached
175 # the same conclusion by now :-)
176 #
177 # TBC..
178 #
179 if ( ! $ENV{'REAL_SHELL'} ) {
180     $ENV{'REAL_SHELL'} = $ENV{'SHELL'};
181 }
182
183 @Files_to_tidy = (); # files we nuke in the case of abnormal termination
184
185 $Unlit = ( $INSTALLING ) ? "$InstLibExecDirGhc/unlit"
186                          : "$TopPwd/${CURRENT_DIR}/${GHC_UNLIT}";
187
188 $Cp   = $CP;
189 $Rm   = $RM;
190 $Diff = $CONTEXT_DIFF;
191 $Cat  = 'cat';
192 $Cmp  = 'cmp';
193 $Time = '';
194
195 $HsCpp   = # but this is re-set to "cat" (after options) if -cpp not seen
196            ( $INSTALLING ) ? "$InstLibExecDirGhc/hscpp"
197                            : "$TopPwd/${CURRENT_DIR}/${GHC_HSCPP}";
198
199 @HsCpp_flags    = ();
200 $HsC     = ( $INSTALLING ) ? "$InstLibExecDirGhc/hsc"
201                            : "$TopPwd/${CURRENT_DIR}/${GHC_HSC}";
202
203 # For PVM fiends only
204 $SysMan  = ( $INSTALLING ) ? "$InstLibExecDirGhc/SysMan"
205                            : "$TopPwd/${CURRENT_DIR}/${GHC_SYSMAN}";
206
207 @Unlit_flags    = ();
208
209 #
210 # HsC_rts_flags: if we want to talk to the LML runtime system
211 # NB: we don't use powers-of-2 sizes, because this may do
212 #   terrible things to cache behavior.
213 #
214 $Specific_heap_size = 6 * 1000 * 1000;
215 $Specific_stk_size  = 1000 * 1000;
216 $Scale_sizes_by     = 1.0;
217
218 \end{code}
219
220 The variables set by @setupOptFlags@ represent parts of the
221 -O/-O2/etc ``templates,'' which are filled in later, using these.
222 These are the default values, which may be changed by user flags.
223
224 \begin{code}
225 sub setupOptFlags {
226    $Oopt_MaxSimplifierIterations  = '-fmax-simplifier-iterations4';
227    $Oopt_PedanticBottoms          = '-fpedantic-bottoms'; # ON by default
228    $Oopt_FinalStgProfilingMassage = '';
229    $Oopt_StgStats                 = '';
230    $Oopt_DoSpecialise             = '-fspecialise';
231    $Oopt_FoldrBuild               = 0; # *Off* by default!
232    $Oopt_UsageSPInf               = ''; # Off by default
233 } # end of setupOptFlags
234
235 # Assign defaults to these right away.
236 &setupOptFlags();
237 \end{code}
238
239 Things to do with C compilers/etc:
240
241 (added -Wimplicit: implicit prototypes cause very hard-to-find
242 problems, so I'm turing on the warnings -- SDM 4/5/98)
243
244 \begin{code}
245 $CcRegd         = $GHC_OPT_HILEV_ASM;
246 @CcBoth_flags   = ('-S','-Wimplicit');   # flags for *any* C compilation
247 @CcInjects      = ();
248
249 # GCC flags: 
250 #    those for all files, 
251 #    those only for .c files;
252 #    those only for .hc files
253
254 @CcRegd_flags    = ();
255 @CcRegd_flags_c  = ();
256 @CcRegd_flags_hc = ();
257
258 $As              = ''; # "assembler" is normally GCC
259 @As_flags        = ();
260
261 $Lnkr            = ''; # "linker" is normally GCC
262 @Ld_flags        = ();
263 @Dll_flags       = ();
264
265 # 'nm' is used for consistency checking (ToDo: mk-world-ify)
266 # ToDo: check the OS or something ("alpha" is surely not the crucial question)
267 $Nm = ($TargetPlatform =~ /^alpha-/) ? 'nm -B' : 'nm';
268 \end{code}
269
270 Warning packages that are controlled by -W and -Wall.  The 'standard'
271 warnings that you get all the time are
272         
273         -fwarn-overlapping-patterns
274         -fwarn-missing-methods
275         -fwarn-duplicate-exports
276
277 these are turned off by -Wnot.
278
279 \begin{code}
280 @StandardWarnings = ('-fwarn-overlapping-patterns', 
281                      '-fwarn-missing-methods',
282                      '-fwarn-missing-fields',
283                      '-fwarn-duplicate-exports');
284 @MinusWOpts       = (@StandardWarnings, 
285                      '-fwarn-unused-binds',
286                      '-fwarn-unused-matches',
287                      '-fwarn-incomplete-patterns', 
288                      '-fwarn-unused-imports');
289 @MinusWallOpts    = (@MinusWOpts, 
290                      '-fwarn-type-defaults',
291                      '-fwarn-name-shadowing',
292                      '-fwarn-missing-signatures');
293 \end{code}
294
295 What options \tr{-user-setup-a} turn into (user-defined ``packages''
296
297 of options).  Note that a particular user-setup implies a particular
298 Prelude ({\em including} its interface file(s)).
299 \begin{code}
300 $BuildTag       = ''; # default is sequential build w/ Appel-style GC
301
302 %BuildDescr     = (# system ways begin
303                    '',      'Normal Sequential',
304                    '_p',    "Profiling",
305                    '_t',    "Ticky-ticky Profiling",
306                    '_u',    "Unregisterised",
307                    '_mp',   "Parallel",
308                    '_mg',   "Gransim",
309                    # system ways end
310                    '_a',    "$WAY_a_NAME",
311                    '_b',    "$WAY_b_NAME",
312                    '_c',    "$WAY_c_NAME",
313                    '_d',    "$WAY_d_NAME",
314                    '_e',    "$WAY_e_NAME",
315                    '_f',    "$WAY_f_NAME",
316                    '_g',    "$WAY_g_NAME",
317                    '_h',    "$WAY_h_NAME",
318                    '_i',    "$WAY_i_NAME",
319                    '_j',    "$WAY_j_NAME",
320                    '_k',    "$WAY_k_NAME",
321                    '_l',    "$WAY_l_NAME",
322                    '_m',    "$WAY_m_NAME",
323                    '_n',    "$WAY_n_NAME",
324                    '_o',    "$WAY_o_NAME",
325                    '_A',    "$WAY_A_NAME",
326                    '_B',    "$WAY_B_NAME" );
327
328 # these are options that are "fed back" through the option processing loop
329 #
330 %SetupOpts = 
331        (
332         '_a', "$WAY_a_REAL_OPTS",
333         '_b', "$WAY_b_REAL_OPTS",
334         '_c', "$WAY_c_REAL_OPTS",
335         '_d', "$WAY_d_REAL_OPTS",
336         '_e', "$WAY_e_REAL_OPTS",
337         '_f', "$WAY_f_REAL_OPTS",
338         '_g', "$WAY_g_REAL_OPTS",
339         '_h', "$WAY_h_REAL_OPTS",
340         '_i', "$WAY_i_REAL_OPTS",
341         '_j', "$WAY_j_REAL_OPTS",
342         '_k', "$WAY_k_REAL_OPTS",
343         '_l', "$WAY_l_REAL_OPTS",
344         '_m', "$WAY_m_REAL_OPTS",
345         '_n', "$WAY_n_REAL_OPTS",
346         '_o', "$WAY_o_REAL_OPTS",
347         '_A', "$WAY_A_REAL_OPTS",
348         '_B', "$WAY_B_REAL_OPTS",
349
350         # system ways
351         '_p',  "-fscc-profiling -DPROFILING -optc-DPROFILING",
352         '_t',  "-fticky-ticky -DTICKY_TICKY -optc-DTICKY_TICKY",
353         '_u',  "-optc-DNO_REGS -optc-DUSE_MINIINTERPRETER -fno-asm-mangling -funregisterised",
354         '_mp', "-fstack-check -fparallel -D__PARALLEL_HASKELL__ -optc-DPAR",
355         '_mg', "-fstack-check -fconcurrent -fgransim -D__GRANSIM__ -D__CONCURRENT_HASKELL__ -optc-DCONCURRENT -optc-DGRAN");
356
357 # where to look for interface files (system hi's, i.e., prelude and syslibs)
358 @SysImport_dir  = ( $INSTALLING )
359                     ? ( "$InstLibDirGhc/imports/std" )
360                     : ( "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/std" );
361
362 # We need to look in ghc/ and glaExts/ when searching for implicitly needed .hi files, but 
363 # we should really *not* look there for explicitly imported modules.
364
365 $Haskell1Version = 5; # i.e., Haskell 1.4
366 @Cpp_define      = ();
367
368 # Cpp symbols defined when we're processing Haskell source.
369
370 @HsSourceCppOpts = 
371         ( "-D__HASKELL__=98"
372         , "-D__HASKELL1__=$Haskell1Version"
373         , "-D__GLASGOW_HASKELL__=$ProjectVersionInt"
374         , "-D__HASKELL98__"
375         , "-D__CONCURRENT_HASKELL__"
376         );
377
378
379 @SysLibrary_dir = ( ( $INSTALLING )     #-syslib things supplied by the system
380                     ? $InstLibDirGhc
381                     : ( "$TopPwd/$CURRENT_DIR/$GHC_RUNTIME_DIR"
382                       , "$TopPwd/$CURRENT_DIR/$GHC_RUNTIME_DIR/gmp"
383                       , "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/std"
384                       , "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/std/cbits"
385                       )
386                   );
387
388 # make depend for Haskell
389 $MkDependHS
390         = ( $INSTALLING ) ? "$InstLibExecDirGhc/mkdependHS"
391                           : "$TopPwd/$CURRENT_DIR/$GHC_MKDEPENDHS";
392 # Fill in later
393 @MkDependHS_flags = ();
394
395 # do_link flag should not be reset while rescanning the cmd-line.
396 $Do_lnkr    = 1;
397 $Specific_output_dir = '';      # set by -odir <dir>
398 $Specific_output_file = '';     # set by -o <file>; "-" for stdout
399 \end{code}
400
401 Function to initialise the per-compilation-unit globals that
402 are used to guide and control the invocation of the different phases.
403
404 \begin{code} 
405 sub initDriverGlobals {
406
407 # reset the following options:
408 # RTS flags to use while compiling
409 @HsC_rts_flags      = ();
410 @HsC_flags      = ();
411 @HsC_antiflags  = ();
412 \end{code}
413
414 The optimisations/etc to be done by the compiler are {\em normally}
415 expressed with a \tr{-O} (or \tr{-O2}) flag, or by its absence.
416
417 \begin{code}
418 $OptLevel      = 0; # no -O == 0; -O == 1; -O2 == 2; -Ofile == 3
419 $MinusO2ForC   = 0; # set to 1 if -O2 should be given to C compiler
420 $StolenX86Regs = 4; # **HACK*** of the very worst sort
421 $CoreLint      = '';
422 $USPLint       = '';
423 $StgLint       = '';
424
425 # The SplitMarker is the string/character used to mark end of element
426 # in import lists.
427 $SplitMarker    = ':';
428 @Import_dir     = ('.'); #-i things
429 @Include_dir    = ('.'); #-I things; other default(s) stuck on AFTER option processing
430
431 @UserLibrary_dir= ();   #-L things;...
432 @UserLibrary    = ();   #-l things asked for by the user
433
434 @SysLibrary = (); # will be built up as we go along
435 \end{code}
436
437 We are given a list of files with various presumably-known suffixes
438 (unknown-suffix files go straight to the linker).  For each file, we
439 begin by assuming that we'll run every phase over it.  However: (1)
440 global flags (\tr{-c}, \tr{-S}, etc.) tell us not to run any phase
441 past a certain point; and (2) the file's suffix tells us what phase to
442 start with.  Linking is weird and kept track of separately.
443
444 Here are the initial defaults applied to all files:
445 \begin{code}
446 $Cpp_flag_set = 0;        # (hack)
447 $Only_preprocess_C = 0;   # pretty hackish
448 $Only_preprocess_hc = 0;  # ditto
449 $Only_generate_deps = 0;  # ""
450 $Only_generate_dll  = 0;
451 $PostprocessCcOutput = 0;
452
453 # Win32 only:
454 #    static = 0 => produce code for DLLs (when compiling & linking.)
455 $Static = 1;
456 $Static = 0 if ($EnableWin32DLLs eq 'YES');
457
458 # native code-gen or via C?
459 $HaveNativeCodeGen = $GhcWithNativeCodeGen;
460 $HscOut = '-C='; # '-C=' ==> .hc output; '-S=' ==> .s output; '-N=' ==> neither
461 $HscOut = '-S='
462     if ($HaveNativeCodeGen ne 'YES') && $TargetPlatform =~ /^(alpha)-/;
463 # TEMP: disable x86 & Sparc if $HaveNativeCodeGen && $TargetPlatform =~ /^(i386|alpha|sparc)-/;
464 $ProduceHi    = '-hifile=';
465 $HiOnStdout   = 0;
466 $HiWith       = '';
467 $HiDiff_flag  = '';
468 $Keep_HiDiffs = 0;
469
470 $CollectingGCstats = 0;
471 $CollectGhcTimings = 0;
472 $DEBUGging = '';        # -DDEBUG and all that it entails (um... not really)
473 $PROFing = '';          # set to p or e if profiling
474 $PROFgroup = '';        # set to group if an explicit -Ggroup specified
475 $PROFauto = '';         # set to relevant hsc flag if -auto or -auto-all
476 $PROFcaf  = '';         # set to relevant hsc flag if -caf-all
477 $PROFdict = '';         # set to relevant hsc flag if -auto-dicts
478 $PROFignore_scc = '';   # set to relevant parser flag if explicit sccs ignored
479 $UNPROFscc_auto = '';   # set to relevant hsc flag if forcing auto sccs without profiling
480 $TICKYing = '';         # set to t if compiling for ticky-ticky profiling
481 $PARing = '';           # set to p if compiling for PAR
482 $GRANing = '';          # set to g if compiling for GRAN
483 $UNREGing = ($GhcWithRegisterised eq 'YES') ? '' : 'u';
484 $Specific_hi_file = '';         # set by -ohi <file>; "-" for stdout
485 $Specific_dump_file = '';       # set by -odump <file>; "-" for stdout
486 $Using_dump_file = 0;
487 $Isuffix    = '';
488 $Osuffix    = '';       # default: use the normal suffix for that kind of output
489 $HiSuffix   = 'hi';
490 $HiSuffix_prelude = '';
491 $CompilingPrelude=0;
492 $Do_recomp_chkr = 0;    # don't use the recompilatio checker unless asked
493 $Do_cc      = -1;   # a MAGIC indeterminate value; will be set to 1 or 0.
494 $Do_as      = 1;
495
496 $Keep_hc_file_too = 0;
497 $Keep_s_file_too = 0;
498 $UseGhcInternals = 0; # if 1, may use GHC* modules
499 $SplitObjFiles = 0;
500 $DoAsmMangling = 1; # on by default, off by -fno-asm-mangling
501 $NoOfSplitFiles = 0;
502 $Dump_parser_output = 0;
503 $Dump_raw_asm = 0;
504 $Dump_asm_splitting_info = 0;
505 $NoImplicitPrelude = 0;
506 # 1 => don't tell the linker to hoist in PrelMain.Main, as an 
507 # external main is provided instead.
508 $NoHaskellMain=0;
509
510 } # end of initDriverGlobals (Sigh)
511
512 # we split the argv passed to the driver into three:
513
514 # the list of files
515 @Input_file = ();
516
517 # and files to be linked...
518 @Link_file  = ();
519
520 # and whatever else
521 @Cmd_opts  = ();
522
523 # cmd line options prefixing the unit we're compiling
524 @File_options = ();
525
526 \end{code}
527
528 We inject consistency-checking information into \tr{.hc} files (both
529 when created by the Haskell compiler and when compiled by the C
530 compiler), so that we can check that an executable is made from
531 consistently-built pieces.  (The check is normally done just after
532 linking.)  The checking is done by introducing/munging
533 \tr{what(1)}-style strings.  Anyway, here are the relevant global
534 variables and their defaults:
535 \begin{code}
536 $LinkChk = 0;   # set to 0 if the link check should *not* be done
537
538 # major & minor version numbers; major numbers must always agree;
539 # minor disagreements yield a warning.
540 $HsC_major_version = $HscMajorVersion;
541 $HsC_minor_version = $HscMinorVersion;
542 $Cc_major_version  = $CcMajorVersion;
543 $Cc_minor_version  = $CcMinorVersion;
544
545 # options: these must always agree
546 $HsC_consist_options = '';    # we record, in this order:
547                               #     Build tag; debugging?
548 $Cc_consist_options  = '';    # we record, in this order:
549                               #     Build tag; debugging?
550 \end{code}
551
552 %************************************************************************
553 %*                                                                      *
554 \section[Driver-parse-argv]{Munge the command-line options}
555 %*                                                                      *
556 %************************************************************************
557
558 Now slurp through the arguments.
559 \begin{code}
560
561 &initDriverGlobals();
562 &splitCmdLine(@ARGV);
563 # Run through the cmd-line first time.
564 &processArgs(@Cmd_opts);
565
566 # Check to see if driver is only in the business
567 # to generate dependencies
568 if (  $Status == 0 && $Only_generate_deps ) {
569
570     push (@MkDependHS_flags, "-o$Osuffix") if $Osuffix;
571     push (@MkDependHS_flags, "-s$BuildTag") if $BuildTag;
572     # They're not (currently) needed, but we need to quote any -#include options
573     foreach (@Cmd_opts) {
574         s/-#include.*$/'$&'/g;
575     };
576     local($to_do) = "$MkDependHS @MkDependHS_flags @HsSourceCppOpts -- @Cmd_opts -- @Input_file" ;
577     &run_something($to_do, 'Haskell dependencies');
578     exit $Status;
579 }
580
581 # ..or just to construct a (Haskell) DLL.
582 if (  $Status == 0 && $Only_generate_dll && $EnableWin32DLLs ) {
583
584     &createWin32DLL();
585     exit $Status;
586 }
587
588 # if there are several input files,
589 # we don't allow \tr{-o <file>} or \tr{-ohi <file>} options...
590 # (except if linking, of course)
591
592 if ($#Input_file > 0 && ( ! $Do_lnkr )) {
593     if ( ($Specific_output_file ne '' && $Specific_output_file ne '-')
594       || ($Specific_hi_file ne ''     && $Specific_hi_file ne '-') ) {
595         print STDERR "$Pgm: You can't use -o or -ohi options if you have multiple input files.\n";
596         print STDERR "\tPerhaps the -odir option will do what you want.\n";
597         $Status++;
598     }
599 }
600
601 # check for various pathological -o and -odir combinations...
602 if ($Specific_output_dir ne '' && $Specific_output_file ne '') {
603     if ($Specific_output_file eq '-') {
604         print STDERR "$Pgm: can't set output directory with -ohi AND have output to stdout\n";
605         $Status++;
606     } else { # amalgamate...
607         $Specific_output_file = "$Specific_output_dir/$Specific_output_file";
608         # ToDo: check we haven't got a junk name now...
609         $Specific_output_dir  = ''; # reset
610     }
611 }
612
613 # crash and burn if there were errors
614 if ( $Status > 0 ) {
615     print STDERR $ShortUsage;
616     exit $Status;
617 }
618 \end{code}
619
620 %************************************************************************
621 %*                                                                      *
622 \section[Driver-post-argv-mangling]{Setup after reading options}
623 %*                                                                      *
624 %************************************************************************
625
626 %************************************************************************
627 %*                                                                      *
628 \subsection{Set up for optimisation level (\tr{-O} or whatever)}
629 %*                                                                      *
630 %************************************************************************
631
632 We come now to the default ``wads of options'' that are turned on by
633 \tr{-O0} (do min optimisation), \tr{-O} (ordinary optimisation),
634 \tr{-O2} (aggressive optimisation), or no O-ish flag (compile speed is
635 more important).
636
637 The user can also specify his/her own list of options in a file; in
638 that case, the work is already done (see stuff about @minusO3@,
639 earlier...).
640
641 GHC allows very precise control of what happens during a compilation.
642 Core-to-Core and STG-to-STG passes can be run in any order, as many
643 times as you like.  Individual transformations can be turned on or
644 disabled.
645
646 Sadly, however, there are some interdependencies \& Things You Must
647 Not Do.  Here is the list.
648
649 CORE-TO-CORE PASSES:
650 \begin{description}
651 \item[\tr{-fspecialise}:]
652 The specialiser must have dependency-analysed input; but if you run
653 the simplifier to do this, you must not let it toss away unused
654 bindings!  (The typechecker conveys some specialisation info via
655 ``unused'' bindings...)
656
657 \item[\tr{-ffloat-inwards}:]
658 Floating inwards should be done before strictness analysis, because
659 the latter will give better results.
660
661 \item[\tr{-fstatic-args}:]
662 The static-arguments-transformation pass {\em must} have the
663 simplifier run right after it.
664
665 \item[\tr{-fcalc-inlinings[12]}:]
666 Not required, but there may be slight gains by re-simplifying after
667 this is done.  (You could then \tr{-fcalc-inlinings} again, just for
668 fun.)
669
670 \item[\tr{-ffull-laziness}:]
671 The (outwards-)let-floater should be the {\em last} Core-to-Core pass
672 that's run.  (Um, well, howzabout the simplifier just once more...)
673 \end{description}
674
675 STG-TO-STG PASSES:
676 \begin{description}
677 \item[\tr{-fupdate-analysis}:]
678 It really really wants to be the last STG-to-STG pass that is run.
679 \end{description}
680
681 \begin{code}
682
683 sub setupOptimiseFlags {
684
685         # this pass-ordering sequence was agreed by Simon and Andr\'e
686         # (WDP 94/07, 94/11).
687
688    @HsC_minusNoO_flags 
689     = ( 
690         '-fsimplify',
691           '[', 
692                 '-finline-phase2',
693                 $Oopt_MaxSimplifierIterations,
694           ']',
695
696         $Oopt_AddAutoSccs,
697         $Oopt_FinalStgProfilingMassage
698       );
699
700    @HsC_minusO_flags # NOTE: used for *both* -O and -O2 (some conditional bits)
701     = (
702         '-ffoldr-build-on',
703
704         '-fdo-eta-reduction',
705         '-fdo-lambda-eta-expansion',
706         '-fcase-of-case',
707         '-fcase-merge',
708         '-flet-to-case',
709         $Oopt_PedanticBottoms,
710
711         # initial simplify: mk specialiser happy: minimum effort please
712
713         '-fsimplify',
714           '[', 
715                 '-finline-phase0',      # Don't inline anything till full laziness has bitten
716                                         # In particular, inlining wrappers inhibits floating
717                                         # e.g. ...(case f x of ...)...
718                                         #  ==> ...(case (case x of I# x# -> fw x#) of ...)...
719                                         #  ==> ...(case x of I# x# -> case fw x# of ...)...
720                                         # and now the redex (f x) isn't floatable any more
721                 '-fmax-simplifier-iterations2',
722           ']',
723
724         # Specialisation is best done before full laziness
725         # so that overloaded functions have all their dictionary lambdas manifest
726         ($Oopt_DoSpecialise) ? ( $Oopt_DoSpecialise, ) : (),
727         '-ffull-laziness',
728         '-ffloat-inwards',
729
730 #       '-fsimplify',
731 #         '[', 
732 #               # Run the simplifier before specialising, so that overloaded functions
733 #               # look like             f = \d -> ...
734 #               # (Full laziness may lift out something hiding the \d
735 #               '-finline-phase1',
736 #               '-fmax-simplifier-iterations1',
737 #         ']',
738
739
740         '-fsimplify',
741           '[', 
742                 '-finline-phase1',
743                 # Want to run with inline phase 1 after the specialiser to give
744                 # maximum chance for fusion to work before we inline build/augment
745                 # in phase 2.  This made a difference in 'ansi' where an overloaded
746                 # function wasn't inlined till too late.
747                 $Oopt_MaxSimplifierIterations,  
748           ']',
749
750         $Oopt_UsageSPInf, # infer usage information here in case we need it later.
751                           # (add more of these where you need them --KSW 1999-04)
752
753         '-fsimplify',
754           '[', 
755                 # Need inline-phase2 here so that build/augment get 
756                 # inlined.  I found that spectral/hartel/genfft lost some useful
757                 # strictness in the function sumcode' if augment is not inlined
758                 # before strictness analysis runs
759
760                 '-finline-phase2',
761                 $Oopt_MaxSimplifierIterations,  
762           ']',
763
764
765         '-fstrictness',
766         '-fcpr-analyse',
767         '-fworker-wrapper',
768
769         '-fsimplify',
770           '[', 
771                 $Oopt_MaxSimplifierIterations,  
772                 # No -finline-phase: allow all Ids to be inlined now
773           ']',
774
775         '-fcse',        # CSE must immediately follow a simplification pass, because it relies
776                         # on the no-shadowing invariant.  See comments at the top of CSE.lhs
777                  
778         '-ffull-laziness',      # nofib/spectral/hartel/wang doubles in speed if you
779                                 # do full laziness late in the day.  It only happens
780                                 # after fusion and other stuff, so the early pass doesn't
781                                 # catch it.  For the record, the redex is 
782                                 #       f_el22 (f_el21 r_midblock)
783         '-ffloat-inwards',
784
785 # Case-liberation for -O2.  This should be after
786 # strictness analysis and the simplification which follows it.
787
788 #       ( ($OptLevel != 2)
789 #        ? ''
790 #       : "-fliberate-case -fsimplify [ $Oopt_FB_Support -ffloat-lets-exposing-whnf -ffloat-primops-ok -fcase-of-case -fdo-case-elim -fcase-merge -fdo-lambda-eta-expansion -freuse-con -flet-to-case $Oopt_PedanticBottoms $Oopt_MaxSimplifierIterations $Oopt_ShowSimplifierProgress ]" ),
791
792 # Final clean-up simplification:
793
794         '-fsimplify',
795           '[', 
796                 $Oopt_MaxSimplifierIterations,  
797                 # No -finline-phase: allow all Ids to be inlined now
798           ']',
799
800       # '-fstatic-args',
801
802       # stg2stg passes
803 #       '-flambda-lift',
804         $Oopt_FinalStgProfilingMassage,
805         $Oopt_StgStats,
806
807       # flags for stg2stg
808         '-flet-no-escape',
809
810       # SPECIAL FLAGS for -O2
811         ($OptLevel == 2) ? (
812           '-fupdate-analysis',  # virtually useless; relegated to -O2
813           '-fsemi-tagging',
814         ) : (),
815       );
816
817 \end{code}
818
819 Sort out what we're going to do about optimising.  First, the @hsc@
820 flags and regular @cc@ flags to worry about:
821 \begin{code}
822 if ( $OptLevel <= 0 ) {
823
824     # for this level, we tell the parser -fignore-interface-pragmas
825     push(@HsC_flags, '-fignore-interface-pragmas');
826     # and tell the compiler not to produce them
827     push(@HsC_flags, '-fomit-interface-pragmas');
828
829     &add_Hsc_flags( @HsC_minusNoO_flags );
830     push(@CcBoth_flags, ($MinusO2ForC) ? '-O2' : '-O'); # not optional!
831
832 } elsif ( $OptLevel == 1 || $OptLevel == 2 ) {
833
834     &add_Hsc_flags( @HsC_minusO_flags );
835     push(@CcBoth_flags, ($MinusO2ForC || $OptLevel == 2) ? '-O2' : '-O'); # not optional!
836     # -O? to GCC is not optional! -O2 probably isn't worth it generally,
837     # but it *is* useful in compiling the garbage collector.
838
839 } else { # -Ofile, then...
840
841     &add_Hsc_flags( @HsC_minusO3_flags );
842     push(@HsC_flags, $Oopt_FinalStgProfilingMassage) if $Oopt_FinalStgProfilingMassage;
843
844     push(@CcBoth_flags, ($MinusO2ForC) ? '-O2' : '-O'); # possibly to be elaborated...
845 }
846
847 } # setupOptimiseFlags
848
849 \end{code}
850
851 %************************************************************************
852 %*                                                                      *
853 \subsection{Check for consistency, etc.}
854 %*                                                                      *
855 %************************************************************************
856
857 Sort out @$BuildTag@, @$PROFing@, @$PARing@,
858 @$GRANing@, @$TICKYing@, @UNREGing@:
859 \begin{code}
860 sub setupBuildFlags {
861
862
863    # PROFILING stuff after argv mangling:
864    if ( ! $PROFing ) {
865      # add -auto sccs even if not profiling !
866      push(@HsC_flags, $UNPROFscc_auto) if $UNPROFscc_auto;
867
868    } else {
869       push(@HsC_flags, $PROFauto) if $PROFauto;
870       push(@HsC_flags, $PROFcaf)  if $PROFcaf;
871       push(@HsC_flags, $PROFdict) if $PROFdict;
872
873       $Oopt_FinalStgProfilingMassage = '-fmassage-stg-for-profiling';
874
875       # Ignore user sccs when auto annotating, but warn when doing so.
876       $PROFignore_scc = '-W' if $PROFauto; 
877   }
878   #if ( $BuildTag ne '' ) {
879   #    local($b) = $BuildDescr{$BuildTag};
880   #    if ($PARing    eq 'p') { print STDERR "$Pgm: Can't mix $b with -parallel.\n"; exit 1; }
881   #    if ($GRANing   eq 'g') { print STDERR "$Pgm: Can't mix $b with -gransim.\n"; exit 1; }
882   #    if ($TICKYing  eq 't') { print STDERR "$Pgm: Can't mix $b with -ticky.\n"; exit 1; }
883
884   #    # ok to have a user-way profiling build
885   #    # eval the profiling opts ... but leave user-way BuildTag 
886   #    if ($PROFing   eq 'p') { &processArgs(split(' ', $SetupOpts{'_p'})); } # eval($EvaldSetupOpts{'_p'}); }
887
888   if ( $PROFing eq 'p' ) {
889       if ($PARing   eq 'p') { print STDERR "$Pgm: Can't do profiling with -parallel.\n"; exit 1; }
890       if ($GRANing  eq 'g') { print STDERR "$Pgm: Can't do profiling with -gransim.\n"; exit 1; }
891       if ($TICKYing eq 't') { print STDERR "$Pgm: Can't do profiling with -ticky.\n"; exit 1; }
892       $BuildTag = '_p' ;
893
894   } elsif ( $PARing eq 'p' ) {
895       if ($GRANing  eq 'g') { print STDERR "$Pgm: Can't mix -parallel with -gransim.\n"; exit 1; }
896       if ($TICKYing eq 't') { print STDERR "$Pgm: Can't mix -parallel with -ticky.\n"; exit 1; }
897       $BuildTag = '_mp';
898
899       if ( $Do_lnkr && ( ! $ENV{'PVM_ROOT'} || ! $ENV{'PVM_ARCH'} )) {
900           print STDERR "$Pgm: both your PVM_ROOT and PVM_ARCH environment variables must be set for linking under -parallel.\n";
901           exit(1);
902       }
903
904   } elsif ( $GRANing eq 'g' ) {
905       if ($TICKYing eq 't') { print STDERR "$Pgm: Can't mix -gransim with -ticky.\n"; exit 1; }
906       $BuildTag = '_mg';
907
908   } elsif ( $TICKYing eq 't' ) {
909       $BuildTag = '_t';
910
911   } elsif ( $UNREGing eq 'u' ) {
912       if ($GhcWithRegisterised eq 'YES') {
913          $BuildTag = '_u';
914       }
915   }
916 \end{code}
917
918 After the sanity checks, add flags to the necessary parts of the driver pipeline:
919
920 \begin{code}
921   if ( $BuildTag ne '' ) { # something other than normal sequential...
922
923       local($Tag) = "${BuildTag}";
924       $Tag =~ s/_//;  # move the underscore to the back
925
926       $HscOut = '-C='; # must go via C
927       &processArgs(split(' ', $SetupOpts{$BuildTag}));
928 #      eval($EvaldSetupOpts{$BuildTag});
929   }
930 \end{code}
931
932 Decide what the consistency-checking options are in force for this run:
933 \begin{code}
934
935   $HsC_consist_options = "${BuildTag},${DEBUGging}";
936   $Cc_consist_options  = "${BuildTag},${DEBUGging}";
937
938   #
939   # Funny place to put it, but why not.
940   #
941   if ( $HiSuffix_prelude eq '' ) {
942
943        if ($CompilingPrelude) {
944          $HiSuffix_prelude = "$HiSuffix" if $CompilingPrelude;
945        } else {
946          local($Tag) = "${BuildTag}";
947   
948          $Tag =~ s/_//;
949          $Tag =  "${Tag}_" if $Tag ne '';
950          $HiSuffix_prelude="${Tag}hi";
951        }
952   }
953 } # setupBuildFlags
954 \end{code}
955
956 %************************************************************************
957 %*                                                                      *
958 \subsection{Add on machine-specific C-compiler flags}
959 %*                                                                      *
960 %************************************************************************
961
962 Shove on magical machine-specific options.  We use \tr{unshift} to
963 stick them on the {\em front} of the arrays, so that ``later''
964 user-specified flags can clobber them (e.g., \tr{-U__STG_REV_TBLS__}).
965
966 Note: a few ``always apply'' flags were set at the very beginning.
967
968 \begin{code}
969 sub setupMachOpts {
970
971   if ($TargetPlatform =~ /^alpha-/) {
972       unshift(@CcBoth_flags,  ('-static'));
973
974   } elsif ($TargetPlatform =~ /^hppa/) {
975       unshift(@CcBoth_flags,  ('-static'));
976       #
977       # We don't put in '-mlong-calls', because it's only
978       # needed for very big modules (sigh), and we don't want
979       # to hobble ourselves further on all the other modules
980       # (most of them).
981       #  
982       # [Dated comment (gcc-2.6.x?), -mlong-calls is no longer
983       #  a supported gcc HPPA flag]
984       unshift(@CcBoth_flags,  ('-D_HPUX_SOURCE'));
985         # ___HPUX_SOURCE, not _HPUX_SOURCE, is #defined if -ansi!
986         # (very nice, but too bad the HP /usr/include files don't agree.)
987
988   } elsif ($TargetPlatform =~ /^i386-/) {
989       # -fno-defer-pop : basically the same game as for m68k
990       #
991       # -fomit-frame-pointer : *must* in .hc files; because we're stealing
992       #  the fp (%ebp) for our register maps.
993
994       unshift(@CcRegd_flags_hc, '-fno-defer-pop');
995       unshift(@CcRegd_flags_hc, '-fomit-frame-pointer');
996       unshift(@CcRegd_flags,    "-DSTOLEN_X86_REGS=$StolenX86Regs");
997       
998       unshift(@CcBoth_flags,  ('-DDONT_WANT_WIN32_DLL_SUPPORT')) if ($Static);
999
1000   } elsif ($TargetPlatform =~ /^m68k-/) {
1001       # -fno-defer-pop : for the .hc files, we want all the pushing/
1002       #    popping of args to routines to be explicit; if we let things
1003       #    be deferred 'til after an STGJUMP, imminent death is certain!
1004       #
1005       # -fomit-frame-pointer : *don't*
1006       #    It's better to have a6 completely tied up being a frame pointer
1007       #    rather than let GCC pick random things to do with it.
1008       #    (If we want to steal a6, then we would try to do things
1009       #    as on iX86, where we *do* steal the frame pointer [%ebp].)
1010
1011       unshift(@CcRegd_flags_hc, '-fno-defer-pop');
1012       unshift(@CcRegd_flags,    '-fno-omit-frame-pointer');
1013         # maybe gives reg alloc a better time
1014         # also: -fno-defer-pop is not sufficiently well-behaved without it
1015
1016   } elsif ($TargetPlatform =~ /^mips-/) {
1017       unshift(@CcBoth_flags,  ('-static'));
1018
1019   } elsif ($TargetPlatform =~ /^powerpc-|^rs6000-/) {
1020       unshift(@CcBoth_flags,  ('-static')); # always easier to start with
1021       unshift(@CcRegd_flags, ('-finhibit-size-directive')); # avoids traceback tables
1022   } elsif ($TargetPlatform =~ /^sparc-/) {
1023   }
1024 } # end of setupMachOpts
1025 \end{code}
1026
1027 %************************************************************************
1028 %*                                                                      *
1029 \subsection{Set up for warnings}
1030 %*                                                                      *
1031 %************************************************************************
1032
1033 Several warnings are turned on by default.  These are supposed to be
1034 the 'I'm pretty sure you've made a mistake here' kind of warnings.
1035 The rest are turned on by the -W and -Wall options, or individually
1036 via their -fwarn and -fno-warn flags.
1037
1038 \begin{code}
1039 sub setupWarningFlags {
1040 &add_Hsc_flags( @StandardWarnings );
1041 }
1042 \end{code}
1043
1044 Same unshifting magic, but for special linker flags.
1045
1046 The configure script determines whether the object file symbol tables
1047 have a leading underscore, and sets @LeadingUnderscore@ accordingly.
1048 (The driver script `sees' the setting of the @LeadingUnderscore@
1049 by having the Makefile prepend it).
1050
1051 \begin{code}
1052 sub setupLinkOpts {
1053   local($uscore) = ( ${LeadingUnderscore} eq 'YES' ) ? '_' : '';
1054
1055   unshift(@Ld_flags,
1056         (($Ld_main) ? ( '-u', "${uscore}Main_" . $Ld_main . '_closure' ) : ()));
1057
1058   # things that are referenced by the RTS - make sure that we pull 'em in
1059   unshift(@Ld_flags,
1060          ( '-u', "${uscore}PrelBase_Izh_static_info"
1061           ,'-u', "${uscore}PrelBase_Czh_static_info"
1062           ,'-u', "${uscore}PrelBase_Fzh_static_info"
1063           ,'-u', "${uscore}PrelBase_Dzh_static_info"
1064           ,'-u', "${uscore}PrelAddr_Azh_static_info"
1065           ,'-u', "${uscore}PrelAddr_Wzh_static_info"
1066           ,'-u', "${uscore}PrelAddr_I64zh_static_info"
1067           ,'-u', "${uscore}PrelAddr_W64zh_static_info"
1068           ,'-u', "${uscore}PrelStable_StablePtr_static_info"
1069           ,'-u', "${uscore}PrelBase_Izh_con_info"
1070           ,'-u', "${uscore}PrelBase_Czh_con_info"
1071           ,'-u', "${uscore}PrelBase_Fzh_con_info"
1072           ,'-u', "${uscore}PrelBase_Dzh_con_info"
1073           ,'-u', "${uscore}PrelAddr_Azh_con_info"
1074           ,'-u', "${uscore}PrelAddr_Wzh_con_info"
1075           ,'-u', "${uscore}PrelAddr_I64zh_con_info"
1076           ,'-u', "${uscore}PrelAddr_W64zh_con_info"
1077           ,'-u', "${uscore}PrelStable_StablePtr_con_info"
1078           ,'-u', "${uscore}PrelBase_False_static_closure"
1079           ,'-u', "${uscore}PrelBase_True_static_closure"
1080           ,'-u', "${uscore}PrelPack_unpackCString_closure"
1081           ,'-u', "${uscore}PrelException_stackOverflow_closure"
1082           ,'-u', "${uscore}PrelException_heapOverflow_closure"
1083           ,'-u', "${uscore}PrelException_NonTermination_static_closure"
1084         ));
1085   if (!$NoHaskellMain) {
1086    unshift (@Ld_flags,'-u', "${uscore}PrelMain_mainIO_closure");
1087   }
1088   if ($TargetPlatform =~ /^powerpc-|^rs6000-/) {
1089     # sometimes we have lots of toc entries...
1090     #  unshift(@Ld_flags, ('-Xlinker -bbigtoc -Xlinker -bnoquiet')); 
1091     unshift(@Ld_flags, ('-Xlinker -bbigtoc')); 
1092   }
1093
1094
1095 } # end of setupLinkOpts
1096
1097 \end{code}
1098
1099 %************************************************************************
1100 %*                                                                      *
1101 \subsection{Set up include paths and system-library enslurpment}
1102 %*                                                                      *
1103 %************************************************************************
1104
1105 Now that we know what garbage-collector, etc., are required, we can
1106 finalise our list of libraries to slurp through, and generally Get
1107 Ready for Business.
1108
1109 \begin{code}
1110 sub setupIncPaths {
1111   # default includes must be added AFTER option processing
1112   if ( ! $INSTALLING ) {
1113       push (@Include_dir, "$TopPwd/${CURRENT_DIR}/${GHC_INCLUDE_DIR}");
1114   } else {
1115       push (@Include_dir, "$InstLibDirGhc/includes");
1116       push (@Include_dir, "$InstLibDirGhc/includes");
1117   }
1118 } # end of setupIncPaths
1119 \end{code}
1120
1121 \begin{code}
1122 sub setupSyslibs {
1123   push(@SysLibrary, ( '-lHS', '-lHS_cbits' )); # basic I/O and prelude stuff
1124
1125   local($f);
1126   foreach $f (@SysLibrary) {
1127       next if $f =~ /_cbits/;
1128       $f .= $BuildTag if $f =~ /^-lHS/;
1129   }
1130
1131   # Push library HSrts, plus boring clib bit
1132   push(@SysLibrary, "-lHSrts${BuildTag}");
1133
1134   #
1135   # RTS compiled with cygwin32, uses the WinMM API
1136   # to implement the itimers, since cygwin.dll does not
1137   # support it. Only reqd. for `ways' that use itimers.
1138   #
1139   push(@SysLibrary, '-lwinmm')   if ($TargetPlatform =~ /-(mingw32|cygwin32)$/);
1140    # Note: currently only tested with mingw, may cause conflicts when linking
1141    #       with libcygwin.a
1142   push(@SysLibrary, '-lwsock32') if ($TargetPlatform =~ /-(mingw32|cygwin32)$/);
1143
1144   # Push the pvm libraries
1145   if ($BuildTag eq '_mp') {
1146       $pvmlib = "$ENV{'PVM_ROOT'}/lib/$ENV{'PVM_ARCH'}";
1147       push(@SysLibrary, "-L$pvmlib", '-lgpvm3', '-lpvm3');
1148       if ( $ENV{'PVM_ARCH'} eq 'SUNMP' ) {
1149           push(@SysLibrary, '-lthread', '-lsocket', '-lnsl');
1150       } elsif ( $ENV{'PVM_ARCH'} eq 'SUN4SOL2' ) {
1151           push(@SysLibrary, '-lsocket', '-lnsl');
1152       }
1153   }
1154
1155 # Push the GNU multi-precision arith lib; and the math library
1156
1157 # If this machine has GMP already installed, then we'll get the installed
1158 # lib here, because presumably the one in the tree won't have been built.
1159
1160 if ($LibGmp eq 'not-installed') {
1161   push(@SysLibrary, "-lgmp");
1162 } else {
1163   push(@SysLibrary, "-l$LibGmp");
1164 }
1165
1166 push(@SysLibrary, '-lm') if !( $TargetPlatform =~ /^.*(cygwin32|mingw32)$/ );
1167 \end{code}
1168
1169 %************************************************************************
1170 %*                                                                      *
1171 \subsection{Check that this system was built to do what we are asking}
1172 %*                                                                      *
1173 %************************************************************************
1174
1175 Before continuing we check that the appropriate build is available.
1176
1177 \begin{code}
1178 #die "$Pgm: no BuildAvail?? $BuildTag\n" if $BuildDescr{$BuildTag} eq '' ; # sanity
1179
1180 if ( $BuildDescr{$BuildTag} eq '' ) {
1181     print STDERR "$Pgm: a `", $BuildDescr{$BuildTag},
1182         "' \"build\" is not available with your GHC setup.\n";
1183     print STDERR "(It was not configured for it at your site.)\n";
1184     print STDERR $ShortUsage;
1185     exit 1;
1186 }
1187
1188 } # end of setupSyslibs
1189
1190 \end{code}
1191
1192 %************************************************************************
1193 %*                                                                      *
1194 \subsection{Final miscellaneous setup bits before we start going}
1195 %*                                                                      *
1196 %************************************************************************
1197
1198 Record largest specific heapsize, if any.
1199 \begin{code}
1200 sub setupHeapStackSize {
1201    $Specific_heap_size = $Specific_heap_size * $Scale_sizes_by;
1202    push(@HsC_rts_flags, '-H'.$Specific_heap_size);
1203    $Specific_stk_size = $Specific_stk_size * $Scale_sizes_by;
1204    push(@HsC_rts_flags, "-K$Specific_stk_size");
1205 }
1206 \end{code}
1207
1208 If no input or link files seen, then we let 'em feed in stdin; this is
1209 mainly for debugging.
1210
1211 \begin{code}
1212
1213 if ($#Input_file < 0 && $#Link_file < 0) {
1214     @Input_file = ( '-' );
1215
1216     open(INF, "> $Tmp_prefix.hs") || &tidy_up_and_die(1,"Can't open $Tmp_prefix.hs\n");
1217     print STDERR "Enter your Haskell program, end with ^D (on a line of its own):\n" if -t;
1218     while (<STDIN>) { print INF $_; }
1219     close(INF) || &tidy_up_and_die(1,"Failed writing to $Tmp_prefix.hs\n");
1220 }
1221
1222 \end{code}
1223
1224 Tell the world who we are, if they asked.
1225 \begin{code}
1226 print STDERR "${ProjectName}, version ${ProjectVersion}\n" if $Verbose;
1227 \end{code}
1228
1229 %************************************************************************
1230 %*                                                                      *
1231 \section[Driver-main-loop]{Main loop: Process input files, and link if required}
1232 %*                                                                      *
1233 %************************************************************************
1234
1235 Process the input files; don't continue with linking if there are
1236 problems (global variable @$Status@ non-zero).
1237 \begin{code}
1238 foreach $ifile (@Input_file) {
1239     &ProcessInputFile($ifile);
1240 }
1241
1242 # don't link if there were errors...
1243 if ( $Status > 0 ) { 
1244     print STDERR $ShortUsage;
1245     &tidy_up();
1246     exit $Status;
1247 }
1248
1249 # Link if appropriate.
1250 &runLinker() if $Do_lnkr;
1251
1252 # that...  that's all, folks!
1253 &tidy_up();
1254 exit $Status; # will still be 0 if all went well
1255 \end{code}
1256
1257 %************************************************************************
1258 %*                                                                      *
1259 \section[Driver-do-one-file]{How to process a single input file}
1260 %*                                                                      *
1261 %************************************************************************
1262
1263 \begin{code}
1264 sub ProcessInputFile {
1265     local($ifile) = @_;   # input file name
1266     local($ifile_root);   # root of or basename of input file
1267     local($ofile_target); # ultimate output file we hope to produce
1268                           # from input file (need to know for recomp
1269                           # checking purposes)
1270     local($hifile_target);# ditto (but .hi file)
1271     local($ofile_c_stub_target); 
1272     local($ofile_h_stub_target); 
1273 \end{code}
1274
1275 Handle the weirdity of input from stdin.
1276 \begin{code}
1277     if ($ifile ne '-') {
1278         ($ifile_root  = $ifile) =~ s/\.[^\.\/]+$//;
1279         $ofile_target = # may be reset later...
1280                         ($Specific_output_file ne '' && ! $Do_lnkr)
1281                         ? $Specific_output_file
1282                         : &odir_ify($ifile_root, 'o');
1283         $hifile_target= ($Specific_hi_file ne '')
1284                         ? $Specific_hi_file
1285                         : "$ifile_root.$HiSuffix"; # ToDo: odirify?
1286                         # NB: may change if $ifile_root isn't module name (??)
1287         ($ofile_c_stub_target = $ifile) =~s/\.[^\.\/]+$/_stub.c/;
1288         ($ofile_h_stub_target = $ifile) =~s/\.[^\.\/]+$/_stub.h/;
1289     } else {
1290         $ifile = "$Tmp_prefix.hs"; # we know that's where we put the input
1291         $ifile_root   = '_stdin';
1292         $ofile_target = '_stdout'; # gratuitous?
1293         $hifile_target= '_stdout'; # ditto?
1294     }
1295 \end{code}
1296
1297 We need to decide what phases of the compilation system we will run
1298 over this file.  The defaults are the ones established when processing
1299 flags.  (That established what the last phase run for all files is.)
1300
1301 We do the pre-recompilation-checker phases here; the rest later.
1302 \begin{code}
1303 \end{code}
1304
1305 Look at the suffix and decide what initial phases of compilation may
1306 be dropped off for this file.  Also the rather boring business of
1307 which files are coming-in/going-out.
1308
1309 Again, we'll do the post-recompilation-checker parts of this later.
1310 \begin{code}
1311     local($do_lit2pgm)  = ($ifile =~ /\.lhs$/) ? 1 : 0;
1312     local($do_hscpp)    = 1; # but "hscpp" might really be "cat"
1313     local($do_hsc)      = 1;
1314
1315     # names of the files to stuff between phases
1316     # defaults are temporaries
1317     local($in_lit2pgm)    = $ifile;
1318     local($lit2pgm_hscpp) = "$Tmp_prefix.lpp";
1319     local($hscpp_hsc)     = "$Tmp_prefix.cpp";
1320     local($hsc_hi)        = "$Tmp_prefix.hi";
1321     local($cc_as_o)       = "${Tmp_prefix}_o.s"; # temporary for raw .s file if opt C
1322     local($cc_as)         = "$Tmp_prefix.s";     # mangled or hsc-produced .s code
1323     local($as_out)        = $ofile_target;
1324
1325     local($is_hc_file) = 1; #Is the C code .hc or .c? Assume .hc for now
1326
1327     # OK, let's strip off some literate junk..
1328     if ($do_lit2pgm) {
1329         &runLit2pgm($in_lit2pgm, $lit2pgm_hscpp)
1330     } else {
1331         $lit2pgm_hscpp = $ifile;
1332     }
1333
1334     #
1335     @File_options = ();
1336
1337     # Scan the top of the de-litted file for {-# OPTIONS #-} pragmas
1338     &check_for_source_options($lit2pgm_hscpp,$ifile);
1339
1340     # Options found in the source file take a back seat, i.e., we scan
1341     # them first. Only process the command line again if source file
1342     # contained anything of interest *or* there's more than one
1343     # input file (we have to reset the options).
1344     #
1345     if ( $#Input_file >= 0 || $#File_options >= 0) {
1346         #@File_options = (@File_options, @Cmd_opts);
1347
1348         # Now process the command line
1349         &initDriverGlobals();
1350         &processArgs((@File_options,@Cmd_opts));
1351         print STDERR "\nEffective command line: " .
1352                      join(' ',(@File_options,@Cmd_opts)) . "\n" if $Verbose;
1353     }
1354     #
1355     # Having got the effective command line scanned, set up
1356     # the various options in prep for some real work.
1357     #
1358     # check the sanity of the BuildTag we're about to use,
1359     # and if needs be, add some more flags and setup to
1360     # the different phases.
1361     #
1362     &setupBuildFlags();
1363     &setupOptimiseFlags();
1364     &setupMachOpts();
1365     &setupIncPaths();
1366     &setupWarningFlags();
1367     &setupHeapStackSize();
1368
1369     #
1370     # These two variables need to be set after the
1371     # command-line has been processed and the build options
1372     # have be seen set up. This is because command-line options
1373     # can control whether to compile vias C or not.
1374     # 
1375     local($do_cc)       = ( $Do_cc != -1) # i.e., it was set explicitly
1376                           ? $Do_cc
1377                           : ( ($HscOut eq '-C=') ? 1 : 0 );
1378     local($do_as)       = $Do_as;
1379     local($hsc_out)        = ( $HscOut eq '-C=' ) ? "$Tmp_prefix.hc" : "$Tmp_prefix.s" ;
1380     local($hsc_out_c_stub) = ( $HscOut eq '-C=' ) ? "${Tmp_prefix}_stb.c" : "";
1381     local($hsc_out_h_stub) = ( $HscOut eq '-C=' ) ? "${Tmp_prefix}_stb.h" : "";
1382
1383     if ($Only_preprocess_hc) { # stop after having run $Cc -E
1384        $do_as=0;
1385     }
1386     if ($Only_preprocess_C)     { # stop after having run $hscpp
1387        $do_hsc=0; $do_cc = 0; $do_as=0;
1388     } elsif ($ifile =~ /.lhs$/ || $ifile =~ /.hs$/ ) {
1389        ;
1390     } elsif ($ifile =~ /\.hc$/ || $ifile =~ /_hc$/ ) { # || $ifile =~ /\.$Isuffix$/o) # ToDo: better
1391         $do_hscpp = 0; $do_hsc = 0; $do_cc = 1;
1392         $hsc_out = $ifile;
1393         $hsc_out_c_stub = '';
1394         $hsc_out_h_stub = '';
1395     } elsif ($ifile =~ /\.c$/) {
1396         $do_hscpp = 0; $do_hsc = 0; $do_cc = 1;
1397         $hsc_out = $ifile; $is_hc_file = 0;
1398         $hsc_out_c_stub = '';
1399         $hsc_out_h_stub = '';
1400     } elsif ($ifile =~ /\.[sS]$/) {
1401         $do_hscpp = 0; $do_hsc = 0; $do_cc = 0;
1402         $cc_as = $ifile;    
1403     } else { # don't know what it is, but nothing to do herein...
1404         $do_hscpp = 0; $do_hsc = 0; $do_cc = 0; $do_as = 0;
1405     }
1406
1407     # hack to avoid running hscpp
1408     $HsCpp = $Cat if ! $Cpp_flag_set;
1409
1410     &runHscpp($in_lit2pgm, $lit2pgm_hscpp, $hscpp_hsc) if $do_hscpp;
1411
1412 \end{code}
1413
1414 We now think about whether to run hsc/cc or not (when hsc produces .s
1415 stuff, it effectively takes the place of both phases).
1416 To get the output file name right: for each phase that we are {\em
1417 not} going to run, set its input (i.e., the output of its preceding
1418 phase) to @"$ifile_root.<suffix>"@.
1419
1420 \begin{code}
1421     local($going_interactive) = $HscOut eq '-N=' || $ifile_root eq '_stdin';
1422
1423     #
1424     # Warning issued if -keep-hc-file-too is used without
1425     # -fvia-C (or the equivalent)
1426     #
1427     if ( $HscOut ne '-C=' && $Keep_hc_file_too ) {
1428         print STDERR "$Pgm: warning: Native code generator to be used, -keep-hc-file-too will be ignored\n";
1429     }
1430
1431     if (! $do_cc && ! $do_as) { # stopping after hsc
1432         $hsc_out = ($Specific_output_file ne '')
1433                  ? $Specific_output_file
1434                  : &odir_ify($ifile_root, ($HscOut eq '-C=') ? 'hc' : 's');
1435
1436         $ofile_target = $hsc_out; # reset
1437     }
1438
1439     if (! $do_as) { # stopping after gcc (or hsc)
1440         $cc_as = ($Specific_output_file ne '')
1441                  ? $Specific_output_file
1442                  : &odir_ify($ifile_root, ( $Only_preprocess_hc ) ? 'i' : 's');
1443
1444         $ofile_target = $cc_as; # reset
1445     }
1446
1447 \end{code}
1448
1449
1450 Now the Haskell compiler, C compiler, and assembler
1451
1452 \begin{code}
1453    if ($do_hsc) {
1454         &runHscAndProcessInterfaces( $ifile, $hscpp_hsc, $ifile_root, 
1455                                      $ofile_target, $hifile_target,
1456                                      $going_interactive);
1457     }
1458
1459     if (-f $hsc_out_h_stub) {
1460         &run_something("cp $hsc_out_h_stub $ofile_h_stub_target", 'Copy foreign export header file');
1461     }
1462
1463     if (-f $hsc_out_c_stub) {
1464         &run_something("rm -f $ofile_c_stub_target && echo '#include \"${ofile_h_stub_target}\"' > $ofile_c_stub_target && cat $hsc_out_c_stub >> $ofile_c_stub_target", 'Copy foreign export C stubs');
1465         local ($hsc_out_s_stub);
1466         local ($hsc_out_o_stub);
1467         ($ofile_s_stub_target = $ofile_c_stub_target) =~ s/\.(.*)$/\.s/;
1468         ($ofile_o_stub_target = $ofile_c_stub_target) =~ s/\.(.*)$/\.o/;
1469         if ($do_cc) {
1470           &runGcc    (0, $ofile_c_stub_target, $ofile_s_stub_target);
1471           &runAs     ($ofile_o_stub_target, $ofile_s_stub_target);
1472         }
1473         #
1474         # Bring the C stub protos into scope when compiling the .hc file.
1475         #
1476         push (@CcInjects, "#include \"${hsc_out_h_stub}\"\n");
1477         # Hack - ensure that the stub .h file is included in the OPTIONS section
1478         #        if the .hc file is saved.
1479         push (@File_options, "-#include \"${ofile_h_stub_target}\"\n");
1480         
1481     }
1482
1483     if ($do_cc) {
1484         &runGcc    ($is_hc_file, $hsc_out, $cc_as_o);
1485         &runMangler($is_hc_file, $cc_as_o, $cc_as, $ifile_root) if ! $Only_preprocess_hc;
1486     }
1487
1488     &split_asm_file($cc_as)  if $do_as && $SplitObjFiles;
1489
1490     # save a copy of the .s file..
1491     &saveIntermediate($ifile_root , "s" , $cc_as) if ($do_as && $Keep_s_file_too);
1492     &runAs($as_out, $ifile_root) if $do_as;
1493 \end{code}
1494
1495 Finally, decide what to queue up for linker input.
1496 \begin{code}
1497     # tentatively assume we will eventually produce linker input:
1498     push(@Link_file, &odir_ify($ifile_root, 'o'));
1499
1500 #ToDo:    local($or_isuf) = ($Isuffix eq '') ? '' : "|$Isuffix";
1501
1502     if ( $ifile !~ /\.(lhs|hs|hc|c|s|a|S)$/ && $ifile !~ /_hc$/ ) {
1503         # There's sometimes confusion regarding .hi files; users
1504         # supplying them on the command line.
1505         if ( $ifile =~ /\.hi$/ ) {
1506             print STDERR "$Pgm: warning: found `$ifile' on command line; interface files should not be supplied here - ignoring it.\n";
1507         } else {
1508            print STDERR "$Pgm: don't recognise suffix on `$ifile'; passing it through to linker\n";
1509         }
1510         # oops; we tentatively pushed the wrong thing; fix & do the right thing
1511         pop(@Link_file); push(@Link_file, $ifile);
1512     }
1513
1514
1515 } # end of ProcessInputFile
1516 \end{code}
1517
1518 %************************************************************************
1519 %*                                                                      *
1520 \section[Driver-run-phases]{Routines to run the various phases}
1521 %*                                                                      *
1522 %************************************************************************
1523
1524 \begin{code}
1525 sub runLit2pgm {
1526     local($in_lit2pgm, $lit2pgm_hscpp) = @_;
1527
1528     local($to_do) = "";
1529
1530     # Only add #line pragma if we're going to need it.
1531     $to_do  = "echo '#line 1 \"$in_lit2pgm\"' > $lit2pgm_hscpp && " if ($Cpp_flag_set);
1532     $to_do .= "$Unlit @Unlit_flags $in_lit2pgm -  >> $lit2pgm_hscpp";
1533      
1534     push(@Files_to_tidy, $lit2pgm_hscpp );
1535
1536     &run_something($to_do, 'literate pre-processor');
1537 }
1538 \end{code}
1539
1540 \begin{code}
1541 sub runHscpp {
1542     local($in_lit2pgm, $lit2pgm_hscpp, $hscpp_hsc) = @_;
1543
1544     local($to_do) = "";
1545
1546     # Strictly speaking, echoing of the following line pragma is only required
1547     # on non-delit'ed input, as we've already added it during de-lit. However,
1548     # hscpp will then add a {-# LINE 1 "$lit2pgm_hsc" -} to the top of the file,
1549     # which is not very informative (but harmless). Hence, we uniformly have
1550     # {-# LINE 1 "$in_lit2pgm" #-} as the first line to all cpp'ed hsc input.
1551     #
1552     $to_do = "echo '{-# LINE 1 \"$in_lit2pgm\" -}' > $hscpp_hsc && ";
1553
1554     if ($HsCpp eq $Cat) {
1555         $to_do .= "$HsCpp $lit2pgm_hscpp >> $hscpp_hsc";
1556         push(@Files_to_tidy, $hscpp_hsc );
1557         &run_something($to_do, 'Ineffective C pre-processor');
1558     } else {
1559         local($includes) = '-I' . join(' -I',@Include_dir);
1560         $to_do .= "$HsCpp $Verbose @HsCpp_flags @HsSourceCppOpts $includes $lit2pgm_hscpp >> $hscpp_hsc";
1561         push(@Files_to_tidy, $hscpp_hsc );
1562         &run_something($to_do, 'Haskellised C pre-processor');
1563     }
1564    
1565     if ( $Only_preprocess_C ) {
1566         $to_do = "$Cat $hscpp_hsc";
1567         &run_something($to_do, '');
1568     }
1569
1570 }
1571 \end{code}
1572
1573
1574 \begin{code}
1575 sub runHscAndProcessInterfaces {
1576     local($ifile, $hscpp_hsc, $ifile_root, 
1577           $ofile_target, $hifile_target,
1578           $going_interactive) = @_;
1579
1580         # $ifile                is the original input file
1581         # $hscpp_hsc            post-unlit, post-cpp, etc., input file
1582         # $ifile_root           input filename minus suffix
1583         # $ofile_target         the output file that we ultimately hope to produce
1584         # $hifile_target        the .hi file ... (ditto)
1585         
1586     local($source_unchanged) = 1;
1587
1588     # Check if the source file is up to date relative to the target; in
1589     # that case we say "source is unchanged" and let the compiler bail out
1590     # early if the import usage information allows it.
1591
1592     ($i_dev,$i_ino,$i_mode,$i_nlink,$i_uid,$i_gid,$i_rdev,$i_size,
1593      $i_atime,$i_mtime,$i_ctime,$i_blksize,$i_blocks) = stat($ifile);
1594
1595     # The informational messages below are now conditional on -v being set -- SOF
1596     if ( $ofile_target ne "_stdin.s" && ! -f $ofile_target ) {
1597         print STDERR "$Pgm:compile:Output file $ofile_target doesn't exist\n" if $Verbose;
1598         $source_unchanged = 0;
1599     }
1600
1601     ($o_dev,$o_ino,$o_mode,$o_nlink,$o_uid,$o_gid,$o_rdev,$o_size,
1602      $o_atime,$o_mtime,$o_ctime,$o_blksize,$o_blocks) = stat(_); # stat info from -f test
1603
1604     if ( $hifile_target ne "_stdout" && ! -f $hifile_target ) {
1605         print STDERR "$Pgm:compile:Interface file $hifile_target doesn't exist\n" if $Verbose;
1606         $source_unchanged = 0;
1607     }
1608
1609     ($hi_dev,$hi_ino,$hi_mode,$hi_nlink,$hi_uid,$hi_gid,$hi_rdev,$hi_size,
1610      $hi_atime,$hi_mtime,$hi_ctime,$hi_blksize,$hi_blocks) = stat(_); # stat info from -f test
1611
1612     if ( $ofile_target ne "_stdin.s" && $i_mtime > $o_mtime) {
1613         print STDERR "$Pgm:recompile:Input file $ifile newer than $ofile_target\n" if $Verbose;
1614         $source_unchanged = 0;
1615     }
1616
1617     # Tell the compiler which version we're using
1618     push(@HsC_flags, "-fhi-version=${ProjectVersionInt}");
1619
1620     # So if source_unchanged is still "1", we pass on the good news to the compiler
1621     # The -recomp flag can disable this, forcing recompilation
1622     if ($Do_recomp_chkr && $source_unchanged) {
1623         push(@HsC_flags, '-fsource-unchanged'); 
1624     }   
1625
1626     # Indicate whether we're static or not.
1627     # This will only ever 
1628     push(@HsC_flags, '-static') if $Static;
1629
1630     # Run the compiler
1631
1632     &runHsc($ifile_root, $hsc_out, $hsc_hi, $hsc_out_c_stub, $hsc_out_h_stub, $going_interactive);
1633
1634    # See if it bailed out early, saying nothing needed doing.  
1635    # We work this out by seeing if it created an output .hi file
1636
1637     if ( ! -f $hsc_hi && $ProduceHi !~ /-nohifile=/ ) {
1638         # Doesn't exist, so we bailed out early.
1639         # Tell the C compiler and assembler not to run
1640         $do_cc = 0; $do_as = 0;
1641
1642         # Update dependency info, touch both object file and 
1643         # interface file, so that the following invariant is
1644         # maintained:
1645         #
1646         #   a dependent module's interface file should after recompilation
1647         #   checking be newer than the interface files of its imports. 
1648         #
1649         # That is, if module A's interface file changes, then module B
1650         # (which import from A) needs to be checked.
1651         # If A's change does not affect B, which causes the compiler to bail
1652         # out early, we still need to touch the interface file of B. The reason
1653         # for this is that B may export A's interface.
1654         #
1655         &run_something("touch $ofile_target",
1656                        "Touch $ofile_target,  to propagate dependencies") if $HscOut ne '-N=';
1657         &run_something("touch $hifile_target", 
1658                        "Touch $hifile_target,  to propagate dependencies") if $ProduceHi =~ /-nohifile=/ ;
1659
1660     } else {    
1661
1662      # Didn't bail out early (new .hi file) so we thunder on
1663     
1664         # If non-interactive, heave in the consistency info at the end
1665         # NB: pretty hackish (depends on how $output is set)
1666         if ( ! $going_interactive ) {
1667             if ( $HscOut eq '-C=' ) {
1668             $to_do = "echo 'static char ghc_hsc_ID[] = \"\@(#)hsc $ifile\t$HsC_major_version.$HsC_minor_version,$HsC_consist_options\";' >> $hsc_out";
1669     
1670             } elsif ( $HscOut eq '-S=' ) {
1671                 local($consist) = "hsc.$ifile.$HsC_major_version.$HsC_minor_version.$HsC_consist_options";
1672                 $consist =~ s/,/./g;
1673                 $consist =~ s/\//./g;
1674                 $consist =~ s/-/_/g;
1675                 $consist =~ s/[^A-Za-z0-9_.]/ZZ/g; # ToDo: properly?
1676                 $to_do = "echo '\n\t.text\n$consist:' >> $hsc_out";
1677             }
1678             &run_something($to_do, 'Pin on Haskell consistency info');  
1679         }   
1680
1681
1682         # Interface-handling is important enough to live off by itself
1683         if ( $ProduceHi !~ /-nohifile=/ ) { # If we've produced one, process it.
1684            require('ghc-iface.prl') || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-iface.prl!\n");
1685            &postprocessHiFile($hsc_hi, $hifile_target, $going_interactive);
1686         }
1687         # if we're going to split up object files,
1688         # we inject split markers into the .hc file now
1689         if ( $HscOut eq '-C=' && $SplitObjFiles ) {
1690             &inject_split_markers ( $hsc_out );
1691         }
1692
1693         # save a copy of the .hc file, even if we are carrying on...
1694         if ($HscOut eq '-C=' && $do_cc && $Keep_hc_file_too) {
1695             &saveIntermediate($ifile_root , "hc" , $hsc_out);
1696         }
1697
1698     }
1699 }
1700 \end{code}
1701
1702
1703 \begin{code}
1704 sub runHsc {
1705     local($ifile_root, $hsc_out, $hsc_hi, $hsc_out_c_stub, $hsc_out_h_stub, $going_interactive) = @_;
1706
1707     &makeHiMap() unless $HiMapDone;
1708     push(@HsC_flags, "\"-himap=$HiIncludeString\"");
1709     push(@HsC_flags, "\"-himap-sep=${SplitMarker}\"");
1710
1711     # here, we may produce .hc/.s and/or .hi files
1712     local($output) = '';
1713     #@Files_to_tidy = ();
1714
1715     if ( $going_interactive ) {
1716         # don't need .hi unless we're going to show it on stdout:
1717         $ProduceHi = '-nohifile=' if ! ($HiOnStdout || $Specific_hi_file ne '' );
1718         $do_cc = 0; $do_as = 0; $Do_lnkr = 0; # and we won't go any further...
1719     }
1720
1721     # set up for producing output/.hi; note that flag twiddling
1722     # may mean that nothing will actually be produced:
1723     $output = "$ProduceHi$hsc_hi $HscOut$hsc_out -F=$hsc_out_c_stub -FH=$hsc_out_h_stub";
1724     push(@Files_to_tidy, $hsc_hi, $hsc_out, $hsc_out_c_stub, $hsc_out_h_stub );
1725
1726     # if we're compiling foo.hs, we want the GC stats to end up in foo.stat
1727     if ( $CollectingGCstats ) {
1728         push(@HsC_rts_flags, "-S$ifile_root.stat");
1729         push(@Files_to_tidy, "$ifile_root.stat");
1730     }
1731
1732     if ( $CollectGhcTimings ) { # assume $RTS_style eq 'ghc'
1733         # emit nofibbish time/bytes-alloc stats to stderr;
1734         # see later .stat file post-processing
1735         print STDERR "warning: both -Rgc-stats and -Rghc-timing used, -Rghc-timing wins." if $CollectingGCstats;
1736         push(@HsC_rts_flags, "-S$Tmp_prefix.stat");
1737         push(@Files_to_tidy, "$Tmp_prefix.stat");
1738     }
1739
1740     local($dump) = '';
1741     if ($Specific_dump_file ne '') {
1742         $dump = "2>> $Specific_dump_file";
1743         $Using_dump_file = 1;
1744     }
1745
1746     local($to_do);
1747     # Win32 only: If the command processor used by system()
1748     # exec()s the application as an ordinary Win32 executable,
1749     # we're in trouble here, since the command line is likely
1750     # to be > 255 chars long. To work around this situation,
1751     # $HsC also understands `at-files',  i.e., `@file' on the
1752     # command line will cause $HsC to add the contents of `file'
1753     # to the command line.
1754     #
1755     #  [ Note: support for `at-files' is not compiled in by default ]
1756     $cmd_line_opts_via_at_file=0;
1757     if ($cmd_line_opts_via_at_file) {
1758
1759       local($to_do_opts) = "$Tmp_prefix.opts";
1760       open(OPTS, "> $Tmp_prefix.opts") || &tidy_up_and_die(1,"Can't open $Tmp_prefix.opts\n");
1761       print OPTS "$dump @HsC_flags $CoreLint $USPLint $StgLint $Verbose";
1762       close(OPTS);
1763       $to_do = "$HsC $hscpp_hsc \@$Tmp_prefix.opts $output +RTS @HsC_rts_flags";
1764
1765     } else {
1766
1767     $to_do = "$HsC $hscpp_hsc $dump @HsC_flags $CoreLint $USPLint $StgLint $Verbose $output +RTS @HsC_rts_flags";
1768     }
1769     &run_something($to_do, 'Haskell compiler');
1770
1771     # finish business w/ nofibbish time/bytes-alloc stats
1772     &process_ghc_timings() if $CollectGhcTimings;
1773 }
1774 \end{code}
1775
1776 Use \tr{@Import_dir} and \tr{@SysImport_dir} to make a tmp file
1777 of (module-name, pathname) pairs, one per line, separated by a space.
1778 \begin{code}
1779 $HiMapDone = 0;
1780 $HiIncludeString = ();          # dir1:dir2:dir3, to pass to GHC
1781
1782 sub makeHiMap {
1783
1784     # collect in %HiMap; write later; also used elsewhere in driver
1785
1786     local($mod, $path, $d, $e);
1787
1788     # reset the global variables:
1789     $HiMapDone = 0;
1790     $HiIncludeString = ();              # dir1:dir2:dir3, to pass to GHC
1791     
1792     foreach $d ( @Import_dir ) {
1793         if ($HiIncludeString) { 
1794            $HiIncludeString = "$HiIncludeString${SplitMarker}${d}%.${HiSuffix}";
1795         } else { 
1796            $HiIncludeString = "$d%.${HiSuffix}"; 
1797         }
1798
1799     }
1800
1801     foreach $d ( @SysImport_dir ) {
1802         if ($HiIncludeString) { 
1803             $HiIncludeString = "$HiIncludeString${SplitMarker}${d}%.${HiSuffix_prelude}";
1804         } else { 
1805             $HiIncludeString = "${d}%.${HiSuffix_prelude}";
1806         }
1807     }
1808
1809     $HiMapDone = 1;
1810 }
1811
1812 \end{code}
1813
1814 Invoke the 'linker' - either the standard linker or the one used to build
1815 a (Win32) DLL.
1816
1817 \begin{code}
1818 sub runLinker
1819 {
1820     local($libdirs) = '';
1821
1822     # append last minute flags linker and consistency flags
1823     &setupBuildFlags();
1824     &setupSyslibs();
1825     &setupLinkOpts();
1826
1827     # glue them together:
1828     push(@UserLibrary_dir, @SysLibrary_dir);
1829
1830     $libdirs = '-L' . join(' -L',@UserLibrary_dir) if $#UserLibrary_dir >= 0;
1831
1832     # for a linker, use an explicitly given one, or the going C compiler ...
1833     local($lnkr) = ( $Lnkr ) ? $Lnkr : $CcRegd;
1834
1835     if ( ($Specific_output_file eq '') && 
1836          ($TargetPlatform eq 'i386-unknown-cygwin32') ) {
1837          $Specific_output_file = 'main.exe';
1838          print STDERR "Output file not specified, defaulting to \"main.exe\"\n";
1839     }
1840
1841     local($output) = ($Specific_output_file ne '') ? "-o $Specific_output_file" : '';
1842     @Files_to_tidy = ($Specific_output_file ne '') ? $Specific_output_file : 'a.out'; 
1843
1844     &prepareWin32DllLink(1);
1845
1846     local($to_do) = "$lnkr $Verbose @Ld_flags $output @Link_file $libdirs @UserLibrary @SysLibrary";
1847     &run_something($to_do, 'Linker');
1848
1849     # finally, check the consistency info in the binary
1850     local($executable) = $Files_to_tidy[0];
1851     @Files_to_tidy = (); # reset; we don't want to nuke it if it's inconsistent
1852
1853     if ( $LinkChk ) {
1854         # dynamically load consistency-chking code; then do it.
1855         require('ghc-consist.prl')
1856             || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-consist.prl!\n");
1857
1858         &chk_consistency_info ( $executable );
1859     }
1860
1861     # if PVM parallel stuff, we do truly weird things.
1862     # Essentially: (1) move the executable over to where PVM expects
1863     # to find it.  (2) create a script in place of the executable
1864     # which will cause the program to be run, via SysMan.
1865     if ( $PARing eq 'p' ) {
1866         local($pvm_executable) = $executable;
1867         local($pvm_executable_base);
1868
1869         if ( $pvm_executable !~ /^\// ) { # a relative path name: make absolute
1870             local($pwd) = `pwd`;
1871             chop($pwd);
1872             $pwd =~ s/^\/tmp_mnt//;
1873             $pvm_executable = "$pwd/$pvm_executable";
1874         }
1875
1876         $pvm_executable =~ s|/|=|g; # make /s into =s
1877         $pvm_executable_base = $pvm_executable;
1878
1879         $pvm_executable = $ENV{'PVM_ROOT'} . '/bin/' . $ENV{'PVM_ARCH'}
1880                         . "/$pvm_executable";
1881
1882         &run_something("$Rm -f $pvm_executable; $Cp -p $executable $pvm_executable && $Rm -f $executable", 'Moving binary to PVM land');
1883
1884         # OK, now create the magic script for "$executable"
1885         open(EXEC, "> $executable") || &tidy_up_and_die(1,"$Pgm: couldn't open $executable to write!\n");
1886         print EXEC <<EOSCRIPT1;
1887 eval 'exec perl -S \$0 \${1+"\$@"}'
1888   if \$running_under_some_shell;
1889 # =!=!=!=!=!=!=!=!=!=!=!
1890 # This script is automatically generated: DO NOT EDIT!!!
1891 # Generated by Glasgow Haskell, version ${ProjectVersion}
1892 #
1893 \$pvm_executable      = '$pvm_executable';
1894 \$pvm_executable_base = '$pvm_executable_base';
1895 \$SysMan = '$SysMan';
1896 EOSCRIPT1
1897
1898         print EXEC <<\EOSCRIPT2;
1899 # first, some magical shortcuts to run "commands" on the binary
1900 # (which is hidden)
1901 if ($#ARGV == 1 && $ARGV[0] eq '+RTS' && $ARGV[1] =~ /^--((size|file|strip|rm|nm).*)/ ) {
1902     local($cmd) = $1;
1903     system("$cmd $pvm_executable");
1904     exit(0); # all done
1905 }
1906
1907 # OK, really run it; process the args first
1908 $ENV{'PE'} = $pvm_executable_base;
1909 $debug = '';
1910 $nprocessors = 2; # the default
1911 @nonPVM_args = ();
1912 $in_RTS_args = 0;
1913
1914 # ToDo: handle --RTS
1915 args: while ($a = shift(@ARGV)) {
1916     if ( $a eq '+RTS' ) {
1917         $in_RTS_args = 1;
1918     } elsif ( $a eq '-RTS' ) {
1919         $in_RTS_args = 0;
1920     }
1921     if ( $a eq '-d' && $in_RTS_args ) {
1922         $debug = '-';
1923     } elsif ( $a =~ /^-N(\d+)/ && $in_RTS_args ) {
1924         $nprocessors = $1;
1925     } else {
1926         push(@nonPVM_args, $a);
1927     }
1928 }
1929
1930 local($return_val) = 0;
1931 system("$SysMan $debug $pvm_executable $nprocessors @nonPVM_args");
1932 $return_val = $?;
1933 system("mv $ENV{'HOME'}/$pvm_executable_base.???.gr .") if -f "$ENV{'HOME'}/$pvm_executable_base.001.gr";
1934 exit($return_val);
1935 EOSCRIPT2
1936         close(EXEC) || die "Failed closing $executable\n";
1937         chmod 0755, $executable;
1938     }
1939 }
1940
1941 sub createWin32DLL
1942 {
1943     local ($libdirs);
1944
1945     # append last minute flags linker and consistency flags
1946     &setupBuildFlags();
1947     &setupSyslibs();
1948     &setupLinkOpts();
1949
1950     # glue them together:
1951     push(@UserLibrary_dir, @SysLibrary_dir);
1952
1953     $libdirs = '-L' . join(' -L',@UserLibrary_dir) if $#UserLibrary_dir >= 0;
1954
1955     &prepareWin32DllLink(0);
1956
1957     local ($bld_dll) = "dllwrap";
1958
1959     local ($output) = ($Specific_output_file ne '') ? "$Specific_output_file" : 'HSdll.dll';
1960     local ($output_dir);
1961     local ($output_file);
1962     local ($output_lib, $output_def);
1963
1964     ($output_dir = $output) =~ s|(.*/)[^/]+$|$1|;
1965     $output_dir = "" if ($output_dir eq $output);
1966     ($output_file = $output) =~ s|.*/([^/]+)$|$1|;
1967
1968     ($output_lib = $output_file) =~ s|(.+)\.[^\.]*$|${output_dir}lib$1_imp.a|;
1969     ($output_def = $output_file) =~ s|(.+)\.[^\.]*$|${output_dir}$1.def|;
1970
1971     push (@Dll_flags, "-mno-cygwin --target=i386-mingw32") if ($TargetPlatform =~ /^.*mingw32$/);
1972     push (@Dll_flags, "--output-lib $output_lib");
1973     # If the "--def " option hasn't been supplied, assume everything 
1974     # is going to be exported via the DLL.."
1975     if (!grep(/--def/, @Dll_flags)) {
1976       push (@Dll_flags, "--export-all --output-def $output_def");
1977     }
1978
1979     local($to_do) = "$bld_dll @Dll_flags -o $output @Link_file $libdirs @UserLibrary @SysLibrary";
1980     # Make sure the user sees this piece of magic.
1981     print STDERR "$to_do\n" if (!$Verbose);
1982     &run_something($to_do, 'DLL creator');
1983 }
1984
1985 sub prepareWin32DllLink
1986 {
1987     local($linking_main) = @_;
1988
1989     #
1990     # Win32 DLLs - link with import libraries, not the real archives.
1991     # 
1992     if ( $TargetPlatform =~ /-mingw32$/ ) {
1993        if (!$Static) {
1994          #
1995          # If the libraries have the form libHSfoo.a, we
1996          # transform that into libHSfoo_imp.a - the import
1997          # library of the DLL.
1998          # 
1999          foreach $a ( @SysLibrary ) {
2000            $a = "${a}_imp" if ($a =~ /^-lHS/);
2001          }
2002          foreach $a ( @UserLibrary ) {
2003            $a = "${a}_imp" if ($a =~ /^-lHS/);
2004          }
2005          push(@Link_file, ( $INSTALLING ) ? "$InstLibDirGhc/Main.dll_o"
2006                                           : "$TopPwd/$CURRENT_DIR/$GHC_RUNTIME_DIR/Main.dll_o") if $linking_main;
2007          push(@Link_file, ( $INSTALLING ) ? "$InstLibDirGhc/PrelMain.dll_o"
2008                                           : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/std/PrelMain.dll_o") if $linking_main;
2009        }
2010        push(@Ld_flags,  "-mno-cygwin");
2011     }
2012 }
2013 \end{code}
2014
2015
2016 %************************************************************************
2017 %*                                                                      *
2018 \section[Driver-misc-utils]{Miscellaneous utilities}
2019 %*                                                                      *
2020 %************************************************************************
2021
2022 %************************************************************************
2023 %*                                                                      *
2024 \subsection[Driver-odir-ify]{@odir_ify@: Mangle filename if \tr{-odir} set}
2025 %*                                                                      *
2026 %************************************************************************
2027
2028 \begin{code}
2029 sub osuf_ify {
2030     local($ofile,$def_suffix) = @_;
2031
2032     return(($Osuffix eq '') ? "$ofile.$def_suffix" : "$ofile.$Osuffix" );
2033 }
2034
2035 sub odir_ify {
2036     local($orig_file, $def_suffix) = @_;
2037     if ($Specific_output_dir eq '') {   # do nothing
2038         &osuf_ify($orig_file, $def_suffix);
2039     } else {
2040         local ($orig_file_only);
2041         ($orig_file_only = $orig_file) =~ s|.*/||;
2042         &osuf_ify("$Specific_output_dir/$orig_file_only",$def_suffix);
2043     }
2044 }
2045 \end{code}
2046
2047 \begin{code}
2048 sub runGcc {
2049     local($is_hc_file, $hsc_out, $cc_as_o) = @_;
2050
2051     local($includes) = '-I' . join(' -I', @Include_dir);
2052     local($cc);
2053     local($s_output);
2054     local($c_flags) = "@CcBoth_flags";
2055     local($ddebug_flag) = ( $DEBUGging ) ? '-DDEBUG' : '';
2056
2057     $c_flags .= " -mno-cygwin" if ( $TargetPlatform =~ /-mingw32$/ );
2058
2059     # "input" files to use that are not in some weird directory;
2060     # to help C compilers grok .hc files [ToDo: de-hackify]
2061     local($cc_help)   = "ghc$$.c";
2062     local($cc_help_s) = "ghc$$.s";
2063
2064     $cc       = $CcRegd;
2065     $s_output = (($is_hc_file && $DoAsmMangling) || $TargetPlatform =~ /^(powerpc|rs6000|hppa)/) ? $cc_as_o : $cc_as;
2066     $c_flags .= " @CcRegd_flags";
2067     $c_flags .= ($is_hc_file) ? " @CcRegd_flags_hc"  : " @CcRegd_flags_c";
2068
2069     # C compiler won't like the .hc extension.  So we create
2070     # a tmp .c file which #include's the needful.
2071     open(TMP, "> $cc_help") || &tidy_up_and_die(1,"$Pgm: failed to open `$cc_help' (to write)\n");
2072     if ( $is_hc_file ) {
2073         print TMP <<EOINCL;
2074 #include "Stg.h"
2075 EOINCL
2076         # user may have asked for #includes to be injected...
2077         print TMP @CcInjects if $#CcInjects >= 0;
2078     } else {
2079         # Straight .c files may want to know that they're being used
2080         # with a particular version of GHC, so we define __GLASGOW_HASKELL__ for their benefit.
2081         print TMP "#define __GLASGOW_HASKELL__ ${ProjectVersionInt}\n";
2082     }
2083     # heave in the consistency info
2084     print TMP "static char ghc_cc_ID[] = \"\@(#)cc $ifile\t$Cc_major_version.$Cc_minor_version,$Cc_consist_options\";\n";
2085
2086     print TMP "#include \"$hsc_out\"\n";
2087     close(TMP) || &tidy_up_and_die(1,"Failed writing to $cc_help\n");
2088
2089     # Don't redirect stderr into intermediate file if slamming output onto stdout (e.g., with -E)
2090     local($fuse_stderr) = "2>&1" if ! $Only_preprocess_hc;
2091     local($to_do) = "$cc $Verbose $ddebug_flag $c_flags @Cpp_define $includes $cc_help > $Tmp_prefix.ccout $fuse_stderr && ( if [ $cc_help_s != $s_output ] ; then mv $cc_help_s $s_output ; else exit 0 ; fi )";
2092
2093     if ( $Only_preprocess_hc ) { # HACK ALERT!
2094         $to_do =~ s/ -S\b//g;
2095     }
2096     push(@Files_to_tidy, $cc_help, $cc_help_s, $s_output );
2097     $PostprocessCcOutput = 1 if ! $Only_preprocess_hc;  # hack, dear hack...
2098     &run_something($to_do, 'C compiler');
2099     $PostprocessCcOutput = 0;
2100     if ( $Only_preprocess_hc ) {
2101        system("$Cat $Tmp_prefix.ccout");
2102     }
2103     unlink($cc_help, $cc_help_s);
2104 }
2105 \end{code}
2106
2107 \begin{code}
2108 sub runMangler {
2109     local($is_hc_file, $cc_as_o, $cc_as, $ifile_root) = @_;
2110
2111     print STDERR `cat $cc_as_o` if $Dump_raw_asm; # to stderr, before mangling
2112
2113     if ($is_hc_file && $DoAsmMangling) {
2114         # dynamically load assembler-fiddling code, which we are about to use:
2115         require('ghc-asm.prl')
2116              || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm.prl!\n");
2117         # post-process the assembler [.hc files only]
2118         &mangle_asm($cc_as_o, $cc_as);
2119
2120     } elsif ($TargetPlatform =~ /^hppa/) {
2121         # minor mangling of non-threaded files for hp-pa only
2122         require('ghc-asm.prl')
2123         || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm-hppa.prl!\n");
2124         &mini_mangle_asm_hppa($cc_as_o, $cc_as);
2125
2126     } elsif ($TargetPlatform =~ /^powerpc|^rs6000/) {
2127         # minor mangling of non-threaded files for powerpcs and rs6000s 
2128         require('ghc-asm.prl')
2129         || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm-powerpc.prl!\n");
2130         &mini_mangle_asm_powerpc($cc_as_o, $cc_as);
2131     }
2132
2133     # save a copy of the .s file, even if we are carrying on...
2134     #if ($do_as && $Keep_s_file_too) {
2135     #    &saveIntermediate($ifile_root , "s" , $cc_as);
2136     #}
2137 }
2138 \end{code}
2139
2140 \begin{code}
2141 sub runAs {
2142     local($as_out, $ifile_root) = @_;
2143
2144     local($asmblr) = ( $As ) ? $As : $CcRegd;
2145
2146     # need to add the -I flags in case the file is going through cpp (.S files)
2147     local($includes) = '-I' . join(' -I', @Include_dir);
2148
2149     if ( ! $SplitObjFiles ) {
2150         local($to_do)  = "$asmblr -o $as_out -c @As_flags $includes $cc_as";
2151         push(@Files_to_tidy, $as_out );
2152         &run_something($to_do, 'Unix assembler');
2153
2154     } else { # more complicated split-ification...
2155
2156         # must assemble files $Tmp_prefix__[1 .. $NoOfSplitFiles].s
2157
2158         # If -odir is used, great, just pin it in front of the
2159         # generated split file names. If it hasn't been set, we
2160         # snatch it from the ifile_root.
2161         #
2162         # 
2163
2164         if ( $Specific_output_dir eq '' ) {
2165             $Specific_output_dir = ${ifile_root};
2166         }
2167
2168         for ($f = 1; $f <= $NoOfSplitFiles; $f++ ) {
2169             local($split_out) = &odir_ify("${ifile_root}__${f}",'o');
2170             local($to_do) = "$asmblr -o $split_out -c @As_flags ${Tmp_prefix}__${f}.s";
2171             push(@Files_to_tidy, $split_out );
2172
2173             &run_something($to_do, 'Unix assembler');
2174         }
2175     }
2176 }
2177 \end{code}
2178
2179 %************************************************************************
2180 %*                                                                      *
2181 \subsection[Driver-run-something]{@run_something@: Run a phase}
2182 %*                                                                      *
2183 %************************************************************************
2184
2185 \begin{code}
2186 sub run_something {
2187     local($str_to_do, $tidy_name) = @_;
2188
2189     print STDERR "\n$tidy_name:\n\t" if $Verbose;
2190     print STDERR "$str_to_do\n" if $Verbose;
2191
2192     if ($Using_dump_file) {
2193         open(DUMP, ">> $Specific_dump_file")
2194             || &tidy_up_and_die(1,"$Pgm: failed to open `$Specific_dump_file'\n");
2195         print DUMP "\nCompilation Dump for: $str_to_do\n\n";
2196         close(DUMP) 
2197             || &tidy_up_and_die(1,"$Pgm: failed closing `$Specific_dump_file'\n");
2198     }
2199
2200     local($return_val) = 0;
2201
2202     if ( length($str_to_do) > 4000) { 
2203       # 4000 - on the random side, just like the *real* ARG_MAX 
2204       # for some shells.
2205
2206       # With some shells, command lines of this length may
2207       # very well cause trouble. To safeguard against this, we squirrel the
2208       # command into a file and exec that.
2209       local ($sh) = $ENV{'REAL_SHELL'};
2210       print STDERR "Backup plan A: saving cmd line in ${Tmp_prefix}.sh and executing that with $sh\n" if $Verbose;
2211       open (TEMP, "> ${Tmp_prefix}.sh") || 
2212                 &tidy_up_and_die(1,"$Pgm: failed to open `$Tmp_prefix.sh'\n");
2213       print TEMP "$Time $str_to_do\n";
2214       close (TEMP) ||
2215                 &tidy_up_and_die(1,"$Pgm: failed closing `$Tmp_prefix.sh'\n");
2216       system("$sh $Tmp_prefix.sh");
2217       $return_val = $?;
2218       
2219       unlink "${Tmp_prefix}.sh";
2220     } else {
2221       system("$Time $str_to_do");
2222       $return_val = $?;
2223     }
2224
2225     if ( $PostprocessCcOutput ) { # hack, continued
2226         open(CCOUT, "< $Tmp_prefix.ccout")
2227             || &tidy_up_and_die(1,"$Pgm: failed to open `$Tmp_prefix.ccout'\n");
2228         while ( <CCOUT> ) {
2229             next if /call-clobbered/;
2230             next if /control reaches end/;
2231             next if /from .*Stg\.h:/;
2232             next if /from ghc\d+.c:\d+:/;
2233             next if /: At top level:$/;
2234             next if /: In function \`.*\':$/;
2235             next if /\`ghc_cc_ID\' defined but not used/;
2236             print STDERR $_;
2237         }
2238         close(CCOUT) || &tidy_up_and_die(1,"$Pgm: failed closing `$Tmp_prefix.ccout'\n");
2239     }
2240
2241     if ($return_val != 0) {
2242         if ($Using_dump_file) {
2243             print STDERR "Compilation Errors dumped in $Specific_dump_file\n";
2244         }
2245         &tidy_up_and_die($return_val, '');
2246     }
2247     $Using_dump_file = 0;
2248 }
2249 \end{code}
2250
2251 %************************************************************************
2252 %*                                                                      *
2253 \subsection[Driver-ghc-timing]{Emit nofibbish GHC timings}
2254 %*                                                                      *
2255 %************************************************************************
2256
2257 NB: nearly the same as in @runstdtest@ script.
2258
2259 \begin{code}
2260 sub process_ghc_timings {
2261     local($StatsFile) = "$Tmp_prefix.stat";
2262     local($SysSpecificTiming) = 'ghc';
2263
2264     open(STATS, $StatsFile) || die "Failed when opening $StatsFile\n";
2265     local($max_live)    = 0; 
2266     local($tot_live)    = 0; # for calculating residency stuff
2267     local($tot_samples) = 0;
2268
2269     while (<STATS>) {
2270         if (! /Gen:\s+0/ && ! /Minor/ && /^\s*\d+\s+\d+\s+(\d+)\s+\d+\.\d+/ ) {
2271                 $max_live = $1 if $max_live < $1;
2272                 $tot_live += $1;
2273                 $tot_samples += 1;
2274         }
2275         $BytesAlloc = $1 if /^\s*([0-9,]+) bytes allocated in the heap/;
2276
2277         if ( /^\s*([0-9,]+) bytes maximum residency .* (\d+) sample/ ) {
2278             $MaxResidency = $1; $ResidencySamples = $2;
2279         }
2280
2281         $GCs = $1 if /^\s*([0-9,]+) (collections? in generation 0|garbage collections? performed)/;
2282
2283         if ( /^\s+([0-9]+)\s+Mb total memory/ ) {
2284             $TotMem = $1;
2285         }
2286
2287         # The presence of -? in the following pattern is only there to
2288         # accommodate 0.29 && <= 2.05 RTS'
2289         if ( /^\s*INIT\s+time\s*(\d+\.\d\d)s\s*\(\s*-?(\d+\.\d\d)s elapsed\)/ ) {
2290             $InitTime = $1; $InitElapsed = $2;
2291         } elsif ( /^\s*MUT\s+time\s*(\d+\.\d\d)s\s*\(\s*(\d+\.\d\d)s elapsed\)/ ) {
2292             $MutTime = $1; $MutElapsed = $2;
2293         } elsif ( /^\s*GC\s+time\s*(\d+\.\d\d)s\s*\(\s*(\d+\.\d\d)s elapsed\)/ ) {
2294             $GcTime = $1; $GcElapsed = $2;
2295         }
2296     }
2297     close(STATS) || die "Failed when closing $StatsFile\n";
2298     if ( $tot_samples > 0 ) {
2299         $ResidencySamples = $tot_samples;
2300         $MaxResidency = $max_live;
2301         $AvgResidency = int ($tot_live / $tot_samples) ;
2302     }
2303
2304     # warn about what we didn't find
2305     print STDERR "Warning: BytesAlloc not found in stats file\n" unless defined($BytesAlloc);
2306     print STDERR "Warning: GCs not found in stats file\n" unless defined($GCs);
2307     print STDERR "Warning: InitTime not found in stats file\n" unless defined($InitTime);
2308     print STDERR "Warning: InitElapsed not found in stats file\n" unless defined($InitElapsed);
2309     print STDERR "Warning: MutTime not found in stats file\n" unless defined($MutTime);
2310     print STDERR "Warning: MutElapsed not found in stats file\n" unless defined($MutElapsed);
2311     print STDERR "Warning: GcTime inot found in stats file\n" unless defined($GcTime);
2312     print STDERR "Warning: GcElapsed not found in stats file\n" unless defined($GcElapsed);
2313
2314     # things we didn't necessarily expect to find
2315     $MaxResidency     = 0 unless defined($MaxResidency);
2316     $AvgResidency     = 0 unless defined($AvgResidency);
2317     $ResidencySamples = 0 unless defined($ResidencySamples);
2318
2319     # a bit of tidying
2320     $BytesAlloc =~ s/,//g;
2321     $MaxResidency =~ s/,//g;
2322     $GCs =~ s/,//g;
2323     $InitTime =~ s/,//g;
2324     $InitElapsed =~ s/,//g;
2325     $MutTime =~ s/,//g;
2326     $MutElapsed =~ s/,//g;
2327     $GcTime =~ s/,//g;
2328     $GcElapsed =~ s/,//g;
2329
2330     # print out what we found
2331     print STDERR "<<$SysSpecificTiming: ",
2332         "$BytesAlloc bytes, $GCs GCs, $AvgResidency/$MaxResidency avg/max bytes residency ($ResidencySamples samples), ${TotMem}M in use, $InitTime INIT ($InitElapsed elapsed), $MutTime MUT ($MutElapsed elapsed), $GcTime GC ($GcElapsed elapsed)",
2333         " :$SysSpecificTiming>>\n";
2334
2335     # OK, party over
2336     unlink $StatsFile;
2337 }
2338 \end{code}
2339
2340 %************************************************************************
2341 %*                                                                      *
2342 \subsection[Driver-dying]{@tidy_up@ and @tidy_up_and_die@: Dying gracefully}
2343 %*                                                                      *
2344 %************************************************************************
2345
2346 \begin{code}
2347 sub tidy_up {
2348     local($to_do) = "\n$Rm $Tmp_prefix*";
2349     if ( $Tmp_prefix !~ /^\s*$/ ) {
2350         print STDERR "$to_do\n" if $Verbose;
2351         system($to_do);
2352     }
2353 }
2354
2355 sub tidy_up_and_die {
2356     local($return_val, $msg) = @_;
2357
2358     # delete any files to tidy
2359     print STDERR "deleting... @Files_to_tidy\n" if $Verbose && $#Files_to_tidy >= 0;
2360     unlink @Files_to_tidy if $#Files_to_tidy >= 0;
2361
2362     &tidy_up();
2363     print STDERR $msg;
2364     exit (($return_val == 0) ? 0 : 1);
2365 }
2366 \end{code}
2367
2368 %************************************************************************
2369 %*                                                                      *
2370 \subsection[Driver-arg-with-arg]{@grab_arg_arg@: Do an argument with an argument}
2371 %*                                                                      *
2372 %************************************************************************
2373
2374 Some command-line arguments take an argument, e.g.,
2375 \tr{-Rmax-heapsize} expects a number to follow.  This can either be
2376 given a part of the same argument (\tr{-Rmax-heapsize8M}) or as the
2377 next argument (\tr{-Rmax-heapsize 8M}).  We allow both cases.
2378
2379 Note: no error-checking; \tr{-Rmax-heapsize -Rgc-stats} will silently
2380 gobble the second argument (and probably set the heapsize to something
2381 nonsensical).
2382 \begin{code}
2383 sub grab_arg_arg {
2384     local(*Args, $option, $rest_of_arg) = @_;
2385     
2386     if ($rest_of_arg ne '') {
2387         return($rest_of_arg);
2388     } elsif ($#Args >= 0) {
2389         local($temp) = $Args[0]; shift(@Args); 
2390         return($temp);
2391     } else {
2392         print STDERR "$Pgm: no argument following $option option\n";
2393         $Status++;
2394     }
2395 }
2396 \end{code}
2397
2398 \begin{code}
2399 sub isntAntiFlag {
2400     local($flag) = @_;
2401     local($f);
2402
2403 #Not in HsC_antiflag ## NO!: and not already in HsC_flags
2404
2405     foreach $f ( @HsC_antiflags ) {
2406         return(0) if $flag eq $f;
2407     }
2408 #    foreach $f ( @HsC_flags ) {
2409 #       return(0) if $flag eq $f;
2410 #    }
2411     return(1);
2412 }
2413
2414 sub squashHscFlag {  # pretty terrible
2415     local($flag) = @_;
2416     local($f);
2417
2418     foreach $f ( @HsC_flags ) {
2419         if ($flag eq $f) { $f = ''; }
2420     }
2421 }
2422
2423 sub add_Hsc_flags {
2424     local(@flags) = @_;
2425     local($f);
2426
2427     foreach $f ( @flags ) {
2428         push( @HsC_flags, $f ) if &isntAntiFlag($f);
2429     }
2430 }
2431 \end{code}
2432
2433 To add another system library, you'll need to augment the
2434 Supported_syslibs variable with name and info on your addition
2435 to the syslib family. The info bit consist of the following:
2436
2437    - interface file directory
2438        see the misc or posix entry for how to distinguish
2439        between using installed and build tree directories.
2440        
2441    - directory location of archives
2442        
2443    - location of (way-independent) C support libs.
2444        not all libraries need this - if you don't, just
2445        give the empty string.
2446    - list of syslibs you depend on.
2447
2448    - additional ghc command line flags that should be used.
2449    - additional C compiler command line flags that should be used.
2450    - link 
2451
2452
2453 \begin{code}
2454
2455 # Hash to keep track of 
2456 %Syslibs_added = ();
2457
2458 sub add_syslib {
2459     local($syslib) = @_;
2460
2461     # Lifting this out of this sub brings it out of scope - why??
2462     %Supported_syslibs =
2463      ( exts,
2464         [  # where to slurp interface files from
2465           ( $INSTALLING 
2466                ? "$InstLibDirGhc/imports/exts"
2467                : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/exts"
2468           )
2469         , # where to find the archive to use when linking
2470           ( $INSTALLING 
2471                ? "$InstLibDirGhc"
2472                : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/exts"
2473           )
2474         , '' # no cbits
2475         , '' # Syslib dependencies
2476         , '' # extra ghc opts
2477         , '' # extra cc opts
2478         , '' # extra ld opts
2479         ],
2480
2481        misc,
2482         [  # where to slurp interface files from
2483           ( $INSTALLING 
2484                ? "$InstLibDirGhc/imports/misc"
2485                : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/misc"
2486           )
2487         , # where to find the archive to use when linking
2488           ( $INSTALLING 
2489                ? "$InstLibDirGhc"
2490                : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/misc"
2491           )
2492         , # where to find the cbits archive to use when linking
2493           ( $INSTALLING 
2494                ? "$InstLibDirGhc"
2495                : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/misc/cbits"
2496           )
2497         , 'exts concurrent' # Syslib dependencies
2498         , ''     # extra ghc opts
2499         , ''     # extra cc opts
2500         , ( $TargetPlatform =~ /-solaris2$/  ? '-lnsl -lsocket' : '')
2501         ],
2502        hbc,
2503         [  # where to slurp interface files from
2504           ( $INSTALLING 
2505                ? "$InstLibDirGhc/imports/hbc"
2506                : "$TopPwd/CONTRIB/libraries/hbc/src"
2507           )
2508         , # where to find the archive to use when linking
2509           ( $INSTALLING 
2510                ? "$InstLibDirGhc"
2511                : "$TopPwd/CONTRIB/libraries/src/hbc"
2512           )
2513         , # where to find the cbits archive to use when linking
2514           ( $INSTALLING 
2515                ? "$InstLibDirGhc"
2516                : "$TopPwd/CONTRIB/libraries/hbc/cbits"
2517           )
2518         , 'exts' # Syslib dependencies
2519         , ''     # extra ghc opts
2520         , ''     # extra cc opts
2521         , ''
2522         ],
2523        posix,
2524         [  # where to slurp interface files from
2525           ( $INSTALLING 
2526                ? "$InstLibDirGhc/imports/posix"
2527                : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/posix"
2528           )
2529         , # where to find the archive to use when linking
2530           ( $INSTALLING 
2531                ? "$InstLibDirGhc"
2532                : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/posix"
2533           )
2534         , # where to find the cbits archive to use when linking
2535           ( $INSTALLING 
2536                ? "$InstLibDirGhc"
2537                : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/posix/cbits"
2538           )
2539         , 'misc' # Syslib dependencies
2540         , ''     # extra ghc opts
2541         , ''     # extra cc opts
2542         , ''     # extra ld opts
2543         ],
2544        concurrent,
2545         [  # where to slurp interface files from
2546           ( $INSTALLING 
2547                ? "$InstLibDirGhc/imports/concurrent"
2548                : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/concurrent"
2549           )
2550         , # where to find the archive to use when linking
2551           ( $INSTALLING 
2552                ? "$InstLibDirGhc"
2553                : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/concurrent"
2554           )
2555         , '' # where to find the cbits archive to use when linking
2556         , '' # Syslib dependencies
2557         , '' # extra ghc opts
2558         , '' # extra cc opts
2559         , '' # extra ld opts
2560         ],
2561        win32,
2562         [  # where to slurp interface files from
2563           ( $INSTALLING 
2564                ? "$InstLibDirGhc/imports/win32"
2565                : "$TopPwd/hslibs/win32/src"
2566           )
2567         , # where to find the archive to use when linking
2568           ( $INSTALLING 
2569                ? "$InstLibDirGhc"
2570                : "$TopPwd/hslibs/win32/src"
2571           )
2572         , ''
2573         , 'exts' # Syslib dependencies
2574         , ''     # extra ghc opts
2575         , ''     # extra cc opts
2576         , '-luser32 -lgdi32'     # extra ld opts
2577         ],
2578        com,
2579         [  # where to slurp interface files from
2580           ( $INSTALLING 
2581                ? "$InstLibDirGhc/imports/com"
2582                : "$TopPwd/hdirect/lib"
2583           )
2584         , # where to find the archive to use when linking
2585           ( $INSTALLING 
2586                ? "$InstLibDirGhc"
2587                : "$TopPwd/hdirect/lib"
2588           )
2589         , ''
2590         , 'exts' # Syslib dependencies
2591         , ''     # extra ghc opts
2592         , ''     # extra cc opts
2593         , '-luser32 -lole32 -loleaut32 -ladvapi32'
2594                  # extra ld opts
2595         ]
2596     );
2597
2598     # check if it's supported..
2599     
2600     if ( !exists $Supported_syslibs{$syslib} ) {
2601        print STDERR "$Pgm: no such system library (-syslib): $syslib\n";
2602        $Status++;
2603        return;
2604     }
2605
2606     # This check is here to avoid syslib loops from
2607     # spoiling the party. A side-effect of it is that
2608     # it disallows multiple mentions of a syslib on a command-line,
2609     # explicit *and* implicit ones (i.e., "-syslib exts -syslib misc"
2610     # is not equal to "-syslib exts -syslib misc -syslib exts",
2611     # which it needs to be)
2612     # 
2613     # Since our current collection of syslibs don't have any
2614     # loops, this test is disabled.
2615     #
2616     # ToDo: loop avoidance scheme when the need arises
2617     #
2618     #return if ( exists $Syslibs_added{$syslib} );
2619         
2620     $Syslibs_added{$syslib} = 1;
2621
2622     local ($hi_dir, $lib_dir, $lib_cbits_dir,
2623            $syslib_deps, $syslib_ghc_opts,
2624            $syslib_cc_opts, $syslib_ld_opts) = @{ $Supported_syslibs{$syslib} };
2625
2626
2627     unshift(@SysImport_dir, $hi_dir);
2628     push(@SysLibrary_dir, $lib_dir);
2629     push(@SysLibrary_dir, $lib_cbits_dir) if ( $lib_cbits_dir ne '');
2630
2631     push(@SysLibrary, "-lHS$syslib");
2632     push(@SysLibrary, "-lHS${syslib}_cbits") if ( $lib_cbits_dir ne '');
2633     push(@SysLibrary, $syslib_ld_opts) if ($syslib_ld_opts ne '');   
2634
2635     # Add on any extra dependencies.
2636     foreach $lib (split(' ',$syslib_deps)) {
2637       &add_syslib($lib);
2638     }
2639 }
2640 \end{code}
2641
2642 Source files may have {-# OPTIONS ... #-} pragmas at the top, containing
2643 command line options we want to append to collection of commands specified
2644 directly. @check_for_source_options@ looks at the top of a de-lit'ified Haskell
2645 file for any such pragmas:
2646
2647 \begin{code}
2648 sub check_for_source_options {
2649     local($file,$ifile) = @_;
2650     local($comment_start,$comment_end);
2651
2652     if ($ifile =~ /\.hc$/ || 
2653         $ifile =~ /_hc$/  || 
2654         $ifile =~ /\.s$/  || 
2655         $ifile =~ /_s$/ ) {  # `Real' C intermediate
2656        $comment_start = "/\\*";
2657        $comment_end   = "\\*/";
2658     } else { # Assume it is a file containing Haskell source
2659        $comment_start = "{-#";
2660        $comment_end   = "#-}";
2661     }
2662
2663     open(FILE,$file) || return(1); # No big loss
2664     
2665     while (<FILE>) {
2666         if ( /^${comment_start} OPTIONS (.*)${comment_end}/ ) {
2667            # add the options found at the back of the command line.
2668            local(@entries) = split(/\s+/,$1);
2669            print STDERR "Found OPTIONS " . join(' ',@entries) . " in $file\n" if $Verbose;
2670            push(@File_options, @entries);
2671         }
2672         elsif ( /^$/ ) { # ignore empty lines
2673            ;
2674         }
2675         elsif ( /^#line.+$/ ) { # ignore comment lines (unused..ToDo: rm )
2676            ;
2677         }
2678         elsif ( /^{-# LINE.+$/ ) { # ignore line pragmas
2679            ;
2680         }
2681         else { # stop looking, something non-empty / not
2682                # ${comment_start} OPTIONS .. ${comment_end} encountered.
2683             close(FILE);return(0);
2684         }
2685     }
2686     close(FILE);
2687     return(0);
2688 }
2689 \end{code}
2690
2691
2692 We split the initial argv up into three arrays:
2693
2694   - @Cmd_opts 
2695   - @Link_file
2696   - @Input_file
2697
2698 the reason for doing so is to be able to deal
2699 with {-# OPTIONS #-} pragma in source files properly.
2700
2701 \begin{code}
2702 sub splitCmdLine {
2703     local(@args) = @_;
2704
2705 arg: while($_ = $args[0]) {
2706     shift(@args);
2707     # sigh, we have to deal with these -option arg specially here.
2708     /^-(tmpdir|odir|ohi|o|isuf|osuf|hisuf|odump|syslib)$/ && 
2709        do { push(@Cmd_opts, $_); push(@Cmd_opts,$args[0]); shift(@args); next arg; };
2710     /^--?./  && do { push(@Cmd_opts, $_); next arg; };
2711
2712     if (/\.([^_]+_)?[oa]$/) {
2713         push(@Link_file, $_);
2714     } else {
2715         push(@Input_file, $_);
2716     }
2717
2718     # input files must exist:
2719     if (! -f $_) {
2720         print STDERR "$Pgm: input file doesn't exist: $_\n";
2721         $Status++;
2722     }
2723   }
2724 }    
2725
2726 \end{code}
2727
2728 When saving an intermediate file (.hc or .s) away, we 
2729 have to prefix any OPTIONS found in the original source file.
2730
2731 \begin{code}
2732 sub saveIntermediate { 
2733   local ($final,$suffix,$tmp)= @_ ;
2734   local ($to_do);
2735
2736   # $final  -- root of where to park ${final}.${suffix}
2737   # $tmp    -- temporary file where hsc put the intermediate file.
2738
2739   # Delete the old file
2740   $to_do = "$Rm ${final}.${suffix}"; &run_something($to_do, "Removing old .${suffix} file");
2741
2742   if ( $#File_options >= 0 ) { # OPTIONS found in Haskell source unit
2743     # Add OPTION comment to the top of the generated .${suffix} file
2744     open(TEMP, "> ${final}.${suffix}") || &tidy_up_and_die(1,"Can't open ${final}.${suffix}\n");
2745     print TEMP "/* OPTIONS " . join(' ',@File_options) . " */\n";
2746     close(TEMP);
2747     print STDERR "Prepending OPTIONS: " . join(' ',@File_options) . " to ${final}.${suffix}\n" if $Verbose;
2748   }
2749   $to_do = "$Cat $tmp  >> ${final}.${suffix}";
2750   &run_something($to_do, "Saving copy of .${suffix} file");
2751
2752 }
2753
2754 \end{code}
2755
2756
2757 Command-line processor
2758
2759 \begin{code}
2760 sub processArgs {
2761     local(@Args) = @_;
2762
2763 # can't use getopt(s); what we want is too complicated
2764
2765 arg: while($_ = $Args[0]) {
2766     shift(@Args);
2767
2768     #---------- help -------------------------------------------------------
2769     if (/^-\?$/ || /^--?help$/) { print $LongUsage; exit $Status; }
2770
2771     #-----------version ----------------------------------------------------
2772     /^--version$/   && do { print STDERR "${ProjectName}, version ${ProjectVersion}\n"; exit $Status; };
2773
2774     #---------- verbosity and such -----------------------------------------
2775     /^-v$/          && do { $Verbose = '-v'; $Time = 'time'; next arg; };
2776
2777     #---------- what phases are to be run ----------------------------------
2778     /^-(no-)?recomp/        && do { $Do_recomp_chkr = ($1 eq '') ? 1 : 0; next arg; };
2779
2780     /^-cpp$/        && do { $Cpp_flag_set = 1; next arg; };
2781     # change the global default:
2782     # we won't run cat; we'll run the real thing
2783         
2784     /^-C$/          && do { $Do_cc = 0; $Do_as = 0; $Do_lnkr = 0; $HscOut = '-C=';
2785                             next arg; };
2786     # stop after generating C
2787         
2788     /^-noC$/        && do { $HscOut = '-N='; $ProduceHi = '-nohifile=';
2789                             $Do_cc = 0; $Do_as = 0; $Do_lnkr = 0;
2790                             next arg; };
2791     # leave out actual C generation (debugging) [also turns off interface gen]
2792
2793
2794     /^-hi$/              && do { $HiOnStdout = 1; $ProduceHi = '-hifile='; next arg; };
2795     # _do_ generate an interface; usually used as: -noC -hi
2796     /^-hi-with-(.*)$/    && do { $HiOnStdout = 1; $HiWith .= " $1" ; $ProduceHi = '-hifile='; next arg; };
2797     # limit ourselves to outputting a particular section.
2798
2799     /^-nohi$/       && do { $ProduceHi = '-nohifile='; next arg; };
2800     # don't generate an interface (even if generating C)
2801
2802     /^-hi-diffs$/             && do { $HiDiff_flag  = 'normal'; next arg; };
2803     /^-hi-diffs-with-usages$/ && do { $HiDiff_flag  = 'usages'; next arg; };
2804     /^-no-hi-diffs$/          && do { $HiDiff_flag  = '';       next arg; };
2805     /^-keep-hi-diffs$/        && do { $Keep_HiDiffs = 1; next arg; };
2806
2807     # show/disable diffs if the interface file changes
2808
2809     /^-E$/          && do { push(@CcBoth_flags, '-E');
2810                             $Only_preprocess_C = 1;
2811                             $Do_as = 0; $Do_lnkr = 0; next arg; };
2812     # stop after preprocessing C
2813     /^-M$/          && do { $Only_generate_deps = 1; $Do_as = 0; $Do_lnkr = 0; next arg; };
2814     # only generate dependency information.
2815     /^--mk-dll$/    && do { $Only_generate_dll  = 1; $Do_as = 0; $Do_lnkr = 0; next arg; };
2816     # Build a Win32 DLL (where supported).
2817     /^-S$/          && do { $Do_as = 0; $Do_lnkr = 0; next arg; };
2818     # stop after generating assembler
2819         
2820     /^-c$/          && do { $Do_lnkr = 0; next arg; };
2821     # stop after generating .o files
2822
2823     /^-link-chk$/    && do { $LinkChk = 1; next arg; };
2824     # don't do consistency-checking after a link
2825     /^-no-link-chk$/ && do { $LinkChk = 0; next arg; };
2826
2827     /^-tmpdir$/ && do { $Tmp_prefix = &grab_arg_arg(*Args,'-tmpdir', '');
2828                         $Tmp_prefix = "$Tmp_prefix/ghc$$";
2829                         $ENV{'TMPDIR'} = $Tmp_prefix; # for those who use it...
2830                         next arg; };
2831     # use an alternate directory for temp files
2832
2833     #---------- redirect output --------------------------------------------
2834
2835     # -o <file>; applies to the last phase, whatever it is
2836     # "-o -" sends it to stdout
2837     # if <file> has a directory component, that dir must already exist
2838
2839     /^-odir$/       && do { $Specific_output_dir = &grab_arg_arg(*Args,'-odir', '');
2840                             #
2841                             # Hack, of the worst sort: don't do validation of
2842                             # odir argument if you're using -M (dependency generation).
2843                             #
2844                             if ( ! $Only_generate_deps && ! -d $Specific_output_dir) {
2845                                 print STDERR "$Pgm: -odir: no such directory: $Specific_output_dir\n";
2846                                 $Status++;
2847                             }
2848                             next arg; };
2849
2850     /^-o$/          && do { $Specific_output_file = &grab_arg_arg(*Args,'-o', '');
2851                             if ($Specific_output_file ne '-'
2852                              && $Specific_output_file =~ /(.*)\/[^\/]*$/) {
2853                                 local($dir_part) = $1;
2854                                 if (! -d $dir_part) {
2855                                     print STDERR "$Pgm: no such directory: $dir_part\n";
2856                                     $Status++;
2857                                 }
2858                             }
2859                             next arg; };
2860
2861     # NB: -isuf not documented yet (because it doesn't work yet)
2862     /^-isuf$/       && do { $Isuffix  = &grab_arg_arg(*Args,'-isuf', '');
2863                             if ($Isuffix =~ /\./ ) {
2864                                 print STDERR "$Pgm: -isuf suffix shouldn't contain a .\n";
2865                                 $Status++;
2866                             }
2867                             next arg; };
2868
2869     /^-osuf$/       && do { $Osuffix  = &grab_arg_arg(*Args,'-osuf', '');
2870                             if ($Osuffix =~ /\./ ) {
2871                                 print STDERR "$Pgm: -osuf suffix shouldn't contain a .\n";
2872                                 $Status++;
2873                             }
2874                             next arg; };
2875
2876     # -ohi <file>; send the interface to <file>; "-ohi -" to send to stdout
2877     /^-ohi$/        && do { $Specific_hi_file = &grab_arg_arg(*Args,'-ohi', '');
2878                             if ($Specific_hi_file ne '-'
2879                              && $Specific_hi_file =~ /(.*)\/[^\/]*$/) {
2880                                 local($dir_part) = $1;
2881                                 if (! -d $dir_part) {
2882                                     print STDERR "$Pgm: no such directory: $dir_part\n";
2883                                     $Status++;
2884                                 }
2885                             }
2886                             $ProduceHi='-hifile=';
2887                             next arg; };
2888
2889     # The suffix to use when looking for interface files
2890     /^-hisuf$/      && do { $HiSuffix = &grab_arg_arg(*Args,'-hisuf', '');
2891                             if ($HiSuffix =~ /\./ ) {
2892                                 print STDERR "$Pgm: -hisuf suffix shouldn't contain a .\n";
2893                                 $Status++;
2894                             }
2895                             next arg; };
2896     /^-odump$/      && do { $Specific_dump_file = &grab_arg_arg(*Args,'-odump', '');
2897                             if ($Specific_dump_file =~ /(.*)\/[^\/]*$/) {
2898                                 local($dir_part) = $1;
2899                                 if (! -d $dir_part) {
2900                                     print STDERR "$Pgm: no such directory: $dir_part\n";
2901                                     $Status++;
2902                                 }
2903                             }
2904                             next arg; };
2905
2906     #-------------- scc & Profiling Stuff ----------------------------------
2907
2908     /^-prof$/ && do { $PROFing = 'p'; next arg; }; # profiling -- details later!
2909
2910     /^-auto-dicts$/ && do {
2911                 $PROFdicts = '-fauto-sccs-on-dicts';
2912                 next arg; };
2913     /^-auto-all$/ && do {
2914                 $PROFauto = '-fauto-sccs-on-all-toplevs';
2915                 next arg; };
2916     /^-auto$/ && do {
2917                 $PROFauto = '-fauto-sccs-on-exported-toplevs';
2918                 next arg; };
2919
2920     /^-caf-all/ && do { # generate individual CAF SCC annotations
2921                 $PROFcaf = '-fauto-sccs-on-individual-cafs';
2922                 next arg; };
2923
2924     /^-ignore-scc$/ && do {
2925                 # forces ignore of scc annotations even if profiling
2926                 $PROFignore_scc = '-W';
2927                 next arg; };
2928
2929     /^-G(.*)$/  && do { push(@HsC_flags, "-G=$1");   # set group for cost centres
2930                         next arg; };
2931
2932     /^-unprof-scc-auto/ && do {
2933                 # generate auto SCCs on top level bindings when not profiling.
2934                 # Used to measure optimisation effects of presence of sccs.
2935                 $UNPROFscc_auto = ( /-all/ )
2936                             ? '-fauto-sccs-on-all-toplevs'
2937                             : '-fauto-sccs-on-exported-toplevs';
2938                 next arg; };
2939
2940     #--------- ticky/parallel ----------------------------------------------
2941     # we sort out the details a bit later on
2942
2943     /^-gransim$/    && do { $GRANing   = 'g'; &add_syslib('concurrent'); next arg; }; # GranSim
2944     /^-ticky$/      && do { $TICKYing  = 't'; next arg; }; # ticky-ticky
2945     /^-parallel$/   && do { $PARing    = 'p'; &add_syslib('concurrent'); next arg; }; # parallel Haskell
2946
2947     #-------------- "user ways" --------------------------------------------
2948
2949     (/^-user-setup-([a-oA-Z])$/ ) && 
2950            do {
2951                 /^-user-setup-([a-oA-Z])$/  && do { $BuildTag = "_$1"; };
2952
2953                 local($stuff) = $UserSetupOpts{$BuildTag};
2954                 local(@opts)  = split(/\s+/, $stuff);
2955                 
2956                 # feed relevant ops into the arg-processing loop (if any)
2957                 unshift(@Args, @opts) if $#opts >= 0;
2958
2959                 next arg; };
2960
2961     #---------- set search paths for libraries and things ------------------
2962
2963     # we do -i just like HBC (-i clears the list; -i<colon-separated-items>
2964     # prepends the items to the list); -I is for including C .h files.
2965
2966     /^-i$/          && do { @Import_dir = ();  # import path cleared!
2967                             @SysImport_dir = ();
2968                             print STDERR "WARNING: import paths cleared by `-i'\n";
2969                             next arg; };
2970
2971     /^-i(.*)/       && do { local(@new_items);
2972                             local($arg) = $1;
2973     
2974                             #
2975                             if ( $arg =~ /;/ ) {
2976                                $SplitMarker=";";
2977                                @new_items = split( /;/, &grab_arg_arg(*Args,'-i', $arg));
2978                             } else {
2979                                @new_items = split( /:/, &grab_arg_arg(*Args,'-i', $arg));
2980                             }
2981                             unshift(@Import_dir, @new_items);
2982                             next arg; };
2983
2984     /^-I(.*)/       && do { push(@Include_dir,     &grab_arg_arg(*Args,'-I', $1)); next arg; };
2985     /^-L(.*)/       && do { push(@UserLibrary_dir, &grab_arg_arg(*Args,'-L', $1)); next arg; };
2986     /^-l(.*)/       && do { push(@UserLibrary,'-l'.&grab_arg_arg(*Args,'-l', $1)); next arg; };
2987
2988     /^-syslib(.*)/  && do { local($syslib) = &grab_arg_arg(*Args,'-syslib',$1);
2989                             &add_syslib($syslib);
2990                             next arg; };
2991
2992     #=======================================================================
2993     # various flags that we can harmlessly send to one program or another
2994     # (we will later "reclaim" some of the compiler ones now sent to gcc)
2995     #=======================================================================
2996
2997     #---------- this driver itself (ghc) -----------------------------------
2998     # these change what executable is run for each phase:
2999     /^-pgmL(.*)$/   && do { $Unlit      = $1; next arg; };
3000     /^-pgmP(.*)$/   && do { $HsCpp      = $1; next arg; };
3001     /^-pgmC(.*)$/   && do { $HsC        = $1; next arg; };
3002     /^-pgmcO?(.*)$/ && do { $CcRegd     = $1; next arg; }; # the O? for back compat
3003     /^-pgma(.*)$/   && do { $As         = $1; next arg; };
3004     /^-pgml(.*)$/   && do { $Lnkr       = $1; next arg; };
3005     /^-pgmdep(.*)$/ && do { $MkDependHS = $1; next arg; };
3006
3007     #---------- the get-anything-through opts (all pgms) -------------------
3008     # these allow arbitrary option-strings to go to any phase:
3009     /^-optL(.*)$/   && do { push(@Unlit_flags,      $1); next arg; };
3010     /^-optP(.*)$/   && do { push(@HsCpp_flags,      $1); next arg; };
3011     /^-optCrts(.*)$/&& do { push(@HsC_rts_flags,    $1); next arg; };
3012     /^-optC(.*)$/   && do { push(@HsC_flags,        $1); next arg; };
3013     /^-optcpp(.*)$/ && do { push(@Cpp_define,       $1); $Only_preprocess_hc = ($1 eq "-E"); next arg; };
3014     /^-optc(.*)$/   && do { push(@CcBoth_flags,     $1); next arg; };
3015     /^-opta(.*)$/   && do { push(@As_flags,         $1); next arg; };
3016     /^-optl(.*)$/   && do { push(@Ld_flags,         $1); next arg; };
3017     /^-optdll(.*)$/ && do { push(@Dll_flags,        $1); next arg; };
3018     /^-optdep(.*)$/ && do { push(@MkDependHS_flags, $1); next arg; };
3019
3020     #---------- Haskell C pre-processor (hscpp) ----------------------------
3021     /^-D(.*)/       && do { push(@HsCpp_flags, "'-D".&grab_arg_arg(*Args,'-D',$1)."'"); next arg; };
3022     /^-U(.*)/       && do { push(@HsCpp_flags, "'-U".&grab_arg_arg(*Args,'-U',$1)."'"); next arg; };
3023
3024     #---------- post-Haskell "assembler"------------------------------------
3025     /^-ddump-raw-asm$/            && do { $Dump_raw_asm        = 1; next arg; };
3026     /^-ddump-asm-splitting-info$/ && do { $Dump_asm_splitting_info = 1; next arg; };
3027
3028     #---------- Haskell compiler (hsc) -------------------------------------
3029
3030     /^-keep-hc-files?-too$/     && do { $Keep_hc_file_too = 1; next arg; };
3031     /^-keep-s-files?-too$/      && do { $Keep_s_file_too = 1;  next arg; };
3032
3033     /^-fignore-interface-pragmas$/ && do { push(@HsC_flags, $_); next arg; };
3034     /^-fignore-asserts$/           && do { push(@HsC_flags, $_); next arg; };
3035
3036     /^-fno-implicit-prelude$/      && do { $NoImplicitPrelude= 1; push(@HsC_flags, $_); next arg; };
3037
3038      #
3039      # have the compiler proper generate concurrent code,
3040      # really only used when you want to configure your own
3041      # special user compilation way.
3042      #
3043      # (ditto for -fgransim, fscc-profiling, -fparallel and -fticky-ticky)
3044      #
3045     /^-fscc-profiling$/   && do { push(@HsC_flags,$_); next arg; };
3046     /^-fticky-ticky$/     && do { push(@HsC_flags,$_); next arg; };
3047     /^-fgransim$/         && do { push(@HsC_flags,$_); next arg; };
3048     /^-fparallel$/        && do { push(@HsC_flags,$_); next arg; };
3049
3050     /^-split-objs$/     && do {
3051                         if ( $TargetPlatform !~ /^(alpha|hppa1\.1|i386|m68k|mips|powerpc|rs6000|sparc)-/ ) {
3052                             $SplitObjFiles = 0;
3053                             print STDERR "WARNING: don't know how to split objects on this platform: $TargetPlatform\n`-split-objs' option ignored\n";
3054                         } else {
3055                             $SplitObjFiles = 1;
3056                             $HscOut = '-C=';
3057
3058                             push(@HsC_flags, "-fglobalise-toplev-names"); 
3059                             push(@CcBoth_flags, '-DUSE_SPLIT_MARKERS');
3060
3061                             require('ghc-split.prl')
3062                              || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-split.prl!\n");
3063                         }
3064                         next arg; };
3065
3066     /^-unreg$/              && do { $UNREGing = 'u'; next arg; };
3067     /^-funregisterised$/    && do { push(@HsC_flags, $_); next arg; };
3068     /^-fno-asm-mangling$/   && do { $DoAsmMangling = 0; next arg; };
3069
3070     /^-fallow-overlapping-instances$/ && do { push(@HsC_flags, $_); next arg; };
3071     /^-fallow-undecidable-instances$/ && do { push(@HsC_flags, $_); next arg; };
3072     /^-fhistory-size.*$/              && do { push(@HsC_flags, $_); next arg; };
3073     /^-fdicts-strict$/                && do { push(@HsC_flags, $_); next arg; };
3074     /^-fglasgow-exts$/
3075                 && do { push(@HsC_flags, $_);
3076
3077                         # -fglasgow-exts implies -syslib exts
3078                         &add_syslib('exts');
3079
3080                         next arg; };
3081
3082     /^-fspeciali[sz]e$/
3083                 && do { $Oopt_DoSpecialise = '-fspecialise'; next arg; };
3084     /^-fno-speciali[sz]e$/
3085                 && do { $Oopt_DoSpecialise = ''; next arg; };
3086
3087     /^-fusagesp$/
3088                 && do {  $Oopt_UsageSPInf = '-fusagesp';
3089                          push (@HsC_flags, '-fusagesp-on'); next arg; };
3090
3091     /^-fcompiling-prelude$/ && do { $CompilingPrelude=1; push(@HsC_flags, $_); next arg; };
3092
3093 # Now the foldr/build options, which are *on* by default (for -O).
3094
3095     /^-ffoldr-build$/
3096                     && do { $Oopt_FoldrBuild = 1; 
3097                             #print "Yes F/B\n";
3098                             next arg; };
3099
3100     /^-fno-foldr-build$/
3101                     && do { $Oopt_FoldrBuild = 0; 
3102                             next arg; };
3103
3104     # --------------- Renamer -------------
3105
3106
3107     /^-fno-prune-tydecls$/     && do { push(@HsC_flags, $_); next arg; };
3108     /^-fno-prune-instdecls$/     && do { push(@HsC_flags, $_); next arg; };
3109
3110     # ---------------
3111
3112     /^-fasm-(.*)$/  && do { $HscOut = '-S='; next arg; }; # force using nativeGen
3113     /^-fvia-[cC]$/          && do { $HscOut = '-C='; next arg; }; # force using C compiler
3114
3115     # ---------------
3116
3117     /^-funfolding-.*$/
3118                     && do { push(@HsC_flags, $_); next arg };
3119
3120     /^-funfold-casms-in-hi-file$/
3121                     && do { push(@HsC_flags, $_); next arg };
3122
3123     /^(-fmax-simplifier-iterations)(.*)$/
3124                     && do { $Oopt_MaxSimplifierIterations = $1 . &grab_arg_arg(*Args,$1, $2);
3125                             next arg; };
3126
3127     /^-fno-pedantic-bottoms$/
3128                     && do { $Oopt_PedanticBottoms = ''; next arg; };
3129
3130     /^-fno-pre-inlining$/
3131                     && do { push(@HsC_flags, $_); next arg };
3132
3133     /^-fno-let-from-(case|app|strict-let)$/ # experimental, really (WDP 95/10)
3134                     && do { push(@HsC_flags, $_); next arg; };
3135
3136     /^-funbox-strict-fields$/
3137                    && do { push(@HsC_flags, $_); next arg; };
3138
3139     # --------------- Warnings etc. ------
3140
3141     /^-fwarn-(.*)$/      && do { push(@HsC_flags, $_); next arg; };
3142
3143     /^-fno-(.*)$/   && do { push(@HsC_antiflags, "-f$1");
3144                             &squashHscFlag("-f$1");
3145                             next arg; };
3146
3147     /^-W$/          && do { push(@HsC_flags, @MinusWOpts); next arg; };
3148     /^-Wall$/       && do { push(@HsC_flags, @MinusWallOpts); next arg; };
3149     /^(-Wnot|w)$/   && do { foreach (@Hsc_flags) {
3150                                 /^-fwarn-(.*)$/ && do { $_=''; };
3151                             };
3152                             push(@HsC_antiflags, @StandardWarnings);
3153                             next arg; };
3154
3155     # --------------- fun stuff ----------------
3156
3157     /^-freport-compile$/ && do { push(@HsC_flags, $_); next arg; };
3158
3159     # --------------- platform specific flags (for gcc mostly) ----------------
3160
3161     /^-mlong-calls$/ && do { # for GCC for HP-PA boxes,
3162                              # for 2.6.x..?, does not apply for 2.7.2
3163                              # any longer.
3164                             unshift(@CcBoth_flags, ( $_ ));
3165                             next arg; };
3166
3167     /^-m(v8|sparclite|cypress|supersparc|cpu=(cypress|supersparc))$/
3168                      && do { # for GCC for SPARCs
3169                             unshift(@CcBoth_flags, ( $_ ));
3170                             next arg; };
3171
3172     /^-monly-([432])-regs/ && do { # for iX86 boxes only; no effect otherwise
3173                             $StolenX86Regs = $1;
3174                             next arg; };
3175
3176     #*************** ... and lots of debugging ones (form: -d* )
3177
3178     # -d(no-)core-lint is done this way so it is turn-off-able.
3179     /^-dcore-lint/       && do { $CoreLint = '-dcore-lint'; next arg; };
3180     /^-dno-core-lint/    && do { $CoreLint = '';            next arg; };
3181     # Ditto for USP lint
3182     /^-dusagesp-lint/    && do { $USPLint = '-dusagesp-lint'; next arg; };
3183     /^-dno-usagesp-lint/ && do { $USPLint = '';               next arg; };
3184     # Ditto for STG lint
3185     /^-dstg-lint/       && do { $StgLint = '-dstg-lint'; next arg; };
3186     /^-dno-stg-lint/    && do { $StgLint = '';           next arg; };
3187
3188     /^-d(dump|ppr)-/         && do { push(@HsC_flags, $_); next arg; };
3189     /^-dverbose-(simpl|stg)/ && do { push(@HsC_flags, $_); next arg; };
3190     /^-dshow-passes/         && do { push(@HsC_flags, $_); next arg; };
3191     /^-dshow-rn-stats/       && do { push(@HsC_flags, $_); next arg; };
3192     /^-dshow-rn-trace/       && do { push(@HsC_flags, $_); next arg; };
3193     /^-dsource-stats/        && do { push(@HsC_flags, $_); next arg; };
3194     /^-dsimplifier-stats/    && do { push(@HsC_flags, $_); next arg; };
3195     /^-dstg-stats/           && do { $Oopt_StgStats = $_; next arg; };
3196
3197     #*************** ... and now all these -R* ones for its runtime system...
3198
3199     /^-Rscale-sizes?(.*)/ && do {
3200         $Scale_sizes_by = &grab_arg_arg(*Args,'-Rscale-sizes', $1);
3201         next arg; };
3202
3203     /^(-H|-Rmax-heapsize)(.*)/ && do {
3204         local($heap_size) = &grab_arg_arg(*Args,$1, $2);
3205         if ($heap_size =~ /(\d+)[Kk]$/) {
3206             $heap_size = $1 * 1000;
3207         } elsif ($heap_size =~ /(\d+)[Mm]$/) {
3208             $heap_size = $1 * 1000 * 1000;
3209         } elsif ($heap_size =~ /(\d+)[Gg]$/) {
3210             $heap_size = $1 * 1000 * 1000 * 1000;
3211         }
3212         if ($heap_size <= 0) {
3213             print STDERR "$Pgm: resetting heap-size to zero!!! $heap_size\n";
3214             $Specific_heap_size = 0;
3215         
3216         # if several heap sizes given, take the largest...
3217         } elsif ($heap_size >= $Specific_heap_size) {
3218             $Specific_heap_size = $heap_size;
3219         } else {
3220             print STDERR "$Pgm: ignoring heap-size-setting option ($_)...not the largest seen\n";
3221         }
3222         next arg; };
3223
3224     /^(-K|Rmax-(stk|stack)size)(.*)/ && do {
3225         local($flag) = $1;
3226         local($stk_size) = &grab_arg_arg(*Args,'-Rmax-stksize', $3);
3227         if ($stk_size =~ /(\d+)[Kk]$/) {
3228             $stk_size = $1 * 1000;
3229         } elsif ($stk_size =~ /(\d+)[Mm]$/) {
3230             $stk_size = $1 * 1000 * 1000;
3231         } elsif ($stk_size =~ /(\d+)[Gg]$/) {
3232             $stk_size = $1 * 1000 * 1000 * 1000;
3233         }
3234         if ($stk_size <= 0) {
3235             print STDERR "$Pgm: resetting stack-size to zero!!! $stk_size\n";
3236             $Specific_stk_size = 0;
3237
3238         # if several stack sizes given, take the largest...
3239         } elsif ($stk_size >= $Specific_stk_size) {
3240             $Specific_stk_size = $stk_size;
3241         } else {
3242             print STDERR "$Pgm: ignoring stack-size-setting option ($flag $stk_size)...not the largest seen\n";
3243         }
3244         next arg; };
3245
3246     /^-Rgc-stats$/ && do {  $CollectingGCstats++;
3247                             # the two RTSs do this diff ways; we will try to compensate
3248                             next arg; };
3249
3250     /^-Rghc-timing/ && do { $CollectGhcTimings = 1; next arg; };
3251
3252     #---------- C high-level assembler (gcc) -------------------------------
3253     /^-(Wall|ansi|pedantic)$/ && do { push(@CcBoth_flags, $_); next arg; };
3254
3255     # -dgcc-lint is a useful way of making GCC very fussy.
3256     # From alan@spri.levels.unisa.edu.au (Alan Modra).
3257     /^-dgcc-lint$/ && do { push(@CcBoth_flags, '-Wall -Wpointer-arith -Wbad-function-cast -Wcast-qual -Wstrict-prototypes -Wmissing-prototypes -Wmissing-declarations -Wnested-externs'); next arg; };
3258     # An alternate set, from mark@sgcs.com (Mark W. Snitily)
3259     # -Wall -Wstrict-prototypes -Wmissing-prototypes -Wcast-align -Wshadow
3260
3261     # inject "#include <wurble>" into the compiler's C output!
3262
3263     /^-#include(.*)/    && do {
3264         local($to_include) = &grab_arg_arg(*Args,'-#include', $1);
3265         push(@CcInjects, "#include $to_include\n");
3266         next arg; };
3267
3268     #---------- Linker (gcc, really) ---------------------------------------
3269
3270     /^-static$/         && do { $Static=1; push(@Ld_flags, $_); next arg; };
3271     /^-no-hs-main$/     && do { $NoHaskellMain=1; next arg;    };
3272
3273     #---------- mixed cc and linker magic ----------------------------------
3274     # this optimisation stuff is finally sorted out later on...
3275
3276     /^-O2-for-C$/ && do { $MinusO2ForC = 1; next arg; };
3277
3278     /^-O[1-2]?$/ && do {
3279                 local($opt_lev) = ( /^-O2$/ ) ? 2 : 1; # max 'em
3280                 $OptLevel = ( $opt_lev > $OptLevel ) ? $opt_lev : $OptLevel;
3281
3282                 $HscOut = '-C=' if $OptLevel == 2; # force use of C compiler
3283                 next arg; };
3284
3285     /^-Onot$/   && do { $OptLevel = 0; next arg; }; # # set it to <no opt>
3286
3287     /^-Ofile(.*)/ && do {
3288                 $OptLevel = 3;
3289                 local($ofile) = &grab_arg_arg(*Args,'-Ofile', $1);
3290                 @HsC_minusO3_flags = ();
3291
3292                 open(OFILE, "< $ofile") || die "Can't open $ofile!\n";
3293                 while (<OFILE>) {
3294                     chop;
3295                     s/\#.*//;       # death to comments
3296                     s/[ \t]+//g;    # death to whitespace
3297                     next if /^$/;   # ditto, blank lines
3298                     s/([()*{}])/\\$1/g;    # protect shell metacharacters
3299                     if ( /^C:(.*)/ ) {
3300                         push(@CcBoth_flags, $1);
3301                     } else {
3302                         push(@HsC_minusO3_flags, $_);
3303                     }
3304                 }
3305                 close(OFILE);
3306                 next arg; };
3307
3308     /^-debug$/  && do { # all this does is mark a .hc/.o as "debugging"
3309                         # in the consistency info
3310                         $DEBUGging = 'd';
3311                         next arg; };
3312
3313     #---------- linking .a file --------------------------------------------
3314
3315     /^-Main(.*)/ && do {
3316                 # specifies main or mainPrimIO to be linked
3317                 $Ld_main = $1;
3318                 next arg; }; 
3319
3320     #---------- catch unrecognized flags -----------------------------------
3321
3322     /^-./ && do {
3323         print STDERR "$Pgm: unrecognised option: $_\n";
3324         $Status++;
3325         next arg; };
3326
3327 }
3328
3329 } # end of processArgs
3330
3331 \end{code}