chore: refactor repository for cleaner development

main
Jef Roosens 2024-03-30 11:46:49 +01:00
parent 5ff788c108
commit 0e39ce3618
Signed by: Jef Roosens
GPG Key ID: B75D4F293C7052DB
18 changed files with 19 additions and 29 deletions

View File

@ -3,7 +3,7 @@
-include config.mk -include config.mk
LIB := $(BUILD_DIR)/$(LIB_FILENAME) LIB_ARCHIVE := $(BUILD_DIR)/lib$(LIB).a
SRCS != find '$(SRC_DIR)' -iname '*.c' SRCS != find '$(SRC_DIR)' -iname '*.c'
SRCS_H != find include -iname '*.h' SRCS_H != find include -iname '*.h'
@ -20,26 +20,17 @@ DEPS := $(SRCS:%=$(BUILD_DIR)/%.d) $(SRCS_TEST:%=$(BUILD_DIR)/%.d)
BIN_TEST := $(BUILD_DIR)/$(TEST_DIR)/runner BIN_TEST := $(BUILD_DIR)/$(TEST_DIR)/runner
BINS_EXAMPLE := $(OBJS_EXAMPLE:%.c.o=%) BINS_EXAMPLE := $(OBJS_EXAMPLE:%.c.o=%)
TARGETS_TEST := $(BINS_TEST:%=test-%)
TARGETS_MEM_TEST := $(BINS_TEST:%=test-mem-%)
TARGETS_EXAMPLE := $(BINS_EXAMPLE:%=example-%)
_CFLAGS := $(addprefix -I,$(INC_DIRS)) $(CFLAGS) -Wall -Wextra _CFLAGS := $(addprefix -I,$(INC_DIRS)) $(CFLAGS) -Wall -Wextra
.PHONY: all
all: lib
# =====COMPILATION===== # =====COMPILATION=====
# Utility used by the CI to lint # Utility used by the CI to lint
.PHONY: lib
$(LIB_ARCHIVE): $(OBJS)
ar -rcs $@ $^
.PHONY: objs .PHONY: objs
objs: $(OBJS) objs: $(OBJS)
.PHONY: lib
lib: $(LIB)
$(LIB): $(OBJS)
ar -rcs $@ $(OBJS)
$(BUILD_DIR)/$(SRC_DIR)/%.c.o: $(SRC_DIR)/%.c $(BUILD_DIR)/$(SRC_DIR)/%.c.o: $(SRC_DIR)/%.c
mkdir -p $(dir $@) mkdir -p $(dir $@)
$(CC) -c $(_CFLAGS) $< -o $@ $(CC) -c $(_CFLAGS) $< -o $@
@ -56,7 +47,7 @@ test-mem: $(BIN_TEST)
.PHONY: build-test .PHONY: build-test
build-test: $(BIN_TEST) build-test: $(BIN_TEST)
$(BIN_TEST): $(OBJS_TEST) $(LIB) $(BIN_TEST): $(OBJS_TEST) $(LIB_ARCHIVE)
$(CC) -o $@ $^ $(_LDFLAGS) $(CC) -o $@ $^ $(_LDFLAGS)
# Along with the include directory, each test includes $(TEST_DIR) (which # Along with the include directory, each test includes $(TEST_DIR) (which
@ -73,7 +64,7 @@ $(BUILD_DIR)/$(TEST_DIR)/%.c.o: $(TEST_DIR)/%.c
.PHONY: build-example .PHONY: build-example
build-example: $(BINS_EXAMPLE) build-example: $(BINS_EXAMPLE)
$(BINS_EXAMPLE): %: %.c.o $(LIB) $(BINS_EXAMPLE): %: %.c.o $(LIB_ARCHIVE)
$(CC) $(LDFLAGS) \ $(CC) $(LDFLAGS) \
$^ -o $@ $^ -o $@
@ -85,22 +76,22 @@ $(BUILD_DIR)/$(EXAMPLE_DIR)/%.c.o: $(EXAMPLE_DIR)/%.c
# =====MAINTENANCE===== # =====MAINTENANCE=====
.PHONY: lint .PHONY: lint
lint: lint:
clang-format -n --Werror \ @ clang-format -n --Werror \
$(filter-out $(THIRDPARTY),$(SRCS)) \ $(shell find '$(SRC_DIR)/$(LIB)' -iname '*.c') \
$(filter-out $(THIRDPARTY),$(SRCS_H)) \ $(shell find '$(SRC_DIR)/_include/$(LIB)' -iname '*.h') \
$(filter-out $(THIRDPARTY),$(SRCS_H_INTERNAL)) $(shell find 'include/$(LIB)' -iname '*.h')
.PHONY: fmt .PHONY: fmt
fmt: fmt:
clang-format -i \ @ clang-format -i \
$(filter-out $(THIRDPARTY),$(SRCS)) \ $(shell find '$(SRC_DIR)/$(LIB)' -iname '*.c') \
$(filter-out $(THIRDPARTY),$(SRCS_H)) \ $(shell find '$(SRC_DIR)/_include/$(LIB)' -iname '*.h') \
$(filter-out $(THIRDPARTY),$(SRCS_H_INTERNAL)) $(shell find 'include/$(LIB)' -iname '*.h')
.PHONY: check .PHONY: check
check: check:
mkdir -p $(BUILD_DIR)/cppcheck @ mkdir -p $(BUILD_DIR)/cppcheck
cppcheck \ @ cppcheck \
$(addprefix -I,$(INC_DIRS)) \ $(addprefix -I,$(INC_DIRS)) \
--cppcheck-build-dir=$(BUILD_DIR)/cppcheck \ --cppcheck-build-dir=$(BUILD_DIR)/cppcheck \
--error-exitcode=1 \ --error-exitcode=1 \
@ -109,7 +100,7 @@ check:
--check-level=exhaustive \ --check-level=exhaustive \
--quiet \ --quiet \
-j$(shell nproc) \ -j$(shell nproc) \
$(filter-out $(THIRDPARTY),$(SRCS)) $(shell find '$(SRC_DIR)/$(LIB)' -iname '*.c')
.PHONY: clean .PHONY: clean
clean: clean:

View File

@ -1,10 +1,9 @@
LIB_FILENAME = liblnm.a LIB = lnm
BUILD_DIR = build BUILD_DIR = build
SRC_DIR = src SRC_DIR = src
TEST_DIR = test TEST_DIR = test
EXAMPLE_DIR = example EXAMPLE_DIR = example
THIRDPARTY = src/picohttpparser.c include/picohttpparser.h
PUB_INC_DIR = include PUB_INC_DIR = include
INC_DIRS = $(PUB_INC_DIR) src/_include INC_DIRS = $(PUB_INC_DIR) src/_include