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