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