Make: Drop $(ttop), use its value directly
[empserver] / Make.mk
1 #
2 #   Empire - A multi-player, client/server Internet based war game.
3 #   Copyright (C) 1986-2016, 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-2016
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 # Formatted info:
129 info.nr := $(addprefix info.nr/, $(info))
130 info.html := $(addprefix info.html/, $(addsuffix .html, $(info)))
131 info.all := $(info.nr) $(info.html) info.ps info/stamp-subj
132 # Tests
133 # sandbox
134
135 # Conditionally generated files:
136 empth_obj := src/lib/empthread/io.o
137 empth_lib :=
138 ifeq ($(empthread),LWP)
139 empth_obj += src/lib/empthread/lwp.o src/lib/empthread/posix.o
140 empth_lib += lib/liblwp.a
141 endif
142 ifeq ($(empthread),POSIX)
143 empth_obj += src/lib/empthread/pthread.o src/lib/empthread/posix.o
144 endif
145 ifeq ($(empthread),Windows)
146 empth_obj += src/lib/empthread/ntthread.o
147 endif
148
149 ifeq ($(empthread),Windows)     # really: W32, regardless of thread package
150 libs += lib/libw32.a
151 $(client): lib/libw32.a
152 endif
153
154 # Cleanliness
155 # Each generated file should be in one of the following sets.
156 # Removed by clean:
157 clean := $(obj) $(deps) $(libs) $(util) $(client) $(server) $(tsubj)    \
158 info/toc info/TOP.t $(info.all) $(empth_obj) $(empth_lib) sandbox
159 # Removed by distclean:
160 distclean := $(ac) $(mk)
161 # Distributed by dist-source from $(srcdir):
162 src_distgen := $(acdist)
163 # Distributed by dist-client from $(srcdir)/src/client; removed by distclean:
164 cli_distgen := $(acdistcli)
165
166 # Compiler flags
167 CPPFLAGS += -I$(srcdir)/include -I.
168 ifeq ($(empthread),Windows)     # really: W32, regardless of thread package
169 CPPFLAGS += -I$(srcdir)/src/lib/w32
170 endif
171 $(client): LDLIBS := $(LIBS_client)
172 $(server): LDLIBS := $(LIBS_server)
173
174
175 ### Advertized goals
176
177 .PHONY: all
178 all: $(util) $(client) $(server) info
179
180 .PHONY: info html
181 info: $(info.nr)
182 html: $(info.html)
183
184 .PHONY: clean
185 clean:
186         $(call quiet-command,rm -rf $(clean),CLEAN)
187
188 .PHONY: distclean
189 distclean: clean
190         $(call quiet-command,rm -rf $(distclean) $(cli_distgen),DISTCLEAN)
191
192 .PHONY: install
193 install: all installdirs
194         $(INSTALL_PROGRAM) $(util) $(server) $(sbindir)
195         $(INSTALL_PROGRAM) $(client) $(bindir)
196         $(INSTALL) -m 444 $(addprefix $(srcdir)/, $(builtins)) $(builtindir)
197         rm -f $(einfodir)/*
198         $(INSTALL_DATA) $(info.nr) $(einfodir)
199         $(INSTALL_DATA) $(addprefix $(srcdir)/, $(man6)) $(mandir)/man6
200         sed -e '1,/^$$/d' -e 's/^/# /g' <$(srcdir)/doc/schedule >$(schedule).dist
201         echo >>$(schedule).dist
202         echo 'every 10 minutes' >>$(schedule).dist
203         [ -e $(schedule) ] || mv $(schedule).dist $(schedule)
204         if [ -e $(econfig) ]; then                                      \
205             echo "Attempting to update your econfig";                   \
206             if src/util/pconfig $(econfig) >$(econfig).dist; then       \
207                 if cmp -s $(econfig) $(econfig).dist; then              \
208                     echo "$(econfig) unchanged";                        \
209                     rm $(econfig).dist;                                 \
210                 fi;                                                     \
211             else                                                        \
212                 echo "Your $(econfig) doesn't work";                    \
213                 src/util/pconfig >$(econfig).dist;                      \
214             fi;                                                         \
215             if [ -e $(econfig).dist ]; then                             \
216                 echo "Check out $(econfig).dist";                       \
217             fi;                                                         \
218         else                                                            \
219             src/util/pconfig >$(econfig);                               \
220         fi
221
222 .PHONY: installdirs
223 installdirs:
224         mkdir -p $(sbindir) $(bindir) $(builtindir) $(einfodir) $(mandir)/man6 $(dir $(econfig)) $(gamedir)
225
226 .PHONY: install-html
227 install-html: html
228         mkdir -p $(ehtmldir)
229         rm -f $(ehtmldir)/*
230         $(INSTALL_DATA) $(info.html) $(ehtmldir)
231
232 .PHONY: uninstall
233 uninstall:
234         rm -f $(addprefix $(sbindir)/, $(notdir $(util) $(server)))
235         rm -f $(addprefix $(bindir)/, $(notdir $(client)))
236         rm -rf $(builtindir) $(einfodir) $(ehtmldir)
237         rmdir $(edatadir)
238         rm -f $(addprefix $(mandir)/man6/, $(notdir $(man6)))
239         @echo "$(dir $(econfig)) and $(gamedir) not removed, you may wish to remove it manually."
240
241 .PHONY: dist
242 dist: dist-source dist-client dist-info
243
244 .PHONY: check check-accept _check
245 check check-accept: _check
246 check:        export EMPIRE_CHECK_ACCEPT :=
247 check-accept: export EMPIRE_CHECK_ACCEPT := y
248 _check: all
249         @echo "Warning: test suite is immature and needs work." >&2
250         $(srcdir)/tests/files-test $(srcdir)
251         $(srcdir)/tests/fairland-test $(srcdir)
252         $(srcdir)/tests/info-test $(srcdir)
253 ifeq ($(empthread),LWP)
254         $(srcdir)/tests/smoke-test $(srcdir)
255         $(srcdir)/tests/actofgod-test $(srcdir)
256         $(srcdir)/tests/build-test $(srcdir)
257         $(srcdir)/tests/navi-march-test $(srcdir)
258         $(srcdir)/tests/fire-test $(srcdir)
259         $(srcdir)/tests/torpedo-test $(srcdir)
260         $(srcdir)/tests/bridgefall-test $(srcdir)
261         $(srcdir)/tests/retreat-test $(srcdir)
262         $(srcdir)/tests/update-test $(srcdir)
263         $(srcdir)/tests/version-test $(srcdir)
264 else
265         @echo "$(srcdir)/tests/smoke-test SKIPPED"
266         @echo "$(srcdir)/tests/actofgod-test SKIPPED"
267         @echo "$(srcdir)/tests/build-test SKIPPED"
268         @echo "$(srcdir)/tests/navi-march-test SKIPPED"
269         @echo "$(srcdir)/tests/fire-test SKIPPED"
270         @echo "$(srcdir)/tests/torpedo-test SKIPPED"
271         @echo "$(srcdir)/tests/bridgefall-test SKIPPED"
272         @echo "$(srcdir)/tests/retreat-test SKIPPED"
273         @echo "$(srcdir)/tests/update-test SKIPPED"
274         @echo "$(srcdir)/tests/version-test SKIPPED"
275 endif
276         $(srcdir)/tests/empdump-test $(srcdir)
277
278
279 ### Implicit rules
280
281 # Compile with dependencies as side effect, i.e. create %.d in
282 # addition to %.o.
283 ifeq ($(how_to_dep),fast)
284 %.o: %.c
285         $(call quiet-command,$(COMPILE.c) -MT $@ -MMD -MP -MF $(@:.o=.d) \
286         $(OUTPUT_OPTION) $< || { rm -f $(@:.o=.d) $@; false; },CC $@)
287 # Why the rm?  If gcc's preprocessor chokes, it leaves an empty
288 # dependency file behind, and doesn't touch the object file.  If an
289 # old object file exists, and is newer than the .c file, make will
290 # then consider the object file up-to-date.
291 endif
292 ifeq ($(how_to_dep),depcomp)
293 %.o: %.c
294         $(call quiet-command,source='$<' object='$@' depfile='$(@:.o=.d)' \
295         $(CCDEPMODE) $(depcomp) $(COMPILE.c) $(OUTPUT_OPTION) $<,CC $@)
296 endif
297 # Cancel the rule to compile %.c straight to %, it interferes with
298 # automatic dependency generation
299 %: %.c
300
301 %$(EXEEXT): %.o
302         $(call quiet-command,$(LINK.o) $^ $(LOADLIBES) $(LDLIBS) -o $@,LINK $@)
303
304
305 info.nr/%: info/%.t
306         $(call quiet-command,$(NROFF) $(filter %.MAC, $^) $< | $(AWK) -f $(filter %/Blank.awk, $^) >$@ && test -s $@,NROFF $@)
307 # Pipes in make are a pain.  The "test -s" catches obvious errors.
308
309 info.html/%.html: info/%.t
310         $(call quiet-command,perl $(srcdir)/info/emp2html.pl $(info) <$< >$@,GEN $@)
311
312
313 ### Explicit rules
314
315 # Compilation
316
317 $(server): $(filter src/server/% src/lib/commands/% src/lib/player/% src/lib/subs/% src/lib/update/%, $(obj)) $(empth_obj) $(empth_lib) $(libs)
318         $(call quiet-command,$(LINK.o) $^ $(LOADLIBES) $(LDLIBS) -o $@,LINK $@)
319
320 $(client): $(filter src/client/%, $(obj)) src/lib/global/version.o
321         $(call quiet-command,$(LINK.o) $^ $(LOADLIBES) $(LDLIBS) -o $@,LINK $@)
322
323 $(util): $(libs)
324
325 lib/libcommon.a: $(filter src/lib/common/%, $(obj))
326 lib/libgen.a: $(filter src/lib/gen/%, $(obj))
327 lib/libglobal.a: $(filter src/lib/global/%, $(obj))
328 lib/liblwp.a: $(filter src/lib/lwp/%, $(obj))
329 lib/libw32.a: $(filter src/lib/w32/%, $(obj))
330
331 $(libs) $(empth_lib):
332         $(call quiet-command,$(AR) rc $@ $?,AR $@)
333         $(RANLIB) $@
334
335 # Info formatting
336
337 # mksubj.pl reads $(tsrc) and writes $(tsubj).  A naive rule
338 #     $(tsubj): $(tsrc)
339 #           COMMAND
340 # runs COMMAND once for each target.  That's because multiple targets
341 # in an explicit rule is just a shorthand for one rule per target,
342 # each with the same prerequisites and commands.  Use a stamp file.
343 $(tsubj) info/toc: info/stamp-subj ;
344 info/stamp-subj: info/mksubj.pl $(tsrc)
345         $(call quiet-command,perl $(srcdir)/info/mksubj.pl $(subjects) $(filter %.t, $^),GEN '$(tsubj) info/toc')
346         >$@
347
348 info/TOP.t: info/mktop.pl info/subjects.mk
349         $(call quiet-command,perl $(srcdir)/info/mktop.pl $@ $(subjects),GEN $@)
350
351 info.nr/all: $(filter-out info.nr/all, $(info.nr))
352         >$@
353         (cd info.nr && LC_ALL=C ls -C $(info)) >>$@
354
355 info.html/all.html: info.nr/all info/ls2html.pl
356         expand $< | perl $(srcdir)/info/ls2html.pl >$@
357
358 $(info.nr): info/CRT.MAC info/INFO.MAC info/Blank.awk
359
360 $(info.html): info/emp2html.pl
361
362 info.ps: info/TROFF.MAC info/INFO.MAC info/TOP.t $(tsubj) $(tsrc)
363         groff $^ >$@
364
365 # Distributing
366
367 .PHONY: dist-source
368 dist-source: $(src_distgen)
369 ifeq ($(revctrl),git)
370         echo "src := $(src)" >$(srcdir)/sources.mk
371 endif
372         $(tarball) $(TARNAME)-$(VERSION) -C $(srcdir) $(src_distgen) $(src) sources.mk
373
374 .PHONY: dist-client
375 dist-client: $(cli_distgen)
376         $(tarball) $(TARNAME)-client-$(VERSION)                         \
377         -C $(srcdir)/src/client                                         \
378                 $(notdir $(filter src/client/%, $(src)) $(cli_distgen)) \
379         -C $(srcdir)/include proto.h version.h                          \
380         -C $(srcdir)/src/lib/global version.c                           \
381         -C $(srcdir)/src/lib $(addprefix w32/, $(client/w32))           \
382         -C $(srcdir)/man empire.6                                       \
383         -C $(srcdir)/build-aux install-sh                               \
384         -C $(srcdir) COPYING INSTALL
385
386 .PHONY: dist-info
387 dist-info: info html
388         $(tarball) $(TARNAME)-info-text-$(VERSION) -C info.nr $(info)
389         $(tarball) $(TARNAME)-info-html-$(VERSION) -C info.html $(addsuffix .html, $(info))
390
391 # Dependencies
392
393 ifneq ($(deps),)
394 -include $(deps)
395 endif
396
397
398 # Automatic remake of configuration
399 # See (autoconf)Automatic Remaking.
400 # This requires sufficiently recent versions of autoconf and automake
401
402 $(srcdir)/configure: configure.ac aclocal.m4
403         cd $(srcdir) && autoconf
404
405 # autoheader might not change config.h.in, so touch a stamp file.
406 $(srcdir)/config.h.in: stamp-h.in ;
407 $(srcdir)/stamp-h.in: configure.ac aclocal.m4
408         cd $(srcdir) && autoheader
409         touch $@
410
411 $(srcdir)/aclocal.m4: $(filter m4/%.m4, $(src))
412         cd $(srcdir) && aclocal -I m4
413
414 # config.status might not change config.h; use the stamp file.
415 config.h: stamp-h ;
416 stamp-h: config.h.in config.status
417         ./config.status config.h stamp-h
418
419 GNUmakefile: GNUmakefile.in config.status
420         ./config.status $@
421
422 config.status: configure
423         ./config.status --recheck
424
425 src/lib/global/path.c src/client/ipglob.c: %: %.in GNUmakefile Make.mk
426         $(call quiet-command,$(subst.in) <$< >$@,GEN $@)
427
428
429 # Make files for standalone client distribution
430
431 $(srcdir)/src/client/configure: src/client/configure.ac src/client/aclocal.m4
432         cd $(dir $@) && autoconf
433
434 $(srcdir)/src/client/config.h.in: src/client/configure.ac src/client/aclocal.m4
435         cd $(dir $@) && autoheader
436         touch $@
437
438 $(srcdir)/src/client/aclocal.m4: m4/ax_lib_socket_nsl.m4 m4/my_terminfo.m4 m4/my_windows_api.m4
439         cat $^ >$@