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