Makefile

# PyCOOLC Makefile
# A COOL to MIPS compiler written in Python

.PHONY: help venv install clean clean-venv clean-all
.PHONY: test unit-tests integration-test test-coverage
.PHONY: lint format typecheck check ci
.PHONY: examples run-hello
.PHONY: build publish publish-test

# Default target
.DEFAULT_GOAL := help

# Python and virtual environment
PYTHON := python3
VENV := .venv
VENV_BIN := $(VENV)/bin
PIP := $(VENV_BIN)/pip
PYTEST := $(VENV_BIN)/pytest
PYCOOLC := $(VENV_BIN)/pycoolc
RUFF := $(VENV_BIN)/ruff
MYPY := $(VENV_BIN)/mypy

# Colors for output
CYAN := \033[36m
GREEN := \033[32m
YELLOW := \033[33m
RED := \033[31m
RESET := \033[0m

##@ General

help: ## Display this help message
	@echo "$(CYAN)PyCOOLC$(RESET) - COOL to MIPS Compiler"
	@echo ""
	@echo "$(YELLOW)Usage:$(RESET)"
	@echo "  make $(GREEN)<target>$(RESET)"
	@echo ""
	@awk 'BEGIN {FS = ":.*##"; printf ""} \
		/^[a-zA-Z_-]+:.*?##/ { printf "  $(GREEN)%-20s$(RESET) %s\n", $$1, $$2 } \
		/^##@/ { printf "\n$(YELLOW)%s$(RESET)\n", substr($$0, 5) }' $(MAKEFILE_LIST)

##@ Development

venv: ## Create virtual environment
	@echo "$(CYAN)Creating virtual environment...$(RESET)"
	$(PYTHON) -m venv $(VENV)
	$(PIP) install --upgrade pip
	$(PIP) install -e ".[dev]"
	@echo "$(GREEN)Done!$(RESET) Activate with: source $(VENV)/bin/activate"

install: ## Install package in development mode
	@echo "$(CYAN)Installing package...$(RESET)"
	$(PIP) install -e ".[dev]"

##@ Code Quality

lint: ## Run linter (ruff)
	@echo "$(CYAN)Running linter...$(RESET)"
	$(RUFF) check pycoolc/ tests/

format: ## Format code (ruff)
	@echo "$(CYAN)Formatting code...$(RESET)"
	$(RUFF) format pycoolc/ tests/
	$(RUFF) check --fix pycoolc/ tests/

format-check: ## Check code formatting without changes
	@echo "$(CYAN)Checking code format...$(RESET)"
	$(RUFF) format --check pycoolc/ tests/

typecheck: ## Run type checker (mypy)
	@echo "$(CYAN)Running type checker...$(RESET)"
	$(MYPY) pycoolc/

check: lint format-check typecheck ## Run all code quality checks

##@ Testing

unit-tests: ## Run unit tests
	@echo "$(CYAN)Running unit tests...$(RESET)"
	$(PYTEST) tests/ -v --tb=short

integration-test: ## Run integration tests with SPIM
	@echo "$(CYAN)Running integration tests...$(RESET)"
	@./bin/integration-test

test: unit-tests integration-test ## Run all tests (unit + integration)

test-coverage: ## Generate code coverage report
	@echo "$(CYAN)Generating code coverage report...$(RESET)"
	$(PYTEST) --cov=pycoolc --cov-report=term-missing --cov-report=html tests/
	@echo "$(GREEN)HTML report: htmlcov/index.html$(RESET)"

##@ CI

ci: check unit-tests ## Run full CI pipeline (lint, format, typecheck, tests)

all: build format check test examples run-hello ## Runs clean, format, build, check, test, examples, run-hello targets

##@ Examples

examples: ## Compile all example programs
	@echo "$(CYAN)Compiling example programs...$(RESET)"
	@for f in examples/*.cl; do \
		echo "  Compiling $$f..."; \
		$(PYCOOLC) "$$f" -o "$${f%.cl}.s" 2>&1 || echo "    $(YELLOW)Warning: $$f failed$(RESET)"; \
	done
	@echo "$(GREEN)Done!$(RESET)"

run-hello: ## Compile and run hello_world.cl
	@echo "$(CYAN)Compiling hello_world.cl...$(RESET)"
	$(PYCOOLC) examples/hello_world.cl -o examples/hello_world.s
	@echo "$(CYAN)Running with SPIM...$(RESET)"
	@if command -v spim >/dev/null 2>&1; then \
		spim -file examples/hello_world.s; \
	elif [ -f /Applications/QtSpim.app/Contents/MacOS/QtSpim ]; then \
		echo "Use QtSpim GUI to run examples/hello_world.s"; \
	else \
		echo "$(YELLOW)SPIM not found. Install from https://sourceforge.net/projects/spimsimulator/$(RESET)"; \
	fi

##@ Build & Publish

build: clean ## Build distribution packages
	@echo "$(CYAN)Building distribution packages...$(RESET)"
	$(VENV_BIN)/python -m build
	@echo "$(GREEN)Done! Packages in dist/$(RESET)"

publish-test: build ## Upload to TestPyPI
	@echo "$(CYAN)Uploading to TestPyPI...$(RESET)"
	$(VENV_BIN)/python -m twine upload --repository testpypi dist/*

publish: build ## Upload to PyPI (use with caution!)
	@echo "$(RED)WARNING: This will publish to the real PyPI!$(RESET)"
	@read -p "Are you sure? [y/N] " confirm && [ "$$confirm" = "y" ]
	$(VENV_BIN)/python -m twine upload dist/*

##@ Cleanup

clean: ## Clean build artifacts and caches
	@echo "$(CYAN)Cleaning...$(RESET)"
	rm -rf build/ dist/ *.egg-info/
	rm -rf .pytest_cache/ .mypy_cache/ .ruff_cache/
	rm -rf __pycache__/ pycoolc/__pycache__/ pycoolc/**/__pycache__/
	rm -rf tests/__pycache__/ tests/**/__pycache__/
	rm -rf htmlcov/ .coverage
	rm -f parser.out parsetab.py
	find examples -name '*.s' ! -name 'hello_world.s' -delete
	@echo "$(GREEN)Done!$(RESET)"

clean-venv: ## Remove the virtual environment
	rm -rf $(VENV)

clean-all: clean clean-venv ## Clean everything including venv