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