1 # Copyright 2020-2021 Ian Jackson and contributors to Otter
2 # SPDX-License-Identifier: AGPL-3.0-or-later
3 # There is NO WARRANTY.
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
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)'
23 MAKEFILE_DEP ?= Makefile
25 # ^ set this to "x" to debug the $rsrcs rune
27 #---------- funky macros etc. ----------
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 $@
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)
39 #---------- programs and config variables ----------
44 USVG_OPTIONS = "--sans-serif-family=DejaVu Sans"
46 WASM_BINDGEN = $(TARGET_DIR)/debug/wasm-bindgen
47 WASM_BINDGEN_OPTIONS = \
48 --remove-name-section --remove-producers-section \
49 --typescript --no-modules \
51 BUNDLE_SOURCES ?= bundle-rust-sources
53 SPHINXBUILD = sphinx-build
55 ifndef INKSCAPE_EXTENSIONS
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 )
62 RECOLOUR_SVG ?= ./run-inkscape-extension $(INKSCAPE_EXTENSIONS)/color_replace.py
64 DEPLOY_ARCH=x86_64-unknown-linux-musl
66 DEPLOY_TARGET_DIR=$(TARGET_DIR)/$(addsuffix /,$(DEPLOY_ARCH))$(DEPLOY_RELEASE)
67 DEPLOYED_BRANCH=deployed
68 PUBLISHED_BRANCH=published
70 #---------- nailing-cargo ----------
72 ifneq (,$(wildcard ../Cargo.nail))
74 NAILING_CARGO = nailing-cargo
75 CARGO = $(NAILING_CARGO)
76 BUILD_SUBDIR ?= ../Build
77 TARGET_DIR = $(BUILD_SUBDIR)/$(notdir $(PWD))/target
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
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)))
93 BUILD_SUBDIR ?= ../Build
94 BUNDLE_SOURCES_CMD ?= $(BUNDLE_SOURCES)
97 WASM_PACKED=$(TARGET_DIR)/packed-wasm
99 #---------- local programs ----------
102 stamp/cargo.$2: $(call rsrcs, ! -name \*.rs)
103 $$(CARGO) build $(call cr,$3) -p $2
105 $1 := $(abspath $(TARGET_DIR)/$3/$4)
108 $(eval $(call lp,BUNDLE_SOURCES,bundle-sources,debug,bundle-rust-sources))
109 $(eval $(call lp,USVG,usvg,release,usvg))
111 #---------- variables defining bits of source etc. ----------
113 PROGRAMS=daemon-otter otter
115 WASM_ASSETS := $(addprefix otter_wasm,.js _bg.wasm)
116 WASM_OUTPUTS := $(addprefix otter_wasm,.d.ts)
120 $(addprefix templates/,$(addsuffix .ts,$(TS_SRCS))) \
121 webassembly-types/webassembly.d.ts \
122 $(WASM_PACKED)/otter_wasm.d.ts
124 LITFILES= LICENCE AGPLv3
125 TXTFILES= CC-BY-SA-3.0 CC-BY-SA-4.0
127 FILEASSETS = $(addprefix templates/, libre shapelib.html script.js \
128 $(LITFILES) $(TXTFILES)) \
129 $(wildcard templates/*.tera)
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.
138 #---------- toplevel aggregate targets ----------
140 check: stamp/cargo.debug-check at wdt
141 @echo 'Tests passed.'
143 full-check: stamp/cargo.release-check
144 full-check: stamp/cargo.release-miri stamp/cargo.debug-miri
147 @echo 'Full tests passed.'
149 doc: cargo-doc doc-sphinx examples
151 debug release:: %: stamp/cargo.% assets libraries extra-%
153 cargo: cargo-debug cargo-wasm-release
155 cargo-debug cargo-release cargo-check cargo-doc \
156 cargo-wasm-debug cargo-wasm-release:: \
157 cargo-%: stamp/cargo.%
159 EXAMPLE_BUNDLES = test-bundle big-bundle
160 EXAMPLE_BUNDLE_FILES = $(foreach f, $(EXAMPLE_BUNDLES), examples/$f.zip)
162 examples: $(EXAMPLE_BUNDLE_FILES)
165 cargo-wasm: cargo-wasm-release
167 wasm: stamp/wasm-bindgen
169 assets: js stamp/wasm-bindgen $(FILEASSETS)
171 js: templates/script.js
174 extra-release: bundled-sources
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
184 #---------- cargo ----------
187 CARGOES=$(foreach t, wasm-,$(addprefix $t,check $(DR)))
189 $(addprefix stamp/cargo.,$(DR)):: \
190 stamp/cargo.%: $(call rsrcs,. ! -path './wasm/*')
191 $(CARGO) build --workspace $(call cr,$*) -p otter -p otter-daemon -p otter-cli
192 $(NAILING_CARGO_JUST_RUN) \
193 ln -sf otter $(abspath $(TARGET_DIR))/$*/otter-ssh-proxy
196 $(TARGET_DIR)/debug/%: $(call rsrcs, ! -path './wasm/*')
197 $(CARGO) build --workspace -p otter-cli
199 stamp/cargo.wasm-bindgen: $(call rsrcs, ! -name \*.rs)
200 $(CARGO) $(WASM_BINDGEN_CLI_CARGO_OPTS) build --target-dir=target \
201 --manifest-path=$(abspath wasm/Cargo.toml) -p wasm-bindgen-cli
204 stamp/cargo.%-check: $(call rsrcs,.)
205 $(CARGO) test --workspace $(call cr,$*)
208 stamp/cargo.%-miri: $(call rsrcs,.)
209 $(CARGO) miri test --workspace $(call cr,$*)
212 stamp/cargo-at.debug: $(call rsrcs,.)
213 $(CARGO) build --workspace $(call cr,$*) -p otter-api-tests
216 stamp/cargo-wdt.debug: $(call rsrcs,.)
217 $(CARGO) build --workspace $(call cr,$*) -p otter-webdriver-tests
220 stamp/cargo.doc: $(call rsrcs,.)
221 set -o pipefail -e; \
222 $(CARGO) doc $(CARGO_DOC_OPTS) --workspace 2>&1 |egrep -vf .cargo-doc-suppress-errors
225 stamp/cargo.doc-otter-only: $(call rsrcs,.)
226 $(CARGO) doc $(CARGO_DOC_OPTS) --workspace -p otter --no-deps
229 $(addprefix stamp/cargo.wasm-,$(DR)):: \
230 stamp/cargo.wasm-%: $(call rsrcs, base wasm Cargo.*)
231 $(CARGO) build --target $(WASM) -p otter-wasm $(call cr,$*)
234 stamp/cargo.deploy-build: $(call rsrcs,.)
235 $(CARGO) build --target $(DEPLOY_ARCH) $(call cr,$(DEPLOY_RELEASE)) -p otter -p otter-cli -p otter-daemon
236 $(NAILING_CARGO_JUST_RUN) \
237 ln -sf otter $(abspath $(TARGET_DIR)/$(DEPLOY_ARCH))/$(DEPLOY_RELEASE)/otter-ssh-proxy
240 #---------- sphnix ----------
242 doc-sphinx: docs/html/index.html \
243 $(foreach f, $(EXAMPLE_BUNDLES), docs/html/examples/$f.zip) \
244 $(addprefix docs/html/examples/, $(notdir $(wildcard specs/*.toml)))
245 @echo 'Documentation can now be found here:'
246 @echo ' file://$(PWD)/$<'
248 docs/html/index.html: docs/conf.py $(wildcard docs/*.md docs/*.rst docs/*.png)
249 $(SPHINXBUILD) -M html docs docs $(SPHINXOPTS)
251 docs/html/examples/%.zip: examples/%.zip
252 mkdir -p docs/html/examples
255 docs/html/examples/%.toml: specs/%.toml
256 mkdir -p docs/html/examples
259 #---------- wasm ----------
261 $(addprefix $(WASM_PACKED)/,$(WASM_ASSETS) $(WASM_OUTPUTS)): stamp/wasm-bindgen
262 stamp/wasm-bindgen: stamp/cargo.wasm-bindgen stamp/cargo.wasm-release
263 $(NAILING_CARGO_JUST_RUN) $(abspath $(WASM_BINDGEN)) \
264 $(WASM_BINDGEN_OPTIONS) --out-dir target/packed-wasm \
265 target/$(WASM)/release/otter_wasm.wasm
268 #---------- bundle-sources ----------
270 BUNDLED_SOURCES_DIRS += otter
272 bundled-sources:: $(addprefix bundled-sources/, $(BUNDLED_SOURCES_DIRS))
274 TARGET_BUNDLED=$(TARGET_DIR)/bundled-sources
277 $(NAILING_CARGO_JUST_RUN) mkdir -p $(abspath $@)
279 $(addprefix bundled-sources/, $(BUNDLED_SOURCES_DIRS)): \
280 bundled-sources/%: stamp/cargo.bundle-sources $(TARGET_BUNDLED)
281 set -e; d=$(abspath $(TARGET_BUNDLED)); \
282 $(if $(filter-out otter,$*), cd ../$*;) \
283 $(BUNDLE_SOURCES_CMD) --output $$d/$*
285 bundled-sources:: $(addprefix $(TARGET_BUNDLED)/, $(BUNDLED_SOURCES_FILES))
287 $(addprefix $(TARGET_BUNDLED)/, $(BUNDLED_SOURCES_LIT)): \
288 $(TARGET_BUNDLED)/%: % $(TARGET_BUNDLED)
289 $(NAILING_CARGO_JUST_RUN) cp $(abspath $(src))/$< $(abspath $@)
291 $(TARGET_BUNDLED)/index.html: bundled-sources-make-index \
292 $(MAKEFILE_DEP) $(TARGET_BUNDLED)
293 $(NAILING_CARGO_JUST_RUN) sh -ec ' \
294 cd $(abspath $(src)); mkdir -p $(dir $@); \
295 ./$< >$@.tmp $(BUNDLED_SOURCES_LINKS); \
300 @echo Bundled sources.
302 #---------- svg processing ----------
304 LIBRARIES ?= $(basename $(wildcard library/*.toml))
305 USVG_DEP = stamp/cargo.usvg
307 include $(addsuffix /files.make, $(LIBRARIES))
309 USVG_PROCESSOR = usvg-processor
310 LIBRARY_PROCESS_SVG = ./$(USVG_PROCESSOR) $@ $(wordlist 1,2,$^) '$(USVG_CMD) $(USVG_OPTIONS)'
311 $(LIBRARY_FILES): $(USVG_PROCESSOR) $(USVG_DEP) $(MAKEFILE_DEP)
313 # actual command for each of $(LIBRARY_FILES) is in one of the files.make
315 library/%/files.make: media-scraper library/%.toml
316 ./$< --offline library/$*.toml
318 #---------- typescript ----------
320 templates/%.js: tsc-wrap tsconfig.json
321 ./tsc-wrap $@ tsconfig.json $(filter %.ts,$^)
323 templates/script.js: $(TS_SRC_FILES) stamp/wasm-bindgen
325 #---------- other templates ----------
327 $(addprefix templates/,$(LITFILES)): templates/%: %
328 cp $< $@.new && mv -f $@.new $@
330 $(addprefix templates/,$(TXTFILES)): templates/%: %.txt
331 cp $< $@.new && mv -f $@.new $@
333 libraries: $(LIBRARY_FILES)
335 templates/shapelib.html: $(TARGET_DIR)/debug/otterlib $(LIBRARY_FILES)
336 $(NAILING_CARGO_JUST_RUN) $(abspath $<) \
337 --libs '$(addprefix $(PWD)/, $(addsuffix .toml, $(LIBRARIES)))' \
338 preview >$@.tmp && mv -f $@.tmp $@
340 #---------- examples ----------
342 EXAMPLE_BUNDLE_INPUT_DEPS := $(shell \
343 cd examples/test-bundle/ && find \! \( -name '*~' -o -name '.*' \) \
346 examples/%.zip: $(MAKEFILE_DEP)
347 set -e; rm -f $@.tmp; cd examples/$*/; \
348 zip $(ZIPFLAGS) -DX ../$(notdir $@).tmp $(ZIP_INPUTS)
351 examples/test-bundle.zip: ZIP_INPUTS=$(EXAMPLE_BUNDLE_INPUT_DEPS)
352 examples/test-bundle.zip: \
353 $(addprefix examples/test-bundle/, $(EXAMPLE_BUNDLE_INPUT_DEPS))
355 examples/big-bundle.zip: examples/big-bundle/otter.toml
356 examples/big-bundle.zip: ZIPFLAGS+= -0 -r -q
357 examples/big-bundle.zip: ZIP_INPUTS=.
358 examples/big-bundle/otter.toml: $(LIBRARY_FILES) $(MAKEFILE_DEP)
359 rm -rf examples/big-bundle
360 mkdir examples/big-bundle examples/big-bundle/library
361 @set -e; echo 'MKDIR for $@'; \
362 for l in $(LIBRARIES); do \
363 mkdir examples/big-bundle/$$l; \
365 -e 'BEGIN { print "# -- AUTOGENERATED FROM COPY IN OTTER SOURCE --\n" }' \
366 -e 'if (m/^\[scraper]/..0) { unless (m/^\[(?!scraper)/..0) { s/^/\#/ } }' \
367 -e 's/(?<=\s)\w\S*(?=\s)/-/ if m/^files = """/..m/^"""/;' \
368 <$$l.toml >examples/big-bundle/$$l.toml; done
369 @set -e; echo 'LN for $@'; \
370 for e in $(LIBRARY_FILE_INPUTS); do \
371 ln $${e#*:} examples/big-bundle/$${e%%.usvg:*}.svg; done;
372 @set -e; echo 'MV for $@'; \
373 cd examples/big-bundle/library/; for x in '' .toml; do \
374 mv wikimedia$$x duped-example$$x; done
375 @set -e; mkdir examples/big-bundle/specs/; \
376 perl -pe <specs/demo.game.toml \
377 >examples/big-bundle/specs/Modded-spec.game.toml \
378 's/chess-b-/chess-purple-/; s/chess-w-/chess-yellow-/'
379 @set -e; echo 'ECHO for $@'; \
380 echo 'title = "Autogenerated test bundle - do not distribute"' \
384 #---------- webdriver tests (wdt) ----------
386 AT_TESTS := $(basename $(notdir $(wildcard apitest/at-*.rs)))
387 WDT_TESTS := $(basename $(notdir $(wildcard wdriver/wdt-*.rs)))
389 WDT_LANDSCAPE_TESTS = wdt-altergame
391 at: $(foreach f, $(AT_TESTS), stamp/$f.check)
393 wdt: $(foreach f, $(WDT_TESTS), stamp/$f.check) \
394 $(foreach f, $(WDT_LANDSCAPE_TESTS), stamp/$f.lcheck) \
396 RUNTEST_DEPS = apitest/run1 stamp/cargo.debug $(FILEASSETS) \
397 $(wildcard specs/*.toml) examples/test-bundle.zip \
398 $(wildcard libraries/*.toml) $(LIBRARY_FILES)
400 AT_DEPS = $(filter-out templates/script.js, $(RUNTEST_DEPS)) \
401 examples/big-bundle.zip \
404 WDT_DEPS = $(RUNTEST_DEPS) \
405 stamp/cargo-wdt.debug
407 AT_WDT_RUN = $(NAILING_CARGO_JUST_RUN) $(abspath $<)
409 AT_RUN = $(AT_WDT_RUN) apitest --test=$(basename $(notdir $@))
410 WDT_RUN = $(AT_WDT_RUN) wdriver --test=$(basename $(notdir $@))
413 stamp/at-%.check: $(AT_DEPS)
418 stamp/wdt-%.check: $(WDT_DEPS)
422 stamp/wdt-%.lcheck: $(WDT_DEPS)
423 $(WDT_RUN) --as-if=lwdt-$* --layout=Landscape
426 #---------- docs publication ----------
428 PUBLISH_USER=ianmdlvl@login.chiark.greenend.org.uk
429 PUBLISH_DOC_SPHINX=$(PUBLISH_USER):public-html/otter/docs
432 rsync -r --delete-delay docs/html/. $(PUBLISH_DOC_SPHINX)/.
433 git branch -f $(PUBLISHED_BRANCH)
435 #---------- deployment ----------
437 DEPLOY_USER=ian@login.chiark.greenend.org.uk
438 DEPLOY_BASE=$(DEPLOY_USER):/volatile/Otter
439 DEPLOY_FINISH=/home/Otter/etc/deploy-finish
441 for-deploy: stamp/cargo.deploy-build
442 deploy: for-deploy bundled-sources assets libraries
443 rsync -zv --progress $(addprefix $(DEPLOY_TARGET_DIR)/,$(PROGRAMS)) $(DEPLOY_BASE)/bin/
444 rsync -zv --progress $(TARGET_DIR)/release/usvg $(DEPLOY_BASE)/libexec/
445 rsync -rv --progress $(TARGET_DIR)/bundled-sources/. $(DEPLOY_BASE)/bundled-sources
446 rsync -r README.md $(DEPLOY_BASE)/.
447 rsync -r --delete --exclude=\*~ library specs $(DEPLOY_BASE)/.
448 rsync -r $(FILEASSETS) $(addprefix $(WASM_PACKED)/, $(WASM_ASSETS)) \
449 $(DEPLOY_BASE)/assets/
450 rsync -r nwtemplates/*.tera $(DEPLOY_BASE)/nwtemplates/
451 ssh -o BatchMode=true $(DEPLOY_USER) $(DEPLOY_FINISH)
452 git branch -f $(DEPLOYED_BRANCH)
453 -git push origin main
454 -git push chiark main
456 #$(DEPLOY_BASE)/bundled-sources
458 #---------- clean ----------
461 rm -f templates/script.js library/*/*.usvg stamp/*
462 rm -rf $(LIBRARY_CLEAN)
463 rm -rf examples/big-bundle examples/big-bundle.zip
464 rm -f examples/test-bundle.zip
465 find * \( -name '*~' -o -name '*.tmp' \) -print0 | xargs -0r rm --
467 clean: clean-nailing clean-for-retest
469 $(NAILING_CARGO_JUST_RUN) rm -rf target