behaviortree-derive 0.2.0

Derive macros for behaviortree
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
125
126
127
128
129
130
131
132
133
134
135
136
137
138

// Copyright © 2025 Stephan Kunz

//! Derive macro for [`Behavior`]s.
//! There are 4 derive macros avialable:
//! - Action
//! - Condition
//! - Control
//! - Decorator
//!
//! # Usage
//! Using the derive macro Action, the others work respectively.
//! ```no_test
//! #[derive(Action)]
//! struct MyAction {
//!     // specific elements
//!     ...
//! }
//!
//! impl MyAction {
//!     // specific implementations
//!     ...
//! }
//! ```
//!
//! # Result
//! Expands the above example to
//! ```no_test
//! struct MyAction {
//!     // specific elements
//!     ...
//! }
//!
//! impl MyAction {
//!     // specific implementations
//!     ...
//! }
//!
//! #[automatically_derived]
//! #[diagnostic::do_not_recommend]
//! impl behaviortree::behavior::Behavior for MyAction {
//!     fn creation_fn() -> alloc::boxed::Box<behaviortree::behavior::BehaviorCreationFn> {
//!         alloc::boxed::Box::new(|| alloc::boxed::Box::new(Self::default()))
//!     }
//! 
//!     fn kind() -> behaviortree::behavior::BehaviorKind {
//!         behaviortree::behavior::BehaviorKind::Action
//!     }
//! }
//!
//! #[automatically_derived]
//! #[diagnostic::do_not_recommend]
//! impl behaviortree::behavior::BehaviorExecution for MyAction {
//!     fn as_any(&self) -> &dyn core::any::Any { self }
//!     fn as_any_mut(&mut self) -> &mut dyn core::any::Any { self }
//!     fn static_provided_ports(&self) -> behaviortree::port::PortList { Self::provided_ports() }
//! }
//! ```
//!
//! # Errors
//!
//! # Panics
//! - if used on enums or unions

#[doc(hidden)]
extern crate proc_macro;

#[doc(hidden)]
extern crate alloc;

mod behavior;

use behavior::derive_behavior_struct;
use proc_macro::TokenStream;
use syn::DeriveInput;

/// internal differantiation of the different kinds of [`Behavior`]s.
enum Kind {
    Action,
    Condition,
    Control,
    Decorator,
}

/// Derive macro for an [`Action`] type [`Behavior`].
#[proc_macro_derive(Action)]
pub fn derive_action(input: TokenStream) -> TokenStream {
    // Construct a representation of the Rust code
    let input: DeriveInput = syn::parse2(input.into()).expect("could not parse input");

    // Check type of input
    match &input.data {
        syn::Data::Struct(_struct) => derive_behavior_struct(&input, Kind::Action).into(),
        syn::Data::Enum(_enum) => panic!("enums not supported"),
        syn::Data::Union(_union) => panic!("unions not supported"),
    }
}

/// Derive macro for an [`Condition`] type [`Behavior`].
#[proc_macro_derive(Condition)]
pub fn derive_condition(input: TokenStream) -> TokenStream {
    // Construct a representation of the Rust code
    let input: DeriveInput = syn::parse2(input.into()).expect("could not parse input");

    // Check type of input
    match &input.data {
        syn::Data::Struct(_struct) => derive_behavior_struct(&input, Kind::Condition).into(),
        syn::Data::Enum(_enum) => panic!("enums not supported"),
        syn::Data::Union(_union) => panic!("unions not supported"),
    }
}

/// Derive macro for an [`Control`] type [`Behavior`].
#[proc_macro_derive(Control)]
pub fn derive_control(input: TokenStream) -> TokenStream {
    // Construct a representation of the Rust code
    let input: DeriveInput = syn::parse2(input.into()).expect("could not parse input");

    // Check type of input
    match &input.data {
        syn::Data::Struct(_struct) => derive_behavior_struct(&input, Kind::Control).into(),
        syn::Data::Enum(_enum) => panic!("enums not supported"),
        syn::Data::Union(_union) => panic!("unions not supported"),
    }
}

/// Derive macro for an [`Decorator`] type [`Behavior`].
#[proc_macro_derive(Decorator)]
pub fn derive_decorator(input: TokenStream) -> TokenStream {
    // Construct a representation of the Rust code
    let input: DeriveInput = syn::parse2(input.into()).expect("could not parse input");

    // Check type of input
    match &input.data {
        syn::Data::Struct(_struct) => derive_behavior_struct(&input, Kind::Decorator).into(),
        syn::Data::Enum(_enum) => panic!("enums not supported"),
        syn::Data::Union(_union) => panic!("unions not supported"),
    }
}