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