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
#[cfg(feature = "rand")]
mod grammar_rng_rand;
#[cfg(feature = "turborand")]
mod grammar_rng_turborand;

#[cfg(feature = "rand")]
pub use grammar_rng_rand::*;
#[cfg(feature = "turborand")]
pub use grammar_rng_turborand::*;

use std::fmt::Debug;

#[derive(Clone, PartialEq, Debug)]
/// This defines a portion of a token stream that may be replaced using a rule, or might already be ready
pub enum Replacable<RuleKeyType: Clone + PartialEq + Debug, ResultType: Clone + PartialEq + Debug> {
    /// The value is already in it's final form
    Ready(ResultType),
    /// The value can be replaced by the provided rule
    Replace(RuleKeyType),
    /// The value is a meta rule for immediate processing
    ImmediateMeta(RuleKeyType, ResultType),
    /// The value is a meta rule for delayed processing - basically aliasing the rule
    DelayedMeta(RuleKeyType, ResultType),
}

/// This sets the direction of processing for the grammar
#[derive(Clone, Copy, Debug)]
pub enum GrammarProcessingDirection {
    /// Breadth first means it first iterates once through an entire stream - only making initial replacements, but not processing their values yet.
    /// It then is able to apply the next iteration - until it either reaches a maximum depth or stabilizes.
    BreadthFirst,
    /// Depth first means it goes in sequence through the stream, and each time it is able to make a replacement it replaces it as far as it can go.
    /// This will not evolve, and cannot detect new emergent patterns in a stream, but can be very effective for specific contexts like text generation.
    DepthFirst,
}

impl Default for GrammarProcessingDirection {
    fn default() -> Self {
        Self::BreadthFirst
    }
}

/// This trait defines a random number generator capable of choosing a single item from a list of len usize.
/// It is used for selecting a rule for using when multiple rules are available.
pub trait GrammarRandomNumberGenerator {
    /// This function provides a random number between 0 and len
    fn get_number(&mut self, len: usize) -> usize;
}

impl<T: FnMut(usize) -> usize> GrammarRandomNumberGenerator for T {
    fn get_number(&mut self, len: usize) -> usize {
        if len == 0 {
            return 0;
        }
        self(len)
    }
}

impl GrammarRandomNumberGenerator for usize {
    fn get_number(&mut self, _: usize) -> usize {
        *self
    }
}

/// This trait defines an interface for a grammar
pub trait Grammar<
    RuleKeyType: Clone + PartialEq + Debug,
    ResultType: Clone + PartialEq + Debug,
    StreamType: Clone + PartialEq + Debug,
>
{
    /// Gets a Vec of all the possible rule keys - can be used to see if any match
    fn rule_keys(&self) -> &Vec<RuleKeyType>;
    /// Checks if a given rule key is available
    fn has_rule(&self, rule: &RuleKeyType) -> bool;
    /// Gets all the possible expansions from a rule key
    fn get_rule_options(&self, rule: &RuleKeyType) -> Option<&Vec<ResultType>>;
    /// Gets the default starting key - used if no other key is set
    fn default_starting_point(&self) -> &RuleKeyType;

    /// Parses a token stream and determines a) whether there are any tokens to replace and b) if so, which
    /// The bool is true if there are no more tokens that need replacing
    fn check_token_stream(
        &self,
        stream: &StreamType,
    ) -> (bool, Vec<Replacable<RuleKeyType, ResultType>>);

    /// Selects an element from a rule's options. provides a default implementation in case no weighting is ncessessary.
    /// The RNG function should accept the total number of options, and return a single id (a number less than the total). If it is larger, we will use the last element.
    fn select_from_rule<R: GrammarRandomNumberGenerator>(
        &self,
        rule: &RuleKeyType,
        rng: &mut R,
    ) -> Option<&ResultType> {
        if let Some(options) = self.get_rule_options(rule) {
            let len = options.len();
            let max = len.checked_sub(1).unwrap_or_default();
            let rng = rng.get_number(len);
            let index = max.min(rng);
            options.get(index)
        } else {
            None
        }
    }

    /// Converts a rule key to a default result, in case no matching rule is found in the grammar.
    fn rule_to_default_result(&self, rule: &RuleKeyType) -> ResultType;

    /// Converts a group of result types to a stream type
    fn result_to_stream(&self, result: &[ResultType]) -> StreamType;

    /// Converts a stream to a vec of result type
    fn stream_to_result(&self, stream: &StreamType) -> Vec<ResultType>;

    /// determines if the grammar should be processed breadth-first or depth-first
    fn processing_direction(&self) -> GrammarProcessingDirection;

    /// This is a function for setting a new rule. The expectation is that it overrides the original.
    fn set_additional_rules(&mut self, rule: RuleKeyType, values: &[ResultType]);

    /// This is used to clone all the roles from another grammar into this one. This is used by stateful generators to update their state.
    fn copy_and_replace_rules(&mut self, other: &Self) {
        for rule in other.rule_keys() {
            if let Some(values) = other.get_rule_options(rule) {
                let rule = rule.clone();
                self.set_additional_rules(rule, values);
            }
        }
    }

    /// Provides the maximum depth (number of iterations) allowed for the generator. It will always quit early if it stabilizes,
    /// but otherwise it will conclude when it reaches the provided depth.
    fn max_depth(&self) -> usize {
        50
    }

    /// Takes a token stream, checks it for replacements, and then applies them by using select from rule.
    /// It returns a bool indicating whether it had to make any replacements this round, and a vec of the results.
    fn process_stream<R: GrammarRandomNumberGenerator>(
        &self,
        stream: &StreamType,
        rng: &mut R,
        temporary_grammar: &mut Self,
    ) -> StreamType {
        match self.processing_direction() {
            GrammarProcessingDirection::BreadthFirst => {
                self.breadth_first_processing(stream, temporary_grammar, rng)
            }
            GrammarProcessingDirection::DepthFirst => {
                self.depth_first_processing(stream, temporary_grammar, rng)
            }
        }
    }

    /// Processes a stream breadth first, regardless of the settings of the grammar
    fn breadth_first_processing<R: GrammarRandomNumberGenerator>(
        &self,
        stream: &StreamType,
        temporary_grammar: &mut Self,
        rng: &mut R,
    ) -> StreamType {
        let max_depth = self.max_depth();
        let (skippable, initial) = self.check_token_stream(stream);
        if skippable {
            return stream.clone();
        }

        let mut queue: Vec<(
            Option<RuleKeyType>,
            Vec<Replacable<RuleKeyType, ResultType>>,
        )> = vec![(None, initial)];
        let mut append_to_queue = vec![];
        let mut depth = 0;
        let mut result = stream.clone();
        let mut tmp_result = None;
        while let Some((target, current)) = queue.pop() {
            let next = current
                .into_iter()
                .filter_map(|token| {
                    let result = match token {
                        Replacable::Ready(v) => Some(v),
                        Replacable::Replace(key) => {
                            if let Some(result) = temporary_grammar.select_from_rule(&key, rng) {
                                Some(result.clone())
                            } else if let Some(result) = self.select_from_rule(&key, rng) {
                                Some(result.clone())
                            } else {
                                Some(self.rule_to_default_result(&key))
                            }
                        }
                        Replacable::ImmediateMeta(key, value) => {
                            let stream = self.result_to_stream(&[value.clone()]);
                            let (skippable, replaceables) = self.check_token_stream(&stream);
                            if skippable {
                                temporary_grammar.set_additional_rules(key, &[value]);
                            } else {
                                append_to_queue.push((Some(key), replaceables));
                            }
                            None
                        }
                        Replacable::DelayedMeta(key, value) => {
                            temporary_grammar.set_additional_rules(key, &[value]);
                            None
                        }
                    };
                    result
                })
                .collect::<Vec<_>>();

            let next = self.result_to_stream(&next);

            if let Some(target) = &target {
                if let Some(tmp) = &tmp_result {
                    if tmp == &next {
                        temporary_grammar
                            .set_additional_rules(target.clone(), &self.stream_to_result(&next));
                        tmp_result = None;
                        continue;
                    }
                }
                tmp_result = Some(next.clone());
            } else if result == next {
                break;
            } else {
                result = next.clone();
            }

            depth += 1;
            if depth >= max_depth {
                break;
            }

            let (skippable, next) = self.check_token_stream(&next);
            if skippable {
                if let (Some(target), Some(tmp)) = (&target, tmp_result) {
                    temporary_grammar
                        .set_additional_rules(target.clone(), &self.stream_to_result(&tmp));
                    tmp_result = None;
                    continue;
                } else {
                    break;
                }
            }
            queue.push((target, next));
            queue.append(&mut append_to_queue);
        }
        result
    }

    /// Processes a stream depth first, regardless of the settings of the grammar
    fn depth_first_processing<R: GrammarRandomNumberGenerator>(
        &self,
        stream: &StreamType,
        temporary_grammar: &mut Self,
        rng: &mut R,
    ) -> StreamType {
        let max_depth = self.max_depth();
        let (skippable, initial) = self.check_token_stream(stream);
        if skippable {
            return stream.clone();
        }

        let mut queue: Vec<(Option<RuleKeyType>, Replacable<RuleKeyType, ResultType>)> =
            initial.into_iter().map(|v| (None, v)).collect();
        queue.reverse();
        let mut results: Vec<(Option<RuleKeyType>, Vec<ResultType>)> = vec![(None, vec![])];
        let mut depth = 0;
        while let Some((target, item)) = queue.pop() {
            if results.len() > 1 {
                let mut remove_last_result = false;

                if let Some(last_result) = results.last() {
                    if last_result.0 != target {
                        remove_last_result = true;
                    }
                }

                if remove_last_result {
                    if let Some((Some(target), values)) = results.pop() {
                        // This two way conversion allows a grammar to potentially collapse multiple values into a single one,
                        // if that is the desired result.
                        let stream = self.result_to_stream(&values);
                        let values = self.stream_to_result(&stream);

                        temporary_grammar.set_additional_rules(target, &values);
                    }
                }
            }

            let mut create_new_result_stream = None;

            match item {
                Replacable::Ready(value) => {
                    if let Some(stream) = results.last_mut() {
                        stream.1.push(value);
                    }
                }
                Replacable::Replace(key) => {
                    let result = if let Some(result) = temporary_grammar.select_from_rule(&key, rng)
                    {
                        result.clone()
                    } else if let Some(result) = self.select_from_rule(&key, rng) {
                        result.clone()
                    } else {
                        self.rule_to_default_result(&key)
                    };
                    let result = self.result_to_stream(&[result]);
                    let (_, mut next) = self.check_token_stream(&result);
                    next.reverse();
                    for item in next.into_iter() {
                        queue.push((target.clone(), item));
                    }
                }
                Replacable::ImmediateMeta(key, result) => {
                    let result = self.result_to_stream(&[result.clone()]);
                    create_new_result_stream = Some(key.clone());
                    let (_, mut next) = self.check_token_stream(&result);
                    next.reverse();
                    for item in next.into_iter() {
                        queue.push((Some(key.clone()), item));
                    }
                }
                Replacable::DelayedMeta(key, value) => {
                    temporary_grammar.set_additional_rules(key.clone(), &[value.clone()]);
                }
            }

            if let Some(key) = create_new_result_stream {
                results.push((Some(key), vec![]));
            }
            depth += 1;
            if depth >= max_depth {
                break;
            }
        }
        if let Some(result) = results.first() {
            self.result_to_stream(&result.1)
        } else {
            stream.clone()
        }
    }
}

/// This trait represents a stateless generator. You pass the grammar & rng in, and it can provide the resulting stream.
pub trait Generator<
    RuleKeyType: Clone + PartialEq + Debug,
    GrammarResultType: Clone + PartialEq + Debug,
    StreamType: Clone + PartialEq + Debug,
    GrammarType: Grammar<RuleKeyType, GrammarResultType, StreamType>,
>
{
    /// This function generates a new value of `StreamType`, starting from the grammar's default rule
    fn generate<R: GrammarRandomNumberGenerator>(
        grammar: &GrammarType,
        rng: &mut R,
    ) -> Option<StreamType>;

    /// This function generates a new value of `StreamType`, starting from a provided rule key
    fn generate_at<R: GrammarRandomNumberGenerator>(
        key: &RuleKeyType,
        grammar: &GrammarType,
        rng: &mut R,
    ) -> Option<StreamType>;

    /// This function generates a new value of `StreamType`, starting by processing an initial input of `StreamType`
    fn expand_from<R: GrammarRandomNumberGenerator>(
        initial: &StreamType,
        grammar: &GrammarType,
        rng: &mut R,
    ) -> StreamType;
}

/// This enum helps handling complex meta-commands within a stream.
pub enum MetaRuleProcessingResult<RuleKey, GrammarResultType, StreamType> {
    /// This is just content
    Raw(StreamType),
    /// This will immediately process the result of the command, so the processed result is consistent when the new rule is used
    ImmediateMeta(RuleKey, StreamType),
    /// This will store the result directly in the ruleset, and process it only when called - allowing for multiple possible results
    DelayedMeta(RuleKey, GrammarResultType),
}

/// This trait represents a stateful generator. Here the generator owns the grammar, allowing it to make adjustments as needed.
pub trait StatefulGenerator<
    RuleKeyType: Clone + PartialEq + Debug,
    GrammarResultType: Clone + PartialEq + Debug,
    StreamType: Clone + PartialEq + Debug,
    GrammarType: Grammar<RuleKeyType, GrammarResultType, StreamType>,
>
{
    /// This sets the used grammar
    fn set_grammar(&mut self, grammar: &GrammarType);
    /// This gets an immutable reference to the grammar
    fn get_grammar(&self) -> &GrammarType;
    /// This gets a mutable reference to the grammar
    fn get_grammar_mut(&mut self) -> &mut GrammarType;

    /// This function generates a new value of `StreamType`, starting from the grammar's default rule
    fn generate<R: GrammarRandomNumberGenerator>(&mut self, rng: &mut R) -> Option<StreamType>;

    /// This function generates a new value of `StreamType`, starting from a provided rule key
    fn generate_at<R: GrammarRandomNumberGenerator>(
        &mut self,
        key: &RuleKeyType,
        rng: &mut R,
    ) -> Option<StreamType>;

    /// This function generates a new value of `StreamType`, starting by processing an initial input of `StreamType`
    fn expand_from<R: GrammarRandomNumberGenerator>(
        &mut self,
        initial: &StreamType,
        rng: &mut R,
    ) -> StreamType;
}