Lady’s Gitweb - Shushe/blob - GNUmakefile

   1 # SPDX-FileCopyrightText: 2023, 2024 Lady <https://www.ladys.computer/about/#lady>
   2 # SPDX-License-Identifier: MPL-2.0
   3
   4 SHELL = /bin/sh
   5
   6 # ━ § BASIC INFORMATION ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
   7 override define makefileinfo
   8  ╭────────────────────────────╮
   9 ╔╡ ⁌ ⛩️📰 书社 ∷ GNUmakefile ╞═════════════════════════════════╗
  10 ║╰────────────────────────────╯                                ║
  11 ╟┬ ¶ Prerequisites ───────────────────────────────────────────┬╢
  12 ║│                                                            │║
  13 ║│ Requires G·N·U Make, at least version 3.81, a version of   │║
  14 ║│ uuencode with base64 support, and the various programs     │║
  15 ║│ offered by libxml2 and libxslt. Beyond this, only programs │║
  16 ║│ required by Posix are required, altho there is a chance of │║
  17 ║│ version incompatibilities. The full list of program        │║
  18 ║│ requirements is as follows :—                             │║
  19 ║│                                                            │║
  20 ║│ • awk                                                      │║
  21 ║│ • cat                                                      │║
  22 ║│ • cksum                                                    │║
  23 ║│ • cp                                                       │║
  24 ║│ • date                                                     │║
  25 ║│ • echo                                                     │║
  26 ║│ • file                                                     │║
  27 ║│ • find                                                     │║
  28 ║│ • git (optional)                                           │║
  29 ║│ • ln                                                       │║
  30 ║│ • mkdir (requires support for `-p´)                        │║
  31 ║│ • mv                                                       │║
  32 ║│ • od (requires support for `-t x1´)                        │║
  33 ║│ • pax (only when generating archives)                      │║
  34 ║│ • printf                                                   │║
  35 ║│ • rm                                                       │║
  36 ║│ • sed                                                      │║
  37 ║│ • sleep                                                    │║
  38 ║│ • stat                                                     │║
  39 ║│ • test                                                     │║
  40 ║│ • touch                                                    │║
  41 ║│ • tr (requires support for `-d´)                           │║
  42 ║│ • uuencode (requires support for `-m´ and `-r´)            │║
  43 ║│ • uudecode (requires support for `-m´ and `-r´)            │║
  44 ║│ • xargs (requires support for `-0´)                        │║
  45 ║│ • xmlcatalog (provided by libxml2)                         │║
  46 ║│ • xmllint (provided by libxml2)                            │║
  47 ║│ • xsltproc (provided by libxslt)                           │║
  48 ║│                                                            │║
  49 ║│ In all cases, you can supply your own version of any       │║
  50 ║│ program `program´ by overriding the corresponding variable │║
  51 ║│ `PROGRAM´ when calling Make.                               │║
  52 ║╰────────────────────────────────────────────────────────────╯║
  53 ╟┬ ¶ Usage ───────────────────────────────────────────────────┬╢
  54 ║│                                                            │║
  55 ║│ • `make all´ (default): Compile, but do not install, all   │║
  56 ║│   files.                                                   │║
  57 ║│                                                            │║
  58 ║│ • `make clean´: Remove `BUILDDIR´.                         │║
  59 ║│                                                            │║
  60 ║│ • `make gone´: Remove `BUILDDIR´ and installed files.      │║
  61 ║│                                                            │║
  62 ║│ • `make help´: Print this message.                         │║
  63 ║│                                                            │║
  64 ║│ • `make install´: Compile all files and install in         │║
  65 ║│   `DESTDIR´.                                               │║
  66 ║│                                                            │║
  67 ║│ • `make list´: List all recognized source files and their  │║
  68 ║│   classification (including media type and dependencies).  │║
  69 ║│                                                            │║
  70 ║│ • `make uninstall´: Remove installed files, but not        │║
  71 ║│   `BUILDDIR´.                                              │║
  72 ║│                                                            │║
  73 ║│ Set `VERBOSE=1´ to see the text of commands as they are    │║
  74 ║│ executed.                                                  │║
  75 ║│                                                            │║
  76 ║│ See `README.markdown´ for a more involved description of   │║
  77 ║│ the capabilities and configuration of this program.        │║
  78 ║╰────────────────────────────────────────────────────────────╯║
  79 ╟┬ ¶ Copyright & License ─────────────────────────────────────┬╢
  80 ║│                                                            │║
  81 ║│ Copyright © 2023–2024 Lady [@ Lady’s Computer].            │║
  82 ║│                                                            │║
  83 ║│ This Source Code Form is subject to the terms of the       │║
  84 ║│ Mozilla Public License, v 2.0. If a copy of the M·P·L was  │║
  85 ║│ not distributed with this file, You can obtain one at      │║
  86 ║│ <http://mozilla.org/MPL/2.0/>.                             │║
  87 ║╰────────────────────────────────────────────────────────────╯║
  88 ╚══════════════════════════════════════════════════════════════╝
  89 endef
  90
  91 # ━ § MAKE·FILE SETUP ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
  92
  93 # Programs needed to run this make·file.
  94 #
  95 # If these are not installed on your computer, or you need to use a different implementation, you can override the appropriate variable.
  96 AWK := awk
  97 CAT := cat
  98 CKSUM := cksum
  99 CP := cp
 100 DATE := date
 101 ECHO := echo
 102 FILE := file
 103 FIND := find
 104 GIT := git
 105 LN := ln
 106 MKDIR := mkdir
 107 MV := mv
 108 OD := od
 109 PAX := pax
 110 PRINTF := printf
 111 RM := rm
 112 SED := sed
 113 SLEEP := sleep
 114 STAT := stat
 115 TEST := test
 116 TOUCH := touch
 117 TR := tr
 118 UUDECODE := uudecode
 119 UUENCODE := uuencode
 120 XARGS := xargs
 121 XMLCATALOG := xmlcatalog
 122 XMLLINT := xmllint
 123 XSLTPROC := xsltproc
 124
 125 # This variable is not used in normal execution.
 126 #
 127 # In the archiving `MODE´, it provides the X·M·L file from which the archive should be constructed.
 128 SRC :=
 129
 130 # This variable is not used in normal execution.
 131 #
 132 # In the archiving `MODE´, it provides a user‐friendly name for the archive.
 133 NAME :=
 134
 135 # The directory which contains the source files.
 136 #
 137 # Multiple directories can be given so long as files with the same name do not exist in each.
 138 SRCDIR := sources
 139
 140 # The directory which contains “includes”:
 141 # Files which may be included in other files but for which no final output will be generated.
 142 #
 143 # Multiple directories can be given so long as files with the same name do not exist in each.
 144 #
 145 # These can be inside of `SRCDIR´ directories if desired.
 146 INCLUDEDIR := sources/includes
 147
 148 # The directory in which to generate temporary buildfiles.
 149 #
 150 # This variable is also used by the archiving `MODE´.
 151 BUILDDIR := build
 152
 153 # The directory into which to output files on `make install´.
 154 #
 155 # This variable is also used by the archiving `MODE´.
 156 DESTDIR := public
 157
 158 # The location of this Makefile (and related ⛩️📰 书社 files), relative to the current working directory.
 159 #
 160 # By default, this is inferred from the variable `MAKEFILE_LIST´.
 161 #
 162 # This variable is also used by the archiving `MODE´.
 163 THISDIR := $(patsubst %/,%,$(dir $(lastword $(MAKEFILE_LIST))))
 164
 165 # Configuration of `find´.
 166 #
 167 # By default, `find´ will ignore files which begin with a period and those which are likely to cause problems for `make´.
 168 EXTRAFINDRULES :=
 169 EXTRAFINDINCLUDERULES :=
 170 FINDRULES := ! '(' '(' -name '[.-]*' -o -name '*[][*?:|$$%\#\\; ]*' -o -name '*[)]' ')' -a -prune ')'$(if $(EXTRAFINDRULES), -a $(EXTRAFINDRULES),)
 171 FINDINCLUDERULES := $(FINDRULES)$(if $(EXTRAFINDINCLUDERULES), -a $(EXTRAFINDINCLUDERULES),)
 172
 173 # The list of magic files to use when determining media types.
 174 #
 175 # Some are provided as part of this repository, but you can add more if you need different media type detection.
 176 #
 177 # Your computer probably has several already installed at `/usr/share/file/magic´.
 178 EXTRAMAGIC :=
 179 MAGIC := $(sort $(patsubst ./%,%,$(wildcard $(THISDIR)/magic/*)) $(EXTRAMAGIC))
 180
 181 # The list of parsers for plaintext file types.
 182 #
 183 # Which parsers are provided will influence which kinds of files are recognized as plaintext.
 184 EXTRAPARSERS :=
 185 PARSERS := $(sort $(patsubst ./%,%,$(wildcard $(THISDIR)/parsers/*.xslt)) $(EXTRAPARSERS))
 186
 187 # The list of transforms.
 188 EXTRATRANSFORMS :=
 189 TRANSFORMS := $(sort $(patsubst ./%,%,$(wildcard $(THISDIR)/transforms/*.xslt)) $(EXTRATRANSFORMS))
 190
 191 # List of types which should be treated as X·M·L.
 192 XMLTYPES := application/xml text/xml
 193
 194 ifdef GIT
 195 ifneq ($(wildcard $(THISDIR)/.git),)
 196 # A description of the current git revision of ⛩️📰 书社.
 197 THISREV := $(shell cd $(THISDIR); $(GIT) describe 2> /dev/null || $(GIT) rev-parse HEAD 2> /dev/null || true)
 198 endif
 199
 200 ifneq ($(wildcard .git),)
 201 # A description of the current git revision of the working directory.
 202 SRCREV := $(shell $(GIT) describe 2> /dev/null || $(GIT) rev-parse HEAD 2> /dev/null || true)
 203 endif
 204 endif
 205
 206 # The mode in which to run this make·file.
 207 # Modes essentially allow for the combination of multiple conceptual make·files into a single source.
 208 #
 209 # The following modes are available :—
 210 #
 211 # • ‹ urn:fdc:ladys.computer:20231231:Shu1She4:mode:default ›:
 212 #   The default mode; typical Shushe behaviours.
 213 #
 214 # • ‹ urn:fdc:ladys.computer:20231231:Shu1She4:mode:archive ›:
 215 #   Generates archive files from parse results.
 216 MODE := urn:fdc:ladys.computer:20231231:Shu1She4:mode:default
 217
 218 # Set to a non·empty value to print all commands as they run.
 219 VERBOSE :=
 220
 221 # The default target for this makefile.
 222 .DEFAULT_GOAL := all
 223
 224 # ━ § BEGIN SHARED MAKE·FILE CONSTRUCTS ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 225
 226 # ─ ¶ Non‐Recipe Variable Definitions ─────────────────────────────────
 227
 228 # A variable with no value, usable when assigning values which contain whitespace.
 229 override empty :=
 230
 231 # A variable which contains a newline, to allow the generation of multiline strings in function calls.
 232 override define newline
 233
 234
 235 endef
 236
 237 # A variable which contains a single space.
 238 override space := $(empty) $(empty)
 239
 240 # A variable which contains a single comma.
 241 override comma := ,
 242
 243 # (callable) Quote the given string for use within shell calls.
 244 override quote = '$(subst ','"'"',$1)'
 245
 246 # Outputs an `@´ to silence rules, unless `VERBOSE´ is nonempty.
 247 override silent := $(if $(VERBOSE),,@)
 248
 249 # ─ ¶ Recipe Variable Definitions ─────────────────────────────────────
 250
 251 # (callable) Check to see if the given directory exists and create it if not.
 252 override ensuredirectory = if $(TEST) ! -d $(call quote,$1); then $(MKDIR) -p $(call quote,$1); fi
 253
 254 # (callable) Test if the provided xpath expression matches the provided document.
 255 override xpath = $(XMLLINT) --xpath $(call quote,$1) $(call quote,$2) > /dev/null 2> /dev/null
 256
 257 # (callable) Extract the value of the text nodes in the provided X·M·L document and print them to `stdout´.
 258 override extracttext = $(PRINTF) '%s' '<transform xmlns="http://www.w3.org/1999/XSL/Transform" version="1.0"><output method="text" encoding="UTF-8"/></transform>' | $(XSLTPROC) - $(call quote,$1)
 259
 260 # (callable) Process the provided transformation result and output the result to the provided location, given the provided relative path.
 261 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 ' | $(UUDECODE) -m -r > $(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
 262
 263 # ━ § BEGIN DEFAULT MAKE·FILE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 264
 265 ifeq ($(MODE),urn:fdc:ladys.computer:20231231:Shu1She4:mode:default)
 266
 267 # ─ ¶ Non‐Recipe Variable Definitions ─────────────────────────────────
 268
 269 # (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´.
 270 # If not, save the new value and then add FORCE.
 271 # Return them regardless.
 272 #
 273 # 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.
 274 #
 275 # ☡ This variable creates at least one subshell every time it is computed.
 276 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)
 277
 278 # (callable) Escape special characters for use in sed regular expressions.
 279 override sedesc = $(subst /,[/],$(subst $$,\$$,$(subst *,\*,$(subst .,\.,$(subst [,\[,$(subst ^,\^,$(subst \,\\,$1)))))))
 280
 281 # The command to use for percent‐decoding.
 282 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'
 283
 284 # (callable) Percent‐decode the given strings.
 285 #
 286 # ☡ This variable creates a subshell every time it is computed.
 287 override perdec = $(shell $(PRINTF) '%s\0450A' $(foreach encoded,$1,$(call quote,$(encoded))) | $(perdeccmd))
 288
 289 # (callable) Percent‐encode the given strings.
 290 #
 291 # This singly‐encodes u·r·i characters and doubly‐encodes other characters, then calls `perdec´ to decode back to a single encoding.
 292 # 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´).
 293 #
 294 # It is assumed that the given strings do not contain newlines.
 295 #
 296 # ☡ This variable creates a subshell every time it is computed.
 297 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))
 298
 299 # (callable) Percent‐encode each component in the given paths.
 300 #
 301 # ☡ This variable creates a subshell every time it is computed.
 302 override pathenc = $(subst %2F,/,$(call perenc,$1))
 303
 304 # (overridable) Collect all of the applicable includes from the includes directory.
 305 sourceincludes := $(shell $(FIND) $(foreach dir,$(INCLUDEDIR),$(call quote,$(dir))) '(' $(FINDRULES) ')' -a -type f)
 306
 307 # (overridable) Collect all of the applicable source files from the source directory, removing any which are also includes.
 308 sourcefiles := $(filter-out $(sourceincludes),$(shell $(FIND) $(foreach dir,$(SRCDIR),$(call quote,$(dir))) '(' $(FINDRULES) ')' -a -type f))
 309
 310 # Figure out the file type of each source file and source include.
 311 ifneq ($(wildcard $(BUILDDIR)/magic.mgc),)
 312 override types := $(shell $(SED) 's/^ *//;s/ *$$//;s/ {2,}/ /g' <<< $(call quote,$(sourcefiles) $(sourceincludes)) | $(TR) ' ' '\n' | $(FILE) -m $(call quote,$(BUILDDIR)/magic.mgc) --mime-type --separator '|' --files-from - | $(SED) 's/| */|/g')
 313 endif
 314
 315 # Get the list of supported plaintext file types from the parser.
 316 ifneq ($(wildcard $(BUILDDIR)/parser.xslt),)
 317 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)))
 318 endif
 319
 320 # (callable) Get all of the files (source and includes) which have the given types.
 321 override filesoftype = $(foreach type,$1,$(patsubst %|$(type),%,$(filter %|$(type),$(types))))
 322
 323 # Build up collections of various file types.
 324 override xmlfiles := $(call filesoftype,$(XMLTYPES))
 325 override plaintextfiles := $(filter-out $(xmlfiles),$(call filesoftype,$(plaintexttypes)))
 326 override assetfiles := $(filter-out $(xmlfiles) $(plaintextfiles),$(sourcefiles) $(sourceincludes))
 327
 328 # (callable) Get the types of the given files.
 329 override typeoffile = $(patsubst $(foreach file,$1,$(file)|%),%,$(filter $(foreach file,$1,$(file)|%),$(types)))
 330
 331 # Pair each source magic file with its location in the build directory.
 332 override magicpair := $(foreach magicfile,$(MAGIC),$(magicfile)|$(BUILDDIR)/magic/$(notdir $(magicfile)))
 333
 334 # (callable) Get the source file for the given magic files.
 335 override magicsource = $(foreach magicpath,$1,$(patsubst %|$(magicpath),%,$(firstword $(filter %|$(magicpath),$(magicpair)))))
 336
 337 # (callable) Get the build file for the given magic files.
 338 override magicfile = $(foreach file,$1,$(patsubst $(file)|%,%,$(filter $(file)|%,$(magicpair))))
 339
 340 # (callable) Get the local path for the given source file.
 341 override sourcepath = $(firstword $(foreach directory,$(SRCDIR),$(if $(filter $(directory)/%,$1),$(patsubst $(directory)/%,%,$1),)))
 342
 343 # (callable) Get the local path for the given include.
 344 override includepath = $(firstword $(foreach directory,$(INCLUDEDIR),$(if $(filter $(directory)/%,$1),$(patsubst $(directory)/%,%,$1),)))
 345
 346 # (callable) Get base64 data u·r·i’s for the given files.
 347 #
 348 # ☡ This variable creates a subshell every time it is computed.
 349 override datauri = $(foreach file,$1,data:$(call typeoffile,$(file));base64,$(shell $(UUENCODE) -m -r $(call quote,$(file)) _ | tr -d ' \n'))
 350
 351 # Pair each source file and include with its local u·r·i.
 352 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)))))
 353
 354 # (callable) Get local uris for the given files.
 355 override localuri = $(foreach file,$1,$(patsubst $(file)|%,%,$(filter $(file)|%,$(sourcelocalpair))))
 356
 357 # (callable) Get the source files for the given local uris.
 358 override sourcefile = $(foreach local,$1,$(patsubst %|$(local),%,$(filter %|$(local),$(sourcelocalpair))))
 359
 360 # Adds a requirement on `$(BUILDDIR)/.update-types´ if the file is present.
 361 #
 362 # This file is created after a reload due to type changes, and is removed after.
 363 # Requiring it ensures that file classifications are up·to·date immediately after the reload.
 364 override typeupdates := $(wildcard $(BUILDDIR)/.update-types)
 365
 366 # Pair each source file and include with its parsed location.
 367 override sourceparsedpair := $(foreach file,$(sourcefiles) $(sourceincludes),$(file)|$(BUILDDIR)/$(if $(filter $(file),$(sourceincludes)),includes/$(call includepath,$(file)),sources/$(call sourcepath,$(file))))
 368
 369 # (callable) Get the location of the transformed X·M·L files for the given source files.
 370 override parsed = $(foreach file,$1,$(patsubst $(file)|%,%,$(filter $(file)|%,$(sourceparsedpair))))
 371
 372 # (callable) Get the source files for the given parsed file.
 373 override unparsed = $(foreach file,$1,$(patsubst %|$(file),%,$(filter %|$(file),$(sourceparsedpair))))
 374
 375 # Pair each parser, transform, or parsed file with its file u·r·i.
 376 override fileuripairs := $(join $(patsubst %,%|,$(PARSERS) $(TRANSFORMS) $(call parsed,$(sourcefiles) $(sourceincludes))),$(call pathenc,$(foreach uriable,$(PARSERS) $(TRANSFORMS) $(call parsed,$(sourcefiles) $(sourceincludes)),file://$(abspath $(uriable)))))
 377
 378 # (callable) Get the file u·r·is for the given parsers, transforms, or parsed files.
 379 override fileuri = $(foreach file,$1,$(patsubst $(file)|%,%,$(filter $(file)|%,$(fileuripairs))))
 380
 381 ifneq ($(wildcard $(BUILDDIR)/dependencies),)
 382 # Pair each file with a list of dependencies for it.
 383 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/^ //))))
 384
 385 # (callable) Get the list of dependency leiris for the given source files.
 386 #
 387 # Recursive dependencies are marked with a leading `-´.
 388 override dependencyuris = $(foreach file,$1,$(subst |, ,$(patsubst $(file)|%,%,$(filter $(file)|%,$(dependenciesforfile)))))
 389
 390 # (callable) Get the list of recursive dependencies for the given source files.
 391 override recursives = $(foreach uri,$(filter -%,$(call dependencyuris,$1)),$(call sourcefile,$(patsubst -%,%,$(uri))))
 392
 393 # (callable) Get the list of (nonrecursive) dependencies for the given source files.
 394 override dependencies = $(foreach uri,$(filter-out -%,$(call dependencyuris,$1)),$(call sourcefile,$(uri)))
 395 endif
 396
 397 # Collect all files with recursive dependencies.
 398 override recursivefiles := $(foreach file,$(filter-out $(assetfiles),$(sourcefiles)),$(if $(call recursives,$(file)),$(file),))
 399
 400 # Collect all files which should be compiled.
 401 #
 402 # This is all of the non·asset, nonrecursive files.
 403 override compilablefiles := $(filter-out $(assetfiles) $(recursivefiles),$(sourcefiles))
 404
 405 # Collect all files which can be installed.
 406 #
 407 # This is all of the comilable files and all asset sources.
 408 override installablefiles := $(compilablefiles) $(filter $(assetfiles),$(sourcefiles))
 409
 410 ifneq ($(wildcard $(BUILDDIR)/destinations),)
 411 # Get the output of the destination transform.
 412 override destinations := $(shell $(CAT) $(BUILDDIR)/destinations)
 413
 414 # Pair source files and their destinations.
 415 override sourcedestinationpair := $(foreach destination,$(destinations),$(call sourcefile,$(firstword $(subst |, ,$(destination))))|$(call perdec,$(subst $(space),|,$(wordlist 2,$(words $(subst |, ,$(destination))),$(subst |, ,$(destination))))))
 416
 417 # (callable) Get the destination for the given source files.
 418 override destination = $(foreach file,$1,$(patsubst $(file)|%,%,$(filter $(file)|%,$(sourcedestinationpair))))
 419
 420 # Pair each source file with its compiled location.
 421 override sourcecompiledpair := $(foreach file,$(sourcefiles),$(file)|$(BUILDDIR)/results/$(call destination,$(file)))
 422
 423 # (callable) Get the location of the transformed X·M·L files for the given source files.
 424 override compiled = $(foreach file,$1,$(patsubst $(file)|%,%,$(filter $(file)|%,$(sourcecompiledpair))))
 425
 426 # (callable) Get the location of the source files for the given compiled file.
 427 override uncompiled = $(foreach file,$1,$(patsubst %|$(file),%,$(filter %|$(file),$(sourcecompiledpair))))
 428
 429 # (callable) Get the location of the final built files for the given source files.
 430 override built = $(foreach file,$1,$(patsubst $(BUILDDIR)/results/%,$(BUILDDIR)/public/%,$(call compiled,$(file))))
 431
 432 # (callable) Get the location of the source files for the given built files.
 433 override unbuilt = $(foreach file,$1,$(call uncompiled,$(patsubst $(BUILDDIR)/public/%,$(BUILDDIR)/results/%,$(file))))
 434
 435 # (callable) Get the installed locations for the given source files.
 436 override installed = $(foreach file,$1,$(DESTDIR)/$(call destination,$(file)))
 437 endif
 438
 439 # ─ ¶ Recipe Variable Definitions ─────────────────────────────────────
 440
 441 # (callable) Get the identifier for the given parser or transform.
 442 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))))
 443
 444 # (callable) Sanitize and wrap the provided plaintext file in X·M·L, printing to `stdout´.
 445 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 -J %% $(PRINTF) '%b%s%s\n' '<?xml version=\042\061.0\042?>\n<script xmlns=\042http://www.w3.org/1999/xhtml\042 type=\042$(call typeoffile,$1)\042><![CDATA[' %% ']]></script>'
 446
 447 # (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´.
 448 #
 449 # 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).
 450 #
 451 # 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.
 452 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}')"
 453
 454 # ─ ¶ Phony Targets ───────────────────────────────────────────────────
 455
 456 # Compile all files, or error if any are recursive.
 457 all : $(call built,$(recursivefiles) $(installablefiles)) ;
 458
 459 # Destroy buildfiles.
 460 clean :
 461         $(if $(BUILDDIR),$(silent)$(RM) -rf $(call quote,$(BUILDDIR)/),)
 462
 463 # Destroy build directory and installed files.
 464 gone : clean uninstall ;
 465
 466 # Provide help.
 467 help :
 468         @$(PRINTF) '%b' '$(subst $(newline),\n,$(makefileinfo))'
 469
 470 # Install the compiled files into `DESTDIR´, or error if any are recursive.
 471 install : $(call installed,$(recursivefiles) $(installablefiles)) ;
 472
 473 # List all source files and includes and their computed types.
 474 list :
 475         @$(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 '
 476
 477 # Destroy installed files.
 478 uninstall :
 479         $(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),))
 480
 481 # Raise an error when attempting to build any files with recursive dependencies.
 482 $(call built,$(recursivefiles)) :
 483         @$(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
 484
 485 # Add as a prerequisite to treat the target as tho it were phony.
 486 FORCE : ;
 487
 488 # ─ ¶ Special Targets ─────────────────────────────────────────────────
 489
 490 # Perform secondary expansion; this enables pattern rules to determine their prerequisites based on the matched pattern.
 491 .SECONDEXPANSION : ;
 492
 493 # Don’t use any implicit rules.
 494 .SUFFIXES : ;
 495
 496 # Phony rules; always consider these out·of·date.
 497 .PHONY : FORCE all default clean gone info install list uninstall $(call built,$(recursivefiles)) ;
 498
 499 ifneq ($(typeupdates)$(wildcard $(BUILDDIR)/dependencies)$(wildcard $(BUILDDIR)/destinations),)
 500 # Reload this make·file if the dependency graph or output destinations have changed.
 501 #
 502 # 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.
 503 #
 504 # This recipe only exists after types have been updated or when the dependency graph or destinations file already exists.
 505 #
 506 # ※ There is a chance that generating the dependencies will also update the parsers.
 507 $(THISDIR)/GNUmakefile :: $(BUILDDIR)/dependencies $(BUILDDIR)/destinations
 508         $(silent)$(TOUCH) $(THISDIR)/GNUmakefile
 509 ifeq ($(typeupdates),)
 510         @if $(TEST) ! -f $(call quote,$(BUILDDIR)/.update-types); then $(PRINTF) '%b\n' '\0033[1mDependency graph and output destinations updated. Restarting…\0033[22m'; fi
 511 else
 512         $(silent)$(RM) $(BUILDDIR)/.update-types
 513         @$(PRINTF) '%b\n' '\0033[1mDependency graph and output destinations updated. Restarting…\0033[22m'
 514 endif
 515 endif
 516
 517 ifeq ($(typeupdates),)
 518 # Reload this make·file if any of the magic files or parsers have changed.
 519 #
 520 # These are used to classify source files, so if they have changed then the make·file must be reloaded.
 521 #
 522 # This recipe sleeps for one second to ensure that files built after the restart have a more current time·stamp.
 523 $(THISDIR)/GNUmakefile :: $(BUILDDIR)/magic.mgc $(BUILDDIR)/parser.xslt
 524         $(silent)$(TOUCH) $(THISDIR)/GNUmakefile
 525         $(silent)$(RM) -f $(call quote,$(BUILDDIR)/dependencies) $(call quote,$(BUILDDIR)/destinations)
 526         @$(PRINTF) '%b\n' '\0033[1mMagic file or parsers have updated. Restarting…\0033[22m'
 527         $(silent)$(SLEEP) 1
 528         $(silent)$(TOUCH) $(call quote,$(BUILDDIR)/.update-types)
 529 endif
 530
 531 # ─ ¶ Build Targets ───────────────────────────────────────────────────
 532
 533 # Create symbolic links from the build directory’s store of magic files to their corresponding sources.
 534 $(call magicfile,$(MAGIC)) : $(BUILDDIR)/magic/% : $$(call magicsource,$$@)
 535         $(silent)$(call ensuredirectory,$(dir $@))
 536         $(silent)$(LN) -sf $(call quote,$(realpath $<)) $(call quote,$@)
 537
 538 # Generate the compiled magic file from its sources.
 539 #
 540 # It must be updated if any of the files in the magic directory change.
 541 $(BUILDDIR)/magic.mgc : $(call diffprereqs,magic,$(sort $(call magicfile,$(MAGIC))))
 542         $(foreach outdated,$(filter-out $^,$(wildcard $(BUILDDIR)/magic/*)),$(silent)$(RM) $(call quote,$(outdated))$(newline))
 543         @$(ECHO) "Compiling new magic…"
 544         $(silent)$(call ensuredirectory,$(dir $@))
 545         $(silent)cd $(call quote,$(BUILDDIR)) && $(FILE) -C -m $(call quote,$(realpath $(BUILDDIR)/magic))
 546         $(silent)$(TOUCH) $(call quote,$(BUILDDIR)/.update-types)
 547
 548 # Generate the main parser.
 549 $(BUILDDIR)/parser.catalog : $(call diffprereqs,parsers,$(sort $(PARSERS)))
 550         @$(ECHO) "Generating catalog of parsers…"
 551         $(silent)$(XMLCATALOG) --create --noout $(call quote,$@)
 552         $(foreach parser,$(PARSERS),$(silent)( $(call id,$(parser)) ) | $(XARGS) -I %% $(XMLCATALOG) --add uri %% $(call quote,$(call fileuri,$(parser))) --noout $(call quote,$@)$(newline))
 553 $(BUILDDIR)/parser.xslt : $(BUILDDIR)/parser.catalog $(THISDIR)/lib/catalog2parser.xslt
 554         @$(ECHO) "Generating main parser…"
 555         $(silent)$(XSLTPROC) -o $(call quote,$@) $(call quote,$(THISDIR)/lib/catalog2parser.xslt) $(call quote,$<)
 556         $(silent)$(TOUCH) $(call quote,$(BUILDDIR)/.update-types)
 557
 558 # Parse the files.
 559 #
 560 # 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.
 561 # Asset files are turned into H·T·M·L embeds pointing to `data:´ U·R·I’s.
 562 $(call parsed,$(sourcefiles) $(sourceincludes)) : % : $$(call unparsed,$$@) $(BUILDDIR)/parser.xslt $(typeupdates)
 563         @$(PRINTF) '%s\n' $(call quote,Processing `$<´…)
 564         $(silent)$(call ensuredirectory,$(dir $@))
 565         $(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) -o $(call quote,$@) --stringparam BUILDTIME $$(TZ= $(DATE) '+%Y-%m-%dT%H:%M:%SZ') --stringparam IDENTIFIER $(call quote,$(call localuri,$<)) --stringparam SRCTIME $$(TZ= $(STAT) -f '%Sm' -t '%Y-%m-%dT%H:%M:%SZ' $(call quote,$<)) --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) -)
 566
 567 # Generate a catalog of all parsed files, for use when processing includes.
 568 #
 569 # This does not depend on actually transforming the files.
 570 $(BUILDDIR)/catalog : $(call diffprereqs,sources,$(sort $(sourcefiles) $(sourceincludes))) $(typeupdates)
 571         @$(ECHO) "Generating catalog of parsed files…"
 572         $(silent)$(XMLCATALOG) --create --noout $(call quote,$@)
 573         $(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))
 574
 575 # Build a list of dependencies for each parsed file.
 576 $(BUILDDIR)/dependencies : $(BUILDDIR)/catalog $(call parsed,$(plaintextfiles) $(xmlfiles)) $(THISDIR)/lib/catalog2dependencies.xslt
 577         @$(ECHO) "Identifying dependencies…"
 578         $(silent)$(XSLTPROC) -o $(call quote,$@) $(call quote,$(THISDIR)/lib/catalog2dependencies.xslt) $(call quote,$<)
 579
 580 # Generate a catalog of destinations for files.
 581 #
 582 # This depends on parsing non·asset source files, but not assets or includes.
 583 # It does not require knowing the dependencies.
 584 $(BUILDDIR)/destinations : $(BUILDDIR)/catalog $(call parsed,$(filter-out $(assetfiles),$(sourcefiles))) $(THISDIR)/lib/catalog2destinations.xslt
 585         @$(ECHO) "Identifying output destinations…"
 586         $(silent)$(XSLTPROC) -o $(call quote,$@) $(call quote,$(THISDIR)/lib/catalog2destinations.xslt) $(call quote,$<)
 587
 588 # Generate the main transform.
 589 $(BUILDDIR)/transform.catalog : $(call diffprereqs,transforms,$(sort $(TRANSFORMS)))
 590         @$(ECHO) "Generating catalog of transforms…"
 591         $(silent)$(XMLCATALOG) --create --noout $(call quote,$@)
 592         $(foreach transform,$(TRANSFORMS),$(silent)( $(call id,$(transform)) ) | $(XARGS) -I %% $(XMLCATALOG) --add uri %% $(call quote,$(call fileuri,$(transform))) --noout $(call quote,$@)$(newline))
 593 $(BUILDDIR)/transform.xslt : $(BUILDDIR)/transform.catalog $(THISDIR)/lib/catalog2transform.xslt
 594         @$(ECHO) "Generating main transform…"
 595         $(silent)$(XSLTPROC) -o $(call quote,$@) $(call quote,$(THISDIR)/lib/catalog2transform.xslt) $(call quote,$<)
 596
 597 # Compile the result files using the dependencies as necessary.
 598 $(call compiled,$(compilablefiles)) : $(BUILDDIR)/results/% : $$(call parsed,$$(call uncompiled,$$@)) $(BUILDDIR)/transform.xslt $$(call parsed,$$(call dependencies,$$(call uncompiled,$$@)))
 599         @$(PRINTF) '%s\n' $(call quote,Compiling </$*>…)
 600         $(silent)$(call ensuredirectory,$(dir $@))
 601         $(silent)$(XSLTPROC) -o $(call quote,$@) --stringparam CATALOG 'catalog' --stringparam BUILDTIME $$(TZ= $(DATE) '+%Y-%m-%dT%H:%M:%SZ') --stringparam SRCTIME $$(TZ= $(STAT) -f '%Sm' -t '%Y-%m-%dT%H:%M:%SZ' $(call quote,$(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,$<)
 602
 603 # Create the final files from the compiled results (or error in the case of recursive ones).
 604 $(call built,$(compilablefiles)) : $(BUILDDIR)/public/% : $(BUILDDIR)/results/%
 605         @$(PRINTF) '%s\n' $(call quote,Building </$*>…)
 606         $(silent)$(call ensuredirectory,$(dir $@))
 607         $(silent)$(call processresultto,$<,$@,$*)
 608 $(call built,$(filter $(assetfiles),$(sourcefiles))) : $(BUILDDIR)/public/% : $$(call unbuilt,$$@)
 609         @$(PRINTF) '%s\n' $(call quote,Building </$*>…)
 610         $(silent)$(call ensuredirectory,$(dir $@))
 611         $(silent)$(CP) $(call quote,$<) $(call quote,$@)
 612
 613 # Install compiled files (or error in the case of recursive ones).
 614 $(call installed,$(recursivefiles) $(installablefiles)) : $(DESTDIR)/% : $(BUILDDIR)/public/%
 615         @$(PRINTF) '%s\n' $(call quote,Installing </$*>…)
 616         $(silent)$(call ensuredirectory,$(dir $@))
 617         $(silent)$(CP) $(call quote,$<) $(call quote,$@)
 618
 619 # ━ § BEGIN ARCHIVE MAKE·FILE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 620
 621 else ifeq ($(MODE),urn:fdc:ladys.computer:20231231:Shu1She4:mode:archive)
 622
 623 # ─ ¶ Non‐Recipe Variable Definitions ─────────────────────────────────
 624
 625 # Get the list of files in the archive.
 626 ifneq ($(wildcard $(BUILDDIR)/index),)
 627 override archivefiles := $(patsubst ./extracted/%,%,$(shell $(CAT) $(call quote,$(BUILDDIR)/index)))
 628 endif
 629
 630 # ─ ¶ Recipe Variable Definitions ─────────────────────────────────────
 631
 632 # ─ ¶ Phony Targets ───────────────────────────────────────────────────
 633
 634 # ─ ¶ Special Targets ─────────────────────────────────────────────────
 635
 636 # Reload this make·file if the archive components have changed.
 637 $(THISDIR)/GNUmakefile : $(BUILDDIR)/index
 638         $(silent)$(TOUCH) $(THISDIR)/GNUmakefile
 639         @$(PRINTF) '%b\n' $(call quote,\0033[1mArchive components for </$(NAME)> updated. Restarting…\0033[22m)
 640
 641 # ─ ¶ Build Targets ───────────────────────────────────────────────────
 642
 643 # Build the extractor transform for extracting the contents of the archive source file.
 644 $(BUILDDIR)/extractor.xslt : $(SRC) $(THISDIR)/lib/archive2extractor.xslt
 645         $(silent)$(call ensuredirectory,$(dir $@))
 646         $(silent)$(XSLTPROC) -o $(call quote,$@) $(call quote,$(THISDIR)/lib/archive2extractor.xslt) $(call quote,$<)
 647
 648 # Use the extractor transform to extract the archive source file out into its components.
 649 #
 650 # This target sleeps for 1 second to ensure the resulting index will always be newer than this make·file.
 651 $(BUILDDIR)/index : $(BUILDDIR)/extractor.xslt $(SRC)
 652         @$(PRINTF) '%s\n' $(call quote,Extracting components for </$(NAME)>…)
 653         $(silent)$(SLEEP) 1
 654         $(silent)$(XSLTPROC) -o $(call quote,$@) --writesubtree $(call quote,$(dir $@)) $(call quote,$<) $(call quote,$(SRC))
 655
 656 # All archive components are extracted alongside the index.
 657 $(foreach file,$(archivefiles),$(BUILDDIR)/extracted/$(file)) : $(BUILDDIR)/index ;
 658
 659 # Process each extractor component into its final form.
 660 $(foreach file,$(archivefiles),$(BUILDDIR)/files/$(file)) : $(BUILDDIR)/files/% : $(BUILDDIR)/extracted/%
 661         @$(PRINTF) '%s\n' $(call quote,Building </$(NAME)/$*>…)
 662         $(silent)$(call ensuredirectory,$(dir $@))
 663         $(silent)$(call processresultto,$<,$@,$*)
 664
 665 # Archive all components in the file to the destination.
 666 #
 667 # This is a match‐anything target, with the assumption that this make·file is being called recursively from the default mode.
 668 $(DESTDIR)/% : $(foreach file,$(archivefiles),$(BUILDDIR)/files/$(file))
 669         @$(PRINTF) '%s\n' $(call quote,Archiving </$(NAME)>…)
 670         $(silent)$(call ensuredirectory,$(dir $@))
 671         $(silent)cd $(call quote,$(BUILDDIR)/files); $(PRINTF) '%s\n' $(foreach file,$(archivefiles),$(call quote,$(file))) | $(PAX) -w > $(call quote,$(abspath $@))
 672
 673 # ━ § END DEFINED MAKE·FILE MODES ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 674
 675 else
 676 $(error Unrecognized MODE: $(MODE))
 677 endif