[project @ 2001-11-28 14:29:59 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 #
26 # see target.mk for more information.
27 #
28
29 #
30 # Setting user/group ownership for the installed entities
31 #
32 # this stuff about "who" does the installing doesn't have make vars
33 # as it is not intended to be run-time changeable.
34 #
35 ifneq "$(OWNER)" ""
36 INSTALL_OWNER   = -o $(OWNER)
37 else
38 INSTALL_OWNER   =
39 endif
40
41 ifneq "$(GROUP)" ""
42 INSTALL_GROUP   = -g $(GROUP)
43 else
44 INSTALL_GROUP   =
45 endif
46
47 SRC_INSTALL_OPTS += $(INSTALL_OWNER) $(INSTALL_GROUP)
48
49 #
50 # Invocations of `install' for the three different classes
51 # of targets:
52 #
53
54 INSTALL_PROGRAM = $(INSTALL) -m 755
55 INSTALL_SCRIPT  = $(INSTALL) -m 755
56 INSTALL_DATA    = $(INSTALL) -m 644
57 INSTALL_DIR     = $(FPTOOLS_TOP)/glafp-utils/mkdirhier/mkdirhier
58
59 #
60 # The install variables does not have any defaults,
61 # what files to install have to be specified in the Makefiles.
62 #
63 #INSTALL_PROGS += $(HS_PROG) $(C_PROG)
64 #INSTALL_LIBS  += $(LIBRARY)
65 #INSTALL_DATAS += $(HS_IFACES)
66
67 #################################################################################
68 #
69 #               Standard variable names
70 #
71 #################################################################################
72
73 #
74 # The fptools mk setup defines a set of standard names which are used by the standard
75 # targets provided by mk. One example of this is the use of standard names
76 # for specifying what files to compile, their intermediate/object code, and
77 # the name of the final executable. Based on the settings of these variables, the
78 # standard targets will generate/expand rules that automatically compile and
79 # link your program.
80 #
81 # The general rules:
82 #
83 #   SRCS - sources, might be prefixed to indicate what type of source
84 #          they are.
85 #   OBJS - object files (possibly prefixed).
86 #
87 #   PROG - name of final executable
88
89 # We attempt to automatically devine the list of sources $(SRCS) to
90 # compile by looking in the current directory.  This is complicated by
91 # the fact that a .hsc file gives rise to a .hs file (which needs to
92 # be automatically included in $(SRCS)), but the .hs file might
93 # already be present in the current directory and we don't want to
94 # compile it twice.
95
96 # So we figure out the sources in three stages: first figure out
97 # what's in the current directory (this is $(PRE_SRCS)).  Then figure
98 # out all the "derived" sources (eg. A.hsc generates A.hs and
99 # A_hsc.c), and finally put all these together and remove duplicates
100 # (GNU make's handy sort function does the duplicate removing).
101 #
102 # BOOT_SRCS: list of machine generated Haskell modules.
103 # HS_SRCS:   list of Haskell modules you want to compile.
104 #             (also use by depend rule).
105 # HS_OBJS:   list of corresponding object files
106 # HS_PROG:   program that is ultimately linked.
107 # HS_IFACES: list of interface files generated
108 #             (caveat: assuming no funny use of -hisuf and that
109 #               file name and module name match)
110
111 PRE_SRCS    = $(wildcard *.lhs *.hs *.c *.prl *.lprl *.lit *.verb *.hsc)
112
113 HSC_SRCS     = $(filter %.hsc, $(PRE_SRCS))
114 DERIVED_SRCS = $(patsubst %.hsc, %.hs, $(HSC_SRCS)) \
115                $(patsubst %.hsc, %_hsc.c, $(HSC_SRCS)) \
116                $(patsubst %.hsc, %_hsc.h, $(HSC_SRCS))
117
118 # EXCLUDED_SRCS can be set in the Makefile, otherwise it defaults to empty.
119 EXCLUDED_HSC_SRCS     = $(filter %.hsc, $(EXCLUDED_SRCS))
120 EXCLUDED_DERIVED_SRCS = $(patsubst %.hsc, %.hs, $(EXCLUDED_HSC_SRCS)) \
121                         $(patsubst %.hsc, %_hsc.h, $(EXCLUDED_HSC_SRCS)) \
122                         $(patsubst %.hsc, %_hsc.c, $(HSC_SRCS))
123 # Exclude _hsc.c files; they get built as part of the cbits library,
124 # not part of the main library
125
126 CLOSED_EXCLUDED_SRCS  = $(sort $(EXCLUDED_SRCS) $(EXCLUDED_DERIVED_SRCS))
127
128 SRCS        = $(filter-out $(CLOSED_EXCLUDED_SRCS), \
129                 $(sort $(PRE_SRCS) $(DERIVED_SRCS)))
130
131 HS_SRCS     = $(filter %.lhs %.hs %.hc,$(sort $(SRCS) $(BOOT_SRCS)))
132 HS_OBJS     = $(addsuffix .$(way_)o,$(basename $(HS_SRCS)))
133 HS_HCS      = $(addsuffix .$(way_)hc,$(basename $(HS_SRCS)))
134 HS_SS       = $(addsuffix .$(way_)s,$(basename $(HS_SRCS)))
135 HS_IFACES   = $(addsuffix .$(way_)hi,$(basename $(HS_SRCS)))
136
137 HSC_C_OBJS  = $(addsuffix _hsc.$(way_)o,$(basename $(filter %.hsc,$(SRCS))))
138
139 C_SRCS      = $(filter %.c,$(SRCS))
140 C_OBJS      = $(addsuffix .$(way_)o,$(basename $(C_SRCS)))
141
142 # SCRIPT_SRCS:  list of raw script files (in literate form)
143 # SCRIPT_OBJS:  de-litted scripts
144 SCRIPT_SRCS=$(filter %.lprl,$(SRCS))
145 SCRIPT_OBJS=$(addsuffix .prl,$(basename $(SCRIPT_SRCS)))
146
147 OBJS=$(HS_OBJS) $(C_OBJS) $(SCRIPT_OBJS)
148
149 #
150 # Note that as long as you use the standard variables for setting
151 # which C & Haskell programs you want to work on, you don't have
152 # to set any of the clean variables - the default should do the Right
153 # Thing.
154 #
155
156 #------------------------------------------------------------------
157 #
158 # make depend defaults
159 #
160 # The default set of files for the dependency generators to work on
161 # is just their source equivalents.
162 #
163
164 ifneq "$(BootingFromHc)" "YES"
165 MKDEPENDHS_SRCS=$(HS_SRCS)
166 else
167 MKDEPENDHS_SRCS=
168 endif
169
170 MKDEPENDC_SRCS=$(C_SRCS)
171
172 #------------------------------------------------------------------
173 #
174 # make TAGS defaults
175 #
176 # The default set of files for the dependency generators to work on
177 # is just their source equivalents.
178 #
179 TAGS_HS_SRCS=$(HS_SRCS)
180 TAGS_C_SRCS=$(C_SRCS)
181
182 #------------------------------------------------------------------
183 # Clean file make-variables.
184 #
185 # The following three variables are used to control
186 # what gets removed when doing `make clean'
187 #
188 # MOSTLYCLEAN_FILES   object code etc., but not stuff
189 #                     that is slow to recompile and/or stable
190 #
191 # CLEAN_FILES  all files that are created by running make.
192 #
193 # MAINTAINER_CLEAN_FILES also clean out machine-generated files
194 #                        that may require extra tools to create.
195 #
196 #
197 MOSTLY_CLEAN_FILES += $(HS_OBJS) $(C_OBJS) $(HSC_C_OBJS)
198 CLEAN_FILES        += $(HS_PROG) $(C_PROG) $(SCRIPT_PROG) $(SCRIPT_LINK) \
199                       $(PROG) $(LIBRARY) $(HS_IFACES) $(HS_SS) a.out \
200                       $(DERIVED_SRCS)
201
202 # Don't clean the .hc files if we're bootstrapping
203 ifneq "$(BootingFromHc)" "YES"
204 CLEAN_FILES += $(HS_HCS)
205 endif
206
207 DIST_CLEAN_FILES += .depend
208 MAINTAINER_CLEAN_FILES += $(BOOT_SRCS)
209
210 #
211 # `Standard' set of files to clean out.
212 #
213 MOSTLY_CLEAN_FILES += \
214  *.CKP *.ln *.BAK *.bak .*.bak *.o core a.out errs ,* *.a .emacs_*  \
215  tags TAGS *.ind *.ilg *.idx *.idx-prev *.aux *.aux-prev *.dvi *.log \
216  *.toc *.lot *.lof *.blg *.cb *_stub.c *_stub.h *.raw_s *.a.list
217
218 #------------------------------------------------------------------
219 #
220 # Distribution setup
221 #
222 # Following variables are used for creating source and binary distributions:
223 #
224 #  SRC_DIST_NAME && BIN_DIST_NAME  -- the package names
225 #
226 #  SRC_DIST_FILES = list of extra files to include from a build tree into a source
227 #                   distribution
228 #
229 #  SRC_DIST_DIR  = what the current directory in the source/build tree
230 #                  maps to in the source distrib. tree being created.
231 #
232 SRC_DIST_NAME=$(ProjectNameShort)-$(ProjectVersion)
233
234 #
235 # Binary distributions proceeds as follows:
236 #
237 # Fromthe top of a build tree, you do `make binary-dist'. The
238 # canned rule for this  (in target.mk) will then do a binary
239 # install to a temporary directory before packaging it all up.
240 # The following variables guide the binary-dist:
241 #
242 #  BIN_DIST_TMPDIR= the absolute path to where the temporary directory
243 #                   structure of a binary distribution should be created.
244 #                   [Default: toplevel from which you issue `make binary-dist']
245 #  BIN_DIST_NAME=   what to call the thing.
246 #
247 #  BIN_DIST_DIRS=   at the toplevel, list of directories to descend into when
248 #                   building the distribution tree.
249 #
250 #  An extra directory variable that is set during bin-dists is $(bindist_top), giving
251 #  the abs. path to the root of the binary installation tree. (useful when punting
252 #  stuff like README and ANNOUNCE into a distrib, for instance)
253 #
254 #  The layout of a binary distribution is described in the
255 #  installation documentation.
256 #
257
258
259 # Directory in which DLLs are dumped so as not to get picked up by running
260 # programs (e.g. ghc or hsc) that run in the build tree
261
262 DLL_PEN = $(FPTOOLS_TOP)/dll
263