Makefile

PREFIX ?= /usr/local
BINDIR = $(PREFIX)/bin
SHAREDIR = $(PREFIX)/share/openbox
ICONDIR = $(PREFIX)/share/icons/hicolor/scalable/apps
DESKTOPDIR = $(PREFIX)/share/applications
METAINFODIR = $(PREFIX)/share/metainfo
LICENSEDIR = $(PREFIX)/share/licenses/openbox

PYTHON_SOURCES = $(shell sed '/^[[:space:]]*#/d;/^[[:space:]]*$$/d' runtime_modules.txt)

# Interpreter for the dev-only contract/ratchet targets. Overridable so the
# same Makefile works on Windows, where `python3` is a Store alias (ADR 0048).
PYTHON ?= python3


DATA_FILES = index.html openbox.svg openbox.metainfo.xml LICENSE assets/openbox-logo.png assets/placeholder-cover.svg assets/mame/scanlines.png assets/shaders/scanlines.slangp
STATIC_FILES = $(wildcard static/*.js) $(wildcard static/*.css) $(wildcard static/*.svg)
LOCALE_FILES = $(wildcard locales/*.json)
NATIVE_HOST = native_host

.PHONY: install uninstall appimage check version-check dev-venv test-one native-host native-host-macos macos-app contracts ratchets

# Feature-regression ratchets (ADR 0060). Regenerates the frozen contracts in
# scripts/contracts/ after an intentional surface change. Run this only when a
# removal is deliberate; the gate then diffs the result against git.
contracts:
	$(PYTHON) -B scripts/check_routes_contract.py --update
	$(PYTHON) -B scripts/check_settings_contract.py --update
	$(PYTHON) -B scripts/check_emulator_defs.py --update
	$(PYTHON) -B scripts/check_frontend_modules.py --update
	$(PYTHON) -B scripts/check_reliability_catalog.py --update
	$(PYTHON) -B scripts/check_state_schema.py --update
	$(PYTHON) -B scripts/check_api_contract.py --update
	@echo "Contracts regenerated. Review the diff, then commit it with the change."

# Run only the feature-regression ratchets, without the coverage stage.
ratchets:
	$(PYTHON) -B scripts/check_routes_contract.py
	$(PYTHON) -B scripts/check_settings_contract.py
	$(PYTHON) -B scripts/check_emulator_defs.py
	$(PYTHON) -B scripts/check_frontend_modules.py
	$(PYTHON) -B scripts/check_reliability_catalog.py
	$(PYTHON) -B scripts/check_clock_coupling.py
	$(PYTHON) -B scripts/check_exec_modes.py
	$(PYTHON) -B scripts/check_state_schema.py
	$(PYTHON) -B scripts/check_api_contract.py
	$(PYTHON) -B scripts/check_backup_format.py
	$(PYTHON) -B scripts/check_deprecations.py
	$(PYTHON) -B scripts/check_api_paths.py


native-host:
	gcc -O2 native_host.c -o $(NATIVE_HOST) $$(pkg-config --cflags --libs webkit2gtk-4.1)

# The macOS native host (WKWebView) and the app bundle that ships it.
native-host-macos:
	bash scripts/build_native_host_macos.sh

macos-app:
	bash scripts/build_macos_app.sh

dev-venv:
	python3 -m venv .venv-dev
	.venv-dev/bin/pip install --disable-pip-version-check -r requirements-dev.txt

# Full verification gate: ruff, runtime_modules, dependencies, api_contract,
# version_sync, frontend, i18n, csp, contract ratchets, py_compile, tests under
# coverage, coverage floors (total + web_app + changed-line + new-module), tokens.
# Dev-only dependencies live in .venv-dev; the runtime app stays dep-free.
check: dev-venv
	python3 scripts/check_tests.py

# A single test file, e.g. `make test-one TEST=tests/test_saves.py`.
test-one:
	python3 -B $(TEST)

# Fails when the version in updates.py disagrees with any published spot.
version-check:
	python3 scripts/check_version_sync.py

install: native-host
	install -d $(DESTDIR)$(BINDIR)
	install -d $(DESTDIR)$(SHAREDIR)
	install -d $(DESTDIR)$(SHAREDIR)/themes
	install -d $(DESTDIR)$(ICONDIR)
	install -Dm755 openbox.sh $(DESTDIR)$(BINDIR)/openbox
	install -Dm755 openbox-native.sh $(DESTDIR)$(BINDIR)/openbox-native
	install -d $(DESTDIR)$(DESKTOPDIR)
	install -d $(DESTDIR)$(METAINFODIR)
	install -d $(DESTDIR)$(LICENSEDIR)
	install -Dm755 $(NATIVE_HOST) $(DESTDIR)$(SHAREDIR)/$(NATIVE_HOST)
	install -d $(DESTDIR)$(SHAREDIR)/emulator_defs
	for f in emulator_defs/*.yaml; do install -Dm644 "$$f" "$(DESTDIR)$(SHAREDIR)/emulator_defs/"; done
	install -Dm755 scripts/openbox-launcher.sh $(DESTDIR)$(SHAREDIR)/openbox-launcher.sh
	# Runtime Python modules (web_app.py, the handlers/ package, parity_*.py,
	# ...) from runtime_modules.txt, mirroring the repo layout under the share
	# dir. `install -D` creates the handlers/ subdirectory as needed.
	for f in $(PYTHON_SOURCES); do install -Dm644 "$$f" "$(DESTDIR)$(SHAREDIR)/$$f"; done
	# plugin_catalog.py resolves plugins/catalog.json relative to its own path.
	install -Dm644 plugins/catalog.json $(DESTDIR)$(SHAREDIR)/plugins/catalog.json
	for f in $(DATA_FILES); do install -Dm644 "$$f" "$(DESTDIR)$(SHAREDIR)/$$f"; done
	for f in $(STATIC_FILES); do install -Dm644 "$$f" "$(DESTDIR)$(SHAREDIR)/$$f"; done
	for f in $(LOCALE_FILES); do install -Dm644 "$$f" "$(DESTDIR)$(SHAREDIR)/$$f"; done
	for f in themes/*.css; do install -Dm644 "$$f" "$(DESTDIR)$(SHAREDIR)/$$f"; done
	install -Dm644 openbox.desktop $(DESTDIR)$(DESKTOPDIR)/io.openbox.GameLauncher.desktop
	install -Dm644 openbox.svg $(DESTDIR)$(ICONDIR)/io.openbox.GameLauncher.svg
	install -Dm644 openbox.metainfo.xml $(DESTDIR)$(METAINFODIR)/io.openbox.GameLauncher.metainfo.xml
	install -Dm644 LICENSE $(DESTDIR)$(LICENSEDIR)/LICENSE

uninstall:
	rm -f $(DESTDIR)$(BINDIR)/openbox
	rm -f $(DESTDIR)$(BINDIR)/openbox-native
	rm -rf $(DESTDIR)$(SHAREDIR)
	rm -f $(DESTDIR)$(ICONDIR)/io.openbox.GameLauncher.svg
	rm -f $(DESTDIR)$(DESKTOPDIR)/io.openbox.GameLauncher.desktop
	rm -f $(DESTDIR)$(METAINFODIR)/io.openbox.GameLauncher.metainfo.xml
	rm -rf $(DESTDIR)$(LICENSEDIR)

appimage:
	bash build_appimage.sh