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