Makefile

####################################################################################################
## Variables
####################################################################################################

# Build configuration
BUILD_TYPE    ?= Debug
BUILD_DIR     := build
CMAKE_OPTIONS ?=
NPROC         := $(shell nproc 2>/dev/null || echo 4)

# Directories
DOC_DIR       := docs
VENV_DIR      := .venv

SHELL := /bin/bash
.SHELLFLAGS := -e -o pipefail -c

.DEFAULT_GOAL := help

####################################################################################################
## Help
####################################################################################################

.PHONY: help
help: ## Show this help message
	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; \
	{printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'

####################################################################################################
## Build Targets
####################################################################################################

.PHONY: build
build: ## Build the project (debug by default, use BUILD_TYPE=Release for optimized)
	@echo "Configuring with CMake (BUILD_TYPE=$(BUILD_TYPE))..."
	@cmake -B $(BUILD_DIR) -DCMAKE_BUILD_TYPE=$(BUILD_TYPE) -DSERPENT_BUILD_TESTS=ON $(CMAKE_OPTIONS)
	@echo "Building..."
	@cmake --build $(BUILD_DIR) -j$(NPROC)

.PHONY: release
release: ## Build optimized release version
	@$(MAKE) build BUILD_TYPE=Release

.PHONY: clean
clean: ## Remove build artifacts
	@echo "Cleaning build directory..."
	@rm -rf $(BUILD_DIR)
	@rm -rf ./site ./doxygen

.PHONY: rebuild
rebuild: clean build ## Clean and rebuild

####################################################################################################
## Testing
####################################################################################################

.PHONY: test
test: build ## Run all tests
	@echo "Running tests..."
	@cd $(BUILD_DIR) && ctest --output-on-failure

.PHONY: test-verbose
test-verbose: build ## Run tests with verbose output
	@cd $(BUILD_DIR) && ctest --output-on-failure --verbose

.PHONY: test-valgrind
test-valgrind: build ## Run tests with Valgrind memory checker
	@echo "Running tests with Valgrind..."
	@valgrind --leak-check=full --suppressions=valgrind.supp ./$(BUILD_DIR)/serpent_test

####################################################################################################
## Examples
####################################################################################################

.PHONY: examples
examples: build ## Build and run all examples
	@echo "Running examples..."
	@for f in $$(find $(BUILD_DIR) -maxdepth 1 -name "*_example" -type f -executable); do \
		echo ""; echo "=== Running $$(basename $$f) ==="; $$f; \
	done

####################################################################################################
## Code Quality
####################################################################################################

.PHONY: format
format: ## Format C++ code using `clang-format`
	@echo "Formatting code..."
	@find src include test -name '*.cc' -o -name '*.h' 2>/dev/null | xargs -r clang-format -i

.PHONY: lint
lint: ## Run static analysis (`clang-tidy` and `cppcheck`)
	@echo "Running cppcheck..."
	@cppcheck --enable=all --inconclusive --quiet --std=c++20 -Iinclude --suppress=missingIncludeSystem src include test
	@echo "Running clang-tidy..."
	@if [ -f $(BUILD_DIR)/compile_commands.json ]; then find src -name '*.cc' | head -5 | \
	xargs -I{} clang-tidy {} -p $(BUILD_DIR); else echo "Build first to generate compile_commands.json"; fi

####################################################################################################
## Documentation
####################################################################################################

.PHONY: docs-mkdocs
docs-mkdocs: ## Build MkDocs documentation
	@echo "Building MkDocs documentation..."
	@mkdocs build

.PHONY: docs-mkdocs-serve
docs-mkdocs-serve: ## Serve MkDocs documentation locally
	@echo "Serving MkDocs at http://localhost:8001..."
	@mkdocs serve -a localhost:8001

.PHONY: docs-doxygen
docs-doxygen: ## Generate API documentation with Doxygen
	@echo "Generating Doxygen API docs..."
	@doxygen Doxyfile

.PHONY: docs-doxygen-serve
docs-doxygen-serve: ## Serve Doxygen documentation locally
	@echo "Serving Doxygen docs at http://localhost:8002..."
	@cd ./doxygen/html && python3 -m http.server 8002

####################################################################################################
## Dependencies
####################################################################################################

.PHONY: install-deps
install-deps: ## Install system dependencies (Debian/Ubuntu)
	@echo "Installing system dependencies..."
	sudo apt-get update
	sudo apt-get install -y cmake build-essential clang clang-format clang-tidy \
 	cppcheck valgrind gdb doxygen graphviz python3 python3-pip python3-venv

.PHONY: install-python-deps
install-python-deps: ## Install Python dependencies for docs
	@echo "Setting up Python environment..."
	@python3 -m venv $(VENV_DIR)
	@$(VENV_DIR)/bin/pip install mkdocs mkdocs-material

.PHONY: submodules
submodules: ## Initialize and update git submodules
	@echo "Updating git submodules..."
	@git submodule update --init --recursive

####################################################################################################
## Additonal Targets
####################################################################################################

.PHONY: setup-hooks
setup-hooks: ## Install Git hooks (pre-commit and pre-push)
	@echo "Installing Git hooks..."
	@pre-commit install --hook-type pre-commit
	@pre-commit install --hook-type pre-push
	@pre-commit install-hooks

.PHONY: test-hooks
test-hooks: ## Run Git hooks on all files manually
	@echo "Running Git hooks..."
	@pre-commit run --all-files