Makefile

# Makefile for the JBOL project

project := jbol

########################################################################
# Prerequisites
########################################################################

# We are using some of the newest GNU Make features... so require GNU
# Make version >= 3.82
version_test := $(filter 3.82,$(firstword $(sort $(MAKE_VERSION) 3.82)))
ifndef version_test
$(error GNU Make version $(MAKE_VERSION); version >= 3.82 is needed)
endif

########################################################################
# Parameters (redefine as you like)
########################################################################

# jq binary used to run tests and examples.
JQ ?= /usr/local/bin/jq

# Used when (un)installing.
prefix	?= /usr/local
datadir	?= $(prefix)/share
bindir	?= $(prefix)/bin

########################################################################
# Paranoia
########################################################################

ifeq (,$(filter install uninstall,$(MAKECMDGOALS)))
ifeq (0,$(shell id --user))
$(error Root only can make "(un)install" targets)
endif
else
ifneq (0,$(shell id --user))
$(error Only root can make "(un)install" targets)
endif
endif

########################################################################
# Configuration
########################################################################

# Disable builtins.
MAKEFLAGS += --no-builtin-rules
MAKEFLAGS += --no-builtin-variables

# Warn when an undefined variable is referenced.
MAKEFLAGS += --warn-undefined-variables

# Make will not print the recipe used to remake files.
.SILENT:

# Eliminate use of the built-in implicit rules. Also clear out the
# default list of suffixes for suffix rules.
.SUFFIXES:

# Sets the default goal to be used if no targets were specified on the
# command line.
.DEFAULT_GOAL := all

# When it is time to consider phony targets, make will run its recipe
# unconditionally, regardless of whether a file with that name exists or
# what its last-modification time is.
.PHONY: all

# Default shell: if we require GNU Make, why not require Bash?
SHELL := /bin/bash

# The argument(s) passed to the shell are taken from the variable
# .SHELLFLAGS.
.SHELLFLAGS := -o errexit -o pipefail -o nounset -c

# Make will delete the target of a rule if it has changed and its recipe
# exits with a nonzero exit status.
.DELETE_ON_ERROR:

########################################################################
# Targets and files
########################################################################

# Tests to check
Tests := $(wildcard tests/*.test)

# Sentinel targets simulating the tests are done
LogDir := .logs
Logs := $(subst tests/,$(LogDir)/,$(Tests:.test=.log))

# Packages
LIB=fadado.github.io
ARRAY=$(LIB)/array
JSON=$(LIB)/json
MATH=$(LIB)/math
MUSIC=$(LIB)/music
OBJECT=$(LIB)/object
STRING=$(LIB)/string
WORD=$(LIB)/word

########################################################################
# Rules
########################################################################

# Default target
all: $(Logs)

# Hidden directory for logs
$(Logs): | $(LogDir)
$(LogDir): ; mkdir --parents $@

# Tests output is saved in a log file
$(LogDir)/%.log: tests/%.test
	echo '>>>' $< '<<<' | tee $@
	$(JQ) -L./fadado.github.io --run-tests $<	\
		| tee --append $@	\
		| grep --invert-match '^Testing'
	grep --quiet '^\*\*\*' $@ && touch $< || true

# Common tests
$(LogDir)/prelude.log: $(LIB)/prelude.jq
$(LogDir)/types.log: $(LIB)/types.jq
$(LogDir)/stream.log: $(LIB)/stream.jq

# JSON tests
$(LogDir)/json.log: $(JSON)/json.jq $(LIB)/prelude.jq $(LIB)/types.jq $(STRING)/ascii.jq $(STRING)/regexp.jq
$(LogDir)/json_schema.log: $(JSON)/schema.jq $(LIB)/prelude.jq $(LIB)/types.jq $(STRING)/url.jq $(STRING)/regexp.jq $(LIB)/stream.jq

# Math tests
$(LogDir)/math.log: $(MATH)/math.jq $(LIB)/types.jq
$(LogDir)/math_chance.log: $(MATH)/chance.jq $(LIB)/prelude.jq
$(LogDir)/math_sequence.log: $(MATH)/sequence.jq $(LIB)/prelude.jq
$(LogDir)/math_bitwise.log: $(MATH)/bitwise.jq

# Arrays tests
$(LogDir)/array.log: $(ARRAY)/array.jq
$(LogDir)/array_choice.log: $(ARRAY)/choice.jq $(LIB)/prelude.jq $(MATH)/chance.jq 
$(LogDir)/array_set.log: $(ARRAY)/set.jq
$(LogDir)/array_kleene.log: $(ARRAY)/kleene.jq
$(LogDir)/array_tuple.log: $(ARRAY)/tuple.jq

# Object tests
$(LogDir)/object.log: $(OBJECT)/object.jq
$(LogDir)/object_set.log: $(OBJECT)/set.jq $(LIB)/prelude.jq $(LIB)/types.jq

# Word tests
$(LogDir)/word.log: $(WORD)/word.jq $(LIB)/types.jq
$(LogDir)/word_scanner.log: $(WORD)/scanner.jq
$(LogDir)/word_factor.log: $(WORD)/factor.jq
$(LogDir)/word_alphabet.log: $(WORD)/alphabet.jq $(ARRAY)/kleene.jq $(LIB)/prelude.jq $(LIB)/types.jq
$(LogDir)/word_language.log: $(WORD)/language.jq $(ARRAY)/kleene.jq $(LIB)/prelude.jq

# String tests
$(LogDir)/string.log: $(STRING)/string.jq $(LIB)/prelude.jq
$(LogDir)/string_table.log: $(STRING)/table.jq $(LIB)/prelude.jq $(STRING)/string.jq $(STRING)/ascii.jq $(STRING)/ascii.json $(OBJECT)/set.jq 
$(LogDir)/string_ascii.log: $(STRING)/ascii.jq $(STRING)/ascii.json $(LIB)/prelude.jq
$(LogDir)/string_latin1.log: $(STRING)/latin1.jq $(STRING)/latin1.json $(LIB)/prelude.jq
$(LogDir)/string_regexp.log: $(STRING)/regexp.jq $(LIB)/prelude.jq $(STRING)/string.jq $(LIB)/types.jq
$(LogDir)/string_roman.log: $(STRING)/roman.jq $(LIB)/prelude.jq
$(LogDir)/string_snobol.log: $(STRING)/snobol.jq $(LIB)/prelude.jq  $(STRING)/string.jq $(LIB)/types.jq
$(LogDir)/string_url.log: $(STRING)/url.jq $(MATH)/math.jq

# Music tests
$(LogDir)/music_pitch.log: $(MUSIC)/pitch.jq $(LIB)/prelude.jq $(STRING)/regexp.jq $(LIB)/types.jq
$(LogDir)/music_pitch-class.log: $(MUSIC)/pitch-class.jq $(MUSIC)/pitch.jq $(LIB)/prelude.jq $(ARRAY)/set.jq $(MATH)/math.jq $(LIB)/types.jq
$(LogDir)/music_pitch-class-set.log: $(MUSIC)/pitch-class-set.jq $(MUSIC)/pitch-class.jq $(LIB)/prelude.jq $(ARRAY)/set.jq $(MATH)/math.jq $(LIB)/types.jq
$(LogDir)/music_interval-class-vector.log: $(MUSIC)/interval-class-vector.jq $(MUSIC)/pitch-class.jq $(ARRAY)/array.jq $(MATH)/math.jq $(LIB)/prelude.jq 
$(LogDir)/music_interval-pattern.log: $(MUSIC)/interval-pattern.jq $(MUSIC)/pitch-class.jq $(LIB)/prelude.jq 
$(LogDir)/music_interval-table.log: $(MUSIC)/interval-table.jq $(MUSIC)/pitch-class.jq $(ARRAY)/array.jq $(LIB)/prelude.jq 

########################################################################
# Utilities
########################################################################

.PHONY: clean distclean check list install uninstall #prototypes

clean:
	rm --force -- $(LogDir)/*.log

distclean: clean
	test -d $(LogDir) && rmdir --parents $(LogDir) || true

clober: distclean

check: clean all

install:
	test -d $(datadir)/$(project) || mkdir -v --parents $(datadir)/$(project)
	test -d $(bindir) || mkdir -v --parents $(bindir)
	cp -v -u -r fadado.github.io/ $(datadir)/$(project)
	cp -v -u -r schemata/ $(datadir)/$(project)
	install --verbose --compare --mode 555 bin/{jgen,jval,jxml} $(bindir)
	install --verbose --compare --mode 644 bin/{jgen,jval,jxml}.jq $(bindir)

uninstall:
	test -d $(datadir)/$(project)				  \
	&& rm --verbose --force --recursive $(datadir)/$(project) \
	|| true
	rm -f $(bindir)/{jgen,jval,jxml}* 

# Show targets
list:
	echo 'Targets:';					\
	$(MAKE) --print-data-base --just-print 2>&1		\
	| grep -v '^[mM]akefile'				\
	| awk '/^[^ \t.%][-A-Za-z0-9_]*:/ { print $$1 }'	\
	| sort --unique						\
	| sed 's/:\+$$//'					\
	| pr --omit-pagination --indent=4 --width=80 --columns=4
	echo 'Default parameters:';				\
	echo '    prefix    = $(prefix)';			\
	echo '    bindir    = $(bindir)';			\
	echo '    datadir   = $(datadir)';			\

# Generate type declarations
define make_prototypes
  find fadado.github.io -name '*.jq' -print | while read m; do	\
    M=$${m##*/};						\
    P=$${M%.jq};						\
    X=$${m#*fadado.github.io/};					\
    X=$${X%/$$M}_;						\
    [[ $$X == *.jq_ ]] && X='';					\
    <$$m grep '^def  *[^_].*\#::'	 			\
    | sed -e 's/^def  *//' -e 's/:  *\#/ /'			\
    | sort >|/tmp/$${X}$${P}.txt ;				\
  done
endef

prototypes:
	$(call make_prototypes)

########################################################################
# Examples
########################################################################

.PHONY: bogussort cross cut dice newton nondet nqbrute nqsmart octcode \
	script seconds sendmoremoney series shuffle nqsbrute triple \
	prolog closure

bogussort: ; $(JQ) -cnRrf examples/$@.jq
closure: ; $(JQ) -cnRrf examples/$@.jq
cross: ; $(JQ) -nRrf examples/$@.jq
cut: ; $(JQ) -cnRrf examples/$@.jq
dice: ; $(JQ) -cnRrf examples/$@.jq
newton: ; $(JQ) -cnRrf examples/$@.jq
nqbrute: ; $(JQ) -cnRrf examples/$@.jq
nqsmart: ; $(JQ) -cnRrf examples/$@.jq
octcode: ; $(JQ) -cnRrf examples/$@.jq
prolog: ; $(JQ) -cnRrf examples/$@.jq
script: ; $(JQ) -cnrf examples/$@.jq
seconds: ; $(JQ) -nRrf examples/$@.jq
sendmoremoney: ; $(JQ) -cnRrf examples/$@.jq
series: ; $(JQ) -cnRrf examples/$@.jq
shuffle: ; $(JQ) -cnRrf examples/$@.jq
nqsbrute: ; $(JQ) -cnRrf examples/$@.jq
triple: ; $(JQ) -cnrf examples/$@.jq

# vim:ai:sw=8:ts=8:noet:syntax=make