interoptopus 0.16.0

The polyglot bindings generator for your library (C#, C, Python, ...). 🐙
Documentation 
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

//! Collection of all FFI items a library wants to expose.
//!
//! The main entry point is [`RustInventory`], built with a builder pattern and the
//! registration macros [`function!`](crate::function), [`service!`](crate::service), [`constant!`](crate::constant), and [`extra_type!`](crate::extra_type).
//! Types referenced by registered functions and services are discovered automatically.
//!
//! ```rust
//! use interoptopus::{ffi, function, service, constant};
//! use interoptopus::inventory::RustInventory;
//!
//! # #[ffi] pub enum MyError { General }
//! # #[ffi] pub fn foo(a: u32, b: u32) -> u32 { a + b }
//! # #[ffi] pub const MAX: u32 = 100;
//! # #[ffi(service)] pub struct Service { v: u32 }
//! # #[ffi] impl Service {
//! #     pub fn create() -> ffi::Result<Self, MyError> { ffi::Ok(Self { v: 0 }) }
//! # }
//! pub fn ffi_inventory() -> RustInventory {
//!     RustInventory::new()
//!         .register(function!(foo))
//!         .register(constant!(MAX))
//!         .register(service!(Service))
//!         .validate()
//! }
//! ```
mod id;
mod macros;
mod plugin;
mod rust;

use crate::lang::constant::Constant;
use crate::lang::function::Function;
use crate::lang::service::Service;
use crate::lang::types::Type;
use std::collections::BTreeMap;

pub use id::{ConstantId, FunctionId, Id, PluginId, ServiceId, TypeId, hash_str};
pub use plugin::PluginInventory;
pub use rust::RustInventory;

/// All registered types.
pub type Types = BTreeMap<TypeId, Type>;
/// All registered functions.
pub type Functions = BTreeMap<FunctionId, Function>;
/// All registered constants.
pub type Constants = BTreeMap<ConstantId, Constant>;
/// All registered services.
pub type Services = BTreeMap<ServiceId, Service>;

/// Trait implemented by inventory types that can accept FFI item registrations.
///
/// You typically don't need to use this directly — the registration macros
/// ([`function`](crate::function!), [`service`](crate::service!), etc.) call these methods for you.
pub trait Inventory {
    /// Register a type.
    fn register_type(&mut self, id: TypeId, ty: Type);
    /// Register a function.
    fn register_function(&mut self, id: FunctionId, function: Function);
    /// Register a constant.
    fn register_constant(&mut self, id: ConstantId, constant: Constant);
    /// Register a service.
    fn register_service(&mut self, id: ServiceId, service: Service);
    /// Register an item via a closure produced by a registration macro.
    fn register(&mut self, f: impl Fn(&mut Self)) -> &mut Self;
}