https://github.com/mthh/sfcgal-sys

SFCGAL low-level FFI bindings for Rust
https://github.com/mthh/sfcgal-sys

rust-ffi-bindings rust-library

Last synced: 22 days ago
JSON representation

SFCGAL low-level FFI bindings for Rust

• Host: GitHub
• URL: https://github.com/mthh/sfcgal-sys
• Owner: mthh
• License: apache-2.0
• Created: 2019-02-05T15:57:40.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-04-20T19:01:59.000Z (7 months ago)
• Last Synced: 2024-10-05T16:08:22.158Z (about 1 month ago)
• Topics: rust-ffi-bindings, rust-library
• Language: Rust
• Homepage: https://crates.io/crates/sfcgal-sys
• Size: 1.11 MB
• Stars: 2
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
# sfcgal-sys

[![Build](https://github.com/mthh/sfcgal-sys/actions/workflows/test.yml/badge.svg)](https://github.com/mthh/sfcgal-sys/actions/workflows/test.yml)

[![Crates.io](https://img.shields.io/crates/v/sfcgal-sys.svg)](https://crates.io/crates/sfcgal-sys)

[![Documentation](https://img.shields.io/badge/documentation-0.7.0-green)](https://mthh.github.io/sfcgal-sys/sfcgal_sys/)

Rust low-level FFI bindings to [`SFCGAL`](https://sfcgal.gitlab.io/SFCGAL/) 1.5.x C API.  

Don't use this crate directly, prefer it's higher-level wrapper : [sfcgal-rs](https://github.com/mthh/sfcgal-rs).

> [!IMPORTANT]

> Note that the required version of SFCGAL is currently 1.5.x (latest version - 2023-10-30).  

> If you want to use SFCCAL 1.4.x, you can use the 0.6.x version of this crate / of [sfcgal-rs](https://github.com/mthh/sfcgal-rs).

## Internals

This crate contains a few lines of C code (compiled as a static library with `cc` crate) wrapping SFCGAL C API in order to replace the error and warning handlers (which use `printf` by default).  

It expects SFCGAL to be installed as a system library and that you have the header file for it's C API.

Then bindgen is run to generate these low-levels bindings.

In addition to all the `sfcgal_` types and functions, this crate expose :

- a Rust `initialize` function: it calls `sfcgal_init()` function then it calls a custom `w_sfcgal_init_handlers()` function which replace the error and warning handlers from `printf` to a char buffer. That `initialize` function internally uses `std::sync::Once` to ensure it's only called once.

- two C functions `w_sfcgal_get_last_error` and `w_sfcgal_get_last_warning` which repectively reads the buffer containing the error message and the buffer containing the warning message.

In the future it could probably be improved by not requiring SFCGAL to be installed as a system library.

## License

Licensed under either of

 * Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)

 * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

at your option.

### Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted

for inclusion in the work by you shall be dual licensed as above, without any

additional terms or conditions.