Makefile

MAKEFLAGS += --no-builtin-rules
MAKEFLAGS += --no-builtin-variables

# use a default prefix for coverage data files
COVERAGE_FILE ?= .coverage

# allow overriding the name of the venv directory
VENV_DIR ?= .venv

# use activated venv if any
export UV_PROJECT_ENVIRONMENT=$(if $(VIRTUAL_ENV),$(VIRTUAL_ENV),$(VENV_DIR))

# allow overriding which extras are installed
VENV_EXTRAS ?= --all-extras
VENV_GROUPS ?= --all-groups


# default lit options
LIT_OPTIONS ?= -v --order=smart
PYTEST_OPTIONS ?= -vv
# quiet options for tests-quiet (minimal terminal output)
LIT_OPTIONS_QUIET ?= -q --order=smart
PYTEST_OPTIONS_QUIET ?= -q --tb=no

# make tasks run all commands in a single shell
.ONESHELL:

define print_help
	@C="\033[$${1}32m"; R='\033[0m'; \
	 printf "%b" "Usage: make $${C}<target>$${R}\n\n"; \
	 printf "Available targets:\n"; \
	 grep -E '^[a-zA-Z_-]+:.*?##' $(MAKEFILE_LIST) | \
	   sort | \
	   awk "BEGIN {FS = \":.*?## \"}; {printf \"  $${C}%-$(2)s$${R} %s\n\", \$$1, \$$2}"
endef

HELP_COLOR := 1;32 # bright green
HELP_COLUMN_WIDTH := 25

.DEFAULT_GOAL := help

.PHONY: help
help: ## show this help message
	$(call print_help,$(HELP_COLOR),$(HELP_COLUMN_WIDTH))

.PHONY: uv-installed
uv-installed:
	@command -v uv &> /dev/null ||\
		(echo "UV doesn't seem to be installed, try the following instructions:" &&\
		echo "https://docs.astral.sh/uv/getting-started/installation/" && false)

# set up the venv with all dependencies for development
.PHONY: ${VENV_DIR}/
${VENV_DIR}/: uv-installed
	uv sync ${VENV_EXTRAS} ${VENV_GROUPS}
	@if [ ! -z "$(XDSL_MLIR_OPT_PATH)" ]; then \
		ln -sf $(XDSL_MLIR_OPT_PATH) ${VENV_DIR}/bin/mlir-opt; \
	fi

.PHONY: venv
venv: ${VENV_DIR}/ ## make sure `make venv` also works correctly

.PHONY: clean-caches
clean-caches: coverage-clean asv-clean ## remove all caches
	rm -rf .pytest_cache *.egg-info


.PHONY: clean
clean: clean-caches ## remove all caches and the venv
	rm -rf ${VENV_DIR}

.PHONY: filecheck
filecheck: uv-installed ## run filecheck tests
	uv run lit $(LIT_OPTIONS) tests/filecheck

.PHONY: pytest
pytest: uv-installed ## run pytest tests on tests and marimo (paths specified in pyproject.toml)
	uv run pytest -W error $(PYTEST_OPTIONS)

.PHONY: filecheck-toy
filecheck-toy: uv-installed ## run tests for Toy tutorial
	uv run lit $(LIT_OPTIONS) docs/Toy/examples

.PHONY: pytest-toy-nb
pytest-toy-nb:
	@if uv run python -c "import riscemu" > /dev/null 2>&1; then \
		uv run pytest -W error --nbval $(PYTEST_OPTIONS) docs/Toy --nbval-current-env; \
	else \
		echo "riscemu is not installed, skipping tests."; \
	fi

.PHONY: tests-toy
tests-toy: filecheck-toy pytest-toy-nb


.PHONY: tests-marimo
tests-marimo: uv-installed
	@bash -c '\
		error_log="/tmp/marimo_test_$$$$.log"; \
		failed_tests=""; \
		files_requiring_mlir_opt=("docs/marimo/mlir_interoperation.py"); \
		for file in docs/marimo/*.py; do \
			if [[ " $${files_requiring_mlir_opt[@]} " =~ " $$file " ]]; then \
				if ! command -v mlir-opt &> /dev/null; then \
					echo "Skipping $$file (mlir-opt is not available)"; \
					continue; \
			  fi; \
			fi; \
			echo "Running $$file"; \
			if ! output=$$(uv run python -W error "$$file" 2>&1); then \
				echo "$$output" >> "$$error_log"; \
				failed_tests="$$failed_tests $$file"; \
			fi; \
		done; \
		if [ ! -z "$$failed_tests" ]; then \
			cat "$$error_log"; \
			echo -e "\n\nThe following marimo tests failed: $$failed_tests"; \
			rm -f "$$error_log"; \
			exit 1; \
		else \
			rm -f "$$error_log"; \
			echo -e "\n\nAll marimo tests passed successfully."; \
		fi'

.PHONY: tests-functional
tests-functional: pytest tests-toy filecheck tests-marimo ## run functional tests
	@echo All functional tests done.

.PHONY: tests-quiet
tests-quiet: uv-installed ## run functional tests with minimal output
	$(MAKE) tests-functional LIT_OPTIONS="$(LIT_OPTIONS_QUIET)" PYTEST_OPTIONS="$(PYTEST_OPTIONS_QUIET)"

.PHONY: tests
tests: tests-functional pyright ## run all tests
	@echo All tests done.


.PHONY: rerun-notebooks
rerun-notebooks: uv-installed ## re-generate the output from all jupyter notebooks in the docs directory
	uv run jupyter nbconvert \
		--ClearMetadataPreprocessor.enabled=True \
		--inplace \
		--to notebook \
		--execute docs/*.ipynb docs/Toy/*.ipynb

.PHONY: precommit-install
precommit-install: uv-installed ## set up all precommit hooks
	uv run prek install

.PHONY: precommit
precommit: uv-installed ## run all precommit hooks and apply them
	uv run prek run --all-files

.PHONY: pyright
pyright: uv-installed ## run pyright on all files in the current git commit, make sure to generate the python typing stubs before running pyright
	uv run xdsl-stubgen
	uv run pyright $(shell git diff --staged --name-only  -- '*.py')

.PHONY: coverage
coverage: coverage-tests coverage-filecheck-tests ## run coverage over all tests and combine data files
	uv run coverage combine --append

.PHONY: coverage-tests
coverage-tests: uv-installed ## use different coverage data file per coverage run, otherwise combine complains
	COVERAGE_FILE="${COVERAGE_FILE}.$@" uv run pytest -W error --cov

.PHONY: coverage-filecheck-tests
coverage-filecheck-tests: uv-installed ## run coverage over filecheck tests
	uv run lit $(LIT_OPTIONS) tests/filecheck/ -DCOVERAGE

.PHONY: coverage-report-html
coverage-report-html: uv-installed ## generate html coverage report
	uv run coverage html

.PHONY: coverage-report
coverage-report: uv-installed ## generate coverage report
	uv run coverage report

.PHONY: coverage-clean
coverage-clean: uv-installed
	uv run coverage erase

.PHONY: asv
asv: uv-installed ## generate asv benchmark regression website
	uv run asv run

.PHONY: asv-html
asv-html: uv-installed
	uv run asv publish

.PHONY: asv-preview
asv-preview: uv-installed .asv/html
	uv run asv preview

.PHONY: asv-clean
asv-clean:
	rm -rf .asv/

# docs

# Set to 1 to skip the generation of "API Reference".
SKIP_GEN_PAGES ?= 0
# Set to 1 to skip the building of xDSL wheel
SKIP_BUILD_WHEEL ?= 0


.PHONY: docs-serve
docs-serve: uv-installed
	uv run mkdocs serve

.PHONY: docs-serve-fast
docs-serve-fast: uv-installed
	SKIP_GEN_PAGES=1 uv run mkdocs serve

.PHONY: docs-build
docs-build: uv-installed
	uv run mkdocs build