rtlola-interpreter-macros 0.2.0

Derive macros to help with integrating the rtlola interpreter
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

pub(crate) mod helper;

mod composit_factory;
mod struct_verdict;
mod value_factory;

extern crate proc_macro;

use proc_macro::TokenStream;
use proc_macro2::Ident;
use proc_macro_error::proc_macro_error;

use crate::composit_factory::expand as composit_expand;
use crate::struct_verdict::expand as struct_verdict_expand;
use crate::value_factory::expand as value_expand;

#[derive(deluxe::ParseAttributes, Debug, Clone)]
#[deluxe(attributes(factory))]
pub(crate) struct FactoryAttr {
    #[deluxe(default)]
    ignore: bool,
    #[deluxe(default)]
    prefix: bool,
    #[deluxe(default)]
    is_time: bool,
    custom_prefix: Option<Ident>,
    custom_name: Option<Ident>,
}

#[proc_macro_derive(ValueFactory, attributes(factory))]
#[proc_macro_error]
/// A derive macro that implements the [EventFactory](rtlola_interpreter::input::EventFactory) trait for a type which is composed of types that implement `TryInto<Value>`.
/// For an example look at `simple.rs` and `custom_names.rs` in the example folder.
///
/// _Note:_ This macro does not implement the [EventFactory](rtlola_interpreter::input::EventFactory) trait directly, but rather implements [AssociatedEventFactory](rtlola_interpreter::input::AssociatedEventFactory) which links to the respective factory.
pub fn derive_record_impl(input: TokenStream) -> TokenStream {
    value_expand(input)
}

#[proc_macro_derive(CompositFactory, attributes(factory))]
#[proc_macro_error]
/// A derive macro that implements the [EventFactory](rtlola_interpreter::input::EventFactory) trait for a type which is composed of types that implement [AssociatedEventFactory](rtlola_interpreter::input::AssociatedEventFactory).
/// For an example look at `enum.rs` in the example folder.
///
/// _Note:_ This macro does not implement the [EventFactory](rtlola_interpreter::input::EventFactory) trait directly, but rather implements [AssociatedEventFactory](rtlola_interpreter::input::AssociatedEventFactory) which links to the respective factory.
pub fn derive_input_impl(input: TokenStream) -> TokenStream {
    composit_expand(input)
}

#[proc_macro_derive(VerdictFactory, attributes(factory))]
#[proc_macro_error]
/// A derive macro that implements the [FromValues](rtlola_interpreter::output::FromValues) trait for a struct with named fields.
/// The types of these fields must implement `TryFrom<Value>`, but are also allowed to be optional.
/// Parametrized streams are captured by HashMaps.
/// For an example look at `verdict.rs` in the example folder.
///
/// _Note:_ This macro does not implement the [VerdictFactory](rtlola_interpreter::output::VerdictFactory) trait directly, but rather implements [AssociatedVerdictFactory](rtlola_interpreter::output::AssociatedVerdictFactory) which links to the respective factory.
pub fn derive_struct_verdict(input: TokenStream) -> TokenStream {
    struct_verdict_expand(input)
}