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