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