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