From 1c0769fdc316a5e2982d8909e713050af223c928 Mon Sep 17 00:00:00 2001
From: "Luke T. Shumaker" <lukeshu@lukeshu.com>
Date: Mon, 27 Jan 2025 22:32:10 -0700
Subject: GNUmakefile: Pull lint/c, lint/all, and lint/unknown out into
 separate shell scripts

---
 .editorconfig          |  4 ++--
 GNUmakefile            | 46 ++++++----------------------------------------
 build-aux/get-dscname  | 12 ++++++++++++
 build-aux/lint-generic | 31 +++++++++++++++++++++++++++++++
 build-aux/lint-h       | 19 +++++++++++++++++++
 build-aux/lint-unknown |  7 +++++++
 6 files changed, 77 insertions(+), 42 deletions(-)
 create mode 100755 build-aux/get-dscname
 create mode 100755 build-aux/lint-generic
 create mode 100755 build-aux/lint-h
 create mode 100755 build-aux/lint-unknown

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..3abe629 100644
--- a/GNUmakefile
+++ b/GNUmakefile
@@ -86,8 +86,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 $<
@@ -102,46 +100,14 @@ 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` #########
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..9f9e0f7
--- /dev/null
+++ b/build-aux/lint-generic
@@ -0,0 +1,31 @@
+#!/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
+
+r=0
+for filename in "$@"; do
+	if ! { [ -f "$filename" ] && ! [ -h "$filename" ]; }; then
+		continue
+	fi
+	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=$(./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
+		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
diff --git a/build-aux/lint-h b/build-aux/lint-h
new file mode 100755
index 0000000..965d7d8
--- /dev/null
+++ b/build-aux/lint-h
@@ -0,0 +1,19 @@
+#!/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
+
+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
+		echo "$filename does not have ${guard} guard"; r=1
+	fi
+done
+exit $r
diff --git a/build-aux/lint-unknown b/build-aux/lint-unknown
new file mode 100755
index 0000000..59e83c2
--- /dev/null
+++ b/build-aux/lint-unknown
@@ -0,0 +1,7 @@
+#!/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
+
+printf "%s: cannot lint unknown file type\n" "$@" >&2
-- 
cgit v1.2.3-2-g168b