# GNUmakefile - Main build script for sbc-harness project
#
# Copyright (C) 2024-2025  Luke T. Shumaker <lukeshu@lukeshu.com>
# SPDX-License-Identifier: AGPL-3.0-or-later

# Project configuration ########################################################

linux.git = $(HOME)/src/github.com/torvalds/linux

all: build
.PHONY: all

# Configure GNU Make itself ####################################################

ifeq ($(filter notintermediate,$(.FEATURES)),)
$(error This $(firstword $(MAKEFILE_LIST)) requies GNU Make 4.4 or later for .NOTINTERMEDIATE)
endif

.NOTINTERMEDIATE:
.DELETE_ON_ERROR:

.PHONY: FORCE

# `generate` ###################################################################

generate/files =

generate/files += COPYING.txt
COPYING.txt:
	wget --no-use-server-timestamps -O $@ https://www.gnu.org/licenses/agpl-3.0.txt

generate/files += 3rd-party/COPYING.newlib.txt
3rd-party/COPYING.newlib.txt: /usr/share/licenses/arm-none-eabi-newlib/COPYING.NEWLIB
	cp $< $@

generate/files += 3rd-party/linux-errno.txt
3rd-party/linux-errno.txt: build-aux/linux-errno.txt.gen
	$< $(linux.git) $@

generate/files += lib9p/include/lib9p/linux-errno.h
lib9p/include/lib9p/linux-errno.h: %: %.gen 3rd-party/linux-errno.txt
	$^ >$@

generate/files += lib9p/9p.generated.c lib9p/include/lib9p/9p.generated.h
lib9p/9p.generated.c lib9p/include/lib9p/9p.generated.h &: lib9p/idl.gen lib9p/idl/__init__.py lib9p/idl lib9p/idl/*.9p
	$< $(filter %.9p,$^)

generate/files += libusb/include/libusb/tusb_helpers.h 3rd-party/MS-LCID.pdf 3rd-party/MS-LCID.txt
libusb/include/libusb/tusb_helpers.h 3rd-party/MS-LCID.pdf 3rd-party/MS-LCID.txt &: libusb/include/libusb/tusb_helpers.h.gen
	$^

generate/files += build-aux/sources.mk
ifeq ($(INNER),)
build-aux/sources.mk: $(if $(wildcard .git),FORCE)
	git ls-files | grep -vFx $(foreach f,$(generate/files),-e $f) \
	| sed 's,^,$(CURDIR)/,' | xargs editorconfig                  \
	| sed -nE -e 's,\[$(CURDIR)/(.*)\],\1,p' -e 's/^_mode=//p'    \
	| sed -E '{N;s/(.*)\n(.*)/sources_\2 += \1/;}'                \
	| sort                                                        \
	>$@.tmp
	if ! cmp -s $@.tmp $@; then mv $@.tmp $@; fi
	@echo '################################################################################'
endif

generate: $(generate/files)
.PHONY: generate

generate-clean:
	rm -f -- $(generate/files)
.PHONY: generate-clean

# `build` and `check` ##########################################################

platforms := rp2040 host # $(shell sed -nE 's/if *\(PICO_PLATFORM STREQUAL "(.*)"\)/\1/p' cmd/*/CMakeLists.txt)
build_types = Debug Release RelWithDebInfo MinSizeRel

build: $(foreach t,$(build_types),$(foreach p,$(platforms),build/$p-$t/build))
.PHONY: build

$(foreach t,$(build_types),$(foreach p,$(platforms),build/$p-$t/Makefile)): build/%/Makefile:
	mkdir -p $(@D) && cd $(@D) && cmake -DPICO_PLATFORM=$(firstword $(subst -, ,$*)) -DCMAKE_BUILD_TYPE=$(lastword $(subst -, ,$*)) ../..

$(foreach t,$(build_types),$(foreach p,$(platforms),build/$p-$t/build)): build/%/build: build/%/Makefile generate
	$(MAKE) -C $(<D)
.PHONY: $(foreach t,$(build_types),$(foreach p,$(platforms),build/$p-$t/build))

check: build
	$(MAKE) -j1 -k INNER=t $(foreach t,$(build_types),$(foreach p,$(platforms),build/$p-$t/check))
.PHONY: check

$(foreach t,$(build_types),$(foreach p,$(platforms),build/$p-$t/check)): build/%/check: build/%/Makefile
	CTEST_OUTPUT_ON_FAILURE=1 $(MAKE) -C $(<D) test
.PHONY: $(foreach t,$(build_types),$(foreach p,$(platforms),build/$p-$t/check))

# `lint` and `format` ##########################################################

-include build-aux/sources.mk
sources_all := $(foreach v,$(filter sources_%,$(.VARIABLES)),$($v))

build-aux/venv: build-aux/requirements.txt
	python3 -m venv $@
	$@/bin/pip install -r $<
	touch --no-create $@

# `lint` ###########
lint:
	$(MAKE) -k INNER=t $(patsubst sources_%,lint/%,$(filter sources_%,$(.VARIABLES)))
# Only lint binaries if the build scripts pass lint.
	$(MAKE) INNER=t lint/bin
lint/bin: build build-aux/lint-bin
	./build-aux/lint-bin $(foreach t,$(build_types),build/rp2040-$t/cmd/sbc_harness/sbc_harness.elf)
lint/sh lint/bash: lint/%:
	shellcheck $(sources_$*)
lint/python3: lint/%: build-aux/venv
	./build-aux/venv/bin/mypy --strict --scripts-are-modules $(sources_$*)
	./build-aux/venv/bin/black --check $(sources_$*)
	./build-aux/venv/bin/isort --check $(sources_$*)
	! grep -nh 'SPECIAL$$' -- lib9p/idl.gen
lint/c: lint/%: build-aux/lint-h build-aux/get-dscname
	./build-aux/lint-h $(filter %.h,$(sources_$*))
lint/make lint/cmake lint/gitignore lint/ini lint/9p lint/markdown: lint/%:
	@:
lint/unknown: lint/%: build-aux/lint-unknown
	./build-aux/lint-unknown $(sources_$*)
lint/all: lint/%: build-aux/lint-generic build-aux/get-dscname
	./build-aux/lint-generic '%s\n' $(sources_$*)
.PHONY: lint lint/%

# `format` #########
format:
	$(MAKE) -k INNER=t $(patsubst sources_%,format/%,$(filter-out sources_all,$(filter sources_%,$(.VARIABLES))))
format/python3: format/%: ./build-aux/venv
	./build-aux/venv/bin/black $(sources_$*)
	./build-aux/venv/bin/isort $(sources_$*)
format/sh format/bash: format/%
	@:
format/c: format/%:
	@: TODO: Adopt a C code-formatter
format/make format/cmake format/gitignore format/ini format/9p format/markdown: format/%:
	@:
format/unknown: format/%:
	@:
.PHONY: format format/%