4a98ebcb7bf4ef96766049eb526fde1911855665
[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) $(foreach way,$(WAYS),-s $(way)) -- $(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 #
328 # Remove local symbols from library objects if requested.
329 #
330
331 ifeq "$(StripLibraries)" "YES"
332 ifneq "$(filter -split-objs,$(HC_OPTS))" ""
333 SRC_HC_POST_OPTS += \
334   for i in $(basename $@)/*; do \
335         ld -r -x -o $$i.tmp $$i; \
336         $(MV) $$i.tmp $$i; \
337   done
338 else
339 SRC_HC_POST_OPTS += \
340   ld -r -x -o $@.tmp $@; $(MV) $@.tmp $@
341 endif
342 endif
343
344 $(LIBRARY) :: $(LIBOBJS)
345         $(BUILD_LIB)
346 endif
347
348 #----------------------------------------
349 #       Building Win32 DLLs
350 #
351 ifeq "$(way)" "dll"
352
353 ifeq "$(DLL_NAME)" ""
354 DLL_NAME = $(patsubst %.a, %.dll, $(subst lib,,$(LIBRARY)))
355 endif
356
357 all :: $(DLL_NAME)
358
359 ifeq "$(DLL_IMPLIB_NAME)" ""
360 DLL_IMPLIB_NAME = $(patsubst %.a, %_imp.a, $(LIBRARY))
361 endif
362
363 $(DLL_NAME) :: $(LIBRARY)
364         $(BLD_DLL) --output-lib $(DLL_IMPLIB_NAME) -o $(DLL_NAME) $(LIBRARY) $(BLD_DLL_OPTS) 
365         touch dLL_ifs.hi
366 endif
367
368 #----------------------------------------
369 #       Script programs
370
371 ifneq "$(SCRIPT_PROG)" ""
372
373 # To produce a fully functional script, you may
374 # have to add some configuration variables at the top of 
375 # the script, i.e., the compiler driver needs to know
376 # the path to various utils in the build tree for instance.
377 #
378 # To have the build rule for the script automatically do this
379 # for you, set the variable SCRIPT_SUBST_VARS to the list of
380 # variables you need to put in.
381
382 #
383 # SCRIPT_SUBST creates a string of echo commands that
384 # will when evaluated append the (perl)variable name and its value 
385 # to the target it is used for, i.e.,
386 #
387 #    A=foo
388 #    B=bar
389 #    SCRIPT_SUBST_VARS = A B
390 #    SCRIPT_SUBST=echo "$""A=\"foo\";" >> $@; echo "$""B=\"bar\";" >> $@
391 #
392 #    so if you have a rule like the following
393 #    
394 #     foo:
395 #         @(RM) $@
396 #         @(TOUCH) $@
397 #         @eval $(SCRIPT_SUBST)
398 #
399 #    `make foo' would create a file `foo' containing the following
400 #
401 #    % cat foo
402 #    $A=foo;
403 #    $B=bar;
404 #    %
405 #
406 # ToDo: make this work for shell scripts (drop the initial $).
407 #
408 ifeq "$(INTERP)" "$(SHELL)"
409 SCRIPT_SUBST=$(foreach val,$(SCRIPT_SUBST_VARS),"echo \"$(val)=\\\"$($(val))\\\";\" >> $@;")
410 else
411 SCRIPT_SUBST=$(foreach val,$(SCRIPT_SUBST_VARS),"echo \"$$\"\"$(val)=\\\"$($(val))\\\";\" >> $@;")
412 endif
413
414 all :: $(SCRIPT_PROG)
415
416 #
417 # #! support under cygwin32 is not quite there yet, 
418 # so we rely on the eval `trick' instead. On all other
419 # platforms, we prepend #!$(INTERP)  -- SOF 6/97
420
421
422 $(SCRIPT_PROG) :: $(SCRIPT_OBJS)
423         $(RM) $@
424         @echo Creating $@...
425 ifeq "$(INTERP)" "perl"
426 ifneq "$(BIN_DIST)" "1"
427         echo "#! "$(PERL) > $@
428 else
429         @touch $@
430 endif
431 else
432 ifneq "$(INTERP)" ""
433         @echo "#!"$(INTERP) > $@
434 else
435         @touch $@
436 endif
437 endif
438 ifneq "$(SCRIPT_PREFIX_FILES)" ""
439         @cat $(SCRIPT_PREFIX_FILES) >> $@
440 endif
441         @eval $(SCRIPT_SUBST) 
442         @cat $(SCRIPT_OBJS) >> $@
443         @chmod a+x $@
444         @echo Done.
445 endif
446
447 # links to script programs: we sometimes install a script as
448 # <name>-<version> with a link from <name> to the real script.
449
450 ifneq "$(SCRIPT_LINK)" ""
451 all :: $(SCRIPT_LINK)
452
453 #
454 # Don't want to overwrite $(SCRIPT_LINK)s that aren't symbolic
455 # links. Testing for symbolic links is problematic to do in
456 # a portable fashion using a /bin/sh test, so we simply rely
457 # on perl.
458 #
459 $(SCRIPT_LINK) : $(SCRIPT_PROG)
460         @if ( $(PERL) -e '$$fn="$(SCRIPT_LINK)"; exit ((! -f $$fn || -l $$fn) ? 0 : 1);' ); then \
461            echo "Creating a symbolic link from $(SCRIPT_PROG) to $(SCRIPT_LINK)"; \
462            $(RM) $(SCRIPT_LINK); \
463            $(LN_S) $(SCRIPT_PROG) $(SCRIPT_LINK); \
464          else \
465            echo "Creating a symbolic link from $(SCRIPT_PROG) to $(SCRIPT_LINK) failed: \`$(SCRIPT_LINK)' already exists"; \
466            echo "Perhaps remove \`$(SCRIPT_LINK)' manually?"; \
467            exit 1; \
468          fi;
469 endif
470
471
472
473 ###########################################
474 #
475 #       Targets: install install-strip uninstall
476 #
477 ###########################################
478
479 # For each of these variables that is defined, you
480 # get one install rule
481 #
482 #       INSTALL_PROGS        executable programs in $(bindir)
483 #       INSTALL_SCRIPTS      executable scripts in $(bindir)
484 #       INSTALL_LIBS         platform-dependent libraries in $(libdir) (ranlib'ed)
485 #       INSTALL_LIB_SCRIPTS  platform-dependent scripts   in $(libdir)
486 #       INSTALL_LIBEXECS     platform-dependent execs in $(libdir)
487 #       INSTALL_DATAS        platform-independent files in $(datadir)
488 #
489 # If the installation directory variable is undefined, the install rule simply
490 # emits a suitable error message.
491 #
492 # Remember, too, that the installation directory variables ($(bindir) and
493 # friends can be overridden from their original settings in mk/config.mk.in
494 # || mk/build.mk
495 #
496 .PHONY: install installdirs install-strip install-dirs uninstall install-docs show-install
497
498 show-install :
499         @echo "bindir = $(bindir)"
500         @echo "libdir = $(libdir)"
501         @echo "libexecdir = $(libexecdir)  # by default, same as libdir"
502         @echo "datadir = $(datadir)  # unused for ghc project"
503
504 #
505 # Sometimes useful to separate out the creation of install directories 
506 # from the installation itself.
507 #
508 install-dirs ::
509         @$(INSTALL_DIR) $(bindir)
510         @$(INSTALL_DIR) $(libdir)
511         @$(INSTALL_DIR) $(libexecdir)
512         @$(INSTALL_DIR) $(datadir)
513
514 # Better do this first...
515 # but we won't for the moment, do it on-demand from
516 # within the various install targets instead.
517 #install:: install-dirs
518
519 ifneq "$(INSTALL_PROGS)" ""
520 install:: $(INSTALL_PROGS)
521         @$(INSTALL_DIR) $(bindir)
522         @for i in $(INSTALL_PROGS); do \
523                 case $$i in \
524                   *.dll) \
525                     echo $(INSTALL_DATA) $(INSTALL_BIN_OPTS) $$i $(bindir); \
526                     $(INSTALL_PROGRAM) $(INSTALL_BIN_OPTS) $$i $(bindir) ;; \
527                   *) \
528                     echo $(INSTALL_PROGRAM) $(INSTALL_BIN_OPTS) $$i$(exeext) $(bindir); \
529                     $(INSTALL_PROGRAM) $(INSTALL_BIN_OPTS) $$i$(exeext) $(bindir) ;;  \
530                 esac; \
531         done
532 endif
533
534 #
535 # Just like INSTALL_PROGS, but prefix with install sites bin/lib/data and
536 # install without stripping.
537 #
538 ifneq "$(INSTALL_SCRIPTS)" ""
539 install:: $(INSTALL_SCRIPTS)
540         @$(INSTALL_DIR) $(bindir)
541         for i in $(INSTALL_SCRIPTS); do \
542                 $(INSTALL_SCRIPT) $(INSTALL_OPTS) $$i $(bindir); \
543         done
544 endif
545
546 ifneq "$(INSTALL_LIB_SCRIPTS)" ""
547 install:: $(INSTALL_LIB_SCRIPTS)
548         @$(INSTALL_DIR) $(libdir)
549         for i in $(INSTALL_LIB_SCRIPTS); do \
550                 $(INSTALL_SCRIPT) $(INSTALL_OPTS) $$i $(libdir); \
551         done
552 endif
553
554 ifneq "$(INSTALL_LIBEXEC_SCRIPTS)" ""
555 install:: $(INSTALL_LIBEXEC_SCRIPTS)
556         @$(INSTALL_DIR) $(libexecdir)
557         for i in $(INSTALL_LIBEXEC_SCRIPTS); do \
558                 $(INSTALL_SCRIPT) $(INSTALL_OPTS) $$i $(libexecdir); \
559         done
560 endif
561
562 ifneq "$(INSTALL_LIBS)" ""
563 install:: $(INSTALL_LIBS)
564         @$(INSTALL_DIR) $(libdir)
565         for i in $(INSTALL_LIBS); do \
566                 case $$i in \
567                   *.a) \
568                     $(INSTALL_DATA) $(INSTALL_OPTS) $$i $(libdir); \
569                     $(RANLIB) $(libdir)/`basename $$i` ;; \
570                   *.dll) \
571                     $(INSTALL_DATA) -s $(INSTALL_OPTS) $$i $(libdir) ;; \
572                   *) \
573                     $(INSTALL_DATA) $(INSTALL_OPTS) $$i $(libdir); \
574                 esac; \
575         done
576 endif
577
578 ifneq "$(INSTALL_LIBEXECS)" ""
579 install:: $(INSTALL_LIBEXECS)
580         @$(INSTALL_DIR) $(libexecdir)
581         -for i in $(INSTALL_LIBEXECS); do \
582                 $(INSTALL_PROGRAM) $(INSTALL_BIN_OPTS) $$i$(exeext) $(libexecdir); \
583         done
584 endif
585
586 ifneq "$(INSTALL_DATAS)" ""
587 install:: $(INSTALL_DATAS)
588         @$(INSTALL_DIR) $(datadir)
589         for i in $(INSTALL_DATAS); do \
590                 $(INSTALL_DATA) $(INSTALL_OPTS) $$i $(datadir); \
591         done
592 endif
593
594 #
595 # Use with care..
596 #
597 uninstall:: 
598         @for i in $(INSTALL_PROGS) "" ; do                      \
599           if test "$$i"; then                                   \
600                 echo rm -f $(bindir)/`basename $$i`;            \
601                 rm -f $(bindir)/`basename $$i`;                 \
602           fi;                                                   \
603         done
604         @for i in $(INSTALL_LIBS) ""; do                        \
605           if test "$$i"; then                                   \
606                 echo rm -f $(libdir)/`basename $$i`;            \
607                 rm -f $(libdir)/`basename $$i`;                 \
608           fi;                                                   \
609         done
610         @for i in $(INSTALL_LIBEXECS) ""; do                    \
611           if test "$$i"; then                                   \
612                 echo rm -f $(libexecdir)/`basename $$i`;        \
613                 rm -f $(libexecdir)/`basename $$i`;             \
614           fi;                                                   \
615         done
616         @for i in $(INSTALL_DATAS) ""; do                       \
617           if test "$$i"; then                                   \
618                 echo rm -f $(datadir)/`basename $$i`;           \
619                 rm -f $(datadir)/`basename $$i`;                \
620           fi;                                                   \
621         done
622
623 #
624 # install-strip is from the GNU Makefile standard.
625 #
626 ifneq "$(way)" ""
627 install-strip::
628         @$(MAKE) EXTRA_INSTALL_OPTS='-s' install                                        
629 endif
630
631 #
632 # install links to script drivers.
633 #
634 ifneq "$(SCRIPT_LINK)" ""
635 install ::
636         @if ( $(PERL) -e '$$fn="$(bindir)/$(SCRIPT_LINK)"; exit ((! -f $$fn || -l $$fn) ? 0 : 1);' ); then \
637            echo "Creating a symbol link from $(SCRIPT_PROG) to $(SCRIPT_LINK) in $(bindir)"; \
638            $(RM) $(bindir)/$(SCRIPT_LINK); \
639            $(LN_S) $(SCRIPT_PROG) $(bindir)/$(SCRIPT_LINK); \
640          else \
641            echo "Creating a symbol link from $(SCRIPT_PROG) to $(SCRIPT_LINK) in $(bindir) failed: \`$(bindir)/$(SCRIPT_LINK)' already exists"; \
642            echo "Perhaps remove \`$(bindir)/$(SCRIPT_LINK)' manually?"; \
643            exit 1; \
644          fi;
645
646 endif
647
648 ###########################################
649 #
650 #       Targets: dist binary-dist
651 #
652 ###########################################
653
654
655 #
656 # dist-pre is a canned rule the toplevel of your source tree
657 # would use as follows, 
658 #
659 #  dist :: dist-pre
660 #
661 # it performs two tasks, first creating the distribution directory
662 # tree and it then decorates the new tree with symbolic links pointing
663 # to the symbolic links in the build tree.
664 #
665 # The dist-pre relies on (at least) the `find' in GNU findutils
666 # (only tested with version 4.1). All non-GNU `find's I have
667 # laid on my hands locally, has a restrictive treatment of {} in
668 # -exec commands, i.e.,
669 #
670 #   find . -print echo a{} \;
671 #   
672 # does not expand the {}, it has to be a separate argument (i.e. `a {}').
673 # GNU find is (IMHO) more sensible here, expanding any {} it comes across
674 # inside an -exec, whether it is a separate arg or part of a word:
675 #
676 #  $ touch yes
677 #  $ find --version
678 #    GNU find version 4.1
679 #  $ find yes -exec echo oh,{}! \;
680 #    oh,yes!
681 #
682 # Of course, the above is not impossible to achieve with other finds,
683 # just that GNU find does the Patently Right Thing here :)
684 #
685 # ====> if you're using these dist rules, get hold of GNU findutils.
686 #
687 #  --SOF 2/97
688 #
689 .PHONY: dist dist-pre dist-post
690
691 #
692 # The dist rules leaves out CVS, SRC (from mkshadowdir) and tests
693 # directories when creating shadow source distrib tree
694 #
695 dist-pre::
696         -rm -rf $(SRC_DIST_DIR)
697         -rm -f $(SRC_DIST_NAME).tar.gz
698         (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)/{} \; \) ; )
699         (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)/{} \; )
700
701 #
702 # After having created a shadow distribution tree and copied/linked
703 # all the necessary files to it, `dist-post' makes sure the permissions
704 # are set right and then package up the tree. Empty directories are also removed.
705 #
706 # For now, we make the packaging a separate rule, so as to allow
707 # the inspection of the dist tree before eventually packaging it up.
708 #
709 dist-post::
710         @echo Deleting the following empty directories..
711         ( 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 )
712         ( cd $(SRC_DIST_DIR) ; cd .. ; chmod -R a+rw $(SRC_DIST_NAME) ) 
713
714 # Automatic generation of a MANIFEST file for a source distribution
715 # tree that is ready to go.
716 dist-manifest ::
717         cd $(SRC_DIST_DIR); find . \( -type l -o -type f \) -exec ls -lLG {} \; | sed -e 's/\.\///' > /tmp/MANIFEST ; mv /tmp/MANIFEST MANIFEST
718
719 dist-package:: dist-package-tar-gz
720
721 dist-package-tar-gz ::
722         cd $(SRC_DIST_DIR); cd ..; $(TAR) chzf $(SRC_DIST_NAME).tar.gz $(SRC_DIST_NAME)
723
724 dist-package-zip ::
725         cd $(SRC_DIST_DIR); cd ..; $(ZIP) $(ZIP_OPTS) -r $(SRC_DIST_NAME).zip $(SRC_DIST_NAME)
726
727 #
728 # binary-dist creates a binary bundle, set BIN_DIST_NAME
729 # to package name and do `make binary-dist' (normally this
730 # just a thing you would do from the toplevel of fptools or)
731 # from the top of a project.
732 #
733 .PHONY: binary-dist-pre binary-dist binary-pack
734
735 binary-dist-pre::
736         -rm -rf $(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME)
737         -rm -f $(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME).tar.gz
738         @for i in $(BIN_DIST_DIRS); do                   \
739           if test -d "$$i"; then                         \
740            echo $(MKDIRHIER) $(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME)/bin/$(TARGETPLATFORM)/$(ProjectNameShort)-$(ProjectVersion); \
741            $(MKDIRHIER) $(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME)/bin/$(TARGETPLATFORM)/$(ProjectNameShort)-$(ProjectVersion); \
742            echo $(MKDIRHIER) $(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME)/lib/$(TARGETPLATFORM)/$(ProjectNameShort)-$(ProjectVersion); \
743            $(MKDIRHIER) $(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME)/lib/$(TARGETPLATFORM)/$(ProjectNameShort)-$(ProjectVersion); \
744            echo $(MKDIRHIER) $(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME)/share/$(ProjectNameShort)-$(ProjectVersion); \
745            $(MKDIRHIER) $(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME)/share/$(ProjectNameShort)-$(ProjectVersion); \
746            echo $(MAKE) -C $$i $(MFLAGS) install BIN_DIST=1 BIN_DIST_NAME=$(BIN_DIST_NAME) \
747                         prefix=$(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME) \
748                         exec_prefix=$(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME) \
749                         bindir=$(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME)/bin/$(TARGETPLATFORM)/$(ProjectNameShort)-$(ProjectVersion) \
750                         libdir=$(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME)/lib/$(TARGETPLATFORM)/$(ProjectNameShort)-$(ProjectVersion) \
751                         libexecdir=$(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME)/lib/$(TARGETPLATFORM)/$(ProjectNameShort)-$(ProjectVersion) \
752                         datadir=$(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME)/share/$(ProjectNameShort)-$(ProjectVersion) ; \
753            $(MAKE) -C $$i $(MFLAGS) install BIN_DIST=1 BIN_DIST_NAME=$(BIN_DIST_NAME) \
754                         prefix=$(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME) \
755                         exec_prefix=$(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME) \
756                         bindir=$(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME)/bin/$(TARGETPLATFORM)/$(ProjectNameShort)-$(ProjectVersion) \
757                         libdir=$(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME)/lib/$(TARGETPLATFORM)/$(ProjectNameShort)-$(ProjectVersion) \
758                         libexecdir=$(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME)/lib/$(TARGETPLATFORM)/$(ProjectNameShort)-$(ProjectVersion) \
759                         datadir=$(BIN_DIST_TMPDIR)/$(BIN_DIST_NAME)/share/$(ProjectNameShort)-$(ProjectVersion) ; \
760           fi; \
761         done
762
763 #
764 # Do this separately for now
765
766 binary-pack::
767         ( cd $(BIN_DIST_TMPDIR); $(TAR) chzf $(BIN_DIST_NAME).tar.gz $(BIN_DIST_NAME); rm -rf $(BIN_DIST_NAME) )
768
769 ifneq "$(way)" ""
770 package-way-dist::
771         ( 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 )
772         gzip $(BIN_DIST_TMPDIR)/ghc-$(ProjectVersion)-$(way)-$(TARGETPLATFORM).tar
773 endif
774
775 ifneq "$(way)" ""
776 remove-way-dist::
777         ( cd $(BIN_DIST_TMPDIR); find $(BIN_DIST_NAME)/ \( -name "*$(_way).a" -o -name "*.$(way_)hi" \) -print -exec rm -f {} \; )
778 endif
779
780 ###########################################
781 #
782 #       Targets: check tags show info
783 #
784 ###########################################
785
786 #------------------------------------------------------------
787 #                       Check
788
789 .PHONY: check
790
791 check:: $(TESTS)
792         @for i in $(filter-out %.lhs .hs, $(TESTS)) ''; do      \
793           if (test -f "$$i"); then              \
794             echo Running: `basename $$i` ;      \
795             cd test; `basename $$i` ;           \
796           fi;                                   \
797         done;
798
799 #------------------------------------------------------------
800 #                       Tags
801
802 .PHONY: TAGS tags
803
804 tags TAGS:: $(TAGS_HS_SRCS) $(TAGS_C_SRCS)
805         @$(RM) TAGS
806         @touch TAGS
807 ifneq "$(TAGS_HS_SRCS)" ""
808         $(HSTAGS) $(HSTAGS_OPTS) -- $(TAGS_HS_SRCS)
809 endif
810 ifneq "$(TAGS_C_SRCS)" ""
811         etags -a $(TAGS_C_SRCS)
812 endif
813         @( 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?
814
815 #------------------------------------------------------------
816 #                       Makefile debugging
817 # to see the effective value used for a Makefile variable, do
818 #  make show VALUE=MY_VALUE
819 #
820
821 show:
822         @echo '$(VALUE)=$($(VALUE))'
823
824 #--------------------------------------------------------------------------
825 # SGML Documentation
826 #
827 .PHONY: dvi ps html info txt
828
829 ifneq "$(SGML_DOC)" ""
830
831 # multi-file SGML document: main document name is specified in $(SGML_DOC),
832 # sub-documents (.sgml files) listed in $(SGML_SRCS).
833
834 ifeq "$(VSGML_SRCS)" ""
835 VSGML_SRCS = $(wildcard *.vsgml)
836 endif
837
838 ifeq "$(SGML_SRCS)" ""
839 ifneq "$(VSGML_SRCS)" ""
840 SGML_SRCS = $(patsubst %.vsgml, %.sgml, $(VSGML_SRCS))
841 else
842 SGML_SRCS = $(wildcard *.sgml)
843 endif
844 endif
845
846 SGML_DVI  = $(SGML_DOC).dvi
847 SGML_PS   = $(SGML_DOC).ps
848 SGML_INFO = $(SGML_DOC).info
849 SGML_HTML = $(SGML_DOC).html
850 SGML_TEXT = $(SGML_DOC).txt
851
852 $(SGML_DVI) $(SGML_PS) $(SGML_INFO) $(SGML_HTML) $(SGML_TEXT) :: $(SGML_SRCS)
853
854 dvi  :: $(SGML_DVI)
855 info :: $(SGML_INFO)
856 html :: $(SGML_HTML)
857 txt  :: $(SGML_TXT)
858 ps   :: $(SGML_PS)
859
860 CLEAN_FILES += $(SGML_TEXT) $(SGML_DOC)*.html $(SGML_PS) $(SGML_DVI)
861
862 endif
863
864 ###########################################
865 #
866 #       Targets: clean
867 #
868 ###########################################
869
870 .PHONY: realclean mostlyclean clean distclean maintainer-clean
871
872 # realclean is just a synonym for maintainer-clean
873 realclean: maintainer-clean
874
875
876 ifneq "$(MOSTLY_CLEAN_FILES)" ""
877 mostlyclean::
878         rm -f $(MOSTLY_CLEAN_FILES)
879 endif
880
881 ifneq "$(CLEAN_FILES)" ""
882 clean:: mostlyclean
883         rm -f $(CLEAN_FILES)
884 endif
885
886
887 ifneq "$(DIST_CLEAN_FILES)" ""
888 distclean:: mostlyclean clean
889         rm -f $(DIST_CLEAN_FILES)
890 endif
891
892
893 ifneq "$(MAINTAINER_CLEAN_FILES)" ""
894 maintainer-clean:: mostlyclean clean distclean
895         @echo 'This command is intended for maintainers to use; it'
896         @echo 'deletes files that may need special tools to rebuild.'
897         rm -f $(MAINTAINER_CLEAN_FILES)
898 endif
899
900 #
901 # If (Haskell) object files are split, cleaning up 
902 # consist of descending into the directories where
903 # the myriads of object files have been put.
904 #
905
906 ifneq "$(HS_OBJS)" ""
907 ifneq "$(filter -split-objs,$(HC_OPTS))" ""
908 clean ::
909         find $(patsubst %.$(way_)o,%,$(HS_OBJS)) -name '*.$(way_)o' -print | xargs $(RM) __rm_food
910         -rmdir $(patsubst %.$(way_)o,%,$(HS_OBJS)) > /dev/null 2>&1
911 endif
912 endif
913
914
915 #################################################################################
916 #
917 #                       Way management
918 #
919 #################################################################################
920
921 # Here is the ingenious jiggery pokery that allows you to build multiple versions
922 # of a program in a single build tree.
923 #
924 # The ways setup requires the following variables to be set:
925 #
926 # Expects:      $(WAYS)                 the possible "way" strings to one of 
927 #                                       which $(way) will be set
928
929
930 # So how does $(way) ever get set to anything?  Answer, we recursively
931 # invoke make, setting $(way) on the command line.
932 # When do we do this recursion?  Answer: whenever the programmer
933 # asks make to make a target that involves a way suffix.
934 # We must remember *not* to recurse again; but that's easy: we
935 # just see if $(way) is set:
936
937 ifeq "$(way)" ""
938
939 # If $(WAYS) = p mc, then WAY_TARGETS expands to
940 #       %.p_lhs %.p_hs %.p_o ... %.mc_lhs %.p_hs ...
941 # and OTHER_WAY_TARGETS to
942 #       %_p.a %_p %_mc.a %_mc
943 # where the suffixes are from $(SUFFIXES)
944 #
945 # We have to treat libraries and "other" targets differently, 
946 # because their names are of the form
947 #       libHS_p.a and Foo_p
948 # whereas everything else has names of the form
949 #       Foo.p_o
950
951 FPTOOLS_SUFFIXES := o hi hc
952
953 WAY_TARGETS     = $(foreach way,$(WAYS),$(foreach suffix, $(FPTOOLS_SUFFIXES), %.$(way)_$(suffix)))
954 LIB_WAY_TARGETS = $(foreach way,$(WAYS),%_$(way).a %_$(way))
955
956 # $@ will be something like Foo.p_o
957 # $(suffix $@)     returns .p_o
958 # $(subst .,.p_o)  returns p_o
959 # $(subst _,.,p_o) returns p.o   (clever)
960 # $(basename p.o)  returns p
961
962 $(WAY_TARGETS) :
963         $(MAKE) way=$(basename $(subst _,.,$(subst .,,$(suffix $@)))) $@
964
965 # $(@F) will be something like libHS_p.a, or Foo_p
966 # $(basename $(@F)) will be libHS_p, or Foo_p
967 # The sed script extracts the "p" part.
968
969 $(LIB_WAY_TARGETS) :
970         $(MAKE) $(MFLAGS) $@ way=$(subst .,,$(suffix $(subst _,.,$(basename $@))))
971
972 endif   # if way
973
974
975 ##################################################################
976 #
977 #               Recursive stuff
978 #
979 ##################################################################
980
981 # Here are the diabolically clever rules that
982
983 # (a) for each "recursive target" <t>
984 #     propagates "make <t>" to directories in SUBDIRS
985 #
986 # (b) when SUBDIRS is empty,
987 #     for each "multi-way-target" <t>
988 #     calls "make -way=w <t>" for each w in $(WAYS)
989 #
990 #     This has the effect of making the standard target
991 #     in each of the specified ways (as well as in the normal way
992
993 # Controlling variables
994 #       WAYS    = extra (beyond the normal way) ways to build things in
995 #       SUBDIRS = subdirectories to recurse into
996
997 # No ways, so iterate over the SUBDIRS
998
999 # note about recursively invoking make: we'd like make to drop all the
1000 # way back to the top level if it fails in any of the
1001 # sub(sub-...)directories.  This is done by setting the -e flag to the
1002 # shell during the loop, which causes an immediate failure if any of
1003 # the shell commands fail.
1004
1005 # One exception: if the user gave the -i or -k flag to make in the
1006 # first place, we'd like to reverse this behaviour.  So we check for
1007 # these flags, and set the -e flag appropriately.  NOTE: watch out for
1008 # the --no-print-directory flag which is passed to recursive
1009 # invocations of make.
1010 #
1011 # NOTE: Truly weird use of exit below to stop the for loop dead in
1012 # its tracks should any of the sub-makes fail. By my reckoning, 
1013 #  "cmd || exit $?" should be equivalent to "cmd"
1014
1015 ifneq "$(SUBDIRS)" ""
1016
1017 all docs runtests boot TAGS clean veryclean maintainer-clean install info ::
1018         @echo "------------------------------------------------------------------------"
1019         @echo "===fptools== Recursively making \`$@' in $(SUBDIRS) ..."
1020         @echo "PWD = $(shell pwd)"
1021         @echo "------------------------------------------------------------------------"
1022 # Don't rely on -e working, instead we check exit return codes from sub-makes.
1023         @case '${MFLAGS}' in *-[ik]*) x_on_err=0;; *-r*[ik]*) x_on_err=0;; *) x_on_err=1;; esac; \
1024         for i in $(SUBDIRS); do \
1025           echo "------------------------------------------------------------------------"; \
1026           echo "==fptools== $(MAKE) $@ $(MFLAGS);"; \
1027           echo " in $(shell pwd)/$$i"; \
1028           echo "------------------------------------------------------------------------"; \
1029           $(MAKE) --no-print-directory -C $$i $(MFLAGS) $@; \
1030           if [ $$? -eq 0 -o $$x_on_err -eq 0 ] ;  then true; else exit 1; fi; \
1031         done
1032         @echo "------------------------------------------------------------------------"
1033         @echo "===fptools== Finished making \`$@' in $(SUBDIRS) ..."
1034         @echo "PWD = $(shell pwd)"
1035         @echo "------------------------------------------------------------------------"
1036
1037 dist ::
1038 # Don't rely on -e working, instead we check exit return codes from sub-makes.
1039         @case '${MFLAGS}' in *-[ik]*) x_on_err=0;; *-r*[ik]*) x_on_err=0;; *) x_on_err=1;; esac; \
1040         for i in $(SUBDIRS) ; do \
1041           $(MKDIRHIER_PREFIX)mkdirhier $(SRC_DIST_DIR)/$$i; \
1042           $(MAKE) -C $$i $(MFLAGS) $@ SRC_DIST_DIR=$(SRC_DIST_DIR)/$$i; \
1043           if [ $$? -eq 0 ] ;  then true; else exit $$x_on_err; fi; \
1044         done
1045 endif
1046
1047 # The default dist rule:
1048 #
1049 # copy/link the contents of $(SRC_DIST_FILES) into the
1050 # shadow distribution tree. SRC_DIST_FILES contain the
1051 # build-generated files that you want to include in
1052 # a source distribution.
1053 #
1054 #
1055 ifneq "$(SRC_DIST_FILES)" ""
1056 dist::
1057         @for i in $(SRC_DIST_FILES); do                  \
1058           if ( echo "$$i" | grep "~" >/dev/null 2>&1 ); then     \
1059             echo $(LN_S) `pwd`/`echo $$i | sed -e "s/^\([^~]*\)~.*/\1/g"` $(SRC_DIST_DIR)/`echo $$i | sed -e "s/.*~\(.*\)/\1/g"` ; \
1060             $(LN_S) `pwd`/`echo $$i | sed -e "s/^\([^~]*\)~.*/\1/g"` $(SRC_DIST_DIR)/`echo $$i | sed -e "s/.*~\(.*\)/\1/g"` ; \
1061           else \
1062             if (test -f "$$i"); then                       \
1063               echo $(LN_S) `pwd`/$$i $(SRC_DIST_DIR)/$$i ; \
1064               $(LN_S) `pwd`/$$i $(SRC_DIST_DIR)/$$i ;      \
1065              fi;                                           \
1066           fi; \
1067         done;
1068 endif
1069
1070
1071 #
1072 # Selectively building subdirectories.
1073 #
1074 #
1075 ifneq "$(SUBDIRS)" ""
1076 $(SUBDIRS) ::
1077           $(MAKE) -C $@ $(MFLAGS)
1078 endif
1079
1080 ifneq "$(WAYS)" ""
1081 ifeq "$(way)" ""
1082
1083 # NB: the targets exclude 
1084 #       boot info TAGS runtests
1085 # since these are way-independent
1086 all docs TAGS clean veryclean maintainer-clean install ::
1087         @echo "------------------------------------------------------------------------"
1088         @echo "===fptools== Recursively making \`$@' for ways: $(WAYS) ..."
1089         @echo "PWD = $(shell pwd)"
1090         @echo "------------------------------------------------------------------------"
1091 # Don't rely on -e working, instead we check exit return codes from sub-makes.
1092         @case '${MFLAGS}' in *-[ik]*) x_on_err=0;; *-r*[ik]*) x_on_err=0;; *) x_on_err=1;; esac; \
1093         for i in $(WAYS) ; do \
1094           echo "------------------------------------------------------------------------"; \
1095           echo "==fptools== $(MAKE) way=$$i $@;"; \
1096           echo "PWD = $(shell pwd)"; \
1097           echo "------------------------------------------------------------------------"; \
1098           $(MAKE) way=$$i --no-print-directory $(MFLAGS) $@ ; \
1099           if [ $$? -eq 0 ] ; then true; else exit $$x_on_err; fi; \
1100         done
1101         @echo "------------------------------------------------------------------------"
1102         @echo "===fptools== Finished recursively making \`$@' for ways: $(WAYS) ..."
1103         @echo "PWD = $(shell pwd)"
1104         @echo "------------------------------------------------------------------------"
1105
1106 endif
1107 endif
1108