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