path: root/libraries/Makefile

# To do a fresh build:
#
#   make clean
#   make boot
#   make
#
# To rebuild a particular library <package>:
#
#   make clean.library.<package>
#   make make.library.<package>
#
# or the following is equivalent:
#
#   make remake.library.<package>
#
# To add a new library to the tree, do
#
#   darcs get http://darcs.haskell.org/packages/foo
#   [ -e foo/configure.ac ] && ( cd foo && autoreconf )
#   make make.library.foo

.PHONY: default_target show

default_target: all

show:
	@echo '$(VALUE)="$($(VALUE))"'

# make doesn't give us an easy way to get the libraries built in
# dependency order the first time, but not rebuild base (for example)
# when we want to rebuild another library later.
# So for now we just don't do anything in parallel in here.
.NOTPARALLEL:

# Ideally we'd just include something to give us variables
# for paths and arguments to tools etc, and those set in mk/build.mk.
TOP=..
include $(TOP)/mk/boilerplate.mk
include $(TOP)/mk/cabal-flags.mk

# Any libraries listed here should also be in ../packages

SUBDIRS  = ghc-prim $(INTEGER_LIBRARY) base array packedstring
SUBDIRS += containers bytestring old-locale old-time filepath directory
ifeq "$(GhcLibsWithUnix)" "YES"
SUBDIRS += unix
endif
ifeq "$(Windows)" "YES"
SUBDIRS += $(wildcard Win32)
endif
SUBDIRS += process pretty hpc template-haskell editline Cabal random haskell98

# Set GhcBootLibs=YES from the command line to work with just the libraries
# needed to bootstrap GHC.
ifneq "$(GhcBootLibs)" "YES"
SUBDIRS += $(wildcard regex-base)
SUBDIRS += $(wildcard regex-posix)
SUBDIRS += $(wildcard regex-compat)
SUBDIRS += $(wildcard parsec)
SUBDIRS += $(wildcard haskell-src)
SUBDIRS += $(wildcard html)
SUBDIRS += $(wildcard network)
SUBDIRS += $(wildcard QuickCheck)
SUBDIRS += $(wildcard HUnit)
SUBDIRS += $(wildcard mtl)
SUBDIRS += $(wildcard time)
SUBDIRS += $(wildcard stm)
SUBDIRS += $(wildcard xhtml)
SUBDIRS += $(wildcard parallel)
SUBDIRS_BUILD += $(wildcard dph/dph-base)
SUBDIRS_BUILD += $(wildcard dph/dph-prim-interface)
SUBDIRS_BUILD += $(wildcard dph/dph-prim-seq)
SUBDIRS_BUILD += $(wildcard dph/dph-prim-par)
SUBDIRS_BUILD += $(wildcard dph/dph)
endif

SUBDIRS += $(SUBDIRS_BUILD)

# -----------------------------------------------------------------------------

empty=
space=$(empty) $(empty)

# -----------------------------------------------------------------------------

ifeq "$(ghc_ge_609)" "YES"
GhcLibHcOpts += -fno-warn-deprecated-flags
endif

ifeq "$(RelocatableBuild)" "YES"
# On Windows we want to make moveable bindists, but we need to tell
# ghc-pkg where the haddock docs are. Therefore we completely ignore
# where the user tells us to put the haddock documentation and put it
# somewhere whose relative location we know. When installing we need
# to give Cabal a real path, though.
iprefix             = $$topdir
ibindir             = $$topdir
ilibdir             = $$topdir
ilibexecdir         = $$topdir
idynlibdir          = $$topdir
idatadir            = $$topdir
idocdir             = $$topdir/doc/libraries/$$pkg
ihaddockdir         = $$topdir/doc/libraries/$$pkg
ihtmldir            = $$httptopdir/doc/libraries/$$pkg
html_installed_root = $(prefix)/doc/libraries
else
# On non-Windows we can just give absolute paths all the time, and
# thus obey the htmldir that we are given.
iprefix             = $(prefix)
ibindir             = $(bindir)
ilibdir             = $(libdir)
ilibexecdir         = $(libexecdir)
idynlibdir          = $(dynlibdir)
idatadir            = $(datadir)
idocdir             = $(docdir)/libraries/$$pkg
ihaddockdir         = $(htmldir)/libraries/$$pkg
ihtmldir            = $(htmldir)/libraries/$$pkg
html_installed_root = $(htmldir)/libraries
endif

ifneq "$(DOING_BIN_DIST)" "YES"

CONFIGURE_OPTS =
CONFIGURE_STAMP_EXTRAS :=

ifneq "$(findstring $(space)p$(space), $(space)$(GhcLibWays)$(space))" ""
CONFIGURE_OPTS += --enable-library-profiling
CONFIGURE_STAMP_EXTRAS := $(CONFIGURE_STAMP_EXTRAS)-profiling
endif

ifeq "$(BuildSharedLibs)" "YES"
CONFIGURE_OPTS += --enable-shared
CONFIGURE_STAMP_EXTRAS := $(CONFIGURE_STAMP_EXTRAS)-shared
endif

ifeq "$(SplitObjs)" "YES"
CONFIGURE_OPTS += --enable-split-objs
CONFIGURE_STAMP_EXTRAS := $(CONFIGURE_STAMP_EXTRAS)-splitting
endif

.PHONY: subdirs

subdirs:
	@echo $(SUBDIRS)

HERE_ABS=$(FPTOOLS_TOP_ABS)/libraries

IFBUILDABLE=ifBuildable/ifBuildable $(FPTOOLS_TOP_ABS)/packages

CABAL_GHC_FLAGS = -Wall
ifeq "$(ghc_ge_605)" "NO"
CABAL_GHC_FLAGS += -cpp
endif

# Euch, hideous hack:
CABAL_VERSION = $(shell grep "^Version:" Cabal/Cabal.cabal | sed -e "s/^Version: //" -e 's/\./,/g')

BOOTSTRAPPING_FLAGS = $(CABAL_GHC_FLAGS) -DCABAL_VERSION=$(CABAL_VERSION) -odir $(HERE_ABS)/bootstrapping -hidir $(HERE_ABS)/bootstrapping -i$(HERE_ABS)/Cabal -i$(HERE_ABS)/filepath -i$(HERE_ABS)/hpc

.PHONY: boot

boot: ifBuildable/ifBuildable cabal-bin bootstrapping.conf

cabal-bin: cabal-bin.hs
	mkdir $(HERE_ABS)/bootstrapping
	$(GHC) $(BOOTSTRAPPING_FLAGS) --make cabal-bin -o cabal-bin

bootstrapping.conf: cabal-bin
	echo "[]" > $@.tmp
	-cd filepath && $(CABAL) clean     --distpref=dist-bootstrapping
	cd filepath && $(CABAL) configure --distpref=dist-bootstrapping --with-compiler=$(GHC) --with-hc-pkg=$(GHC_PKG) --package-db=$(HERE_ABS)/$@.tmp
	cd filepath && $(CABAL) build     --distpref=dist-bootstrapping
	cd filepath && $(CABAL) install   --distpref=dist-bootstrapping --inplace
	-cd Cabal    && $(CABAL) clean     --distpref=dist-bootstrapping
	cd Cabal    && $(CABAL) configure --distpref=dist-bootstrapping --with-compiler=$(GHC) --with-hc-pkg=$(GHC_PKG) --package-db=$(HERE_ABS)/$@.tmp
	cd Cabal    && $(CABAL) build     --distpref=dist-bootstrapping
	cd Cabal    && $(CABAL) install   --distpref=dist-bootstrapping --inplace
	-cd hpc    && $(CABAL) clean     --distpref=dist-bootstrapping
	cd hpc    && $(CABAL) configure --distpref=dist-bootstrapping --with-compiler=$(GHC) --with-hc-pkg=$(GHC_PKG) --package-db=$(HERE_ABS)/$@.tmp
	cd hpc    && $(CABAL) build     --distpref=dist-bootstrapping
	cd hpc    && $(CABAL) install   --distpref=dist-bootstrapping --inplace
	mv $@.tmp $@

ifBuildable/ifBuildable: ifBuildable.hs
	-$(RM) -rf ifBuildable
	mkdir ifBuildable
	$(CP) ifBuildable.hs ifBuildable/
ifeq "$(stage)" "2"
	cd ifBuildable && ../$(HC) -Wall --make ifBuildable -o ifBuildable
else
	cd ifBuildable && $(GHC) -Wall --make ifBuildable -o ifBuildable
endif

.PHONY: all build configure

all: build

ifeq "$(HADDOCK_DOCS)" "YES"
all: doc
endif

.PHONY: rebuild.library.%
.PHONY: remake.library.%

$(foreach SUBDIR,$(SUBDIRS),rebuild.library.$(SUBDIR)):\
rebuild.library.%: clean.library.% build.library.%

$(foreach SUBDIR,$(SUBDIRS),remake.library.$(SUBDIR)):\
remake.library.%: clean.library.% make.library.%

# NB. we're depending on make chasing dependencies from left to right here.
# This bit goes wrong with 'make -j'.
build: $(foreach SUBDIR,$(SUBDIRS),make.library.$(SUBDIR))

configure: $(foreach SUBDIR,$(SUBDIRS), \
             stamp/configure.library.build$(CONFIGURE_STAMP_EXTRAS).$(SUBDIR))

.PHONY: build.library.%
.PHONY: make.library.%

# We should depend on %/%.cabal here (and in other rules), but make
# makes that difficult.

ALL_CONFIGURE_FLAGS = \
               $(INSTALL_DIRS_CONFIGURE_FLAGS) \
               $(USE_STAGE1_CONFIGURE_FLAGS) \
               $(COMMON_CONFIGURE_FLAGS) \
	           --haddock-options="--use-contents=../index.html \
	                              --use-index=../doc-index.html" \
	           $(CONFIGURE_OPTS)

$(foreach SUBDIR,$(SUBDIRS), \
		  stamp/configure.library.build$(CONFIGURE_STAMP_EXTRAS).$(SUBDIR)): \
stamp/configure.library.build$(CONFIGURE_STAMP_EXTRAS).%: cabal-bin \
                                                          bootstrapping.conf
	-$(RM) -f stamp/configure.library.*.$* $*/unbuildable
	$(MKDIRHIER) `dirname $@`
	( cd $* && $(CABAL) configure $(ALL_CONFIGURE_FLAGS) ) \
	      && touch $@ || touch $*/unbuildable
# We don't touch $@ if configure failed as we would prefer to try
# configuring it next time round, rather than assuming it'll still fail.
# This is particularly important for bootlibs, where failure means the
# build dies!

# Build the library using 'make'
# We re-run 'setup makefile' each time, just in case any preprocessing
# needs to be done.  However, we're careful not to overwrite GNUmakefile
# if it hasn't changed, so that dependency-generation isn't forced
# every time.
# Packages in $(SUBDIRS_BUILD) need to use the build.* rules instead of
# make.*, so filter them out and use an alternate rule below instead.
$(foreach SUBDIR,$(filter-out $(SUBDIRS_BUILD),$(SUBDIRS)),make.library.$(SUBDIR)):\
make.library.%: stamp/configure.library.build$(CONFIGURE_STAMP_EXTRAS).% \
                cabal-bin ifBuildable/ifBuildable bootstrapping.conf
	if $(IFBUILDABLE) $*; then \
	  cd $* && \
	  cmp -s $(MAKEFILE_LOCAL) Makefile.local || cp $(MAKEFILE_LOCAL) .; \
	  mv GNUmakefile GNUmakefile.tmp; \
	  $(CABAL) makefile -f GNUmakefile; \
	  cmp -s GNUmakefile GNUmakefile.tmp && mv GNUmakefile.tmp GNUmakefile; \
	  $(MAKE) $(MFLAGS) && \
	  $(CABAL) register --inplace; \
	fi

MAKEFILE_LOCAL = $(FPTOOLS_TOP_ABS)/libraries/Makefile.local

# Alternate rule, as described above
$(foreach SUBDIR,$(SUBDIRS_BUILD),make.library.$(SUBDIR)):\
make.library.%: build.library.%

# Build the library using 'setup build' (not the default)
$(foreach SUBDIR,$(SUBDIRS),build.library.$(SUBDIR)):\
build.library.%: stamp/configure.library.build$(CONFIGURE_STAMP_EXTRAS).% \
                 cabal-bin ifBuildable/ifBuildable bootstrapping.conf
	if $(IFBUILDABLE) $*; then \
	  cd $* && \
	  $(CABAL) build $(BUILD_FLAGS); \
	  $(CABAL) register --inplace; \
	fi

.PHONY: doc html

html: doc

doc: $(foreach SUBDIR,$(SUBDIRS),doc.library.$(SUBDIR))
	sh gen_contents_index --inplace

# Making hyperlinked source only works if we have hscolour
ifneq "$(HSCOLOUR)" ""
CABAL_HADDOCK_FLAGS=--hyperlink-source
endif

$(foreach SUBDIR,$(SUBDIRS),doc.library.$(SUBDIR)):\
doc.library.%: stamp/configure.library.build$(CONFIGURE_STAMP_EXTRAS).% \
               cabal-bin ifBuildable/ifBuildable bootstrapping.conf
	if $(IFBUILDABLE) $*; then \
	  cd $* && $(CABAL) haddock --html-location='../$$pkg' \
	                            $(CABAL_HADDOCK_FLAGS); \
	fi
ifneq "$(HSCOLOUR)" ""
# We use */src rather than $*/src due to the $(INTEGER_LIBRARY)/integer
# mismatch
	if $(IFBUILDABLE) $*; then cp hscolour.css $*/dist/doc/html/*/src/; fi
endif

.PHONY: distclean clean clean.library.%

distclean: clean

clean: $(foreach SUBDIR,$(SUBDIRS),clean.library.$(SUBDIR))
	-cd filepath && $(CABAL) clean --distpref=dist-bootstrapping
	-cd Cabal    && $(CABAL) clean --distpref=dist-bootstrapping
	-cd hpc      && $(CABAL) clean --distpref=dist-bootstrapping
	$(RM) -rfd bootstrapping
	$(RM) -f bootstrapping.conf     bootstrapping.conf.old
	$(RM) -f bootstrapping.conf.tmp bootstrapping.conf.tmp.old
	$(RM) -f cabal-bin cabal-bin.exe
	$(RM) -rf ifBuildable
	$(RM) -f libraries.txt index.html doc-index.html doc-index*.html
	$(RM) -f haddock* *.gif

distclean:
	$(RM) $(foreach lib, $(SUBDIRS), $(lib)/.depend $(lib)/.depend.bak)

$(foreach SUBDIR,$(SUBDIRS),clean.library.$(SUBDIR)): \
clean.library.%:
	$(RM) -f stamp/configure.library.*.$* $*/unbuildable
	-cd $* && $(CABAL) clean
	$(RM) -f $*/Setup $*/Setup.exe $*/Setup.hi $*/Setup.o
	$(RM) $*/GNUmakefile $*/Makefile.local
endif

# -----------------------------------------------------------------------------

.PHONY: install install-docs install.library.%

install: $(foreach SUBDIR,$(SUBDIRS),install.library.$(SUBDIR))
ifeq "$(HADDOCK_DOCS)" "YES"
	$(INSTALL_DIR)                                                     $(DESTDIR)$(html_installed_root)
	$(INSTALL_DATA)   index.html doc-index*.html                       $(DESTDIR)$(html_installed_root)
	$(INSTALL_SCRIPT) gen_contents_index                               $(DESTDIR)$(html_installed_root)
	# Hacks:
	$(INSTALL_DATA)   base/dist/doc/html/*/*.css $(DESTDIR)$(html_installed_root)
	$(INSTALL_DATA)   base/dist/doc/html/*/*.js $(DESTDIR)$(html_installed_root)
	$(INSTALL_DATA)   base/dist/doc/html/*/*.gif $(DESTDIR)$(html_installed_root)
endif

# Cabal doesn't let us ask to install docs only, so do nothing here
install-docs:
	@:

# Ideally this would depend on a stamp/build.library.%, but if it does
# then we can't change the libraries and then just rerun make.
# Thus if you install without building then it will just break.

# prefix and (on Windows) htmldir use $topdir when configuring, so we
# need to tell installPackage the real path to use when installing.

# We also need to pass all the other directories in, as they can be
# overridden when installing a bindist.

$(foreach SUBDIR,$(SUBDIRS),install.library.$(SUBDIR)): \
install.library.%: ifBuildable/ifBuildable
	if $(IFBUILDABLE) $*; then \
	  cd $* && \
	  $(INSTALL_PACKAGE) install '$(GHC_PKG_PROG)' '$(DESTDIR)$(libdir)/package.conf' '$(DESTDIR)' '$(prefix)' '$(iprefix)' '$(ibindir)' '$(ilibdir)' '$(ilibexecdir)' '$(idynlibdir)' '$(idatadir)' '$(idocdir)' '$(ihtmldir)' '$(ihaddockdir)' ; \
	fi

.PHONY: binary-dist binary-dist.library.%

BIN_DIST_LIBDIR=$(BIN_DIST_DIR)/libraries

BINDIST_EXTRAS += ifBuildable/ifBuildable
ifeq "$(HADDOCK_DOCS)" "YES"
BINDIST_EXTRAS += gen_contents_index
BINDIST_EXTRAS += index.html
BINDIST_EXTRAS += doc-index*.html
endif
binary-dist: $(foreach SUBDIR,$(SUBDIRS),binary-dist.library.$(SUBDIR))
# This is a bit of a hack, but it works...
	echo $(WHERE_AM_I)/Makefile >> $(BIN_DIST_LIST)

$(foreach SUBDIR,$(SUBDIRS),binary-dist.library.$(SUBDIR)): \
binary-dist.library.%:
	if $(IFBUILDABLE) $*; then \
	  $(MAKE) -C $* -f Makefile.local binary-dist BINDIST_EXTRAS="$*.cabal LICENSE $*.buildinfo unbuildable" WHERE_AM_I=$(WHERE_AM_I)/$*; \
	fi

# Ignore some doc targets that we don't support
# The root recurses into us when these targets are made
.PHONY: html-no-chunks chm HxS fo dvi ps pdf
html-no-chunks chm HxS fo dvi ps pdf:
	@: