Rename rebuild to remake, and define rebuild to "clean; build"
[ghc-hetmet.git] / libraries / Makefile
1
2 # To do a fresh build:
3 #
4 #   make clean
5 #   make boot
6 #   make
7 #
8 # To rebuild a particular library <package>:
9 #
10 #   make clean.library.<package>
11 #   make make.library.<package>
12 #
13 # or the following is equivalent:
14 #
15 #   make remake.library.<package>
16 #
17 # To add a new library to the tree, do
18 #
19 #   darcs get http://darcs.haskell.org/packages/foo
20 #   [ -e foo/configure.ac ] && ( cd foo && autoreconf )
21 #   make make.library.foo
22
23 .PHONY: default_target show
24
25 default_target: all
26
27 show:
28         @echo '$(VALUE)="$($(VALUE))"'
29
30 # make doesn't give us an easy way to get the libraries built in
31 # dependency order the first time, but not rebuild base (for example)
32 # when we want to rebuild another library later.
33 # So for now we just don't do anything in parallel in here.
34 .NOTPARALLEL:
35
36 # Ideally we'd just include something to give us variables
37 # for paths and arguments to tools etc, and those set in mk/build.mk.
38 TOP=..
39 include $(TOP)/mk/boilerplate.mk
40
41 SUBDIRS  = base array packedstring containers bytestring
42 SUBDIRS += old-locale old-time filepath directory
43 ifeq "$(GhcLibsWithUnix)" "YES"
44 SUBDIRS += unix
45 endif
46 ifeq "$(Windows)" "YES"
47 SUBDIRS += $(wildcard Win32)
48 endif
49 SUBDIRS += process pretty hpc template-haskell editline Cabal random haskell98
50
51 # Set GhcBootLibs=YES from the command line to work with just the libraries
52 # needed to bootstrap GHC.
53 ifneq "$(GhcBootLibs)" "YES"
54 SUBDIRS += $(wildcard regex-base)
55 SUBDIRS += $(wildcard regex-posix)
56 SUBDIRS += $(wildcard regex-compat)
57 SUBDIRS += $(wildcard parsec)
58 SUBDIRS += $(wildcard haskell-src)
59 SUBDIRS += $(wildcard html)
60 SUBDIRS += $(wildcard network)
61 SUBDIRS += $(wildcard QuickCheck)
62 SUBDIRS += $(wildcard HUnit)
63 SUBDIRS += $(wildcard mtl)
64 SUBDIRS += $(wildcard fgl)
65 SUBDIRS += $(wildcard time)
66 SUBDIRS += $(wildcard OpenGL)
67 SUBDIRS += $(wildcard GLUT)
68 SUBDIRS += $(wildcard OpenAL)
69 SUBDIRS += $(wildcard ALUT)
70 SUBDIRS += $(wildcard stm)
71 SUBDIRS += $(wildcard xhtml)
72 SUBDIRS += $(wildcard cgi)
73 ifeq "$(GhcLibsWithObjectIO)" "YES"
74 SUBDIRS += $(wildcard ObjectIO)
75 endif
76 SUBDIRS += $(wildcard parallel)
77 SUBDIRS += $(wildcard ndp)
78 endif
79
80 # -----------------------------------------------------------------------------
81
82 empty=
83 space=$(empty) $(empty)
84
85 # -----------------------------------------------------------------------------
86
87 ifeq "$(RelocatableBuild)" "YES"
88 # On Windows we want to make moveable bindists, but we need to tell
89 # ghc-pkg where the haddock docs are. Therefore we completely ignore
90 # where the user tells us to put the haddock documentation and put it
91 # somewhere whose relative location we know. When installing we need
92 # to give Cabal a real path, though.
93 iprefix             = $$topdir
94 ibindir             = $$topdir
95 ilibdir             = $$topdir
96 ilibexecdir         = $$topdir
97 idynlibdir          = $$topdir
98 idatadir            = $$topdir
99 idocdir             = $$topdir/doc/libraries/$$pkg
100 ihaddockdir         = $$topdir/doc/libraries/$$pkg
101 ihtmldir            = $$httptopdir/doc/libraries/$$pkg
102 html_installed_root = $(prefix)/doc/libraries
103 else
104 # On non-Windows we can just give absolute paths all the time, and
105 # thus obey the htmldir that we are given.
106 iprefix             = $(prefix)
107 ibindir             = $(bindir)
108 ilibdir             = $(libdir)
109 ilibexecdir         = $(libexecdir)
110 idynlibdir          = $(dynlibdir)
111 idatadir            = $(datadir)
112 idocdir             = $(docdir)/libraries/$$pkg
113 ihaddockdir         = $(htmldir)/libraries/$$pkg
114 ihtmldir            = $(htmldir)/libraries/$$pkg
115 html_installed_root = $(htmldir)/libraries
116 endif
117
118 ifneq "$(DOING_BIN_DIST)" "YES"
119
120 CONFIGURE_OPTS =
121 CONFIGURE_STAMP_EXTRAS :=
122
123 ifneq "$(findstring $(space)p$(space), $(space)$(GhcLibWays)$(space))" ""
124 CONFIGURE_OPTS += --enable-library-profiling
125 CONFIGURE_STAMP_EXTRAS := $(CONFIGURE_STAMP_EXTRAS)-profiling
126 endif
127
128 ifneq "$(findstring $(space)dyn$(space), $(space)$(GhcLibWays)$(space))" ""
129 CONFIGURE_OPTS += --enable-shared
130 CONFIGURE_STAMP_EXTRAS := $(CONFIGURE_STAMP_EXTRAS)-shared
131 endif
132
133 ifeq "$(SplitObjs)" "YES"
134 CONFIGURE_OPTS += --enable-split-objs
135 CONFIGURE_STAMP_EXTRAS := $(CONFIGURE_STAMP_EXTRAS)-splitting
136 endif
137
138 ifneq "$(HSCOLOUR)" ""
139 CONFIGURE_OPTS += --with-hscolour=$(HSCOLOUR)
140 endif
141
142 BOOTSTRAP_LIBS = Cabal filepath
143 BOOTSTRAP_STAMPS = $(addprefix stamp/bootstrapping.,$(BOOTSTRAP_LIBS))
144 BOOTSTRAP_INC_1_UP = -DCABAL_VERSION=1,3 $(addprefix -i../bootstrapping.,$(BOOTSTRAP_LIBS))
145 BOOTSTRAP_INC_2_UP = -DCABAL_VERSION=1,3 $(addprefix -i../../bootstrapping.,$(BOOTSTRAP_LIBS))
146 DEPLOYMENT_OPTS = $(addprefix -optc, $(MACOSX_DEPLOYMENT_CC_OPTS)) \
147                   $(addprefix -optl, $(MACOSX_DEPLOYMENT_LD_OPTS))
148
149 .PHONY: subdirs
150
151 subdirs:
152         @echo $(SUBDIRS)
153
154 .PHONY: boot
155
156 boot: $(BOOTSTRAP_STAMPS) ifBuildable/ifBuildable \
157           $(foreach SUBDIR,$(SUBDIRS),$(SUBDIR)/setup/Setup) \
158           installPackage/installPackage
159
160 # We build the Setup program in a setup subdirectory to stop it trying
161 # to use bits of base and Cabal when we build those packages.
162 # This also makes it slightly easier to clean.
163
164 # We ought to be depending on %/Setup.*hs, but make makes that difficult.
165
166 $(foreach SUBDIR,$(SUBDIRS),$(SUBDIR)/setup/Setup): \
167 %/setup/Setup: $(BOOTSTRAP_STAMPS)
168         -$(RM) -rf $*/setup
169         mkdir $*/setup
170         $(CP) $*/Setup.*hs $*/setup
171         cd $*/setup && $(GHC) -Wall -cpp --make Setup.*hs -o Setup \
172                               $(BOOTSTRAP_INC_2_UP)
173
174 installPackage/installPackage: installPackage.hs $(BOOTSTRAP_STAMPS)
175         -$(RM) -rf installPackage
176         mkdir installPackage
177         $(CP) installPackage.hs installPackage/
178 ifeq "$(stage)" "2"
179         cd installPackage && ../$(HC) -Wall -cpp \
180                                     --make installPackage -o installPackage \
181                                     $(BOOTSTRAP_INC_1_UP) $(DEPLOYMENT_OPTS)
182 else
183         cd installPackage && $(GHC) -Wall -cpp \
184                                     --make installPackage -o installPackage \
185                                     $(BOOTSTRAP_INC_1_UP)
186 endif
187 # TODO: The conditional is yucky, but we need to be able to build with stage1
188 #       for bindists and as installPackages/ has no Makefile, it seems hard
189 #       to make this nicer.
190
191 ifBuildable/ifBuildable: ifBuildable.hs
192         -$(RM) -rf ifBuildable
193         mkdir ifBuildable
194         $(CP) ifBuildable.hs ifBuildable/
195 ifeq "$(stage)" "2"
196         cd ifBuildable && ../$(HC) -Wall --make ifBuildable -o ifBuildable \
197                                  $(DEPLOYMENT_OPTS)
198 else
199         cd ifBuildable && $(GHC) -Wall --make ifBuildable -o ifBuildable
200 endif
201
202 $(BOOTSTRAP_STAMPS): stamp/bootstrapping.%:
203         $(RM) -rf bootstrapping.$*
204         $(CP) -R $* bootstrapping.$*
205         $(FIND) bootstrapping.$* \( -name "*.o" -o -name "*.hi" \) \
206                                  -exec $(RM) -f {} \;
207         touch $@
208
209 .PHONY: all build configure
210
211 all: build
212
213 ifeq "$(HADDOCK_DOCS)" "YES"
214 all: doc
215 endif
216
217 .PHONY: rebuild.library.%
218 .PHONY: remake.library.%
219
220 $(foreach SUBDIR,$(SUBDIRS),rebuild.library.$(SUBDIR)):\
221 rebuild.library.%: clean.library.% build.library.%
222
223 $(foreach SUBDIR,$(SUBDIRS),remake.library.$(SUBDIR)):\
224 remake.library.%: clean.library.% make.library.%
225
226 # NB. we're depending on make chasing dependencies from left to right here.
227 # This bit goes wrong with 'make -j'.
228 build: $(foreach SUBDIR,$(SUBDIRS),make.library.$(SUBDIR))
229 build: installPackage/installPackage
230
231 configure: $(foreach SUBDIR,$(SUBDIRS), \
232              stamp/configure.library.build$(CONFIGURE_STAMP_EXTRAS).$(SUBDIR))
233
234 .PHONY: build.library.%
235 .PHONY: make.library.%
236
237 # We should depend on %/%.cabal here (and in other rules), but make
238 # makes that difficult.
239
240 # We put non-existant paths in when configuring, as we require that
241 # builds don't depend on these paths when making bindists.
242
243 # We rely on all the CONFIGURE_ARGS being quoted with '...', and there
244 # being no 's inside the values.
245 FLAGGED_CONFIGURE_ARGS = $(subst $(space)',\
246                                  $(space)--configure-option=',\
247                                  $(space)$(CONFIGURE_ARGS))
248
249 $(foreach SUBDIR,$(SUBDIRS), \
250                   stamp/configure.library.build$(CONFIGURE_STAMP_EXTRAS).$(SUBDIR)): \
251 stamp/configure.library.build$(CONFIGURE_STAMP_EXTRAS).%: %/setup/Setup
252         -$(RM) -f stamp/configure.library.*.$* $*/unbuildable
253         ( cd $* && setup/Setup configure \
254                    $(CONFIGURE_OPTS) \
255                    --prefix=/NONEXISTANT \
256                    --bindir=/NONEXISTANT \
257                    --libdir=/NONEXISTANT \
258                    --libsubdir='$$pkgid' \
259                    --libexecdir=/NONEXISTANT \
260                    --datadir=/NONEXISTANT \
261                    --docdir=/NONEXISTANT \
262                            --haddockdir=/NONEXISTANT \
263                    --htmldir=/NONEXISTANT \
264                    --with-compiler=../../compiler/stage1/ghc-inplace \
265                    --with-hc-pkg=../../utils/ghc-pkg/ghc-pkg-inplace \
266                    --with-hsc2hs=../../utils/hsc2hs/hsc2hs-inplace \
267                    --with-ld=$(LD) \
268                    --haddock-options="--use-contents=../index.html \
269                                    --use-index=../doc-index.html" \
270                    $(FLAGGED_CONFIGURE_ARGS) \
271                    --configure-option=--with-cc=$(CC) ) \
272               && touch $@ || touch $*/unbuildable
273 # We don't touch $@ if configure failed as we would prefer to try
274 # configuring it next time round, rather than assuming it'll still fail.
275 # This is particularly important for bootlibs, where failure means the
276 # build dies!
277
278 # Build the library using 'make'
279 # We re-run 'setup makefile' each time, just in case any preprocessing
280 # needs to be done.  However, we're careful not to overwrite GNUmakefile
281 # if it hasn't changed, so that dependency-generation isn't forced
282 # every time.
283 $(foreach SUBDIR,$(SUBDIRS),make.library.$(SUBDIR)):\
284 make.library.%: stamp/configure.library.build$(CONFIGURE_STAMP_EXTRAS).% \
285                 %/setup/Setup ifBuildable/ifBuildable installPackage/installPackage
286         if ifBuildable/ifBuildable $*; then \
287           cd $* && \
288           cmp -s ../Makefile.local Makefile.local || cp ../Makefile.local .; \
289           mv GNUmakefile GNUmakefile.tmp; \
290           setup/Setup makefile -f GNUmakefile; \
291           cmp -s GNUmakefile GNUmakefile.tmp && mv GNUmakefile.tmp GNUmakefile; \
292           $(MAKE) $(MFLAGS) && \
293           ../installPackage/installPackage register --inplace; \
294         fi
295
296 # Build the library using 'setup build' (not the default)
297 $(foreach SUBDIR,$(SUBDIRS),build.library.$(SUBDIR)):\
298 build.library.%: stamp/configure.library.build$(CONFIGURE_STAMP_EXTRAS).% \
299                  %/setup/Setup ifBuildable/ifBuildable
300         if ifBuildable/ifBuildable $*; then \
301           cd $* && \
302           setup/Setup build $(addprefix --ghc-option=,$(GhcLibHcOpts)); \
303         fi
304
305 .PHONY: doc html
306
307 html: doc
308
309 doc: $(foreach SUBDIR,$(SUBDIRS),doc.library.$(SUBDIR))
310         sh gen_contents_index --inplace
311
312 # Making hyperlinked source only works if we have hscolour
313 ifneq "$(HSCOLOUR)" ""
314 CABAL_HADDOCK_FLAGS=--hyperlink-source
315 endif
316
317 $(foreach SUBDIR,$(SUBDIRS),doc.library.$(SUBDIR)):\
318 doc.library.%: stamp/configure.library.build$(CONFIGURE_STAMP_EXTRAS).% \
319                %/setup/Setup ifBuildable/ifBuildable
320         if ifBuildable/ifBuildable $*; then \
321           cd $* && setup/Setup haddock --html-location='../$$pkg' \
322                                        $(CABAL_HADDOCK_FLAGS); \
323         fi
324 ifneq "$(HSCOLOUR)" ""
325         if ifBuildable/ifBuildable $*; then cp hscolour.css $*/dist/doc/html/$*/src/; fi
326 endif
327
328 .PHONY: distclean clean clean.library.%
329
330 distclean: clean
331
332 clean: $(foreach SUBDIR,$(SUBDIRS),clean.library.$(SUBDIR))
333         $(RM) -f stamp/bootstrapping.*
334         $(RM) -rf bootstrapping.*
335         $(RM) -rf ifBuildable
336         $(RM) -rf installPackage
337         $(RM) -f libraries.txt index.html doc-index.html doc-index*.html
338         $(RM) -f haddock* *.gif
339
340 distclean:
341         $(RM) $(foreach lib, $(SUBDIRS), $(lib)/.depend $(lib)/.depend.bak)
342
343 $(foreach SUBDIR,$(SUBDIRS),clean.library.$(SUBDIR)): \
344 clean.library.%:
345         $(RM) -f stamp/configure.library.*.$* $*/unbuildable
346         -cd $* && setup/Setup clean
347         $(RM) -rf $*/setup
348         $(RM) $*/GNUmakefile $*/Makefile.local
349 endif
350
351 # -----------------------------------------------------------------------------
352
353 .PHONY: install install-docs install.library.%
354
355 install: $(foreach SUBDIR,$(SUBDIRS),install.library.$(SUBDIR))
356 ifeq "$(HADDOCK_DOCS)" "YES"
357         $(INSTALL_DIR)                                                     $(DESTDIR)$(html_installed_root)
358         $(INSTALL_DATA)   index.html doc-index*.html                       $(DESTDIR)$(html_installed_root)
359         $(INSTALL_SCRIPT) gen_contents_index                               $(DESTDIR)$(html_installed_root)
360         # Hacks:
361         $(INSTALL_DATA)   base/dist/doc/html/*/*.css $(DESTDIR)$(html_installed_root)
362         $(INSTALL_DATA)   base/dist/doc/html/*/*.js $(DESTDIR)$(html_installed_root)
363         $(INSTALL_DATA)   base/dist/doc/html/*/*.gif $(DESTDIR)$(html_installed_root)
364 endif
365
366 # Cabal doesn't let us ask to install docs only, so do nothing here
367 install-docs:
368         @:
369
370 # Ideally this would depend on a stamp/build.library.%, but if it does
371 # then we can't change the libraries and then just rerun make.
372 # Thus if you install without building then it will just break.
373
374 # prefix and (on Windows) htmldir use $topdir when configuring, so we
375 # need to tell installPackage the real path to use when installing.
376
377 # We also need to pass all the other directories in, as they can be
378 # overridden when installing a bindist.
379
380 $(foreach SUBDIR,$(SUBDIRS),install.library.$(SUBDIR)): \
381 install.library.%: installPackage/installPackage ifBuildable/ifBuildable
382         if ifBuildable/ifBuildable $*; then \
383           cd $* && \
384           ../installPackage/installPackage install '$(GHC_PKG_PROG)' '$(DESTDIR)$(libdir)/package.conf' '$(DESTDIR)' '$(prefix)' '$(iprefix)' '$(ibindir)' '$(ilibdir)' '$(ilibexecdir)' '$(idynlibdir)' '$(idatadir)' '$(idocdir)' '$(ihtmldir)' '$(ihaddockdir)' ; \
385         fi
386
387 .PHONY: binary-dist binary-dist.library.%
388
389 BIN_DIST_LIBDIR=$(BIN_DIST_DIR)/libraries
390
391 binary-dist: $(foreach SUBDIR,$(SUBDIRS),binary-dist.library.$(SUBDIR))
392         mkdir                               $(BIN_DIST_LIBDIR)/installPackage
393         cp        installPackage/installPackage $(BIN_DIST_LIBDIR)/installPackage
394         mkdir                               $(BIN_DIST_LIBDIR)/ifBuildable
395         cp        ifBuildable/ifBuildable       $(BIN_DIST_LIBDIR)/ifBuildable
396         cp    Makefile                      $(BIN_DIST_LIBDIR)
397 ifeq "$(HADDOCK_DOCS)" "YES"
398         cp    gen_contents_index            $(BIN_DIST_LIBDIR)
399         cp    index.html                    $(BIN_DIST_LIBDIR)
400         cp    doc-index*.html               $(BIN_DIST_LIBDIR)
401 endif
402         cp -pR stamp                         $(BIN_DIST_LIBDIR)
403
404 $(foreach SUBDIR,$(SUBDIRS),binary-dist.library.$(SUBDIR)): \
405 binary-dist.library.%:
406         if ifBuildable/ifBuildable $*; then \
407           $(MKDIRHIER) $(BIN_DIST_LIBDIR)/$*; \
408           cd $* && \
409           cp    $*.cabal      $(BIN_DIST_LIBDIR)/$* && \
410           cp    LICENSE       $(BIN_DIST_LIBDIR)/$* && \
411           cp -R dist          $(BIN_DIST_LIBDIR)/$* && \
412           $(FIND) . -name "*.buildinfo" -exec cp {} $(BIN_DIST_LIBDIR)/$* \; && \
413           $(FIND) . -name unbuildable -exec cp {} $(BIN_DIST_LIBDIR)/$* \; && \
414           (cp -RL include      $(BIN_DIST_LIBDIR)/$* || true) && \
415           $(FIND) $(BIN_DIST_LIBDIR)/$*/dist \
416              \( -name "*_split" -o -name "autogen" \) | xargs rm -rf && \
417           $(FIND) $(BIN_DIST_LIBDIR)/$*/dist \
418              \( \( -name "*.o" -o -name "*.p_o" \) -a ! -name "HS*" \) \
419              -exec rm {} \; ; \
420         fi
421
422 # Ignore some doc targets that we don't support
423 # The root recurses into us when these targets are made
424 .PHONY: html-no-chunks chm HxS fo dvi ps pdf
425 html-no-chunks chm HxS fo dvi ps pdf:
426         @:
427