Add WAY_debug_t_NAME and WAY_debug_t_HC_OPTS
[ghc-hetmet.git] / mk / paths.mk
index bd1d040..aff1274 100644 (file)
-#################################################################################
+################################################################################
 #
 #                          paths.mk
 #
 #      This file defines Make variables for standard directories
 #      and file lists
 #
-#################################################################################
+################################################################################
 
-
-#-----------------------------------------------------------------
-#
-# Installation setup
-#
-
-#-----------------------------------------------------------------------------
-# install configuration
-#
-# The install standard target is guided by the following four variables
-#
-#  INSTALL_PROGS    (installed in $(bindir))
-#  INSTALL_LIBS     (installed in $(libdir))
-#  INSTALL_LIBEXECS (installed in $(libexecdir))
-#  INSTALL_DATAS    (installed in $(datadir))
-#
-# see target.mk for more information.
-#
-
-#
-# Setting user/group ownership for the installed entities
-#
-# this stuff about "who" does the installing doesn't have make vars
-# as it is not intended to be run-time changeable.
-#
-ifneq "$(OWNER)" ""
-INSTALL_OWNER  = -o $(OWNER)
-else
-INSTALL_OWNER  =
-endif
-
-ifneq "$(GROUP)" ""
-INSTALL_GROUP  = -g $(GROUP)
-else
-INSTALL_GROUP  =
-endif
-
-SRC_INSTALL_OPTS += $(INSTALL_OWNER) $(INSTALL_GROUP)
-
-#
-# Invocations of `install' for the three different classes
-# of targets:
-#
-
-INSTALL_PROGRAM = $(INSTALL)
-INSTALL_DATA    = $(INSTALL) -m 644
-INSTALL_DIR     = $(FPTOOLS_TOP)/glafp-utils/mkdirhier/mkdirhier
-
-#
-# The install variables does not have any defaults,
-# what files to install have to be specified in the Makefiles.
-# 
-#INSTALL_PROGS += $(HS_PROG) $(C_PROG)
-#INSTALL_LIBS  += $(LIBRARY)
-#INSTALL_DATAS += $(HS_IFACES)
-
-#-----------------------------------------------------------------------------
-# Man pages & Documentation
-#
-# (AFAIK, not currently used)
-#
-
-#man1dir               = $(mandir)/man1
-#manext          = '.1'
-#man1ext          = '.1'
-#man2dir               = $(mandir)/man2
-#man2ext          = '.2'
-#man3dir               = $(mandir)/man3
-#man3ext          = '.3'
-#man4dir               = $(mandir)/man4
-#man4ext          = '.4'
-#man5dir               = $(mandir)/man5
-#man5ext          = '.5'
-#man6dir               = $(mandir)/man6
-#man6ext          = '.6'
-#man7dir               = $(mandir)/man7
-#man7ext          = '.7'
-#man8dir               = $(mandir)/man8
-#man8ext          = '.8'
-
-## top of manual page tree to install in
-## NB: not necessarily the same place as to look for man pages (?)
-#INSTALL_MAN_ROOT = $(mandir)
-
-## prefix for man page _sources_ (vs .../cat)
-#INSTALL_MAN_SRCROOT  = $(INSTALL_MAN_ROOT)/man
-
-## man pages for commands
-#INSTALL_COMMAND_DIR = $(INSTALL_MAN_SRCROOT)$(COMMANSUFFIX)
-
-## man pages for library routines
-#INSTALL_LIB_MANDIR = $(INSTALL_MAN_SRCROOT)$(LIBMANSUFFIX)
-
-## man pages for system commands
-#INSTALL_SYS_MANDIR = $(INSTALL_MAN_SRCROOT)$(SYSMANSUFFIX)
-
-## suffix for installing commands'/etcs' man pages
-#COMMANSUFFIX  = 1
-#LIBMANSUFFIX  = 3
-#SYSMANSUFFIX  = 8
-
-INSTALL_INFO_DIR = $(infodir)
-
-
-INSTALL_FILE_OPTS =
-INSTALL_STRIP    =
-INSTALL_BIN_OPTS  = \
-       -m 0755 $(INSTALL_OWNER) $(INSTALL_GROUP) $(INSTALL_FILE_FLAGS) $(INSTALL_STRIP)
-
-
-
-
-
-#################################################################################
+################################################################################
 #
 #              Standard variable names
 #
-#################################################################################
-
-#
-# The fptools mk setup defines a set of standard names which are used by the standard
-# targets provided by mk. One example of this is the use of standard names
-# for specifying what files to compile, their intermediate/object code, and
-# the name of the final executable. Based on the settings of these variables, the
-# standard targets will generate/expand rules that automatically compile and
+################################################################################
+# The fptools mk setup defines a set of standard names which are used
+# by the standard targets provided by mk. One example of this is the
+# use of standard names for specifying what files to compile, their
+# intermediate/object code, and the name of the final
+# executable. Based on the settings of these variables, the standard
+# targets will generate/expand rules that automatically compile and
 # link your program.
 #
 # The general rules:
-#   
+#
 #   SRCS - sources, might be prefixed to indicate what type of source
 #          they are.
 #   OBJS - object files (possibly prefixed).
 #
 #   PROG - name of final executable
 #
-#
-#
-# BOOT_SRCS: list of machine generated Haskell modules.
+# We attempt to automatically devine the list of sources $(SRCS) to
+# compile by looking in the current directory (and possibly other
+# directories which may be specified by setting the $(ALL_DIRS)
+# variable).  This is complicated by the fact that some files are
+# derived from other files: eg. .hsc files give rise to -hsc.c and
+# -hsc.h files, .ly files give rise to .hs files, and .hs files give
+# rise to .hc files sometimes.
+
+# So we figure out the sources in three stages: first figure out what
+# sources we can find (this is $(ALL_SRCS)).  Then figure out all the
+# "derived" sources (eg. A.hsc generates A.hs and A_hsc.c), and
+# finally put all these together and remove duplicates (GNU make's
+# handy sort function does the duplicate removing).
+
 # HS_SRCS:   list of Haskell modules you want to compile.
 #             (also use by depend rule).
 # HS_OBJS:   list of corresponding object files
@@ -153,31 +50,135 @@ INSTALL_BIN_OPTS  = \
 #             (caveat: assuming no funny use of -hisuf and that
 #               file name and module name match)
 
-SRCS=$(wildcard *.lhs *.hs *.c *.lc *.prl *.lprl *.lit *.verb)
-
-HS_SRCS=$(filter %.lhs %.hs %.hc,$(SRCS))
-#
-# Do not include BOOT_SRCS in the HS_SRCS defn above,
-# since this will make HS_SRCS always be non-empty,
-# which breaks rules like `depend'. Price is that
-# you have to define BOOT_SRCS before including
-# boilerplate.mk
-#
-ifneq "$(BOOT_SRCS)" ""
-HS_SRCS+=$(BOOT_SRCS)
+ALL_SRCS    = $(wildcard $(patsubst ./%, %,  \
+                  $(patsubst %,%/*.hs,   . $(ALL_DIRS)) \
+                  $(patsubst %,%/*.lhs,  . $(ALL_DIRS)) \
+                  $(patsubst %,%/*.hs-boot,  . $(ALL_DIRS)) \
+                  $(patsubst %,%/*.lhs-boot, . $(ALL_DIRS)) \
+                  $(patsubst %,%/*.y,    . $(ALL_DIRS)) \
+                  $(patsubst %,%/*.ly,   . $(ALL_DIRS)) \
+                  $(patsubst %,%/*.x,    . $(ALL_DIRS)) \
+                  $(patsubst %,%/*.c,    . $(ALL_DIRS)) \
+                  $(patsubst %,%/*.hc,   . $(ALL_DIRS)) \
+                  $(patsubst %,%/*.S,    . $(ALL_DIRS)) \
+                  $(patsubst %,%/*.prl,  . $(ALL_DIRS)) \
+                  $(patsubst %,%/*.lprl, . $(ALL_DIRS)) \
+                  $(patsubst %,%/*.lit,  . $(ALL_DIRS)) \
+                  $(patsubst %,%/*.verb, . $(ALL_DIRS)) \
+                  $(patsubst %,%/*.hsc,  . $(ALL_DIRS)) \
+                  $(patsubst %,%/*.gc,   . $(ALL_DIRS)) \
+              )) $(EXTRA_SRCS)
+
+# ALL_SRCS is computed once and for all into PRE_SRCS at the top of
+# target.mk.  Otherwise, we end up re-computing ALL_SRCS every time it
+# is expanded (it is used in several variables below, and these
+# variables are used in several others, etc.), which can really slow
+# down make.
+
+PRE_HS_SRCS  = $(filter %.hs,  $(PRE_SRCS))
+PRE_LHS_SRCS = $(filter %.lhs, $(PRE_SRCS))
+
+PRE_HS_BOOT_SRCS = $(filter %.hs-boot,  $(PRE_SRCS)) \
+                  $(filter %.lhs-boot, $(PRE_SRCS))
+
+GC_SRCS       = $(filter %.gc,  $(PRE_SRCS))
+HSC_SRCS      = $(filter %.hsc, $(PRE_SRCS))
+HAPPY_Y_SRCS  = $(filter %.y,   $(PRE_SRCS))
+HAPPY_LY_SRCS = $(filter %.ly,   $(PRE_SRCS))
+HAPPY_SRCS    = $(HAPPY_Y_SRCS) $(HAPPY_LY_SRCS)
+ALEX_SRCS     = $(filter %.x,   $(PRE_SRCS))
+
+DERIVED_GC_SRCS       = $(patsubst %.gc, %.hs, $(GC_SRCS)) \
+                       $(patsubst %.gc, %_stub_ffi.c, $(GC_SRCS)) \
+                       $(patsubst %.gc, %_stub_ffi.h, $(GC_SRCS))
+
+DERIVED_HSC_SRCS      = $(patsubst %.hsc, %.hs, $(HSC_SRCS)) \
+                       $(patsubst %.hsc, %_hsc.c, $(HSC_SRCS)) \
+                       $(patsubst %.hsc, %_hsc.h, $(HSC_SRCS)) \
+                       $(patsubst %.hsc, %.hc, $(HSC_SRCS))
+
+DERIVED_HAPPY_SRCS    = $(patsubst %.y,   %.hs, $(HAPPY_Y_SRCS)) \
+                       $(patsubst %.ly,  %.hs, $(HAPPY_LY_SRCS))
+
+DERIVED_ALEX_SRCS     = $(patsubst %.x,   %.hs, $(ALEX_SRCS))
+
+DERIVED_HC_SRCS       = $(patsubst %.hs,  %.hc, $(PRE_HS_SRCS)) \
+                       $(patsubst %.lhs, %.hc, $(PRE_LHS_SRCS))
+
+DERIVED_SRCS         = $(DERIVED_GC_SRCS) \
+                       $(DERIVED_HSC_SRCS) \
+                       $(DERIVED_HAPPY_SRCS) \
+                       $(DERIVED_ALEX_SRCS) \
+                       $(DERIVED_HC_SRCS)
+
+# EXCLUDED_SRCS can be set in the Makefile, otherwise it defaults to empty.
+EXCLUDED_GC_SRCS       = $(filter %.gc,  $(EXCLUDED_SRCS))
+EXCLUDED_HSC_SRCS      = $(filter %.hsc, $(EXCLUDED_SRCS))
+EXCLUDED_HAPPY_Y_SRCS  = $(filter %.y,   $(EXCLUDED_SRCS))
+EXCLUDED_HAPPY_LY_SRCS = $(filter %.ly,  $(EXCLUDED_SRCS))
+EXCLUDED_HAPPY_SRCS   = $(EXCLUDED_HAPPY_Y_SRCS) $(EXCLUDED_HAPPY_LY_SRCS)
+EXCLUDED_ALEX_SRCS    = $(filter %.x,   $(EXCLUDED_SRCS))
+EXCLUDED_HS_SRCS      = $(filter %.hs,  $(EXCLUDED_SRCS))
+EXCLUDED_LHS_SRCS     = $(filter %.lhs, $(EXCLUDED_SRCS))
+EXCLUDED_DERIVED_SRCS = $(patsubst %.hsc, %.hs, $(EXCLUDED_HSC_SRCS)) \
+                       $(patsubst %.hsc, %_hsc.h, $(EXCLUDED_HSC_SRCS)) \
+                       $(patsubst %.hsc, %_hsc.c, $(EXCLUDED_HSC_SRCS)) \
+                       $(patsubst %.hsc, %.hc, $(EXCLUDED_HSC_SRCS)) \
+                       $(patsubst %.gc,  %_stub_ffi.c, $(EXCLUDED_GC_SRCS)) \
+                       $(patsubst %.gc,  %_stub_ffi.h, $(EXCLUDED_GC_SRCS)) \
+                        $(patsubst %.y,   %.hs, $(EXCLUDED_HAPPY_Y_SRCS)) \
+                       $(patsubst %.ly,  %.hs, $(EXCLUDED_HAPPY_LY_SRCS)) \
+                        $(patsubst %.x,   %.hs, $(EXCLUDED_ALEX_SRCS)) \
+                       $(patsubst %.hs,  %.hc, $(EXCLUDED_HS_SRCS)) \
+                       $(patsubst %.lhs, %.hc, $(EXCLUDED_LHS_SRCS)) \
+                       $(patsubst %.hs,  %_stub.c, $(EXCLUDED_HS_SRCS)) \
+                       $(patsubst %.lhs, %_stub.c, $(EXCLUDED_LHS_SRCS))
+
+# Exclude _hsc.c files; they get built as part of the cbits library,
+# not part of the main library
+
+CLOSED_EXCLUDED_SRCS  = $(sort $(EXCLUDED_SRCS) $(EXCLUDED_DERIVED_SRCS))
+
+SRCS        = $(filter-out $(CLOSED_EXCLUDED_SRCS), \
+               $(sort $(PRE_SRCS) $(DERIVED_SRCS)))
+
+HS_SRCS            = $(filter %.lhs %.hs, $(sort $(SRCS) $(BOOT_SRCS)))
+HS_OBJS     = $(addsuffix .$(way_)o,$(basename $(HS_SRCS)))
+HS_IFACES   = $(addsuffix .$(way_)hi,$(basename $(HS_SRCS)))
+
+HI_BOOTS    = $(patsubst %.hs-boot, %.$(way_)hi-boot, \
+             $(patsubst %.lhs-boot, %.$(way_)hi-boot, $(PRE_HS_BOOT_SRCS)))
+
+O_BOOTS     = $(patsubst %.hs-boot, %.$(way_)o-boot, \
+             $(patsubst %.lhs-boot, %.$(way_)o-boot, $(PRE_HS_BOOT_SRCS)))
+
+GC_C_OBJS   = $(addsuffix _stub_ffi.$(way_)o,$(basename $(filter %.gc,$(SRCS))))
+HSC_C_OBJS  = $(addsuffix _hsc.$(way_)o,$(basename $(filter %.hsc,$(SRCS))))
+
+ifeq "$(BootingFromHc)" "NO"
+# We don't want to build the _stub.c files ourselves, unless we're
+# bootstrapping from .hc files.
+EXCLUDED_C_SRCS = $(patsubst %.lhs, %_stub.c, $(HS_SRCS)) \
+                 $(patsubst %.hs,  %_stub.c, $(HS_SRCS)) \
+                 $(patsubst %.gc, %_stub_ffi.c, $(GC_SRCS)) \
+                 $(patsubst %.gc, %_stub_ffi.h, $(GC_SRCS))
 endif
-HS_OBJS=$(addsuffix .$(way_)o,$(basename $(HS_SRCS)))
-HS_IFACES=$(addsuffix .$(way_)hi,$(basename $(HS_SRCS)))
 
-C_SRCS=$(filter %.lc %.c,$(SRCS))
-C_OBJS=$(addsuffix .$(way_)o,$(basename $(C_SRCS)))
+# These are droppings from hsc2hs - ignore them if we see them.
+EXCLUDED_C_SRCS += $(patsubst %.hsc, %_hsc_make.c, $(HSC_SRCS))
+
+C_SRCS      = $(filter-out $(EXCLUDED_C_SRCS),$(filter %.c %.S,$(SRCS)))
+C_OBJS      = $(addsuffix .$(way_)o,$(basename $(C_SRCS)))
 
 # SCRIPT_SRCS:  list of raw script files (in literate form)
 # SCRIPT_OBJS:  de-litted scripts
-SCRIPT_SRCS=$(filter %.lprl,$(SRCS))
-SCRIPT_OBJS=$(addsuffix .prl,$(basename $(SCRIPT_SRCS)))
+SCRIPT_SRCS = $(filter %.lprl,$(SRCS))
+SCRIPT_OBJS = $(addsuffix .prl,$(basename $(SCRIPT_SRCS)))
 
-OBJS=$(HS_OBJS) $(C_OBJS) $(SCRIPT_OBJS)
+OBJS        = $(HS_OBJS) $(C_OBJS) $(GC_C_OBJS) 
+
+# The default is for $(LIBOBJS) to be the same as $(OBJS)
+LIBOBJS            = $(OBJS)
 
 #
 # Note that as long as you use the standard variables for setting
@@ -192,15 +193,31 @@ OBJS=$(HS_OBJS) $(C_OBJS) $(SCRIPT_OBJS)
 #
 # The default set of files for the dependency generators to work on
 # is just their source equivalents.
-# 
+#
+
+ifneq "$(BootingFromHc)" "YES"
 MKDEPENDHS_SRCS=$(HS_SRCS)
+else
+MKDEPENDHS_SRCS=
+endif
+
 MKDEPENDC_SRCS=$(C_SRCS)
 
 #------------------------------------------------------------------
+#
+# make TAGS defaults
+#
+# The default set of files for the TAGS file generators to work on
+# is just their source equivalents.
+#
+TAGS_HS_SRCS=$(HS_SRCS)
+TAGS_C_SRCS=$(C_SRCS)
+
+#------------------------------------------------------------------
 # Clean file make-variables.
 #
 # The following three variables are used to control
-# what gets removed when doing `make clean' 
+# what gets removed when doing `make clean'
 #
 # MOSTLYCLEAN_FILES   object code etc., but not stuff
 #                     that is slow to recompile and/or stable
@@ -211,84 +228,50 @@ MKDEPENDC_SRCS=$(C_SRCS)
 #                        that may require extra tools to create.
 #
 #
-MOSTLY_CLEAN_FILES     += $(HS_OBJS) $(C_OBJS)
-CLEAN_FILES            += $(HS_PROG) $(C_PROG) $(SCRIPT_PROG) $(PROG) $(LIBRARY) \
-                         $(HS_IFACES) \
-                         a.out core
-MAINTAINER_CLEAN_FILES += .depend $(BOOT_SRCS)
+# NOTE: $(SCRIPT_OBJS) is not in MOSTLY_CLEAN_FILES, because in some
+# places in the tree it appears that we have source files in $(SCRIPT_OBJS).
+# Specifically glafp-utils/mkdependC/mkdependC.prl and others in driver/ and
+# possibly others elsewhere in the tree.  ToDo: fix this properly.
+MOSTLY_CLEAN_FILES += $(HS_OBJS) $(C_OBJS) $(HSC_C_OBJS) $(GC_C_OBJS)
+CLEAN_FILES        += $(HS_PROG) $(C_PROG) $(SCRIPT_PROG) $(SCRIPT_LINK) \
+                     $(PROG) $(LIBRARY) a.out \
+                     $(DERIVED_HSC_SRCS) \
+                     $(DERIVED_GC_SRCS) \
+                     $(patsubst %,%/*.$(way_)hi, . $(ALL_DIRS)) \
+                     $(HI_BOOTS) $(O_BOOTS)
+
+# we delete *all* the .hi files we can find, rather than just
+# $(HS_IFACES), because stale interfaces left around by modules which
+# don't exist any more can screw up the build.
+
+# Don't clean the .hc files if we're bootstrapping
+ifneq "$(BootingFromHc)" "YES"
+CLEAN_FILES += $(DERIVED_HC_SRCS)
+endif
+
+DIST_CLEAN_FILES       += .depend* *.hp *.prof
+
+MAINTAINER_CLEAN_FILES         += $(BOOT_SRCS) $(DERIVED_HAPPY_SRCS) $(DERIVED_ALEX_SRCS)
 
 #
 # `Standard' set of files to clean out.
 #
 MOSTLY_CLEAN_FILES += \
- *.CKP *.ln *.BAK *.bak *.o core a.out errs ,* *.a .emacs_*         \
+ *.CKP *.ln *.BAK *.bak .*.bak *.o core a.out errs ,* *.a .emacs_*  \
  tags TAGS *.ind *.ilg *.idx *.idx-prev *.aux *.aux-prev *.dvi *.log \
- *.toc *.lot *.lof *.blg *.info *.itxi *.itex *.ihtml *.cb
+ *.toc *.lot *.lof *.blg *.cb *_stub.c *_stub.h *.raw_s *.a.list
 
 #------------------------------------------------------------------
-# Documentation setup.
-#
-# Documentation is not normally produced via the default target, but
-# selectively through a set of standard targets (e.g, dvi, html, etc., see
-# target.mk). Here we define the variables (and their default settings),
-# that control the operation of these standard targets.
-#
-# Documentation variables:
-#
-#  DOC_SRCS  = list of documents you want to generate various
-#              forms of documentation from.
-#  DOC_DVI   = list of DVI files to generate.
-#  DOC_HTML  = list of HTML files to generate
-#  DOC_TEXI  = list of TexInfo files to generate
-#  DOC_TEXT  = list of simple text files to generate
-# 
-DOC_SRCS=$(wildcard    *.tex *.lit)
-DOC_DVI =$(addsuffix  .dvi,$(basename $(DOC_SRCS)))
-DOC_PS  =$(addsuffix   .ps,$(basename $(DOC_SRCS)))
-DOC_TEXI=$(addsuffix .texi,$(basename $(DOC_SRCS)))
-DOC_HTML=$(addsuffix .html,$(basename $(DOC_SRCS)))
-DOC_TEXT=$(addsuffix .txt,$(basename $(DOC_SRCS)))
-
-CLEAN_FILES += $(DOC_TEXT) $(DOC_HTML) $(DOC_TEXI) $(DOC_PS) $(DOC_DVI)
 
-#------------------------------------------------------------------
-#
-# Distribution setup
-# 
-# Following variables are used for creating source and binary distributions:
-#
-#  SRC_DIST_NAME && BIN_DIST_NAME  -- the package names
-#
-#  SRC_DIST_FILES = list of extra files to include from a build tree into a source
-#                   distribution
-#  
-#  SRC_DIST_DIR  = what the current directory in the source/build tree
-#                  maps to in the source distrib. tree being created.
-#
-SRC_DIST_NAME=$(ProjectNameShort)-$(ProjectVersion)
+# Directory in which DLLs are dumped so as not to get picked up by running
+# programs (e.g. ghc or hsc) that run in the build tree
 
+DLL_PEN = $(FPTOOLS_TOP)/dll
+
+#------------------------------------------------------------------
 #
-# Binary distributions proceeds as follows:
-#
-# Fromthe top of a build tree, you do `make binary-dist'. The
-# canned rule for this  (in target.mk) will then do a binary
-# install to a temporary directory before packaging it all up.
-# The following variables guide the binary-dist:
-#
-#  BIN_DIST_TMPDIR= the absolute path to where the temporary directory
-#                  structure of a binary distribution should be created.
-#                  [Default: toplevel from which you issue `make binary-dist']
-#  BIN_DIST_NAME=   what to call the thing.
-#
-#  BIN_DIST_DIRS=   at the toplevel, list of directories to descend into when
-#                  building the distribution tree.
-#  
-#  An extra directory variable that is set during bin-dists is $(bindist_top), giving
-#  the abs. path to the root of the binary installation tree. (useful when punting
-#  stuff like README and ANNOUNCE into a distrib, for instance)
-#
-#  The layout of a binary distribution is described in the
-#  installation documentation.
+# Stylesheet for HTML generated from DocBook XML
 #
 
-
+FPTOOLS_CSS     = fptools.css
+FPTOOLS_CSS_ABS = $(FPTOOLS_TOP)/mk/$(FPTOOLS_CSS)