Makefile

.PHONY: help system_requirements gloss gen_csv_diffs gen_latex compile_graphs compile_doc clean

STUBS = Supp Quality Approach
GLOSSARIES = $(addsuffix Glossary, $(STUBS))
CSV_GLOSSARIES = $(addsuffix .csv, $(GLOSSARIES))
TXT_GLOSSARIES = $(addsuffix .txt, $(GLOSSARIES))
DIFF_GLOSSARIES = $(addprefix Diff, $(TXT_GLOSSARIES))

GRAPH_GLOSSARIES = ApproachGlossary.csv assets/graphs/exampleGlossaries/*Glossary.csv

LEGENDS = assets/graphs/*Legend.tex assets/graphs/manual/*Legend.tex
GRAPHS = $(LEGENDS) assets/graphs/*Graph.tex assets/graphs/manual/*.tex
CUSTOM_STUBS = subsumes specBased recovery scalability performance
ALL_CUSTOM_STUBS = $(CUSTOM_STUBS) $(addsuffix Proposed, $(CUSTOM_STUBS))
CUSTOM_GRAPHS = $(addprefix assets/graphs/, $(addsuffix Graph, $(ALL_CUSTOM_STUBS)))

DOC_NAME =
TEX_NAME ?= $(DOC_NAME)
TEX_FLAGS = -interaction=nonstopmode

# Whether or not to update "before" counts
UNDEF =

help:
	@echo "Build:"
	@echo "  - build : Build a fresh copy of relevant artifacts."
	@echo "  - paper : Build a fresh copy of just the ICSE paper."
	@echo "  - thesis: Build a fresh copy of just the thesis."
	@echo "  - debug : Same as 'thesis', but pauses build on errors for easier debugging."
	@echo "  - poster: Build a fresh copy of the testing terminology poster."
	@echo "  - clean : Clean working TeX build artifacts."
	@echo ""
	@echo "Supplementary Information:"
	@echo "  - help               : View this help guide."
	@echo "  - system_requirements: List system requirements."
	@echo "  - gloss              : Open all relevant glossaries in Excel."
	@echo "  - csv_diff           : View changes to glossaries in an intuitive format."

system_requirements:
	@echo "System Requirements: LaTeX (latexmk + LuaLaTeX), Pygments, InkScape"
	@echo "  - working LaTeX installation (with latexmk and LuaLaTeX)"
	@echo "  - Pygments (for code snippet syntax highlighting, installed with Python/pip)"
	@echo "  - InkScape (for SVG-based figures)"

gloss:
	$(foreach gloss, $(CSV_GLOSSARIES),EXCEL.EXE $(gloss) &)

gen_csv_diffs:
	py scripts/undefTermCounts.py $(UNDEF)
	for gloss in $(GLOSSARIES) ; do \
		py scripts/diffCSV.py $$gloss; \
	done

csv_diff: gen_csv_diffs
	for gloss in $(DIFF_GLOSSARIES) ; do \
		git diff --word-diff=plain --color --no-index --word-diff-regex='[[:alnum:]]+|[^[:space:],\);\.]+|[,\);\.]+' scripts/$$gloss $$gloss; \
		if [ $$? -ne 1 ]; then echo "No diff in $$gloss"; rm $$gloss; fi; \
	done

# Update diff files for better diffs, ignore errors if no difference
update_diffs: gen_csv_diffs
	for gloss in $(DIFF_GLOSSARIES) ; do \
		if [ -f $$gloss ]; then mv $$gloss scripts/$$gloss; fi; \
	done

LATEX_SCRIPTS = csvToGraph undefTermSources sourceCounts methodologyHelper exampleCSVtoLaTeX

$(LATEX_SCRIPTS):
	-mkdir build || true
	py scripts/$@.py

sourceCounts:
	-mkdir build || true
	py scripts/$@.py $(CSV_GLOSSARIES)

csvToGraph:
	-mkdir build || true
	for filename in $(GRAPH_GLOSSARIES) ; do \
		py scripts/$@.py $${filename} ; \
	done

compile_graphs: csvToGraph
	for filename in $(GRAPHS) ; do \
			filename=$${filename%.tex} ; \
			# -rm filename.pdf ; \
			latex -interaction=nonstopmode -shell-escape $${filename}.tex || true ; \
			latex -interaction=nonstopmode -shell-escape $${filename}.tex || true ; \
			basefilename=$$(basename $$filename) ; \
			cp $${basefilename}.pdf $${filename}.pdf ; \
	done
	rm *Graph* || true
	rm *Legend* || true
	rm *catRels* || true

custom_graphs: GRAPHS=$(CUSTOM_GRAPHS)
custom_graphs: compile_graphs

legends: GRAPHS=$(LEGENDS)
legends: compile_graphs

graphs: compile_graphs

compile_doc: # '-output-directory=build' is a special name and is referenced from '\usepackage{minted}' region in some .tex files
	-latexmk -output-directory=build -jobname=$(DOC_NAME) -pdflatex=lualatex -pdf $(TEX_FLAGS) -shell-escape $(TEX_NAME).tex
	cp build/$(DOC_NAME).pdf $(DOC_NAME).pdf
	-rm lualatex*.fls || true

paper thesis seminar defense meeting poster: $(LATEX_SCRIPTS) # standard build of documents
# Attempted to convert the following find and replace working in VS Code:
# ([^p])p.[\s~]+(\d+)([-,])(\d+) -> $1pp.~$2$3$4
# To a Makefile rule unsuccessfully (grep not finding tildes):
# grep -Irwl "([^p])p.[\s~]+(\d+)([-,])(\d+)" --include='*.tex' . | xargs sed -ri "s/([^p])p.[\s~]+(\d+)([-,])(\d+)/\1pp.~\2\3\4/g"
	make compile_doc DOC_NAME=$@

paper_blind: paper # double-blind build of ICSE paper for review submission
	make compile_doc DOC_NAME=$@ TEX_NAME=$<

build: csv_diff paper graphs thesis
docs: paper thesis presentations
presentations: seminar defense # meeting poster

debug: DOC_NAME=thesis
debug: TEX_FLAGS=
debug: $(LATEX_SCRIPTS) compile_doc # for finding hard issues, this is an interactive version of 'thesis'

clean:
	rm -rf build/
	rm *Graph* || true
	rm *Legend* || true
	rm *catRels* || true