1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
#![cfg_attr(docsrs, feature(doc_cfg))] // does this work? //! //! [![Latest Version]][crates.io] //! [![docs]][docs.rs] //! ![MIT] //! [![Rust](https://img.shields.io/badge/rust-1.53%2B-blue.svg?maxAge=3600)](https://github.com/ralfbiedert/interoptopus) //! [![Rust](https://github.com/ralfbiedert/interoptopus/actions/workflows/rust.yml/badge.svg?branch=master)](https://github.com/ralfbiedert/interoptopus/actions/workflows/rust.yml) //! //! # Interoptopus π //! //! The polyglot bindings generator for your library (C#, C, Python, ...) //! //! <br> //! //! Huh? //! - Imagine you are writing this cool API and want the world to have it. //! - The world, however, is running Unity, C, Python, ... all at the same time. //! - "Not a problem", you say, "I'll just use Interoptopus". //! //! And you'll live happily<sup>*</sup> ever after. //! //! <sub>*Actual results may depend on other life choices.</sub> //! //! ## Code you write ... //! //! ```rust //! use interoptopus::{ffi_function, ffi_type, inventory}; //! //! #[ffi_type] //! #[repr(C)] //! pub struct Vec2 { //! pub x: f32, //! pub y: f32, //! } //! //! #[ffi_function] //! #[no_mangle] //! pub extern "C" fn my_function(input: Vec2) { //! println!("{}", input.x); //! } //! //! inventory!(ffi_inventory, [], [my_function], []); //! //! ``` //! //! ## ... Interoptopus generates //! //! | Language | Crate | Sample Output | //! | --- | --- | --- | //! | C# (incl. Unity) | [**interoptopus_backend_csharp**](https://crates.io/crates/interoptopus_backend_csharp) | [Interop.cs](https://github.com/ralfbiedert/interoptopus/blob/master/interoptopus_backend_csharp/tests/output/Interop.cs) | //! | C | [**interoptopus_backend_c**](https://crates.io/crates/interoptopus_backend_c) | [my_header.h](https://github.com/ralfbiedert/interoptopus/blob/master/interoptopus_backend_c/tests/output/my_header.h) | //! | Python [CFFI](https://cffi.readthedocs.io/en/latest/index.html) | [**interoptopus_backend_cpython_cffi**](https://crates.io/crates/interoptopus_backend_cpython_cffi) | [reference.py](https://github.com/ralfbiedert/interoptopus/blob/master/interoptopus_backend_cpython_cffi/tests/output/reference_project.py) | //! | Your language | Write your own backend<sup>1</sup> | - | //! //! <sup>1</sup> Create your own backend in just a few hours. No pull request needed. [Pinkie promise](https://github.com/ralfbiedert/interoptopus/blob/master/FAQ.md#new-backends). //! //! ## Getting Started πΌ //! //! If you ... //! - want to **create a new API** see the [**example projects**](https://github.com/ralfbiedert/interoptopus/tree/master/examples), //! - need to **support a new language** or rewrite a backend, [**copy and adapt the C backend**](https://github.com/ralfbiedert/interoptopus/tree/master/interoptopus_backend_c). //! //! ## Features //! //! - explicit, type-safe, **single source of truth** API definition in Rust, //! - **quality-of-life [patterns](crate::patterns)** on **both sides** (e.g., [options](crate::patterns::option), [slices](crate::patterns::slice), [services](crate::patterns::service), ...) //! - **minimal on dependencies**, build time, tooling impact, //! - if your **project compiles your bindings should work**<sup>**cough**</sup> (i.e., generated and callable), //! - **extensible**, multiple backends, **easy to support new languages**, fully **customizable**, //! - **no scripts needed**, `cargo build` + `cargo test` **can produce and test** (if lang installed) generated bindings //! //! //! ## Supported Rust Constructs //! See the [**reference project**](https://github.com/ralfbiedert/interoptopus/tree/master/interoptopus_reference_project/src); it lists all supported constructs including: //! - [functions](https://github.com/ralfbiedert/interoptopus/blob/master/interoptopus_reference_project/src/functions.rs) (`extern "C"` functions and delegates) //! - [types](https://github.com/ralfbiedert/interoptopus/blob/master/interoptopus_reference_project/src/types.rs) (primitives, composite, enums (numeric only), opaques, references, pointers, ...) //! - [constants](https://github.com/ralfbiedert/interoptopus/blob/master/interoptopus_reference_project/src/constants.rs) (primitive constants; results of const evaluation) //! - [patterns](https://github.com/ralfbiedert/interoptopus/tree/master/interoptopus_reference_project/src/patterns) (ASCII pointers, options, slices, classes, ...) //! //! As a rule of thumb we recommend to be slightly conservative with your signatures and always "think C", since other languages don't track lifetimes //! well and it's is easy to accidentally pass an outlived pointer or doubly alias a `&mut X` on reentrant functions. //! //! //! ## Performance π //! //! Generated low-level bindings should be "zero cost" w.r.t. hand-crafted bindings for that language. However, even hand-crafted bindings //! have an inherent, language-specific cost. For C# that cost can be almost 0, for Python CFFI it can be high. Patterns and convenience //! helpers might add additional overhead. //! //! If you **need API design guidance** the following (wip) [**C# call-cost table**](https://github.com/ralfbiedert/interoptopus/blob/master/interoptopus_backend_csharp/benches/BENCHMARK_RESULTS.md)<sup>π₯</sup> can help. //! //! ## Current Status //! //! - June 20, 2021 - Alpha. Has generated simple working<sup>TM</sup> bindings for a few projects for a week now, many things missing. //! - June 13, 2021 - Pre-alpha. Has generated C#, C, Python-CFFI bindings at least once, many things missing, untested. //! //! //! ## FAQ //! //! - [FAQ and Safety Guides](https://github.com/ralfbiedert/interoptopus/blob/master/FAQ.md). //! //! ## Contributing //! //! PRs are welcome. //! //! - Bug fixes can be submitted directly. Major changes should be filed as issues //! first. //! //! - Anything that would make previously working bindings change behavior or stop compiling //! is a major change; which doesn't mean we're opposed to breaking stuff before 1.0, just that //! we'd like to talk about it before it happens. //! //! - New features or patterns must be materialized in the reference project and accompanied by //! an interop test (i.e., a backend test running C# / Python against a DLL invoking that code) //! in at least one included backend. //! //! [Latest Version]: https://img.shields.io/crates/v/interoptopus.svg //! [crates.io]: https://crates.io/crates/interoptopus //! [MIT]: https://img.shields.io/badge/license-MIT-blue.svg //! [docs]: https://docs.rs/interoptopus/badge.svg //! [docs.rs]: https://docs.rs/interoptopus/ pub use error::Error; #[cfg(feature = "derive")] #[cfg_attr(docsrs, doc(cfg(feature = "derive")))] // does this work? pub use interoptopus_proc::{ffi_constant, ffi_function, ffi_type}; pub use crate::core::{merge_libraries, Library}; pub use generators::Interop; mod core; mod error; mod generators; pub mod patterns; #[cfg(feature = "testing")] #[cfg_attr(docsrs, doc(cfg(feature = "testing")))] // does this work? pub mod testing; pub mod util; pub mod writer; pub mod lang { //! Abstractions for authors of backends. //! //! A a rule of thumb, types in the [`rust`](rust) module generate instances //! of types in the [`c`](c) module. //! //! Normal users of Interoptopus probably won't have to concern //! themselves with any of the items in this module. //! A notable exception to this rule is having to manually implement //! a [`CType`](`c::CType`) surrogate for un-owned types. See the //! [surrogates section in `ffi_type`](crate::ffi_type#surrogates). pub mod c; pub mod rust; } /// **The** macro to define your library, ties everything together! /// /// This macro produces an "inventory function", which can be ingested by backends. The function /// will have the signature `fn f() -> Library`, where [`Library`] represents all functions, /// types, constants and documentation exported by this crate over the FFI boundary. /// /// # Usage /// /// This macro must be invoked with exactly 4 parameters: /// /// ```ignore /// # use interoptopus::inventory_function; /// inventory_function!(symbol, consts, functions, patterns); /// ``` /// /// Where /// - `symbol` - the name of the exported inventory function producing a [`Library`], /// - `consts` - a list of [`#[ffi_constant]`](crate::ffi_constant) constants to include `[C1, C2, ...]`, /// - `functions` - a list of [`#[ffi_function]`](crate::ffi_function) functions to include `[f1, f2, ...]`, /// - `patterns` - a list of [`LibraryPattern`](crate::patterns::LibraryPattern) to include `[p1, ...]`, /// /// Any of `consts`, `functions` or `patters` can be an empty list `[]` instead. Types are always /// inferred automatically based on the used functions. /// /// # Example /// /// ```rust /// use interoptopus::{ffi_function, ffi_constant}; /// /// #[ffi_constant] /// const MY_CONSTANT: u8 = 1; /// /// #[ffi_function] /// #[no_mangle] /// pub extern "C" fn f(_x: u8) {} /// /// interoptopus::inventory!( /// my_inventory_function, /// [ MY_CONSTANT ], /// [ f ], /// [] /// ); /// ``` /// /// You can then use `my_inventory_function`, which will return a [`Library`], in a backend to /// produce bindings to your language. /// #[cfg(feature = "derive")] #[cfg_attr(docsrs, doc(cfg(feature = "derive")))] // does this work? #[macro_export] macro_rules! inventory { ( $export_function:ident, [ $( $const:path ),* ], [ $( $function:path ),* ], [ $( $pattern:path ),* ] ) => { #[doc(hidden)] pub fn $export_function() -> $crate::Library { use $crate::lang::rust::FunctionInfo; use $crate::lang::rust::ConstantInfo; let mut constants: Vec<$crate::lang::c::Constant> = Vec::new(); $( { use $const as user_constant; constants.push(user_constant::constant_info()); } )* let mut functions: Vec<$crate::lang::c::Function> = Vec::new(); $( { use $function as user_function; functions.push(user_function::function_info()); } )* let mut patterns: Vec<$crate::patterns::LibraryPattern> = Vec::new(); $( { let pattern: $crate::patterns::LibraryPattern = $pattern().into(); match &pattern { $crate::patterns::LibraryPattern::Service(class) => { functions.push(class.constructor().clone()); functions.push(class.destructor().clone()); functions.extend(class.methods().iter().cloned()); } } patterns.push(pattern); } )* $crate::Library::new(functions, constants, patterns) } }; }