sim-lib-plugin-core 0.1.0-rc.1

Common plugin descriptors, state, and graph adapters.
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

use sim_kernel::{Cx, Result, Symbol};
use sim_lib_core::{SurfaceField, SurfacePackLib, SurfacePackSpec, SurfaceValueSpec, install_once};

const PLUGIN_CORE_LIB_ID: &str = "plugin-core";

/// Installs the plugin-core surface pack into the runtime context.
///
/// Registers one descriptor card per plugin-core export symbol; installing more
/// than once is idempotent.
///
/// # Errors
///
/// Returns an error when the surface pack fails to install.
pub fn install_plugin_core_lib(cx: &mut Cx) -> Result<()> {
    install_once(cx, &plugin_core_pack())?;
    Ok(())
}

/// Returns the qualified export symbols the plugin-core lib publishes.
pub fn plugin_core_symbols() -> Vec<Symbol> {
    [
        "PluginDescriptor",
        "ParameterDescriptor",
        "PluginState",
        "HostedPluginProcessor",
        "ProcessorPlugin",
    ]
    .into_iter()
    .map(|name| Symbol::qualified(PLUGIN_CORE_LIB_ID, name))
    .collect()
}

/// The plugin-core surface pack: one uniform descriptor card per export symbol.
fn plugin_core_pack() -> SurfacePackLib {
    SurfacePackLib {
        spec: SurfacePackSpec {
            lib_id: Symbol::new(PLUGIN_CORE_LIB_ID),
            values: plugin_core_symbols()
                .into_iter()
                .map(|symbol| SurfaceValueSpec {
                    symbol: symbol.clone(),
                    fields: vec![
                        (Symbol::new("symbol"), SurfaceField::Symbol(symbol)),
                        (
                            Symbol::new("layer"),
                            SurfaceField::Str(PLUGIN_CORE_LIB_ID.to_owned()),
                        ),
                        (
                            Symbol::new("kind"),
                            SurfaceField::Str("plugin-descriptor".to_owned()),
                        ),
                        (
                            Symbol::new("role"),
                            SurfaceField::Str(
                                "common plugin descriptor and adapter surface".to_owned(),
                            ),
                        ),
                    ],
                })
                .collect(),
        },
    }
}