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
use crate::lib::*;
use crate::{FsmBackend, FsmResult};

/// The event queueing trait for FSMs. Can be used from outside or from within the actions of the FSM.
pub trait FsmEventQueue<F: FsmBackend>: FsmEventQueueSender<F> {
    /// Try to dequeue an event.
    fn dequeue(&mut self) -> Option<<F as FsmBackend>::Events>;
    /// Number of messages to be dequeued.
    fn len(&self) -> usize;
}

pub trait FsmEventQueueSender<F: FsmBackend> {
    /// Try to enqueue an event.
    fn enqueue<E: Into<<F as FsmBackend>::Events>>(&mut self, event: E) -> FsmResult<()>;
}

#[cfg(feature = "std")]
mod queue_vec {
    use super::*;

    /// An unbound event queue that uses `VecDeque`.
    pub struct FsmEventQueueVec<F: FsmBackend> {
        queue: VecDeque<<F as FsmBackend>::Events>
    }

    
    impl<F: FsmBackend> FsmEventQueueVec<F> {
        pub fn new() -> Self {
            FsmEventQueueVec {
                queue: VecDeque::new()
            }
        }
    }

    impl<F: FsmBackend> FsmEventQueue<F> for FsmEventQueueVec<F> {
        fn dequeue(&mut self) -> Option<<F as FsmBackend>::Events> {
            self.queue.pop_front()
        }

        fn len(&self) -> usize {
            self.queue.len()
        }
    }

    impl<F: FsmBackend> FsmEventQueueSender<F> for FsmEventQueueVec<F> {
        fn enqueue<E: Into<<F as FsmBackend>::Events>>(&mut self, event: E) -> FsmResult<()> {
            self.queue.push_back(event.into());
            Ok(())
        }
    }
}

#[cfg(feature = "std")]
pub use self::queue_vec::*;

#[cfg(feature = "std")]
mod queue_vec_shared {
    use std::sync::{Arc, Mutex};

    use crate::FsmError;

    use super::*;

    /// An unbound event queue that uses `VecDeque`.
    pub struct FsmEventQueueVecShared<F: FsmBackend> {
        inner: Inner<F>
    }

    impl<F> Clone for FsmEventQueueVecShared<F> where F: FsmBackend {
        fn clone(&self) -> Self {
            Self { inner: Inner { queue: self.inner.queue.clone() } }
        }
    }

    struct Inner<F: FsmBackend> {
        queue: Arc<Mutex<VecDeque<<F as FsmBackend>::Events>>>
    }
    
    impl<F: FsmBackend> FsmEventQueueVecShared<F> {
        pub fn new() -> Self {
            let q = VecDeque::new();
            let inner = Inner {
                queue: Arc::new(Mutex::new(q))
            };
            FsmEventQueueVecShared {
                inner
            }
        }
    }

    impl<F: FsmBackend> FsmEventQueue<F> for FsmEventQueueVecShared<F> {
        fn dequeue(&mut self) -> Option<<F as FsmBackend>::Events> {
            if let Ok(mut q) = self.inner.queue.lock() {
                q.pop_front()
            } else {
                None
            }
        }

        fn len(&self) -> usize {
            if let Ok(q) = self.inner.queue.lock() {
                q.len()
            } else {
                0
            }
        }
    }

    impl<F: FsmBackend> FsmEventQueueSender<F> for FsmEventQueueVecShared<F> {
        fn enqueue<E: Into<<F as FsmBackend>::Events>>(&mut self, event: E) -> FsmResult<()> {
            if let Ok(mut q) = self.inner.queue.lock() {
                q.push_back(event.into());
                Ok(())
            } else {
                Err(FsmError::QueueOverCapacity)
            }
        }
    }
}

#[cfg(feature = "std")]
pub use self::queue_vec_shared::*;

mod queue_array {
    use arraydeque::{Array, ArrayDeque};

    use super::*;

    /// A heapless queue with a fixed size. Implemented using the `arraydequeue` crate.
    pub struct FsmEventQueueArray<F, A>
        where F: FsmBackend, A: Array<Item = <F as FsmBackend>::Events>, Self: Sized
    {
        dequeue: ArrayDeque<A>,
        _fsm: PhantomData<F>
    }

    impl<F, A> FsmEventQueueArray<F, A>
        where F: FsmBackend, A: Array<Item = <F as FsmBackend>::Events>
    {
        pub fn new() -> Self {
            Self {
                dequeue: ArrayDeque::new(),
                _fsm: PhantomData::default()
            }
        }
    }

    impl<F, A> FsmEventQueue<F> for FsmEventQueueArray<F, A> 
        where F: FsmBackend, A: Array<Item = <F as FsmBackend>::Events>
    {
        fn dequeue(&mut self) -> Option<<F as FsmBackend>::Events> {
            self.dequeue.pop_front()
        }

        fn len(&self) -> usize {
            self.dequeue.len()
        }
    }

    impl<F, A> FsmEventQueueSender<F> for FsmEventQueueArray<F, A> 
        where F: FsmBackend, A: Array<Item = <F as FsmBackend>::Events>
    {
        fn enqueue<E: Into<<F as FsmBackend>::Events>>(&mut self, event: E) -> FsmResult<()> {
            match self.dequeue.push_back(event.into()) {
                Ok(_) => Ok(()),
                Err(_) => Err(crate::FsmError::QueueOverCapacity)
            }
        }
    }
}

pub use self::queue_array::*;


pub mod heapless_shared {
    //! A heapless queue with Clone and Arc support.
    
    use core::sync::atomic::{AtomicUsize, Ordering};

    use crate::FsmError;

    use super::*;

    extern crate alloc;
    use alloc::sync::Arc;
    use heapless::mpmc::Q64;

/// An unbound event queue that uses `VecDeque`.
    pub struct FsmEventQueueHeaplessShared<F: FsmBackend> {
        inner: Arc<Inner<F>>
    }

    impl<F> Clone for FsmEventQueueHeaplessShared<F> where F: FsmBackend {
        fn clone(&self) -> Self {
            Self { inner: self.inner.clone() }
        }
    }

    struct Inner<F: FsmBackend> {
        queue: Q64<<F as FsmBackend>::Events>,
        len: AtomicUsize
    }
    
    impl<F: FsmBackend> FsmEventQueueHeaplessShared<F> {
        pub fn new() -> Self {
            let q = Q64::new();
            let inner = Inner {
                queue: q,
                len: AtomicUsize::new(0)
            };
            FsmEventQueueHeaplessShared {
                inner: Arc::new(inner)
            }
        }
    }

    impl<F: FsmBackend> FsmEventQueue<F> for FsmEventQueueHeaplessShared<F> {
        fn dequeue(&mut self) -> Option<<F as FsmBackend>::Events> {
            match self.inner.queue.dequeue() {
                Some(e) => {
                    self.inner.len.fetch_sub(1, Ordering::SeqCst);
                    Some(e)
                },
                None => None
            }
        }

        fn len(&self) -> usize {
            self.inner.len.load(Ordering::SeqCst)
        }
    }

    impl<F: FsmBackend> FsmEventQueueSender<F> for FsmEventQueueHeaplessShared<F> {
        fn enqueue<E: Into<<F as FsmBackend>::Events>>(&mut self, event: E) -> FsmResult<()> {
            match self.inner.queue.enqueue(event.into()) {
                Ok(_) => {
                    self.inner.len.fetch_add(1, Ordering::SeqCst);
                    Ok(())
                },
                Err(_) => Err(FsmError::QueueOverCapacity) 
            }
        }
    }

}

pub struct FsmEventQueueNull<F> {
    _ty: PhantomData<F>
}

impl<F> FsmEventQueueNull<F> {
    pub fn new() -> Self {
        FsmEventQueueNull { _ty: PhantomData::default() }
    }
}

impl<F: FsmBackend> FsmEventQueue<F> for FsmEventQueueNull<F> {
    fn dequeue(&mut self) -> Option<<F as FsmBackend>::Events> {
        None
    }

    fn len(&self) -> usize {
        0
    }
}

impl<F: FsmBackend> FsmEventQueueSender<F> for FsmEventQueueNull<F> {
    fn enqueue<E: Into<<F as FsmBackend>::Events>>(&mut self, _event: E) -> FsmResult<()> {
        Ok(())
    }
}

pub struct FsmEventQueueSub<'a, Q, F, FSub>
    where 
        F: FsmBackend,
        Q: FsmEventQueueSender<F>
{
    pub parent: &'a mut Q,
    pub _parent_fsm: PhantomData<F>,
    pub _sub_fsm: PhantomData<FSub>
}

impl<'a, Q, F, FSub> FsmEventQueue<FSub> for FsmEventQueueSub<'a, Q, F, FSub>
    where 
        F: FsmBackend,
        Q: FsmEventQueueSender<F>,
        FSub: FsmBackend,
        <F as FsmBackend>::Events: From<<FSub as FsmBackend>::Events>
{
    fn dequeue(&mut self) -> Option<<FSub as FsmBackend>::Events> {
        None
    }

    fn len(&self) -> usize {
        0
    }
}

impl<'a, Q, F, FSub> FsmEventQueueSender<FSub> for FsmEventQueueSub<'a, Q, F, FSub>
    where 
        F: FsmBackend,
        Q: FsmEventQueueSender<F>,
        FSub: FsmBackend,
        <F as FsmBackend>::Events: From<<FSub as FsmBackend>::Events>
{
    fn enqueue<E: Into<<FSub as FsmBackend>::Events>>(&mut self, event: E) -> FsmResult<()>
    {
        self.parent.enqueue(event.into())
    }
}



#[cfg(test)]
use super::tests_fsm::TestFsm;

#[test]
fn test_dequeue_vec() {
    
    let queue = FsmEventQueueVec::<TestFsm>::new();
    test_queue(queue);
}

#[test]
fn test_array() {
    let queue = FsmEventQueueArray::<TestFsm, [_; 16]>::new();
    test_queue(queue);
}

#[test]
fn test_dequeue_vec_shared() {
    let queue = FsmEventQueueVecShared::<TestFsm>::new();
    test_queue(queue);
}

#[test]
fn test_heapless_shared() {
    use self::heapless_shared::FsmEventQueueHeaplessShared;
    let queue = FsmEventQueueHeaplessShared::<TestFsm>::new();
    test_queue(queue);
}

#[cfg(test)]
fn test_queue<Q: FsmEventQueue<TestFsm>>(mut queue: Q) {
    use super::tests_fsm::{Events, EventA};

    // fill and drain
    {
        for i in 0..5 {
            assert_eq!(i, queue.len());
            queue.enqueue(EventA { n: i }).unwrap();            
            assert_eq!(i+1, queue.len());
        }

        for i in 0..5 {
            assert_eq!(5-i, queue.len());
            let ev = queue.dequeue().unwrap();
            assert_eq!(Events::EventA(EventA { n: i }), ev);            
            assert_eq!(5-i-1, queue.len());
        }
    }
    assert_eq!(None, queue.dequeue());

    // zipper - enqueue 2, drain 1
    {
        let mut n = 0;
        let mut x = 0;
        for _ in 0..10 {
            queue.enqueue(EventA { n }).unwrap();
            n += 1;
            queue.enqueue(EventA { n }).unwrap();
            n += 1;

            {
                let ev = queue.dequeue().unwrap();
                assert_eq!(Events::EventA(EventA { n: x }), ev);
                x += 1;
            }

            assert_eq!(queue.len(), x);
        }
    }
}