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