Benedikt Peetz
50c9d45cb7
|
||
|---|---|---|
| docs | ||
| example/main | ||
| scripts | ||
| src | ||
| tests | ||
| .envrc | ||
| .gitignore | ||
| .licensure.yml | ||
| COPYING | ||
| COPYING.LESSER | ||
| Cargo.lock | ||
| Cargo.toml | ||
| LICENSE.spdx | ||
| NEWS.md | ||
| README.md | ||
| cog.toml | ||
| flake.lock | ||
| flake.nix | ||
| update.sh | ||
README.md
Trixy
A crate to generate a multi-language foreign function interface.
Features
- Support for custom types, derived from a set of primitive types.
- Support for callbacks, thought c function pointers.
- Support for error handling, when checking a functions arguments (NULL pointer and such things).
Supported languages:
- c
Dependencies
Trixy only needs:
clang-formatto format the generated c header files.
The Trixy Language
The API to generate is specified in a Trixy file. The language of these files is an subset of rust and should thus be easy to learn and pick up.
A grammar file is provided here encoded in Extended Backus-Naur Form.
The grammar file is rendered as railroad diagrams in PDF here, run ./docs/generate_docs to regenerate the PDF file.
Testing
Trixy contains integration tests in the ./tests directory. These are maintained with the
./scripts/tests.sh script. Take a look at it's --help output for further usage
information.
This crate also contains a binary, which can help with manual testing and inspecting of the
generated AST. The cargo run --features 'build-binary' -- --help output should provide
all required information.
Tests are (as of now) only positive, i.e. they can only test successful situations. Failing test will probably be supported in the future.
Contributing
We have a nix flake, which provides the required dependencies to work with Trixy and the associated scripts in the ./scripts directory.
Please also make sure to run the ./scripts/renew_copyright_header.sh after you added a new file, to ensure that every file contains a license header.