[project @ 2002-02-12 15:17:13 by simonmar]
[ghc-hetmet.git] / mk / config.mk.in
index 3de4aab..a4f8f70 100644 (file)
@@ -3,33 +3,26 @@
 #
 ################################################################################
 #
-#                      config.mk.in-template
+# config.mk.in
 #
-#      This file defines all the variables that set the configuration of
-#      a particular build.
+# This file supplies defaults for many tweakable build configuration
+# options.  Some of the defaults are filled in by the autoconf-generated
+# configure script.
 #
+# DO NOT EDIT THIS FILE!
 #
-################################################################################
-
-# The configuration is defined in two steps:
-#
-#      1. The builder (i.e. the person doing the build)
-#         copies this file, config.mk.in-template
-#         to config.mk.in
-#
-#      2. S/he then edits it manually (gasp) to reflect any configuration
-#         options s/he wants.
+#      - config.mk is auto-generated from config.mk.in by configure.
+#        This may be triggered automatically by the build system (say
+#        if config.mk.in has changed more recently than config.mk),
+#        so if you edit config.mk your changes will be spammed.
 #
-#      3. Then s/he runs "configure", which generates config.mk from
-#         config.mk.in, substituting for system/platform-dependent things
-#         enclosed in @at-signs@.
+#      - Settings in this file may be overriden by giving replacement
+#        definitions in build.mk.  If you don't have a build.mk file
+#        then you get defaults for everything.  The defaults should
+#        provide a reasonable vanilla build.
 #
 # This is one of only two files that configure generates (the other is config.h)
 #
-# Note that after subsequent edits of config.mk.in for a build, the configure script
-# will have to be re-run manually to have the change reflected in config.mk. 
-#
-
 # There is a section below for each project within the fptools suite
 #
 #      PLUS
@@ -100,11 +93,15 @@ exeext=@exeext@
 # BootingFromHc - build GHC and the libraries from .hc files?
 BootingFromHc = @BootingFromHc@
 
+# BootingFromUnregisterisedHc - treat .hc files as containing unregisterised
+# rather than registerised code, i.e., disable the mangler?
+BootingFromUnregisterisedHc = @BootingFromUnregisterisedHc@
+
 # build the libs first if we're bootstrapping from .hc files
 ifeq "$(BootingFromHc)" "YES"
-AllProjects = glafp-utils hslibs ghc green-card happy hdirect hood nofib
+AllProjects = glafp-utils libraries hslibs ghc green-card happy hdirect hood nofib
 else
-AllProjects = glafp-utils ghc hslibs green-card happy hdirect hood nofib
+AllProjects = glafp-utils ghc libraries hslibs green-card happy hdirect hood nofib
 endif
 
 #
@@ -124,6 +121,12 @@ ProjectsDontInstall = glafp-utils nofib
 #
 IncludeTestDirsInBuild=NO
 
+#
+# Which ways should SGML documents be built?
+# options are: dvi ps pdf html rtf
+#
+SGMLDocWays=
+
 ################################################################################
 #
 #              GHC project
@@ -148,16 +151,26 @@ GhcCompilerWays=
 
 # Extra option flags to pass to the compiler that compiles the compiler
 # (Ones that are essential are wired into ghc/compiler/Makefile)
-# Typical ones:
-#      -H25m           allocate a bigger heap (might speed up compilation)
-#
-#      -O              compile an optimised compiler
+# Typical options to use here:
 #
-#      -DDEBUG         include consistency/assertion checks in the compiled compiler
+#      -DDEBUG         include debugging code and assertions (will make the
+#                      compiler slower and produce debugging output, but useful
+#                      for development)
 #
 #      -dcore-lint     check the types after every pass of the compiler;
-#                      a pretty strong internal check
-GhcHcOpts=-O -Rghc-timing
+#                      a pretty strong internal check of the compiler being
+#                      used to compile GHC.  Useful when bootstrapping.
+GhcHcOpts=-Rghc-timing
+
+# Extra Haskell compiler options to use when compiling all Haskell
+# *programs* (not libraries), including GHC itself.
+# Typical options to use here:
+#
+#      -H25m           use a bigger heap (to speed up compilation)
+#
+#      -O              compile an optimised compiler
+#
+FptoolsHcOpts=-O
 
 # Build a compiler that will build *unregisterised* libraries and
 # binaries by default.  Unregisterised code is supposed to compile and
@@ -181,18 +194,21 @@ GhcUnregisterised=NO
 # (as well as a C backend)
 #
 # Target platforms supported:
-#   i386, alpha & sparc
-ifneq "$(findstring $(HostArch_CPP), i386 alpha sparc)" ""
+#   i386 & sparc
+ifneq "$(findstring $(HostArch_CPP), i386 sparc)" ""
 GhcWithNativeCodeGen=YES
 else
 GhcWithNativeCodeGen=NO
 endif
 
+# Include support for generating Java
+GhcWithJavaGen=NO
+
 HaveLibDL = @HaveLibDL@
 
 # Include GHCi in the compiler.  Default to NO for the time being.
 
-ifneq "$(findstring $(HostOS_CPP), linux solaris freebsd netbsd openbsd)" ""
+ifneq "$(findstring $(HostOS_CPP), mingw32 linux solaris2 freebsd netbsd openbsd)" ""
 GhcWithInterpreter=YES
 ifeq "$(HaveLibDL)" "YES"
 SRC_HC_OPTS += -ldl
@@ -220,10 +236,10 @@ else
 GhcLibWays=p
 endif
 
-# Option flags to pass to GHC when it's compiling prelude modules
-# *and* standard library modules (std) *and* modules in hslibs
-# Typically these are things like -O or -dcore-lint
-# The ones that are *essential* are wired into ghc/lib/Makefile
+# Option flags to pass to GHC when it's compiling modules in
+# fptools/libraries.  Typically these are things like -O or
+# -dcore-lint or -H32m.  The ones that are *essential* are wired into
+# the build system.
 #
 #      -O is pretty desirable, otherwise no inlining of prelude
 #              things (incl "+") happens when compiling with this compiler
@@ -233,6 +249,17 @@ GhcLibHcOpts=-O -Rghc-timing
 # Win32 only: Enable the RTS and libraries to be built as DLLs
 DLLized=@EnableWin32DLLs@
 
+# Win32 only: are we building a compiler that tries to reduce external
+# dependencies? i.e., one that doesn't assume that the user has got
+# the cygwin toolchain installed on his/her Win32 box.
+#
+# GHC is still dependent on GNU tools in the backend (gcc to further process
+# .c/.hc/.s/.o files + 'perl' to mangle and split), but using this
+# option a GHC distribution can be put together which includes a minimal
+# set of these open source tools. 
+#
+MinimalUnixDeps=@MinimalUnixDeps@
+
 # Don't split object files for libs if we're building DLLs, or booting from
 # .hc files.
 SplitObjs=YES
@@ -243,6 +270,9 @@ endif
 ifeq "$(BootingFromHc)" "YES"
 SplitObjs=NO
 endif
+ifeq "$(GhcUnregisterised)" "YES"
+SplitObjs=NO
+endif
 
 # Strip local symbols from libraries?  This can make the libraries smaller,
 # but makes debugging somewhat more difficult.  Doesn't work with all ld's.
@@ -258,35 +288,32 @@ StripLibraries=NO
 
 # For a debugging RTS:
 # GhcRtsHcOpts = -optc-DDEBUG
-# GhcRtsCcOpts = -optc-g
+# GhcRtsCcOpts = -g
 
 # For an optimised RTS:
 GhcRtsHcOpts=-O2
-GhcRtsCcOpts=-O2 -fomit-frame-pointer
+GhcRtsCcOpts=-fomit-frame-pointer
 
 # Include the front panel code?  Needs GTK+.
 GhcRtsWithFrontPanel = NO
 
+#
+# To have the RTS support interoperation with OS threads, set
+# GhcRtsThreaded to YES (preferably via the --enable-threaded-rts
+# configure script option). The consequence of this is spelled out
+# in details elsewhere, but, briefly, Concurrent Haskell threads
+# can now make external (i.e., C) calls without blocking the progress
+# of other CH threads. Multiple native threads can also execute
+# Haskell code without getting in each others way too.
+# 
+GhcRtsThreaded=@ThreadedRts@
+
 ################################################################################
 #
-#              hslibs project
+# libraries project
 #
 ################################################################################
 
-# Build HsLibs for which compiler?  
-
-# If $(HsLibsFor) == hugs or ghc, we assume we're building for the
-# compiler/interpreter in the same source tree.
-
-# HsLibsFor = ghc | hugs | nhc | hbc
-HsLibsFor      = ghc
-
-# hslibs for GHC also uses the following variables (defined above):
-#   GhcLibWays, GhcLibHcOpts, GhcLibToolsHcOpts, DLLized, StripLibraries
-
-# Haskell compiler options for tools in hslibs
-GhcLibToolsHcOpts=-O
-
 # Build the Haskell Readline bindings?
 #
 GhcLibsWithReadline=@HaveReadlineHeaders@
@@ -306,6 +333,9 @@ LIBM=@LIBM@
 #
 GhcLibsWithHOpenGL=@GhcLibsWithHOpenGL@
 
+X_CFLAGS=@X_CFLAGS@
+X_LIBS=@X_LIBS@
+
 ################################################################################
 #
 #              happy project
@@ -399,15 +429,10 @@ ifeq "$(TARGETPLATFORM)" "i386-unknown-mingw32"
 DEFAULT_TMPDIR         = C:/TEMP
 endif
 
-# FPTOOLS_TOP: the top of the fptools hierarchy, absolute path.
-
-ifeq "$(findstring $(TARGETPLATFORM), i386-unknown-cygwin32 i386-unknown-mingw32)" ""
+# FPTOOLS_TOP: the top of the fptools hierarchy, absolute path. (POSIX / unix-style path).
 FPTOOLS_TOP_ABS                = @hardtop@
-else
-FPTOOLS_TOP_ABS                = $(subst \,/,$(shell cygpath -w @hardtop@))
-endif
-# Keep the Unix-style path to use with Unix tools (e.g. in ghc-inplace script)
-FPTOOLS_TOP_ABS_UNIX    = @hardtop@
+# The platform specific version of 'hardtop'.
+FPTOOLS_TOP_ABS_PLATFORM = @hardtop_plat@
 
 #
 # Installation directories, we don't use half of these,
@@ -417,19 +442,35 @@ FPTOOLS_TOP_ABS_UNIX    = @hardtop@
 prefix                 = @prefix@
 exec_prefix            = @exec_prefix@
 bindir                 = @bindir@
-datadir                        = @datadir@
+datadir0               = @datadir@
+
 #sysconfdir            = @datadir@
 #sharedstatedir                = @sharedstatedir@
 #localstatedir         = @localstatedir@
-libdir                 = @libdir@
+ifneq "$(TARGETPLATFORM)" "i386-unknown-mingw32"
+libdir0                        = @libdir@
+else
+libdir0                 = @prefix@
+endif
 includedir             = @includedir@
 oldincludedir          = @oldincludedir@
 mandir                 = @mandir@
 
-#UNUSED, see below: libexecdir              = @libexecdir@
 #UNUSED:infodir                = @infodir@
 #UNUSED:srcdir          = @srcdir@
 
+#
+# override libdir and datadir to put project-specific stuff in
+# a subdirectory with the version number included.
+#
+ifneq "$(TARGETPLATFORM)" "i386-unknown-mingw32"
+libdir     = $(if $(ProjectNameShort),$(libdir0)/$(ProjectNameShort)-$(ProjectVersion),$(libdir0))
+datadir    = $(if $(ProjectNameShort),$(datadir0)/$(ProjectNameShort)-$(ProjectVersion),$(datadir0))
+else
+libdir    = $(libdir0)
+datadir    = $(datadir0)
+endif
+
 # 
 # Default values for most of the above are only set if
 # they weren't configured to anything in particular
@@ -566,6 +607,8 @@ GhcVersion  = @GhcVersion@
 GhcMajVersion  = @GhcMajVersion@
 GhcMinVersion  = @GhcMinVersion@
 GhcPatchLevel  = @GhcPatchLevel@
+# Canonicalised ghc version number, used for easy (integer) version comparisons.
+GhcCanonVersion = $(GhcMajVersion)$(GhcMinVersion)
 
 HBC            = @HBC@
 NHC            = @NHC@
@@ -582,7 +625,10 @@ GHC_INPLACE        = $(FPTOOLS_TOP)/ghc/compiler/ghc-inplace
 #-----------------------------------------------------------------------------
 # C compiler
 #
-#
+# NB. Don't override $(WhatGccIsCalled) using build.mk,  re-configure using
+# the flag --with-gcc=<blah> instead.  The reason is that the configure script
+# needs to know which gcc you're using in order to perform its tests.
+
 HaveGcc        = @HaveGcc@
 UseGcc         = YES
 WhatGccIsCalled = @WhatGccIsCalled@
@@ -595,10 +641,7 @@ endif
 endif
 
 # default C compiler flags
-SRC_CC_OPTS = -O
-ifeq "$(TARGETPLATFORM)" "i386-unknown-mingw32"
-SRC_CC_OPTS += -mno-cygwin -mwin32
-endif
+SRC_CC_OPTS = @SRC_CC_OPTS@
 
 #-----------------------------------------------------------------------------
 # GMP Library (version 2.0.x or above)
@@ -630,6 +673,7 @@ FLEX_LIB            =
 # Other standard (ha!) Unix utilities
 
 AR                     = @ArCmd@
+ArSupportsInput                = @ArSupportsInput@
 # Yuckage: for ghc/utils/parallel -- todo: nuke this dependency!!
 BASH                    = /usr/local/bin/bash
 #
@@ -640,9 +684,13 @@ COMPRESS_SUFFIX         = @CompressSuffix@
 
 CONTEXT_DIFF           = @ContextDiffCmd@
 CP                     = cp
-CPP                    = @CPP@
+CPP                    = @CPP@ @CPPFLAGS@
 CTAGS                  = $(ETAGS)
-RAWCPP                  = $(CPP) -undef -traditional
+#
+# RAWCPP_FLAGS are the flags to give to cpp (viz, gcc -E) to persuade it to
+# behave plausibly on Haskell sources.
+#
+RAWCPP_FLAGS            = -undef -traditional
 FIND                   = @FindCmd@
 INSTALL                        = @INSTALL@
 #
@@ -667,6 +715,13 @@ RANLIB                     = @RANLIB@
 RM                     = rm -f
 SED                    = @SedCmd@
 SHELL                  = /bin/sh
+
+# Some ld's support the -x flag and some don't, so the configure
+# script detects which we have and sets LdXFlag to "-x" or ""
+# respectively.
+LD                     = @LdCmd@
+LD_X                   = @LdXFlag@
+
 #
 # In emergency situations, REAL_SHELL is used to perform shell commands
 # from within the ghc driver script, by scribbling the command line to
@@ -732,6 +787,7 @@ SRC_SGML2DVI_OPTS       = -d $(SGMLSTYLESHEET)
 SRC_SGML2HTML_OPTS      = -d $(SGMLSTYLESHEET)
 SRC_SGML2PS_OPTS       = -d $(SGMLSTYLESHEET)
 SRC_SGML2RTF_OPTS       = -d $(SGMLSTYLESHEET)
+SRC_SGML2PDF_OPTS       = -d $(SGMLSTYLESHEET)
 
 DOCBOOK_CATALOG                = @Catalog@
 
@@ -754,6 +810,12 @@ GREENCARD          = $(FPTOOLS_TOP)/green-card/src/green-card
 BLD_DLL                        = dllwrap
 
 #
+# .NET support software
+#
+ILX2IL                  = ilx2il
+ILASM                   = ilasm
+
+#
 # Happy
 #
 HAPPY                  = @HappyCmd@
@@ -761,7 +823,7 @@ HAPPY_VERSION               = @HappyVersion@
 #
 # Options to pass to Happy when we're going to compile the output with GHC
 #
-GHC_HAPPY_OPTS         = $(shell if ( test `echo $(HAPPY_VERSION) | sed -e "s/\(.*\)\..*/\1/g"` "-gt" "1" || test `echo $(HAPPY_VERSION) | sed -e "s/.*\.\(.*\)/\1/g"` "-ge" "9" ); then echo -agc; else echo -g; fi)
+GHC_HAPPY_OPTS         = @HappyOpts@
 
 #
 # Stuff from fptools/literate
@@ -818,7 +880,7 @@ HSC2HS                      = $(HSC2HS_PREFIX)hsc2hs-inplace
 # The ways currently defined.
 #
 ALL_WAYS=p t u s mp mg a b c d e f g h i j k l m n o A B
-USER_WAYS=a b c d e f g h i j k l m n o A B
+USER_WAYS=a b c d e f g h j k l m n o A B
 
 #
 # The following ways currently have treated specially, p u t mg,
@@ -828,6 +890,10 @@ USER_WAYS=a b c d e f g h i j k l m n o A B
 # 
 # If you want to add to these default options, fill in the variables below:
 
+# Way 'i':
+WAY_i_NAME=ILX
+WAY_i_HC_OPTS= -filx -fruntime-types
+
 # Way 'p':
 WAY_p_NAME=profiling
 WAY_p_HC_OPTS= -prof
@@ -885,9 +951,6 @@ WAY_g_HC_OPTS=
 WAY_h_NAME=
 WAY_h_HC_OPTS=
 
-WAY_i_NAME=
-WAY_i_HC_OPTS=
-
 WAY_j_NAME=
 WAY_j_HC_OPTS=
 
@@ -905,3 +968,23 @@ WAY_n_HC_OPTS=
 
 WAY_o_NAME=
 WAY_o_HC_OPTS=
+
+################################################################################
+#
+#              31-bit-Int Core files
+#
+################################################################################
+
+# 
+# It is possible to configure the compiler and prelude to support 31-bit
+# integers, suitable for a back-end and RTS using a tag bit on a 32-bit
+# architecture.  Currently the only useful output from this option is external Core
+# files.  The following additions to your build.mk will produce the
+# 31-bit core output.  Note that this is *not* just a library "way"; the
+# compiler must be built a special way too.
+
+# GhcCppOpts +=-DWORD_SIZE_IN_BITS=31
+# GhcLibHcOpts +=-fext-core -fno-code -DWORD_SIZE_IN_BITS=31
+# GhcLibCppOpts += -DWORD_SIZE_IN_BITS=31
+# SplitObjs=NO
+