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