automata-like-programming 0.2.0

Library that provides mechanisms for controlling the flow of execution in imitation of an automaton.
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

use std::{rc::Rc, sync::Arc};

use crate::simple_impl::simple_state::{KeyProvidingData, SharedSimpleState, SimpleInterStateConnection};

/// Allows for quick definition of chain of states that follow single path.
/// # Examples
/// ```
/// # use std::{cell::RefCell, rc::Rc};
/// # use automata_like_programming::{
/// #   automaton::{
/// #     AutomatonResult
/// #   }, 
/// #   automaton_state::{
/// #     new_shared_concrete_state,
/// #     AutomatonState
/// #   }, 
/// #   simple_impl::{
/// #     series::definer::SeriesDefiner,
/// #     simple_state::{
/// #       KeyProvidingData,
/// #       SimpleStateImplementation
/// #     }
/// #   }
/// # };
/// #
/// # fn char_matcher(c: char) -> impl Fn(&char) -> bool {
/// #   move |k: &char| *k == c
/// # }
/// #
/// # pub struct TestData {}
/// #
/// # impl KeyProvidingData<char> for TestData {
/// #   fn next_key(&mut self) -> Option<char> {
/// #     Option::Some('a')
/// #   }
/// # }
/// #
/// // Creates series of state that will match 'abc' character sequence or go back to root state anytime there is a mismatch.
/// fn create_abc_series_state_tree() -> Rc<RefCell<dyn AutomatonState<'static, char, TestData, String>>> {
///   let root_state = new_shared_concrete_state(SimpleStateImplementation::new('x'));
///   SeriesDefiner::new_without_default_action(&root_state)
///   .next_state(char_matcher('a'), &new_shared_concrete_state(SimpleStateImplementation::new('a')))
///   .next_state(char_matcher('b'), &new_shared_concrete_state(SimpleStateImplementation::new('b')))
///   .next_state(char_matcher('c'), &new_shared_concrete_state(SimpleStateImplementation::new('c')));
///   root_state
/// }
/// ```
pub struct SeriesDefiner<'a, K, Id: Copy, D: KeyProvidingData<K>, E> {
    default_state: SharedSimpleState<'a, K, Id, D, E>,
    default_execution: Arc<dyn Fn(&mut D, &K) -> Result<(), E> + 'a>,
    // default_execution: FDExec,
    state: SharedSimpleState<'a, K, Id, D, E>,
}

impl <'a, K, Id: Copy, D: KeyProvidingData<K>, E> SeriesDefiner<'a, K, Id, D, E> {
    /// Creates new `SeriesDefiner` which defaults unmatched connections to the same node it starts from.
    pub fn new_without_default_action(starting_state: &SharedSimpleState<'a, K, Id, D, E>) -> SeriesDefiner<'a, K, Id, D, E> {
        Self::new(starting_state, |_, _| {Result::Ok(())})
    }

    /// Creates new `SeriesDefiner` which defaults unmatched connections to the same node it starts from.
    pub fn new<FDExec: Fn(&mut D, &K) -> Result<(), E> + 'a>(starting_state: &SharedSimpleState<'a, K, Id, D, E>, default_execution_function: FDExec) -> SeriesDefiner<'a, K, Id, D, E> {
        Self::new_different_default_state(starting_state, starting_state, default_execution_function)
    }

    /// Creates new `SeriesDefiner` with possible different starting and default states.
    pub fn new_different_default_state<FDExec: Fn(&mut D, &K) -> Result<(), E> + 'a>(starting_state: &SharedSimpleState<'a, K, Id, D, E>, default_state: &SharedSimpleState<'a, K, Id, D, E>, default_execution_function: FDExec) -> SeriesDefiner<'a, K, Id, D, E> {
        SeriesDefiner {
            state: Rc::clone(&starting_state),
            default_state: Rc::clone(&default_state),
            default_execution: Arc::new(default_execution_function),
        }
    }
    
    /// Adds connection to currently processed state. No function is executed when changing state. Creates a default connection 
    /// to starting state as well.
    pub fn next_state<M>(mut self, matcher: M, next_state: &SharedSimpleState<'a, K, Id, D, E>) -> SeriesDefiner<'a, K, Id, D, E> 
    where M: 'a + Fn(&K) -> bool
    {
        self.state.borrow_mut().register_connection(SimpleInterStateConnection::new_no_action(matcher, next_state));
        let default_exec_function = Arc::clone(&self.default_execution);
        self.state.borrow_mut().register_connection(SimpleInterStateConnection::new_always_matched(move |k,d| (default_exec_function)(k, d), &self.default_state));
        self.state = Rc::clone(next_state);
        self
    }

    /// Adds connection to currently processed state. Given function is executed when changing state. Creates a default connection 
    /// to starting state as well.
    pub fn next_state_exec<M, FExec>(mut self, matcher: M, next_state: &SharedSimpleState<'a, K, Id, D, E>, execution_function: FExec) -> SeriesDefiner<'a, K, Id, D, E> 
    where
    M: 'a + Fn(&K) -> bool,
    FExec: 'a + Fn(&mut D, &K) -> Result<(), E>
    {
        self.state.borrow_mut().register_connection(SimpleInterStateConnection::new(matcher, execution_function, next_state));
        let default_exec_function = Arc::clone(&self.default_execution);
        self.state.borrow_mut().register_connection(SimpleInterStateConnection::new_always_matched(move |k,d| (default_exec_function)(k, d), &self.default_state));
        self.state = Rc::clone(next_state);
        self
    }
}

#[cfg(test)]
mod test {
    use std::{cell::RefCell, rc::Rc};

    use crate::{automaton::{Automaton, AutomatonResult}, automaton_state::{new_shared_concrete_state, AutomatonState}, simple_impl::simple_state::SimpleStateImplementation, test_commons::{char_matcher, unwrap_result, CopiedTestData}};

    use super::SeriesDefiner;

    fn create_abc_series_state_tree() -> Rc<RefCell<dyn AutomatonState<'static, char, CopiedTestData<char>, String>>> {
        let root_state = new_shared_concrete_state(SimpleStateImplementation::new('x'));
        SeriesDefiner::new(&root_state, |_, _| {Result::Ok(())})
        .next_state(char_matcher('a'), &new_shared_concrete_state(SimpleStateImplementation::new('a')))
        .next_state(char_matcher('b'), &new_shared_concrete_state(SimpleStateImplementation::new('b')))
        .next_state(char_matcher('c'), &new_shared_concrete_state(SimpleStateImplementation::new('c')));
        root_state
    }

    #[test]
    fn series_full_match() -> () {
        let mut automaton = Automaton::new(create_abc_series_state_tree());
        let mut data = CopiedTestData::new(vec!['a', 'b', 'c']);
        let automaton_result: AutomatonResult<char, String> = automaton.run(&mut data);
        assert_eq!(unwrap_result!(automaton_result.expect_empty_iter()), 'c');
    }

    #[test]
    fn series_back_to_default() -> () {
        let mut automaton = Automaton::new(create_abc_series_state_tree());
        let mut data = CopiedTestData::new(vec!['a', 'b', 'd']);
        let automaton_result: AutomatonResult<char, String> = automaton.run(&mut data);
        assert_eq!(unwrap_result!(automaton_result.expect_empty_iter()), 'x');
    }

    #[test]
    fn series_no_more_sates() -> () {
        let mut automaton = Automaton::new(create_abc_series_state_tree());
        let mut data = CopiedTestData::new(vec!['a', 'b', 'c', 'd']);
        let automaton_result = automaton.run(&mut data).expect_could_not_find_next_state();
        assert_eq!(unwrap_result!(automaton_result), 'c');
    }
}