Makefile

   1 # Copyright 2020-2021 Ian Jackson and contributors to Otter
   2 # SPDX-License-Identifier: AGPL-3.0-or-later
   3 # There is NO WARRANTY.
   4
   5 # make -j8
   6 # make -j8 release
   7 # make -j8 shapelib
   8
   9 SHELL=/bin/bash
  10 src=.
  11
  12 default: all check
  13 all: debug
  14 full-check: all check cargo-syntaxcheck-release shapelib doc-sphinx
  15 full-check: for-deploy release
  16 everything: debug doc release check bundled-sources
  17
  18 shapelib: templates/shapelib.html stamp/cargo.doc-otter-only
  19         @echo 'Shape library preview and docs can now be found here:'
  20         @echo '  file://$(PWD)/$<'
  21         @echo '  file://$(abspath $(TARGET_DIR)/doc/otter/shapelib_toml/index.html)'
  22
  23 MAKEFILE_DEP ?= Makefile
  24 MAKEFILE_FIND_X ?=
  25 # ^ set this to "x" to debug the $rsrcs rune
  26
  27 #---------- funky macros etc. ----------
  28
  29 cr = $(addprefix --,$(filter-out debug,$1))
  30 rsrcs = $(shell $(foreach x,$(MAKEFILE_FIND_X),set -$x;)\
  31     find -H $1 \( -name Cargo.toml -o -name Cargo.lock -o -name Cargo.lock.example -o -name \*.rs \) \! -path '*/build/*' )
  32 stamp=@mkdir -p stamp; touch $@
  33
  34 BUNDLED_SOURCES_LIT = README.md LICENCE
  35 BUNDLED_SOURCES_FILES = index.html $(BUNDLED_SOURCES_LIT)
  36 BUNDLED_SOURCES_LINKS += $(BUNDLED_SOURCES_LIT) otter/
  37 BUNDLED_SOURCES += $(BUNDLED_SOURCES_FILES)
  38
  39 #---------- programs and config variables ----------
  40
  41 CARGO ?= cargo
  42 TARGET_DIR ?= target
  43
  44 USVG_OPTIONS = "--sans-serif-family=DejaVu Sans"
  45
  46 WASM_BINDGEN = $(TARGET_DIR)/debug/wasm-bindgen
  47 WASM_BINDGEN_OPTIONS =                                          \
  48         --remove-name-section --remove-producers-section        \
  49         --typescript --no-modules                               \
  50
  51 BUNDLE_SOURCES ?= bundle-rust-sources
  52
  53 SPHINXBUILD   = sphinx-build
  54
  55 ifndef INKSCAPE_EXTENSIONS
  56 INKSCAPE ?= inkscape
  57 INKSCAPE_SDD_QUIETEN ?= 2>/dev/null
  58 # inkscape 0.92.4: --extension-directory works, no --system-data-directory
  59 # inkscape 1.0.2: --system-data-directory, no --extension-directory
  60 INKSCAPE_EXTENSIONS := $(shell set -e; { sdd=$$( $(INKSCAPE) --system-data-directory $(INKSCAPE_SDD_QUIETEN) ) && echo "$$sdd/extensions"; } || $(INKSCAPE) --extension-directory )
  61 endif
  62 RECOLOUR_SVG ?= ./run-inkscape-extension $(INKSCAPE_EXTENSIONS)/color_replace.py
  63
  64 DEPLOY_ARCH=x86_64-unknown-linux-musl
  65 DEPLOY_RELEASE=debug
  66 DEPLOY_TARGET_DIR=$(TARGET_DIR)/$(addsuffix /,$(DEPLOY_ARCH))$(DEPLOY_RELEASE)
  67 DEPLOYED_BRANCH=deployed
  68 PUBLISHED_BRANCH=published
  69
  70 #---------- nailing-cargo ----------
  71
  72 ifneq (,$(wildcard ../Cargo.nail))
  73
  74 NAILING_CARGO = nailing-cargo
  75 CARGO = $(NAILING_CARGO)
  76 BUILD_SUBDIR ?= ../Build
  77 TARGET_DIR = $(BUILD_SUBDIR)/$(notdir $(PWD))/target
  78
  79 NAILING_CARGO_JUST_RUN ?= $(NAILING_CARGO) --just-run -q ---
  80 BUNDLE_SOURCES_CMD ?= $(NAILING_CARGO) --- $(BUNDLE_SOURCES)
  81 USVG_CMD ?= $(NAILING_CARGO_JUST_RUN) $(USVG)
  82 WASM_BINDGEN_CLI_CARGO_OPTS ?= --subcommand-props=!manifest-path
  83
  84 clean-nailing:
  85         $(NAILING_CARGO_JUST_RUN) \
  86  sh -c 'cd "$1"; find -mindepth 1 -maxdepth 1 -print0 | xargs -0r rm -rf --' \
  87                 $(abspath $(BUILD_SUBDIR)/$(notdir $(PWD)))
  88
  89 else
  90 clean-nailing:
  91 endif # Cargo.nail
  92
  93 BUILD_SUBDIR ?= ../Build
  94 BUNDLE_SOURCES_CMD ?= $(BUNDLE_SOURCES)
  95 USVG_CMD ?= $(USVG)
  96
  97 WASM_PACKED=$(TARGET_DIR)/packed-wasm
  98
  99 #---------- local programs ----------
 100
 101 define lp
 102 stamp/cargo.$2: $(call rsrcs, ! -name \*.rs)
 103         $$(CARGO) build $(call cr,$3) -p $2
 104         $$(stamp)
 105 $1 := $(abspath $(TARGET_DIR)/$3/$4)
 106 endef
 107
 108 $(eval $(call lp,BUNDLE_SOURCES,bundle-sources,debug,bundle-rust-sources))
 109 $(eval $(call lp,USVG,usvg,release,usvg))
 110
 111 #---------- variables defining bits of source etc. ----------
 112
 113 PROGRAMS=daemon-otter otter
 114
 115 WASM_ASSETS := $(addprefix otter_wasm,.js _bg.wasm)
 116 WASM_OUTPUTS := $(addprefix otter_wasm,.d.ts)
 117
 118 TS_SRCS= script
 119 TS_SRC_FILES= \
 120         $(addprefix templates/,$(addsuffix .ts,$(TS_SRCS))) \
 121         webassembly-types/webassembly.d.ts \
 122         $(WASM_PACKED)/otter_wasm.d.ts
 123
 124 LITFILES= LICENCE AGPLv3
 125 TXTFILES= CC-BY-SA-3.0 CC-BY-SA-4.0
 126
 127 FILEASSETS = $(addprefix templates/, libre shapelib.html script.js \
 128                         $(LITFILES) $(TXTFILES)) \
 129                 $(wildcard templates/*.tera)
 130
 131 WASM := wasm32-unknown-unknown
 132 # ^ todo: Is this still right after
 133 #     Use correct ABI for wasm32 by default
 134 #     https://github.com/rust-lang/rust/pull/79998
 135 # ?  But maybe it doesn't matter since we're very conservative and
 136 # only pass JsValue and a few strings across the WASM ABI.
 137
 138 #---------- toplevel aggregate targets ----------
 139
 140 check: stamp/cargo.debug-check at wdt
 141         @echo 'Tests passed.'
 142
 143 full-check: stamp/cargo.release-check
 144 full-check: stamp/cargo.release-miri stamp/cargo.debug-miri
 145
 146 full-check:
 147         @echo 'Full tests passed.'
 148
 149 doc: cargo-doc doc-sphinx examples
 150
 151 debug release:: %: stamp/cargo.% assets libraries extra-%
 152
 153 cargo: cargo-debug cargo-wasm-release
 154
 155 cargo-debug cargo-release cargo-check cargo-doc \
 156 cargo-wasm-debug cargo-wasm-release:: \
 157 cargo-%: stamp/cargo.%
 158
 159 EXAMPLE_BUNDLES = test-bundle big-bundle
 160 EXAMPLE_BUNDLE_FILES = $(foreach f, $(EXAMPLE_BUNDLES), examples/$f.zip)
 161
 162 examples: $(EXAMPLE_BUNDLE_FILES)
 163 .PHONY: examples
 164
 165 cargo-wasm: cargo-wasm-release
 166
 167 wasm: stamp/wasm-bindgen
 168
 169 assets: js stamp/wasm-bindgen $(FILEASSETS)
 170
 171 js: templates/script.js
 172
 173 extra-debug:
 174 extra-release: bundled-sources
 175
 176 cargo-syntaxcheck: cargo-syntaxcheck-host cargo-syntaxcheck-wasm
 177 cargo-syntaxcheck-host:
 178         $(CARGO) check --workspace
 179 cargo-syntaxcheck-wasm:
 180         $(CARGO) check --target $(WASM) -p otter-wasm --release
 181 cargo-syntaxcheck-release:
 182         $(CARGO) check --workspace --release
 183
 184 #---------- cargo ----------
 185
 186 DR=debug release
 187 CARGOES=$(foreach t, wasm-,$(addprefix $t,check $(DR)))
 188
 189 $(addprefix stamp/cargo.,$(DR)):: \
 190 stamp/cargo.%: $(call rsrcs,. ! -path './wasm/*')
 191         $(CARGO) build --workspace $(call cr,$*) -p otter -p otter-daemon
 192         $(stamp)
 193
 194 $(TARGET_DIR)/debug/%: $(call rsrcs, ! -path './wasm/*')
 195         $(CARGO) build --workspace -p otter --bin $*
 196
 197 stamp/cargo.wasm-bindgen: $(call rsrcs, ! -name \*.rs)
 198         $(CARGO) $(WASM_BINDGEN_CLI_CARGO_OPTS) build --target-dir=target \
 199                 --manifest-path=$(abspath wasm/Cargo.toml) -p wasm-bindgen-cli
 200         $(stamp)
 201
 202 stamp/cargo.%-check: $(call rsrcs,.)
 203         $(CARGO) test --workspace $(call cr,$*)
 204         $(stamp)
 205
 206 stamp/cargo.%-miri: $(call rsrcs,.)
 207         $(CARGO) miri test --workspace $(call cr,$*)
 208         $(stamp)
 209
 210 stamp/cargo-at.debug: $(call rsrcs,.)
 211         $(CARGO) build --workspace $(call cr,$*) -p otter-api-tests
 212         $(stamp)
 213
 214 stamp/cargo-wdt.debug: $(call rsrcs,.)
 215         $(CARGO) build --workspace $(call cr,$*) -p otter-webdriver-tests
 216         $(stamp)
 217
 218 stamp/cargo.doc: $(call rsrcs,.)
 219         $(CARGO) doc $(CARGO_DOC_OPTS) --workspace 2>&1 |egrep -vf .cargo-doc-suppress-errors
 220         $(stamp)
 221
 222 stamp/cargo.doc-otter-only: $(call rsrcs,.)
 223         $(CARGO) doc $(CARGO_DOC_OPTS) --workspace -p otter --no-deps
 224         $(stamp)
 225
 226 $(addprefix stamp/cargo.wasm-,$(DR)):: \
 227 stamp/cargo.wasm-%: $(call rsrcs, base wasm Cargo.*)
 228         $(CARGO) build --target $(WASM) -p otter-wasm $(call cr,$*)
 229         $(stamp)
 230
 231 stamp/cargo.deploy-build: $(call rsrcs,.)
 232         $(CARGO) build --target $(DEPLOY_ARCH) $(call cr,$(DEPLOY_RELEASE)) -p otter -p otter-daemon
 233         $(stamp)
 234
 235 #---------- sphnix ----------
 236
 237 doc-sphinx:     docs/html/index.html \
 238                 $(foreach f, $(EXAMPLE_BUNDLES), docs/html/$f.zip)
 239         @echo 'Documentation can now be found here:'
 240         @echo '  file://$(PWD)/$<'
 241
 242 docs/html/index.html: docs/conf.py $(wildcard docs/*.md docs/*.rst docs/*.png)
 243         $(SPHINXBUILD) -M html docs docs $(SPHINXOPTS)
 244
 245 docs/html/%.zip: examples/%.zip
 246         rm -f $@ && ln $< $@
 247
 248 #---------- wasm ----------
 249
 250 $(addprefix $(WASM_PACKED)/,$(WASM_ASSETS) $(WASM_OUTPUTS)): stamp/wasm-bindgen
 251 stamp/wasm-bindgen: stamp/cargo.wasm-bindgen stamp/cargo.wasm-release
 252         $(NAILING_CARGO_JUST_RUN) $(abspath $(WASM_BINDGEN)) \
 253                 $(WASM_BINDGEN_OPTIONS) --out-dir target/packed-wasm \
 254                 target/$(WASM)/release/otter_wasm.wasm
 255         $(stamp)
 256
 257 #---------- bundle-sources ----------
 258
 259 BUNDLED_SOURCES_DIRS += otter
 260
 261 bundled-sources:: $(addprefix bundled-sources/, $(BUNDLED_SOURCES_DIRS))
 262
 263 TARGET_BUNDLED=$(TARGET_DIR)/bundled-sources
 264
 265 $(TARGET_BUNDLED):
 266         $(NAILING_CARGO_JUST_RUN) mkdir -p $(abspath $@)
 267
 268 $(addprefix bundled-sources/, $(BUNDLED_SOURCES_DIRS)): \
 269 bundled-sources/%: stamp/cargo.bundle-sources $(TARGET_BUNDLED)
 270         set -e; d=$(abspath $(TARGET_BUNDLED)); \
 271         $(if $(filter-out otter,$*), cd ../$*;) \
 272         $(BUNDLE_SOURCES_CMD) --output $$d/$*
 273
 274 bundled-sources:: $(addprefix $(TARGET_BUNDLED)/, $(BUNDLED_SOURCES_FILES))
 275
 276 $(addprefix $(TARGET_BUNDLED)/, $(BUNDLED_SOURCES_LIT)): \
 277 $(TARGET_BUNDLED)/%: % $(TARGET_BUNDLED)
 278         $(NAILING_CARGO_JUST_RUN) cp $(abspath $(src))/$< $(abspath $@)
 279
 280 $(TARGET_BUNDLED)/index.html: bundled-sources-make-index \
 281                 $(MAKEFILE_DEP) $(TARGET_BUNDLED)
 282         $(NAILING_CARGO_JUST_RUN) sh -ec '                      \
 283                 cd $(abspath $(src)); mkdir -p $(dir $@);       \
 284                 ./$< >$@.tmp $(BUNDLED_SOURCES_LINKS);          \
 285                 mv -f $@.tmp $@;                                \
 286         '
 287
 288 bundled-sources::
 289         @echo Bundled sources.
 290
 291 #---------- svg processing ----------
 292
 293 LIBRARIES ?= $(basename $(wildcard library/*.toml))
 294 USVG_DEP = stamp/cargo.usvg
 295
 296 include $(addsuffix /files.make, $(LIBRARIES))
 297
 298 USVG_PROCESSOR = usvg-processor
 299 LIBRARY_PROCESS_SVG = ./$(USVG_PROCESSOR) $@ $(wordlist 1,2,$^) '$(USVG_CMD) $(USVG_OPTIONS)'
 300 $(LIBRARY_FILES): $(USVG_PROCESSOR) $(USVG_DEP) $(MAKEFILE_DEP)
 301
 302 # actual command for each of $(LIBRARY_FILES) is in one of the files.make
 303
 304 library/%/files.make: media-scraper library/%.toml
 305         ./$< --offline library/$*.toml
 306
 307 #---------- typescript ----------
 308
 309 templates/%.js: tsc-wrap tsconfig.json
 310         ./tsc-wrap $@ tsconfig.json $(filter %.ts,$^)
 311
 312 templates/script.js: $(TS_SRC_FILES) stamp/wasm-bindgen
 313
 314 #---------- other templates ----------
 315
 316 $(addprefix templates/,$(LITFILES)): templates/%: %
 317         cp $< $@.new && mv -f $@.new $@
 318
 319 $(addprefix templates/,$(TXTFILES)): templates/%: %.txt
 320         cp $< $@.new && mv -f $@.new $@
 321
 322 libraries: $(LIBRARY_FILES)
 323
 324 templates/shapelib.html: $(TARGET_DIR)/debug/otterlib $(LIBRARY_FILES)
 325         $(NAILING_CARGO_JUST_RUN) $(abspath $<) \
 326         --libs '$(addprefix $(PWD)/, $(addsuffix .toml, $(LIBRARIES)))' \
 327                 preview >$@.tmp && mv -f $@.tmp $@
 328
 329 #---------- examples ----------
 330
 331 EXAMPLE_BUNDLE_INPUT_DEPS := $(shell                                    \
 332         cd examples/test-bundle/ && find \! \( -name '*~' -o -name '.*' \) \
 333 )
 334
 335 examples/%.zip: $(MAKEFILE_DEP)
 336         set -e; rm -f $@.tmp; cd examples/$*/; \
 337         zip $(ZIPFLAGS) -DX ../$(notdir $@).tmp $(ZIP_INPUTS)
 338         mv -f $@.tmp $@
 339
 340 examples/test-bundle.zip: ZIP_INPUTS=$(EXAMPLE_BUNDLE_INPUT_DEPS)
 341 examples/test-bundle.zip: \
 342  $(addprefix examples/test-bundle/, $(EXAMPLE_BUNDLE_INPUT_DEPS))
 343
 344 examples/big-bundle.zip: examples/big-bundle/otter.toml
 345 examples/big-bundle.zip: ZIPFLAGS+= -0 -r -q
 346 examples/big-bundle.zip: ZIP_INPUTS=.
 347 examples/big-bundle/otter.toml: $(LIBRARY_FILES) $(MAKEFILE_DEP)
 348         rm -rf examples/big-bundle
 349         mkdir examples/big-bundle examples/big-bundle/library
 350         @set -e; echo 'MKDIR for $@'; \
 351         for l in $(LIBRARIES); do \
 352                 mkdir examples/big-bundle/$$l; \
 353                 perl -p \
 354  -e 'BEGIN { print "# -- AUTOGENERATED FROM COPY IN OTTER SOURCE --\n" }' \
 355  -e 'if (m/^\[scraper]/..0) { unless (m/^\[(?!scraper)/..0) { s/^/\#/ } }' \
 356  -e 's/(?<=\s)\w\S*(?=\s)/-/ if m/^files = """/..m/^"""/;' \
 357                         <$$l.toml >examples/big-bundle/$$l.toml; done
 358         @set -e; echo 'LN for $@'; \
 359         for e in $(LIBRARY_FILE_INPUTS); do \
 360                 ln $${e#*:} examples/big-bundle/$${e%%.usvg:*}.svg; done;
 361         @set -e; echo 'MV for $@'; \
 362         cd examples/big-bundle/library/; for x in '' .toml; do \
 363                 mv wikimedia$$x duped-example$$x; done
 364         @set -e; mkdir examples/big-bundle/specs/; \
 365         perl -pe <specs/demo.game.toml \
 366                 >examples/big-bundle/specs/Modded-spec.game.toml \
 367                 's/chess-b-/chess-purple-/; s/chess-w-/chess-yellow-/'
 368         @set -e; echo 'ECHO for $@'; \
 369         echo 'title = "Autogenerated test bundle - do not distribute"' \
 370                 >$@.tmp
 371         mv -f $@.tmp $@
 372
 373 #---------- webdriver tests (wdt) ----------
 374
 375 AT_TESTS := $(basename $(notdir $(wildcard apitest/at-*.rs)))
 376 WDT_TESTS := $(basename $(notdir $(wildcard wdriver/wdt-*.rs)))
 377
 378 WDT_LANDSCAPE_TESTS = wdt-altergame
 379
 380 at:     $(foreach f, $(AT_TESTS), stamp/$f.check)
 381
 382 wdt:    $(foreach f, $(WDT_TESTS), stamp/$f.check) \
 383         $(foreach f, $(WDT_LANDSCAPE_TESTS), stamp/$f.lcheck) \
 384
 385 RUNTEST_DEPS =  apitest/run1 stamp/cargo.debug $(FILEASSETS) \
 386                 $(wildcard specs/*.toml) examples/test-bundle.zip \
 387                 $(wildcard libraries/*.toml) $(LIBRARY_FILES)
 388
 389 AT_DEPS =       $(filter-out templates/script.js, $(RUNTEST_DEPS)) \
 390                 examples/big-bundle.zip \
 391                 stamp/cargo-at.debug
 392
 393 WDT_DEPS =      $(RUNTEST_DEPS) \
 394                 stamp/cargo-wdt.debug
 395
 396 AT_WDT_RUN = $(NAILING_CARGO_JUST_RUN) $(abspath $<)
 397
 398 AT_RUN = $(AT_WDT_RUN) apitest --test=$(basename $(notdir $@))
 399 WDT_RUN = $(AT_WDT_RUN) wdriver --test=$(basename $(notdir $@))
 400
 401 for-at:                 $(AT_DEPS)
 402 stamp/at-%.check:       $(AT_DEPS)
 403         $(AT_RUN)
 404         $(stamp)
 405
 406 for-wdt:                $(WDT_DEPS)
 407 stamp/wdt-%.check:      $(WDT_DEPS)
 408         $(WDT_RUN)
 409         $(stamp)
 410
 411 stamp/wdt-%.lcheck:     $(WDT_DEPS)
 412         $(WDT_RUN) --as-if=lwdt-$* --layout=Landscape
 413         $(stamp)
 414
 415 #---------- docs publication ----------
 416
 417 PUBLISH_USER=ianmdlvl@login.chiark.greenend.org.uk
 418 PUBLISH_DOC_SPHINX=$(PUBLISH_USER):public-html/otter/docs
 419
 420 publish: doc-sphinx
 421         rsync -r --delete-delay docs/html/. $(PUBLISH_DOC_SPHINX)/.
 422         git branch -f $(PUBLISHED_BRANCH)
 423
 424 #---------- deployment ----------
 425
 426 DEPLOY_USER=ian@login.chiark.greenend.org.uk
 427 DEPLOY_BASE=$(DEPLOY_USER):/volatile/Otter
 428 DEPLOY_FINISH=/home/Otter/etc/deploy-finish
 429
 430 for-deploy: stamp/cargo.deploy-build
 431 deploy: for-deploy bundled-sources assets libraries
 432         rsync -zv --progress $(addprefix $(DEPLOY_TARGET_DIR)/,$(PROGRAMS)) $(DEPLOY_BASE)/bin/
 433         rsync -zv --progress $(TARGET_DIR)/release/usvg $(DEPLOY_BASE)/libexec/
 434         rsync -rv --progress $(TARGET_DIR)/bundled-sources/. $(DEPLOY_BASE)/bundled-sources
 435         rsync -r README.md $(DEPLOY_BASE)/.
 436         rsync -r --delete --exclude=\*~ library specs $(DEPLOY_BASE)/.
 437         rsync -r $(FILEASSETS) $(addprefix $(WASM_PACKED)/, $(WASM_ASSETS)) \
 438                 $(DEPLOY_BASE)/assets/
 439         rsync -r nwtemplates/*.tera $(DEPLOY_BASE)/nwtemplates/
 440         ssh -o BatchMode=true $(DEPLOY_USER) $(DEPLOY_FINISH)
 441         git branch -f $(DEPLOYED_BRANCH)
 442         -git push origin main
 443         -git push chiark main
 444
 445 #$(DEPLOY_BASE)/bundled-sources
 446
 447 #---------- clean ----------
 448
 449 clean-for-retest:
 450         rm -f templates/script.js library/*/*.usvg stamp/*
 451         rm -rf $(LIBRARY_CLEAN)
 452         rm -rf examples/big-bundle examples/big-bundle.zip
 453         rm -f examples/test-bundle.zip
 454         find * \( -name '*~' -o -name '*.tmp' \) -print0 | xargs -0r rm --
 455
 456 clean: clean-nailing clean-for-retest
 457         rm -rf target
 458         $(NAILING_CARGO_JUST_RUN) rm -rf target