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