Lib.rs

为 Interoptopus 生成 C 绑定。

用法

假设您已经编写了一个包含 FFI 逻辑的 crate，称为 example_library_ffi，并希望生成 C 绑定，请按照以下说明操作。

在您的库中

向您编写的库添加 Interoptopus 属性，并定义一个列出所有要导出符号的清单函数。所有支持的结构的概述可以在 参考项目 中找到。

use interoptopus::{ffi_function, ffi_type, Inventory, InventoryBuilder, function};

#[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) -> Vec2 {
    input
}

pub fn my_inventory() -> Inventory {
    InventoryBuilder::new()
        .register(function!(my_function))
        .inventory()
}

将这些添加到您的 Cargo.toml 中，以便可以找到属性和绑定生成器（将 ... 替换为最新版本）

[lib]
crate-type = ["cdylib", "rlib"]

[dependencies]
interoptopus = "..."
interoptopus_backend_c = "..."

在 tests/bindings.rs 中创建一个单元测试，该测试将在使用 cargo test 运行时生成您的绑定。在实际项目中，您可能希望将此代码添加到另一个 crate 中

use interoptopus::util::NamespaceMappings;
use interoptopus::{Error, Interop};

#[test]
fn bindings_c() -> Result<(), Error> {
    use interoptopus_backend_c::{Config, Generator};

    Generator::new(
        Config {
            ifndef: "example_library".to_string(),
            ..Config::default()
        },
        example_library_ffi::my_inventory(),
    ).write_file("bindings/c/example_complex.h")?;

    Ok(())
}

现在运行 cargo test。

如果您有任何不清楚的地方，可以在 GitHub 上的示例 中找到。

生成的输出

以下输出可能是后端可能生成的。如果您想自定义某些内容，请查看 Config 结构体。如果您真的不喜欢某些内容的生成方式，可以轻松地 创建自己的。

// Automatically generated by Interoptopus.

#ifndef example_library
#define example_library

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#include <stdbool.h>

typedef struct vec2
    {
    float x
    float y;
    } vec2;


vec2 my_function(vec2 input);

#ifdef __cplusplus
}
#endif

#endif /* example_library */