roto 0.10.0

a statically-typed, compiled, embedded scripting language
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

use std::any::{TypeId, type_name};

use crate::runtime::NoCtx;

/// The context or environment that a Roto script runs in
///
/// This declares a set of global variables that are initialized just before
/// the script is run.
///
/// # Safety
///
/// This trait is unsafe because it tell Roto about the offsets and types of
/// each field. It is crucial that this information is correct. Therefore,
/// you should only ever derive this trait and not implement it manually.
pub unsafe trait Context: 'static + Clone {
    /// Return the fields of this struct, their offsets and their types
    fn fields() -> Vec<ContextField>;

    /// Return the [`ContextDescription`] of this [`Context`] type.
    fn description() -> ContextDescription {
        ContextDescription {
            type_id: TypeId::of::<Self>(),
            type_name: type_name::<Self>(),
            fields: Self::fields(),
        }
    }
}

/// Description of `Context` type
#[derive(Clone)]
pub struct ContextDescription {
    /// [`TypeId`] of this type.
    pub type_id: TypeId,

    /// Name of this type.
    pub type_name: &'static str,

    /// Fields of this type.
    pub fields: Vec<ContextField>,
}

/// Description of a field of a [`Context`] type
#[derive(Clone, Debug)]
pub struct ContextField {
    /// Name of the field
    pub name: &'static str,

    /// Offset of the field in its enclosing type
    pub offset: usize,

    /// Name of the type of the field
    pub type_name: &'static str,

    /// [`TypeId`] of the type of the field
    pub type_id: TypeId,

    /// Docstring of the field
    pub docstring: String,
}

unsafe impl Context for NoCtx {
    fn fields() -> Vec<ContextField> {
        Vec::new()
    }
}