mecha10-behavior-runtime 0.1.25

Behavior tree runtime for Mecha10 - unified AI and logic composition system
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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
//! Composition primitives for building behavior trees
//!
//! This module provides the fundamental composition nodes: Sequence, Selector, and Parallel.

use crate::{BehaviorNode, BoxedBehavior, NodeStatus};
use async_trait::async_trait;
use mecha10_core::Context;
use tracing::{debug, warn};

// ============================================================================
// Sequence Node
// ============================================================================

/// Executes child behaviors in sequence until one fails or all succeed.
///
/// **Behavior:**
/// - Ticks children in order
/// - Returns `Success` if all children succeed
/// - Returns `Failure` if any child fails
/// - Returns `Running` while executing children
///
/// **Use cases:**
/// - Multi-step tasks that must complete in order
/// - Pipeline processing
/// - Sequential actions (approach → grasp → lift)
///
/// # Example
///
/// ```rust,no_run
/// use mecha10_behavior_runtime::prelude::*;
///
/// // Assuming these behaviors are defined elsewhere
/// # use mecha10_behavior_runtime::BoxedBehavior;
/// # fn get_behaviors() -> Vec<BoxedBehavior> { vec![] }
/// let sequence = SequenceNode::new(get_behaviors());
/// ```
#[derive(Debug)]
pub struct SequenceNode {
    children: Vec<BoxedBehavior>,
    current_index: usize,
}

impl SequenceNode {
    /// Create a new sequence node with the given children.
    pub fn new(children: Vec<BoxedBehavior>) -> Self {
        Self {
            children,
            current_index: 0,
        }
    }

    /// Add a child behavior to the sequence.
    pub fn add_child(&mut self, child: BoxedBehavior) {
        self.children.push(child);
    }

    /// Get the number of children.
    pub fn len(&self) -> usize {
        self.children.len()
    }

    /// Check if the sequence is empty.
    pub fn is_empty(&self) -> bool {
        self.children.is_empty()
    }
}

#[async_trait]
impl BehaviorNode for SequenceNode {
    async fn tick(&mut self, ctx: &Context) -> anyhow::Result<NodeStatus> {
        // Empty sequence succeeds immediately
        if self.children.is_empty() {
            return Ok(NodeStatus::Success);
        }

        // Execute children in sequence
        let total_children = self.children.len();
        while self.current_index < total_children {
            debug!(
                "Sequence: ticking child {} of {}",
                self.current_index + 1,
                total_children
            );

            let child = &mut self.children[self.current_index];
            match child.tick(ctx).await? {
                NodeStatus::Success => {
                    // Move to next child
                    self.current_index += 1;
                }
                NodeStatus::Failure => {
                    // Sequence fails if any child fails
                    debug!("Sequence: child {} failed", self.current_index + 1);
                    return Ok(NodeStatus::Failure);
                }
                NodeStatus::Running => {
                    // Child still running, sequence continues next tick
                    return Ok(NodeStatus::Running);
                }
            }
        }

        // All children succeeded
        debug!("Sequence: all children succeeded");
        Ok(NodeStatus::Success)
    }

    async fn reset(&mut self) -> anyhow::Result<()> {
        self.current_index = 0;
        for child in &mut self.children {
            child.reset().await?;
        }
        Ok(())
    }

    async fn on_init(&mut self, ctx: &Context) -> anyhow::Result<()> {
        for child in &mut self.children {
            child.on_init(ctx).await?;
        }
        Ok(())
    }

    async fn on_terminate(&mut self, ctx: &Context) -> anyhow::Result<()> {
        for child in &mut self.children {
            child.on_terminate(ctx).await?;
        }
        Ok(())
    }

    fn name(&self) -> &str {
        "sequence"
    }
}

// ============================================================================
// Selector Node (Also called Fallback or Priority)
// ============================================================================

/// Executes child behaviors until one succeeds or all fail.
///
/// **Behavior:**
/// - Ticks children in order
/// - Returns `Success` if any child succeeds
/// - Returns `Failure` if all children fail
/// - Returns `Running` while executing children
///
/// **Use cases:**
/// - Fallback behaviors (try A, if it fails try B)
/// - Alternative strategies
/// - Error recovery chains
///
/// # Example
///
/// ```rust,no_run
/// use mecha10_behavior_runtime::prelude::*;
///
/// // Assuming these behaviors are defined elsewhere
/// # use mecha10_behavior_runtime::BoxedBehavior;
/// # fn get_behaviors() -> Vec<BoxedBehavior> { vec![] }
/// let selector = SelectOrNode::new(get_behaviors());
/// ```
#[derive(Debug)]
pub struct SelectOrNode {
    children: Vec<BoxedBehavior>,
    current_index: usize,
}

impl SelectOrNode {
    /// Create a new selector node with the given children.
    pub fn new(children: Vec<BoxedBehavior>) -> Self {
        Self {
            children,
            current_index: 0,
        }
    }

    /// Add a child behavior to the selector.
    pub fn add_child(&mut self, child: BoxedBehavior) {
        self.children.push(child);
    }

    /// Get the number of children.
    pub fn len(&self) -> usize {
        self.children.len()
    }

    /// Check if the selector is empty.
    pub fn is_empty(&self) -> bool {
        self.children.is_empty()
    }
}

#[async_trait]
impl BehaviorNode for SelectOrNode {
    async fn tick(&mut self, ctx: &Context) -> anyhow::Result<NodeStatus> {
        // Empty selector fails immediately
        if self.children.is_empty() {
            return Ok(NodeStatus::Failure);
        }

        // Try children in order until one succeeds
        let total_children = self.children.len();
        while self.current_index < total_children {
            debug!(
                "Selector: ticking child {} of {}",
                self.current_index + 1,
                total_children
            );

            let child = &mut self.children[self.current_index];
            match child.tick(ctx).await? {
                NodeStatus::Success => {
                    // Selector succeeds if any child succeeds
                    debug!("Selector: child {} succeeded", self.current_index + 1);
                    return Ok(NodeStatus::Success);
                }
                NodeStatus::Failure => {
                    // Try next child
                    warn!("Selector: child {} failed, trying next", self.current_index + 1);
                    self.current_index += 1;
                }
                NodeStatus::Running => {
                    // Child still running, selector continues next tick
                    return Ok(NodeStatus::Running);
                }
            }
        }

        // All children failed
        debug!("Selector: all children failed");
        Ok(NodeStatus::Failure)
    }

    async fn reset(&mut self) -> anyhow::Result<()> {
        self.current_index = 0;
        for child in &mut self.children {
            child.reset().await?;
        }
        Ok(())
    }

    async fn on_init(&mut self, ctx: &Context) -> anyhow::Result<()> {
        for child in &mut self.children {
            child.on_init(ctx).await?;
        }
        Ok(())
    }

    async fn on_terminate(&mut self, ctx: &Context) -> anyhow::Result<()> {
        for child in &mut self.children {
            child.on_terminate(ctx).await?;
        }
        Ok(())
    }

    fn name(&self) -> &str {
        "selector"
    }
}

// ============================================================================
// Parallel Node
// ============================================================================

/// Policy for determining when a parallel node succeeds or fails.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ParallelPolicy {
    /// Succeed when all children succeed, fail if any child fails.
    RequireAll,

    /// Succeed when any child succeeds, fail when all children fail.
    RequireOne,

    /// Succeed when at least N children succeed.
    RequireN(usize),
}

/// Executes all child behaviors concurrently (in parallel).
///
/// **Behavior:**
/// - Ticks all children every tick
/// - Success/failure depends on the configured policy
/// - Returns `Running` while any child is still running
///
/// **Use cases:**
/// - Concurrent actions (move + look around + monitor obstacles)
/// - Parallel sensor processing
/// - Multi-objective optimization
///
/// # Example
///
/// ```rust,no_run
/// use mecha10_behavior_runtime::prelude::*;
///
/// // Assuming these behaviors are defined elsewhere
/// # use mecha10_behavior_runtime::BoxedBehavior;
/// # fn get_behaviors() -> Vec<BoxedBehavior> { vec![] }
/// // All must succeed
/// let parallel = ParallelNode::new(
///     get_behaviors(),
///     ParallelPolicy::RequireAll,
/// );
/// ```
#[derive(Debug)]
pub struct ParallelNode {
    children: Vec<BoxedBehavior>,
    policy: ParallelPolicy,
    child_statuses: Vec<NodeStatus>,
}

impl ParallelNode {
    /// Create a new parallel node with the given children and policy.
    pub fn new(children: Vec<BoxedBehavior>, policy: ParallelPolicy) -> Self {
        let child_statuses = vec![NodeStatus::Running; children.len()];
        Self {
            children,
            policy,
            child_statuses,
        }
    }

    /// Add a child behavior to the parallel node.
    pub fn add_child(&mut self, child: BoxedBehavior) {
        self.children.push(child);
        self.child_statuses.push(NodeStatus::Running);
    }

    /// Get the number of children.
    pub fn len(&self) -> usize {
        self.children.len()
    }

    /// Check if the parallel node is empty.
    pub fn is_empty(&self) -> bool {
        self.children.is_empty()
    }
}

#[async_trait]
impl BehaviorNode for ParallelNode {
    async fn tick(&mut self, ctx: &Context) -> anyhow::Result<NodeStatus> {
        // Empty parallel succeeds immediately
        if self.children.is_empty() {
            return Ok(NodeStatus::Success);
        }

        // Tick all children that are still running
        for (i, child) in self.children.iter_mut().enumerate() {
            if self.child_statuses[i].is_running() {
                let status = child.tick(ctx).await?;
                self.child_statuses[i] = status;
                debug!("Parallel: child {} status: {}", i + 1, status);
            }
        }

        // Check policy to determine overall status
        let success_count = self.child_statuses.iter().filter(|s| s.is_success()).count();
        let failure_count = self.child_statuses.iter().filter(|s| s.is_failure()).count();
        let _running_count = self.child_statuses.iter().filter(|s| s.is_running()).count();

        match self.policy {
            ParallelPolicy::RequireAll => {
                if failure_count > 0 {
                    debug!("Parallel (RequireAll): at least one child failed");
                    Ok(NodeStatus::Failure)
                } else if success_count == self.children.len() {
                    debug!("Parallel (RequireAll): all children succeeded");
                    Ok(NodeStatus::Success)
                } else {
                    Ok(NodeStatus::Running)
                }
            }
            ParallelPolicy::RequireOne => {
                if success_count > 0 {
                    debug!("Parallel (RequireOne): at least one child succeeded");
                    Ok(NodeStatus::Success)
                } else if failure_count == self.children.len() {
                    debug!("Parallel (RequireOne): all children failed");
                    Ok(NodeStatus::Failure)
                } else {
                    Ok(NodeStatus::Running)
                }
            }
            ParallelPolicy::RequireN(n) => {
                if success_count >= n {
                    debug!("Parallel (RequireN({})): {} children succeeded", n, success_count);
                    Ok(NodeStatus::Success)
                } else if (self.children.len() - failure_count) < n {
                    // Not enough children can possibly succeed
                    debug!("Parallel (RequireN({})): not enough children can succeed", n);
                    Ok(NodeStatus::Failure)
                } else {
                    Ok(NodeStatus::Running)
                }
            }
        }
    }

    async fn reset(&mut self) -> anyhow::Result<()> {
        for i in 0..self.children.len() {
            self.child_statuses[i] = NodeStatus::Running;
            self.children[i].reset().await?;
        }
        Ok(())
    }

    async fn on_init(&mut self, ctx: &Context) -> anyhow::Result<()> {
        for child in &mut self.children {
            child.on_init(ctx).await?;
        }
        Ok(())
    }

    async fn on_terminate(&mut self, ctx: &Context) -> anyhow::Result<()> {
        for child in &mut self.children {
            child.on_terminate(ctx).await?;
        }
        Ok(())
    }

    fn name(&self) -> &str {
        "parallel"
    }
}