rules/haddock: Set __HADDOCK_VERSION__
[ghc.git] / rules / build-dependencies.mk
1 # -----------------------------------------------------------------------------
2 #
3 # (c) 2009 The University of Glasgow
4 #
5 # This file is part of the GHC build system.
6 #
7 # To understand how the build system works and how to modify it, see
8 # http://ghc.haskell.org/trac/ghc/wiki/Building/Architecture
9 # http://ghc.haskell.org/trac/ghc/wiki/Building/Modifying
10 #
11 # -----------------------------------------------------------------------------
12
13 define build-dependencies
14 $(call trace, build-dependencies($1,$2,$3))
15 $(call profStart, build-dependencies($1,$2,$3))
16 # $1 = dir
17 # $2 = distdir
18 # $3 = GHC stage to use (0 == bootstrapping compiler)
19
20 $1_$2_depfile_haskell = $$($1_$2_depfile_base).haskell
21 $1_$2_depfile_c_asm = $$($1_$2_depfile_base).c_asm
22
23 $1_$2_C_FILES_DEPS = $$(filter-out $$($1_$2_C_FILES_NODEPS),$$($1_$2_C_FILES))
24
25 $1_$2_MKDEPENDHS_FLAGS = -dep-makefile $$($1_$2_depfile_haskell).tmp $$(foreach way,$$($1_$2_WAYS),-dep-suffix "$$(patsubst %o,%,$$($$(way)_osuf))")
26 $1_$2_MKDEPENDHS_FLAGS += -include-pkg-deps
27
28 ifneq "$$(NO_GENERATED_MAKEFILE_RULES)" "YES"
29
30 # Some of the Haskell files (e.g. utils/hsc2hs/Main.hs) (directly or
31 # indirectly) include the generated includes files.
32 $$($1_$2_depfile_haskell) : $$(includes_H_CONFIG) $$(includes_H_PLATFORM)
33
34 $$($1_$2_depfile_haskell) : $$($1_$2_HS_SRCS) $$($1_$2_HS_BOOT_SRCS) $$$$($1_$2_HC_MK_DEPEND_DEP) | $$$$(dir $$$$@)/.
35 $$(call removeFiles,$$@.tmp)
36 ifneq "$$($1_$2_HS_SRCS)" ""
37 "$$($1_$2_HC_MK_DEPEND)" -M \
38 $$($1_$2_$$(firstword $$($1_$2_WAYS))_MOST_DIR_HC_OPTS) \
39 $$($1_$2_MKDEPENDHS_FLAGS) \
40 $$($1_$2_HS_SRCS)
41 endif
42 echo "$1_$2_depfile_haskell_EXISTS = YES" >> $$@.tmp
43 ifneq "$$($1_$2_SLASH_MODS)" ""
44 for dir in $$(sort $$(foreach mod,$$($1_$2_SLASH_MODS),$1/$2/build/$$(dir $$(mod)))); do \
45 if test ! -d $$$$dir; then mkdir -p $$$$dir; fi \
46 done
47 endif
48 # Some packages are from the bootstrapping compiler, so are not
49 # within the build tree. On Windows this causes a problem as they look
50 # like bad rules, due to the two colons, so we filter them out.
51 grep -v ' : [a-zA-Z]:/' $$@.tmp > $$@.tmp2
52 # Insert the calls to hi-rule. Basically, we look for the
53 # Foo.dyn_o Foo.o : Foo.hs
54 # lines, and create corresponding hi-rule lines
55 # <dollar>(eval <dollar>(call hi-rule,Foo.dyn_hi Foo.hi : %hi: %o Foo.hs))
56 sed -e '/hs$$$$/ p' -e '/hs$$$$/ s/o /hi /g' \
57 -e '/hs$$$$/ s/:/ : %hi: %o /' \
58 -e '/hs$$$$/ s/^/$$$$(eval $$$$(call hi-rule,/' \
59 -e '/hs$$$$/ s/$$$$/))/' \
60 -e '/hs-boot$$$$/ p' -e '/hs-boot$$$$/ s/o-boot /hi-boot /g' \
61 -e '/hs-boot$$$$/ s/:/ : %hi-boot: %o-boot /' \
62 -e '/hs-boot$$$$/ s/^/$$$$(eval $$$$(call hi-rule,/' \
63 -e '/hs-boot$$$$/ s/$$$$/))/' \
64 $$@.tmp2 > $$@
65 # Some of the C files (directly or indirectly) include the generated
66 # includes files.
67 $$($1_$2_depfile_c_asm) : $$(includes_H_CONFIG) $$(includes_H_PLATFORM)
68
69 $$($1_$2_depfile_c_asm) : $$($1_$2_C_FILES_DEPS) $$($1_$2_S_FILES) $$($1_$2_CMM_FILES) | $$$$(dir $$$$@)/.
70 $$(call removeFiles,$$@.tmp)
71 ifneq "$$(strip $$($1_$2_C_FILES_DEPS) $$($1_$2_S_FILES)) $$($1_$2_CMM_FILES))" ""
72 # We ought to actually do this for each way in $$($1_$2_WAYS), but then
73 # it takes a long time to make the C deps for the RTS (30 seconds rather
74 # than 3), so instead we just pass the list of ways in and let addCFileDeps
75 # copy the deps for each way on the assumption that they are the same
76 $$(foreach f,$$($1_$2_C_FILES_DEPS) $$($1_$2_S_FILES) $$($1_$2_CMM_FILES), \
77 $$(call addCFileDeps,$1,$2,$$($1_$2_depfile_c_asm),$$f,$$($1_$2_WAYS)))
78 $$(call removeFiles,$$@.bit)
79 endif
80 echo "$1_$2_depfile_c_asm_EXISTS = YES" >> $$@.tmp
81 mv $$@.tmp $$@
82
83 endif # NO_GENERATED_MAKEFILE_RULES
84
85 # Note sed magic above: mkdependC can't do -odir stuff, so we have to
86 # munge the dependencies it generates to refer to the correct targets.
87
88 $(call profEnd, build-dependencies($1,$2,$3))
89 endef
90
91 # This comment is outside the "define addCFileDeps" as that definition
92 # is a list of command lines, and if it is inside it then we pass this
93 # comment to the shell every time we call the definition.
94 # $1 = dir
95 # $2 = distdir
96 # $3 = depfile
97 # $4 = file
98 # $5 = ways
99 #
100 # The formatting of this definition (e.g. the blank line above) is
101 # important, in order to get make to generate the right makefile code.
102 #
103 # 's|\\|/|g'
104 # We first normalise all slashes to be forward slashes. Note that
105 # $(TOP) also uses forward slashes.
106 # 's| /$$| \\|'
107 # But now we need to fix the line continuation characters that we
108 # just broke.
109 # "1s|\.o|\.$($w_osuf)|"
110 # We will have dependencies for .o files, so we need to fix them up
111 # for the right object suffix for the way we're doing
112 # "1s|^|$(dir $4)|"
113 # We always get deps for just foo.o when the file we're making is
114 # a/b/c/foo.o, so we need to prepend the directory of the source file
115 # "1s|$1/|$1/$2/build/|"
116 # Well, almost. We actually need to insert e.g. "dist/build" in the
117 # middle of that directory
118 # "1s|$2/build/$2/build|$2/build|g"
119 # But some source files, e.g. sm/Evac_thr.c, are also inside the
120 # "dist/build" directory, so now we've just made
121 # "dist/build/dist/build", so we need to remove the duplication
122 # again
123 # "s|$(TOP)/||g$(CASE_INSENSITIVE_SED)"
124 # Finally, when making deps for packages like ghc stage2, we have
125 # some include paths for packages registered in the in-tree package
126 # database. These include paths are full (i.e. not relative) paths,
127 # which means that the "cpp -MM" output uses full paths in some cases.
128 # This causes 2 problems:
129 # * they don't match up with the rules to rebuild the files, where
130 # appropriate.
131 # * on Windows, make interprets the colon in c:/foo/bar.h as make
132 # syntax.
133 # So we sed off $(TOP). Unfortunately, on Windows, the case for the
134 # drive letter is sometimes different in what $(TOP) starts with, and
135 # what the path in the package database starts with. We therefore
136 # need to do the substitution case-insensitively on Windows. But
137 # the s///i modifier isn't portable, so we set CASE_INSENSITIVE_SED
138 # to "i" on Windows and "" on any other platform.
139
140 # We use this not only for .c files, but also for .S and .cmm files.
141 # As gcc doesn't know what a .cmm file is, it treats it as a linker
142 # input and ignores it. We therefore tell gcc that all files are C
143 # files with "-x c" so that it actually processes them all.
144
145 define addCFileDeps
146
147 $(CPP) $($1_$2_MKDEPENDC_OPTS) $($1_$2_$(firstword $($1_$2_WAYS))_ALL_CC_OPTS) $($(basename $4)_CC_OPTS) -MM -x c $4 -MF $3.bit
148 $(foreach w,$5,sed -e 's|\\|/|g' -e 's| /$$| \\|' -e "1s|\.o|\.$($w_osuf)|" -e "1s|^|$(dir $4)|" -e "1s|$1/|$1/$2/build/|" -e "1s|$2/build/$2/build|$2/build|g" -e "s|$(TOP)/||g$(CASE_INSENSITIVE_SED)" $3.bit >> $3.tmp &&) true
149 endef
150
151 ifeq "$(Windows_Host)" "YES"
152 CASE_INSENSITIVE_SED = i
153 else
154 CASE_INSENSITIVE_SED =
155 endif
156