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