1 # SPDX-FileCopyrightText: 2023, 2024 Lady <https://www.ladys.computer/about/#lady>
2 # SPDX-License-Identifier: MPL-2.0
6 # ━ § BASIC INFORMATION ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
7 override define makefileinfo
8 ╭────────────────────────────╮
9 ╔╡ ⁌ ⛩️📰 书社 ∷ GNUmakefile ╞═════════════════════════════════╗
10 ║╰────────────────────────────╯ ║
11 ╟┬ ¶ Prerequisites ───────────────────────────────────────────┬╢
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 :— │║
28 ║│ • git (optional) │║
34 ║│ • pax (only when generating archives) │║
45 ║│ • xmlcatalog (provided by libxml2) │║
46 ║│ • xmllint (provided by libxml2) │║
47 ║│ • xsltproc (provided by libxslt) │║
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 ───────────────────────────────────────────────────┬╢
55 ║│ • `make all´ (default): Compile, but do not install, all │║
58 ║│ • `make clean´: Remove `BUILDDIR´. │║
60 ║│ • `make gone´: Remove `BUILDDIR´ and installed files. │║
62 ║│ • `make help´: Print this message. │║
64 ║│ • `make install´: Compile all files and install in │║
67 ║│ • `make list´: List all recognized source files and their │║
68 ║│ classification (including media type and dependencies). │║
70 ║│ • `make listout´: List out the destinations of all │║
71 ║│ resulting files (relative to `DESTDIR´), e·g for │║
72 ║│ processing by another script. │║
74 ║│ • `make uninstall´: Remove installed files, but not │║
77 ║│ Set `VERBOSE=1´ to see the text of commands as they are │║
80 ║│ See `README.markdown´ for a more involved description of │║
81 ║│ the capabilities and configuration of this program. │║
82 ║╰────────────────────────────────────────────────────────────╯║
83 ╟┬ ¶ Copyright & License ─────────────────────────────────────┬╢
85 ║│ Copyright © 2023–2024 Lady [@ Lady’s Computer]. │║
87 ║│ This Source Code Form is subject to the terms of the │║
88 ║│ Mozilla Public License, v 2.0. If a copy of the M·P·L was │║
89 ║│ not distributed with this file, You can obtain one at │║
90 ║│ <http://mozilla.org/MPL/2.0/>. │║
91 ║╰────────────────────────────────────────────────────────────╯║
92 ╚══════════════════════════════════════════════════════════════╝
95 # ━ § MAKE·FILE SETUP ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
97 # Programs needed to run this make·file.
99 # If these are not installed on your computer, or you need to use a different implementation, you can override the appropriate variable.
125 XMLCATALOG := xmlcatalog
129 # This variable is not used in normal execution.
131 # In the archiving `MODE´, it provides the X·M·L file from which the archive should be constructed.
134 # This variable is not used in normal execution.
136 # In the archiving `MODE´, it provides a user‐friendly name for the archive.
139 # The directory which contains the source files.
141 # Multiple directories can be given so long as files with the same name do not exist in each.
144 # The directory which contains “includes”:
145 # Files which may be included in other files but for which no final output will be generated.
147 # Multiple directories can be given so long as files with the same name do not exist in each.
149 # These can be inside of `SRCDIR´ directories if desired.
150 INCLUDEDIR := sources/includes
152 # The directory in which to generate temporary buildfiles.
154 # This variable is also used by the archiving `MODE´.
157 # The directory into which to output files on `make install´.
159 # This variable is also used by the archiving `MODE´.
162 # The location of this Makefile (and related ⛩️📰 书社 files), relative to the current working directory.
164 # By default, this is inferred from the variable `MAKEFILE_LIST´.
166 # This variable is also used by the archiving `MODE´.
167 THISDIR := $(patsubst %/,%,$(dir $(lastword $(MAKEFILE_LIST))))
169 # Configuration of `find´.
171 # By default, `find´ will ignore files which begin with a period and those which are likely to cause problems for `make´.
173 EXTRAFINDINCLUDERULES :=
174 FINDRULES := ! '(' '(' -name '[.-]*' -o -name '*[][*?:|$$%\#\\; ]*' -o -name '*[)]' ')' -a -prune ')'$(if $(EXTRAFINDRULES), -a $(EXTRAFINDRULES),)
175 FINDINCLUDERULES := $(FINDRULES)$(if $(EXTRAFINDINCLUDERULES), -a $(EXTRAFINDINCLUDERULES),)
177 # The list of magic files to use when determining media types.
179 # Some are provided as part of this repository, but you can add more if you need different media type detection.
181 # Your computer probably has several already installed at `/usr/share/file/magic´.
183 MAGIC := $(sort $(patsubst ./%,%,$(wildcard $(THISDIR)/magic/*)) $(EXTRAMAGIC))
185 # The list of parsers for plaintext file types.
187 # Which parsers are provided will influence which kinds of files are recognized as plaintext.
189 PARSERS := $(sort $(patsubst ./%,%,$(wildcard $(THISDIR)/parsers/*.xslt)) $(EXTRAPARSERS))
191 # The list of transforms.
193 TRANSFORMS := $(sort $(patsubst ./%,%,$(wildcard $(THISDIR)/transforms/*.xslt)) $(EXTRATRANSFORMS))
195 # List of types which should be treated as X·M·L.
196 XMLTYPES := application/xml text/xml
199 ifneq ($(wildcard $(THISDIR)/.git),)
200 # A description of the current git revision of ⛩️📰 书社.
201 THISREV := $(shell cd $(THISDIR); $(GIT) describe 2> /dev/null || $(GIT) rev-parse HEAD 2> /dev/null || true)
204 ifneq ($(wildcard .git),)
205 # A description of the current git revision of the working directory.
206 SRCREV := $(shell $(GIT) describe 2> /dev/null || $(GIT) rev-parse HEAD 2> /dev/null || true)
210 # The mode in which to run this make·file.
211 # Modes essentially allow for the combination of multiple conceptual make·files into a single source.
213 # The following modes are available :—
215 # • ‹ urn:fdc:ladys.computer:20231231:Shu1She4:mode:default ›:
216 # The default mode; typical Shushe behaviours.
218 # • ‹ urn:fdc:ladys.computer:20231231:Shu1She4:mode:archive ›:
219 # Generates archive files from parse results.
220 MODE := urn:fdc:ladys.computer:20231231:Shu1She4:mode:default
222 # Set to a non·empty value to print all commands as they run.
225 # The default target for this makefile.
228 # ━ § BEGIN SHARED MAKE·FILE CONSTRUCTS ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
230 # ─ ¶ Non‐Recipe Variable Definitions ─────────────────────────────────
232 # A variable with no value, usable when assigning values which contain whitespace.
235 # A variable which contains a newline, to allow the generation of multiline strings in function calls.
236 override define newline
241 # A variable which contains a single space.
242 override space := $(empty) $(empty)
244 # A variable which contains a single comma.
247 # (callable) Quote the given string for use within shell calls.
248 override quote = '$(subst ','"'"',$1)'
250 # Outputs an `@´ to silence rules, unless `VERBOSE´ is nonempty.
251 override silent := $(if $(VERBOSE),,@)
253 # (callable) Get the modified time of the provided file.
255 # Only the date·time information available via `ls -l´ is supported; that is, only minute precision for files newer than six months, and only day precision for files which are older.
256 # This is, unfortunately, the best that can be done in pure Posix as of now.
258 # There is an easier implementation which provides the full date·time by archiving an empty file and then reading it back out of the archive :—
260 # $(shell LC_TIME=POSIX TZ=UTC0 $(TOUCH) -m -r $(callquote,$1) $(BUILDDIR)/.mtime && $(PAX) -w -x ustar $(BUILDDIR)/.mtime | $(PAX) -v -o 'listopt=%(mtime=%Y-%m-%dT%H:%M:%SZ)T')
262 # However, it depends on the `listopt´ option in `pax´, which (despite being specified in Posix) no implementations actually support.
264 # ☡ This variable creates a subshell every time it is computed.
265 override modtime = $(shell { $(DATE) -u '+%Y-%m'; LC_TIME=POSIX TZ=UTC0 ls -q -A -l $(call quote,$1) | $(SED) 's/\([^ ]* \{1,\}\)\{5\}\(\([^ ]* \{1,\}\)\{3\}\).*/\2/;s/ \([0123456789]\) / 0\1 /;s/Jan/01/;s/Feb/02/;s/Mar/03/;s/Apr/04/;s/May/05/;s/Jun/06/;s/Jul/07/;s/Aug/08/;s/Sep/09/;s/Oct/10/;s/Nov/11/;s/Dec/12/;s/\([0123456789]\{2\}\) *\([0123456789]\{2\}\) *\([0123456789]\{4\}\)/\3-\1-\2T00:00:00Z/;s/\([0123456789]\{2\}\) *\([0123456789]\{2\}\) *\([0123456789:]\{5\}\)/XXXX-\1-\2T\3:00Z/'; } | $(TR) -d ' ' | $(AWK) -F '-' 'NR==1{year=$$1;month=$$2}$$1=="XXXX"&&$$2<=month{print year"-"$$2"-"$$3}$$1=="XXXX"&&$$2>month{print year-1"-"$$2"-"$$3}NR>1&&$$1!="XXXX"')
267 # ─ ¶ Recipe Variable Definitions ─────────────────────────────────────
269 # (callable) Check to see if the given directory exists and create it if not.
270 override ensuredirectory = if $(TEST) ! -d $(call quote,$1); then $(MKDIR) -p $(call quote,$1); fi
272 # Quote standard input in such a way that piping it to xargs will result in it being processed as a single argument.
274 # If standard input ends in a newline, it is stripped; all other newlines are preserved.
275 override xargsquote = $(SED) $(call quote,s/'/'"'"'/g;s/^/'/;s/$$/'/;$$!s/$$/\\/)
277 # Quote standard input in such a way that piping it to xargs will result in each line being processed as a single argument.
278 override xargsmultiquote = $(SED) $(call quote,s/'/'"'"'/g;s/^/'/;s/$$/'/)
280 # (callable) Test if the provided xpath expression matches the provided document.
281 override xpath = $(XMLLINT) --xpath $(call quote,$1) $(call quote,$2) > /dev/null 2> /dev/null
283 # (callable) Extract the value of the text nodes in the provided X·M·L document and print them to `stdout´.
284 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)
286 # (callable) Process the provided transformation result and output the result to the provided location, given the provided relative path.
287 override processresultto = if $(call xpath,/*[local-name()="raw-text" and namespace-uri()="urn:fdc:ladys.computer:20231231:Shu1She4"],$1); then $(call extracttext,$1) > $(call quote,$2); elif $(call xpath,/*[local-name()="base64-binary" and namespace-uri()="urn:fdc:ladys.computer:20231231:Shu1She4"],$1); then { $(PRINTF) '%s\n' 'begin-base64 644 -'; $(call extracttext,$1) | $(TR) -d '\t\n\f\r '; $(PRINTF) '\n%s\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 $(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 $(XMLLINT) --nsclean $(call quote,$1) > $(call quote,$2); fi
289 # ━ § BEGIN DEFAULT MAKE·FILE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
291 ifeq ($(MODE),urn:fdc:ladys.computer:20231231:Shu1She4:mode:default)
293 # ─ ¶ Non‐Recipe Variable Definitions ─────────────────────────────────
295 # (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´.
296 # If not, save the new value and then add FORCE.
297 # Return them regardless.
299 # 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.
301 # ☡ This variable creates at least one subshell every time it is computed.
302 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)
304 # (callable) Escape special characters for use in sed regular expressions.
305 override sedesc = $(subst /,[/],$(subst $$,\$$,$(subst *,\*,$(subst .,\.,$(subst [,\[,$(subst ^,\^,$(subst \,\\,$1)))))))
307 # The command to use for percent‐decoding.
308 override perdeccmd := $(SED) 's/|/%7C/g;s/[\]/%5C/g;s/%[0123456789ABCDEFabcdef]\{2\}/|&|/g' | $(TR) '|' '\n' | $(SED) '/^%[0123456789ABCDEFabcdef]\{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}' | $(xargsquote) | $(XARGS) -E '' $(PRINTF) '%b'
310 # (callable) Percent‐decode the given strings.
312 # ☡ This variable creates a subshell every time it is computed.
313 override perdec = $(shell $(PRINTF) '%s\0450A' $(foreach encoded,$1,$(call quote,$(encoded))) | $(perdeccmd))
315 # (callable) Percent‐encode the given strings.
317 # This singly‐encodes u·r·i characters and doubly‐encodes other characters, then calls `perdec´ to decode back to a single encoding.
318 # 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´).
320 # It is assumed that the given strings do not contain newlines.
322 # ☡ This variable creates a subshell every time it is computed.
323 override perenc = $(shell $(PRINTF) '%s\n' $(foreach unencoded,$1,$(call quote,$(unencoded))) | $(OD) -t x1 | $(SED) 's/^[0123456789]*//;s/0[Aa]/%&/g;s/2[146789ABCDEabcde]/%&/g;s/3[0123456789AaBbDd]/%&/g;s/40/%&/g;s/[46][123456789ABCDEFabcdef]/%&/g;s/[57][0123456789Aa]/%&/g;s/5[Ff]/%&/g;s/7[Ee]/%&/g;s/[ ][0123456789ABCDEFabcdef]\{2\}/%25&/g' | $(TR) -d ' \n' | $(TR) 'abcdef' 'ABCDEF' | $(perdeccmd))
325 # (callable) Percent‐encode each component in the given paths.
327 # ☡ This variable creates a subshell every time it is computed.
328 override pathenc = $(subst %2F,/,$(call perenc,$1))
330 # (overridable) Collect all of the applicable includes from the includes directory.
331 sourceincludes := $(shell $(FIND) $(foreach dir,$(INCLUDEDIR),$(call quote,$(dir))) '(' $(FINDRULES) ')' -a -type f)
333 # (overridable) Collect all of the applicable source files from the source directory, removing any which are also includes.
334 sourcefiles := $(filter-out $(sourceincludes),$(shell $(FIND) $(foreach dir,$(SRCDIR),$(call quote,$(dir))) '(' $(FINDRULES) ')' -a -type f))
336 # Figure out the file type of each source file and source include.
337 ifneq ($(wildcard $(BUILDDIR)/magic.mgc),)
338 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')
341 # Get the list of supported plaintext file types from the parser.
342 ifneq ($(wildcard $(BUILDDIR)/parser.xslt),)
343 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)))
346 # (callable) Get all of the files (source and includes) which have the given types.
347 override filesoftype = $(foreach type,$1,$(patsubst %|$(type),%,$(filter %|$(type),$(types))))
349 # Build up collections of various file types.
350 override xmlfiles := $(call filesoftype,$(XMLTYPES))
351 override plaintextfiles := $(filter-out $(xmlfiles),$(call filesoftype,$(plaintexttypes)))
352 override assetfiles := $(filter-out $(xmlfiles) $(plaintextfiles),$(sourcefiles) $(sourceincludes))
354 # (callable) Get the types of the given files.
355 override typeoffile = $(patsubst $(foreach file,$1,$(file)|%),%,$(filter $(foreach file,$1,$(file)|%),$(types)))
357 # Pair each source magic file with its location in the build directory.
358 override magicpair := $(foreach magicfile,$(MAGIC),$(magicfile)|$(BUILDDIR)/magic/$(notdir $(magicfile)))
360 # (callable) Get the source file for the given magic files.
361 override magicsource = $(foreach magicpath,$1,$(patsubst %|$(magicpath),%,$(firstword $(filter %|$(magicpath),$(magicpair)))))
363 # (callable) Get the build file for the given magic files.
364 override magicfile = $(foreach file,$1,$(patsubst $(file)|%,%,$(filter $(file)|%,$(magicpair))))
366 # (callable) Get the local path for the given source file.
367 override sourcepath = $(firstword $(foreach directory,$(SRCDIR),$(if $(filter $(directory)/%,$1),$(patsubst $(directory)/%,%,$1),)))
369 # (callable) Get the local path for the given include.
370 override includepath = $(firstword $(foreach directory,$(INCLUDEDIR),$(if $(filter $(directory)/%,$1),$(patsubst $(directory)/%,%,$1),)))
372 # (callable) Get base64 data u·r·i’s for the given files.
374 # ☡ This variable creates a subshell every time it is computed.
375 override datauri = $(foreach file,$1,data:$(call typeoffile,$(file));base64,$(shell $(UUENCODE) -m $(call quote,$(file)) _ | $(SED) '2,$$!d;$$d' | $(TR) -d ' \n'))
377 # Pair each source file and include with its local u·r·i.
378 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)))))
380 # (callable) Get local uris for the given files.
381 override localuri = $(foreach file,$1,$(patsubst $(file)|%,%,$(filter $(file)|%,$(sourcelocalpair))))
383 # (callable) Get the source files for the given local uris.
384 override sourcefile = $(foreach local,$1,$(patsubst %|$(local),%,$(filter %|$(local),$(sourcelocalpair))))
386 # Adds a requirement on `$(BUILDDIR)/.update-types´ if the file is present.
388 # This file is created after a reload due to type changes, and is removed after.
389 # Requiring it ensures that file classifications are up·to·date immediately after the reload.
390 override typeupdates := $(wildcard $(BUILDDIR)/.update-types)
392 # Pair each source file and include with its parsed location.
393 override sourceparsedpair := $(foreach file,$(sourcefiles) $(sourceincludes),$(file)|$(BUILDDIR)/$(if $(filter $(file),$(sourceincludes)),includes/$(call includepath,$(file)),sources/$(call sourcepath,$(file))))
395 # (callable) Get the location of the transformed X·M·L files for the given source files.
396 override parsed = $(foreach file,$1,$(patsubst $(file)|%,%,$(filter $(file)|%,$(sourceparsedpair))))
398 # (callable) Get the source files for the given parsed file.
399 override unparsed = $(foreach file,$1,$(patsubst %|$(file),%,$(filter %|$(file),$(sourceparsedpair))))
401 # Pair each parser, transform, or parsed file with its file u·r·i.
402 override fileuripairs := $(join $(patsubst %,%|,$(PARSERS) $(TRANSFORMS) $(call parsed,$(sourcefiles) $(sourceincludes))),$(call pathenc,$(foreach uriable,$(PARSERS) $(TRANSFORMS) $(call parsed,$(sourcefiles) $(sourceincludes)),file://$(abspath $(uriable)))))
404 # (callable) Get the file u·r·is for the given parsers, transforms, or parsed files.
405 override fileuri = $(foreach file,$1,$(patsubst $(file)|%,%,$(filter $(file)|%,$(fileuripairs))))
407 ifneq ($(wildcard $(BUILDDIR)/dependencies),)
408 # Pair each file with a list of dependencies for it.
409 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/^ //))))
411 # (callable) Get the list of dependency leiris for the given source files.
413 # Recursive dependencies are marked with a leading `-´.
414 override dependencyuris = $(foreach file,$1,$(subst |, ,$(patsubst $(file)|%,%,$(filter $(file)|%,$(dependenciesforfile)))))
416 # (callable) Get the list of recursive dependencies for the given source files.
417 override recursives = $(foreach uri,$(filter -%,$(call dependencyuris,$1)),$(call sourcefile,$(patsubst -%,%,$(uri))))
419 # (callable) Get the list of (nonrecursive) dependencies for the given source files.
420 override dependencies = $(foreach uri,$(filter-out -%,$(call dependencyuris,$1)),$(call sourcefile,$(uri)))
423 # Collect all files with recursive dependencies.
424 override recursivefiles := $(foreach file,$(filter-out $(assetfiles),$(sourcefiles)),$(if $(call recursives,$(file)),$(file),))
426 # Collect all files which should be compiled.
428 # This is all of the non·asset, nonrecursive files.
429 override compilablefiles := $(filter-out $(assetfiles) $(recursivefiles),$(sourcefiles))
431 # Collect all files which can be installed.
433 # This is all of the comilable files and all asset sources.
434 override installablefiles := $(compilablefiles) $(filter $(assetfiles),$(sourcefiles))
436 ifneq ($(wildcard $(BUILDDIR)/destinations),)
437 # Get the output of the destination transform.
438 override destinations := $(shell $(CAT) $(BUILDDIR)/destinations)
440 # Pair source files and their destinations.
441 override sourcedestinationpair := $(foreach destination,$(destinations),$(call sourcefile,$(firstword $(subst |, ,$(destination))))|$(call perdec,$(subst $(space),|,$(wordlist 2,$(words $(subst |, ,$(destination))),$(subst |, ,$(destination))))))
443 # (callable) Get the destination for the given source files.
444 override destination = $(foreach file,$1,$(patsubst $(file)|%,%,$(filter $(file)|%,$(sourcedestinationpair))))
446 # Pair each source file with its compiled location.
447 override sourcecompiledpair := $(foreach file,$(sourcefiles),$(file)|$(BUILDDIR)/results/$(call destination,$(file)))
449 # (callable) Get the location of the transformed X·M·L files for the given source files.
450 override compiled = $(foreach file,$1,$(patsubst $(file)|%,%,$(filter $(file)|%,$(sourcecompiledpair))))
452 # (callable) Get the location of the source files for the given compiled file.
453 override uncompiled = $(foreach file,$1,$(patsubst %|$(file),%,$(filter %|$(file),$(sourcecompiledpair))))
455 # (callable) Get the location of the final built files for the given source files.
456 override built = $(foreach file,$1,$(patsubst $(BUILDDIR)/results/%,$(BUILDDIR)/public/%,$(call compiled,$(file))))
458 # (callable) Get the location of the source files for the given built files.
459 override unbuilt = $(foreach file,$1,$(call uncompiled,$(patsubst $(BUILDDIR)/public/%,$(BUILDDIR)/results/%,$(file))))
461 # (callable) Get the installed locations for the given source files.
462 override installed = $(foreach file,$1,$(DESTDIR)/$(call destination,$(file)))
465 # ─ ¶ Recipe Variable Definitions ─────────────────────────────────────
467 # (callable) Get the identifier for the given parser or transform.
468 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))))
470 # (callable) Sanitize and wrap the provided plaintext file in X·M·L, printing to `stdout´.
471 override wrapplaintext = { $(PRINTF) '%s\n%s' '<?xml version="1.0"?>' '<script xmlns="http://www.w3.org/1999/xhtml" type="$(call typeoffile,$1)"><![CDATA['; $(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\ns/\0342\0200\0250/\\n/g\ns/[\0001\0002\0003\0004\0005\0006\0007\0010]/�/g\ns/[\0016\0017\0020\0021\0022\0023\0024\0025\0026\0027\0031\0032\0033\0034\0035\0036\0037]/�/g')"; $(PRINTF) '%s\n' ']]></script>'; }
473 # (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´.
475 # 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).
477 # 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.
478 override serializexml = $(SED) "$$($(PRINTF) '%b' '/<?xml[ \t]\\{1,\\}version=[\0042\0047]1.1/,$${ s/<?xml[^>]*?>/<!--<?xml version=\00421.1\0042?>-->/\n s/&\0043x0*[12345678BCEFbcef];/\0302\0221/g\n s/&\0043x0*1[0123456789ABCDEFabcdef];/\0302\0221/g\n s/&\00430*[12345678];/\0302\0221/g\n s/&\00430*1[12456789];/\0302\0221/g\n s/&\00430*2[0123456789];/\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}')"
480 # ─ ¶ Phony Targets ───────────────────────────────────────────────────
482 # Compile all files, or error if any are recursive.
483 all : $(call built,$(recursivefiles) $(installablefiles)) ;
485 # Destroy buildfiles.
487 $(if $(BUILDDIR),$(silent)$(RM) -f -R $(call quote,$(BUILDDIR)/),)
489 # Destroy build directory and installed files.
490 gone : clean uninstall ;
494 @$(PRINTF) '%b' '$(subst $(newline),\n,$(makefileinfo))'
496 # Install the compiled files into `DESTDIR´, or error if any are recursive.
497 install : $(call installed,$(recursivefiles) $(installablefiles)) ;
499 # List all source files and includes and their computed types.
501 @$(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] Modified:|$(call modtime,$(file))$(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 '
503 # Lists out the destinations of all resulting files (relative to `DESTDIR´).
505 @$(PRINTF) '⛩️📰 书社 Output: %s\n' $(call quote,$(foreach file,$(sort $(sourcefiles)),$(call destination,$(file))))
507 # Destroy installed files.
509 $(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),))
511 # Raise an error when attempting to build any files with recursive dependencies.
512 $(call built,$(recursivefiles)) :
513 @$(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
515 # Add as a prerequisite to treat the target as tho it were phony.
518 # ─ ¶ Special Targets ─────────────────────────────────────────────────
520 # Perform secondary expansion; this enables pattern rules to determine their prerequisites based on the matched pattern.
523 # Don’t use any implicit rules.
526 # Phony rules; always consider these out·of·date.
527 .PHONY : FORCE all default clean gone info install list listout uninstall $(call built,$(recursivefiles)) ;
529 ifneq ($(typeupdates)$(wildcard $(BUILDDIR)/dependencies)$(wildcard $(BUILDDIR)/destinations),)
530 # Reload this make·file if the dependency graph or output destinations have changed.
532 # 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.
534 # This recipe only exists after types have been updated or when the dependency graph or destinations file already exists.
536 # ※ There is a chance that generating the dependencies will also update the parsers.
537 $(THISDIR)/GNUmakefile :: $(BUILDDIR)/dependencies $(BUILDDIR)/destinations
538 $(silent)$(TOUCH) $(THISDIR)/GNUmakefile
539 ifeq ($(typeupdates),)
540 @if $(TEST) ! -f $(call quote,$(BUILDDIR)/.update-types); then $(PRINTF) '%b\n' '\0033[1mDependency graph and output destinations updated. Restarting…\0033[22m'; fi
542 $(silent)$(RM) $(call quote,$(BUILDDIR)/.update-types)
543 @$(PRINTF) '%b\n' '\0033[1mDependency graph and output destinations updated. Restarting…\0033[22m'
547 ifeq ($(typeupdates),)
548 # Reload this make·file if any of the magic files or parsers have changed.
550 # These are used to classify source files, so if they have changed then the make·file must be reloaded.
552 # This recipe sleeps for one second to ensure that files built after the restart have a more current time·stamp.
553 $(THISDIR)/GNUmakefile :: $(BUILDDIR)/magic.mgc $(BUILDDIR)/parser.xslt
554 $(silent)$(TOUCH) $(THISDIR)/GNUmakefile
555 $(silent)$(RM) -f $(call quote,$(BUILDDIR)/dependencies) $(call quote,$(BUILDDIR)/destinations)
556 @$(PRINTF) '%b\n' '\0033[1mMagic file or parsers have updated. Restarting…\0033[22m'
558 $(silent)$(TOUCH) $(call quote,$(BUILDDIR)/.update-types)
561 # ─ ¶ Build Targets ───────────────────────────────────────────────────
563 # Create symbolic links from the build directory’s store of magic files to their corresponding sources.
564 $(call magicfile,$(MAGIC)) : $(BUILDDIR)/magic/% : $$(call magicsource,$$@)
565 $(silent)$(call ensuredirectory,$(dir $@))
566 $(silent)$(LN) -sf $(call quote,$(realpath $<)) $(call quote,$@)
568 # Generate the compiled magic file from its sources.
570 # It must be updated if any of the files in the magic directory change.
571 $(BUILDDIR)/magic.mgc : $(call diffprereqs,magic,$(sort $(call magicfile,$(MAGIC))))
572 $(foreach outdated,$(filter-out $^,$(wildcard $(BUILDDIR)/magic/*)),$(silent)$(RM) $(call quote,$(outdated))$(newline))
573 @$(PRINTF) '%s\n' 'Compiling new magic…'
574 $(silent)$(call ensuredirectory,$(dir $@))
575 $(silent)cd $(call quote,$(BUILDDIR)) && $(FILE) -C -m $(call quote,$(realpath $(BUILDDIR)/magic))
576 $(silent)$(TOUCH) $(call quote,$(BUILDDIR)/.update-types)
578 # Generate the main parser.
579 $(BUILDDIR)/parser.catalog : $(call diffprereqs,parsers,$(sort $(PARSERS)))
580 @$(PRINTF) '%s\n' 'Generating catalog of parsers…'
581 $(silent)$(XMLCATALOG) --create --noout $(call quote,$@)
582 $(foreach parser,$(PARSERS),$(silent){ $(call id,$(parser)); $(PRINTF) '%s\n' $(call quote,$(call fileuri,$(parser))) '--noout' $(call quote,$@); } | $(xargsmultiquote) | $(XARGS) -E '' $(XMLCATALOG) --add uri$(newline))
583 $(BUILDDIR)/parser.xslt : $(BUILDDIR)/parser.catalog $(THISDIR)/lib/catalog2parser.xslt
584 @$(PRINTF) '%s\n' 'Generating main parser…'
585 $(silent)$(XSLTPROC) --nonet --novalid -o $(call quote,$@) $(call quote,$(THISDIR)/lib/catalog2parser.xslt) $(call quote,$<)
586 $(silent)$(TOUCH) $(call quote,$(BUILDDIR)/.update-types)
590 # 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.
591 # Asset files are turned into H·T·M·L embeds pointing to `data:´ U·R·I’s.
592 $(call parsed,$(sourcefiles) $(sourceincludes)) : % : $$(call unparsed,$$@) $(BUILDDIR)/parser.xslt $(typeupdates)
593 @$(PRINTF) '%s\n' $(call quote,Processing `$<´…)
594 $(silent)$(call ensuredirectory,$(dir $@))
595 $(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 $$($(DATE) -u '+%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) -)
597 # Generate a catalog of all parsed files, for use when processing includes.
599 # This does not depend on actually transforming the files.
600 $(BUILDDIR)/catalog : $(call diffprereqs,sources,$(sort $(sourcefiles) $(sourceincludes))) $(typeupdates)
601 @$(PRINTF) '%s\n' 'Generating catalog of parsed files…'
602 $(silent)$(XMLCATALOG) --create --noout $(call quote,$@)
603 $(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))
605 # Build a list of dependencies for each parsed file.
606 $(BUILDDIR)/dependencies : $(BUILDDIR)/catalog $(call parsed,$(plaintextfiles) $(xmlfiles)) $(THISDIR)/lib/catalog2dependencies.xslt
607 @$(PRINTF) '%s\n' 'Identifying dependencies…'
608 $(silent)$(TOUCH) $(call quote,$@)
609 $(silent)$(XSLTPROC) --nonet --novalid -o $(call quote,$@) $(call quote,$(THISDIR)/lib/catalog2dependencies.xslt) $(call quote,$<)
611 # Generate a catalog of destinations for files.
613 # This depends on parsing non·asset source files, but not assets or includes.
614 # It does not require knowing the dependencies.
615 $(BUILDDIR)/destinations : $(BUILDDIR)/catalog $(call parsed,$(filter-out $(assetfiles),$(sourcefiles))) $(THISDIR)/lib/catalog2destinations.xslt
616 @$(PRINTF) '%s\n' 'Identifying output destinations…'
617 $(silent)$(TOUCH) $(call quote,$@)
618 $(silent)$(XSLTPROC) --nonet --novalid -o $(call quote,$@) $(call quote,$(THISDIR)/lib/catalog2destinations.xslt) $(call quote,$<)
620 # Generate the main transform.
621 $(BUILDDIR)/transform.catalog : $(call diffprereqs,transforms,$(sort $(TRANSFORMS)))
622 @$(PRINTF) '%s\n' 'Generating catalog of transforms…'
623 $(silent)$(XMLCATALOG) --create --noout $(call quote,$@)
624 $(foreach transform,$(TRANSFORMS),$(silent){ $(call id,$(transform)); $(PRINTF) '%s\n' $(call quote,$(call fileuri,$(transform))) '--noout' $(call quote,$@); } | $(xargsmultiquote) | $(XARGS) -E '' $(XMLCATALOG) --add uri$(newline))
625 $(BUILDDIR)/transform.xslt : $(BUILDDIR)/transform.catalog $(THISDIR)/lib/catalog2transform.xslt
626 @$(PRINTF) '%s\n' 'Generating main transform…'
627 $(silent)$(XSLTPROC) --nonet --novalid -o $(call quote,$@) $(call quote,$(THISDIR)/lib/catalog2transform.xslt) $(call quote,$<)
629 # Compile the result files using the dependencies as necessary.
630 $(call compiled,$(compilablefiles)) : $(BUILDDIR)/results/% : $$(call parsed,$$(call uncompiled,$$@)) $(BUILDDIR)/transform.xslt $$(call parsed,$$(call dependencies,$$(call uncompiled,$$@)))
631 @$(PRINTF) '%s\n' $(call quote,Compiling </$*>…)
632 $(silent)$(call ensuredirectory,$(dir $@))
633 $(silent)$(XSLTPROC) --nonet --novalid -o $(call quote,$@) --stringparam CATALOG 'catalog' --stringparam BUILDTIME $$($(DATE) -u '+%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,$<)
635 # Create the final files from the compiled results (or error in the case of recursive ones).
636 $(call built,$(compilablefiles)) : $(BUILDDIR)/public/% : $(BUILDDIR)/results/%
637 @$(PRINTF) '%s\n' $(call quote,Building </$*>…)
638 $(silent)$(call ensuredirectory,$(dir $@))
639 $(silent)$(RM) -f -R $(call quote,$@)
640 $(silent)$(call processresultto,$<,$@,$*)
641 $(call built,$(filter $(assetfiles),$(sourcefiles))) : $(BUILDDIR)/public/% : $$(call unbuilt,$$@)
642 @$(PRINTF) '%s\n' $(call quote,Building </$*>…)
643 $(silent)$(call ensuredirectory,$(dir $@))
644 $(silent)$(RM) -f -R $(call quote,$@)
645 $(silent)$(CP) $(call quote,$<) $(call quote,$@)
647 # Install compiled files (or error in the case of recursive ones).
648 $(call installed,$(recursivefiles) $(installablefiles)) : $(DESTDIR)/% : $(BUILDDIR)/public/%
649 @$(PRINTF) '%s\n' $(call quote,Installing </$*>…)
650 $(silent)$(call ensuredirectory,$(dir $@))
651 $(silent)$(RM) -f -R $(call quote,$@)
652 $(silent)$(CP) -R $(call quote,$<) $(call quote,$@)
654 # ━ § BEGIN ARCHIVE MAKE·FILE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
656 else ifeq ($(MODE),urn:fdc:ladys.computer:20231231:Shu1She4:mode:archive)
658 # ─ ¶ Non‐Recipe Variable Definitions ─────────────────────────────────
660 # Get the list of files in the archive.
661 ifneq ($(wildcard $(BUILDDIR)/index),)
662 override archivefiles := $(patsubst ./extracted/%,%,$(shell $(CAT) $(call quote,$(BUILDDIR)/index)))
665 # ─ ¶ Recipe Variable Definitions ─────────────────────────────────────
667 # ─ ¶ Phony Targets ───────────────────────────────────────────────────
669 # ─ ¶ Special Targets ─────────────────────────────────────────────────
671 # Reload this make·file if the archive components have changed.
672 $(THISDIR)/GNUmakefile : $(BUILDDIR)/index
673 $(silent)$(TOUCH) $(THISDIR)/GNUmakefile
674 @$(PRINTF) '%b\n' $(call quote,\0033[1mArchive components for </$(NAME)> updated. Restarting…\0033[22m)
676 # ─ ¶ Build Targets ───────────────────────────────────────────────────
678 # Build the extractor transform for extracting the contents of the archive source file.
679 $(BUILDDIR)/extractor.xslt : $(SRC) $(THISDIR)/lib/archive2extractor.xslt
680 $(silent)$(call ensuredirectory,$(dir $@))
681 $(silent)$(XSLTPROC) --nonet --novalid -o $(call quote,$@) $(call quote,$(THISDIR)/lib/archive2extractor.xslt) $(call quote,$<)
683 # Use the extractor transform to extract the archive source file out into its components.
685 # This target sleeps for 1 second to ensure the resulting index will always be newer than this make·file.
686 $(BUILDDIR)/index : $(BUILDDIR)/extractor.xslt $(SRC)
687 @$(PRINTF) '%s\n' $(call quote,Extracting components for </$(NAME)>…)
689 $(silent)$(XSLTPROC) --nonet --novalid -o $(call quote,$@) --writesubtree $(call quote,$(dir $@)) $(call quote,$<) $(call quote,$(SRC))
691 # All archive components are extracted alongside the index.
692 $(foreach file,$(archivefiles),$(BUILDDIR)/extracted/$(file)) : $(BUILDDIR)/index ;
694 # Process each extractor component into its final form.
695 $(foreach file,$(archivefiles),$(BUILDDIR)/files/$(file)) : $(BUILDDIR)/files/% : $(BUILDDIR)/extracted/%
696 @$(PRINTF) '%s\n' $(call quote,Building </$(NAME)/$*>…)
697 $(silent)$(call ensuredirectory,$(dir $@))
698 $(silent)$(RM) -f -R $(call quote,$@)
699 $(silent)$(call processresultto,$<,$@,$*)
701 # Archive all components in the file to the destination.
703 # This is a match‐anything target, with the assumption that this make·file is being called recursively from the default mode.
704 $(DESTDIR)/% : $(SRC) $(foreach file,$(archivefiles),$(BUILDDIR)/files/$(file))
705 @$(PRINTF) '%s\n' $(call quote,Archiving </$(NAME)>…)
706 $(silent)$(call ensuredirectory,$(dir $@))
707 $(silent)$(RM) -f -R $(call quote,$@)
708 $(silent)cd $(call quote,$(BUILDDIR)/files); if $(call xpath,/*/@*[local-name()="expanded" and namespace-uri()="urn:fdc:ladys.computer:20231231:Shu1She4"],$(abspath $<)); then $(MKDIR) -p $(call quote,$(abspath $@)); $(PRINTF) '%s\n' $(foreach file,$(archivefiles),$(call quote,$(file))) | $(PAX) -r -w $(call quote,$(abspath $@)); else $(PRINTF) '%s\n' $(foreach file,$(archivefiles),$(call quote,$(file))) | $(PAX) -w -x ustar > $(call quote,$(abspath $@)); fi
710 # ━ § END DEFINED MAKE·FILE MODES ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
713 $(error Unrecognized MODE: $(MODE))