[project @ 2003-07-24 15:04:41 by simonmar]
[ghc-hetmet.git] / mk / paths.mk
1 #################################################################################
2 #
3 #                           paths.mk
4 #
5 #       This file defines Make variables for standard directories
6 #       and file lists
7 #
8 #################################################################################
9
10
11 #-----------------------------------------------------------------
12 #
13 # Installation setup
14 #
15
16 #-----------------------------------------------------------------------------
17 # install configuration
18 #
19 # The install standard target is guided by the following four variables
20 #
21 #  INSTALL_PROGS    (installed in $(bindir))
22 #  INSTALL_LIBS     (installed in $(libdir))
23 #  INSTALL_LIBEXECS (installed in $(libexecdir))
24 #  INSTALL_DATAS    (installed in $(datadir))
25 #  INSTALL_IFACES   (installed in $(ifacedir))
26 #
27 # see target.mk for more information.
28 #
29
30 #
31 # Setting user/group ownership for the installed entities
32 #
33 # this stuff about "who" does the installing doesn't have make vars
34 # as it is not intended to be run-time changeable.
35 #
36 ifneq "$(OWNER)" ""
37 INSTALL_OWNER   = -o $(OWNER)
38 else
39 INSTALL_OWNER   =
40 endif
41
42 ifneq "$(GROUP)" ""
43 INSTALL_GROUP   = -g $(GROUP)
44 else
45 INSTALL_GROUP   =
46 endif
47
48 SRC_INSTALL_OPTS += $(INSTALL_OWNER) $(INSTALL_GROUP)
49
50 #
51 # Invocations of `install' for the four different classes
52 # of targets:
53 #
54
55 INSTALL_PROGRAM = $(INSTALL) -m 755
56 INSTALL_SCRIPT  = $(INSTALL) -m 755
57 INSTALL_SHLIB   = $(INSTALL) -m 755
58 INSTALL_DATA    = $(INSTALL) -m 644
59 INSTALL_DIR     = $(FPTOOLS_TOP)/glafp-utils/mkdirhier/mkdirhier
60
61 #
62 # The install variables does not have any defaults,
63 # what files to install have to be specified in the Makefiles.
64 #
65
66 #################################################################################
67 #
68 #               Standard variable names
69 #
70 #################################################################################
71 # The fptools mk setup defines a set of standard names which are used
72 # by the standard targets provided by mk. One example of this is the
73 # use of standard names for specifying what files to compile, their
74 # intermediate/object code, and the name of the final
75 # executable. Based on the settings of these variables, the standard
76 # targets will generate/expand rules that automatically compile and
77 # link your program.
78 #
79 # The general rules:
80 #
81 #   SRCS - sources, might be prefixed to indicate what type of source
82 #          they are.
83 #   OBJS - object files (possibly prefixed).
84 #
85 #   PROG - name of final executable
86 #
87 # We attempt to automatically devine the list of sources $(SRCS) to
88 # compile by looking in the current directory (and possibly other
89 # directories which may be specified by setting the $(ALL_DIRS)
90 # variable).  This is complicated by the fact that some files are
91 # derived from other files: eg. .hsc files give rise to -hsc.c and
92 # -hsc.h files, .ly files give rise to .hs files, and .hs files give
93 # rise to .hc files sometimes.
94
95 # So we figure out the sources in three stages: first figure out what
96 # sources we can find (this is $(ALL_SRCS)).  Then figure out all the
97 # "derived" sources (eg. A.hsc generates A.hs and A_hsc.c), and
98 # finally put all these together and remove duplicates (GNU make's
99 # handy sort function does the duplicate removing).
100
101 # HS_SRCS:   list of Haskell modules you want to compile.
102 #             (also use by depend rule).
103 # HS_OBJS:   list of corresponding object files
104 # HS_PROG:   program that is ultimately linked.
105 # HS_IFACES: list of interface files generated
106 #             (caveat: assuming no funny use of -hisuf and that
107 #               file name and module name match)
108
109 ALL_SRCS    = $(wildcard $(patsubst ./%, %,  \
110                    $(patsubst %,%/*.hs,   . $(ALL_DIRS)) \
111                    $(patsubst %,%/*.lhs,  . $(ALL_DIRS)) \
112                    $(patsubst %,%/*.y,    . $(ALL_DIRS)) \
113                    $(patsubst %,%/*.ly,   . $(ALL_DIRS)) \
114                    $(patsubst %,%/*.c,    . $(ALL_DIRS)) \
115                    $(patsubst %,%/*.hc,   . $(ALL_DIRS)) \
116                    $(patsubst %,%/*.S,    . $(ALL_DIRS)) \
117                    $(patsubst %,%/*.prl,  . $(ALL_DIRS)) \
118                    $(patsubst %,%/*.lprl, . $(ALL_DIRS)) \
119                    $(patsubst %,%/*.lit,  . $(ALL_DIRS)) \
120                    $(patsubst %,%/*.verb, . $(ALL_DIRS)) \
121                    $(patsubst %,%/*.hsc,  . $(ALL_DIRS)) \
122                    $(patsubst %,%/*.gc,   . $(ALL_DIRS)) \
123                )) $(EXTRA_SRCS)
124
125 # ALL_SRCS is computed once and for all into PRE_SRCS at the top of
126 # target.mk.  Otherwise, we end up re-computing ALL_SRCS every time it
127 # is expanded (it is used in several variables below, and these
128 # variables are used in several others, etc.), which can really slow
129 # down make.
130
131 PRE_HS_SRCS  = $(filter %.hs,  $(PRE_SRCS))
132 PRE_LHS_SRCS = $(filter %.lhs, $(PRE_SRCS))
133
134 GC_SRCS       = $(filter %.gc,  $(PRE_SRCS))
135 HSC_SRCS      = $(filter %.hsc, $(PRE_SRCS))
136 HAPPY_Y_SRCS  = $(filter %.y,   $(PRE_SRCS))
137 HAPPY_LY_SRCS = $(filter %.ly,   $(PRE_SRCS))
138 HAPPY_SRCS    = $(HAPPY_Y_SRCS) $(HAPPY_LY_SRCS)
139
140 DERIVED_GC_SRCS       = $(patsubst %.gc, %.hs, $(GC_SRCS)) \
141                         $(patsubst %.gc, %_stub_ffi.c, $(GC_SRCS)) \
142                         $(patsubst %.gc, %_stub_ffi.h, $(GC_SRCS))
143
144 DERIVED_HSC_SRCS      = $(patsubst %.hsc, %.hs, $(HSC_SRCS)) \
145                         $(patsubst %.hsc, %_hsc.c, $(HSC_SRCS)) \
146                         $(patsubst %.hsc, %_hsc.h, $(HSC_SRCS)) \
147                         $(patsubst %.hsc, %.hc, $(HSC_SRCS))
148
149 DERIVED_HAPPY_SRCS    = $(patsubst %.y,   %.hs, $(HAPPY_Y_SRCS)) \
150                         $(patsubst %.ly,  %.hs, $(HAPPY_LY_SRCS))
151
152 DERIVED_HC_SRCS       = $(patsubst %.hs,  %.hc, $(PRE_HS_SRCS)) \
153                         $(patsubst %.lhs, %.hc, $(PRE_LHS_SRCS))
154
155 DERIVED_SRCS          = $(DERIVED_GC_SRCS) \
156                         $(DERIVED_HSC_SRCS) \
157                         $(DERIVED_HAPPY_SRCS) \
158                         $(DERIVED_HC_SRCS)
159
160 # EXCLUDED_SRCS can be set in the Makefile, otherwise it defaults to empty.
161 EXCLUDED_GC_SRCS       = $(filter %.gc,  $(EXCLUDED_SRCS))
162 EXCLUDED_HSC_SRCS      = $(filter %.hsc, $(EXCLUDED_SRCS))
163 EXCLUDED_HAPPY_Y_SRCS  = $(filter %.y,   $(EXCLUDED_SRCS))
164 EXCLUDED_HAPPY_LY_SRCS = $(filter %.ly,  $(EXCLUDED_SRCS))
165 EXCLUDED_HAPPY_SRCS   = $(EXCLUDED_HAPPY_Y_SRCS) $(EXCLUDED_HAPPY_LY_SRCS)
166 EXCLUDED_HS_SRCS      = $(filter %.hs,  $(EXCLUDED_SRCS))
167 EXCLUDED_LHS_SRCS     = $(filter %.lhs, $(EXCLUDED_SRCS))
168 EXCLUDED_DERIVED_SRCS = $(patsubst %.hsc, %.hs, $(EXCLUDED_HSC_SRCS)) \
169                         $(patsubst %.hsc, %_hsc.h, $(EXCLUDED_HSC_SRCS)) \
170                         $(patsubst %.hsc, %_hsc.c, $(EXCLUDED_HSC_SRCS)) \
171                         $(patsubst %.hsc, %.hc, $(EXCLUDED_HSC_SRCS)) \
172                         $(patsubst %.gc,  %_stub_ffi.c, $(EXCLUDED_GC_SRCS)) \
173                         $(patsubst %.gc,  %_stub_ffi.h, $(EXCLUDED_GC_SRCS)) \
174                         $(patsubst %.y,   %.hs, $(EXCLUDED_HAPPY_Y_SRCS)) \
175                         $(patsubst %.ly,  %.hs, $(EXCLUDED_HAPPY_LY_SRCS)) \
176                         $(patsubst %.hs,  %.hc, $(EXCLUDED_HS_SRCS)) \
177                         $(patsubst %.lhs, %.hc, $(EXCLUDED_LHS_SRCS)) \
178                         $(patsubst %.hs,  %_stub.c, $(EXCLUDED_HS_SRCS)) \
179                         $(patsubst %.lhs, %_stub.c, $(EXCLUDED_LHS_SRCS))
180
181 # Exclude _hsc.c files; they get built as part of the cbits library,
182 # not part of the main library
183
184 CLOSED_EXCLUDED_SRCS  = $(sort $(EXCLUDED_SRCS) $(EXCLUDED_DERIVED_SRCS))
185
186 SRCS        = $(filter-out $(CLOSED_EXCLUDED_SRCS), \
187                 $(sort $(PRE_SRCS) $(DERIVED_SRCS)))
188
189 HS_SRCS     = $(filter %.lhs %.hs, $(sort $(SRCS) $(BOOT_SRCS)))
190 HS_OBJS     = $(addsuffix .$(way_)o,$(basename $(HS_SRCS)))
191 HS_IFACES   = $(addsuffix .$(way_)hi,$(basename $(HS_SRCS)))
192
193 GC_C_OBJS   = $(addsuffix _stub_ffi.$(way_)o,$(basename $(filter %.gc,$(SRCS))))
194 HSC_C_OBJS  = $(addsuffix _hsc.$(way_)o,$(basename $(filter %.hsc,$(SRCS))))
195
196 ifeq "$(BootingFromHc)" "NO"
197 # We don't want to build the _stub.c files ourselves, unless we're
198 # bootstrapping from .hc files.
199 EXCLUDED_C_SRCS = $(patsubst %.lhs, %_stub.c, $(HS_SRCS)) \
200                   $(patsubst %.hs,  %_stub.c, $(HS_SRCS)) \
201                   $(patsubst %.gc, %_stub_ffi.c, $(GC_SRCS)) \
202                   $(patsubst %.gc, %_stub_ffi.h, $(GC_SRCS))
203 endif
204
205 C_SRCS      = $(filter-out $(EXCLUDED_C_SRCS),$(filter %.c,$(SRCS)))
206 C_OBJS      = $(addsuffix .$(way_)o,$(basename $(C_SRCS)))
207
208 # SCRIPT_SRCS:  list of raw script files (in literate form)
209 # SCRIPT_OBJS:  de-litted scripts
210 SCRIPT_SRCS = $(filter %.lprl,$(SRCS))
211 SCRIPT_OBJS = $(addsuffix .prl,$(basename $(SCRIPT_SRCS)))
212
213 OBJS        = $(HS_OBJS) $(C_OBJS) $(SCRIPT_OBJS) $(GC_C_OBJS) 
214
215 # The default is for $(LIBOBJS) to be the same as $(OBJS)
216 LIBOBJS     = $(OBJS)
217
218 #
219 # Note that as long as you use the standard variables for setting
220 # which C & Haskell programs you want to work on, you don't have
221 # to set any of the clean variables - the default should do the Right
222 # Thing.
223 #
224
225 #------------------------------------------------------------------
226 #
227 # make depend defaults
228 #
229 # The default set of files for the dependency generators to work on
230 # is just their source equivalents.
231 #
232
233 ifneq "$(BootingFromHc)" "YES"
234 MKDEPENDHS_SRCS=$(HS_SRCS)
235 else
236 MKDEPENDHS_SRCS=
237 endif
238
239 MKDEPENDC_SRCS=$(C_SRCS)
240
241 #------------------------------------------------------------------
242 #
243 # make TAGS defaults
244 #
245 # The default set of files for the TAGS file generators to work on
246 # is just their source equivalents.
247 #
248 TAGS_HS_SRCS=$(HS_SRCS)
249 TAGS_C_SRCS=$(C_SRCS)
250
251 #------------------------------------------------------------------
252 # Clean file make-variables.
253 #
254 # The following three variables are used to control
255 # what gets removed when doing `make clean'
256 #
257 # MOSTLYCLEAN_FILES   object code etc., but not stuff
258 #                     that is slow to recompile and/or stable
259 #
260 # CLEAN_FILES  all files that are created by running make.
261 #
262 # MAINTAINER_CLEAN_FILES also clean out machine-generated files
263 #                        that may require extra tools to create.
264 #
265 #
266 MOSTLY_CLEAN_FILES += $(HS_OBJS) $(C_OBJS) $(HSC_C_OBJS) $(GC_C_OBJS)
267 CLEAN_FILES        += $(HS_PROG) $(C_PROG) $(SCRIPT_PROG) $(SCRIPT_LINK) \
268                       $(PROG) $(LIBRARY) a.out \
269                       $(DERIVED_HSC_SRCS) \
270                       $(DERIVED_GC_SRCS) \
271                       $(patsubst %,%/*.$(way_)hi, . $(ALL_DIRS))
272
273 # we delete *all* the .hi files we can find, rather than just
274 # $(HS_IFACES), because stale interfaces left around by modules which
275 # don't exist any more can screw up the build.
276
277 # Don't clean the .hc files if we're bootstrapping
278 ifneq "$(BootingFromHc)" "YES"
279 CLEAN_FILES += $(DERIVED_HC_SRCS)
280 endif
281
282 DIST_CLEAN_FILES        += .depend* *.hp *.prof
283
284 MAINTAINER_CLEAN_FILES  += $(BOOT_SRCS) $(DERIVED_HAPPY_SRCS)
285
286 #
287 # `Standard' set of files to clean out.
288 #
289 MOSTLY_CLEAN_FILES += \
290  *.CKP *.ln *.BAK *.bak .*.bak *.o core a.out errs ,* *.a .emacs_*  \
291  tags TAGS *.ind *.ilg *.idx *.idx-prev *.aux *.aux-prev *.dvi *.log \
292  *.toc *.lot *.lof *.blg *.cb *_stub.c *_stub.h *.raw_s *.a.list
293
294 #------------------------------------------------------------------
295 #
296 # Distribution setup
297 #
298 # Following variables are used for creating source and binary distributions:
299 #
300 #  SRC_DIST_NAME && BIN_DIST_NAME  -- the package names
301 #
302 #  SRC_DIST_FILES = list of extra files to include from a build tree into a source
303 #                   distribution
304 #
305 #  SRC_DIST_DIR  = what the current directory in the source/build tree
306 #                  maps to in the source distrib. tree being created.
307 #
308 SRC_DIST_NAME=$(ProjectNameShort)-$(ProjectVersion)
309
310 #
311 # Binary distributions proceeds as follows:
312 #
313 # Fromthe top of a build tree, you do `make binary-dist'. The
314 # canned rule for this  (in target.mk) will then do a binary
315 # install to a temporary directory before packaging it all up.
316 # The following variables guide the binary-dist:
317 #
318 #  BIN_DIST_TMPDIR= the absolute path to where the temporary directory
319 #                   structure of a binary distribution should be created.
320 #                   [Default: toplevel from which you issue `make binary-dist']
321 #  BIN_DIST_NAME=   what to call the thing.
322 #
323 #  BIN_DIST_DIRS=   at the toplevel, list of directories to descend into when
324 #                   building the distribution tree.
325 #
326 #  An extra directory variable that is set during bin-dists is $(bindist_top), giving
327 #  the abs. path to the root of the binary installation tree. (useful when punting
328 #  stuff like README and ANNOUNCE into a distrib, for instance)
329 #
330 #  The layout of a binary distribution is described in the
331 #  installation documentation.
332 #
333
334
335 # Directory in which DLLs are dumped so as not to get picked up by running
336 # programs (e.g. ghc or hsc) that run in the build tree
337
338 DLL_PEN = $(FPTOOLS_TOP)/dll
339