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