tests/retreat: New; exercising retreat
[empserver] / Make.mk
1 #
2 #   Empire - A multi-player, client/server Internet based war game.
3 #   Copyright (C) 1986-2014, Dave Pare, Jeff Bailey, Thomas Ruschak,
4 #                 Ken Stevens, Steve McClure, Markus Armbruster
5 #
6 #   Empire is free software: you can redistribute it and/or modify
7 #   it under the terms of the GNU General Public License as published by
8 #   the Free Software Foundation, either version 3 of the License, or
9 #   (at your option) any later version.
10 #
11 #   This program is distributed in the hope that it will be useful,
12 #   but WITHOUT ANY WARRANTY; without even the implied warranty of
13 #   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 #   GNU General Public License for more details.
15 #
16 #   You should have received a copy of the GNU General Public License
17 #   along with this program.  If not, see <http://www.gnu.org/licenses/>.
18 #
19 #   ---
20 #
21 #   See files README, COPYING and CREDITS in the root of the source
22 #   tree for related information and legal notices.  It is expected
23 #   that future projects/authors will amend these files as needed.
24 #
25 #   ---
26 #
27 #   Make.mk: The real Makefile, included by GNUmakefile
28 #
29 #   Known contributors to this file:
30 #      Markus Armbruster, 2005-2014
31 #
32
33 # This makefile was inspired by `Recursive Make Considered Harmful',
34 # Peter Miller, 1997.
35 # http://miller.emu.id.au/pmiller/books/rmch/
36
37 # Recursively expanded variables are occasionally useful, but can be
38 # slow and tricky.  Do not use them gratuitously.  If you don't
39 # understand this, always use `:=' rather than `='.
40
41 # Default goal
42 all:
43
44 # Delete target on error.  Every Makefile should have this.
45 .DELETE_ON_ERROR:
46
47 # Source files
48 ifeq ($(revctrl),git)
49 src := $(shell cd $(srcdir) && git ls-files | uniq)
50 else
51 include $(srcdir)/sources.mk
52 endif
53 dirs := $(sort $(dir $(src)))
54 csrc := $(filter %.c, $(src))
55 tsrc := $(filter %.t, $(src))
56 man6 := $(filter man/%.6, $(src))
57 builtins := $(filter src/lib/global/%.config, $(src))
58
59 # Info subjects
60 include $(srcdir)/info/subjects.mk
61
62 # Abbreviations
63 topics := $(patsubst %.t,%,$(notdir $(tsrc)))
64 info := $(topics) $(subjects) all TOP
65 scripts := $(srcdir)/src/scripts
66 depcomp := $(SHELL) $(srcdir)/depcomp
67 tarball := $(SHELL) -e $(scripts)/tarball
68 econfig := $(sysconfdir)/empire/econfig
69 schedule := $(sysconfdir)/empire/schedule
70 gamedir := $(localstatedir)/empire
71 edatadir := $(datadir)/empire
72 builtindir := $(edatadir)/builtin
73 einfodir := $(edatadir)/info.nr
74 ehtmldir := $(edatadir)/info.html
75 client/w32 := arpa/inet.h netdb.h netinet/in.h sys/time.h sys/socket.h  \
76 sys/uio.h unistd.h w32io.c w32sockets.c w32types.h
77
78 # Abbreviate make output
79 # Run make with a V=1 parameter for full output.
80 ifneq ($(origin V),command line)
81 V:=
82 endif
83 # $(call quiet-command COMMAND,ABBREV) runs COMMAND, but prints only ABBREV.
84 # Recursively expanded so that variables in COMMAND and ABBREV work.
85 ifneq ($V$(findstring s,$(MAKEFLAGS)),)
86 quiet-command = $1
87 else
88 quiet-command = @echo $2 && $1
89 endif
90
91 # How to substitute Autoconf output variables
92 # Recursively expanded so that $@ and $< work.
93 subst.in = sed \
94         -e 's?@configure_input\@?$(notdir $@): Generated from $(notdir $<) by make.?g' \
95         -e 's?@builtindir\@?$(builtindir)?g'    \
96         -e 's?@econfig\@?$(econfig)?g'          \
97         -e 's?@einfodir\@?$(einfodir)?g'        \
98         -e 's?@gamedir\@?$(gamedir)?g'          \
99         -e 's/@EMPIREHOST\@/$(EMPIREHOST)/g'    \
100         -e 's/@EMPIREPORT\@/$(EMPIREPORT)/g'
101
102 # Generated files
103 # See `Cleanliness' below
104 mk :=
105 ifeq ($(revctrl),git)
106 mk += $(srcdir)/sources.mk
107 endif
108 # Generated by Autoconf, not distributed:
109 ac := config.h config.log config.status info.html info.nr lib stamp-h
110 ac += $(basename $(filter %.in, $(src)))
111 ac += $(srcdir)/autom4te.cache $(srcdir)/src/client/autom4te.cache
112 # distributed by dist-source from $(srcdir):
113 acdist := aclocal.m4 config.h.in configure stamp-h.in
114 # distributed by dist-client from $(srcdir):
115 acdistcli := $(addprefix src/client/, aclocal.m4 config.h.in configure)
116 # Object files:
117 obj := $(csrc:.c=.o) $(filter %.o, $(ac:.c=.o))
118 # Dependencies:
119 deps := $(obj:.o=.d)
120 # Library archives:
121 libs := $(addprefix lib/, libcommon.a libgen.a libglobal.a)
122 # Programs:
123 util := $(addprefix src/util/, $(addsuffix $(EXEEXT), empdump empsched fairland files pconfig))
124 client := src/client/empire$(EXEEXT)
125 server := src/server/emp_server$(EXEEXT)
126 # Info subjects:
127 tsubj := $(addprefix info/, $(addsuffix .t, $(subjects)))
128 ttop := info/TOP.t
129 # Formatted info:
130 info.nr := $(addprefix info.nr/, $(info))
131 info.html := $(addprefix info.html/, $(addsuffix .html, $(info)))
132 info.all := $(info.nr) $(info.html) info.ps info/stamp-subj
133 # Tests
134 # sandbox
135
136 # Conditionally generated files:
137 empth_obj := src/lib/empthread/io.o
138 empth_lib :=
139 ifeq ($(empthread),LWP)
140 empth_obj += src/lib/empthread/lwp.o src/lib/empthread/posix.o
141 empth_lib += lib/liblwp.a
142 endif
143 ifeq ($(empthread),POSIX)
144 empth_obj += src/lib/empthread/pthread.o src/lib/empthread/posix.o
145 endif
146 ifeq ($(empthread),Windows)
147 empth_obj += src/lib/empthread/ntthread.o
148 endif
149
150 ifeq ($(empthread),Windows)     # really: W32, regardless of thread package
151 libs += lib/libw32.a
152 $(client): lib/libw32.a
153 endif
154
155 # Cleanliness
156 # Each generated file should be in one of the following sets.
157 # Removed by clean:
158 clean := $(obj) $(deps) $(libs) $(util) $(client) $(server) $(tsubj)    \
159 $(ttop) $(info.all) $(empth_obj) $(empth_lib) sandbox
160 # Removed by distclean:
161 distclean := $(ac) $(mk)
162 # Distributed by dist-source from $(srcdir):
163 src_distgen := $(acdist)
164 # Distributed by dist-client from $(srcdir)/src/client; removed by distclean:
165 cli_distgen := $(acdistcli)
166
167 # Compiler flags
168 CPPFLAGS += -I$(srcdir)/include -I.
169 ifeq ($(empthread),Windows)     # really: W32, regardless of thread package
170 CPPFLAGS += -I$(srcdir)/src/lib/w32
171 endif
172 ifeq ($(have_gcc),yes)
173 CFLAGS += -fno-builtin-carg     # conflicts with our carg()
174 CFLAGS += -fno-common
175 CFLAGS += -Wall -W -Wno-unused-parameter -Wpointer-arith        \
176 -Wstrict-prototypes -Wmissing-prototypes -Wnested-externs       \
177 -Wredundant-decls
178 endif
179 $(client): LDLIBS := $(LIBS_client)
180 $(server): LDLIBS := $(LIBS_server)
181
182
183 ### Advertized goals
184
185 .PHONY: all
186 all: $(util) $(client) $(server) info
187
188 .PHONY: info html
189 info: $(info.nr)
190 html: $(info.html)
191
192 .PHONY: clean
193 clean:
194         $(call quiet-command,rm -rf $(clean),CLEAN)
195
196 .PHONY: distclean
197 distclean: clean
198         $(call quiet-command,rm -rf $(distclean) $(cli_distgen),DISTCLEAN)
199
200 .PHONY: install
201 install: all installdirs
202         $(INSTALL_PROGRAM) $(util) $(server) $(sbindir)
203         $(INSTALL_PROGRAM) $(client) $(bindir)
204         $(INSTALL) -m 444 $(addprefix $(srcdir)/, $(builtins)) $(builtindir)
205         rm -f $(einfodir)/*
206         $(INSTALL_DATA) $(info.nr) $(einfodir)
207         $(INSTALL_DATA) $(addprefix $(srcdir)/, $(man6)) $(mandir)/man6
208         sed -e '1,/^$$/d' -e 's/^/# /g' <$(srcdir)/doc/schedule >$(schedule).dist
209         echo >>$(schedule).dist
210         echo 'every 10 minutes' >>$(schedule).dist
211         [ -e $(schedule) ] || mv $(schedule).dist $(schedule)
212         if [ -e $(econfig) ]; then                                      \
213             echo "Attempting to update your econfig";                   \
214             if src/util/pconfig $(econfig) >$(econfig).dist; then       \
215                 if cmp -s $(econfig) $(econfig).dist; then              \
216                     echo "$(econfig) unchanged";                        \
217                     rm $(econfig).dist;                                 \
218                 fi;                                                     \
219             else                                                        \
220                 echo "Your $(econfig) doesn't work";                    \
221                 src/util/pconfig >$(econfig).dist;                      \
222             fi;                                                         \
223             if [ -e $(econfig).dist ]; then                             \
224                 echo "Check out $(econfig).dist";                       \
225             fi;                                                         \
226         else                                                            \
227             src/util/pconfig >$(econfig);                               \
228         fi
229
230 .PHONY: installdirs
231 installdirs:
232         mkdir -p $(sbindir) $(bindir) $(builtindir) $(einfodir) $(mandir)/man6 $(dir $(econfig)) $(gamedir)
233
234 .PHONY: install-html
235 install-html: html
236         mkdir -p $(ehtmldir)
237         rm -f $(ehtmldir)/*
238         $(INSTALL_DATA) $(info.html) $(ehtmldir)
239
240 .PHONY: uninstall
241 uninstall:
242         rm -f $(addprefix $(sbindir)/, $(notdir $(util) $(server)))
243         rm -f $(addprefix $(bindir)/, $(notdir $(client)))
244         rm -rf $(builtindir) $(einfodir) $(ehtmldir)
245         rmdir $(edatadir)
246         rm -f $(addprefix $(mandir)/man6/, $(notdir $(man6)))
247         @echo "$(dir $(econfig)) and $(gamedir) not removed, you may wish to remove it manually."
248
249 .PHONY: dist
250 dist: dist-source dist-client dist-info
251
252 .PHONY: check check-accept _check
253 check check-accept: _check
254 check:        export override EMPIRE_CHECK_ACCEPT :=
255 check-accept: export override EMPIRE_CHECK_ACCEPT := y
256 _check: all
257         @echo "Warning: test suite is immature and needs work." >&2
258         $(srcdir)/tests/files-test $(srcdir)
259         $(srcdir)/tests/fairland-test $(srcdir)
260         $(srcdir)/tests/info-test $(srcdir)
261 ifeq ($(empthread),LWP)
262         $(srcdir)/tests/smoke-test $(srcdir)
263         $(srcdir)/tests/actofgod-test $(srcdir)
264         $(srcdir)/tests/build-test $(srcdir)
265         $(srcdir)/tests/fire-test $(srcdir)
266         $(srcdir)/tests/bridgefall-test $(srcdir)
267         $(srcdir)/tests/retreat-test $(srcdir)
268 else
269         @echo "$(srcdir)/tests/smoke-test SKIPPED"
270         @echo "$(srcdir)/tests/actofgod-test SKIPPED"
271         @echo "$(srcdir)/tests/build-test SKIPPED"
272         @echo "$(srcdir)/tests/fire-test SKIPPED"
273         @echo "$(srcdir)/tests/bridgefall-test SKIPPED"
274         @echo "$(srcdir)/tests/retreat-test SKIPPED"
275 endif
276
277
278 ### Implicit rules
279
280 # Compile with dependencies as side effect, i.e. create %.d in
281 # addition to %.o.
282 ifeq ($(how_to_dep),fast)
283 %.o: %.c
284         $(call quiet-command,$(COMPILE.c) -MT $@ -MMD -MP -MF $(@:.o=.d) \
285         $(OUTPUT_OPTION) $< || { rm -f $(@:.o=.d) $@; false; },CC $@)
286 # Why the rm?  If gcc's preprocessor chokes, it leaves an empty
287 # dependency file behind, and doesn't touch the object file.  If an
288 # old object file exists, and is newer than the .c file, make will
289 # then consider the object file up-to-date.
290 endif
291 ifeq ($(how_to_dep),depcomp)
292 %.o: %.c
293         $(call quiet-command,source='$<' object='$@' depfile='$(@:.o=.d)' \
294         $(CCDEPMODE) $(depcomp) $(COMPILE.c) $(OUTPUT_OPTION) $<,CC $@)
295 endif
296 # Cancel the rule to compile %.c straight to %, it interferes with
297 # automatic dependency generation
298 %: %.c
299
300 %$(EXEEXT): %.o
301         $(call quiet-command,$(LINK.o) $^ $(LOADLIBES) $(LDLIBS) -o $@,LINK $@)
302
303
304 info.nr/%: info/%.t
305         $(call quiet-command,$(NROFF) $(filter %.MAC, $^) $< | $(AWK) -f $(filter %/Blank.awk, $^) >$@ && test -s $@,NROFF $@)
306 # Pipes in make are a pain.  The "test -s" catches obvious errors.
307
308 info.html/%.html: info/%.t
309         $(call quiet-command,perl $(srcdir)/info/emp2html.pl $(info) <$< >$@,GEN $@)
310
311
312 ### Explicit rules
313
314 # Compilation
315
316 $(server): $(filter src/server/% src/lib/commands/% src/lib/player/% src/lib/subs/% src/lib/update/%, $(obj)) $(empth_obj) $(empth_lib) $(libs)
317         $(call quiet-command,$(LINK.o) $^ $(LOADLIBES) $(LDLIBS) -o $@,LINK $@)
318
319 $(client): $(filter src/client/%, $(obj)) src/lib/global/version.o
320         $(call quiet-command,$(LINK.o) $^ $(LOADLIBES) $(LDLIBS) -o $@,LINK $@)
321
322 $(util): $(libs)
323
324 lib/libcommon.a: $(filter src/lib/common/%, $(obj))
325 lib/libgen.a: $(filter src/lib/gen/%, $(obj))
326 lib/libglobal.a: $(filter src/lib/global/%, $(obj))
327 lib/liblwp.a: $(filter src/lib/lwp/%, $(obj))
328 lib/libw32.a: $(filter src/lib/w32/%, $(obj))
329
330 $(libs) $(empth_lib):
331         $(call quiet-command,$(AR) rc $@ $?,AR $@)
332         $(RANLIB) $@
333
334 # Info formatting
335
336 # mksubj.pl reads $(tsrc) and writes $(tsubj).  A naive rule
337 #     $(tsubj): $(tsrc)
338 #           COMMAND
339 # runs COMMAND once for each target.  That's because multiple targets
340 # in an explicit rule is just a shorthand for one rule per target,
341 # each with the same prerequisites and commands.  Use a stamp file.
342 $(tsubj) info/toc: info/stamp-subj ;
343 info/stamp-subj: info/mksubj.pl $(tsrc)
344         $(call quiet-command,perl $(srcdir)/info/mksubj.pl $(subjects) $(filter %.t, $^),GEN '$(tsubj) info/toc')
345         >$@
346
347 $(ttop): info/mktop.pl info/subjects.mk
348         $(call quiet-command,perl $(srcdir)/info/mktop.pl $@ $(subjects),GEN $@)
349
350 info.nr/all: $(filter-out info.nr/all, $(info.nr))
351         >$@
352         (cd info.nr && LC_ALL=C ls -C $(info)) >>$@
353
354 info.html/all.html: info.nr/all info/ls2html.pl
355         expand $< | perl $(srcdir)/info/ls2html.pl >$@
356
357 $(info.nr): info/CRT.MAC info/INFO.MAC info/Blank.awk
358
359 $(info.html): info/emp2html.pl
360
361 info.ps: info/TROFF.MAC info/INFO.MAC $(ttop) $(tsubj) $(tsrc)
362         groff $^ >$@
363
364 # Distributing
365
366 .PHONY: dist-source
367 dist-source: $(src_distgen)
368 ifeq ($(revctrl),git)
369         echo "src := $(src)" >$(srcdir)/sources.mk
370 endif
371         $(tarball) $(TARNAME)-$(VERSION) -C $(srcdir) $(src_distgen) $(src) sources.mk
372
373 .PHONY: dist-client
374 dist-client: $(cli_distgen)
375         $(tarball) $(TARNAME)-client-$(VERSION)                         \
376         -C $(srcdir)/src/client                                         \
377                 $(notdir $(filter src/client/%, $(src)) $(cli_distgen)) \
378         -C $(srcdir)/include proto.h version.h                          \
379         -C $(srcdir)/src/lib/global version.c                           \
380         -C $(srcdir)/src/lib $(addprefix w32/, $(client/w32))           \
381         -C $(srcdir)/man empire.6                                       \
382         -C $(srcdir)/build-aux install-sh                               \
383         -C $(srcdir) COPYING INSTALL
384
385 .PHONY: dist-info
386 dist-info: info html
387         $(tarball) $(TARNAME)-info-text-$(VERSION) -C info.nr $(info)
388         $(tarball) $(TARNAME)-info-html-$(VERSION) -C info.html $(addsuffix .html, $(info))
389
390 # Dependencies
391
392 ifneq ($(deps),)
393 -include $(deps)
394 endif
395
396
397 # Automatic remake of configuration
398 # See (autoconf)Automatic Remaking.
399 # This requires sufficiently recent versions of autoconf and automake
400
401 $(srcdir)/configure: configure.ac aclocal.m4
402         cd $(srcdir) && autoconf
403
404 # autoheader might not change config.h.in, so touch a stamp file.
405 $(srcdir)/config.h.in: stamp-h.in ;
406 $(srcdir)/stamp-h.in: configure.ac aclocal.m4
407         cd $(srcdir) && autoheader
408         touch $@
409
410 $(srcdir)/aclocal.m4: $(filter m4/%.m4, $(src))
411         cd $(srcdir) && aclocal -I m4
412
413 # config.status might not change config.h; use the stamp file.
414 config.h: stamp-h ;
415 stamp-h: config.h.in config.status
416         ./config.status config.h stamp-h
417
418 GNUmakefile: GNUmakefile.in config.status
419         ./config.status $@
420
421 config.status: configure
422         ./config.status --recheck
423
424 src/lib/global/path.c src/client/ipglob.c: %: %.in GNUmakefile Make.mk
425         $(call quiet-command,$(subst.in) <$< >$@,GEN $@)
426
427
428 # Make files for standalone client distribution
429
430 $(srcdir)/src/client/configure: src/client/configure.ac src/client/aclocal.m4
431         cd $(dir $@) && autoconf
432
433 $(srcdir)/src/client/config.h.in: src/client/configure.ac src/client/aclocal.m4
434         cd $(dir $@) && autoheader
435         touch $@
436
437 $(srcdir)/src/client/aclocal.m4: m4/ax_lib_socket_nsl.m4 m4/my_terminfo.m4 m4/my_windows_api.m4
438         cat $^ >$@