fairland: Tidy up comments
[empserver] / Make.mk
1 #
2 #   Empire - A multi-player, client/server Internet based war game.
3 #   Copyright (C) 1986-2020, 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-2017
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 version := $(shell cd $(srcdir) && build-aux/git-version-gen /dev/null)
51 ifeq ($(version),UNKNOWN)
52 $(warning cannot figure out version number, falling back to git hash)
53 version := UNKNOWN-$(shell cd $(srcdir) && git-rev-parse --verify --short HEAD || echo "UNKNOWN")
54 endif
55 else
56 include $(srcdir)/sources.mk
57 version := $(shell cat $(srcdir)/.tarball-version || echo "UNKNOWN")
58 endif
59 ifeq ($(version),UNKNOWN)
60 $(error cannot figure out version number)
61 endif
62 dirs := $(sort $(dir $(src)))
63 csrc := $(filter %.c, $(src))
64 tsrc := $(filter %.t, $(src))
65 man6 := $(filter man/%.6, $(src))
66 builtins := $(filter src/lib/global/%.config, $(src))
67
68 # Info subjects
69 include $(srcdir)/info/subjects.mk
70
71 # Abbreviations
72 topics := $(patsubst %.t,%,$(notdir $(tsrc)))
73 info := $(topics) $(subjects) all TOP
74 scripts := $(srcdir)/src/scripts
75 depcomp := $(SHELL) $(srcdir)/depcomp
76 tarball := $(SHELL) -e $(scripts)/tarball
77 econfig := $(sysconfdir)/empire/econfig
78 schedule := $(sysconfdir)/empire/schedule
79 gamedir := $(localstatedir)/empire
80 edatadir := $(datadir)/empire
81 builtindir := $(edatadir)/builtin
82 einfodir := $(edatadir)/info.nr
83 ehtmldir := $(edatadir)/info.html
84 client/w32 := arpa/inet.h netdb.h netinet/in.h sys/time.h sys/socket.h  \
85 sys/uio.h unistd.h w32io.c w32sockets.c w32types.h
86
87 # Abbreviate make output
88 # Run make with a V=1 parameter for full output.
89 ifneq ($(origin V),command line)
90 V:=
91 endif
92 # $(call quiet-command COMMAND,ABBREV) runs COMMAND, but prints only ABBREV.
93 # Recursively expanded so that variables in COMMAND and ABBREV work.
94 ifneq ($V$(findstring s,$(MAKEFLAGS)),)
95 quiet-command = $1
96 else
97 quiet-command = @echo $2 && $1
98 endif
99
100 # How to substitute Autoconf output variables
101 # Recursively expanded so that $@ and $< work.
102 subst.in = sed \
103         -e 's?@configure_input\@?$(notdir $@): Generated from $(notdir $<) by make.?g' \
104         -e 's?@builtindir\@?$(builtindir)?g'    \
105         -e 's?@econfig\@?$(econfig)?g'          \
106         -e 's?@einfodir\@?$(einfodir)?g'        \
107         -e 's?@gamedir\@?$(gamedir)?g'          \
108         -e 's/@EMPIREHOST\@/$(EMPIREHOST)/g'    \
109         -e 's/@EMPIREPORT\@/$(EMPIREPORT)/g'
110
111 # Generated files
112 # See `Cleanliness' below
113 # Generated makefiles, distributed by dist-source from $(srcdir):
114 mk := sources.mk
115 # Generated by Autoconf, not distributed:
116 ac := config.h config.log config.status info.html info.nr lib stamp-h
117 ac += $(basename $(filter %.in, $(src)))
118 ac += $(srcdir)/autom4te.cache $(srcdir)/src/client/autom4te.cache
119 # distributed by dist-source from $(srcdir):
120 acdist := aclocal.m4 config.h.in configure stamp-h.in
121 # Object files:
122 obj := $(csrc:.c=.o) $(filter %.o, $(ac:.c=.o))
123 # Dependencies:
124 deps := $(obj:.o=.d)
125 # Library archives:
126 libs := $(addprefix lib/, libcommon.a libgen.a libglobal.a)
127 # Programs:
128 util := $(addprefix src/util/, $(addsuffix $(EXEEXT), empdump empsched fairland files pconfig))
129 client := src/client/empire$(EXEEXT)
130 server := src/server/emp_server$(EXEEXT)
131 # Info subjects:
132 tsubj := $(addprefix info/, $(addsuffix .t, $(subjects)))
133 # Formatted info:
134 info.nr := $(addprefix info.nr/, $(info))
135 info.html := $(addprefix info.html/, $(addsuffix .html, $(info)))
136 info.all := $(info.nr) $(info.html) info.ps info/stamp-subj
137 # Tests
138 # sandbox
139
140 # Conditionally generated files:
141 empth_obj := src/lib/empthread/io.o
142 empth_lib :=
143 ifeq ($(empthread),LWP)
144 empth_obj += src/lib/empthread/lwp.o src/lib/empthread/posix.o
145 empth_lib += lib/liblwp.a
146 endif
147 ifeq ($(empthread),POSIX)
148 empth_obj += src/lib/empthread/pthread.o src/lib/empthread/posix.o
149 endif
150 ifeq ($(empthread),Windows)
151 empth_obj += src/lib/empthread/ntthread.o
152 endif
153
154 ifeq ($(empthread),Windows)     # really: W32, regardless of thread package
155 libs += lib/libw32.a
156 $(client): lib/libw32.a
157 endif
158
159 # Cleanliness
160 # Each generated file should be in one of the following sets.
161 # Removed by clean:
162 clean := $(obj) $(deps) $(libs) $(util) $(client) $(server) $(tsubj)    \
163 info/toc info/TOP.t $(info.all) $(empth_obj) $(empth_lib) sandbox
164 # Removed by distclean:
165 distclean := $(ac)
166 ifeq ($(revctrl),git)
167 distclean += $(addprefix $(srcdir)/, $(mk))
168 endif
169 # Distributed by dist-source from $(srcdir):
170 src_distgen := $(acdist) $(mk)
171
172 # Compiler flags
173 CPPFLAGS += -I$(srcdir)/include -I.
174 ifeq ($(empthread),Windows)     # really: W32, regardless of thread package
175 CPPFLAGS += -I$(srcdir)/src/lib/w32
176 endif
177 $(client): LDLIBS := $(LIBS_client)
178 $(server): LDLIBS := $(LIBS_server)
179
180
181 ### Advertized goals
182
183 .PHONY: all
184 all: $(util) $(client) $(server) info
185
186 .PHONY: info html
187 info: $(info.nr)
188 html: $(info.html)
189
190 .PHONY: clean
191 clean:
192         $(call quiet-command,rm -rf $(clean),CLEAN)
193
194 .PHONY: distclean
195 distclean: clean
196         $(call quiet-command,rm -rf $(distclean),DISTCLEAN)
197
198 .PHONY: install
199 install: all installdirs
200         $(INSTALL_PROGRAM) $(util) $(server) $(sbindir)
201         $(INSTALL_PROGRAM) $(client) $(bindir)
202         $(INSTALL) -m 444 $(addprefix $(srcdir)/, $(builtins)) $(builtindir)
203         rm -f $(einfodir)/*
204         $(INSTALL_DATA) $(info.nr) $(einfodir)
205         $(INSTALL_DATA) $(addprefix $(srcdir)/, $(man6)) $(mandir)/man6
206         sed -e '1,/^$$/d' -e 's/^/# /g' <$(srcdir)/doc/schedule >$(schedule).dist
207         echo >>$(schedule).dist
208         echo 'every 10 minutes' >>$(schedule).dist
209         [ -e $(schedule) ] || mv $(schedule).dist $(schedule)
210         if [ -e $(econfig) ]; then                                      \
211             echo "Attempting to update your econfig";                   \
212             if src/util/pconfig $(econfig) >$(econfig).dist; then       \
213                 if cmp -s $(econfig) $(econfig).dist; then              \
214                     echo "$(econfig) unchanged";                        \
215                     rm $(econfig).dist;                                 \
216                 fi;                                                     \
217             else                                                        \
218                 echo "Your $(econfig) doesn't work";                    \
219                 src/util/pconfig >$(econfig).dist;                      \
220             fi;                                                         \
221             if [ -e $(econfig).dist ]; then                             \
222                 echo "Check out $(econfig).dist";                       \
223             fi;                                                         \
224         else                                                            \
225             src/util/pconfig >$(econfig);                               \
226         fi
227
228 .PHONY: installdirs
229 installdirs:
230         mkdir -p $(sbindir) $(bindir) $(builtindir) $(einfodir) $(mandir)/man6 $(dir $(econfig)) $(gamedir)
231
232 .PHONY: install-html
233 install-html: html
234         mkdir -p $(ehtmldir)
235         rm -f $(ehtmldir)/*
236         $(INSTALL_DATA) $(info.html) $(ehtmldir)
237
238 .PHONY: uninstall
239 uninstall:
240         rm -f $(addprefix $(sbindir)/, $(notdir $(util) $(server)))
241         rm -f $(addprefix $(bindir)/, $(notdir $(client)))
242         rm -rf $(builtindir) $(einfodir) $(ehtmldir)
243         rmdir $(edatadir)
244         rm -f $(addprefix $(mandir)/man6/, $(notdir $(man6)))
245         @echo "$(dir $(econfig)) and $(gamedir) not removed, you may wish to remove it manually."
246
247 .PHONY: dist
248 dist: dist-source dist-client dist-info
249
250 .PHONY: check check-accept _check
251 check check-accept: _check
252 check:        export EMPIRE_CHECK_ACCEPT :=
253 check-accept: export EMPIRE_CHECK_ACCEPT := y
254 _check: all
255         @echo "Warning: test suite is immature and needs work." >&2
256         $(srcdir)/tests/files-test $(srcdir)
257         $(srcdir)/tests/fairland-test $(srcdir)
258         $(srcdir)/tests/info-test $(srcdir)
259 ifeq ($(empthread),LWP)
260         $(srcdir)/tests/smoke-test $(srcdir)
261         $(srcdir)/tests/actofgod-test $(srcdir)
262         $(srcdir)/tests/build-test $(srcdir)
263         $(srcdir)/tests/load-tend-test $(srcdir)
264         $(srcdir)/tests/navi-march-test $(srcdir)
265         $(srcdir)/tests/fire-test $(srcdir)
266         $(srcdir)/tests/torpedo-test $(srcdir)
267         $(srcdir)/tests/bridgefall-test $(srcdir)
268         $(srcdir)/tests/retreat-test $(srcdir)
269         $(srcdir)/tests/update-test $(srcdir)
270         $(srcdir)/tests/version-test $(srcdir)
271 else
272         @echo "$(srcdir)/tests/smoke-test SKIPPED"
273         @echo "$(srcdir)/tests/actofgod-test SKIPPED"
274         @echo "$(srcdir)/tests/build-test SKIPPED"
275         @echo "$(srcdir)/tests/load-tend-test SKIPPED"
276         @echo "$(srcdir)/tests/navi-march-test SKIPPED"
277         @echo "$(srcdir)/tests/fire-test SKIPPED"
278         @echo "$(srcdir)/tests/torpedo-test SKIPPED"
279         @echo "$(srcdir)/tests/bridgefall-test SKIPPED"
280         @echo "$(srcdir)/tests/retreat-test SKIPPED"
281         @echo "$(srcdir)/tests/update-test SKIPPED"
282         @echo "$(srcdir)/tests/version-test SKIPPED"
283 endif
284         $(srcdir)/tests/empdump-test $(srcdir)
285
286
287 ### Implicit rules
288
289 # Compile with dependencies as side effect, i.e. create %.d in
290 # addition to %.o.
291 ifeq ($(how_to_dep),fast)
292 %.o: %.c
293         $(call quiet-command,$(COMPILE.c) -MT $@ -MMD -MP -MF $(@:.o=.d) \
294         $(OUTPUT_OPTION) $< || { rm -f $(@:.o=.d) $@; false; },CC $@)
295 # Why the rm?  If gcc's preprocessor chokes, it leaves an empty
296 # dependency file behind, and doesn't touch the object file.  If an
297 # old object file exists, and is newer than the .c file, make will
298 # then consider the object file up-to-date.
299 endif
300 ifeq ($(how_to_dep),depcomp)
301 %.o: %.c
302         $(call quiet-command,source='$<' object='$@' depfile='$(@:.o=.d)' \
303         $(CCDEPMODE) $(depcomp) $(COMPILE.c) $(OUTPUT_OPTION) $<,CC $@)
304 endif
305 # Cancel the rule to compile %.c straight to %, it interferes with
306 # automatic dependency generation
307 %: %.c
308
309 %$(EXEEXT): %.o
310         $(call quiet-command,$(LINK.o) $^ $(LOADLIBES) $(LDLIBS) -o $@,LINK $@)
311
312
313 info.nr/%: info/%.t
314         $(call quiet-command,$(NROFF) $(filter %.MAC, $^) $< | $(AWK) -f $(filter %/Blank.awk, $^) >$@ && test -s $@,NROFF $@)
315 # Pipes in make are a pain.  The "test -s" catches obvious errors.
316
317 info.html/%.html: info/%.t
318         $(call quiet-command,perl $(srcdir)/info/emp2html.pl $(info) <$< >$@,GEN $@)
319
320
321 ### Explicit rules
322
323 # Compilation
324
325 $(server): $(filter src/server/% src/lib/commands/% src/lib/player/% src/lib/subs/% src/lib/update/%, $(obj)) $(empth_obj) $(empth_lib) $(libs)
326         $(call quiet-command,$(LINK.o) $^ $(LOADLIBES) $(LDLIBS) -o $@,LINK $@)
327
328 $(client): $(filter src/client/%, $(obj)) src/lib/global/version.o src/lib/gen/fnameat.o
329         $(call quiet-command,$(LINK.o) $^ $(LOADLIBES) $(LDLIBS) -o $@,LINK $@)
330
331 $(util): $(libs)
332
333 lib/libcommon.a: $(filter src/lib/common/%, $(obj))
334 lib/libgen.a: $(filter src/lib/gen/%, $(obj))
335 lib/libglobal.a: $(filter src/lib/global/%, $(obj))
336 lib/liblwp.a: $(filter src/lib/lwp/%, $(obj))
337 lib/libw32.a: $(filter src/lib/w32/%, $(obj))
338
339 $(libs) $(empth_lib):
340         $(call quiet-command,$(AR) rc $@ $?,AR $@)
341         $(RANLIB) $@
342
343 src/lib/global/version.o: CPPFLAGS += -DVERSION='"$(version)"'
344 src/lib/global/version.o: $(src)
345
346 ifneq ($(revctrl),git)
347 $(srcdir)/.tarball-version: $(src)
348         v=`sed -e 's/-dirty$$//' <$@`; echo "$$v-dirty" >$@
349 # Force Make to start over after updating .tarball-version, so that
350 # $(version) gets the new value
351 $(srcdir)/.dirty-stamp: $(srcdir)/.tarball-version
352         >$@
353 include $(srcdir)/.dirty-stamp
354 endif
355
356 # Info formatting
357
358 # mksubj.pl reads $(tsrc) and writes $(tsubj).  A naive rule
359 #     $(tsubj): $(tsrc)
360 #           COMMAND
361 # runs COMMAND once for each target.  That's because multiple targets
362 # in an explicit rule is just a shorthand for one rule per target,
363 # each with the same prerequisites and commands.  Use a stamp file.
364 $(tsubj) info/toc: info/stamp-subj ;
365 info/stamp-subj: info/mksubj.pl $(tsrc)
366         $(call quiet-command,perl $(srcdir)/info/mksubj.pl $(subjects) $(filter %.t, $^),GEN '$(tsubj) info/toc')
367         >$@
368
369 info/TOP.t: info/mktop.pl info/subjects.mk
370         $(call quiet-command,perl $(srcdir)/info/mktop.pl $@ $(subjects),GEN $@)
371
372 info.nr/all: $(filter-out info.nr/all, $(info.nr))
373         >$@
374         (cd info.nr && LC_ALL=C ls -C $(info)) >>$@
375
376 info.html/all.html: info.nr/all info/ls2html.pl
377         expand $< | perl $(srcdir)/info/ls2html.pl >$@
378
379 $(info.nr): info/CRT.MAC info/INFO.MAC info/Blank.awk
380
381 $(info.html): info/emp2html.pl
382
383 info.ps: info/TROFF.MAC info/INFO.MAC info/TOP.t $(tsubj) $(tsrc)
384         groff $^ >$@
385
386 # Distributing
387
388 .PHONY: dist-source
389 dist-source: $(addprefix $(srcdir)/, $(src_distgen))
390         $(tarball) -x $(srcdir)/src/scripts/gen-tarball-version $(TARNAME) $(version) -C $(srcdir) $(src_distgen) $(src)
391
392 ifeq ($(revctrl),git)
393 .PHONY: $(srcdir)/sources.mk
394 $(srcdir)/sources.mk:
395         $(call quiet-command,echo "src := $(src)" >$@,GEN $@)
396 endif
397
398 .PHONY: dist-client
399 dist-client:
400         $(tarball) -x $(srcdir)/src/scripts/gen-client-configure        \
401         $(TARNAME)-client $(version)                                    \
402         -C $(srcdir)/src/client                                         \
403                 $(notdir $(filter src/client/%, $(src)))                \
404         -C $(srcdir)/include fnameat.h proto.h version.h                \
405         -C $(srcdir)/src/lib/global version.c                           \
406         -C $(srcdir)/src/lib/gen fnameat.c                              \
407         -C $(srcdir)/src/lib $(addprefix w32/, $(client/w32))           \
408         -C $(srcdir)/man empire.6                                       \
409         -C $(srcdir)/build-aux install-sh                               \
410         -C $(srcdir) COPYING INSTALL                                    \
411                 m4/ax_lib_socket_nsl.m4 m4/my_lib_readline.m4           \
412                 m4/my_terminfo.m4 m4/my_windows_api.m4
413
414 .PHONY: dist-info
415 dist-info: info html
416         $(tarball) $(TARNAME)-info-text $(version) -C info.nr $(info)
417         $(tarball) $(TARNAME)-info-html $(version) -C info.html $(addsuffix .html, $(info))
418
419 # Dependencies
420
421 ifneq ($(deps),)
422 -include $(deps)
423 endif
424
425
426 # Automatic remake of configuration
427 # See (autoconf)Automatic Remaking.
428 # This requires sufficiently recent versions of autoconf and automake
429
430 $(srcdir)/configure: configure.ac aclocal.m4
431         cd $(srcdir) && autoconf
432
433 # autoheader might not change config.h.in, so touch a stamp file.
434 $(srcdir)/config.h.in: stamp-h.in ;
435 $(srcdir)/stamp-h.in: configure.ac aclocal.m4
436         cd $(srcdir) && autoheader
437         touch $@
438
439 $(srcdir)/aclocal.m4: $(filter m4/%.m4, $(src))
440         cd $(srcdir) && aclocal -I m4
441
442 # config.status might not change config.h; use the stamp file.
443 config.h: stamp-h ;
444 stamp-h: config.h.in config.status
445         ./config.status config.h stamp-h
446
447 GNUmakefile: GNUmakefile.in config.status
448         ./config.status $@
449
450 config.status: configure
451         ./config.status --recheck
452
453 src/lib/global/path.c src/client/ipglob.c: %: %.in GNUmakefile Make.mk
454         $(call quiet-command,$(subst.in) <$< >$@,GEN $@)