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