behaviortree-derive 0.5.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

// Copyright © 2025 Stephan Kunz
//! Derive macros for [`Behavior`](crate)s.
//! There are 4 derive macros available:
//! - Action
//! - Condition
//! - Control
//! - Decorator
//!
//! On struct level there are the attributes
//! - `#[behavior(no_create)]`: will suppress the derive of create_fn(...)
//! - `#[behavior(no_register)]`: will suppress the derive of register()
//! - `#[behavior(no_register_with)]`: will suppress the derive of register_with(...)
//!
//! On field level there are the attributes
//! - `#[behavior(parameter)]`: defines a field as a parameter for `create_fn(...)` and `register_with(...)`
//!   The values must be given when using the `register_with(...)` method.
//!   A parameter must implement `Clone`.
//! - `#[behavior(default = <Expression>)]`: defines a default value for a field.
//!   'Expression' can be any Rust expression that creates an appropriate value out of nothing.
//!
//! # Usage
//! Example uses the derive macro `Action`, the others work respectively.
//! ```no_test
//! #[derive(Action)]
//! struct MyAction {
//!     // specific elements
//!     ...
//! }
//!
//! impl MyAction {
//!     // your specific implementations
//!     ...
//! }
//! ```
//!
//! # Errors
//! - if attributes are used in a wrong way
//!
//! # Panics
//! - if used on enums or unions or functions

use quote::quote;

mod derive_behavior;

use derive_behavior::derive_behavior_impl;
use proc_macro::TokenStream;

/// Derive macro for an [`Action`] type `Behavior`, [`usage`](https://docs.rs/behaviortree-derive).
#[proc_macro_derive(Action, attributes(behavior))]
pub fn derive_action(input: TokenStream) -> TokenStream {
	derive_behavior_impl(
		input.into(),
		quote! { behaviortree_core::behavior_kind::BehaviorKind::Action },
	)
	.into()
}

/// Derive macro for an [`Condition`] type `Behavior`, [`usage`](https://docs.rs/behaviortree-derive).
#[proc_macro_derive(Condition, attributes(behavior))]
pub fn derive_condition(input: TokenStream) -> TokenStream {
	derive_behavior_impl(
		input.into(),
		quote! { behaviortree_core::behavior_kind::BehaviorKind::Condition },
	)
	.into()
}

/// Derive macro for an [`Control`] type `Behavior`, [`usage`](https://docs.rs/behaviortree-derive).
#[proc_macro_derive(Control, attributes(behavior))]
pub fn derive_control(input: TokenStream) -> TokenStream {
	derive_behavior_impl(
		input.into(),
		quote! { behaviortree_core::behavior_kind::BehaviorKind::Control },
	)
	.into()
}

/// Derive macro for an [`Decorator`] type `Behavior`, [`usage`](https://docs.rs/behaviortree-derive).
#[proc_macro_derive(Decorator, attributes(behavior))]
pub fn derive_decorator(input: TokenStream) -> TokenStream {
	derive_behavior_impl(
		input.into(),
		quote! { behaviortree_core::behavior_kind::BehaviorKind::Decorator },
	)
	.into()
}