Merge branch 'lukeshu/lint'

8 files changed, 127 insertions, 55 deletions

diff --git a/.editorconfig b/.editorconfig
index 8fb3a6f..0baab4f 100644
--- a/.editorconfig
+++ b/.editorconfig
@@ -30,10 +30,10 @@ _mode = markdown
 [*.9p{,.wip}]
 _mode = 9p
 
-[{lib9p/tests/test_server/static.h.gen,build-aux/embed-sources.h.gen}]
+[{lib9p/tests/test_server/static.h.gen,build-aux/embed-sources.h.gen,build-aux/lint-{generic,unknown},build-aux/get-dscname}]
 _mode = sh
 
-[{build-aux/linux-errno.txt.gen,libusb/include/libusb/tusb_helpers.h.gen,lib9p/tests/runtest}]
+[{build-aux/lint-h,build-aux/linux-errno.txt.gen,libusb/include/libusb/tusb_helpers.h.gen,lib9p/tests/runtest}]
 _mode = bash
 
 [{lib9p/idl.gen,lib9p/include/lib9p/linux-errno.h.gen,build-aux/stack.c.gen}]
diff --git a/GNUmakefile b/GNUmakefile
index ab28ede..db7f7fd 100644
--- a/GNUmakefile
+++ b/GNUmakefile
@@ -42,6 +42,7 @@ libusb/include/libusb/tusb_helpers.h 3rd-party/MS-LCID.pdf 3rd-party/MS-LCID.txt
 	$^
 
 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                  \
@@ -50,6 +51,8 @@ build-aux/sources.mk: $(if $(wildcard .git),FORCE)
 	| sort                                                        \
 	>$@.tmp
 	if ! cmp -s $@.tmp $@; then mv $@.tmp $@; fi
+	@echo '################################################################################'
+endif
 
 generate: $(generate/files)
 .PHONY: generate
@@ -70,15 +73,15 @@ $(foreach t,$(build_types),$(foreach p,$(platforms),build/$p-$t/Makefile)): buil
 	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)
+	$(MAKE) -C $(<D) INNER=t
 .PHONY: $(foreach t,$(build_types),$(foreach p,$(platforms),build/$p-$t/build))
 
 check: build
-	$(MAKE) -j1 -k $(foreach t,$(build_types),$(foreach p,$(platforms),build/$p-$t/check))
+	$(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
+	CTEST_OUTPUT_ON_FAILURE=1 $(MAKE) -C $(<D) INNER=t test
 .PHONY: $(foreach t,$(build_types),$(foreach p,$(platforms),build/$p-$t/check))
 
 # `lint` and `format` ##########################################################
@@ -86,8 +89,6 @@ $(foreach t,$(build_types),$(foreach p,$(platforms),build/$p-$t/check)): build/%
 -include build-aux/sources.mk
 sources_all := $(foreach v,$(filter sources_%,$(.VARIABLES)),$($v))
 
-get_dscname = sed -n '1,3{ /^\#!/d; /^<!--$$/d; /-\*- .* -\*-/d; s,[/*\# ]*,,; s/ - .*//;p; q; }'
-
 build-aux/venv: build-aux/requirements.txt
 	python3 -m venv $@
 	$@/bin/pip install -r $<
@@ -95,58 +96,26 @@ build-aux/venv: build-aux/requirements.txt
 
 # `lint` ###########
 lint:
-	$(MAKE) -k $(patsubst sources_%,lint/%,$(filter sources_%,$(.VARIABLES)))
+	$(MAKE) -k INNER=t $(patsubst sources_%,lint/%,$(filter sources_%,$(.VARIABLES)))
 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_$*)
-lint/c: lint/%:
-	@for filename in $(filter %.h,$(sources_$*)); do \
-	    dscname=$$($(get_dscname) $$filename); \
-	    guard=$${dscname//'/'/'_'}; \
-	    guard=$${guard//'.'/'_'}; \
-	    guard="_$${guard^^}_"; \
-	    if ! { grep -Fxq "#ifndef $${guard}"      "$$filename" && \
-	           grep -Fxq "#define $${guard}"      "$$filename" && \
-	           grep -Fxq "#endif /* $${guard} */" "$$filename"; }; then \
-	        echo "$$filename does not have $${guard} guard"; r=1; \
-	    fi; \
-	done; exit $$r
+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/%:
-	@printf "%s: cannot lint unknown file type\n" $(sources_$*) >&2
-lint/all: lint/%:
-	$(eval export sources_$*)
-	@find $$(printf '%s\n' $${sources_$*} | grep -vE '^lib9p/tests/[^/]+/static/') \
-	    -maxdepth 0 -type f | \
-	{ r=0; while read -r filename; do \
-	    if ! grep -E -q 'Copyright \(C\) 202[4-9]((-|, )202[5-9])*  Luke T. Shumaker' $$filename; then \
-	        echo "$$filename is missing a copyright statement"; r=1; \
-	    fi; \
-	    if ! grep -q ' SPDX-License-Identifier[:] ' $$filename; then \
-	        echo "$$filename is missing an SPDX-License-Identifier"; r=1; \
-	    fi; \
-	    dscname_act=$$($(get_dscname) $$filename); \
-	    dscname_exp=$$(echo "$$filename" | sed \
-	        -e 's,.*/config/,,' \
-	        -e 's,.*/config\.h$$,config.h,' \
-	        -e 's,.*include/,,' \
-	        -e 's/\.wip$$//'); \
-	    if [ "$$dscname_act" != "$$dscname_exp" ] && [ "cmd/$$dscname_act" != "$$dscname_exp" ]; then \
-	        echo "$$filename self-identifies as $$dscname_act (expected $$dscname_exp)"; r=1; \
-	    fi; \
-	    if grep -n --color=auto "$$(printf '\\S\t')" $$filename; then \
-	        echo "$$filename uses tabs for alignment"; r=1; \
-	    fi; \
-	done; exit $$r; }
+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 $$(printf '%s\n' $(sources_$*) | grep -vE '^lib9p/tests/[^/]+/static/')
 .PHONY: lint lint/%
 
 # `format` #########
 format:
-	$(MAKE) -k $(patsubst sources_%,format/%,$(filter-out sources_all,$(filter sources_%,$(.VARIABLES))))
+	$(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_$*)
diff --git a/build-aux/get-dscname b/build-aux/get-dscname
new file mode 100755
index 0000000..c8b3681
--- /dev/null
+++ b/build-aux/get-dscname
@@ -0,0 +1,12 @@
+#!/bin/sh
+# build-aux/get-dscname - Get a file's self-described filename
+#
+# Copyright (C) 2024-2025  Luke T. Shumaker <lukeshu@lukeshu.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+if [ $# -ne 1 ]; then
+	echo "$0: expected exactly 1 argument"
+	exit 2
+fi
+
+sed -n '1,3{ /^\#!/d; /^<!--$/d; /-\*- .* -\*-/d; s,[/*\# ]*,,; s/ - .*//;p; q; }' -- "$1"
diff --git a/build-aux/lint-generic b/build-aux/lint-generic
new file mode 100755
index 0000000..c02dc34
--- /dev/null
+++ b/build-aux/lint-generic
@@ -0,0 +1,54 @@
+#!/bin/sh
+# build-aux/lint-generic - Non-language-specific lint checks
+#
+# Copyright (C) 2024-2025  Luke T. Shumaker <lukeshu@lukeshu.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+RED=$(tput setaf 1)
+RESET=$(tput sgr0)
+
+err() {
+	printf "${RED}%s${RESET}: %s\n" "$1" "$2" >&2
+	r=1
+}
+
+r=0
+for filename in "$@"; do
+	if ! { [ -f "$filename" ] && ! [ -h "$filename" ]; }; then
+		# Ignore non-files
+		continue
+	fi
+
+	# File header ##########################################################
+
+	shebang="$(sed -n '1{/^#!/{/^#!\/hint\//q; p;};}' "$filename")"
+	if [ -x "$filename" ] && [ -z "$shebang" ]; then
+		err "$filename" 'is executable but does not have a shebang'
+	elif [ -n "$shebang" ] && ! [ -x "$filename" ]; then
+		err "$filename" 'has a shebang but is executable'
+	fi
+
+	if ! grep -E -q 'Copyright \(C\) 202[4-9]((-|, )202[5-9])*  Luke T. Shumaker' "$filename"; then
+		err "$filename" 'is missing a copyright statement'
+	fi
+	if ! grep -q ' SPDX-License-Identifier[:] ' "$filename"; then
+		err "$filename" 'is missing an SPDX-License-Identifier'
+	fi
+
+	dscname_act=$(./build-aux/get-dscname "$filename")
+	dscname_exp=$(echo "$filename" | sed \
+		-e 's,.*/config/,,' \
+		-e 's,.*/config\.h$,config.h,' \
+		-e 's,.*include/,,' \
+		-e 's/\.wip$//')
+	if [ "$dscname_act" != "$dscname_exp" ] && [ "cmd/$dscname_act" != "$dscname_exp" ]; then
+		err "$filename" "self-identifies as $dscname_act (expected $dscname_exp)"
+	fi
+
+	# File body ############################################################
+
+	if grep -n --color=auto "$(printf '\\S\t')" "$filename"; then
+		err "$filename" 'uses tabs for alignment'
+	fi
+done
+exit $r
diff --git a/build-aux/lint-h b/build-aux/lint-h
new file mode 100755
index 0000000..26ac13d
--- /dev/null
+++ b/build-aux/lint-h
@@ -0,0 +1,27 @@
+#!/usr/bin/env bash
+# build-aux/lint-h - Lint checks for C header files
+#
+# Copyright (C) 2024-2025  Luke T. Shumaker <lukeshu@lukeshu.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+RED=$(tput setaf 1)
+RESET=$(tput sgr0)
+
+err() {
+	printf "${RED}%s${RESET}: %s\n" "$1" "$2" >&2
+	r=1
+}
+
+r=0
+for filename in "$@"; do
+	dscname=$(./build-aux/get-dscname "$filename")
+	guard=${dscname//'/'/'_'}
+	guard=${guard//'.'/'_'}
+	guard="_${guard^^}_"
+	if ! { grep -Fxq "#ifndef ${guard}"      "$filename" &&
+	       grep -Fxq "#define ${guard}"      "$filename" &&
+	       grep -Fxq "#endif /* ${guard} */" "$filename"; }; then
+		err "$filename" "does not have ${guard} guard"
+	fi
+done
+exit $r
diff --git a/build-aux/lint-unknown b/build-aux/lint-unknown
new file mode 100755
index 0000000..3c2e91b
--- /dev/null
+++ b/build-aux/lint-unknown
@@ -0,0 +1,10 @@
+#!/bin/sh
+# build-aux/lint-unknown - Lint checks for unknown files
+#
+# Copyright (C) 2024-2025  Luke T. Shumaker <lukeshu@lukeshu.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+RED=$(tput setaf 1)
+RESET=$(tput sgr0)
+
+printf "${RED}%s${RESET}: cannot lint unknown file type\n" "$@" >&2
diff --git a/lib9p/9p.generated.c b/lib9p/9p.generated.c
index ab39102..df81d25 100644
--- a/lib9p/9p.generated.c
+++ b/lib9p/9p.generated.c
@@ -39,7 +39,7 @@
  * (because `!CONFIG_9P_ENABLE_##ver`).  This is useful when `||`ing
  * several version checks together.
  */
-#define is_ver(ctx, ver) _is_ver_##ver(ctx->ctx->version)
+#define is_ver(CTX, ver) _is_ver_##ver(CTX->ctx->version)
 
 /* strings ********************************************************************/
 
diff --git a/lib9p/idl.gen b/lib9p/idl.gen
index 0b86246..b23b5b8 100755
--- a/lib9p/idl.gen
+++ b/lib9p/idl.gen
@@ -368,12 +368,6 @@ def gen_c(versions: set[str], typs: list[idl.Type]) -> str:
     def unused(arg: str) -> str:
         return f"LM_UNUSED({arg})"
 
-    for v in sorted(versions):
-        ret += f"#if CONFIG_9P_ENABLE_{v.replace('.', '_')}\n"
-        ret += f"\t#define _is_ver_{v.replace('.', '_')}(v) (v == {c_ver_enum(v)})\n"
-        ret += "#else\n"
-        ret += f"\t#define _is_ver_{v.replace('.', '_')}(v) false\n"
-        ret += "#endif\n"
     id2typ: dict[int, idl.Message] = {}
     for msg in [msg for msg in typs if isinstance(msg, idl.Message)]:
         id2typ[msg.msgid] = msg
@@ -400,6 +394,12 @@ def gen_c(versions: set[str], typs: list[idl.Type]) -> str:
         ret += "};\n"
         return ret
 
+    for v in sorted(versions):
+        ret += f"#if CONFIG_9P_ENABLE_{v.replace('.', '_')}\n"
+        ret += f"\t#define _is_ver_{v.replace('.', '_')}(v) (v == {c_ver_enum(v)})\n"
+        ret += "#else\n"
+        ret += f"\t#define _is_ver_{v.replace('.', '_')}(v) false\n"
+        ret += "#endif\n"
     ret += "\n"
     ret += "/**\n"
     ret += f" * is_ver(ctx, ver) is essentially `(ctx->ctx->version == {idprefix.upper()}VER_##ver)`,\n"
@@ -407,7 +407,7 @@ def gen_c(versions: set[str], typs: list[idl.Type]) -> str:
     ret += " * (because `!CONFIG_9P_ENABLE_##ver`).  This is useful when `||`ing\n"
     ret += " * several version checks together.\n"
     ret += " */\n"
-    ret += "#define is_ver(ctx, ver) _is_ver_##ver(ctx->ctx->version)\n"
+    ret += "#define is_ver(CTX, ver) _is_ver_##ver(CTX->ctx->version)\n"
 
     # strings ##################################################################
     ret += f"""