sh-layer4 1.0.2

Continuum Layer 4: Integration
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
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

//! Stable ABI for Plugin Interface
//!
//! Uses abi_stable to provide a stable ABI across Rust versions.

use abi_stable::std_types::RString;
use abi_stable::StableAbi;
use serde::{Deserialize, Serialize};

/// Plugin metadata with stable ABI
#[repr(C)]
#[derive(Debug, Clone, StableAbi, Serialize, Deserialize)]
pub struct StablePluginMeta {
    pub name: RString,
    pub version: RString,
    pub author: RString,
    pub description: RString,
}

impl Default for StablePluginMeta {
    fn default() -> Self {
        Self {
            name: RString::from("unknown"),
            version: RString::from("0.1.0"),
            author: RString::from("unknown"),
            description: RString::new(),
        }
    }
}

impl From<super::PluginMeta> for StablePluginMeta {
    fn from(meta: super::PluginMeta) -> Self {
        Self {
            name: RString::from(meta.name),
            version: RString::from(meta.version),
            author: RString::from(meta.author),
            description: RString::from(meta.description),
        }
    }
}

impl From<StablePluginMeta> for super::PluginMeta {
    fn from(meta: StablePluginMeta) -> Self {
        Self {
            name: meta.name.into_string(),
            version: meta.version.into_string(),
            author: meta.author.into_string(),
            description: meta.description.into_string(),
            ..Default::default()
        }
    }
}

/// Plugin entry point (exported by plugin)
#[repr(C)]
pub struct PluginEntryPoint {
    /// Create plugin instance
    pub create: extern "C" fn() -> *mut std::ffi::c_void,
    /// Destroy plugin instance
    pub destroy: extern "C" fn(*mut std::ffi::c_void),
    /// Get plugin metadata
    pub meta: extern "C" fn() -> StablePluginMeta,
}

/// Macro for creating stable ABI plugin exports
#[macro_export]
macro_rules! declare_stable_plugin {
    ($plugin_type:ty, $name:expr, $version:expr) => {
        static mut PLUGIN_INSTANCE: Option<Box<$plugin_type>> = None;

        #[no_mangle]
        pub extern "C" fn plugin_create() -> *mut std::ffi::c_void {
            unsafe {
                PLUGIN_INSTANCE = Some(Box::new(<$plugin_type>::default()));
                PLUGIN_INSTANCE.as_mut().unwrap().as_mut() as *mut _ as *mut std::ffi::c_void
            }
        }

        #[no_mangle]
        pub extern "C" fn plugin_destroy(_ptr: *mut std::ffi::c_void) {
            unsafe {
                PLUGIN_INSTANCE = None;
            }
        }

        #[no_mangle]
        pub extern "C" fn plugin_meta() -> $crate::plugin_loader::abi::StablePluginMeta {
            $crate::plugin_loader::abi::StablePluginMeta {
                name: abi_stable::std_types::RString::from($name),
                version: abi_stable::std_types::RString::from($version),
                ..Default::default()
            }
        }
    };
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_stable_plugin_meta_default() {
        let meta = StablePluginMeta::default();
        assert_eq!(meta.name.as_str(), "unknown");
        assert_eq!(meta.version.as_str(), "0.1.0");
    }

    #[test]
    fn test_stable_plugin_meta_conversion() {
        let original = super::super::PluginMeta {
            name: "test".to_string(),
            version: "1.0.0".to_string(),
            author: "tester".to_string(),
            description: "test plugin".to_string(),
            ..Default::default()
        };

        let stable: StablePluginMeta = original.clone().into();
        assert_eq!(stable.name.as_str(), "test");

        let back: super::super::PluginMeta = stable.into();
        assert_eq!(back.name, "test");
        assert_eq!(back.version, "1.0.0");
    }
}