X-Git-Url: https://jxself.org/git/?a=blobdiff_plain;f=Makefile;h=afd81a099480bd0da6d103abb8e44fe8e6d45f66;hb=refs%2Fheads%2Fmaster;hp=1b88b81d8e8398c7b693eaff3dca3688ff3e9763;hpb=24d7aeaf8a1dc13034884044139728045604fc37;p=open-adventure.git

diff --git a/Makefile b/Makefile
index 1b88b81..0da7fb8 100644
--- a/Makefile
+++ b/Makefile
@@ -1,23 +1,158 @@
-# NOTE: This version of Adventure was developed by the author on private
-# equipment, and has been ported to Sun for entertainment purposes only.
-# The author (Don Woods) retains full rights to the work.
+# Makefile for the open-source release of adventure 2.5
 
-OBJS=main.o init.o actions1.o actions2.o score.o misc.o datime.o
+# SPDX-FileCopyrightText: (C) Eric S. Raymond <esr@thyrsus.com>
+# SPDX-License-Identifier: BSD-2-Clause
+
+# To build with save/resume disabled, pass CFLAGS="-DADVENT_NOSAVE"
+# To build with auto-save/resume enabled, pass CFLAGS="-DADVENT_AUTOSAVE"
+
+VERS=$(shell sed -n <NEWS.adoc '/^[0-9]/s/:.*//p' | head -1)
+
+.PHONY: debug indent release refresh dist linty html clean
+.PHONY: check coverage
+
+CC?=gcc
+CCFLAGS+=-std=c99 -D_DEFAULT_SOURCE -DVERSION=\"$(VERS)\" -O2 -D_FORTIFY_SOURCE=2 -fstack-protector-all $(CFLAGS) -g $(EXTRA)
+LIBS=$(shell pkg-config --libs libedit)
+INC+=$(shell pkg-config --cflags libedit)
+
+# LLVM/Clang on macOS seems to need -ledit flag for linking
+UNAME_S := $(shell uname -s)
+ifeq ($(UNAME_S),Darwin)
+    LIBS += -ledit
+endif
+
+OBJS=main.o init.o actions.o score.o misc.o saveresume.o
+CHEAT_OBJS=cheat.o init.o actions.o score.o misc.o saveresume.o
+SOURCES=$(OBJS:.o=.c) advent.h adventure.yaml Makefile control make_dungeon.py templates/*.tpl
 
 .c.o:
-	gcc -O $(DBX) -c $<
+	$(CC) $(CCFLAGS) $(INC) $(DBX) -c $<
+
+advent:	$(OBJS) dungeon.o
+	$(CC) $(CCFLAGS) $(DBX) -o advent $(OBJS) dungeon.o $(LDFLAGS) $(LIBS)
+
+main.o:	 	advent.h dungeon.h
+
+init.o:	 	advent.h dungeon.h
+
+actions.o:	advent.h dungeon.h
+
+score.o:	advent.h dungeon.h
+
+misc.o:		advent.h dungeon.h
+
+cheat.o:	advent.h dungeon.h
+
+saveresume.o:	advent.h dungeon.h
+
+dungeon.o:	dungeon.c dungeon.h
+	$(CC) $(CCFLAGS) $(DBX) -c dungeon.c
+
+dungeon.c dungeon.h: make_dungeon.py adventure.yaml advent.h templates/*.tpl
+	./make_dungeon.py
+
+clean:
+	rm -f *.o advent cheat *.html *.gcno *.gcda
+	rm -f dungeon.c dungeon.h
+	rm -f README advent.6 MANIFEST *.tar.gz
+	rm -f *~
+	rm -f .*~
+	rm -rf coverage advent.info
+	cd tests; $(MAKE) --quiet clean
+
+
+cheat: $(CHEAT_OBJS) dungeon.o
+	$(CC) $(CCFLAGS) $(DBX) -o cheat $(CHEAT_OBJS) dungeon.o $(LDFLAGS) $(LIBS)
+
+CSUPPRESSIONS = --suppress=missingIncludeSystem --suppress=invalidscanf
+cppcheck:
+	@-cppcheck -I. --quiet --template gcc -UPROP_SET_SEEN --enable=all $(CSUPPRESSIONS) *.[ch]
+
+pylint:
+	@-pylint --score=n *.py */*.py
+
+check: advent cheat pylint cppcheck
+	cd tests; $(MAKE) --quiet
+
+reflow:
+	@clang-format --style="{IndentWidth: 8, UseTab: ForIndentation}" -i $$(find . -name "*.[ch]")
+	@black --quiet *.py
+
+# Requires gcov, lcov, libasan6, and libubsan1
+# The last two are Ubuntu names, might vary on other distributions.
+# After this, run your browser on coverage/open-adventure/index.html
+# to see coverage results. Browse coverage/adventure.yaml.html
+# to see symbol coverage over the YAML file.
+coverage: clean debug
+	cd tests; $(MAKE) coverage --quiet
+
+# Note: to suppress the footers with timestamps being generated in HTML,
+# we use "-a nofooter".
+# To debug asciidoc problems, you may need to run "xmllint --nonet --noout --valid"
+# on the intermediate XML that throws an error.
+.SUFFIXES: .html .adoc .6
+
+.adoc.6:
+	asciidoctor -D. -a nofooter -b manpage $<
+.adoc.html:
+	asciidoctor -D. -a nofooter -a webfonts! $<
+
+html: advent.html history.html hints.html
+
+# README.adoc exists because that filename is magic on GitLab.
+DOCS=COPYING NEWS.adoc README.adoc advent.adoc history.adoc notes.adoc hints.adoc advent.6 INSTALL.adoc
+TESTFILES=tests/*.log tests/*.chk tests/README tests/decheck tests/Makefile
+
+# Can't use GNU tar's --transform, needs to build under Alpine Linux.
+# This is a requirement for testing dist in GitLab's CI pipeline
+advent-$(VERS).tar.gz: $(SOURCES) $(DOCS)
+	@find $(SOURCES) $(DOCS) $(TESTFILES) -print | sed s:^:advent-$(VERS)/: >MANIFEST
+	@(ln -s . advent-$(VERS))
+	(tar -T MANIFEST -czvf advent-$(VERS).tar.gz)
+	@(rm advent-$(VERS))
 
-adventure:	$(OBJS)
-	gcc -O $(DBX) -o adventure $(OBJS)
+release: advent-$(VERS).tar.gz advent.html history.html hints.html notes.html
+	shipper version=$(VERS) | sh -e -x
 
-main.o:		misc.h funcs.h
+refresh: advent.html notes.html history.html
+	shipper -N -w version=$(VERS) | sh -e -x
 
-init.o:		misc.h main.h share.h funcs.h
+dist: advent-$(VERS).tar.gz
 
-actions1.o:	misc.h main.h share.h funcs.h
+linty: CCFLAGS += -W
+linty: CCFLAGS += -Wall
+linty: CCFLAGS += -Wextra
+linty: CCGLAGS += -Wpedantic
+linty: CCFLAGS += -Wundef
+linty: CCFLAGS += -Wstrict-prototypes
+linty: CCFLAGS += -Wmissing-prototypes
+linty: CCFLAGS += -Wmissing-declarations
+linty: CCFLAGS += -Wshadow
+linty: CCFLAGS += -Wnull-dereference
+linty: CCFLAGS += -Wjump-misses-init
+linty: CCFLAGS += -Wfloat-equal
+linty: CCFLAGS += -Wcast-align
+linty: CCFLAGS += -Wwrite-strings
+linty: CCFLAGS += -Waggregate-return
+linty: CCFLAGS += -Wcast-qual
+linty: CCFLAGS += -Wswitch-enum
+linty: CCFLAGS += -Wwrite-strings
+linty: CCFLAGS += -Wunreachable-code
+linty: CCFLAGS += -Winit-self
+linty: CCFLAGS += -Wpointer-arith
+linty: advent cheat
 
-actions2.o:	misc.h main.h share.h funcs.h
+# These seem to be more modern options for enabling coverage testing.
+# Documenting them here in case a future version bump disables --coverage.
+#debug: CCFLAGS += -ftest-coverage
+#debug: CCFLAGS += -fprofile-arcs
 
-score.o:	misc.h main.h share.h
+debug: CCFLAGS += -O0
+debug: CCFLAGS += --coverage
+debug: CCFLAGS += -ggdb
+debug: CCFLAGS += -U_FORTIFY_SOURCE
+debug: CCFLAGS += -fsanitize=address
+debug: CCFLAGS += -fsanitize=undefined
+debug: linty
 
-misc.o:		misc.h main.h