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

diff --git a/Makefile b/Makefile
index 9d94c11..0da7fb8 100644
--- a/Makefile
+++ b/Makefile
@@ -1,42 +1,33 @@
 # Makefile for the open-source release of adventure 2.5
 
-# The libedit (aka: editline) library is required to build. On
-# Debian or Ubuntu:
-#
-# apt-get install libedit-dev
-
-# You will also need Python 3 YAML.  Under Debian or ubuntu:
-#
-# apt-get install python3-yaml
-#
-# If you have pip installed,
-#
-# pip3 install PyYAML
-#
-# If you are using MacPorts on OS X:
-# port install py3{5,6}-yaml as appropriate for your Python 3 version.
-#
-# To build with save/resume disabled, pass CCFLAGS="-D ADVENT_NOSAVE"
-
-VERS=$(shell sed -n <NEWS '/^[0-9]/s/:.*//p' | head -1)
+# 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)\" -Wpedantic -O2
-LIBS=-ledit
+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),Linux)
-	LIBS+=-lrt
+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
+SOURCES=$(OBJS:.o=.c) advent.h adventure.yaml Makefile control make_dungeon.py templates/*.tpl
 
 .c.o:
-	$(CC) $(CCFLAGS) $(DBX) -c $<
+	$(CC) $(CCFLAGS) $(INC) $(DBX) -c $<
 
 advent:	$(OBJS) dungeon.o
 	$(CC) $(CCFLAGS) $(DBX) -o advent $(OBJS) dungeon.o $(LDFLAGS) $(LIBS)
@@ -58,8 +49,8 @@ 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
-	python3 make_dungeon.py
+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
@@ -74,26 +65,43 @@ clean:
 cheat: $(CHEAT_OBJS) dungeon.o
 	$(CC) $(CCFLAGS) $(DBX) -o cheat $(CHEAT_OBJS) dungeon.o $(LDFLAGS) $(LIBS)
 
-check: advent cheat
+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
 
-coverage: debug cheat
+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
 
-.SUFFIXES: .adoc .html .6
+# 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.
@@ -104,9 +112,6 @@ advent-$(VERS).tar.gz: $(SOURCES) $(DOCS)
 	(tar -T MANIFEST -czvf advent-$(VERS).tar.gz)
 	@(rm advent-$(VERS))
 
-indent:
-	astyle -n -A3 --pad-header --min-conditional-indent=1 --pad-oper *.c
-
 release: advent-$(VERS).tar.gz advent.html history.html hints.html notes.html
 	shipper version=$(VERS) | sh -e -x
 
@@ -118,11 +123,14 @@ dist: advent-$(VERS).tar.gz
 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
@@ -133,9 +141,18 @@ linty: CCFLAGS += -Wwrite-strings
 linty: CCFLAGS += -Wunreachable-code
 linty: CCFLAGS += -Winit-self
 linty: CCFLAGS += -Wpointer-arith
-linty: advent
-
-debug: CCFLAGS += -O0 --coverage -ggdb
+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
-debug: cheat