Lady’s Gitweb - Caudex/blob - GNUmakefile

   1 SHELL = /bin/sh
   2
   3 # ━ § BASIC INFORMATION ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
   4 override define makefileinfo
   5  ╭──────────────────────────────╮
   6 ╔╡ ⁌ 🪾📰 Caudex ∷ GNUmakefile ╞═══════════════════════════════╗
   7 ║╰──────────────────────────────╯                              ║
   8 ╟┬ ¶ Prerequisites ───────────────────────────────────────────┬╢
   9 ║│                                                            │║
  10 ║│ Requires G·N·U Make, at least version 3.81, and all of the │║
  11 ║│ requirements of ⛩📰 书社, which is included as a git      │║
  12 ║│ submodule. Run `make help-shushe´ for more information.    │║
  13 ║╰────────────────────────────────────────────────────────────╯║
  14 ╟┬ ¶ Usage ───────────────────────────────────────────────────┬╢
  15 ║│                                                            │║
  16 ║│ • `make all´ (default): Compile, but do not install, all   │║
  17 ║│   files.                                                   │║
  18 ║│                                                            │║
  19 ║│ • `make clean´: Remove `BUILDDIR´.                         │║
  20 ║│                                                            │║
  21 ║│ • `make clean´: Remove `BUILDDIR´.                         │║
  22 ║│                                                            │║
  23 ║│ • `make gone´: Remove `BUILDDIR´ and installed files.      │║
  24 ║│                                                            │║
  25 ║│ • `make help´: Print this message.                         │║
  26 ║│                                                            │║
  27 ║│ • `make install´: Compile all files and install in         │║
  28 ║│   `DESTDIR´.                                               │║
  29 ║│                                                            │║
  30 ║│ • `make list´: List all recognized source files and their  │║
  31 ║│   classification (including media type and dependencies).  │║
  32 ║│                                                            │║
  33 ║│ • `make uninstall´: Remove installed files, but not        │║
  34 ║│   `BUILDDIR´.                                              │║
  35 ║│                                                            │║
  36 ║│ • `make +⟨CATEGORY⟩´: Create a new entry in ⟨CATEGORY⟩ and │║
  37 ║│   output its path.                                         │║
  38 ║│                                                            │║
  39 ║│ Set `VERBOSE=1´ to see the text of commands as they are    │║
  40 ║│ executed.                                                  │║
  41 ║│                                                            │║
  42 ║│ See `README.markdown´ for a more involved description of   │║
  43 ║│ the capabilities and configuration of this program.        │║
  44 ║╰────────────────────────────────────────────────────────────╯║
  45 ╟┬ ¶ Copyright & License ─────────────────────────────────────┬╢
  46 ║│                                                            │║
  47 ║│ Copyright © 2024 Lady [@ Ladys Computer].                  │║
  48 ║│                                                            │║
  49 ║│ This Source Code Form is subject to the terms of the       │║
  50 ║│ Mozilla Public License, v 2.0. If a copy of the M·P·L was  │║
  51 ║│ not distributed with this file, You can obtain one at      │║
  52 ║│ <http://mozilla.org/MPL/2.0/>.                             │║
  53 ║╰────────────────────────────────────────────────────────────╯║
  54 ╚══════════════════════════════════════════════════════════════╝
  55 endef
  56
  57 # ━ § MAKE·FILE SETUP ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
  58
  59 # Programs needed to run this make·file.
  60 #
  61 # If these are not installed on your computer, or you need to use a different implementation, you can override the appropriate variable.
  62 #
  63 # See also the documentation for ⛩📰 书社, which specifies additional programs.
  64 AWK := awk
  65 CAT := cat
  66 GIT := git
  67 MKDIR := mkdir
  68 OD := od
  69 PRINTF := printf
  70 RM := rm
  71 SED := sed
  72 TEST := test
  73 TR := tr
  74 XARGS := xargs
  75 XMLCATALOG := xmlcatalog
  76
  77 # The directory which contains the codex entries and related metadata.
  78 SRCDIR := entries
  79
  80 # The directory which contains additional assets for the codex generator.
  81 ASSETDIR := assets
  82
  83 # The directory which contains includes for additional assets for the codex generator.
  84 ASSETINCLUDEDIR := $(ASSETDIR)/includes
  85
  86 # The directory in which to generate temporary buildfiles.
  87 BUILDDIR := build
  88
  89 # The directory into which to output files on `make´.
  90 DESTDIR := public
  91
  92 # The location of this Makefile, relative to the current working directory.
  93 #
  94 # It is expected that other files packaged as a part of 🪾📰 Caudex can also be found in this directory.
  95 #
  96 # By default, this is inferred from the variable `MAKEFILE_LIST´.
  97 THISDIR := $(patsubst %/,%,$(dir $(lastword $(MAKEFILE_LIST))))
  98
  99 # Extra magic files to forward to ⛩📰 书社.
 100 #
 101 # Your computer probably has several already installed at `/usr/share/file/magic´.
 102 EXTRAMAGIC :=
 103
 104 # Extra parsers to forward to ⛩📰 书社.
 105 #
 106 # Which parsers are provided will influence which kinds of files are recognized as plaintext.
 107 EXTRAPARSERS :=
 108
 109 # Extra transforms to forward to ⛩📰 书社.
 110 EXTRATRANSFORMS :=
 111
 112 # A description of the current git revision of 🪾📰 Caudex.
 113 THISREV := $(shell cd $(THISDIR); $(GIT) describe 2> /dev/null || $(GIT) rev-parse HEAD 2> /dev/null || true)
 114
 115 # Variables to communicate to further calls to Make.
 116 #
 117 # By default, `MAKEOVERRIDES´ contains all variable overrides specified on the commandline.
 118 # However, some values are specific to 🪾📰 Caudex and may have different meaning in other make·files; filter these out.
 119 MAKEOVERRIDES := $(filter-out SRCDIR=% ASSETDIR=% BUILDDIR=% DESTDIR=% THISDIR=% EXTRAMAGIC=% EXTRAPARSERS=% EXTRATRANSFORMS=% THISREV=%,$(MAKEOVERRIDES))
 120
 121 # The location of 💄📝 Les·M·L.
 122 LESML := $(THISDIR)/.💄📝
 123
 124 # The location of ⛩📰 书社.
 125 SHUSHE := $(THISDIR)/.⛩📰
 126
 127 # Set to a non·empty value to print all commands as they run.
 128 VERBOSE :=
 129
 130 # The default target for this makefile.
 131 .DEFAULT_GOAL := all
 132
 133 # ━ § BEGIN MAKE·FILE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 134
 135 # ─ ¶ Non‐Recipe Variable Definitions ─────────────────────────────────
 136
 137 # A variable which contains a newline, to allow the generation of multiline strings in function calls.
 138 override define newline
 139
 140
 141 endef
 142
 143 # (callable) Quote the given string for use within shell calls.
 144 override quote = '$(subst ','"'"',$1)'
 145
 146 # Outputs an `@´ to silence rules, unless `VERBOSE´ is nonempty.
 147 override silent := $(if $(VERBOSE),,@)
 148
 149 # The list of categories, determined by the set of directories in `SRCDIR´ with corresponding metadata files.
 150 override categories := $(sort $(patsubst $(SRCDIR)/%/@,%,$(wildcard $(SRCDIR)/*/@)))
 151
 152 # (callable) The set of file locations for the entries of the provided categories.
 153 override entriesforcategory = $(sort $(foreach category,$1,$(wildcard $(SRCDIR)/$(category)/???-????) $(wildcard $(SRCDIR)/$(category)/???-????,*)))
 154
 155 # A random W·R·M·G(·like) base⹀32 identifier.
 156 #
 157 # This variable returns a different value each time it is referenced.
 158 # Use `foreach´ to save the value for repeated usage.
 159 #
 160 # This variable recursively calls itself to ensure there is no existing entry with the resulting identifier.
 161 override wrmg = $(foreach attempt,$(shell $(OD) -t u4 -N 4 /dev/random | $(SED) 's/^[0-9]* *//' | $(TR) -d ' \n' | $(AWK) 'BEGIN{chars="0123456789ABCDEFGHJKMNPQRSTVWXYZ&~@=U"}{d=32^5;r=$$0%(32^6);printf("%s",substr(chars,r%37,1));while(d>0){printf("%s", substr(chars,int(r/d),1));if(d==32^4)printf("%s", "-");r%=d;d=int(d/32)}}'),$(if $(wildcard $(SRCDIR)/*/($(attempt))*),$(call wrmg),$(attempt)))
 162
 163 # (callable) Returns the identifiers of the provided entries.
 164 override identifier = $(shell $(PRINTF) '%s\n' $(call quote,$1) | $(TR) ' ' '\n' | $(SED) 's/^\(.*[/]\)\{0,1\}\(.\{3\}-.\{4\}\)\(,[^/]*\)\{0,1\}$$/\2/')
 165
 166 # Output locations for compiled catalog files for categories.
 167 override categorycatalogs := $(patsubst %,$(BUILDDIR)/catalogs/categories/%/index,$(categories))
 168
 169 # Output locations for compiled catalog files for entries.
 170 override entrycatalogs := $(foreach entry,$(call entriesforcategory,$(categories)),$(patsubst $(SRCDIR)/%,$(BUILDDIR)/catalogs/entries/%,$(entry)))
 171
 172 # Output locations for all compiled catalog files.
 173 override allcatalogs := $(BUILDDIR)/catalogs/indices/index $(BUILDDIR)/catalogs/indices/fullindex $(categorycatalogs) $(entrycatalogs)
 174
 175 # (overridable) Options to pass to ⛩📰 书社.
 176 override shusheopts := SRCDIR=$(call quote,$(if $(wildcard $(ASSETDIR)),$(ASSETDIR),) $(if $(entrycatalogs),$(BUILDDIR)/catalogs/entries,) $(BUILDDIR)/catalogs/indices) BUILDDIR=$(call quote,$(BUILDDIR)/⛩📰) INCLUDEDIR=$(call quote,$(SRCDIR) $(if $(wildcard $(ASSETINCLUDEDIR)),$(ASSETINCLUDEDIR),) $(if $(categorycatalogs),$(BUILDDIR)/catalogs/categories,)) DESTDIR=$(call quote,$(DESTDIR)) EXTRAMAGIC=$(call quote,$(sort $(patsubst ./%,%,$(wildcard $(THISDIR)/magic/*)) $(LESML)/magic $(EXTRAMAGIC))) EXTRAPARSERS=$(call quote,$(sort $(patsubst ./%,%,$(wildcard $(THISDIR)/parsers/*.xslt)) $(LESML)/parser.xslt $(EXTRAPARSERS))) EXTRATRANSFORMS=$(call quote,$(sort $(patsubst ./%,%,$(wildcard $(THISDIR)/transforms/*.xslt)) $(EXTRATRANSFORMS)))
 177
 178 # ─ ¶ Recipe Variable Definitions ─────────────────────────────────────
 179
 180 # (callable) Check to see if the given directory exists and create it if not.
 181 override ensuredirectory = if $(TEST) ! -d $(call quote,$1); then $(MKDIR) -p $(call quote,$1); fi
 182
 183 # (callable) Test to see if the file provided by the first argument exists and the dependencies provided by the third argument matches the value in the file corresponding to the second argument in `$(BUILDDIR)/lastprereqs´.
 184 # If not, return the fourth argument, plus an additional rule to save the new prerequisites.
 185 #
 186 # ※ If the third argument is empty, the fourth argument is always returned.
 187 override makeandsavedeps = $(if $(or $(if $3,,1),$(if $(wildcard $1),,1),$(subst $(shell $(CAT) $(call quote,$(BUILDDIR)/lastdeps/$2) 2> /dev/null || true),,$3)),$4$(newline)$(silent)$(call ensuredirectory,$(BUILDDIR)/lastdeps)$(newline)$(silent)$(PRINTF) '%s\n' $(call quote,$3) > $(call quote,$(BUILDDIR)/lastdeps/$2),)
 188
 189 # (callable) Make the catalog for the provided category.
 190 override define makecategorycatalog
 191 @$(PRINTF) '%s\n' $(call quote,Generating catalog for category `$1´…)
 192 $(silent)$(call ensuredirectory,$(BUILDDIR)/catalogs/categories/$1)
 193 $(silent)$(XMLCATALOG) --create --noout $(call quote,$(BUILDDIR)/catalogs/categories/$1/index)
 194 $(silent)$(XMLCATALOG) --add uri '?' 'about:category' --noout $(call quote,$(BUILDDIR)/catalogs/categories/$1/index)
 195 $(silent)$(XMLCATALOG) --add uri '@' $(call quote,$1/@) --noout $(call quote,$(BUILDDIR)/catalogs/categories/$1/index)
 196 $(foreach entry,$(call entriesforcategory,$1),$(silent)$(XMLCATALOG) --add uri $(call quote,$(call identifier,$(entry))) $(call quote,$(patsubst $(SRCDIR)/%,%,$(entry))) --noout $(call quote,$(BUILDDIR)/catalogs/categories/$1/index)$(newline))
 197 endef
 198
 199 # (callable) Make the catalog for the dynamic or static index.
 200 override define makeindexcatalog
 201 @$(PRINTF) '%s\n' 'Generating $(if $1,static,dynamic) catalog index…'
 202 $(silent)$(call ensuredirectory,$(BUILDDIR)/catalogs/indices)
 203 $(silent)$(XMLCATALOG) --create --noout $(call quote,$(BUILDDIR)/catalogs/indices/$(if $1,full,)index)
 204 $(silent)$(XMLCATALOG) --add uri '.' '$(if $1,standalone,index).xhtml' --noout $(call quote,$(BUILDDIR)/catalogs/indices/$(if $1,full,)index)
 205 $(silent)$(XMLCATALOG) --add uri '?' 'about:$(if $1,full,)index' --noout $(call quote,$(BUILDDIR)/catalogs/indices/$(if $1,full,)index)
 206 $(silent)$(XMLCATALOG) --add uri '@' '@' --noout $(call quote,$(BUILDDIR)/catalogs/indices/$(if $1,full,)index)
 207 $(foreach category,$(categories),$(silent)$(XMLCATALOG) --add uri $(call quote,$(category)) $(call quote,$(category)/index) --noout $(call quote,$(BUILDDIR)/catalogs/indices/$(if $1,full,)index)$(newline))
 208 endef
 209
 210 # ─ ¶ ⛩📰 书社 Targets ──────────────────────────────────────────────
 211
 212 # Targets to forward to ⛩📰 书社.
 213 all install list uninstall : $(SHUSHE)/GNUmakefile catalogs
 214         $(silent)$(MAKE) -f $(call quote,$<) $(call quote,$@) $(shusheopts)
 215 %-shushe : $(SHUSHE)/GNUmakefile FORCE
 216         $(silent)$(MAKE) -f $(call quote,$<) $(call quote,$*) $(shusheopts)
 217 build/⛩📰/% : $(SHUSHE)/GNUmakefile catalogs FORCE
 218         $(SILENT)$(MAKE) -f $(call quote,$<) $(call quote,$@) $(shusheopts)
 219 public/% : $(SHUSHE)/GNUmakefile catalogs FORCE
 220         $(SILENT)$(MAKE) -f $(call quote,$<) $(call quote,$@) $(shusheopts)
 221
 222 # ─ ¶ Phony Targets ───────────────────────────────────────────────────
 223
 224 # Generate all catalogs, then remove any which no longer have corresponding source files.
 225 catalogs : $(allcatalogs)
 226         @$(PRINTF) '%s\n' 'Removing any outdated catalogs…'
 227         $(foreach deletedcategory,$(filter-out $(categorycatalogs),$(wildcard $(BUILDDIR)/catalogs/categories/*/index)),@$(PRINTF) '%s\n' $(call quote,Removing `$(patsubst $(BUILDDIR)/catalogs/categories/%/index,%,$(deletedcategory))´…)$(newline)$(silent)$(RM) -rf $(call quote,./$(dir $(deletedcategory)))$(newline)$(silent)$(RM) -rf $(call quote,./$(patsubst $(BUILDDIR)/catalogs/categories/%,$(BUILDDIR)/catalogs/entries/%,$(dir $(deletedcategory))))$(newline))
 228         $(foreach deletedentry,$(filter-out $(entrycatalogs),$(wildcard $(BUILDDIR)/catalogs/entries/*/*)),@$(PRINTF) '%s\n' $(call quote,Removing `$(patsubst $(BUILDDIR)/catalogs/entries/%,%,$(deletedentry))´…)$(newline)$(silent)$(RM) $(call quote,./$(deletedentry))$(newline))
 229
 230 # Destroy buildfiles.
 231 clean:
 232         $(if $(BUILDDIR),$(silent)$(RM) -rf $(call quote,$(BUILDDIR)/),)
 233
 234 # Provide help.
 235 help :
 236         @$(PRINTF) '%b' '$(subst $(newline),\n,$(makefileinfo))'
 237
 238 # Destroy build directory and installed files.
 239 gone : clean uninstall ;
 240
 241 # List the i·d’s of all recognized entries.
 242 listids :
 243         @$(TR) '| ' ' \n' <<< '$(strip $(foreach category,$(categories),\0033[1m$(category)\0033[22m: $(patsubst %,•|%,$(call identifier,$(call entriesforcategory,$(category)))) ))' | $(XARGS) -0 $(PRINTF) '%b'
 244
 245 # Output a random unused identifier.
 246 wrmg :
 247         @$(PRINTF) '%s\n' $(wrmg)
 248
 249 # Create a new entry in the provided category and output its path.
 250 +% : FORCE
 251         $(silent)$(call ensuredirectory,$(SRCDIR)/$*)
 252         $(if $(wildcard $(SRCDIR)/$*/@),,$(silent)$(PRINTF) '%b' '%%\nCATEGORY : $*\n%%\n' > '$(SRCDIR)/$*/@')
 253         $(foreach identifier,$(wrmg),@$(PRINTF) '%b' '\0043!lesml\nENTRY : $(identifier)\n%%\n\n' > '$(SRCDIR)/$*/$(identifier)'$(newline)@$(PRINTF) '%s\n' '$(SRCDIR)/$*/$(identifier)')
 254
 255 # ─ ¶ Special Targets ─────────────────────────────────────────────────
 256
 257 # Perform secondary expansion; this enables pattern rules to determine their prerequisites based on the matched pattern.
 258 .SECONDEXPANSION : ;
 259
 260 # Don’t use any implicit rules.
 261 .SUFFIXES : ;
 262
 263 # Treat targets with this as a prerequisite as though they were phony.
 264 #
 265 # Mainly useful in pattern rules.
 266 FORCE : ;
 267
 268 # Phony rules; always consider these out·of·date.
 269 .PHONY : FORCE all build catalogs clean gone help install list listids uninstall wrmg ;
 270
 271 # ─ ¶ Build Targets ───────────────────────────────────────────────────
 272
 273 # Initialize the ⛩📰 书社 repository if it is empty.
 274 ifneq ($(filter $(THISDIR)/%,$(SHUSHE)),)
 275 $(SHUSHE)/GNUmakefile : $(THISDIR)/%/GNUmakefile :
 276         @$(PRINTF) '%s\n' $(call quote,Initializing git submodule at `$*´)
 277         $(silent)cd $(THISDIR) && $(GIT) submodule update --init $(call quote,$*)
 278 endif
 279
 280 # Initialize the 💄📝 Les·M·L repository if it is empty.
 281 ifneq ($(filter $(THISDIR)/%,$(LESML)),)
 282 $(LESML)/parser.xslt : $(THISDIR)/%/parser.xslt :
 283         @$(PRINTF) '%s\n' $(call quote,Initializing git submodule at `$*´)
 284         $(silent)cd $(THISDIR) && $(GIT) submodule update --init $(call quote,$*)
 285 endif
 286
 287 # Create an empty codex metadata file if none exists.
 288 $(SRCDIR)/@ :
 289         $(silent)$(PRINTF) '%b' '%%\nCODEX :\n%%\n' > $(call quote,$@)
 290
 291 # Create category catalogs.
 292 $(categorycatalogs) : $(BUILDDIR)/catalogs/categories/%/index : FORCE
 293         $(call makeandsavedeps,$@,$*,$(call entriesforcategory,$*),$(call makecategorycatalog,$*))
 294
 295 # Create entry catalogs.
 296 $(entrycatalogs) : $(BUILDDIR)/catalogs/entries/% :
 297         @$(PRINTF) '%s\n' $(call quote,Generating catalog for document `$(call identifier,$*)´…)
 298         $(silent)$(call ensuredirectory,$(dir $@))
 299         $(silent)$(XMLCATALOG) --create --noout $(call quote,$@)
 300         $(silent)$(XMLCATALOG) --add uri '.' '$(call identifier,$*).xhtml' --noout $(call quote,$@)
 301         $(silent)$(XMLCATALOG) --add uri '?' 'about:entry' --noout $(call quote,$@)
 302         $(silent)$(XMLCATALOG) --add uri '@' $(call quote,$*) --noout $(call quote,$@)
 303
 304 $(BUILDDIR)/catalogs/indices/index : FORCE | $(SRCDIR)/@
 305         $(call makeandsavedeps,$@,index,$(categories),$(call makeindexcatalog,))
 306
 307 $(BUILDDIR)/catalogs/indices/fullindex : FORCE | $(SRCDIR)/@
 308         $(call makeandsavedeps,$@,fullindex,$(categories),$(call makeindexcatalog,1))