b8410cd2c96e0d021f1a1f2e26609cc2a24738a7
[ghc-hetmet.git] / mk / target.mk
1 #################################################################################
2 #
3 #                       target.mk
4 #
5 #               Standard targets for fptools
6 #
7 #################################################################################
8
9 #
10 # This file contain three groups of target rules:
11 #
12 # 1.  FPtools targets
13 #       depend*
14 #       runtests*
15 #
16 # 2.  GNU standard targets
17 #       all*
18 #       install* uninstall installcheck installdirs
19 #       clean* distclean* mostlyclean* maintainer-clean*
20 #       tags*
21 #       info dvi ps
22 #       dist binary-dist
23 #       check
24 #
25 # 3. Some of the above targets have a version that
26 #    recursively invokes that target in sub-directories.
27 #    This relies on the importing Makefile setting SUBDIRS
28 #
29 #    The recursive targets are marked with a * above
30 #
31
32
33
34 #
35
36
37 ##################################################################
38 #
39 #               Recursive stuff
40 #
41 # At the top of the file so that recursive makes happen before
42 # makes in the main directory. This is needed for some targets,
43 # e.g. when building DLLs in hslibs.
44 #
45 ##################################################################
46
47 # Here are the diabolically clever rules that
48
49 # (a) for each "recursive target" <t>
50 #     propagates "make <t>" to directories in SUBDIRS
51 #
52 # (b) when SUBDIRS is empty,
53 #     for each "multi-way-target" <t>
54 #     calls "make -way=w <t>" for each w in $(WAYS)
55 #
56 #     This has the effect of making the standard target
57 #     in each of the specified ways (as well as in the normal way
58
59 # Controlling variables
60 #       WAYS    = extra (beyond the normal way) ways to build things in
61 #       SUBDIRS = subdirectories to recurse into
62
63 # No ways, so iterate over the SUBDIRS
64
65 # note about recursively invoking make: we'd like make to drop all the
66 # way back to the top level if it fails in any of the
67 # sub(sub-...)directories.  This is done by setting the -e flag to the
68 # shell during the loop, which causes an immediate failure if any of
69 # the shell commands fail.
70
71 # One exception: if the user gave the -i or -k flag to make in the
72 # first place, we'd like to reverse this behaviour.  So we check for
73 # these flags, and set the -e flag appropriately.  NOTE: watch out for
74 # the --no-print-directory flag which is passed to recursive
75 # invocations of make.
76 #
77 # NOTE: Truly weird use of exit below to stop the for loop dead in
78 # its tracks should any of the sub-makes fail. By my reckoning, 
79 #  "cmd || exit $?" should be equivalent to "cmd"
80
81 ifneq "$(SUBDIRS)" ""
82
83 all docs runtests boot TAGS clean distclean mostlyclean maintainer-clean install info html ps dvi txt::
84         @echo "------------------------------------------------------------------------"
85         @echo "===fptools== Recursively making \`$@' in $(SUBDIRS) ..."
86         @echo "PWD = $(shell pwd)"
87         @echo "------------------------------------------------------------------------"
88 # Don't rely on -e working, instead we check exit return codes from sub-makes.
89         @case '${MFLAGS}' in *-[ik]*) x_on_err=0;; *-r*[ik]*) x_on_err=0;; *) x_on_err=1;; esac; \
90         for i in $(SUBDIRS); do \
91           echo "------------------------------------------------------------------------"; \
92           echo "==fptools== $(MAKE) $@ $(MFLAGS);"; \
93           echo " in $(shell pwd)/$$i"; \
94           echo "------------------------------------------------------------------------"; \
95           $(MAKE) --no-print-directory -C $$i $(MFLAGS) $@; \
96           if [ $$? -eq 0 -o $$x_on_err -eq 0 ] ;  then true; else exit 1; fi; \
97         done
98         @echo "------------------------------------------------------------------------"
99         @echo "===fptools== Finished making \`$@' in $(SUBDIRS) ..."
100         @echo "PWD = $(shell pwd)"
101         @echo "------------------------------------------------------------------------"
102
103 dist ::
104 # Don't rely on -e working, instead we check exit return codes from sub-makes.
105         @case '${MFLAGS}' in *-[ik]*) x_on_err=0;; *-r*[ik]*) x_on_err=0;; *) x_on_err=1;; esac; \
106         for i in $(SUBDIRS) ; do \
107           $(MKDIRHIER_PREFIX)mkdirhier $(SRC_DIST_DIR)/$$i; \
108           $(MAKE) -C $$i $(MFLAGS) $@ SRC_DIST_DIR=$(SRC_DIST_DIR)/$$i; \
109           if [ $$? -eq 0 ] ;  then true; else exit $$x_on_err; fi; \
110         done
111 endif
112
113 # The default dist rule:
114 #
115 # copy/link the contents of $(SRC_DIST_FILES) into the
116 # shadow distribution tree. SRC_DIST_FILES contain the
117 # build-generated files that you want to include in
118 # a source distribution.
119 #
120 #
121 ifneq "$(SRC_DIST_FILES)" ""
122 dist::
123         @for i in $(SRC_DIST_FILES); do                  \
124           if ( echo "$$i" | grep "~" >/dev/null 2>&1 ); then     \
125             echo $(LN_S) `pwd`/`echo $$i | sed -e "s/^\([^~]*\)~.*/\1/g"` $(SRC_DIST_DIR)/`echo $$i | sed -e "s/.*~\(.*\)/\1/g"` ; \
126             $(LN_S) `pwd`/`echo $$i | sed -e "s/^\([^~]*\)~.*/\1/g"` $(SRC_DIST_DIR)/`echo $$i | sed -e "s/.*~\(.*\)/\1/g"` ; \
127           else \
128             if (test -f "$$i"); then                       \
129               echo $(LN_S) `pwd`/$$i $(SRC_DIST_DIR)/$$i ; \
130               $(LN_S) `pwd`/$$i $(SRC_DIST_DIR)/$$i ;      \
131              fi;                                           \
132           fi; \
133         done;
134 endif
135
136
137 #
138 # Selectively building subdirectories.
139 #
140 #
141 ifneq "$(SUBDIRS)" ""
142 $(SUBDIRS) ::
143           $(MAKE) -C $@ $(MFLAGS)
144 endif
145
146 ##################################################################
147 #               FPtools standard targets
148 #
149 # depend:
150 #
151 #  The depend target has to cope with a set of files that may have
152 #  different ways of computing their dependencies, i.e., a Haskell
153 #  module's dependencies are computed differently from C files.
154 #
155 # Note that we don't compute dependencies automatically, i.e., have the
156 # .depend file be a target that is dependent on the Haskell+C sources,
157 # and then have the `depend' target depend on `.depend'. The reason for
158 # this is that when GNU make is processing the `include .depend' statement
159 # it records .depend as being a Makefile. Before doing any other processing,
160 # `make' will try to check to see if the Makefiles are up-to-date. And,
161 # surprisingly enough, .depend has a rule for it, so if any of the source
162 # files change, it will be invoked, *regardless* of what target you're making.
163 #
164 # So, for now, the dependencies has to be re-computed manually via `make depend'
165 # whenever a module changes its set of imports. Doing what was outlined above
166 # is only a small optimisation anyway, it would avoid the recomputation of
167 # dependencies if the .depend file was newer than any of the source modules.
168 #
169 .PHONY: depend
170
171 # Compiler produced files that are targets of the source's imports.
172 MKDEPENDHS_OBJ_SUFFICES=o
173
174 depend :: $(MKDEPENDHS_SRCS) $(MKDEPENDC_SRCS)
175         @$(RM) .depend
176         @touch .depend
177 ifneq "$(DOC_SRCS)" ""
178         $(MKDEPENDLIT) -o .depend $(MKDEPENDLIT_OPTS) $(filter %.lit,$(DOC_SRCS))
179 endif
180 ifneq "$(MKDEPENDC_SRCS)" ""
181         $(MKDEPENDC) -f .depend $(MKDEPENDC_OPTS) $(foreach way,$(WAYS),-s $(way)) -- $(CC_OPTS) -- $(MKDEPENDC_SRCS) 
182 endif
183 ifneq "$(MKDEPENDHS_SRCS)" ""
184         $(MKDEPENDHS) -M -optdep-f -optdep.depend $(foreach way,$(WAYS),-optdep-s -optdep$(way)) $(foreach obj,$(MKDEPENDHS_OBJ_SUFFICES),-optdep-o -optdep$(obj)) $(MKDEPENDHS_OPTS) $(HC_OPTS) $(MKDEPENDHS_SRCS)
185 endif
186
187
188 ##################################################################
189 #                       boot
190 #
191 #  The boot target, at a minimum generates dependency information
192
193 .PHONY: boot
194 boot :: depend
195
196
197 ##################################################################
198 #               GNU Standard targets
199 #
200 #       Every Makefile should define the following targets
201
202 # `all'
203 #      Compile the entire program. This should be the default target.
204 #      This target need not rebuild any documentation files; Info files
205 #      should normally be included in the distribution, and DVI files
206 #      should be made only when explicitly asked for.
207
208 # `install'
209 #      Compile the program and copy the executables, libraries, and so on
210 #      to the file names where they should reside for actual use. If
211 #      there is a simple test to verify that a program is properly
212 #      installed, this target should run that test.
213
214 #      The commands should create all the directories in which files are
215 #      to be installed, if they don't already exist. This includes the
216 #      directories specified as the values of the variables prefix and
217 #      exec_prefix , as well as all subdirectories that are needed. One
218 #      way to do this is by means of an installdirs target as described
219 #      below.
220
221 #      Use `-' before any command for installing a man page, so that make
222 #      will ignore any errors.  This is in case there are systems that
223 #      don't have the Unix man page documentation system installed.
224
225 #      The way to install Info files is to copy them into `$(infodir)'
226 #      with $(INSTALL_DATA) (see Command Variables), and then run the
227 #      install-info program if it is present.  install-info is a script
228 #      that edits the Info `dir' file to add or update the menu entry for
229 #      the given Info file; it will be part of the Texinfo package. Here
230 #      is a sample rule to install an Info file:
231
232 #            $(infodir)/foo.info: foo.info # There may be a newer info
233 #            file in . than in srcdir.
234 #                    -if test -f foo.info; then d=.; \
235 #                     else d=$(srcdir); fi; \ $(INSTALL_DATA)
236 #                    $$d/foo.info $@; \ # Run install-info only if it
237 #            exists.  # Use `if' instead of just prepending `-' to the
238 #            # line so we notice real errors from install-info.  # We
239 #            use `$(SHELL) -c' because some shells do not # fail
240 #            gracefully when there is an unknown command.
241 #                    if $(SHELL) -c 'install-info --version' \
242 #                       >/dev/null 2>&1; then \ install-info
243 #                      --infodir=$(infodir) $$d/foo.info; \ else true;
244 #                    fi
245
246 # `uninstall'
247 #      Delete all the installed files that the `install' target would
248 #      create (but not the noninstalled files such as `make all' would
249 #      create).
250
251 # `clean'
252
253 #      Delete all files from the current directory that are normally
254 #      created by building the program.  Don't delete the files that
255 #      record the configuration. Also preserve files that could be made
256 #      by building, but normally aren't because the distribution comes
257 #      with them.
258
259 #      Delete `.dvi' files here if they are not part of the
260 #      distribution.
261
262 # `distclean'
263 #      Delete all files from the current directory that are created by
264 #      configuring or building the program. If you have unpacked the
265 #      source and built the program without creating any other files,
266 #      `make distclean' should leave only the files that were in the
267 #      distribution.
268
269 # `mostlyclean'
270 #      Like `clean', but may refrain from deleting a few files that
271 #      people normally don't want to recompile. For example, the
272 #      `mostlyclean' target for GCC does not delete `libgcc.a', because
273 #      recompiling it is rarely necessary and takes a lot of time.
274
275 # `maintainer-clean'
276 #      Delete everything from the current directory that can be
277 #      reconstructed with this Makefile.  This typically includes
278 #      everything deleted by distclean , plus more: C source files
279 #      produced by Bison, tags tables, Info files, and so on.
280
281 #      One exception, however: `make maintainer-clean' should not delete
282 #      `configure' even if `configure' can be remade using a rule in the
283 #      Makefile. More generally, `make maintainer-clean' should not delete
284 #      anything that needs to exist in order to run `configure' and then
285 #      begin to build the program.
286
287 # `TAGS'
288 #      Update a tags table for this program.
289
290 # `info'
291 #      Generate any Info files needed. The best way to write the rules is
292 #      as follows:
293
294 #            info: foo.info
295
296 #            foo.info: foo.texi chap1.texi chap2.texi
297 #                    $(MAKEINFO) $(srcdir)/foo.texi
298
299 #      You must define the variable MAKEINFO in the Makefile. It should
300 #      run the makeinfo program, which is part of the Texinfo
301 #      distribution.
302
303 # `dvi' `ps'
304 #      Generate DVI files for all TeXinfo documentation. For example:
305
306 #            dvi: foo.dvi
307
308 #            foo.dvi: foo.texi chap1.texi chap2.texi
309 #                    $(TEXI2DVI) $(srcdir)/foo.texi
310
311 #      You must define the variable TEXI2DVI in the Makefile. It should
312 #      run the program texi2dvi , which is part of the Texinfo
313 #      distribution. Alternatively, write just the dependencies, and
314 #      allow GNU Make to provide the command.
315 #
316 #      ps is a FPtools addition for Postscript files
317
318 # `dist' `binary-dist'
319 #      Create a distribution tar file for this program. The tar file
320 #      should be set up so that the file names in the tar file start with
321 #      a subdirectory name which is the name of the package it is a
322 #      distribution for. This name can include the version number.
323
324 #      For example, the distribution tar file of GCC version 1.40 unpacks
325 #      into a subdirectory named `gcc-1.40'.
326
327 #      The easiest way to do this is to create a subdirectory
328 #      appropriately named, use ln or cp to install the proper files in
329 #      it, and then tar that subdirectory.
330
331 #      The dist target should explicitly depend on all non-source files
332 #      that are in the distribution, to make sure they are up to date in
333 #      the distribution. See Making Releases.
334 #
335 #       binary-dist is an FPtools addition for binary distributions
336
337 # `check'
338 #      Perform self-tests (if any). The user must build the program
339 #      before running the tests, but need not install the program; you
340 #      should write the self-tests so that they work when the program is
341 #      built but not installed.
342
343 # The following targets are suggested as conventional names, for programs
344 # in which they are useful.
345
346 # installcheck
347 #      Perform installation tests (if any). The user must build and
348 #      install the program before running the tests. You should not
349 #      assume that `$(bindir)' is in the search path.
350
351 # installdirs
352 #      It's useful to add a target named `installdirs' to create the
353 #      directories where files are installed, and their parent
354 #      directories. There is a script called `mkinstalldirs' which is
355 #      convenient for this; find it in the Texinfo package.
356 #      (FPTOOLS: we use a close relative of the suggested script, situated
357 #       in glafp-utils/mkdirhier -- SOF)
358
359
360
361
362 ###########################################
363 #
364 #       Targets: "all"
365 #
366 ###########################################
367
368 # For each of these variables that is defined
369 # we generate one "all" rule and one rule for the variable itself:
370 #
371 #       HS_PROG         Haskell program
372 #       C_PROG          C program
373 #       LIBRARY         Library
374 #       SCRIPT_PROG     Script (e.g. Perl script)
375 #
376 # For details of exactly what rule is generated, see the
377 # relevant section below
378
379 .PHONY: all
380
381 #----------------------------------------
382 #       Haskell programs
383
384 ifneq "$(HS_PROG)" ""
385 all :: $(HS_PROG)
386
387 $(HS_PROG) :: $(HS_OBJS)
388         $(HC) -o $@ $(HC_OPTS) $(LD_OPTS) $(HS_OBJS) $(LIBS)
389 endif
390
391 #----------------------------------------
392 #       C programs
393
394 ifneq "$(C_PROG)" ""
395 all :: $(C_PROG)
396
397 $(C_PROG) :: $(C_OBJS)
398         $(CC) -o $@ $(CC_OPTS) $(LD_OPTS) $(C_OBJS) $(LIBS)
399 endif
400
401
402 #----------------------------------------
403 #       Libraries/archives
404
405 ifneq "$(LIBRARY)" ""
406 all :: $(LIBRARY)
407
408
409 define BUILD_LIB
410 $(RM) $@
411 $(AR) $(AR_OPTS) $@ $(STUBOBJS) $(LIBOBJS)
412 $(RANLIB) $@
413 endef
414
415 #
416 # For Haskell object files, we might have chosen to split
417 # up the object files. Test for whether the library being
418 # built is consisting of Haskell files by (hackily) checking
419 # whether HS_SRCS is empty or not.
420 #
421
422 ifneq "$(HS_SRCS)" ""
423 ifeq "$(SplitObjs)" "YES"
424
425 SRC_HC_OPTS += -split-objs
426
427 define BUILD_LIB
428 $(RM) $@
429 TMPDIR=$(TMPDIR); export TMPDIR; ( echo $(STUBOBJS) ; $(FIND) $(patsubst %.$(way_)o,%,$(LIBOBJS)) -name '*.$(way_)o' -print ) | xargs ar q $@
430 $(RANLIB) $@
431 endef
432
433 # Extra stuff for compiling Haskell files with $(SplitObjs):
434
435 HC_SPLIT_PRE= \
436 if [ ! -d $(basename $@) ]; then mkdir $(basename $@); else \
437  $(FIND) $(basename $@) -name '*.$(way_)o' -print | xargs $(RM) __rm_food ; fi
438 HC_SPLIT_POST  = touch $@
439
440 SRC_HC_PRE_OPTS  += $(HC_SPLIT_PRE) ;
441 SRC_HC_POST_OPTS += $(HC_SPLIT_POST) ;
442
443 #
444 # If (Haskell) object files are split, cleaning up 
445 # consist of descending into the directories where
446 # the myriads of object files have been put.
447 #
448
449 extraclean ::
450         $(FIND) $(patsubst %.$(way_)o,%,$(HS_OBJS)) -name '*.$(way_)o' -print | xargs $(RM) __rm_food
451         -rmdir $(patsubst %.$(way_)o,%,$(HS_OBJS)) > /dev/null 2>&1
452
453 endif # $(SplitObjs)
454 endif # $(HS_SRCS)
455
456 #
457 # Remove local symbols from library objects if requested.
458 #
459
460 ifeq "$(StripLibraries)" "YES"
461 ifeq "$(SplitObjs)" "YES"
462 SRC_HC_POST_OPTS += \
463   for i in $(basename $@)/*; do \
464         ld -r -x -o $$i.tmp $$i; \
465         $(MV) $$i.tmp $$i; \
466   done
467 else
468 SRC_HC_POST_OPTS += \
469   ld -r -x -o $@.tmp $@; $(MV) $@.tmp $@
470 endif
471 endif
472
473 $(LIBRARY) :: $(STUBOBJS) $(LIBOBJS)
474         $(BUILD_LIB)
475 endif
476
477 #----------------------------------------
478 #       Building Win32 DLLs
479 #
480 ifeq "$(way)" "dll"
481
482 ifeq "$(DLL_NAME)" ""
483 DLL_NAME = $(patsubst %.a, %.dll, $(subst lib,,$(LIBRARY)))
484 endif
485
486 all :: $(DLL_NAME)
487
488 ifeq "$(DLL_IMPLIB_NAME)" ""
489 DLL_IMPLIB_NAME = $(patsubst %.a, %_imp.a, $(LIBRARY))
490 endif
491
492 $(DLL_NAME) :: $(LIBRARY)
493         $(BLD_DLL) --output-lib $(DLL_IMPLIB_NAME) -o $(DLL_NAME) $(LIBRARY) $(BLD_DLL_OPTS)
494 endif
495
496 #
497 # Version information is baked into a DLL by having the DLL include DllVersionInfo.o.
498 # The version info contains two user tweakables: DLL_VERSION and DLL_VERSION_NAME.
499 # (both are given sensible defaults though.)
500 #
501 # Note: this will not work as expected with Cygwin B20.1; you need a more recent
502 #       snapshot of binutils (to pick up windres bugfixes.)
503
504 ifndef DLL_VERSION
505 DLL_VERSION=$(ProjectVersion)
506 endif
507
508 ifndef DLL_VERSION_NAME
509 DLL_VERSION_NAME="http://www.haskell.org/ghc"
510 endif
511
512 ifndef DLL_DESCRIPTION
513 DLL_DESCRIPTION="A GHC-compiled DLL"
514 endif
515
516 ifndef EXE_VERSION
517 EXE_VERSION=$(ProjectVersion)
518 endif
519
520 ifndef EXE_VERSION_NAME
521 EXE_VERSION_NAME="http://www.haskell.org/ghc"
522 endif
523
524 ifndef EXE_DESCRIPTION
525 EXE_DESCRIPTION="A GHC-compiled binary"
526 endif
527
528 #
529 # Little bit of lo-fi mangling to get at the right set of settings depending
530 # on whether we're generating the VERSIONINFO for a DLL or EXE
531
532 DLL_OR_EXE=$(subst VersionInfo.rc,,$@)
533 VERSION_FT=$(subst Dll, 0x2L, $(subst Exe, 0x1L, $(DLL_OR_EXE)))
534 VERSION_RES_NAME=$(subst Exe,$(EXE_VERSION_NAME), $(subst Dll, $(DLL_VERSION_NAME),$(DLL_OR_EXE)))
535 VERSION_RES=$(subst Exe,$(EXE_VERSION), $(subst Dll, $(DLL_VERSION),$(DLL_OR_EXE)))
536 VERSION_DESC=$(subst Exe,$(EXE_DESCRIPTION), $(subst Dll, $(DLL_DESCRIPTION),$(DLL_OR_EXE)))
537
538 DllVersionInfo.rc ExeVersionInfo.rc:
539         $(RM) DllVersionInfo.rc
540         echo "1 VERSIONINFO"                > $@
541         echo "FILEVERSION 1,0,0,1"         >> $@
542         echo "PRODUCTVERSION 1,0,0,1"      >> $@
543         echo "FILEFLAGSMASK 0x3fL"         >> $@
544         echo "FILEOS 0x4L"                 >> $@
545         echo "FILETYPE $(VERSION_FT)"      >> $@
546         echo "FILESUBTYPE 0x0L"            >> $@
547         echo "BEGIN"                       >> $@
548         echo " BLOCK \"StringFileInfo\""   >> $@
549         echo " BEGIN"                      >> $@
550         echo "  BLOCK \"040904B0\""        >> $@
551         echo "  BEGIN"                     >> $@
552         echo "   VALUE \"CompanyName\", \"$(VERSION_RES_NAME)\\0\"" >> $@
553         echo "   VALUE \"FileVersion\", \"$(VERSION_RES)\\0\"" >> $@
554         echo "   VALUE \"ProductVersion\", \"$(VERSION_RES)\\0\"" >> $@
555         echo "   VALUE \"FileDescription\", \"$(VERSION_DESC)\\0\"" >> $@
556         echo "  END" >> $@
557         echo " END" >> $@
558         echo " BLOCK \"VarFileInfo\""  >> $@
559         echo " BEGIN" >> $@
560         echo "  VALUE \"Translation\", 0x0409, 1200" >> $@
561         echo " END" >> $@
562         echo "END" >> $@
563
564 #----------------------------------------
565 #       Script programs
566
567 ifneq "$(SCRIPT_PROG)" ""
568
569 # To produce a fully functional script, you may
570 # have to add some configuration variables at the top of 
571 # the script, i.e., the compiler driver needs to know
572 # the path to various utils in the build tree for instance.
573 #
574 # To have the build rule for the script automatically do this
575 # for you, set the variable SCRIPT_SUBST_VARS to the list of
576 # variables you need to put in.
577
578 #
579 # SCRIPT_SUBST creates a string of echo commands that
580 # will when evaluated append the (perl)variable name and its value 
581 # to the target it is used for, i.e.,
582 #
583 #    A=foo
584 #    B=bar
585 #    SCRIPT_SUBST_VARS = A B
586 #    SCRIPT_SUBST=echo "$""A=\"foo\";" >> $@; echo "$""B=\"bar\";" >> $@
587 #
588 #    so if you have a rule like the following
589 #    
590 #     foo:
591 #         @(RM) $@
592 #         @(TOUCH) $@
593 #         @eval $(SCRIPT_SUBST)
594 #
595 #    `make foo' would create a file `foo' containing the following
596 #
597 #    % cat foo
598 #    $A=foo;
599 #    $B=bar;
600 #    %
601 #
602 # ToDo: make this work for shell scripts (drop the initial $).
603 #
604 ifeq "$(INTERP)" "$(SHELL)"
605 SCRIPT_SUBST=$(foreach val,$(SCRIPT_SUBST_VARS),"echo \"$(val)=\\\"$($(val))\\\";\" >> $@;")
606 else
607 SCRIPT_SUBST=$(foreach val,$(SCRIPT_SUBST_VARS),"echo \"$$\"\"$(val)=\\\"$($(val))\\\";\" >> $@;")
608 endif
609
610 all :: $(SCRIPT_PROG)
611
612 #
613 # #! support under cygwin32 is not quite there yet, 
614 # so we rely on the eval `trick' instead. On all other
615 # platforms, we prepend #!$(INTERP)  -- SOF 6/97
616
617
618 $(SCRIPT_PROG) :: $(SCRIPT_OBJS)
619         $(RM) $@
620         @echo Creating $@...
621 ifeq "$(INTERP)" "perl"
622         echo "#! "$(PERL) > $@
623 else
624 ifneq "$(INTERP)" ""
625         @echo "#!"$(INTERP) > $@
626 else
627         @touch $@
628 endif
629 endif
630 ifneq "$(SCRIPT_PREFIX_FILES)" ""
631         @cat $(SCRIPT_PREFIX_FILES) >> $@
632 endif
633         @eval $(SCRIPT_SUBST) 
634         @cat $(SCRIPT_OBJS) >> $@
635         @chmod a+x $@
636         @echo Done.
637 endif
638
639 # links to script programs: we sometimes install a script as
640 # <name>-<version> with a link from <name> to the real script.
641
642 ifneq "$(SCRIPT_LINK)" ""
643 all :: $(SCRIPT_LINK)
644
645 #
646 # Don't want to overwrite $(SCRIPT_LINK)s that aren't symbolic
647 # links. Testing for symbolic links is problematic to do in
648 # a portable fashion using a /bin/sh test, so we simply rely
649 # on perl.
650 #
651 $(SCRIPT_LINK) : $(SCRIPT_PROG)
652         @if ( $(PERL) -e '$$fn="$(SCRIPT_LINK)"; exit ((! -f $$fn || -l $$fn) ? 0 : 1);' ); then \
653            echo "Creating a symbolic link from $(SCRIPT_PROG) to $(SCRIPT_LINK)"; \
654            $(RM) $(SCRIPT_LINK); \
655            $(LN_S) $(SCRIPT_PROG) $(SCRIPT_LINK); \
656          else \
657            echo "Creating a symbolic link from $(SCRIPT_PROG) to $(SCRIPT_LINK) failed: \`$(SCRIPT_LINK)' already exists"; \
658            echo "Perhaps remove \`$(SCRIPT_LINK)' manually?"; \
659            exit 1; \
660          fi;
661 endif
662
663
664
665 ###########################################
666 #
667 #       Targets: install install-strip uninstall
668 #
669 ###########################################
670
671 # For each of these variables that is defined, you
672 # get one install rule
673 #
674 #       INSTALL_PROGS        executable programs in $(bindir)
675 #       INSTALL_SCRIPTS      executable scripts in $(bindir)
676 #       INSTALL_LIBS         platform-dependent libraries in $(libdir) (ranlib'ed)
677 #       INSTALL_LIB_SCRIPTS  platform-dependent scripts   in $(libdir)
678 #       INSTALL_LIBEXECS     platform-dependent execs in $(libdir)
679 #       INSTALL_DATAS        platform-independent files in $(datadir)
680 #
681 # If the installation directory variable is undefined, the install rule simply
682 # emits a suitable error message.
683 #
684 # Remember, too, that the installation directory variables ($(bindir) and
685 # friends can be overridden from their original settings in mk/config.mk.in
686 # || mk/build.mk
687 #
688 .PHONY: install installdirs install-strip install-dirs uninstall install-docs show-install
689
690 show-install :
691         @echo "bindir = $(bindir)"
692         @echo "libdir = $(libdir)"
693         @echo "libexecdir = $(libexecdir)  # by default, same as libdir"
694         @echo "datadir = $(datadir)  # unused for ghc project"
695
696 #
697 # Sometimes useful to separate out the creation of install directories 
698 # from the installation itself.
699 #
700 install-dirs ::
701         @$(INSTALL_DIR) $(bindir)
702         @$(INSTALL_DIR) $(libdir)
703         @$(INSTALL_DIR) $(libexecdir)
704         @$(INSTALL_DIR) $(datadir)
705
706 # Better do this first...
707 # but we won't for the moment, do it on-demand from
708 # within the various install targets instead.
709 #install:: install-dirs
710
711 ifneq "$(INSTALL_PROGS)" ""
712
713 #
714 # Here's an interesting one - when using the win32 version
715 # of install (provided via the cygwin toolkit), we have to
716 # supply the .exe suffix, *if* there's no other suffix.
717 #
718 # The rule below does this by ferreting out the suffix of each
719 # entry in the INSTALL_PROGS list. If there's no suffix, use
720 # $(exeext).
721
722 # This is bit of a pain to express since GNU make doesn't have
723 # something like $(if ...), but possible using $(subst ..)
724 # [Aside: I added support for $(if ..) to my local copy of GNU
725 # make at one stage, perhaps I should propagate the patch to
726 # the GNU make maintainers..] 
727 #
728 INSTALL_PROGS := $(foreach p, $(INSTALL_PROGS), $(addsuffix $(subst _,,$(subst __,$(exeext),_$(suffix $(p))_)), $(basename $(p))))
729
730 install:: $(INSTALL_PROGS)
731         @$(INSTALL_DIR) $(bindir)
732         @for i in $(INSTALL_PROGS); do \
733                     echo $(INSTALL_PROGRAM) $(INSTALL_BIN_OPTS) $$i $(bindir); \
734                     $(INSTALL_PROGRAM) $(INSTALL_BIN_OPTS) $$i $(bindir) ;  \
735         done
736 endif
737
738 #
739 # Just like INSTALL_PROGS, but prefix with install sites bin/lib/data and
740 # install without stripping.
741 #
742 ifneq "$(INSTALL_SCRIPTS)" ""
743 install:: $(INSTALL_SCRIPTS)
744         @$(INSTALL_DIR) $(bindir)
745         for i in $(INSTALL_SCRIPTS); do \
746                 $(INSTALL_SCRIPT) $(INSTALL_OPTS) $$i $(bindir); \
747         done
748 endif
749
750 ifneq "$(INSTALL_LIB_SCRIPTS)" ""
751 install:: $(INSTALL_LIB_SCRIPTS)
752         @$(INSTALL_DIR) $(libdir)
753         for i in $(INSTALL_LIB_SCRIPTS); do \
754                 $(INSTALL_SCRIPT) $(INSTALL_OPTS) $$i $(libdir); \
755         done
756 endif
757
758 ifneq "$(INSTALL_LIBEXEC_SCRIPTS)" ""
759 install:: $(INSTALL_LIBEXEC_SCRIPTS)
760         @$(INSTALL_DIR) $(libexecdir)
761         for i in $(INSTALL_LIBEXEC_SCRIPTS); do \
762                 $(INSTALL_SCRIPT) $(INSTALL_OPTS) $$i $(libexecdir); \
763         done
764 endif
765
766 ifneq "$(INSTALL_LIBS)" ""
767 install:: $(INSTALL_LIBS)
768         @$(INSTALL_DIR) $(libdir)
769         for i in $(INSTALL_LIBS); do \
770                 case $$i in \
771                   *.a) \
772                     $(INSTALL_DATA) $(INSTALL_OPTS) $$i $(libdir); \
773                     $(RANLIB) $(libdir)/`basename $$i` ;; \
774                   *.dll) \
775                     $(INSTALL_DATA) -s $(INSTALL_OPTS) $$i $(libdir) ;; \
776                   *) \
777                     $(INSTALL_DATA) $(INSTALL_OPTS) $$i $(libdir); \
778                 esac; \
779         done
780 endif
781
782 ifneq "$(INSTALL_LIBEXECS)" ""
783 #
784 # See above comment next to defn of INSTALL_PROGS for what
785 # the purpose of this one-liner is.
786
787 INSTALL_LIBEXECS := $(foreach p, $(INSTALL_LIBEXECS), $(addsuffix $(subst _,,$(subst __,$(exeext),_$(suffix $(p))_)), $(basename $(p))))
788
789 install:: $(INSTALL_LIBEXECS)
790         @$(INSTALL_DIR) $(libexecdir)
791         -for i in $(INSTALL_LIBEXECS); do \
792                 $(INSTALL_PROGRAM) $(INSTALL_BIN_OPTS) $$i $(libexecdir); \
793         done
794 endif
795
796 ifneq "$(INSTALL_DATAS)" ""
797 install:: $(INSTALL_DATAS)
798         @$(INSTALL_DIR) $(datadir)
799         for i in $(INSTALL_DATAS); do \
800                 $(INSTALL_DATA) $(INSTALL_OPTS) $$i $(datadir); \
801         done
802 endif
803
804 ifneq "$(INSTALL_INCLUDES)" ""
805 install:: $(INSTALL_INCLUDES)
806         @$(INSTALL_DIR) $(includedir)
807         for i in $(INSTALL_INCLUDES); do \
808                 $(INSTALL_DATA) $(INSTALL_OPTS) $$i $(includedir); \
809         done
810 endif
811
812 #
813 # Use with care..
814 #
815 uninstall:: 
816         @for i in $(INSTALL_PROGS) "" ; do                      \
817           if test "$$i"; then                                   \
818                 echo rm -f $(bindir)/`basename $$i`;            \
819                 rm -f $(bindir)/`basename $$i`;                 \
820           fi;                                                   \
821         done
822         @for i in $(INSTALL_LIBS) ""; do                        \
823           if test "$$i"; then                                   \
824                 echo rm -f $(libdir)/`basename $$i`;            \
825                 rm -f $(libdir)/`basename $$i`;                 \
826           fi;                                                   \
827         done
828         @for i in $(INSTALL_LIBEXECS) ""; do                    \
829           if test "$$i"; then                                   \
830                 echo rm -f $(libexecdir)/`basename $$i`;        \
831                 rm -f $(libexecdir)/`basename $$i`;             \
832           fi;                                                   \
833         done
834         @for i in $(INSTALL_DATAS) ""; do                       \
835           if test "$$i"; then                                   \
836                 echo rm -f $(datadir)/`basename $$i`;           \
837                 rm -f $(datadir)/`basename $$i`;                \
838           fi;                                                   \
839         done
840
841 #
842 # install-strip is from the GNU Makefile standard.
843 #
844 ifneq "$(way)" ""
845 install-strip::
846         @$(MAKE) EXTRA_INSTALL_OPTS='-s' install                                        
847 endif
848
849 #
850 # install links to script drivers.
851 #
852 ifneq "$(SCRIPT_LINK)" ""
853 install ::
854         @if ( $(PERL) -e '$$fn="$(bindir)/$(SCRIPT_LINK)"; exit ((! -f $$fn || -l $$fn) ? 0 : 1);' ); then \
855            echo "Creating a symbol link from $(SCRIPT_PROG) to $(SCRIPT_LINK) in $(bindir)"; \
856            $(RM) $(bindir)/$(SCRIPT_LINK); \
857            $(LN_S) $(SCRIPT_PROG) $(bindir)/$(SCRIPT_LINK); \
858          else \
859            echo "Creating a symbol link from $(SCRIPT_PROG) to $(SCRIPT_LINK) in $(bindir) failed: \`$(bindir)/$(SCRIPT_LINK)' already exists"; \
860            echo "Perhaps remove \`$(bindir)/$(SCRIPT_LINK)' manually?"; \
861            exit 1; \
862          fi;
863
864 endif
865
866 ###########################################
867 #
868 #       Targets: dist binary-dist
869 #
870 ###########################################
871
872
873 #
874 # dist-pre is a canned rule the toplevel of your source tree
875 # would use as follows, 
876 #
877 #  dist :: dist-pre
878 #
879 # it performs two tasks, first creating the distribution directory
880 # tree and it then decorates the new tree with symbolic links pointing
881 # to the symbolic links in the build tree.
882 #
883 # The dist-pre relies on (at least) the `find' in GNU findutils
884 # (only tested with version 4.1). All non-GNU `find's I have
885 # laid on my hands locally, has a restrictive treatment of {} in
886 # -exec commands, i.e.,
887 #
888 #   find . -print echo a{} \;
889 #   
890 # does not expand the {}, it has to be a separate argument (i.e. `a {}').
891 # GNU find is (IMHO) more sensible here, expanding any {} it comes across
892 # inside an -exec, whether it is a separate arg or part of a word:
893 #
894 #  $ touch yes
895 #  $ find --version
896 #    GNU find version 4.1
897 #  $ find yes -exec echo oh,{}! \;
898 #    oh,yes!
899 #
900 # Of course, the above is not impossible to achieve with other finds,
901 # just that GNU find does the Patently Right Thing here :)
902 #
903 # ====> if you're using these dist rules, get hold of GNU findutils.
904 #
905 #  --SOF 2/97
906 #
907 .PHONY: dist dist-pre dist-post
908
909 #
910 # The dist rules leaves out CVS, SRC (from mkshadowdir) and tests
911 # directories when creating shadow source distrib tree
912 #
913 dist-pre::
914         -rm -rf $(SRC_DIST_DIR)
915         -rm -f $(SRC_DIST_NAME).tar.gz
916         (cd $(FPTOOLS_TOP_ABS); $(FIND) $(SRC_DIST_DIRS) -type d \( -name CVS -prune -o -name SRC -prune -o -name tests -prune -o -exec $(MKDIRHIER) $(SRC_DIST_DIR)/{} \; \) ; )
917         (cd $(FPTOOLS_TOP_ABS); $(FIND) $(SRC_DIST_DIRS) -name CVS -prune -o -name SRC -prune -o -name tests -prune -o -name "*~" -prune -o -name ".cvsignore" -prune -o -name "\#*" -prune -o -name ".\#*" -prune -o -type l -exec $(LN_S) $(FPTOOLS_TOP_ABS)/{} $(SRC_DIST_DIR)/{} \; )
918
919 #
920 # After having created a shadow distribution tree and copied/linked
921 # all the necessary files to it, `dist-post' makes sure the permissions
922 # are set right and then package up the tree. Empty directories are also removed.
923 #
924 # For now, we make the packaging a separate rule, so as to allow
925 # the inspection of the dist tree before eventually packaging it up.
926 #
927 dist-post::
928         @echo Deleting the following empty directories..
929         ( cd $(SRC_DIST_DIR) ; cd .. ; $(FIND) $(SRC_DIST_NAME) -type d -exec sh -c 'test x`ls $$0 | wc -l | sed -e "s/ //g"` = x0' {} \; -print -exec rm -rf {} \; -prune )
930         ( cd $(SRC_DIST_DIR) ; cd .. ; chmod -R a+rw $(SRC_DIST_NAME) ) 
931
932 # Automatic generation of a MANIFEST file for a source distribution
933 # tree that is ready to go.
934 dist-manifest ::
935         cd $(SRC_DIST_DIR); $(FIND) . \( -type l -o -type f \) -exec ls -lLG {} \; | sed -e 's/\.\///' > /tmp/MANIFEST ; mv /tmp/MANIFEST MANIFEST
936
937 dist-package:: dist-package-tar-gz
938
939 dist-package-tar-gz ::
940         cd $(SRC_DIST_DIR); cd ..; $(TAR) chzf $(SRC_DIST_NAME).tar.gz $(SRC_DIST_NAME)
941
942 dist-package-zip ::
943         cd $(SRC_DIST_DIR); cd ..; $(ZIP) $(ZIP_OPTS) -r $(SRC_DIST_NAME).zip $(SRC_DIST_NAME)
944
945 ###########################################
946 #
947 #       Targets: check tags show info
948 #
949 ###########################################
950
951 #------------------------------------------------------------
952 #                       Check
953
954 .PHONY: check
955
956 check:: $(TESTS)
957         @for i in $(filter-out %.lhs .hs, $(TESTS)) ''; do      \
958           if (test -f "$$i"); then              \
959             echo Running: `basename $$i` ;      \
960             cd test; `basename $$i` ;           \
961           fi;                                   \
962         done;
963
964 #------------------------------------------------------------
965 #                       Tags
966
967 .PHONY: TAGS tags
968
969 tags TAGS:: $(TAGS_HS_SRCS) $(TAGS_C_SRCS)
970         @$(RM) TAGS
971         @touch TAGS
972 ifneq "$(TAGS_HS_SRCS)" ""
973         $(HSTAGS) $(HSTAGS_OPTS) -- $(TAGS_HS_SRCS)
974 endif
975 ifneq "$(TAGS_C_SRCS)" ""
976         etags -a $(TAGS_C_SRCS)
977 endif
978         @( DEREFFED=`ls -l Makefile | sed -e 's/.*-> \(.*\)/\1/g'` && $(RM) `dirname $$DEREFFED`/TAGS && $(CP) TAGS `dirname $$DEREFFED` ) 2>/dev/null || echo TAGS file generated, perhaps copy over to source tree?
979
980 #------------------------------------------------------------
981 #                       Makefile debugging
982 # to see the effective value used for a Makefile variable, do
983 #  make show VALUE=MY_VALUE
984 #
985
986 show:
987         @echo '$(VALUE)=$($(VALUE))'
988
989 #--------------------------------------------------------------------------
990 # SGML Documentation
991 #
992 .PHONY: dvi ps html pdf rtf
993
994 ifneq "$(SGML_DOC)" ""
995
996 # multi-file SGML document: main document name is specified in $(SGML_DOC),
997 # sub-documents (.sgml files) listed in $(SGML_SRCS).
998
999 ifeq "$(VSGML_SRCS)" ""
1000 VSGML_SRCS = $(wildcard *.vsgml)
1001 endif
1002
1003 ifeq "$(SGML_SRCS)" ""
1004 ifneq "$(VSGML_SRCS)" ""
1005 SGML_SRCS = $(patsubst %.vsgml, %.sgml, $(VSGML_SRCS))
1006 else
1007 SGML_SRCS = $(wildcard *.sgml)
1008 endif
1009 endif
1010
1011 SGML_TEX  = $(SGML_DOC).tex
1012 SGML_DVI  = $(SGML_DOC).dvi
1013 SGML_PS   = $(SGML_DOC).ps
1014 SGML_PDF  = $(SGML_DOC).pdf
1015 SGML_RTF  = $(SGML_DOC).rtf
1016 SGML_HTML = $(SGML_DOC).html
1017 # HTML output goes in a subdirectory on its own.
1018 SGML_TEXT = $(SGML_DOC).txt
1019
1020 $(SGML_DVI) $(SGML_PS) $(SGML_INFO) $(SGML_HTML) $(SGML_TEXT) :: $(SGML_SRCS)
1021
1022 dvi  :: $(SGML_DVI)
1023 ps   :: $(SGML_PS)
1024 pdf  :: $(SGML_PDF)
1025 rtf  :: $(SGML_RTF)
1026 html :: $(SGML_HTML)
1027 txt  :: $(SGML_TEXT)
1028
1029 CLEAN_FILES += $(SGML_TEXT) $(SGML_TEX) $(SGML_PS) $(SGML_DVI) $(SGML_PDF) $(SGML_RTF) $(SGML_HTML) $(SGML_DOC)-*.html
1030 # can't use $(SGML_SRCS) here, it was maybe used elsewhere
1031 MOSTLY_CLEAN_FILES += $(patsubst %.vsgml, %.sgml, $(VSGML_SRCS))
1032
1033 extraclean ::
1034         $(RM) -rf $(SGML_DOC)
1035
1036 endif
1037
1038 ###########################################
1039 #
1040 #       Targets: clean
1041 #
1042 ###########################################
1043
1044 # we have to be careful about recursion here; since all the clean
1045 # targets are recursive, we don't want to make eg. distclean depend on
1046 # clean because that would result in far too many recursive calls.
1047
1048 .PHONY: mostlyclean clean distclean maintainer-clean
1049
1050 mostlyclean::
1051         rm -f $(MOSTLY_CLEAN_FILES)
1052
1053 # extraclean is used for adding actions to the clean target.
1054 extraclean::
1055
1056 clean:: extraclean
1057         rm -f $(MOSTLY_CLEAN_FILES) $(CLEAN_FILES)
1058
1059 distclean:: extraclean
1060         rm -f $(MOSTLY_CLEAN_FILES) $(CLEAN_FILES) $(DIST_CLEAN_FILES)
1061
1062 maintainer-clean:: extraclean
1063         @echo 'This command is intended for maintainers to use; it'
1064         @echo 'deletes files that may need special tools to rebuild.'
1065         rm -f $(MOSTLY_CLEAN_FILES) $(CLEAN_FILES) $(MAINTAINER_CLEAN_FILES)
1066
1067 #################################################################################
1068 #
1069 #                       Way management
1070 #
1071 #################################################################################
1072
1073 # Here is the ingenious jiggery pokery that allows you to build multiple versions
1074 # of a program in a single build tree.
1075 #
1076 # The ways setup requires the following variables to be set:
1077 #
1078 # Expects:      $(WAYS)                 the possible "way" strings to one of 
1079 #                                       which $(way) will be set
1080
1081
1082 # So how does $(way) ever get set to anything?  Answer, we recursively
1083 # invoke make, setting $(way) on the command line.
1084 # When do we do this recursion?  Answer: whenever the programmer
1085 # asks make to make a target that involves a way suffix.
1086 # We must remember *not* to recurse again; but that's easy: we
1087 # just see if $(way) is set:
1088
1089 ifeq "$(way)" ""
1090
1091 # If $(WAYS) = p mc, then WAY_TARGETS expands to
1092 #       %.p_lhs %.p_hs %.p_o ... %.mc_lhs %.p_hs ...
1093 # and OTHER_WAY_TARGETS to
1094 #       %_p.a %_p %_mc.a %_mc
1095 # where the suffixes are from $(SUFFIXES)
1096 #
1097 # We have to treat libraries and "other" targets differently, 
1098 # because their names are of the form
1099 #       libHS_p.a and Foo_p
1100 # whereas everything else has names of the form
1101 #       Foo.p_o
1102
1103 FPTOOLS_SUFFIXES := o hi hc
1104
1105 WAY_TARGETS     = $(foreach way,$(WAYS),$(foreach suffix, $(FPTOOLS_SUFFIXES), %.$(way)_$(suffix)))
1106 LIB_WAY_TARGETS = $(foreach way,$(WAYS),%_$(way).a %_$(way))
1107
1108 # $@ will be something like Foo.p_o
1109 # $(suffix $@)     returns .p_o
1110 # $(subst .,.p_o)  returns p_o
1111 # $(subst _,.,p_o) returns p.o   (clever)
1112 # $(basename p.o)  returns p
1113
1114 $(WAY_TARGETS) :
1115         $(MAKE) way=$(basename $(subst _,.,$(subst .,,$(suffix $@)))) $@
1116
1117 # $(@F) will be something like libHS_p.a, or Foo_p
1118 # $(basename $(@F)) will be libHS_p, or Foo_p
1119 # The sed script extracts the "p" part.
1120
1121 $(LIB_WAY_TARGETS) :
1122         $(MAKE) $(MFLAGS) $@ way=$(subst .,,$(suffix $(subst _,.,$(basename $@))))
1123
1124 endif   # if way
1125
1126 ifneq "$(WAYS)" ""
1127 ifeq "$(way)" ""
1128
1129 # NB: the targets exclude 
1130 #       boot runtests
1131 # since these are way-independent
1132 all docs TAGS clean distclean mostlyclean maintainer-clean install ::
1133         @echo "------------------------------------------------------------------------"
1134         @echo "===fptools== Recursively making \`$@' for ways: $(WAYS) ..."
1135         @echo "PWD = $(shell pwd)"
1136         @echo "------------------------------------------------------------------------"
1137 # Don't rely on -e working, instead we check exit return codes from sub-makes.
1138         @case '${MFLAGS}' in *-[ik]*) x_on_err=0;; *-r*[ik]*) x_on_err=0;; *) x_on_err=1;; esac; \
1139         for i in $(WAYS) ; do \
1140           echo "------------------------------------------------------------------------"; \
1141           echo "==fptools== $(MAKE) way=$$i $@;"; \
1142           echo "PWD = $(shell pwd)"; \
1143           echo "------------------------------------------------------------------------"; \
1144           $(MAKE) way=$$i --no-print-directory $(MFLAGS) $@ ; \
1145           if [ $$? -eq 0 ] ; then true; else exit $$x_on_err; fi; \
1146         done
1147         @echo "------------------------------------------------------------------------"
1148         @echo "===fptools== Finished recursively making \`$@' for ways: $(WAYS) ..."
1149         @echo "PWD = $(shell pwd)"
1150         @echo "------------------------------------------------------------------------"
1151
1152 endif
1153 endif