Baillehache Pascal's personal website

Makefile template

Memo for myself of a Makefile template for a project written in C.

The project structure is as follow:

.
├── Bin
│   ├── XXX
│   └── ...
├── commitId.txt
├── DockerFiles
│   ├── Ubuntu18
│   │   ├── Dockerfile
│   │   └── runTest.sh
│   └── Ubuntu20
│       ├── Dockerfile
│       └── runTest.sh
├── Html
│   ├── XXX.php
│   └── ...
├── INSTALL.md
├── ISSUES.md
├── LICENSE
├── Makefile
├── Obj
│   ├── XXX.o
│   ├── XXX.d
│   └── ...
├── Pdf
│   ├── XXX.pdf
│   └── ...
├── README.md
├── Src
│   ├── XXX.c
│   ├── XXX.h
│   └── ...
├── UnitTests
│   ├── test_XXX.c
│   └── ...
└── VERSIONS.md

The Makefile is as follow:

(Edited on 2022/11/21 to use CUTest.)

# Compiler
COMPILER=gcc

# Build mode 0:dev, 1:prod
BUILD_MODE=1

# Version
VERSION="0.0.0"

# Compiler arguments
# _XOPEN_SOURCE=700 is needed by ipc.h on my old 16bits/ubuntu16
# Set PNG_SKIP_SETJMP_CHECK to avoid
# "__pngconf.h__ in libpng already includes setjmp.h;"
ifeq ($(BUILD_MODE), 0)
	BUILD_ARG_MODE=-O0 -ggdb -g3
else ifeq ($(BUILD_MODE), 1)
	BUILD_ARG_MODE=-Werror -Wfatal-errors -O3
endif
GTK_PARAM=`pkg-config --cflags gtk+-3.0`
GTK_LINK=`pkg-config --libs gtk+-3.0`
BUILD_ARG=-std=c18 -I./Src -Wall -Wextra -Wshadow -Wno-format-truncation $(BUILD_ARG_MODE) -fopenmp -DBUILD_MODE=$(BUILD_MODE) -DVERSION=$(VERSION) -DCOMMIT=`cat commitId.txt` -DPNG_SKIP_SETJMP_CHECK -D_XOPEN_SOURCE=700 $(GTK_PARAM)
LINK_ARG=-lm -fopenmp -lpng $(GTK_LINK)

# Variable to detect changes to the repo
REPO_CHANGES=`if [ -d .git ]; then git status --porcelain; fi`

# Commit id
COMMIT_ID=`if [ -d .git ]; then git rev-parse HEAD; fi`

# List of source files
SRCS=$(wildcard Src/*.c)

# List of header files
HEADERS=$(wildcard Src/*.h)

# List of object files
OBJS=$(patsubst Src/%.c, Obj/%.o, $(SRCS))

# Binary
BIN=

# List of unit tests
TEST_SRCS=$(wildcard UnitTests/test_*.c)
TESTS=$(patsubst UnitTests/test_%.c, UnitTests/test_%, $(TEST_SRCS))

# Compile the binary
Bin/$(BIN): obj
	mkdir -p Bin
	$(COMPILER) -o Bin/$(BIN) $(OBJS) $(LINK_ARG)

# Compile the obj files
obj: commitId_txt $(OBJS)

# Compile everything
all: obj $(TESTS)

# Include the dependencies rules
-include $(OBJS:.o=.d)

# Compile rule for obj files
Obj/%.o: Src/%.c Src/%.h Makefile
	mkdir -p Obj
	$(COMPILER) $(BUILD_ARG) -c Src/$*.c -o $@
	echo -n "Obj/" > Obj/$*.d
	$(COMPILER) -MM Src/$*.c >> Obj/$*.d

# Compilation rules for unit tests
UnitTests/%: obj UnitTests/%.c Makefile
	$(COMPILER) -o $@ UnitTests/$*.c $(OBJS) $(BUILD_ARG) $(LINK_ARG)

# Cleaning rule
clean:
	rm -rf Obj Dist $(TESTS) UnitTests/*.o *core*

# Installation rule
INSTALL_DIR=/usr/local
installLib: checkCommit clean obj
	@echo "Installing commit `cat commitId.txt` into $(INSTALL_DIR)"
	@sudo mkdir -p $(INSTALL_DIR)/include $(INSTALL_DIR)/lib
	@sudo rm -rf $(INSTALL_DIR)/include/LibCapy
	@sudo mkdir -p $(INSTALL_DIR)/include/LibCapy
	@sudo cp $(HEADERS) $(INSTALL_DIR)/include/LibCapy
	@sudo rm -f $(INSTALL_DIR)/lib/libcapy.a
	@sudo ar -r $(INSTALL_DIR)/lib/libcapy.a $(OBJS)

INSTALL_BIN_DIR=~/Tools/
installBin: $(BIN)
	cp $(BIN) $(INSTALL_BIN_DIR)

# Packaging rule
package: checkCommit cppcheck clean obj cbo unittests
	mkdir -p Dist
	rm -f Dist/*
	tar czvf Dist/libcapy.$(VERSION).tar.gz Src Makefile INSTALL.md LICENSE README.md commitId.txt UnitTests

# Test rule
test:
	echo "#include <LibCapy/capy.h>" > /tmp/testLibCapy.c && \
	echo "int main() {println(\"Hello world.\");return 0;}" >> /tmp/test.c && $(COMPILER) -o /tmp/test /tmp/test.c -lcapy $(BUILD_ARG) $(LINK_ARG) && /tmp/test; rm -f /tmp/test*

# Save the current commit id to a file to be able to use it in the code
commitId_txt:
	@if [ -z "${REPO_CHANGES}" ]; then echo ${COMMIT_ID} > commitId.txt; else echo ${COMMIT_ID} " locally edited" > commitId.txt; fi

# Check that there are no uncommited change to the repository
checkCommit:
	@if [ -z "${REPO_CHANGES}" ]; then exit 0; else echo "Commit your changes first"; exit 1; fi

# Test the installation process
testInstall: testInstallUbuntu18 testInstallUbuntu20

testInstallUbuntu18:
	cd DockerFiles/Ubuntu18; docker image inspect capy_ubuntu18 >/dev/null 2>&1 && echo "" || docker build -t capy_ubuntu18 .
	xhost local:root && docker run --rm -e DISPLAY=${DISPLAY} -v /tmp/.X11-unix:/tmp/.X11-unix capy_ubuntu18

testInstallUbuntu20:
	cd DockerFiles/Ubuntu20; docker image inspect capy_ubuntu20 >/dev/null 2>&1 && echo "" || docker build -t capy_ubuntu20 .
	docker run --rm -e DISPLAY=${DISPLAY} -v /tmp/.X11-unix:/tmp/.X11-unix capy_ubuntu20

# Run all the unit tests
unitTests:
	for f in ${TESTS}; do make --no-print-directory $$f; if [ $$? -ne 0 ]; then exit 1; fi; done

# Run one unit test
UnitTests/test_%: obj Makefile
	@mkdir -p Resources
	@test -f Resources/cutest.c || curl https://baillehachepascal.dev/2022/Data/cutest.c -o Resources/cutest.c
	@$(COMPILER) -o UnitTests/cutest Resources/cutest.c -DCUTEST_FILE=../UnitTests/test_$*.c $(OBJS) $(BUILD_ARG) $(LINK_ARG) && UnitTests/cutest && \rm -f UnitTests/cutest

# Dynamic analysis, use as: make valgrind test=XXX where xx is the module to
# test
# About 'memory still reachable' due to Gtk and Glib:
# suppression files do not work
# https://github.com/GreenBeard/GNOME.supp
# https://wiki.gnome.org/Valgrind
# give up and ignore the 'possibly lost' and 'sill reachable' categories
valgrind:
	valgrind \
	-v --track-origins=yes --tool=memcheck \
	--leak-check=full \
	--show-leak-kinds=definite,indirect \
	UnitTests/test_$(test)

# Open all files in the Geany editor
edit:
	geany Src/*.c Src/*.h Makefile *.md UnitTests/*.c &
	gio open Pdf/*.pdf &

# Run the preprocessor on a file, use as: make preprocessSrcFile file=XXX where
# XXX is the file to preprocess
preprocessSrcFile:
	$(COMPILER) $(BUILD_ARG) -E Src/$(file).c

# Static analysis
cppcheck:
	cppcheck Src/*.[ch]

# Code beautifier
cbo:
	cbo --check --files Src/*.[ch] UnitTests/*.c

# Doc generation in HTML format
docHtml:
	mkdir -p Html && cbo -f $(SRCS) $(HEADERS) -d html -o ./Html -p ProjectName -pr Html/pre.php -po Html/post.php

# Doc generation in PDF format
docPdf:
	mkdir -p Pdf && cbo -f $(SRCS) $(HEADERS) -d pdf -o ./Pdf && cd Pdf && make

2022-06-18
in All, C programming,
40 views
I'm open for work ! Check my profile and email me.
Liked this article ? Please consider supporting me: