# SPDX-FileCopyrightText: 2023, 2024 Lady <https://www.ladys.computer/about/#lady>
# SPDX-License-Identifier: MPL-2.0

SHELL = /bin/sh

# ━ § BASIC INFORMATION ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
override define makefileinfo
 ╭────────────────────────────╮
╔╡ ⁌ ⛩️📰 书社 ∷ GNUmakefile ╞═════════════════════════════════╗
║╰────────────────────────────╯                                ║
╟┬ ¶ Prerequisites ───────────────────────────────────────────┬╢
║│                                                            │║
║│ Requires G·N·U Make, at least version 3.81, a version of   │║
║│ uuencode with base64 support, and the various programs     │║
║│ offered by libxml2 and libxslt. Beyond this, only programs │║
║│ required by Posix are required, altho there is a chance of │║
║│ version incompatibilities. The full list of program        │║
║│ requirements is as follows :—                             │║
║│                                                            │║
║│ • awk                                                      │║
║│ • cat                                                      │║
║│ • cksum                                                    │║
║│ • cp                                                       │║
║│ • date                                                     │║
║│ • echo                                                     │║
║│ • file                                                     │║
║│ • find                                                     │║
║│ • grep                                                     │║
║│ • git (optional)                                           │║
║│ • ln                                                       │║
║│ • mkdir (requires support for `-p´)                        │║
║│ • mv                                                       │║
║│ • od (requires support for `-t x1´)                        │║
║│ • pax (only when generating archives)                      │║
║│ • printf                                                   │║
║│ • rm                                                       │║
║│ • sed                                                      │║
║│ • sleep                                                    │║
║│ • stat                                                     │║
║│ • test                                                     │║
║│ • touch                                                    │║
║│ • tr (requires support for `-d´)                           │║
║│ • uuencode (requires support for `-m´ and `-r´)            │║
║│ • uudecode (requires support for `-m´ and `-r´)            │║
║│ • xargs (requires support for `-0´)                        │║
║│ • xmlcatalog (provided by libxml2)                         │║
║│ • xmllint (provided by libxml2)                            │║
║│ • xsltproc (provided by libxslt)                           │║
║│                                                            │║
║│ In all cases, you can supply your own version of any       │║
║│ program `program´ by overriding the corresponding variable │║
║│ `PROGRAM´ when calling Make.                               │║
║╰────────────────────────────────────────────────────────────╯║
╟┬ ¶ Usage ───────────────────────────────────────────────────┬╢
║│                                                            │║
║│ • `make all´ (default): Compile, but do not install, all   │║
║│   files.                                                   │║
║│                                                            │║
║│ • `make clean´: Remove `BUILDDIR´.                         │║
║│                                                            │║
║│ • `make gone´: Remove `BUILDDIR´ and installed files.      │║
║│                                                            │║
║│ • `make help´: Print this message.                         │║
║│                                                            │║
║│ • `make install´: Compile all files and install in         │║
║│   `DESTDIR´.                                               │║
║│                                                            │║
║│ • `make list´: List all recognized source files and their  │║
║│   classification (including media type and dependencies).  │║
║│                                                            │║
║│ • `make uninstall´: Remove installed files, but not        │║
║│   `BUILDDIR´.                                              │║
║│                                                            │║
║│ Set `VERBOSE=1´ to see the text of commands as they are    │║
║│ executed.                                                  │║
║│                                                            │║
║│ See `README.markdown´ for a more involved description of   │║
║│ the capabilities and configuration of this program.        │║
║╰────────────────────────────────────────────────────────────╯║
╟┬ ¶ Copyright & License ─────────────────────────────────────┬╢
║│                                                            │║
║│ Copyright © 2023–2024 Lady [@ Lady’s Computer].            │║
║│                                                            │║
║│ This Source Code Form is subject to the terms of the       │║
║│ Mozilla Public License, v 2.0. If a copy of the M·P·L was  │║
║│ not distributed with this file, You can obtain one at      │║
║│ <http://mozilla.org/MPL/2.0/>.                             │║
║╰────────────────────────────────────────────────────────────╯║
╚══════════════════════════════════════════════════════════════╝
endef

# ━ § MAKE·FILE SETUP ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

# Programs needed to run this make·file.
#
# If these are not installed on your computer, or you need to use a different implementation, you can override the appropriate variable.
AWK := awk
CAT := cat
CKSUM := cksum
CP := cp
DATE := date
ECHO := echo
FILE := file
FIND := find
GIT := git
GREP := grep
LN := ln
MKDIR := mkdir
MV := mv
OD := od
PAX := pax
PRINTF := printf
RM := rm
SED := sed
SLEEP := sleep
STAT := stat
TEST := test
TOUCH := touch
TR := tr
UUDECODE := uudecode
UUENCODE := uuencode
XARGS := xargs
XMLCATALOG := xmlcatalog
XMLLINT := xmllint
XSLTPROC := xsltproc

# This variable is not used in normal execution.
#
# In the archiving `MODE´, it provides the X·M·L file from which the archive should be constructed.
SRC :=

# This variable is not used in normal execution.
#
# In the archiving `MODE´, it provides a user‐friendly name for the archive.
NAME :=

# The directory which contains the source files.
#
# Multiple directories can be given so long as files with the same name do not exist in each.
SRCDIR := sources

# The directory which contains “includes”:
# Files which may be included in other files but for which no final output will be generated.
#
# Multiple directories can be given so long as files with the same name do not exist in each.
#
# These can be inside of `SRCDIR´ directories if desired.
INCLUDEDIR := sources/includes

# The directory in which to generate temporary buildfiles.
#
# This variable is also used by the archiving `MODE´.
BUILDDIR := build

# The directory into which to output files on `make install´.
#
# This variable is also used by the archiving `MODE´.
DESTDIR := public

# The location of this Makefile (and related ⛩️📰 书社 files), relative to the current working directory.
#
# By default, this is inferred from the variable `MAKEFILE_LIST´.
#
# This variable is also used by the archiving `MODE´.
THISDIR := $(patsubst %/,%,$(dir $(lastword $(MAKEFILE_LIST))))

# Configuration of `find´.
#
# By default, `find´ will ignore files which begin with a period and those which are likely to cause problems for `make´.
EXTRAFINDRULES :=
EXTRAFINDINCLUDERULES :=
FINDRULES := ! '(' '(' -name '[.-]*' -o -name '*[][*?:|$$%\#\\; ]*' -o -name '*[)]' ')' -a -prune ')'$(if $(EXTRAFINDRULES), -a $(EXTRAFINDRULES),)
FINDINCLUDERULES := $(FINDRULES)$(if $(EXTRAFINDINCLUDERULES), -a $(EXTRAFINDINCLUDERULES),)

# The list of magic files to use when determining media types.
#
# Some are provided as part of this repository, but you can add more if you need different media type detection.
#
# Your computer probably has several already installed at `/usr/share/file/magic´.
EXTRAMAGIC :=
MAGIC := $(sort $(patsubst ./%,%,$(wildcard $(THISDIR)/magic/*)) $(EXTRAMAGIC))

# The list of parsers for plaintext file types.
#
# Which parsers are provided will influence which kinds of files are recognized as plaintext.
EXTRAPARSERS :=
PARSERS := $(sort $(patsubst ./%,%,$(wildcard $(THISDIR)/parsers/*.xslt)) $(EXTRAPARSERS))

# The list of transforms.
EXTRATRANSFORMS :=
TRANSFORMS := $(sort $(patsubst ./%,%,$(wildcard $(THISDIR)/transforms/*.xslt)) $(EXTRATRANSFORMS))

# List of types which should be treated as X·M·L.
XMLTYPES := application/xml text/xml

ifdef GIT
ifneq ($(wildcard $(THISDIR)/.git),)
# A description of the current git revision of ⛩️📰 书社.
THISREV := $(shell cd $(THISDIR); $(GIT) describe 2> /dev/null || $(GIT) rev-parse HEAD 2> /dev/null || true)
endif

ifneq ($(wildcard .git),)
# A description of the current git revision of the working directory.
SRCREV := $(shell $(GIT) describe 2> /dev/null || $(GIT) rev-parse HEAD 2> /dev/null || true)
endif
endif

# The mode in which to run this make·file.
# Modes essentially allow for the combination of multiple conceptual make·files into a single source.
#
# The following modes are available :—
#
# • ‹ urn:fdc:ladys.computer:20231231:Shu1She4:mode:default ›:
#   The default mode; typical Shushe behaviours.
#
# • ‹ urn:fdc:ladys.computer:20231231:Shu1She4:mode:archive ›:
#   Generates archive files from parse results.
MODE := urn:fdc:ladys.computer:20231231:Shu1She4:mode:default

# Set to a non·empty value to print all commands as they run.
VERBOSE :=

# The default target for this makefile.
.DEFAULT_GOAL := all

# ━ § BEGIN SHARED MAKE·FILE CONSTRUCTS ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

# ─ ¶ Non‐Recipe Variable Definitions ─────────────────────────────────

# A variable with no value, usable when assigning values which contain whitespace.
override empty :=

# A variable which contains a newline, to allow the generation of multiline strings in function calls.
override define newline


endef

# A variable which contains a single space.
override space := $(empty) $(empty)

# A variable which contains a single comma.
override comma := ,

# (callable) Quote the given string for use within shell calls.
override quote = '$(subst ','"'"',$1)'

# Outputs an `@´ to silence rules, unless `VERBOSE´ is nonempty.
override silent := $(if $(VERBOSE),,@)

# (callable) Get the modified time of the provided file.
#
# This is messy; there is no portable way of using `stat´.
#
# ☡ This variable creates a subshell every time it is computed.
override modtime = $(shell if $(STAT) --version 2> /dev/null | $(GREP) -q GNU; then $(DATE) -d "@$$(TZ= $(STAT) -c '%Y' $(call quote,$1))" '+%Y-%m-%dT%H:%M:%SZ'; else TZ= $(STAT) -f '%Sm' -t '%Y-%m-%dT%H:%M:%SZ' $(call quote,$1); fi)

# ─ ¶ Recipe Variable Definitions ─────────────────────────────────────

# (callable) Check to see if the given directory exists and create it if not.
override ensuredirectory = if $(TEST) ! -d $(call quote,$1); then $(MKDIR) -p $(call quote,$1); fi

# (callable) Test if the provided xpath expression matches the provided document.
override xpath = $(XMLLINT) --xpath $(call quote,$1) $(call quote,$2) > /dev/null 2> /dev/null

# (callable) Extract the value of the text nodes in the provided X·M·L document and print them to `stdout´.
override extracttext = $(PRINTF) '%s' '<transform xmlns="http://www.w3.org/1999/XSL/Transform" version="1.0"><output method="text" encoding="UTF-8"/></transform>' | $(XSLTPROC) --nonet --novalid - $(call quote,$1)

# (callable) Process the provided transformation result and output the result to the provided location, given the provided relative path.
override processresultto = if $(call xpath,/*[local-name()="raw-text" and namespace-uri()="urn:fdc:ladys.computer:20231231:Shu1She4"],$1); then $(RM) -f $(call quote,$2); $(call extracttext,$1) > $(call quote,$2); elif $(call xpath,/*[local-name()="base64-binary" and namespace-uri()="urn:fdc:ladys.computer:20231231:Shu1She4"],$1); then $(RM) -f $(call quote,$2); $(call extracttext,$1) | $(TR) -d '\t\n\f\r ' | $(XARGS) -0 $(PRINTF) 'begin-base64 644 -\n%s\n====\n' | $(UUDECODE) -o /dev/stdout > $(call quote,$2); elif $(call xpath,/*[local-name()="archive" and namespace-uri()="urn:fdc:ladys.computer:20231231:Shu1She4"],$1); then $(RM) -f $(call quote,$2); $(MAKE) -f $(call quote,$(abspath $(THISDIR)/GNUmakefile)) $(call quote,$2) NAME=$(call quote,$3) SRC=$(call quote,$1) BUILDDIR=$(call quote,$(BUILDDIR)/archive/$3) DESTDIR=$(call quote,$(patsubst %/,%,$(dir $2))) MODE='urn:fdc:ladys.computer:20231231:Shu1She4:mode:archive'; else $(RM) -f $(call quote,$2); $(XMLLINT) --nsclean $(call quote,$1) > $(call quote,$2); fi

# ━ § BEGIN DEFAULT MAKE·FILE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

ifeq ($(MODE),urn:fdc:ladys.computer:20231231:Shu1She4:mode:default)

# ─ ¶ Non‐Recipe Variable Definitions ─────────────────────────────────

# (callable) Test to see if the prerequisites provided by the second argument matches the value in the file corresponding to the first argument in `$(BUILDDIR)/lastprereqs´.
# If not, save the new value and then add FORCE.
# Return them regardless.
#
# Calling this variable is useful when a given target should be updated whenever its list of prerequisites changes in addition to whenever there is a change to one of its prerequisites.
#
# ☡ This variable creates at least one subshell every time it is computed.
override diffprereqs = $(if $(subst $(shell $(CAT) $(call quote,$(BUILDDIR)/lastprereqs/$1) 2> /dev/null || true),,$2),$2 FORCE$(and $(shell $(call ensuredirectory,$(BUILDDIR)/lastprereqs) && $(PRINTF) '%s\n' $(call quote,$2) > $(BUILDDIR)/lastprereqs/$1),),$2)

# (callable) Escape special characters for use in sed regular expressions.
override sedesc = $(subst /,[/],$(subst $$,\$$,$(subst *,\*,$(subst .,\.,$(subst [,\[,$(subst ^,\^,$(subst \,\\,$1)))))))

# The command to use for percent‐decoding.
override perdeccmd := $(SED) 's/|/%7C/g;s/[\]/%5C/g;s/%[0-9A-Fa-f]\{2\}/|&|/g' | $(TR) '|' '\n' | $(SED) '/^%[0-9A-Fa-f]\{2\}$$/!s/%/|%25|/' | $(TR) '|' '\n' | $(AWK) '$$0!~/%/{printf "%s",$$0}/%/{d="0123456789ABCDEF";v=substr(toupper($$0),2,2);printf "\\%04o",(index(d,substr(v,1,1))-1)*16+index(d,substr(v,2,1))-1}' | $(XARGS) -0 $(PRINTF) '%b'

# (callable) Percent‐decode the given strings.
#
# ☡ This variable creates a subshell every time it is computed.
override perdec = $(shell $(PRINTF) '%s\0450A' $(foreach encoded,$1,$(call quote,$(encoded))) | $(perdeccmd))

# (callable) Percent‐encode the given strings.
#
# This singly‐encodes u·r·i characters and doubly‐encodes other characters, then calls `perdec´ to decode back to a single encoding.
# The encoding assumes the input is a “u·r·i component”; e·g that the resulting string should only contain `pchar´ (but can contain any `sub-delim´).
#
# It is assumed that the given strings do not contain newlines.
#
# ☡ This variable creates a subshell every time it is computed.
override perenc = $(shell $(PRINTF) '%s\n' $(foreach unencoded,$1,$(call quote,$(unencoded))) | $(OD) -t x1 | $(SED) 's/^[0-9]*//;s/0[Aa]/%&/g;s/2[146-9A-Ea-e]/%&/g;s/3[0-9AaBbDd]/%&/g;s/40/%&/g;s/[46][1-9A-Fa-f]/%&/g;s/[57][0-9Aa]/%&/g;s/5[Ff]/%&/g;s/7[Ee]/%&/g;s/[ ][0-9A-Fa-f]\{2\}/%25&/g' | $(TR) -d ' \n' | $(TR) 'abcdef' 'ABCDEF' | $(perdeccmd))

# (callable) Percent‐encode each component in the given paths.
#
# ☡ This variable creates a subshell every time it is computed.
override pathenc = $(subst %2F,/,$(call perenc,$1))

# (overridable) Collect all of the applicable includes from the includes directory.
sourceincludes := $(shell $(FIND) $(foreach dir,$(INCLUDEDIR),$(call quote,$(dir))) '(' $(FINDRULES) ')' -a -type f)

# (overridable) Collect all of the applicable source files from the source directory, removing any which are also includes.
sourcefiles := $(filter-out $(sourceincludes),$(shell $(FIND) $(foreach dir,$(SRCDIR),$(call quote,$(dir))) '(' $(FINDRULES) ')' -a -type f))

# Figure out the file type of each source file and source include.
ifneq ($(wildcard $(BUILDDIR)/magic.mgc),)
override types := $(shell $(PRINTF) '%s\n' $(call quote,$(sourcefiles) $(sourceincludes)) | $(SED) 's/^ *//;s/ *$$//;s/ {2,}/ /g' | $(TR) ' ' '\n' | $(FILE) -m $(call quote,$(BUILDDIR)/magic.mgc) --mime-type --separator '|' --files-from - | $(SED) 's/| */|/g')
endif

# Get the list of supported plaintext file types from the parser.
ifneq ($(wildcard $(BUILDDIR)/parser.xslt),)
override plaintexttypes := $(filter-out $(XMLTYPES),$(shell $(XMLLINT) --xpath '/*/*[@name="书社:parsers"]//*[namespace-uri()="http://www.w3.org/1999/xhtml" and local-name()="dd"]/text()' $(call quote,$(BUILDDIR)/parser.xslt)))
endif

# (callable) Get all of the files (source and includes) which have the given types.
override filesoftype = $(foreach type,$1,$(patsubst %|$(type),%,$(filter %|$(type),$(types))))

# Build up collections of various file types.
override xmlfiles := $(call filesoftype,$(XMLTYPES))
override plaintextfiles := $(filter-out $(xmlfiles),$(call filesoftype,$(plaintexttypes)))
override assetfiles := $(filter-out $(xmlfiles) $(plaintextfiles),$(sourcefiles) $(sourceincludes))

# (callable) Get the types of the given files.
override typeoffile = $(patsubst $(foreach file,$1,$(file)|%),%,$(filter $(foreach file,$1,$(file)|%),$(types)))

# Pair each source magic file with its location in the build directory.
override magicpair := $(foreach magicfile,$(MAGIC),$(magicfile)|$(BUILDDIR)/magic/$(notdir $(magicfile)))

# (callable) Get the source file for the given magic files.
override magicsource = $(foreach magicpath,$1,$(patsubst %|$(magicpath),%,$(firstword $(filter %|$(magicpath),$(magicpair)))))

# (callable) Get the build file for the given magic files.
override magicfile = $(foreach file,$1,$(patsubst $(file)|%,%,$(filter $(file)|%,$(magicpair))))

# (callable) Get the local path for the given source file.
override sourcepath = $(firstword $(foreach directory,$(SRCDIR),$(if $(filter $(directory)/%,$1),$(patsubst $(directory)/%,%,$1),)))

# (callable) Get the local path for the given include.
override includepath = $(firstword $(foreach directory,$(INCLUDEDIR),$(if $(filter $(directory)/%,$1),$(patsubst $(directory)/%,%,$1),)))

# (callable) Get base64 data u·r·i’s for the given files.
#
# ☡ This variable creates a subshell every time it is computed.
override datauri = $(foreach file,$1,data:$(call typeoffile,$(file));base64,$(shell $(UUENCODE) -m $(call quote,$(file)) _ | $(SED) '2,$$!d;$d' | $(TR) -d ' \n'))

# Pair each source file and include with its local u·r·i.
override sourcelocalpair := $(foreach file,$(sourcefiles) $(sourceincludes),$(file)|about:shushe?$(if $(filter $(file),$(sourceincludes)),include=$(call pathenc,$(call includepath,$(file))),source=$(call pathenc,$(call sourcepath,$(file)))))

# (callable) Get local uris for the given files.
override localuri = $(foreach file,$1,$(patsubst $(file)|%,%,$(filter $(file)|%,$(sourcelocalpair))))

# (callable) Get the source files for the given local uris.
override sourcefile = $(foreach local,$1,$(patsubst %|$(local),%,$(filter %|$(local),$(sourcelocalpair))))

# Adds a requirement on `$(BUILDDIR)/.update-types´ if the file is present.
#
# This file is created after a reload due to type changes, and is removed after.
# Requiring it ensures that file classifications are up·to·date immediately after the reload.
override typeupdates := $(wildcard $(BUILDDIR)/.update-types)

# Pair each source file and include with its parsed location.
override sourceparsedpair := $(foreach file,$(sourcefiles) $(sourceincludes),$(file)|$(BUILDDIR)/$(if $(filter $(file),$(sourceincludes)),includes/$(call includepath,$(file)),sources/$(call sourcepath,$(file))))

# (callable) Get the location of the transformed X·M·L files for the given source files.
override parsed = $(foreach file,$1,$(patsubst $(file)|%,%,$(filter $(file)|%,$(sourceparsedpair))))

# (callable) Get the source files for the given parsed file.
override unparsed = $(foreach file,$1,$(patsubst %|$(file),%,$(filter %|$(file),$(sourceparsedpair))))

# Pair each parser, transform, or parsed file with its file u·r·i.
override fileuripairs := $(join $(patsubst %,%|,$(PARSERS) $(TRANSFORMS) $(call parsed,$(sourcefiles) $(sourceincludes))),$(call pathenc,$(foreach uriable,$(PARSERS) $(TRANSFORMS) $(call parsed,$(sourcefiles) $(sourceincludes)),file://$(abspath $(uriable)))))

# (callable) Get the file u·r·is for the given parsers, transforms, or parsed files.
override fileuri = $(foreach file,$1,$(patsubst $(file)|%,%,$(filter $(file)|%,$(fileuripairs))))

ifneq ($(wildcard $(BUILDDIR)/dependencies),)
# Pair each file with a list of dependencies for it.
override dependenciesforfile := $(foreach file,$(filter-out $(assetfiles),$(sourcefiles) $(sourceincludes)),$(file)|$(subst $(space),|,$(shell $(CAT) $(call quote,$(BUILDDIR)/dependencies) | $(SED) $(call quote,/^$(call sedesc,$(call localuri,$(file)))$$/$(comma)/^[^	]/!d;/^	/!d;s/^	//))))

# (callable) Get the list of dependency leiris for the given source files.
#
# Recursive dependencies are marked with a leading `-´.
override dependencyuris = $(foreach file,$1,$(subst |, ,$(patsubst $(file)|%,%,$(filter $(file)|%,$(dependenciesforfile)))))

# (callable) Get the list of recursive dependencies for the given source files.
override recursives = $(foreach uri,$(filter -%,$(call dependencyuris,$1)),$(call sourcefile,$(patsubst -%,%,$(uri))))

# (callable) Get the list of (nonrecursive) dependencies for the given source files.
override dependencies = $(foreach uri,$(filter-out -%,$(call dependencyuris,$1)),$(call sourcefile,$(uri)))
endif

# Collect all files with recursive dependencies.
override recursivefiles := $(foreach file,$(filter-out $(assetfiles),$(sourcefiles)),$(if $(call recursives,$(file)),$(file),))

# Collect all files which should be compiled.
#
# This is all of the non·asset, nonrecursive files.
override compilablefiles := $(filter-out $(assetfiles) $(recursivefiles),$(sourcefiles))

# Collect all files which can be installed.
#
# This is all of the comilable files and all asset sources.
override installablefiles := $(compilablefiles) $(filter $(assetfiles),$(sourcefiles))

ifneq ($(wildcard $(BUILDDIR)/destinations),)
# Get the output of the destination transform.
override destinations := $(shell $(CAT) $(BUILDDIR)/destinations)

# Pair source files and their destinations.
override sourcedestinationpair := $(foreach destination,$(destinations),$(call sourcefile,$(firstword $(subst |, ,$(destination))))|$(call perdec,$(subst $(space),|,$(wordlist 2,$(words $(subst |, ,$(destination))),$(subst |, ,$(destination))))))

# (callable) Get the destination for the given source files.
override destination = $(foreach file,$1,$(patsubst $(file)|%,%,$(filter $(file)|%,$(sourcedestinationpair))))

# Pair each source file with its compiled location.
override sourcecompiledpair := $(foreach file,$(sourcefiles),$(file)|$(BUILDDIR)/results/$(call destination,$(file)))

# (callable) Get the location of the transformed X·M·L files for the given source files.
override compiled = $(foreach file,$1,$(patsubst $(file)|%,%,$(filter $(file)|%,$(sourcecompiledpair))))

# (callable) Get the location of the source files for the given compiled file.
override uncompiled = $(foreach file,$1,$(patsubst %|$(file),%,$(filter %|$(file),$(sourcecompiledpair))))

# (callable) Get the location of the final built files for the given source files.
override built = $(foreach file,$1,$(patsubst $(BUILDDIR)/results/%,$(BUILDDIR)/public/%,$(call compiled,$(file))))

# (callable) Get the location of the source files for the given built files.
override unbuilt = $(foreach file,$1,$(call uncompiled,$(patsubst $(BUILDDIR)/public/%,$(BUILDDIR)/results/%,$(file))))

# (callable) Get the installed locations for the given source files.
override installed = $(foreach file,$1,$(DESTDIR)/$(call destination,$(file)))
endif

# ─ ¶ Recipe Variable Definitions ─────────────────────────────────────

# (callable) Get the identifier for the given parser or transform.
override id = $(XMLLINT) --xpath '/*/*[local-name()="id" and namespace-uri()="urn:fdc:ladys.computer:20231231:Shu1She4"]/text()[1]' $(call quote,$1) 2> /dev/null || $(PRINTF) '%s\n' $(call quote,about:shushe?$(or $2,unknown)=$(call pathenc,$(basename $(notdir $1))))

# (callable) Sanitize and wrap the provided plaintext file in X·M·L, printing to `stdout´.
override wrapplaintext = $(TR) '\000\013\014' '\032\011\012' < $(call quote,$1) | $(SED) "$$($(PRINTF) '%b' 's/]]>/]]]]><!\\[CDATA\\[>/g\ns/\0357\0277\0276/�/g\ns/\0357\0277\0277/�/g\n$$!s/\\r$$//g\ns/\\r/\\n/g\n$$!s/\0302\0205$$//g\ns/\0302\0205/\\n/g;s/\0342\0200\0250/\\n/g;s/[\0001-\0010]/�/g;s/[\0016-\0037]/�/g')" | $(XARGS) -0 $(PRINTF) '%b%s]]></script>\n' '<?xml version=\042\061.0\042?>\n<script xmlns=\042http://www.w3.org/1999/xhtml\042 type=\042$(call typeoffile,$1)\042><![CDATA['

# (callable) Check if the provided X·M·L file is X·M·L 1.1, and if so, coerce to X·M·L 1.0 as best as possible, printing the result (or the original file contents) to `stdout´.
#
# The X·M·L declaration will be dropped and character escapes for C0 control codes will be replaced with a literal `U+0091 PRIVATE USE ONE´, which is invalid in X·M·L 1.1, but valid X·M·L 1.0 (making the replacement obvious).
#
# This isn’t a perfect substitution (it makes some assumptions about the format of the underlying X·M·L), but it should be workable for most sensible, welformed files.
override serializexml = $(SED) "$$($(PRINTF) '%b' '/<?xml[ \t]\\{1,\\}version=[\0042\0047]1.1/,$${ s/<?xml[^>]*?>/<!--<?xml version=\00421.1\0042?>-->/\n s/&\0043x0*[1-8BCEFbcef];/\0302\0221/g\n s/&\0043x0*1[0-9A-Fa-f];/\0302\0221/g\n s/&\00430*[1-8];/\0302\0221/g\n s/&\00430*1[124-9];/\0302\0221/g\n s/&\00430*2[0-9];/\0302\0221/g\n s/&\00430*3[01];/\0302\0221/g\n}')" < $(call quote,$1) | $(SED) "$$($(PRINTF) '%b' ':a\n/^\\n*$$/{ $$d\n N\n ba\n}')"

# ─ ¶ Phony Targets ───────────────────────────────────────────────────

# Compile all files, or error if any are recursive.
all : $(call built,$(recursivefiles) $(installablefiles)) ;

# Destroy buildfiles.
clean :
	$(if $(BUILDDIR),$(silent)$(RM) -rf $(call quote,$(BUILDDIR)/),)

# Destroy build directory and installed files.
gone : clean uninstall ;

# Provide help.
help :
	@$(PRINTF) '%b' '$(subst $(newline),\n,$(makefileinfo))'

# Install the compiled files into `DESTDIR´, or error if any are recursive.
install : $(call installed,$(recursivefiles) $(installablefiles)) ;

# List all source files and includes and their computed types.
list :
	@$(PRINTF) '%b' $(call quote,$(foreach file,$(sort $(sourcefiles)) $(sort $(sourceincludes)),\0033[1m$(file)\0033[22m|$(call typeoffile,$(file))|[\0033[3m$(if $(filter $(file),$(xmlfiles)),xml,$(if $(filter $(file),$(plaintextfiles)),text,asset))$(if $(filter $(file),$(sourceincludes)),|include,)\0033[23m]$(if $(call dependencies,$(file))$(call recursives,$(file)), $(strip $(foreach recursive,$(call recursives,$(file)),\0033[93;41m•|Recursive|Dependency|\0033[39;49m|$(recursive)) $(foreach dependency,$(call dependencies,$(file)),\0033[2m•|Dependency|\0033[22m|$(dependency))))$(if $(filter $(file),$(sourcefiles)), →|<\0033[4m/$(call destination,$(file))\0033[24m>,) )) | $(TR) ' |' '\n '

# Destroy installed files.
uninstall :
	$(foreach file,$(installablefiles),$(if $(wildcard $(call installed,$(file))),$(silent)$(PRINTF) '%s\n' $(call quote,Removing </$(patsubst $(DESTDIR)/%,%,$(call installed,$(file)))>…)$(newline)$(silent)$(RM) -f $(call quote,$(call installed,$(file)))$(newline),))

# Raise an error when attempting to build any files with recursive dependencies.
$(call built,$(recursivefiles)) :
	@$(PRINTF) '%b\n' $(call quote,\0033[93;41mError:\0033[39;49m `$(call unbuilt,$@)´ has recursive dependencies:\n$(subst |, ,$(subst $(space),$(newline),$(foreach recursive,$(call recursives,$(call unbuilt,$@)),•|$(recursive))))) && false

# Add as a prerequisite to treat the target as tho it were phony.
FORCE : ;

# ─ ¶ Special Targets ─────────────────────────────────────────────────

# Perform secondary expansion; this enables pattern rules to determine their prerequisites based on the matched pattern.
.SECONDEXPANSION : ;

# Don’t use any implicit rules.
.SUFFIXES : ;

# Phony rules; always consider these out·of·date.
.PHONY : FORCE all default clean gone info install list uninstall $(call built,$(recursivefiles)) ;

ifneq ($(typeupdates)$(wildcard $(BUILDDIR)/dependencies)$(wildcard $(BUILDDIR)/destinations),)
# Reload this make·file if the dependency graph or output destinations have changed.
#
# The dependency graph and output destinations are used to set the values of variables in this make·file, so it’s important to ensure that they are actually up·to·date prior to executing any later rules.
#
# This recipe only exists after types have been updated or when the dependency graph or destinations file already exists.
#
# ※ There is a chance that generating the dependencies will also update the parsers.
$(THISDIR)/GNUmakefile :: $(BUILDDIR)/dependencies $(BUILDDIR)/destinations
	$(silent)$(TOUCH) $(THISDIR)/GNUmakefile
ifeq ($(typeupdates),)
	@if $(TEST) ! -f $(call quote,$(BUILDDIR)/.update-types); then $(PRINTF) '%b\n' '\0033[1mDependency graph and output destinations updated. Restarting…\0033[22m'; fi
else
	$(silent)$(RM) $(BUILDDIR)/.update-types
	@$(PRINTF) '%b\n' '\0033[1mDependency graph and output destinations updated. Restarting…\0033[22m'
endif
endif

ifeq ($(typeupdates),)
# Reload this make·file if any of the magic files or parsers have changed.
#
# These are used to classify source files, so if they have changed then the make·file must be reloaded.
#
# This recipe sleeps for one second to ensure that files built after the restart have a more current time·stamp.
$(THISDIR)/GNUmakefile :: $(BUILDDIR)/magic.mgc $(BUILDDIR)/parser.xslt
	$(silent)$(TOUCH) $(THISDIR)/GNUmakefile
	$(silent)$(RM) -f $(call quote,$(BUILDDIR)/dependencies) $(call quote,$(BUILDDIR)/destinations)
	@$(PRINTF) '%b\n' '\0033[1mMagic file or parsers have updated. Restarting…\0033[22m'
	$(silent)$(SLEEP) 1
	$(silent)$(TOUCH) $(call quote,$(BUILDDIR)/.update-types)
endif

# ─ ¶ Build Targets ───────────────────────────────────────────────────

# Create symbolic links from the build directory’s store of magic files to their corresponding sources.
$(call magicfile,$(MAGIC)) : $(BUILDDIR)/magic/% : $$(call magicsource,$$@)
	$(silent)$(call ensuredirectory,$(dir $@))
	$(silent)$(LN) -sf $(call quote,$(realpath $<)) $(call quote,$@)

# Generate the compiled magic file from its sources.
#
# It must be updated if any of the files in the magic directory change.
$(BUILDDIR)/magic.mgc : $(call diffprereqs,magic,$(sort $(call magicfile,$(MAGIC))))
	$(foreach outdated,$(filter-out $^,$(wildcard $(BUILDDIR)/magic/*)),$(silent)$(RM) $(call quote,$(outdated))$(newline))
	@$(ECHO) "Compiling new magic…"
	$(silent)$(call ensuredirectory,$(dir $@))
	$(silent)cd $(call quote,$(BUILDDIR)) && $(FILE) -C -m $(call quote,$(realpath $(BUILDDIR)/magic))
	$(silent)$(TOUCH) $(call quote,$(BUILDDIR)/.update-types)

# Generate the main parser.
$(BUILDDIR)/parser.catalog : $(call diffprereqs,parsers,$(sort $(PARSERS)))
	@$(ECHO) "Generating catalog of parsers…"
	$(silent)$(XMLCATALOG) --create --noout $(call quote,$@)
	$(foreach parser,$(PARSERS),$(silent)( $(call id,$(parser)) ) | $(XARGS) -I %% $(XMLCATALOG) --add uri %% $(call quote,$(call fileuri,$(parser))) --noout $(call quote,$@)$(newline))
$(BUILDDIR)/parser.xslt : $(BUILDDIR)/parser.catalog $(THISDIR)/lib/catalog2parser.xslt
	@$(ECHO) "Generating main parser…"
	$(silent)$(XSLTPROC) --nonet --novalid -o $(call quote,$@) $(call quote,$(THISDIR)/lib/catalog2parser.xslt) $(call quote,$<)
	$(silent)$(TOUCH) $(call quote,$(BUILDDIR)/.update-types)

# Parse the files.
#
# Even plain X·M·L files are parsed, because they may contain X·H·T·M·L `<script>´ elements which contain other kinds of data.
# Asset files are turned into H·T·M·L embeds pointing to `data:´ U·R·I’s.
$(call parsed,$(sourcefiles) $(sourceincludes)) : % : $$(call unparsed,$$@) $(BUILDDIR)/parser.xslt $(typeupdates)
	@$(PRINTF) '%s\n' $(call quote,Processing `$<´…)
	$(silent)$(call ensuredirectory,$(dir $@))
	$(silent)$(if $(filter $<,$(assetfiles)),$(PRINTF) '%s\n' $(call quote,<object xmlns="http://www.w3.org/1999/xhtml" type="$(call typeoffile,$<)" data="$(call datauri,$<)"/>) > $(call quote,$@),$(if $(filter $<,$(plaintextfiles)),$(call wrapplaintext,$<),$(call serializexml,$<)) | $(XSLTPROC) --nonet --novalid -o $(call quote,$@) --stringparam BUILDTIME $$(TZ= $(DATE) '+%Y-%m-%dT%H:%M:%SZ') --stringparam IDENTIFIER $(call quote,$(call localuri,$<)) --stringparam SRCTIME '$(call modtime,$<)' --stringparam CKSUM $$($(CKSUM) $(call quote,$<) | $(SED) 's/[ ].*//')$(if $(THISREV), --stringparam THISREV $(call quote,$(THISREV)),)$(if $(SRCREV), --stringparam SRCREV $(call quote,$(SRCREV)),) $(call quote,$(BUILDDIR)/parser.xslt) -)

# Generate a catalog of all parsed files, for use when processing includes.
#
# This does not depend on actually transforming the files.
$(BUILDDIR)/catalog : $(call diffprereqs,sources,$(sort $(sourcefiles) $(sourceincludes))) $(typeupdates)
	@$(ECHO) "Generating catalog of parsed files…"
	$(silent)$(XMLCATALOG) --create --noout $(call quote,$@)
	$(foreach source,$(sourcefiles) $(sourceincludes),$(silent)$(XMLCATALOG) --add uri $(call quote,$(call localuri,$(source))) $(call quote,$(call fileuri,$(call parsed,$(source)))#$(if $(filter $(source),$(assetfiles)),asset,xml)) --noout $(call quote,$@)$(newline))

# Build a list of dependencies for each parsed file.
$(BUILDDIR)/dependencies : $(BUILDDIR)/catalog $(call parsed,$(plaintextfiles) $(xmlfiles)) $(THISDIR)/lib/catalog2dependencies.xslt
	@$(ECHO) "Identifying dependencies…"
	$(silent)$(TOUCH) $(call quote,$@)
	$(silent)$(XSLTPROC) --nonet --novalid -o $(call quote,$@) $(call quote,$(THISDIR)/lib/catalog2dependencies.xslt) $(call quote,$<)

# Generate a catalog of destinations for files.
#
# This depends on parsing non·asset source files, but not assets or includes.
# It does not require knowing the dependencies.
$(BUILDDIR)/destinations : $(BUILDDIR)/catalog $(call parsed,$(filter-out $(assetfiles),$(sourcefiles))) $(THISDIR)/lib/catalog2destinations.xslt
	@$(ECHO) "Identifying output destinations…"
	$(silent)$(TOUCH) $(call quote,$@)
	$(silent)$(XSLTPROC) --nonet --novalid -o $(call quote,$@) $(call quote,$(THISDIR)/lib/catalog2destinations.xslt) $(call quote,$<)

# Generate the main transform.
$(BUILDDIR)/transform.catalog : $(call diffprereqs,transforms,$(sort $(TRANSFORMS)))
	@$(ECHO) "Generating catalog of transforms…"
	$(silent)$(XMLCATALOG) --create --noout $(call quote,$@)
	$(foreach transform,$(TRANSFORMS),$(silent)( $(call id,$(transform)) ) | $(XARGS) -I %% $(XMLCATALOG) --add uri %% $(call quote,$(call fileuri,$(transform))) --noout $(call quote,$@)$(newline))
$(BUILDDIR)/transform.xslt : $(BUILDDIR)/transform.catalog $(THISDIR)/lib/catalog2transform.xslt
	@$(ECHO) "Generating main transform…"
	$(silent)$(XSLTPROC) --nonet --novalid -o $(call quote,$@) $(call quote,$(THISDIR)/lib/catalog2transform.xslt) $(call quote,$<)

# Compile the result files using the dependencies as necessary.
$(call compiled,$(compilablefiles)) : $(BUILDDIR)/results/% : $$(call parsed,$$(call uncompiled,$$@)) $(BUILDDIR)/transform.xslt $$(call parsed,$$(call dependencies,$$(call uncompiled,$$@)))
	@$(PRINTF) '%s\n' $(call quote,Compiling </$*>…)
	$(silent)$(call ensuredirectory,$(dir $@))
	$(silent)$(XSLTPROC) --nonet --novalid -o $(call quote,$@) --stringparam CATALOG 'catalog' --stringparam BUILDTIME $$(TZ= $(DATE) '+%Y-%m-%dT%H:%M:%SZ') --stringparam SRCTIME '$(call modtime,$(call uncompiled,$@))' --stringparam IDENTIFIER $(call quote,$(call localuri,$(call uncompiled,$@))) --stringparam PATH $(call quote,/$*) --stringparam CKSUM $$($(CKSUM) $(call quote,$(call uncompiled,$@)) | $(SED) 's/[ ].*//')$(if $(THISREV), --stringparam THISREV $(call quote,$(THISREV)),)$(if $(SRCREV), --stringparam SRCREV $(call quote,$(SRCREV)),) $(call quote,$(BUILDDIR)/transform.xslt) $(call quote,$<)

# Create the final files from the compiled results (or error in the case of recursive ones).
$(call built,$(compilablefiles)) : $(BUILDDIR)/public/% : $(BUILDDIR)/results/%
	@$(PRINTF) '%s\n' $(call quote,Building </$*>…)
	$(silent)$(call ensuredirectory,$(dir $@))
	$(silent)$(call processresultto,$<,$@,$*)
$(call built,$(filter $(assetfiles),$(sourcefiles))) : $(BUILDDIR)/public/% : $$(call unbuilt,$$@)
	@$(PRINTF) '%s\n' $(call quote,Building </$*>…)
	$(silent)$(call ensuredirectory,$(dir $@))
	$(silent)$(CP) $(call quote,$<) $(call quote,$@)

# Install compiled files (or error in the case of recursive ones).
$(call installed,$(recursivefiles) $(installablefiles)) : $(DESTDIR)/% : $(BUILDDIR)/public/%
	@$(PRINTF) '%s\n' $(call quote,Installing </$*>…)
	$(silent)$(call ensuredirectory,$(dir $@))
	$(silent)$(CP) $(call quote,$<) $(call quote,$@)

# ━ § BEGIN ARCHIVE MAKE·FILE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

else ifeq ($(MODE),urn:fdc:ladys.computer:20231231:Shu1She4:mode:archive)

# ─ ¶ Non‐Recipe Variable Definitions ─────────────────────────────────

# Get the list of files in the archive.
ifneq ($(wildcard $(BUILDDIR)/index),)
override archivefiles := $(patsubst ./extracted/%,%,$(shell $(CAT) $(call quote,$(BUILDDIR)/index)))
endif

# ─ ¶ Recipe Variable Definitions ─────────────────────────────────────

# ─ ¶ Phony Targets ───────────────────────────────────────────────────

# ─ ¶ Special Targets ─────────────────────────────────────────────────

# Reload this make·file if the archive components have changed.
$(THISDIR)/GNUmakefile : $(BUILDDIR)/index
	$(silent)$(TOUCH) $(THISDIR)/GNUmakefile
	@$(PRINTF) '%b\n' $(call quote,\0033[1mArchive components for </$(NAME)> updated. Restarting…\0033[22m)

# ─ ¶ Build Targets ───────────────────────────────────────────────────

# Build the extractor transform for extracting the contents of the archive source file.
$(BUILDDIR)/extractor.xslt : $(SRC) $(THISDIR)/lib/archive2extractor.xslt
	$(silent)$(call ensuredirectory,$(dir $@))
	$(silent)$(XSLTPROC) --nonet --novalid -o $(call quote,$@) $(call quote,$(THISDIR)/lib/archive2extractor.xslt) $(call quote,$<)

# Use the extractor transform to extract the archive source file out into its components.
#
# This target sleeps for 1 second to ensure the resulting index will always be newer than this make·file.
$(BUILDDIR)/index : $(BUILDDIR)/extractor.xslt $(SRC)
	@$(PRINTF) '%s\n' $(call quote,Extracting components for </$(NAME)>…)
	$(silent)$(SLEEP) 1
	$(silent)$(XSLTPROC) --nonet --novalid -o $(call quote,$@) --writesubtree $(call quote,$(dir $@)) $(call quote,$<) $(call quote,$(SRC))

# All archive components are extracted alongside the index.
$(foreach file,$(archivefiles),$(BUILDDIR)/extracted/$(file)) : $(BUILDDIR)/index ;

# Process each extractor component into its final form.
$(foreach file,$(archivefiles),$(BUILDDIR)/files/$(file)) : $(BUILDDIR)/files/% : $(BUILDDIR)/extracted/%
	@$(PRINTF) '%s\n' $(call quote,Building </$(NAME)/$*>…)
	$(silent)$(call ensuredirectory,$(dir $@))
	$(silent)$(call processresultto,$<,$@,$*)

# Archive all components in the file to the destination.
#
# This is a match‐anything target, with the assumption that this make·file is being called recursively from the default mode.
$(DESTDIR)/% : $(foreach file,$(archivefiles),$(BUILDDIR)/files/$(file))
	@$(PRINTF) '%s\n' $(call quote,Archiving </$(NAME)>…)
	$(silent)$(call ensuredirectory,$(dir $@))
	$(silent)cd $(call quote,$(BUILDDIR)/files); $(PRINTF) '%s\n' $(foreach file,$(archivefiles),$(call quote,$(file))) | $(PAX) -w > $(call quote,$(abspath $@))

# ━ § END DEFINED MAKE·FILE MODES ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

else
$(error Unrecognized MODE: $(MODE))
endif