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