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