Add your description here
Project description
WAQ - WebAssembly to QBE Compiler
WAQ is an ahead-of-time (AOT) compiler that translates WebAssembly binary modules into native machine code using QBE as the backend.
Features
- WASM Binary Parsing: Parse WebAssembly binary modules
- Stack-to-SSA Translation: Convert WebAssembly's stack-based model to QBE's SSA form
- Control Flow Conversion: Transform structured control flow (blocks, loops, ifs) to basic blocks and jumps
- Type Mapping: Map WASM types (i32, i64, f32, f64) to QBE types (w, l, s, d)
- QBE Backend: Generate QBE intermediate language code
Installation
# Clone the repository
# (not yet) git clone https://github.com/abilian/waq.git
git clone https://git.sr.ht/~sfermigier/waq
cd waq
# Install dependencies using uv
uv sync
Usage
Basic Compilation
# Compile a WASM file to QBE IL
waq input.wasm -o output.qbe
# Run tests
make test
# Run specific test types
uv run pytest -m unit # Unit tests only
uv run pytest -m integration # Integration tests only
uv run pytest -m e2e # End-to-end tests only
Development Commands
# Format code
make format
# Lint and type check
make lint
# Run with coverage
make test-cov
# Multi-version testing via nox
nox -s tests # Run tests on all Python versions
nox -s check # Run linting/type checking
Project Structure
waq/
├── src/
│ └── waq/ # Main source code
│ ├── compiler/ # Compilation logic
│ ├── parser/ # WASM binary parsing
│ ├── runtime/ # Runtime support
│ └── cli.py # Command-line interface
├── tests/ # Test suite
│ ├── a_unit/ # Unit tests
│ ├── b_integration/ # Integration tests
│ └── c_e2e/ # End-to-end tests
├── notes/ # Technical notes (no documentation yet)
└── runtime/ # Runtime components
Testing
The project follows a pyramid testing structure:
- Unit Tests: Fast, isolated tests in
tests/a_unit/ - Integration Tests: Component interaction tests in
tests/b_integration/ - End-to-end Tests: Full workflow tests in
tests/c_e2e/
Code Style
- Targets Python 3.12+
- Uses Ruff with ALL rules enabled
- Multiple type checkers: ty, pyrefly, mypy
- All files must have
from __future__ import annotations
License
[Specify your license here - e.g., MIT, Apache 2.0, etc.]
Contributing
See CONTRIBUTING.md for contribution guidelines.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
waq-0.1.1.tar.gz
(32.1 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
waq-0.1.1-py3-none-any.whl
(44.0 kB
view details)
File details
Details for the file waq-0.1.1.tar.gz.
File metadata
- Download URL: waq-0.1.1.tar.gz
- Upload date:
- Size: 32.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.9.26 {"installer":{"name":"uv","version":"0.9.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
eea04f0e7a1900ae3790e05c957bd6f31c78aad099b32460bfde3c1d49ef6c15
|
|
| MD5 |
d149cea5e1e195945abdd3d092a93b95
|
|
| BLAKE2b-256 |
25424e278b3a4da968ad2e16534905f5b5bb1645d1ece089c7dddf492a5a3597
|
File details
Details for the file waq-0.1.1-py3-none-any.whl.
File metadata
- Download URL: waq-0.1.1-py3-none-any.whl
- Upload date:
- Size: 44.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.9.26 {"installer":{"name":"uv","version":"0.9.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e30706cf49c539ea563744792c6fe7e6ea9f72c939bdec49eaf5c566053f3d97
|
|
| MD5 |
6cd056f582e261ad594f31d733d9efa6
|
|
| BLAKE2b-256 |
c78526cfb523dde5b84f1d5a7ad0e045b0e5182cbac566de57c15ac46b789b2d
|