Provide very much needed recommendations on how to write good error
[wine] / Make.rules.in
1 # Global rules shared by all makefiles     -*-Makefile-*-
2 #
3 # Each individual makefile must define the following variables:
4 # TOPSRCDIR    : top-level source directory
5 # TOPOBJDIR    : top-level object directory
6 # SRCDIR       : source directory for this module
7 # MODULE       : name of the module being built
8 #
9 # Each individual makefile may define the following additional variables:
10 # C_SRCS       : C sources for the module
11 # C_SRCS16     : 16-bit C sources for the module
12 # RC_SRCS      : resource source files
13 # SPEC_SRCS    : interface definition files
14 # EXTRA_SRCS   : extra source files for make depend
15 # EXTRA_OBJS   : extra object files
16 # IMPORTS      : dlls to import
17 # DELAYIMPORTS : dlls to import in delayed mode
18 # SUBDIRS      : subdirectories that contain a Makefile
19 # EXTRASUBDIRS : subdirectories that do not contain a Makefile
20 # INSTALLSUBDIRS : subdirectories to run make install/uninstall into
21
22 # First some useful definitions
23
24 SHELL     = /bin/sh
25 CC        = @CC@
26 CPP       = @CPP@
27 CFLAGS    = @CFLAGS@ $(EXTRACFLAGS)
28 OPTIONS   = @OPTIONS@ -D_REENTRANT
29 LIBS      = @LIBS@
30 YACC      = @YACC@
31 LEX       = @LEX@
32 LEXLIB    = @LEXLIB@
33 EXEEXT    = @EXEEXT@
34 OBJEXT    = @OBJEXT@
35 LIBEXT    = @LIBEXT@
36 DLLEXT    = @DLLEXT@
37 IMPLIBEXT = @IMPLIBEXT@
38 CROSSCC   = @CROSSCC@
39 LDSHARED  = @LDSHARED@
40 DLLTOOL   = @DLLTOOL@
41 DLLWRAP   = @DLLWRAP@
42 AR        = @AR@ rc
43 RANLIB    = @RANLIB@
44 STRIP     = @STRIP@
45 WINDRES   = @WINDRES@
46 LN        = @LN@
47 LN_S      = @LN_S@
48 TOOLSDIR  = @TOOLSDIR@
49 DIVINCL   = -I$(SRCDIR) -I. -I$(TOPSRCDIR)/include -I$(TOPOBJDIR)/include $(EXTRAINCL)
50 ALLCFLAGS = $(DIVINCL) $(CFLAGS) $(DEFS) $(OPTIONS)
51 AS        = @AS@
52 LD        = @LD@
53 LDFLAGS   = @LDFLAGS@
54 LDCOMBINE = $(LD) -r
55 RM        = rm -f
56 MV        = mv
57 C2MAN     = @C2MAN@
58 MANSPECS  = -w $(TOPSRCDIR)/dlls/gdi/gdi32.spec \
59             -w $(TOPSRCDIR)/dlls/user/user32.spec \
60             -w $(TOPSRCDIR)/dlls/comctl32/comctl32.spec \
61             -w $(TOPSRCDIR)/dlls/commdlg/comdlg32.spec \
62             -w $(TOPSRCDIR)/dlls/kernel/kernel32.spec
63 LINT      = @LINT@
64 LINTFLAGS = @LINTFLAGS@
65 ALLLINTFLAGS = $(LINTFLAGS) $(DEFS) $(OPTIONS) $(DIVINCL)
66 MKINSTALLDIRS= $(TOPSRCDIR)/tools/mkinstalldirs
67 WINAPI_CHECK = $(TOPSRCDIR)/tools/winapi_check/winapi_check
68 WINEWRAPPER  = $(TOPSRCDIR)/tools/winewrapper
69 RUNTEST      = $(TOPSRCDIR)/tools/runtest
70 WINEBUILD    = $(TOOLSDIR)/tools/winebuild/winebuild
71 MAKEDEP      = $(TOOLSDIR)/tools/makedep
72 WRC          = $(TOOLSDIR)/tools/wrc/wrc
73 WMC          = $(TOOLSDIR)/tools/wmc/wmc
74 WIDL         = $(TOOLSDIR)/tools/widl/widl
75 WRCFLAGS     = -J -m $(EXTRAWRCFLAGS)
76 LDPATH       = @LDPATH@
77 DLLDIR       = $(TOPOBJDIR)/dlls
78 LIBWINE      = -L$(TOPOBJDIR)/library -lwine
79 LIBUNICODE   = -L$(TOPOBJDIR)/unicode -lwine_unicode
80 LIBUUID      = -L$(TOPOBJDIR)/ole -lwine_uuid
81
82 @SET_MAKE@
83
84 # Installation infos
85
86 INSTALL         = @INSTALL@ $(INSTALL_FLAGS)
87 INSTALL_PROGRAM = @INSTALL_PROGRAM@ $(INSTALL_PROGRAM_FLAGS)
88 INSTALL_SCRIPT  = @INSTALL_SCRIPT@ $(INSTALL_SCRIPT_FLAGS)
89 INSTALL_DATA    = @INSTALL_DATA@ $(INSTALL_DATA_FLAGS)
90 prefix          = @prefix@
91 exec_prefix     = @exec_prefix@
92 bindir          = @bindir@
93 libdir          = @libdir@
94 datadir         = @datadir@
95 infodir         = @infodir@
96 mandir          = @mandir@
97 sysconfdir      = @sysconfdir@
98 includedir      = @includedir@/wine
99 dlldir          = @libdir@/wine
100 prog_manext     = 1
101 conf_manext     = 5
102 CLEAN_FILES     = *.o *.a *.so *.ln *.$(LIBEXT) \\\#*\\\# *~ *% .\\\#* *.bak *.orig *.rej \
103                   *.flc *.spec.c *.spec.def *.glue.c *.dbg.c y.tab.c y.tab.h @LEX_OUTPUT_ROOT@.c core
104
105 OBJS = $(C_SRCS:.c=.o) $(EXTRA_OBJS)
106
107 RCOBJS = $(RC_SRCS:.rc=.res.o)
108 LINTS  = $(C_SRCS:.c=.ln)
109
110 # Implicit rules
111
112 .SUFFIXES: .mc .rc .mc.rc .res .res.o .spec .spec.c .spec.def .ok .cross.o
113
114 .c.o:
115         $(CC) -c $(ALLCFLAGS) -o $@ $<
116
117 .c.cross.o:
118         $(CROSSCC) -c $(ALLCFLAGS) -o $@ $<
119
120 .s.o:
121         $(AS) -o $@ $<
122
123 .mc.mc.rc:
124         $(LDPATH) $(WMC) -i -U -H /dev/null -o $@ $<
125
126 .rc.res:
127         $(LDPATH) $(WRC) $(WRCFLAGS) $(DIVINCL) -o $@ $<
128
129 .res.res.o:
130         $(WINDRES) -i $< -o $@
131
132 .spec.spec.c:
133         $(LDPATH) $(WINEBUILD) $(DEFS) -o $@ -M $(MODULE) --spec $<
134
135 .spec.spec.def:
136         $(LDPATH) $(WINEBUILD) $(DEFS) -o $@ --def $<
137
138 .c.ln:
139         $(LINT) -c $(ALLLINTFLAGS) $< || ( $(RM) $@ && exit 1 )
140
141 .c.ok:
142         $(RUNTEST) $(RUNTESTFLAGS) $< && touch $@
143
144 # 'all' target first in case the enclosing Makefile didn't define any target
145
146 all: Makefile
147
148 filter:
149         @$(TOPSRCDIR)/tools/winapi/make_filter --make $(MAKE) all
150
151 .PHONY: all filter
152
153 # Rule for main module debug channels
154
155 $(MODULE).dbg.c: $(C_SRCS) $(C_SRCS16) $(WINEBUILD)
156         $(LDPATH) $(WINEBUILD) $(DEFS) -o $@ --debug -C$(SRCDIR) $(C_SRCS) $(C_SRCS16)
157
158 # Rule to rebuild the tools
159
160 $(MAKEDEP) $(WIDL) $(WINEBUILD) $(WMC) $(WRC):
161         cd $(TOOLSDIR)/tools && $(MAKE) `basename $@`
162
163 # Rules for makefile
164
165 Makefile: Makefile.in $(TOPSRCDIR)/configure
166         @echo Makefile is older than $?, please rerun $(TOPSRCDIR)/configure
167         @exit 1
168
169 # Rules for auto documentation
170
171 $(SUBDIRS:%=%/__man__): dummy
172         cd `dirname $@` && $(MAKE) man
173
174 man: $(C_SRCS) $(SUBDIRS:%=%/__man__)
175         if [ -n "$(C_SRCS)" ]; then $(MKINSTALLDIRS) $(TOPOBJDIR)/documentation/man3w; for i in $(C_SRCS); do $(C2MAN) -L -o $(TOPOBJDIR)/documentation/man3w -S3w $(DIVINCL) $(MANSPECS) $$i; done; fi
176
177 $(SUBDIRS:%=%/__doc_html__): dummy
178         cd `dirname $@` && $(MAKE) doc-html
179
180 doc-html: $(C_SRCS) $(SUBDIRS:%=%/__doc_html__)
181         if [ -n "$(C_SRCS)" ]; then $(MKINSTALLDIRS) $(TOPOBJDIR)/documentation/html; for i in $(C_SRCS); do $(C2MAN) -L -o $(TOPOBJDIR)/documentation/html -Th -iwindows.h  $(DIVINCL) $(MANSPECS) $$i; done; fi
182
183 .PHONY: man doc-html $(SUBDIRS:%=%/__man__) $(SUBDIRS:%=%/__doc_html__)
184
185 # Rule for linting
186
187 $(MODULE).ln : $(LINTS)
188         if test "$(LINTS)" ; \
189         then \
190                 $(LINT) $(ALLLINTFLAGS) -o$(MODULE) $(LINTS) ; \
191                 $(MV) llib-l$(MODULE).ln $(MODULE).ln ; \
192         else \
193                 $(LINT) $(ALLLINTFLAGS) -C$(MODULE) /dev/null ; \
194         fi
195
196 lint:: $(MODULE).ln
197
198 # Rules for Windows API checking
199
200 winapi_check:: dummy
201         $(WINAPI_CHECK) $(WINAPI_CHECK_FLAGS) $(WINAPI_CHECK_EXTRA_FLAGS) .
202
203 .PHONY: winapi_check
204
205 # Rules for dependencies
206
207 $(SUBDIRS:%=%/__depend__): $(MAKEDEP) dummy
208         cd `dirname $@` && $(MAKE) depend
209
210 depend: $(MAKEDEP) $(SUBDIRS:%=%/__depend__)
211         $(MAKEDEP) $(DIVINCL) -C$(SRCDIR) $(C_SRCS) $(C_SRCS16) $(RC_SRCS) $(RC_SRCS16) $(MC_SRCS) $(EXTRA_SRCS)
212
213 .PHONY: depend $(SUBDIRS:%=%/__depend__)
214
215 # Rules for cleaning
216
217 $(SUBDIRS:%=%/__clean__): dummy
218         cd `dirname $@` && $(MAKE) clean
219
220 $(SUBDIRS:%=%/__testclean__): dummy
221         cd `dirname $@` && $(MAKE) testclean
222
223 $(EXTRASUBDIRS:%=%/__clean__): dummy
224         -cd `dirname $@` && $(RM) $(CLEAN_FILES)
225
226 testclean:: $(SUBDIRS:%=%/__testclean__)
227
228 clean:: $(SUBDIRS:%=%/__clean__) $(EXTRASUBDIRS:%=%/__clean__)
229         $(RM) $(CLEAN_FILES) $(RC_SRCS:.rc=.res) $(RC_SRCS16:.rc=.res) $(MC_SRCS:.mc=.mc.rc) $(PROGRAMS)
230
231 .PHONY: clean testclean $(SUBDIRS:%=%/__clean__) $(SUBDIRS:%=%/__testclean__) $(EXTRASUBDIRS:%=%/__clean__)
232
233 # Rules for installing
234
235 $(INSTALLSUBDIRS:%=%/__install__): dummy
236         cd `dirname $@` && $(MAKE) install
237
238 $(INSTALLSUBDIRS:%=%/__uninstall__): dummy
239         cd `dirname $@` && $(MAKE) uninstall
240
241 install:: $(INSTALLSUBDIRS:%=%/__install__)
242
243 uninstall:: $(INSTALLSUBDIRS:%=%/__uninstall__)
244
245 .PHONY: install install-lib install-dev uninstall \
246         $(INSTALLSUBDIRS:%=%/__install__) $(INSTALLSUBDIRS:%=%/__uninstall__)
247
248 # Rules for checking that no imports are missing
249
250 $(SUBDIRS:%=%/__checklink__): dummy
251         @cd `dirname $@` && $(MAKE) checklink
252
253 .PHONY: checklink $(SUBDIRS:%=%/__checklink__)
254
255 # Rules for testing
256
257 $(SUBDIRS:%=%/__test__): dummy
258         @cd `dirname $@` && $(MAKE) test
259
260 $(SUBDIRS:%=%/__crosstest__): dummy
261         @cd `dirname $@` && $(MAKE) crosstest
262
263 .PHONY: check test crosstest $(SUBDIRS:%=%/__test__) $(SUBDIRS:%=%/__crosstest__)
264
265 # Misc. rules
266
267 $(SPEC_SRCS:.spec=.spec.c): $(WINEBUILD)
268
269 $(RC_SRCS:.rc=.res): $(WRC)
270
271 $(RC_SRCS16:.rc=.res): $(WRC)
272
273 $(MC_SRCS:.mc=.mc.rc): $(WMC)
274
275 $(SUBDIRS): dummy
276         @cd $@ && $(MAKE)
277
278 dummy:
279
280 .PHONY: dummy $(SUBDIRS)
281
282 # End of global rules