Makefile

# TODO: out-of-source build
# TODO: build static library
# TODO: using vanilla GNU Make has no easy way to automatically specify files' dependencies from included headers

MAKEFLAGS += .silent

CXX=g++
CXXFLAGS=--std=c++11 -static-libstdc++ -Wall -Wextra
CPPFLAGS=-I${INC_DIR}

AR=ar
ARFLAGS=crs

SRC_DIR=src
INC_DIR=include
BUILD_DIR=build
TEST_DIR=tests
SCRIPTS_DIR=scripts

SRCS=$(wildcard ${SRC_DIR}/*.cpp)
INCS=$(wildcard ${INC_DIR}/*.h)
OBJS=$(addprefix ${BUILD_DIR}/,$(notdir $(SRCS:.cpp=.o)))
DEPS=$(OBJS:.o=.d)
TEST_PROGS=$(addprefix ${BUILD_DIR}/,$(patsubst %.cpp,%,$(notdir $(wildcard ${TEST_DIR}/*.cpp))))

all: build/lzw

fast: build/lzw.cpp | ${BUILD_DIR}
	${CXX} ${CXXFLAGS} -Ofast $< -o build/lzw

build/lzw: build/lzw.cpp | ${BUILD_DIR}
	${CXX} ${CXXFLAGS} -g $< -o $@

build/lzw.cpp: main.cpp ${SRCS} ${INCS} | ${BUILD_DIR}
	# use concatenate_source_file to concat entry files, then compile, so that we can save all the hassle of setting up obscure Makefile
	concat $< -o $@ -I ${INC_DIR} -S ${SRC_DIR}
	clang-format -i -style=file $@

${BUILD_DIR}:
	mkdir -p $@

rebuild: clean all

build-lib: ${BUILD_DIR}/liblzw.a

${BUILD_DIR}/liblzw.a: ${OBJS}
	${AR} ${ARFLAGS} $@ $^

-include ${DEPS}

generate-deps: ${DEPS}

${BUILD_DIR}/%.d: ${SRC_DIR}/%.cpp | ${BUILD_DIR}
	@set -e; rm -f $@; \
	$(CXX) -MM $< $(CXXFLAGS) $(CPPFLAGS) > $@.$$$$; \
	sed 's,\($*\)\.o[ :]*,${BUILD_DIR}/\1.o $@ : ,g' < $@.$$$$ > $@; \
	rm -f $@.$$$$

${BUILD_DIR}/%.o: ${SRC_DIR}/%.cpp | ${BUILD_DIR}
	${CXX} -c -o $@ $< ${CXXFLAGS} ${CPPFLAGS}
	# ${CXX} -MM $< ${CXXFLAGS} ${CPPFLAGS} > ${BUILD_DIR}/$*.d

test: unit-test integrate-test

build-test: ${TEST_PROGS}

unit-test: build-test
	python3 ${SCRIPTS_DIR}/runall.py ${TEST_PROGS}

${BUILD_DIR}/%: ${TEST_DIR}/%.cpp
	concat $< -o $(addprefix ${BUILD_DIR}/,$(notdir $<)) -I ${INC_DIR} -S ${SRC_DIR}
	${CXX} ${CXXFLAGS} -g $(addprefix ${BUILD_DIR}/,$(notdir $<)) -o $@

integrate-test: build/lzw
	pytest ${TEST_DIR}/test_integrate.py

# TODO
cov:
	# gcov ${SRCS}

# TODO
prof: | ${BUILD_DIR}
	# ${CXX} ${CXXFLAGS} -pg -g -Ofast build/lzw.cpp -o build/lzw
	# ${CXX} ${CXXFLAGS} -pg -g build/lzw.cpp -o build/lzw
	# gprof ${PROGS}.exe gmon.out > prof_result
	# gprof -l ${PROGS}.exe gmon.out > prof_result
	# code prof_result

reformat:
	# WARNING: don't use globstar like "echo **/*.cpp **/*.c **/*.h" because it has some limitations and pitfalls, like nullglob problem and it can't match current directory
	find ${SRC_DIR} ${INC_DIR} ${TEST_DIR} -type f -regextype posix-extended -regex ".*\.(c|cpp|h)" | xargs clang-format -i -style=file
	isort --apply
	black .

compare-branch:
	git diff master assignment --compact-summary

todo:
	# ripgrep automatically skip undesired files and directories. Save the effort to manually exclude.
	rg TODO

fixme:
	# ripgrep automatically skip undesired files and directories. Save the effort to manually exclude.
	rg FIXME

clean:
	rm -rf build

pdf:
	# TODO: use the command line Typora's builtin PDF export functionality usees to invoke pandoc under the hood. Use the style from Typora.
	pandoc -s -o README.pdf README.md

transform-eqn:
	python3 ${SCRIPTS_DIR}/eqn2imgurl.py README.raw.md -o README.md

# Alternatively, changelog can be renamed release-note
changelog:
	git shortlog

install-pre-commit-hook-script:
	cp ${SCRIPTS_DIR}/pre-commit.py .git/hooks/pre-commit

.PHONY: all fast rebuild build-lib generate-deps test build-test unit-test
.PHONY: integrate-test cov prof reformat compare-branch todo fixme clean
.PHONY: pdf transform-eqn changelog install-pre-commit-hook-script