[project @ 2002-07-16 14:49:38 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' `rtf' 
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) $(EXTRA_OBJS); $(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 echo $(EXTRA_OBJS) >> $@.list
308 $(FIND) $(patsubst %.$(way_)o,%_split,$(HS_OBJS)) -name '*.$(way_)o' >> $@.list
309 $(AR) $(AR_OPTS) $@.tmp $(ArSupportsInput) $@.list
310 $(RM) $@.list
311 $(RANLIB) $@.tmp
312 $(MV) $@.tmp $@
313 endef
314 endif
315
316 # Extra stuff for compiling Haskell files with $(SplitObjs):
317
318 HC_SPLIT_PRE = \
319     $(RM) $@; if [ ! -d $(basename $@)_split ]; then mkdir $(basename $@)_split; else \
320     $(FIND) $(basename $@)_split -name '*.$(way_)o' | xargs $(RM) __rm_food; fi
321 ifeq "$(GhcWithInterpreter)" "YES"
322 HC_SPLIT_POST = (cd $(dir $@) && $(LD) -r $(LD_X) -o $(notdir $@) $(basename $(notdir $@))_split/*.$(way_)o)
323 else
324 HC_SPLIT_POST = touch $@
325 endif # GhcWithInterpreter == YES
326
327 SRC_HC_PRE_OPTS  += $(HC_SPLIT_PRE);
328 SRC_HC_POST_OPTS += $(HC_SPLIT_POST);
329
330 #
331 # If (Haskell) object files are split, cleaning up 
332 # consist of descending into the directories where
333 # the myriads of object files have been put.
334 #
335
336 extraclean ::
337         $(FIND) $(patsubst %.$(way_)o,%_split,$(HS_OBJS)) -name '*.$(way_)o' -print | xargs $(RM) __rm_food
338         -rmdir $(patsubst %.$(way_)o,%_split,$(HS_OBJS)) > /dev/null 2>&1
339
340 endif # $(way) == u
341 endif # $(SplitObjs)
342 endif # $(HS_SRCS)
343
344 #
345 # Remove local symbols from library objects if requested.
346 #
347
348 ifeq "$(StripLibraries)" "YES"
349 ifeq "$(SplitObjs)" "YES"
350 SRC_HC_POST_OPTS += \
351   for i in $(basename $@)_split/*; do \
352         $(LD) -r $(LD_X) -o $$i.tmp $$i; \
353         $(MV) $$i.tmp $$i; \
354   done
355 else
356 SRC_HC_POST_OPTS += \
357   $(LD) -r $(LD_X) -o $@.tmp $@; $(MV) $@.tmp $@
358 endif # SplitObjs
359 endif # StripLibraries
360
361 # Note: $(STUBOBJS) isn't depended on here, but included when building the lib.
362 #       (i.e., the assumption is that $(STUBOBJS) are created as a side-effect
363 #       of building $(LIBOBJS)).
364 $(LIBRARY) : $(LIBOBJS)
365         $(BUILD_LIB)
366 endif # LIBRARY = ""
367
368 #----------------------------------------
369 #       Building Win32 DLLs
370 #
371
372 ifeq "$(DLLized)" "YES"
373 SRC_CC_OPTS += -DDLLized
374
375 ifneq "$(PACKAGE)" ""
376
377 SRC_BLD_DLL_OPTS += --export-all --output-def=HS$(PACKAGE)$(_cbits)$(_way).def DllVersionInfo.$(way_)o
378
379 ifneq "$(PACKAGE) $(IS_CBITS_LIB)" "std YES"
380 ifneq "$(PACKAGE)" "rts"
381 SRC_BLD_DLL_OPTS += -lHSstd_cbits_imp -L$(GHC_LIB_DIR)/std/cbits
382 SRC_BLD_DLL_OPTS += -lHSrts_$(way_)imp -L$(GHC_RUNTIME_DIR)
383 ifneq "$(PACKAGE)" "std"
384   ifeq "$(IS_CBITS_LIB)" ""
385   SRC_BLD_DLL_OPTS += -lHSstd_$(way_)imp -L$(GHC_LIB_DIR)/std 
386   endif
387 endif
388 endif
389 endif
390
391 SRC_BLD_DLL_OPTS += -lgmp -L. -L$(GHC_RUNTIME_DIR)/gmp
392 ifeq "$(IS_CBITS_LIB)" ""
393 SRC_BLD_DLL_OPTS += $(patsubst %,-lHS%_$(way_)imp, $(PACKAGE_DEPS))
394 SRC_BLD_DLL_OPTS += $(patsubst %,-L../%, $(PACKAGE_DEPS))
395 endif
396 ifneq "$(HAS_CBITS)" ""
397 SRC_BLD_DLL_OPTS += -lHS$(PACKAGE)_cbits_imp -Lcbits
398 endif
399 SRC_BLD_DLL_OPTS += -lwsock32 -lwinmm
400
401 endif # PACKAGE != ""
402
403 SplitObjs = NO 
404
405 ifneq "$(LIBRARY)" ""
406
407 all :: DllVersionInfo.$(way_)o
408
409 ifeq "$(DLL_NAME)" ""
410 DLL_NAME = $(patsubst %.a,%.dll,$(subst lib,,$(LIBRARY)))
411 endif
412
413 ifneq "$(DLL_NAME)" ""
414 DLL_NAME := $(DLL_PEN)/$(DLL_NAME)
415 endif
416
417 all :: $(DLL_NAME)
418
419 ifeq "$(DLL_IMPLIB_NAME)" ""
420 DLL_IMPLIB_NAME = $(patsubst %.a,%_imp.a,$(LIBRARY))
421 endif
422
423 $(DLL_NAME) :: $(LIBRARY)
424         $(BLD_DLL) --output-lib $(DLL_IMPLIB_NAME) -o $(DLL_NAME) $(LIBRARY) $(BLD_DLL_OPTS)
425 endif # LIBRARY != ""
426
427 endif # DLLized
428
429 #
430 # Version information is baked into a DLL by having the DLL include DllVersionInfo.o.
431 # The version info contains two user tweakables: DLL_VERSION and DLL_VERSION_NAME.
432 # (both are given sensible defaults though.)
433 #
434 # Note: this will not work as expected with Cygwin B20.1; you need a more recent
435 #       version of binutils (to pick up windres bugfixes.)
436
437 ifndef DLL_VERSION
438 DLL_VERSION=$(ProjectVersion)
439 endif
440
441 ifndef DLL_VERSION_NAME
442 DLL_VERSION_NAME="http://www.haskell.org/ghc"
443 endif
444
445 ifndef DLL_DESCRIPTION
446 DLL_DESCRIPTION="A GHC-compiled DLL"
447 endif
448
449 ifndef EXE_VERSION
450 EXE_VERSION=$(ProjectVersion)
451 endif
452
453 ifndef EXE_VERSION_NAME
454 EXE_VERSION_NAME="http://www.haskell.org/ghc"
455 endif
456
457 ifndef EXE_DESCRIPTION
458 EXE_DESCRIPTION="A GHC-compiled binary"
459 endif
460
461 #
462 # Little bit of lo-fi mangling to get at the right set of settings depending
463 # on whether we're generating the VERSIONINFO for a DLL or EXE
464
465 DLL_OR_EXE=$(subst VersionInfo.$(way_)rc,,$@)
466 VERSION_FT=$(subst Dll, 0x2L, $(subst Exe, 0x1L, $(DLL_OR_EXE)))
467 VERSION_RES_NAME=$(subst Exe,$(EXE_VERSION_NAME), $(subst Dll, $(DLL_VERSION_NAME),$(DLL_OR_EXE)))
468 VERSION_RES=$(subst Exe,$(EXE_VERSION), $(subst Dll, $(DLL_VERSION),$(DLL_OR_EXE)))
469 VERSION_DESC=$(subst Exe,$(EXE_DESCRIPTION), $(subst Dll, $(DLL_DESCRIPTION),$(DLL_OR_EXE)))
470
471 DllVersionInfo.$(way_)rc ExeVersionInfo.$(way_)rc:
472         $(RM) DllVersionInfo.$(way_)rc
473         echo "1 VERSIONINFO"                > $@
474         echo "FILEVERSION 1,0,0,1"         >> $@
475         echo "PRODUCTVERSION 1,0,0,1"      >> $@
476         echo "FILEFLAGSMASK 0x3fL"         >> $@
477         echo "FILEOS 0x4L"                 >> $@
478         echo "FILETYPE $(VERSION_FT)"      >> $@
479         echo "FILESUBTYPE 0x0L"            >> $@
480         echo "BEGIN"                       >> $@
481         echo " BLOCK \"StringFileInfo\""   >> $@
482         echo " BEGIN"                      >> $@
483         echo "  BLOCK \"040904B0\""        >> $@
484         echo "  BEGIN"                     >> $@
485         echo "   VALUE \"CompanyName\", \"$(VERSION_RES_NAME)\\0\"" >> $@
486         echo "   VALUE \"FileVersion\", \"$(VERSION_RES)\\0\"" >> $@
487         echo "   VALUE \"ProductVersion\", \"$(VERSION_RES)\\0\"" >> $@
488         echo "   VALUE \"FileDescription\", \"$(VERSION_DESC)\\0\"" >> $@
489         echo "  END" >> $@
490         echo " END" >> $@
491         echo " BLOCK \"VarFileInfo\""  >> $@
492         echo " BEGIN" >> $@
493         echo "  VALUE \"Translation\", 0x0409, 1200" >> $@
494         echo " END" >> $@
495         echo "END" >> $@
496
497 #----------------------------------------
498 #       Script programs
499
500 ifneq "$(SCRIPT_PROG)" ""
501
502 # To produce a fully functional script, you may
503 # have to add some configuration variables at the top of 
504 # the script, i.e., the compiler driver needs to know
505 # the path to various utils in the build tree for instance.
506 #
507 # To have the build rule for the script automatically do this
508 # for you, set the variable SCRIPT_SUBST_VARS to the list of
509 # variables you need to put in.
510
511 #
512 # SCRIPT_SUBST creates a string of echo commands that
513 # will when evaluated append the (perl)variable name and its value 
514 # to the target it is used for, i.e.,
515 #
516 #    A=foo
517 #    B=bar
518 #    SCRIPT_SUBST_VARS = A B
519 #    SCRIPT_SUBST=echo "$""A=\"foo\";" >> $@; echo "$""B=\"bar\";" >> $@
520 #
521 #    so if you have a rule like the following
522 #    
523 #     foo:
524 #         @(RM) $@
525 #         @(TOUCH) $@
526 #         @eval $(SCRIPT_SUBST)
527 #
528 #    `make foo' would create a file `foo' containing the following
529 #
530 #    % cat foo
531 #    $A=foo;
532 #    $B=bar;
533 #    %
534 #
535 # ToDo: make this work for shell scripts (drop the initial $).
536 #
537 ifeq "$(INTERP)" "$(SHELL)"
538 SCRIPT_SUBST=$(foreach val,$(SCRIPT_SUBST_VARS),"echo \"$(val)=\\\"$($(val))\\\";\" >> $@;")
539 else
540 SCRIPT_SUBST=$(foreach val,$(SCRIPT_SUBST_VARS),"echo \"$$\"\"$(val)=\\\"$($(val))\\\";\" >> $@;")
541 endif
542
543 all :: $(SCRIPT_PROG)
544
545 $(SCRIPT_PROG) : $(SCRIPT_OBJS)
546         $(RM) $@
547         @echo Creating $@...
548 ifeq "$(INTERP)" "perl"
549         echo "#! "$(PERL) > $@
550 else
551 ifneq "$(INTERP)" ""
552         @echo "#!"$(INTERP) > $@
553 else
554         @touch $@
555 endif
556 endif
557 ifneq "$(SCRIPT_PREFIX_FILES)" ""
558         @cat $(SCRIPT_PREFIX_FILES) >> $@
559 endif
560 ifneq "$(SCRIPT_SUBST)" ""
561         @eval $(SCRIPT_SUBST) 
562 endif
563         @cat $(SCRIPT_OBJS) >> $@
564         @chmod a+x $@
565         @echo Done.
566 endif
567
568 # ---------------------------------------------------------------------------
569 # Symbolic links
570
571 # links to programs: we sometimes install a program as
572 # <name>-<version> with a link from <name> to the real program.
573
574 ifneq "$(LINK)" ""
575
576 all :: $(LINK)
577
578 CLEAN_FILES += $(LINK)
579
580 ifeq "$(LINK_TARGET)" ""
581 ifneq "$(SCRIPT_PROG)" ""
582 LINK_TARGET = $(SCRIPT_PROG)
583 else
584 ifneq "$(HS_PROG)" ""
585 LINK_TARGET = $(HS_PROG)
586 else
587 ifneq "$(C_PROG)" ""
588 LINK_TARGET = $(C_PROG)
589 else
590 LINK_TARGET = dunno
591 endif
592 endif
593 endif
594 endif
595
596 #
597 # Don't want to overwrite $(LINK)s that aren't symbolic
598 # links. Testing for symbolic links is problematic to do in
599 # a portable fashion using a /bin/sh test, so we simply rely
600 # on perl.
601 #
602 $(LINK) : $(LINK_TARGET)
603         @if ( $(PERL) -e '$$fn="$(LINK)"; exit ((! -f $$fn || -l $$fn) ? 0 : 1);' ); then \
604            echo "Creating a symbolic link from $(LINK_TARGET) to $(LINK)"; \
605            $(RM) $(LINK); \
606            $(LN_S) $(LINK_TARGET) $(LINK); \
607          else \
608            echo "Creating a symbolic link from $(LINK_TARGET) to $(LINK) failed: \`$(LINK)' already exists"; \
609            echo "Perhaps remove \`$(LINK)' manually?"; \
610            exit 1; \
611          fi;
612
613
614 #
615 # install links to script drivers.
616 #
617 install ::
618         @$(INSTALL_DIR) $(bindir)
619         @if ( $(PERL) -e '$$fn="$(bindir)/$(LINK)"; exit ((! -f $$fn || -l $$fn) ? 0 : 1);' ); then \
620            echo "Creating a symbol link from $(LINK_TARGET) to $(LINK) in $(bindir)"; \
621            $(RM) $(bindir)/$(LINK); \
622            $(LN_S) $(LINK_TARGET) $(bindir)/$(LINK); \
623          else \
624            echo "Creating a symbol link from $(LINK_TARGET) to $(LINK) in $(bindir) failed: \`$(bindir)/$(LINK)' already exists"; \
625            echo "Perhaps remove \`$(bindir)/$(LINK)' manually?"; \
626            exit 1; \
627          fi;
628
629 endif # LINK 
630
631
632 ###########################################
633 #
634 #       Targets: install install-strip uninstall
635 #
636 ###########################################
637
638 # For each of these variables that is defined, you
639 # get one install rule
640 #
641 #       INSTALL_PROGS        executable programs in $(bindir)
642 #       INSTALL_SCRIPTS      executable scripts in $(bindir)
643 #       INSTALL_LIBS         platform-dependent libraries in $(libdir) (ranlib'ed)
644 #       INSTALL_LIB_SCRIPTS  platform-dependent scripts   in $(libdir)
645 #       INSTALL_LIBEXECS     platform-dependent execs in $(libdir)
646 #       INSTALL_DATAS        platform-independent files in $(datadir)
647 #       INSTALL_IFACES       platform-dependent interface files in $(ifacedir)
648 #
649 # If the installation directory variable is undefined, the install rule simply
650 # emits a suitable error message.
651 #
652 # Remember, too, that the installation directory variables ($(bindir) and
653 # friends can be overridden from their original settings in mk/config.mk.in
654 # || mk/build.mk
655 #
656 .PHONY: install install-docs installdirs install-strip install-dirs uninstall install-docs show-install
657
658 show-install :
659         @echo "bindir = $(bindir)"
660         @echo "libdir = $(libdir)"
661         @echo "libexecdir = $(libexecdir)  # by default, same as libdir"
662         @echo "datadir = $(datadir)  # unused for ghc project"
663
664 #
665 # Sometimes useful to separate out the creation of install directories 
666 # from the installation itself.
667 #
668 install-dirs ::
669         @$(INSTALL_DIR) $(bindir)
670         @$(INSTALL_DIR) $(libdir)
671         @$(INSTALL_DIR) $(libexecdir)
672         @$(INSTALL_DIR) $(datadir)
673
674 # Better do this first...
675 # but we won't for the moment, do it on-demand from
676 # within the various install targets instead.
677 #install:: install-dirs
678
679 ifneq "$(INSTALL_PROGS)" ""
680
681 #
682 # Here's an interesting one - when using the win32 version
683 # of install (provided via the cygwin toolkit), we have to
684 # supply the .exe suffix, *if* there's no other suffix.
685 #
686 # The rule below does this by ferreting out the suffix of each
687 # entry in the INSTALL_PROGS list. If there's no suffix, use
688 # $(exeext).
689
690 INSTALL_PROGS := $(foreach p, $(INSTALL_PROGS), $(addsuffix $(if $(suffix $(p)),,$(exeext)), $(basename $(p))))
691
692 install:: $(INSTALL_PROGS)
693         @$(INSTALL_DIR) $(bindir)
694         @for i in $(INSTALL_PROGS); do \
695                     echo $(INSTALL_PROGRAM) $(INSTALL_BIN_OPTS) $$i $(bindir); \
696                     $(INSTALL_PROGRAM) $(INSTALL_BIN_OPTS) $$i $(bindir) ;  \
697         done
698 endif
699
700 #
701 # Just like INSTALL_PROGS, but prefix with install sites bin/lib/data and
702 # install without stripping.
703 #
704 ifneq "$(INSTALL_SCRIPTS)" ""
705 install:: $(INSTALL_SCRIPTS)
706         @$(INSTALL_DIR) $(bindir)
707         for i in $(INSTALL_SCRIPTS); do \
708                 $(INSTALL_SCRIPT) $(INSTALL_OPTS) $$i $(bindir); \
709         done
710 endif
711
712 ifneq "$(INSTALL_LIB_SCRIPTS)" ""
713 install:: $(INSTALL_LIB_SCRIPTS)
714         @$(INSTALL_DIR) $(libdir)
715         for i in $(INSTALL_LIB_SCRIPTS); do \
716                 $(INSTALL_SCRIPT) $(INSTALL_OPTS) $$i $(libdir); \
717         done
718 endif
719
720 ifneq "$(INSTALL_LIBEXEC_SCRIPTS)" ""
721 install:: $(INSTALL_LIBEXEC_SCRIPTS)
722         @$(INSTALL_DIR) $(libexecdir)
723         for i in $(INSTALL_LIBEXEC_SCRIPTS); do \
724                 $(INSTALL_SCRIPT) $(INSTALL_OPTS) $$i $(libexecdir); \
725         done
726 endif
727
728 ifneq "$(INSTALL_LIBS)" ""
729 install:: $(INSTALL_LIBS)
730         @$(INSTALL_DIR) $(libdir)
731         for i in $(INSTALL_LIBS); do \
732                 case $$i in \
733                   *.a) \
734                     $(INSTALL_DATA) $(INSTALL_OPTS) $$i $(libdir); \
735                     $(RANLIB) $(libdir)/`basename $$i` ;; \
736                   *.dll) \
737                     $(INSTALL_DATA) -s $(INSTALL_OPTS) $$i $(libdir) ;; \
738                   *.so) \
739                     $(INSTALL_SHLIB) $(INSTALL_OPTS) $$i $(libdir) ;; \
740                   *) \
741                     $(INSTALL_DATA) $(INSTALL_OPTS) $$i $(libdir); \
742                 esac; \
743         done
744 endif
745
746 ifneq "$(INSTALL_LIBEXECS)" ""
747 #
748 # See above comment next to defn of INSTALL_PROGS for what
749 # the purpose of this one-liner is.
750
751 INSTALL_LIBEXECS := $(foreach p, $(INSTALL_LIBEXECS), $(addsuffix $(subst _,,$(subst __,$(exeext),_$(suffix $(p))_)), $(basename $(p))))
752
753 install:: $(INSTALL_LIBEXECS)
754         @$(INSTALL_DIR) $(libexecdir)
755         -for i in $(INSTALL_LIBEXECS); do \
756                 $(INSTALL_PROGRAM) $(INSTALL_BIN_OPTS) $$i $(libexecdir); \
757         done
758 endif
759
760 ifneq "$(INSTALL_DATAS)" ""
761 install:: $(INSTALL_DATAS)
762         @$(INSTALL_DIR) $(datadir)
763         for i in $(INSTALL_DATAS); do \
764                 $(INSTALL_DATA) $(INSTALL_OPTS) $$i $(datadir); \
765         done
766 endif
767
768 ifneq "$(INSTALL_IFACES)" ""
769 install:: $(INSTALL_IFACES)
770         @$(INSTALL_DIR) $(ifacedir)
771         for i in $(INSTALL_IFACES); do \
772                 $(INSTALL_DATA) $(INSTALL_OPTS) $$i $(ifacedir); \
773         done
774 endif
775
776 ifneq "$(INSTALL_IFACES_WITH_DIRS)" ""
777 install:: $(INSTALL_IFACES_WITH_DIRS)
778         @$(INSTALL_DIR) $(ifacedir)
779         for i in $(INSTALL_IFACES_WITH_DIRS); do \
780                 $(INSTALL_DATA) $(INSTALL_OPTS) $$i $(ifacedir)/`dirname $$i`; \
781         done
782 endif
783
784 ifneq "$(INSTALL_INCLUDES)" ""
785 install:: $(INSTALL_INCLUDES)
786         @$(INSTALL_DIR) $(includedir)
787         for i in $(INSTALL_INCLUDES); do \
788                 $(INSTALL_DATA) $(INSTALL_OPTS) $$i $(includedir); \
789         done
790 endif
791
792 ifneq "$(INSTALL_DOCS)" ""
793 install-docs:: $(INSTALL_DOCS)
794         @$(INSTALL_DIR) $(datadir)      
795         for i in $(INSTALL_DOCS); do \
796                 $(INSTALL_DATA) $(INSTALL_OPTS) $$i $(datadir); \
797         done
798 endif
799
800 ifneq "$(INSTALL_SGML_DOC)" ""
801 ifneq "$(SGMLDocWays)" ""
802 install-docs:: $(foreach i,$(SGMLDocWays),$(INSTALL_SGML_DOC).$i)
803         @$(INSTALL_DIR) $(datadir)      
804         @for i in $(SGMLDocWays); do \
805                 if [ $$i = "html" ]; then \
806                         $(INSTALL_DIR) $(datadir)/html; \
807                         echo $(CP) -r $(INSTALL_SGML_DOC) $(datadir)/html; \
808                         $(CP) -r $(INSTALL_SGML_DOC) $(datadir)/html; \
809                 else \
810                         echo $(INSTALL_DATA) $(INSTALL_OPTS) $(INSTALL_SGML_DOC).$$i $(datadir); \
811                         $(INSTALL_DATA) $(INSTALL_OPTS) $(INSTALL_SGML_DOC).$$i $(datadir); \
812                 fi \
813         done
814 endif
815 endif
816
817 #
818 # Use with care..
819 #
820 uninstall:: 
821         @for i in $(INSTALL_PROGS) "" ; do                      \
822           if test "$$i"; then                                   \
823                 echo rm -f $(bindir)/`basename $$i`;            \
824                 rm -f $(bindir)/`basename $$i`;                 \
825           fi;                                                   \
826         done
827         @for i in $(INSTALL_LIBS) ""; do                        \
828           if test "$$i"; then                                   \
829                 echo rm -f $(libdir)/`basename $$i`;            \
830                 rm -f $(libdir)/`basename $$i`;                 \
831           fi;                                                   \
832         done
833         @for i in $(INSTALL_LIBEXECS) ""; do                    \
834           if test "$$i"; then                                   \
835                 echo rm -f $(libexecdir)/`basename $$i`;        \
836                 rm -f $(libexecdir)/`basename $$i`;             \
837           fi;                                                   \
838         done
839         @for i in $(INSTALL_DATAS) ""; do                       \
840           if test "$$i"; then                                   \
841                 echo rm -f $(datadir)/`basename $$i`;           \
842                 rm -f $(datadir)/`basename $$i`;                \
843           fi;                                                   \
844         done
845
846 #
847 # install-strip is from the GNU Makefile standard.
848 #
849 ifneq "$(way)" ""
850 install-strip::
851         @$(MAKE) EXTRA_INSTALL_OPTS='-s' install                                        
852 endif
853
854 ##############################################################################
855 #
856 #       Targets: check tags show
857 #
858 ##############################################################################
859
860 #------------------------------------------------------------
861 #                       Check
862
863 .PHONY: check
864
865 check:: $(TESTS)
866         @for i in $(filter-out %.lhs .hs, $(TESTS)) ''; do      \
867           if (test -f "$$i"); then              \
868             echo Running: `basename $$i` ;      \
869             cd test; `basename $$i` ;           \
870           fi;                                   \
871         done;
872
873 #------------------------------------------------------------
874 #                       Tags
875
876 .PHONY: TAGS tags
877
878 tags TAGS:: $(TAGS_HS_SRCS) $(TAGS_C_SRCS)
879         @$(RM) TAGS
880         @touch TAGS
881 ifneq "$(TAGS_HS_SRCS)" ""
882         $(HSTAGS) $(HSTAGS_OPTS) -- $(TAGS_HS_SRCS)
883 endif
884 ifneq "$(TAGS_C_SRCS)" ""
885         etags -a $(TAGS_C_SRCS)
886 endif
887         @( 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?
888
889 #------------------------------------------------------------
890 #                       Makefile debugging
891 # to see the effective value used for a Makefile variable, do
892 #  make show VALUE=MY_VALUE
893 #
894
895 show:
896         @echo '$(VALUE)="$($(VALUE))"'
897
898 ################################################################################
899 #
900 #                       SGML Documentation
901 #
902 ################################################################################
903
904 .PHONY: dvi ps html pdf rtf
905
906 ifneq "$(SGML_DOC)" ""
907
908 all :: $(SGMLDocWays)
909
910 # multi-file SGML document: main document name is specified in $(SGML_DOC),
911 # sub-documents (.sgml files) listed in $(SGML_SRCS).
912
913 ifeq "$(SGML_SRCS)" ""
914 SGML_SRCS = $(wildcard *.sgml)
915 endif
916
917 SGML_TEX  = $(addsuffix .tex,$(SGML_DOC))
918 SGML_DVI  = $(addsuffix .dvi,$(SGML_DOC))
919 SGML_PS   = $(addsuffix .ps,$(SGML_DOC))
920 SGML_PDF  = $(addsuffix .pdf,$(SGML_DOC))
921 SGML_RTF  = $(addsuffix .rtf,$(SGML_DOC))
922 SGML_HTML = $(addsuffix .html,$(SGML_DOC))
923 # HTML output goes in a subdirectory on its own.
924 SGML_TEXT = $(addsuffix .txt,$(SGML_DOC))
925
926 $(SGML_DVI) $(SGML_PS) $(SGML_HTML) $(SGML_TEXT) $(SGML_PDF) :: $(SGML_SRCS)
927
928 dvi  :: $(SGML_DVI)
929 ps   :: $(SGML_PS)
930 pdf  :: $(SGML_PDF)
931 rtf  :: $(SGML_RTF)
932 html :: $(SGML_HTML)
933 txt  :: $(SGML_TEXT)
934
935 CLEAN_FILES += $(SGML_TEXT) $(SGML_TEX) $(SGML_PS) $(SGML_DVI) $(SGML_PDF) $(SGML_RTF) $(SGML_HTML) $(SGML_DOC)-*.html
936 # can't use $(SGML_SRCS) here, it was maybe used elsewhere
937
938 extraclean ::
939         $(RM) -rf DBTOHTML_OUTPUT_*
940         $(RM) -rf *.junk/
941         $(RM) -rf $(SGML_DOC)
942 endif
943
944 ##############################################################################
945 #
946 #       Targets: clean
947 #
948 ##############################################################################
949
950 # we have to be careful about recursion here; since all the clean
951 # targets are recursive, we don't want to make eg. distclean depend on
952 # clean because that would result in far too many recursive calls.
953
954 .PHONY: mostlyclean clean distclean maintainer-clean
955
956 mostlyclean::
957         rm -f $(MOSTLY_CLEAN_FILES)
958
959 # extraclean is used for adding actions to the clean target.
960 extraclean::
961
962 clean:: extraclean
963         rm -f $(MOSTLY_CLEAN_FILES) $(CLEAN_FILES)
964
965 distclean:: extraclean
966         rm -f $(MOSTLY_CLEAN_FILES) $(CLEAN_FILES) $(DIST_CLEAN_FILES)
967
968 maintainer-clean:: extraclean
969         @echo 'This command is intended for maintainers to use; it'
970         @echo 'deletes files that may need special tools to rebuild.'
971         rm -f $(MOSTLY_CLEAN_FILES) $(CLEAN_FILES) $(DIST_CLEAN_FILES) $(MAINTAINER_CLEAN_FILES)
972
973 ################################################################################
974 #
975 #                       Way management
976 #
977 ################################################################################
978
979 # Here is the ingenious jiggery pokery that allows you to build multiple versions
980 # of a program in a single build tree.
981 #
982 # The ways setup requires the following variables to be set:
983 #
984 # Expects:      $(WAYS)                 the possible "way" strings to one of 
985 #                                       which $(way) will be set
986
987
988 # So how does $(way) ever get set to anything?  Answer, we recursively
989 # invoke make, setting $(way) on the command line.
990 # When do we do this recursion?  Answer: whenever the programmer
991 # asks make to make a target that involves a way suffix.
992 # We must remember *not* to recurse again; but that's easy: we
993 # just see if $(way) is set:
994
995 ifeq "$(way)" ""
996
997 # If $(WAYS) = p mc, then WAY_TARGETS expands to
998 #       %.p_lhs %.p_hs %.p_o ... %.mc_lhs %.p_hs ...
999 # and OTHER_WAY_TARGETS to
1000 #       %_p.a %_p %_mc.a %_mc
1001 # where the suffixes are from $(SUFFIXES)
1002 #
1003 # We have to treat libraries and "other" targets differently, 
1004 # because their names are of the form
1005 #       libHS_p.a and Foo_p
1006 # whereas everything else has names of the form
1007 #       Foo.p_o
1008
1009 FPTOOLS_SUFFIXES := o hi hc
1010
1011 WAY_TARGETS     = $(foreach way,$(WAYS),$(foreach suffix, $(FPTOOLS_SUFFIXES), %.$(way)_$(suffix)))
1012 LIB_WAY_TARGETS = $(foreach way,$(WAYS),%_$(way).a %_$(way))
1013
1014 # $@ will be something like Foo.p_o
1015 # $(suffix $@)     returns .p_o
1016 # $(subst .,.p_o)  returns p_o
1017 # $(subst _,.,p_o) returns p.o   (clever)
1018 # $(basename p.o)  returns p
1019
1020 $(WAY_TARGETS) :
1021         $(MAKE) way=$(basename $(subst _,.,$(subst .,,$(suffix $@)))) $@
1022
1023 # $(@F) will be something like libHS_p.a, or Foo_p
1024 # $(basename $(@F)) will be libHS_p, or Foo_p
1025 # The sed script extracts the "p" part.
1026
1027 $(LIB_WAY_TARGETS) :
1028         $(MAKE) $(MFLAGS) $@ way=$(subst .,,$(suffix $(subst _,.,$(basename $@))))
1029
1030 endif   # if way
1031
1032 # -------------------------------------------------------------------------
1033 # Object and interface files have suffixes tagged with their ways
1034
1035 ifneq "$(way)" ""
1036 SRC_HC_OPTS += -hisuf $(way_)hi -hcsuf $(way_)hc -osuf $(way_)o
1037 endif
1038
1039 # -------------------------------------------------------------------------
1040 # Rules to invoke the current target recursively for each way
1041
1042 ifneq "$(WAYS)" ""
1043 ifeq "$(way)" ""
1044
1045 # NB: the targets exclude 
1046 #       boot runtests
1047 # since these are way-independent
1048 all docs TAGS clean distclean mostlyclean maintainer-clean install ::
1049         @echo "------------------------------------------------------------------------"
1050         @echo "===fptools== Recursively making \`$@' for ways: $(WAYS) ..."
1051         @echo "PWD = $(shell pwd)"
1052         @echo "------------------------------------------------------------------------"
1053 # Don't rely on -e working, instead we check exit return codes from sub-makes.
1054         @case '${MFLAGS}' in *-[ik]*) x_on_err=0;; *-r*[ik]*) x_on_err=0;; *) x_on_err=1;; esac; \
1055         for i in $(WAYS) ; do \
1056           echo "------------------------------------------------------------------------"; \
1057           echo "==fptools== $(MAKE) way=$$i $@;"; \
1058           echo "PWD = $(shell pwd)"; \
1059           echo "------------------------------------------------------------------------"; \
1060           $(MAKE) way=$$i --no-print-directory $(MFLAGS) $@ ; \
1061           if [ $$? -eq 0 ] ; then true; else exit $$x_on_err; fi; \
1062         done
1063         @echo "------------------------------------------------------------------------"
1064         @echo "===fptools== Finished recursively making \`$@' for ways: $(WAYS) ..."
1065         @echo "PWD = $(shell pwd)"
1066         @echo "------------------------------------------------------------------------"
1067
1068 endif
1069 endif
1070
1071
1072 ##################################################################
1073 #
1074 #               Recursive stuff
1075 #
1076 # This was once at the top of the file, allegedly because it was
1077 # needed for some targets, e.g. when building DLLs in libraries.  But
1078 # since this reason is a little short on information, and I'm having
1079 # trouble with subdirectory builds happening before the current
1080 # directory when building hslibs (bad interaction with including
1081 # _hsc.o files in the cbits lib) so I'm moving the recursive makes to
1082 # the end --SDM 12/12/2001
1083 #
1084 ##################################################################
1085
1086 # Here are the diabolically clever rules that
1087
1088 # (a) for each "recursive target" <t>
1089 #     propagates "make <t>" to directories in SUBDIRS
1090 #
1091 # (b) when SUBDIRS is empty,
1092 #     for each "multi-way-target" <t>
1093 #     calls "make way=w <t>" for each w in $(WAYS)
1094 #
1095 #     This has the effect of making the standard target
1096 #     in each of the specified ways (as well as in the normal way
1097
1098 # Controlling variables
1099 #       WAYS    = extra (beyond the normal way) ways to build things in
1100 #       SUBDIRS = subdirectories to recurse into
1101
1102 # No ways, so iterate over the SUBDIRS
1103
1104 # note about recursively invoking make: we'd like make to drop all the
1105 # way back to the top level if it fails in any of the
1106 # sub(sub-...)directories.  This is done by setting the -e flag to the
1107 # shell during the loop, which causes an immediate failure if any of
1108 # the shell commands fail.
1109
1110 # One exception: if the user gave the -i or -k flag to make in the
1111 # first place, we'd like to reverse this behaviour.  So we check for
1112 # these flags, and set the -e flag appropriately.  NOTE: watch out for
1113 # the --no-print-directory flag which is passed to recursive
1114 # invocations of make.
1115 #
1116 ifeq "$(way)" ""
1117 ifneq "$(SUBDIRS)" ""
1118
1119 # we override the 'boot', 'all' and 'install' targets in the top
1120 # level Makefile. Some of the sub-projects also set 'boot' to empty.
1121
1122 ifeq "$(NO_ALL_TARGET)" "YES"
1123 ALL_TARGET     =
1124 else
1125 ALL_TARGET     = all
1126 endif
1127
1128 ifeq "$(NO_BOOT_TARGET)" "YES"
1129 BOOT_TARGET    =
1130 else
1131 BOOT_TARGET    = boot
1132 endif
1133
1134 ifeq "$(NO_INSTALL_TARGET)" "YES"
1135 INSTALL_TARGET =
1136 INSTALL_DOCS_TARGET =
1137 else
1138 INSTALL_TARGET = install
1139 INSTALL_DOCS_TARGET = install-docs
1140 endif
1141
1142 $(ALL_TARGET) docs runtests $(BOOT_TARGET) TAGS clean distclean mostlyclean maintainer-clean $(INSTALL_TARGET) $(INSTALL_DOCS_TARGET) html ps dvi txt::
1143         @echo "------------------------------------------------------------------------"
1144         @echo "===fptools== Recursively making \`$@' in $(SUBDIRS) ..."
1145         @echo "PWD = $(shell pwd)"
1146         @echo "------------------------------------------------------------------------"
1147 # Don't rely on -e working, instead we check exit return codes from sub-makes.
1148         @case '${MFLAGS}' in *-[ik]*) x_on_err=0;; *-r*[ik]*) x_on_err=0;; *) x_on_err=1;; esac; \
1149         for i in $(SUBDIRS); do \
1150           echo "------------------------------------------------------------------------"; \
1151           echo "==fptools== $(MAKE) $@ $(MFLAGS);"; \
1152           echo " in $(shell pwd)/$$i"; \
1153           echo "------------------------------------------------------------------------"; \
1154           $(MAKE) --no-print-directory -C $$i $(MFLAGS) $@; \
1155           if [ $$? -eq 0 -o $$x_on_err -eq 0 ] ;  then true; else exit 1; fi; \
1156         done
1157         @echo "------------------------------------------------------------------------"
1158         @echo "===fptools== Finished making \`$@' in $(SUBDIRS) ..."
1159         @echo "PWD = $(shell pwd)"
1160         @echo "------------------------------------------------------------------------"
1161
1162 endif
1163 endif
1164
1165 #
1166 # Selectively building subdirectories.
1167 #
1168 #
1169 ifneq "$(SUBDIRS)" ""
1170 $(SUBDIRS) ::
1171           $(MAKE) -C $@ $(MFLAGS)
1172 endif