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