Makefile

##############
# parameters #
##############
# should we show commands executed ?
DO_MKDBG?=0
# do you want dependency on the Makefile itself ?
DO_ALLDEP:=1
# should we depend on the wrappers scripts dates ?
DO_WRAPDEPS:=1
# should we depend on the common include file ?
DO_INCDEPS:=1
# should we make the ly files and use them?
DO_LY:=1
# should we make pdfs ?
DO_PDF:=0
# should we make postscript ?
DO_PS:=0
# should we make midi ?
DO_MIDI:=0
# should we make stamp files ?
DO_STAMP:=0
# should we make .wav files ? (don't really want this):
DO_WAV:=0
# should we make mp3 ?
DO_MP3:=0
# should we make ogg ?
DO_OGG:=0
# should we do the full books ?
DO_BOOKS_PDF:=1
# do you want to validate html?
DO_CHECKHTML:=0
# do you want to lynt scripts?
DO_LINT:=1
# which books should we do?
NAMES:=openbook israeli drumming rockbook guitar_album

########
# code #
########
# where is the web folder?
DOCS:=docs
# what is the output folder?
OUTPUT:=$(DOCS)/output
# where are the sources located ?
SOURCE_DIR:=src
# where is the output folder ?
OUT_DIR:=out
# where is the common file?
COMMON:=include/common.ly.mako
# wrappers
LILYPOND_WRAPPER:=python -m scripts.wrapper_lilypond
LILYPOND_WRAPPER_DEP:=scripts/wrapper_lilypond.py
MAKO_WRAPPER:=python -m scripts.wrapper_mako
MAKO_WRAPPER_DEP:=scripts/wrapper_mako.py
MAKO_DEPS_WRAPPER:=scripts/mako_deps.py
MIDI2WAV_WRAPPER:=scripts/midi2wav.pl
MIDI2WAV_WRAPPER_DEP:=scripts/midi2wav.pl
MIDI2OGG_WRAPPER:=scripts/midi2ogg.pl
MIDI2OGG_WRAPPER_DEP:=scripts/midi2ogg.pl
MIDI2MP3_WRAPPER:=scripts/midi2mp3.pl
MIDI2MP3_WRAPPER_DEP:=scripts/midi2mp3.pl
# parameters to pass to the mako wrapper
CONST_BOOK:=1
CONST_SONG:=0
CONST_DONTCUT:=0
CONST_CUT:=1
# arguments to git grep
GITARGS:=--no-pager

ALL:=

ifeq ($(DO_WRAPDEPS),0)
	LILYPOND_WRAPPER_DEP:=
	BOOK_WRAPPER_DEP:=
	MAKO_WRAPPER_DEP:=
	MAKO_DEPS_WRAPPER_DEP:=
	MIDI2WAV_WRAPPER_DEP:=
	MIDI2OGG_WRAPPER_DEP:=
	MIDI2MP3_WRAPPER_DEP:=
endif #  DO_WRAPDEPS
ifeq ($(DO_INCDEPS),1)
	MAKO_WRAPPER_DEP:=$(MAKO_WRAPPER_DEP) $(COMMON)
endif # DO_INCDEPS

ifeq ($(DO_MKDBG),1)
Q=
# we are not silent in this branch
else # DO_MKDBG
Q=@
#.SILENT:
endif # DO_MKDBG

# this finds the sources without git. We dont want to use git since in some integration
# environments we don't have git (e.g. github workflows)
SOURCES_ALL:=$(subst ./,,$(shell find src -type f -and -name "*.mako"))
FILES_MAKO:=$(filter %.ly.mako,$(SOURCES_ALL))
FILES_MAKO_BASE:=$(basename $(basename $(FILES_MAKO)))
SCRIPTS:=$(shell find scripts -type f -and -name "*.py")

FILES_JAZZ:=$(subst ./,,$(shell find src/openbook -type f -and -name "*.mako"))

FILES_MAKO_DEPS:=$(addsuffix .mako.d,$(addprefix $(OUT_DIR)/,$(FILES_MAKO_BASE)))
FILES_LY:=$(addsuffix .ly,$(addprefix $(OUT_DIR)/,$(FILES_MAKO_BASE)))
FILES_PDF:=$(addsuffix .pdf,$(addprefix $(OUT_DIR)/,$(FILES_MAKO_BASE)))
FILES_PS:=$(addsuffix .ps,$(addprefix $(OUT_DIR)/,$(FILES_MAKO_BASE)))
FILES_MIDI:=$(addsuffix .midi,$(addprefix $(OUT_DIR)/,$(FILES_MAKO_BASE)))
FILES_STAMP:=$(addsuffix .stamp,$(addprefix $(OUT_DIR)/,$(FILES_MAKO_BASE)))
FILES_WAV:=$(addsuffix .wav,$(addprefix $(OUT_DIR)/,$(FILES_MAKO_BASE)))
FILES_MP3:=$(addsuffix .mp3,$(addprefix $(OUT_DIR)/,$(FILES_MAKO_BASE)))
FILES_OGG:=$(addsuffix .ogg,$(addprefix $(OUT_DIR)/,$(FILES_MAKO_BASE)))

# ALL_OUT_FILES:=$(shell find src -type f -and -name "*.mako")
# ALL_OUT_STAMP:=$(addsuffix .stamp,$(addprefix $(OUT_DIR)/,$(basename $(ALL_OUT_FILES))))

OUT_LY:=$(addsuffix .ly,$(addprefix $(OUTPUT)/,$(NAMES)))
OUT_PS:=$(addsuffix .ps,$(addprefix $(OUTPUT)/,$(NAMES)))
OUT_PDF:=$(addsuffix .pdf,$(addprefix $(OUTPUT)/,$(NAMES)))

ifeq ($(DO_LY),1)
ALL+=$(FILES_LY)
endif # DO_LY
ifeq ($(DO_PS),1)
ALL+=$(FILES_PS)
endif # DO_PS
ifeq ($(DO_PDF),1)
ALL+=$(FILES_PDF)
endif # DO_PDF
ifeq ($(DO_MIDI),1)
ALL+=$(FILES_MIDI)
endif # DO_MIDI
ifeq ($(DO_STAMP),1)
ALL+=$(FILES_STAMP)
endif # DO_STAMP
ifeq ($(DO_WAV),1)
ALL+=$(FILES_WAV)
endif # DO_WAV
ifeq ($(DO_MP3),1)
ALL+=$(FILES_MP3)
endif # DO_MPS
ifeq ($(DO_OGG),1)
ALL+=$(FILES_OGG)
endif # DO_OGG
ifeq ($(DO_BOOKS_PDF),1)
ALL+=$(OUT_PDF)
endif # DO_BOOKS_PDF

SOURCES_HTML:=$(DOCS)/index.html
HTMLCHECK:=out/html.stamp
ifeq ($(DO_CHECKHTML),1)
ALL+=$(HTMLCHECK)
endif # DO_CHECKHTML

ifeq ($(DO_LINT),1)
ALL+=out/lint.stamp
endif # DO_LINT

REAL_BOOKS_STAMP=out/real_books.stamp

#########
# rules #
#########
# do not touch this rule or add a recipe to it. This is to force 'make' to take the new $(ALL)
.PHONY: all
all: $(ALL)
	@true

.PHONY: stamp
stamp: $(FILES_STAMP)
	$(info doing [$@])

.PHONY: ly
ly: $(FILES_LY)
	$(info doing [$@])

.PHONY: debug
debug:
	$(info doing [$@])
	$(info ALL is $(ALL))
	$(info SOURCES_ALL is $(SOURCES_ALL))
	$(info SOURCES_HTML is $(SOURCES_HTML))
	$(info FILES_MAKO is $(FILES_MAKO))
	$(info FILES_MAKO_DEPS is $(FILES_MAKO_DEPS))
	$(info FILES_LY is $(FILES_LY))
	$(info FILES_LYI is $(FILES_LYI))
	$(info FILES_PDF is $(FILES_PDF))
	$(info FILES_PS is $(FILES_PS))
	$(info FILES_MIDI is $(FILES_MIDI))
	$(info FILES_STAMP is $(FILES_STAMP))
	$(info FILES_WAV is $(FILES_WAV))
	$(info FILES_MP3 is $(FILES_MP3))
	$(info FILES_OGG is $(FILES_OGG))
	$(info FILES_JAZZ is $(FILES_JAZZ))
	$(info NAMES is $(NAMES))
	$(info OUT_LY is $(OUT_LY))
	$(info OUT_PS is $(OUT_PS))
	$(info OUT_PDF is $(OUT_PDF))
	$(info DO_MKDBG is $(DO_MKDBG))
	$(info SCRIPTS is $(SCRIPTS))

.PHONY: todo
todo:
	$(info doing [$@])
	$(Q)-grep TODO $(FILES_LY)

.PHONY: clean
clean:
	$(Q)rm -f $(ALL) $(OUT_LY) $(OUT_PS) $(OUT_PDF)
.PHONY: clean_hard
clean_hard:
	$(info doing [$@])
	$(Q)git clean -qffxd
.PHONY: clean_hard_and_out
	$(info doing [$@])
	$(Q)rm -f $(ALL) $(OUT_LY) $(OUT_PS) $(OUT_PDF)
.PHONY: clean_all_png
clean_all_png:
	$(info doing [$@])
	$(Q)-find $(SOURCE_DIR) -name "*.png" -exec rm -f {} \;

.PHONY: clean_docs
clean_docs:
	$(info doing [$@])
	$(Q)rm -f $(OUT_PDF) $(OUT_PS) $(OUT_LY)

# checks

.PHONY: check_ws
check_ws:
	$(info doing [$@])
	$(Q)pymakehelper no_err git grep -e "[[:space:]]$$" -- src
.PHONY: check_naked_mymark
check_naked_mymark:
	$(info doing [$@])
	$(Q)grep "\myMark" $(FILES_MAKO) | pymakehelper error_on_print grep -v -E "A|B|C|D|Intro|End|Instr"
.PHONY: check_and
check_and:
	$(info doing [$@])
	$(Q)pymakehelper error_on_print grep "composer=\".* and .*\"" $(FILES_MAKO)
	$(Q)pymakehelper error_on_print grep "poet=\".* and .*\"" $(FILES_MAKO)
.PHONY: check_mark
check_mark:
	$(info doing [$@])
	$(Q)pymakehelper error_on_print grep --files-without-match "\\\\myMark" $(FILES_JAZZ)
.PHONY: check_key
check_key:
	$(info doing [$@])
	$(Q)grep "\\\\key" $(FILES_JAZZ) | grep -v major | pymakehelper error_on_print grep -v minor
.PHONY: check_python
check_python:
	$(info doing [$@])
	$(Q)scripts/check.py
.PHONY: check_hardcoded_names
check_hardcoded_names:
	$(info doing [$@])
	$(Q)pymakehelper error_on_print git $(GITARGS) grep veltzer
.PHONY: check_parts
check_parts:
	$(info doing [$@])
	$(Q)git grep "%% part" src | pymakehelper error_on_print grep -v \"
.PHONY: check_volta_last
check_volta_last:
	$(info doing [$@])
	$(Q)pymakehelper error_on_print grep alternative `git grep -L myEndLineVolta src/openbook`
.PHONY: check_null
check_null:
	$(info doing [$@])
	$(Q)git grep null src | pymakehelper error_on_print grep -v include
.PHONY: check_alternative
check_alternative:
	$(info doing [$@])
	$(Q)git grep \\\\alternative src | pymakehelper error_on_print grep -v "}"
.PHONY: check_tempo
check_tempo:
	$(info doing [$@])
	$(Q)git grep "\\\\tempo " src | pymakehelper error_on_print grep -v \"
.PHONY: check_all
check_all: check_ws check_naked_mymark check_and check_mark check_key check_python check_parts check_volta_last check_null check_alternative check_tempo

.PHONY: checkhtml
checkhtml: $(HTMLCHECK)
	$(info doing [$@])

# rules

# explain to make that .ps .pdf and .midi are really stamp files (do I need this ?!?)
$(FILES_PS): %.ps: %.stamp
	$(info doing [$@])

$(FILES_PDF): %.pdf: %.stamp
	$(info doing [$@])

$(FILES_MIDI): %.midi: %.stamp
	$(info doing [$@])

# this is the real rule
$(FILES_STAMP): $(OUT_DIR)/%.stamp: $(OUT_DIR)/%.ly $(LILYPOND_WRAPPER_DEP)
	$(info doing [$@])
	$(Q)mkdir -p $(dir $@)
	$(Q)$(LILYPOND_WRAPPER) run --stop_on_output False --ps $(dir $@)$(basename $(notdir $@)).ps --pdf $(dir $@)$(basename $(notdir $@)).pdf --output $(dir $@)$(basename $(notdir $@)) --ly $<
	$(Q)touch $@

$(OUT_DIR)/%.0.pdf: %.ly.mako $(MAKO_WRAPPER_DEP)
	$(info doing [$@])
	$(Q)mkdir -p $(dir $@)
	$(Q)$(MAKO_WRAPPER) $(CONST_SONG) $(CONST_CUT) 0 $@ $<
$(OUT_DIR)/%.1.pdf: %.ly.mako $(MAKO_WRAPPER_DEP)
	$(info doing [$@])
	$(Q)mkdir -p $(dir $@)
	$(Q)$(MAKO_WRAPPER) $(CONST_SONG) $(CONST_CUT) 1 $@ $<
$(OUT_DIR)/%.2.pdf: %.ly.mako $(MAKO_WRAPPER_DEP)
	$(info doing [$@])
	$(Q)mkdir -p $(dir $@)
	$(Q)$(MAKO_WRAPPER) $(CONST_SONG) $(CONST_CUT) 2 $@ $<
$(OUT_DIR)/%.3.pdf: %.ly.mako $(MAKO_WRAPPER_DEP)
	$(info doing [$@])
	$(Q)mkdir -p $(dir $@)
	$(Q)$(MAKO_WRAPPER) $(CONST_SONG) $(CONST_CUT) 3 $@ $<
$(FILES_LY): $(OUT_DIR)/%.ly: %.ly.mako $(MAKO_WRAPPER_DEP)
	$(info doing [$@])
	$(Q)mkdir -p $(dir $@)
	$(Q)$(MAKO_WRAPPER) $(CONST_SONG) $(CONST_DONTCUT) 0 $@ $<
$(FILES_MAKO_DEPS): $(OUT_DIR)/%.mako.d: %.ly.mako $(MAKO_DEPS_WRAPPER_DEP)
	$(info doing [$@])
	$(Q)mkdir -p $(dir $@)
	$(Q)$(MAKO_DEPS_WRAPPER) $< $@ $(basename $(basename $@)).stamp $(basename $(basename $@)).pdf $(basename $(basename $@)).ps $(basename $(basename $@)).midi
$(FILES_WAV): %.wav: %.midi $(MIDI2WAV_WRAPPER_DEP)
	$(info doing $@)
	$(Q)mkdir -p $(dir $@)
	$(Q)$(MIDI2WAV_WRAPPER) $< $@
$(FILES_OGG): %.ogg: %.midi $(MIDI2OGG_WRAPPER_DEP)
	$(info doing [$@])
	$(Q)mkdir -p $(dir $@)
	$(Q)$(MIDI2OGG_WRAPPER) $< $@
$(FILES_MP3): %.mp3: %.midi $(MIDI2MP3_WRAPPER_DEP)
	$(info doing [$@])
	$(Q)mkdir -p $(dir $@)
	$(Q)$(MIDI2MP3_WRAPPER) $< $@

define template
TMPL_LY_$(1):=$$(OUTPUT)/$(1).ly
TMPL_PS_$(1):=$$(OUTPUT)/$(1).ps
TMPL_PDF_$(1):=$$(OUTPUT)/$(1).pdf
TMPL_PREREQ_$(1):=$(subst ./,,$(shell find src/$(1) -type f -and -name "*.mako"))
$$(TMPL_PDF_$(1)): $$(TMPL_LY_$(1)) $$(LILYPOND_WRAPPER_DEP)
	$$(info doing [$$@])
	$$(Q)$$(LILYPOND_WRAPPER) run --ps $$(TMPL_PS_$(1)) --pdf $$(TMPL_PDF_$(1)) --output $$(OUTPUT) --ly $$<
$$(TMPL_LY_$(1)): $$(TMPL_PREREQ_$(1)) $$(MAKO_WRAPPER_DEP) $$(COMMON)
	$$(info doing [$$@])
	$$(Q)mkdir -p $$(dir $$@)
	$$(Q)$$(MAKO_WRAPPER) $$(CONST_BOOK) $$(CONST_DONTCUT) 0 $$@ $$(TMPL_PREREQ_$(1))
endef
$(foreach name, $(NAMES), $(eval $(call template,$(name))))

.PHONY: all_tunes
all_tunes: $(FILES_STAMP)
	$(info doing [$@])

$(HTMLCHECK): $(SOURCES_HTML)
	$(info doing [$@])
	$(Q)tidy -errors -q -utf8 $(SOURCES_HTML)
	$(Q)pymakehelper only_print_on_error node_modules/.bin/htmlhint $(SOURCES_HTML)
	$(Q)mkdir -p $(dir $@)
	$(Q)touch $@
out/lint.stamp: $(SCRIPTS)
	$(info doing [$@])
	$(Q)pymakehelper error_on_print python -m pylint --reports=n --score=n $(SCRIPTS)
	$(Q)mkdir -p $(dir $@)
	$(Q)touch $@
.PHONY: real_books_archive.gi
real_books_archive.gi: $(REAL_BOOKS_STAMP)
$(REAL_BOOKS_STAMP):
	$(info doing [$@])
	$(Q)wget -qO- https://www.dropbox.com/s/birwhwe6g7ojqnh/real_books_archive.gi.tar.gz?dl=1 | tar xzvf -
	$(Q)mkdir -p $(dir $@)
	$(Q)touch $@

##########
# alldep #
##########
ifeq ($(DO_ALLDEP),1)
.EXTRA_PREREQS+=$(foreach mk, ${MAKEFILE_LIST},$(abspath ${mk}))
endif # DO_ALLDEP