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

diff --git a/Makefile b/Makefile
index 1c18a86..0da7fb8 100644
--- a/Makefile
+++ b/Makefile
@@ -1,99 +1,107 @@
 # Makefile for the open-source release of adventure 2.5
 
-# Note: If you're building from the repository rather than the source tarball,
-# do this to get the linenoise library where you can use it:
-#
-# git submodule update --recursive --remote --init
-#
-# Therafter, you can update it like this:
-#
-# git submodule update --recursive --remote
-#
-# but this should seldom be necessary as that library is pretty stable.
-#
-# You will also need Python 3 YAML.  Under Debian or ubuntu:
-#
-# apt-get install python3-yaml
-#
-# If you have pip installed,
-#
-# pip3 install PyYAML
-
-VERS=1.0
+# SPDX-FileCopyrightText: (C) Eric S. Raymond <esr@thyrsus.com>
+# SPDX-License-Identifier: BSD-2-Clause
 
-CC?=gcc
-CCFLAGS+=-std=c99 -D _DEFAULT_SOURCE -Wall -Wpedantic -g
-LIBS=
-UNAME_S := $(shell uname -s)
-ifeq ($(UNAME_S),Linux)
-	LIBS=-lrt
-endif
+# To build with save/resume disabled, pass CFLAGS="-DADVENT_NOSAVE"
+# To build with auto-save/resume enabled, pass CFLAGS="-DADVENT_AUTOSAVE"
 
-OBJS=main.o init.o actions.o score.o misc.o saveresume.o common.o
-SOURCES=$(OBJS:.o=.c) dungeon.c advent.h common.h adventure.text Makefile control linenoise/linenoise.[ch] newdungeon.py
+VERS=$(shell sed -n <NEWS.adoc '/^[0-9]/s/:.*//p' | head -1)
 
-.c.o:
-	$(CC) $(CCFLAGS) $(DBX) -c $<
+.PHONY: debug indent release refresh dist linty html clean
+.PHONY: check coverage
 
-advent:	$(OBJS) database.o linenoise.o newdb.o
-	$(CC) $(CCFLAGS) $(DBX) -o advent $(OBJS) database.o newdb.o linenoise.o $(LDFLAGS) $(LIBS)
+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)
 
-main.o:	 	advent.h database.h database.c common.h newdb.h
+# LLVM/Clang on macOS seems to need -ledit flag for linking
+UNAME_S := $(shell uname -s)
+ifeq ($(UNAME_S),Darwin)
+    LIBS += -ledit
+endif
 
-init.o:	 	advent.h database.h database.c common.h newdb.h
+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
 
-actions.o:	advent.h database.h database.c common.h
+.c.o:
+	$(CC) $(CCFLAGS) $(INC) $(DBX) -c $<
 
-score.o:	advent.h database.h database.c common.h newdb.h
+advent:	$(OBJS) dungeon.o
+	$(CC) $(CCFLAGS) $(DBX) -o advent $(OBJS) dungeon.o $(LDFLAGS) $(LIBS)
 
-misc.o:		advent.h database.h database.c common.h newdb.h
+main.o:	 	advent.h dungeon.h
 
-saveresume.o:	advent.h database.h database.c common.h
+init.o:	 	advent.h dungeon.h
 
-common.o:	common.h
+actions.o:	advent.h dungeon.h
 
-database.o:     database.c database.h common.h
-	$(CC) $(CCFLAGS) $(DBX) -c database.c
+score.o:	advent.h dungeon.h
 
-newdb.o:	newdb.c newdb.h
-	$(CC) $(CCFLAGS) $(DBX) -c newdb.c
+misc.o:		advent.h dungeon.h
 
-database.c database.h: dungeon
-	./dungeon
+cheat.o:	advent.h dungeon.h
 
-newdb.c newdb.h:
-	python3 newdungeon.py
+saveresume.o:	advent.h dungeon.h
 
-linenoise.o:	linenoise/linenoise.h
-	$(CC) -c linenoise/linenoise.c
+dungeon.o:	dungeon.c dungeon.h
+	$(CC) $(CCFLAGS) $(DBX) -c dungeon.c
 
-dungeon: dungeon.o common.o
-	$(CC) $(CCFLAGS) -o $@ dungeon.o common.o
+dungeon.c dungeon.h: make_dungeon.py adventure.yaml advent.h templates/*.tpl
+	./make_dungeon.py
 
 clean:
-	rm -f *.o advent *.html database.[ch] dungeon *.gcno *.gcda
-	rm -f newdb.c newdb.h
+	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
 
-check: advent
+
+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
 
-.SUFFIXES: .adoc .html .6
+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
 
-# Requires asciidoc and xsltproc/docbook stylesheets.
 .adoc.6:
-	a2x --doctype manpage --format manpage $<
+	asciidoctor -D. -a nofooter -b manpage $<
 .adoc.html:
-	asciidoc $<
-.adoc:
-	asciidoc $<
+	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 README.adoc TODO advent.adoc history.adoc notes.adoc hints.adoc advent.6
+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.
@@ -107,10 +115,44 @@ advent-$(VERS).tar.gz: $(SOURCES) $(DOCS)
 release: advent-$(VERS).tar.gz advent.html history.html hints.html notes.html
 	shipper version=$(VERS) | sh -e -x
 
-refresh: advent.html
+refresh: advent.html notes.html history.html
 	shipper -N -w version=$(VERS) | sh -e -x
 
 dist: advent-$(VERS).tar.gz
 
-debug: CCFLAGS += -O0 --coverage -g
-debug: advent
+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
+
+# 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
+
+debug: CCFLAGS += -O0
+debug: CCFLAGS += --coverage
+debug: CCFLAGS += -ggdb
+debug: CCFLAGS += -U_FORTIFY_SOURCE
+debug: CCFLAGS += -fsanitize=address
+debug: CCFLAGS += -fsanitize=undefined
+debug: linty
+