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