# Makefile for the open-source release of adventure 2.5
-CCFLAGS=-std=c99
-LIBS=-lrt
+# To build with save/resume disabled, pass CCFLAGS="-D ADVENT_NOSAVE"
+
+VERS=$(shell sed -n <NEWS '/^[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
+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)
-GCCVERSIONGTEQ4 := $(shell expr `gcc -dumpversion | cut -f1 -d.` \>= 4)
ifeq ($(UNAME_S),Darwin)
- LIBS=
-else ifeq "$(GCCVERSIONGTEQ4)" "1"
- CC=c99
+ LIBS += -ledit
endif
-OBJS=main.o init.o actions1.o actions2.o score.o misc.o database.o
-SOURCES=$(OBJS:.o=.c) COPYING NEWS README TODO adventure.text advent.text control misc.h main.h share.h funcs.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
.c.o:
- $(CC) $(CCFLAGS) -O $(DBX) -c $<
+ $(CC) $(CCFLAGS) $(INC) $(DBX) -c $<
-advent: $(OBJS) database.o
- $(CC) $(CCFLAGS) -O $(DBX) -o advent $(OBJS) $(LIBS)
+advent: $(OBJS) dungeon.o
+ $(CC) $(CCFLAGS) $(DBX) -o advent $(OBJS) dungeon.o $(LDFLAGS) $(LIBS)
-main.o: main.h misc.h funcs.h database.h
+main.o: advent.h dungeon.h
-init.o: misc.h main.h share.h funcs.h database.h
+init.o: advent.h dungeon.h
-actions1.o: misc.h main.h share.h funcs.h database.h
+actions.o: advent.h dungeon.h
-actions2.o: misc.h main.h share.h funcs.h
+score.o: advent.h dungeon.h
-score.o: misc.h main.h share.h database.h
+misc.o: advent.h dungeon.h
-misc.o: misc.h main.h database.h
+cheat.o: advent.h dungeon.h
-database.o: database.h
+saveresume.o: advent.h dungeon.h
-funcs.h: database.h
+dungeon.o: dungeon.c dungeon.h
+ $(CC) $(CCFLAGS) $(DBX) -c dungeon.c
-database.c database.h: compile adventure.text
- ./compile
- $(CC) $(CCFLAGS) -O $(DBX) -c database.c
+dungeon.c dungeon.h: make_dungeon.py adventure.yaml advent.h templates/*.tpl
+ ./make_dungeon.py
clean:
- rm -f *.o advent advent.html advent.6 database.[ch] compile
+ 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)
+
+check: advent cheat
cd tests; $(MAKE) --quiet
+# 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: debug
+ cd tests; $(MAKE) coverage --quiet
+
+.SUFFIXES: .adoc .html .6
+
# Requires asciidoc and xsltproc/docbook stylesheets.
-.asc.6:
+.adoc.6:
a2x --doctype manpage --format manpage $<
-.asc.html:
- a2x --doctype manpage --format xhtml -D . $<
- rm -f docbook-xsl.css
+.adoc.html:
+ asciidoc $<
+.adoc:
+ asciidoc $<
-advent-$(VERS).tar.gz: $(SOURCES) advent.6
- tar --transform='s:^:advent-$(VERS)/:' --show-transformed-names -cvzf advent-$(VERS).tar.gz $(SOURCES) advent.6
+html: advent.html history.html hints.html
-dist: advent-$(VERS).tar.gz
+# README.adoc exists because that filename is magic on GitLab.
+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.
+# 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))
+
+indent:
+ astyle -n -A3 --pad-header --min-conditional-indent=1 --pad-oper *.c
-release: advent-$(VERS).tar.gz advent.html
+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
+
+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
+
+debug: CCFLAGS += -O0
+debug: CCFLAGS += --coverage
+debug: CCFLAGS += -ggdb
+debug: CCFLAGS += -U_FORTIFY_SOURCE
+debug: CCFLAGS += -fsanitize=address
+debug: CCFLAGS += -fsanitize=undefined
+debug: linty
+
+CSUPPRESSIONS = --suppress=missingIncludeSystem --suppress=invalidscanf
+cppcheck:
+ cppcheck -I. --template gcc --enable=all $(CSUPPRESSIONS) *.[ch]
+
+PYSUPPRESSIONS = line-too-long,invalid-name,missing-function-docstring,too-many-lines,too-many-branches,global-statement,multiple-imports,too-many-locals,too-many-statements,too-many-nested-blocks,no-else-return,raise-missing-from,redefined-outer-name,consider-using-in,dict-iter-missing-items
+pylint:
+ @pylint --score=n --disable=$(PYSUPPRESSIONS) *.py */*.py