trinitrix
/
trixy
Archived
5
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
This repository has been archived on 2024-05-26. You can view files and clone it, but cannot push or open issues or pull requests.
112 Commits 2 Branches 2 Tags 2.2 MiB
Rust 87.7%
C 7.2%
Shell 3.1%
Nix 1.6%
Makefile 0.4%
Go to file
Benedikt Peetz cc788a9493
chore(Cargo.toml): Add required metadata 		2024-05-20 15:33:32 +02:00
docs fix(docs/generate_docs): Cd into the correct directory to make ebnf2pdf work 2024-03-27 10:21:50 +01:00
example/main fix(example/main): Ignore generated `api.rs` debugging file 2024-05-20 15:33:22 +02:00
scripts fix(scripts/renew_copyright_header): Set correct template line lenght 2024-03-26 21:12:40 +01:00
src fix(generate/convert/host/rust/derive/structure): Ignore `ptr` arg on todo 2024-03-27 22:36:24 +01:00
tests test(types): Update to represent a minimal change in the library 2024-05-20 15:33:30 +02:00
.envrc build(.envrc): Add `./target/debug` to PATH 2024-03-27 08:11:44 +01:00
.gitignore chore(treewide): Update license header 2024-03-26 20:11:23 +01:00
.licensure.yml chore(treewide): Update license header 2024-03-26 20:11:23 +01:00
COPYING build(treewide): Add relevant configuration for releases 2023-12-23 18:35:38 +01:00
COPYING.LESSER build(treewide): Add relevant configuration for releases 2023-12-23 18:35:38 +01:00
Cargo.toml chore(Cargo.toml): Add required metadata 2024-05-20 15:33:32 +02:00
LICENSE.spdx build(treewide): Add relevant configuration for releases 2023-12-23 18:35:38 +01:00
README.md docs(README): Mention the binary 2024-05-20 15:33:32 +02:00
cog.toml chore(treewide): Update license header 2024-03-26 20:11:23 +01:00
flake.lock build(flake): Update 2024-03-26 19:58:17 +01:00
flake.nix chore(treewide): Update license header 2024-03-26 20:11:23 +01:00
update.sh style(treewide): Format 2024-03-27 22:36:19 +01:00

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-format to 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.