Make clean now removes cheat binary
[open-adventure.git] / Makefile
index 362f58664d7c6750fd1166fd66383766ab3e9ad1..9cb6feb8e03c7ccdd66330197092650d558e6313 100644 (file)
--- a/Makefile
+++ b/Makefile
 # Makefile for the open-source release of adventure 2.5
 
-LIBS=-lrt
+# 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"
+
+.PHONY: debug indent release refresh dist linty html clean
+
+VERS=1.0
+
+CC?=gcc
+CCFLAGS+=-std=c99 -D _DEFAULT_SOURCE -Wpedantic -O2
+LIBS=
 UNAME_S := $(shell uname -s)
-ifeq ($(UNAME_S),Darwin)
-       LIBS=
+ifeq ($(UNAME_S),Linux)
+       LIBS=-lrt
 endif
 
-OBJS=main.o init.o actions1.o actions2.o score.o misc.o database.o
-SOURCES=$(OBJS:.o=.c) COPYING NEWS README TODO advent.text control
+OBJS=main.o init.o actions.o score.o misc.o saveresume.o common.o
+CHEAT_OBJS=cheat.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
 
 .c.o:
-       gcc -O $(DBX) -c $<
+       $(CC) $(CCFLAGS) $(DBX) -c $<
 
-advent:        $(OBJS)
-       gcc -Wall -std=c99 -O $(DBX) -o advent $(OBJS) $(LIBS)
+advent:        $(OBJS) linenoise.o newdb.o
+       $(CC) $(CCFLAGS) $(DBX) -o advent $(OBJS) newdb.o linenoise.o $(LDFLAGS) $(LIBS)
 
-main.o:                main.h misc.h funcs.h database.h
+main.o:                advent.h database.h common.h newdb.h
 
-init.o:                misc.h main.h share.h funcs.h database.h
+init.o:                advent.h database.h common.h newdb.h
 
-actions1.o:    misc.h main.h share.h funcs.h database.h
+actions.o:     advent.h database.h common.h newdb.h
 
-actions2.o:    misc.h main.h share.h funcs.h
+score.o:       advent.h database.h common.h newdb.h
 
-score.o:       misc.h main.h share.h database.h
+misc.o:                advent.h database.h common.h newdb.h
 
-misc.o:                misc.h main.h database.h
+cheat.o:       advent.h database.h common.h newdb.h
 
-database.c database.h: compile
-       ./compile
-       gcc $(OPTIONS) -O $(DBX) -c database.c
+saveresume.o:  advent.h database.h common.h newdb.h
+
+common.o:      common.h
+
+dungeon.o:     common.h newdb.h
+
+newdb.o:       newdb.c newdb.h
+       $(CC) $(CCFLAGS) $(DBX) -c newdb.c
+
+database.h: dungeon
+       ./dungeon
+
+newdb.c newdb.h: newdungeon.py adventure.yaml
+       python3 newdungeon.py
+
+linenoise.o:   linenoise/linenoise.h
+       $(CC) $(CCFLAGS) -c linenoise/linenoise.c
+
+dungeon: dungeon.o common.o
+       $(CC) $(CCFLAGS) -o $@ dungeon.o common.o
 
 clean:
-       rm -f *.o advent advent.html advent.6 database.[ch] compile
+       rm -f *.o advent cheat *.html database.h dungeon *.gcno *.gcda
+       rm -f newdb.c newdb.h
+       rm -f README advent.6 MANIFEST *.tar.gz
+       rm -f *~
+       rm -f .*~
        cd tests; $(MAKE) --quiet clean
 
-check: advent
+
+cheat: $(CHEAT_OBJS) linenoise.o newdb.o 
+       $(CC) $(CCFLAGS) $(DBX) -o cheat $(CHEAT_OBJS) linenoise.o newdb.o $(LDFLAGS) $(LIBS)
+
+check: advent cheat
        cd tests; $(MAKE) --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 TODO advent.adoc history.adoc notes.adoc hints.adoc advent.6
+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))
 
-release: advent-$(VERS).tar.gz advent.html
+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
 
-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: CCFLAGS += -Wundef
+linty: CCFLAGS += -Wstrict-prototypes
+linty: CCFLAGS += -Wmissing-prototypes
+linty: CCFLAGS += -Wmissing-declarations
+linty: CCFLAGS += -Wshadow
+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
+
+debug: CCFLAGS += -O0 --coverage -ggdb
+debug: linty
+debug: cheat