X-Git-Url: https://jxself.org/git/?a=blobdiff_plain;f=Makefile;h=0f82c4a69833ba42ac8390073410e795e07937fd;hb=47c3d14a11c379e0c3ddf1bbff2c7149208416dc;hp=43f1f9514caa1c1286ec093cbb47e5147d92d307;hpb=b0705ba0bbbee2cc1648c5b9adbe0e147e1dfea9;p=open-adventure.git

diff --git a/Makefile b/Makefile
index 43f1f95..0f82c4a 100644
--- a/Makefile
+++ b/Makefile
@@ -1,28 +1,7 @@
 # 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
-#
-# 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"
+# 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 '/^[0-9]/s/:.*//p' | head -1)
 
@@ -30,24 +9,27 @@ VERS=$(shell sed -n <NEWS '/^[0-9]/s/:.*//p' | head -1)
 .PHONY: check coverage
 
 CC?=gcc
-CCFLAGS+=-std=c99 -D_DEFAULT_SOURCE -DVERSION=\"$(VERS)\" -Wpedantic -O2
-LIBS=
+CCFLAGS+=-std=c99 -D_DEFAULT_SOURCE -DVERSION=\"$(VERS)\" -O2 -D_FORTIFY_SOURCE=2 -fstack-protector-all $(CFLAGS) -g
+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 linenoise/linenoise.[ch] 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) linenoise.o dungeon.o
-	$(CC) $(CCFLAGS) $(DBX) -o advent $(OBJS) dungeon.o linenoise.o $(LDFLAGS) $(LIBS)
+advent:	$(OBJS) dungeon.o
+	$(CC) $(CCFLAGS) $(DBX) -o advent $(OBJS) dungeon.o $(LDFLAGS) $(LIBS)
 
-main.o:	 	advent.h dungeon.h linenoise.o
+main.o:	 	advent.h dungeon.h
 
 init.o:	 	advent.h dungeon.h
 
@@ -57,25 +39,15 @@ score.o:	advent.h dungeon.h
 
 misc.o:		advent.h dungeon.h
 
-cheat.o:	advent.h dungeon.h linenoise.o
+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
-	python3 make_dungeon.py
-
-linenoise.o: linenoise/linenoise.h
-	@test -s linenoise/linenoise.h || { echo -e "linenoise not present. Try:\n\
-		git submodule update --recursive --remote --init"; exit 1; }
-	$(CC) -c linenoise/linenoise.c
-
-linenoise-dbg: linenoise/linenoise.h
-	@test -s linenoise/linenoise.h || { echo -e "linenoise not present. Try:\n\
-		git submodule update --recursive --remote --init"; exit 1; }
-	$(CC) $(CCFLAGS) -c linenoise/linenoise.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
@@ -87,13 +59,18 @@ clean:
 	cd tests; $(MAKE) --quiet clean
 
 
-cheat: $(CHEAT_OBJS) linenoise.o dungeon.o 
-	$(CC) $(CCFLAGS) $(DBX) -o cheat $(CHEAT_OBJS) linenoise.o dungeon.o $(LDFLAGS) $(LIBS)
+cheat: $(CHEAT_OBJS) dungeon.o
+	$(CC) $(CCFLAGS) $(DBX) -o cheat $(CHEAT_OBJS) dungeon.o $(LDFLAGS) $(LIBS)
 
 check: advent cheat
 	cd tests; $(MAKE) --quiet
 
-coverage: debug cheat
+# Requires gcov, lcov, libasan6, and libubsan1
+# The last two are Ubuntu names, might vary onb 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
@@ -109,7 +86,7 @@ coverage: debug cheat
 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 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.
@@ -134,11 +111,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
@@ -149,10 +129,24 @@ 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 modeern 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
 
-debug-ln: linenoise-dbg debug
+CSUPPRESSIONS = --suppress=missingIncludeSystem --suppress=invalidscanf
+cppcheck:
+	cppcheck -I. --template gcc --enable=all $(CSUPPRESSIONS) *.[ch]
+
+pylint:
+	@pylint --score=n *.py */*.py