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
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
use rand::thread_rng;
use rand::Rng;
use std::collections::HashMap;
use std::sync::Arc;
use std::sync::RwLock;

use super::Generator;

/// The maximum number of repetitions for the Many and Many1 Generators
const MANY_MAX: usize = 5;
/// The maximum number of repetitions for the SepBy and SepBy1 Generators
const SEP_BY_MAX: usize = 5;
/// The maximum number of repetitions for the negation of the RepeatN
/// Generator
const REPEAT_MAX: usize = 5;

/// Choice is a Generator that will pick one of the Generators specified in
///2its choices. Each call to the generate method may return a value from a
/// different Generator
#[derive(Debug)]
pub struct Choice {
    pub choices: Vec<Box<Generator>>,
}

impl Generator for Choice {
    fn generate(&self) -> Vec<u8> {
        trace!("generate Choice");
        match thread_rng().choose(&self.choices) {
            Some(generator) => generator.generate(),
            None => panic!("no choices specified"),
        }
    }

    fn negate(&self) -> Vec<u8> {
        trace!("negate Choice");
        // must match any of of choices, except one, or anything not a choice
        match self.choices.len() {
            0 => vec![], // TODO: generate something non-empty
            1 => self.choices[0].negate(),
            _ => {
                let generate_nothing = thread_rng().gen();
                if generate_nothing {
                    vec![]
                } else {
                    vec![]
                }
            }
        }
    }
}

/// choice is a helper to create a Choice Generator. There is also a macro
/// that generates the Vec and Boxes the individual generators being passed
/// as choices for brevity and simplicity
pub fn choice(choices: Vec<Box<Generator>>) -> impl Generator {
    Choice { choices: choices }
}

/// Many is a Generator that will generate 0 or more values of its generator
#[derive(Debug)]
pub struct Many {
    pub generator: Box<Generator>,
}

impl Generator for Many {
    fn generate(&self) -> Vec<u8> {
        trace!("generate Many");
        let num = thread_rng().gen_range(0, MANY_MAX);
        (0..num).flat_map(|_| self.generator.generate()).collect()
    }

    fn negate(&self) -> Vec<u8> {
        trace!("negate Many");
        // generate nothing or the negation of generator 0..MANY_MAX times
        let num = thread_rng().gen_range(0, MANY_MAX);
        (0..num).flat_map(|_| self.generator.negate()).collect()
    }
}

/// many is a helper to create a Many Generator
pub fn many(generator: impl Generator + 'static) -> impl Generator {
    Many {
        generator: Box::new(generator),
    }
}

/// Many1 is a Generator that will generate 1 or more values of its generator
#[derive(Debug)]
pub struct Many1 {
    pub generator: Box<Generator>,
}

impl Generator for Many1 {
    fn generate(&self) -> Vec<u8> {
        trace!("generate Many1");
        let num = thread_rng().gen_range(1, MANY_MAX);
        (0..num).flat_map(|_| self.generator.generate()).collect()
    }

    fn negate(&self) -> Vec<u8> {
        trace!("negate Many1");
        // generate nothing or the negation of generator 0..MANY_MAX times
        let num: usize = thread_rng().gen_range(0, MANY_MAX);
        (0..num).flat_map(|_| self.generator.negate()).collect()
    }
}

/// many1 is a helper to create a Many1 Generator
pub fn many1(generator: impl Generator + 'static) -> impl Generator {
    Many1 {
        generator: Box::new(generator),
    }
}

/// Optional is a Generator that will optionally choose to generate exactly 1
/// of its generator or and empty value
#[derive(Debug)]
pub struct Optional {
    pub generator: Box<Generator>,
}

impl Generator for Optional {
    fn generate(&self) -> Vec<u8> {
        trace!("generate Optional");
        if thread_rng().gen() {
            self.generator.generate()
        } else {
            vec![]
        }
    }

    fn negate(&self) -> Vec<u8> {
        trace!("negate Optional");
        if thread_rng().gen() {
            self.generator.negate()
        } else {
            vec![]
        }
    }
}

/// optional is a helper to create an Optional Generator
pub fn optional(generator: impl Generator + 'static) -> impl Generator {
    Optional {
        generator: Box::new(generator),
    }
}

/// Rule is a Generator for invoking a named rule Generator. This is useful
/// for implementing recursion and avoiding duplication of portions of a
/// grammar.
///
/// Only names that have already been registered should be used. If a
/// corresponding rule does not exist when generate is called it will panic.
#[derive(Debug)]
pub struct Rule {
    pub rules: Arc<RwLock<HashMap<String, Box<Generator>>>>,
    pub name: String,
}

impl Generator for Rule {
    fn generate(&self) -> Vec<u8> {
        trace!("generate Rule {}", self.name);
        let rules = self.rules.read().unwrap();
        match rules.get(&self.name) {
            Some(generator) => generator.generate(),
            None => panic!("rule '{}' does not exist", self.name),
        }
    }

    fn negate(&self) -> Vec<u8> {
        trace!("negate Rule {}", self.name);
        // invoke the negation of the rule
        let rules = self.rules.read().unwrap();
        match rules.get(&self.name) {
            Some(generator) => generator.negate(),
            None => panic!("rule '{}' does not exist", self.name),
        }
    }
}

/// rule is a helper to create a Rule Generator
pub fn rule<S>(name: S, rules: Arc<RwLock<Rules>>) -> impl Generator
where
    S: Into<String>,
{
    Rule {
        name: name.into(),
        rules: rules,
    }
}

/// register_rule associates a tree of Generators to a name that can be
/// later used with the Rule Generator. A rule must always be registered
/// before a Rule Generator is executed otherwise it will lead to a panic
/// due to an unknown rule. Rule names are case sensitive and must be unique.
/// Attempting to register two rules with the same name will result in the
/// last one being registered being used. This can lead to unexpected
/// behavior.
pub fn register_rule<S>(rules: &Arc<RwLock<Rules>>, name: S, rule: impl Generator + 'static)
where
    S: Into<String>,
{
    let mut rules = rules.write().unwrap();
    rules.insert(name.into(), Box::new(rule));
}

/// Rules stores a map of rule name to the tree of Generators. For
/// multithreaded applications this should be wrapped in an Arc<Mutex<T>>
/// to provide safe access. Realistically, as long as all rules are added
/// before generation begins, locking should be unecessary
pub type Rules = HashMap<String, Box<Generator>>;

/// Sequence is a Generator that generates all of its generators in the order
/// in which they are specified. This is useful for sequences of specific
/// bytes or chars but when multiple tokens are desired JoinWith is likely
/// more helpful
#[derive(Debug)]
pub struct Sequence {
    pub generators: Vec<Box<Generator>>,
}

impl Generator for Sequence {
    fn generate(&self) -> Vec<u8> {
        trace!("generate Sequence");
        self.generators.iter().flat_map(|g| g.generate()).collect()
    }

    fn negate(&self) -> Vec<u8> {
        trace!("negate Sequence");
        self.generators.iter().flat_map(|g| g.negate()).collect()
    }
}

/// seq is a helper to create a Sequence Generator. This is also a macro that
/// handles creating the Vec and boxing the individual Generators being
/// specified for brevity and simplicity
pub fn seq(generators: Vec<Box<Generator>>) -> impl Generator {
    Sequence {
        generators: generators,
    }
}

/// RepeastN is a Generator that will product the specified Generator between
/// 0 and n times
#[derive(Debug)]
pub struct RepeatN {
    pub n: usize,
    pub generator: Box<Generator>,
}

impl Generator for RepeatN {
    fn generate(&self) -> Vec<u8> {
        trace!("generate RepeatN");
        (0..self.n)
            .flat_map(|_| self.generator.generate())
            .collect()
    }

    fn negate(&self) -> Vec<u8> {
        trace!("negate RepeatN");
        // repeats any number except n times
        let mut repetitions = thread_rng().gen_range(0, REPEAT_MAX);
        if repetitions == self.n {
            repetitions += 1;
        }

        (0..repetitions)
            .flat_map(|_| self.generator.negate())
            .collect()
    }
}

/// repeat_n is a helper to create a RepeatN Generator
pub fn repeat_n(generator: impl Generator + 'static, n: usize) -> impl Generator {
    RepeatN {
        n: n,
        generator: Box::new(generator),
    }
}

/// Range is a Generator that will produce the specified Generator between n
/// and m times
#[derive(Debug)]
pub struct Range {
    pub n: usize,
    pub m: usize,
    pub generator: Box<Generator>,
}

impl Generator for Range {
    fn generate(&self) -> Vec<u8> {
        trace!("repeat Range");
        let times = thread_rng().gen_range(self.n, self.m);
        (self.n..times)
            .flat_map(|_| self.generator.generate())
            .collect()
    }

    fn negate(&self) -> Vec<u8> {
        unimplemented!()
    }
}

/// range is a helper to create a Range Generator
pub fn range(generator: impl Generator + 'static, n: usize, m: usize) -> impl Generator {
    Range {
        n: n,
        m: m,
        generator: Box::new(generator),
    }
}

/// JoinWith is a Generator that joins a list of Generators with the
/// specified Generator as the delimiter. In the case of the only one
/// Generator being specified in the list no delimiter will be added. This is
/// particularly useful when attempting to match tokens or desiring that
/// be a separator (eg. some whitespace) between them. In that case this
/// should be used instead of Sequence so specify the sequence of tokens for
/// a rule.
#[derive(Debug)]
pub struct JoinWith {
    pub generators: Vec<Box<Generator>>,
    pub delimiter: Box<Generator>,
}

impl Generator for JoinWith {
    fn generate(&self) -> Vec<u8> {
        trace!("generate JoinWith");
        let mut first = true;
        self.generators
            .iter()
            .flat_map(|g| {
                let mut value = g.generate();
                if !first {
                    let mut d = self.delimiter.generate();
                    d.extend(value);
                    value = d;
                } else {
                    first = false;
                }
                value
            })
            .collect()
    }

    fn negate(&self) -> Vec<u8> {
        unimplemented!()
    }
}

/// join_with is a helper to create a JoinWith Generator. This is also a
/// macro that handles creating the Vec and boxing the individual Generators
/// being specified for brevity and simplicity

pub fn join_with(
    generators: Vec<Box<Generator>>,
    delimiters: impl Generator + 'static,
) -> impl Generator {
    JoinWith {
        generators: generators,
        delimiter: Box::new(delimiters),
    }
}

/// SepBy is a Generator that will repeat the generator 0 or more times
/// separated by the specified separator. A single match will result in no
/// separator being present, only there there is more than one
#[derive(Debug)]
pub struct SepBy {
    pub generator: Box<Generator>,
    pub separator: Box<Generator>,
}

impl Generator for SepBy {
    fn generate(&self) -> Vec<u8> {
        trace!("generate SepBy");
        let limit = thread_rng().gen_range(0, SEP_BY_MAX);

        let mut first = true;
        (0..limit)
            .flat_map(|_| {
                let mut value = self.generator.generate();
                if first {
                    first = false;
                } else {
                    let mut separator = self.separator.generate();
                    separator.extend(self.generator.generate());
                    value = separator;
                }

                value
            })
            .collect()
    }

    fn negate(&self) -> Vec<u8> {
        unimplemented!()
    }
}

/// sep_by is a helper to create a SepBy Generator
pub fn sep_by(
    generator: impl Generator + 'static,
    separator: impl Generator + 'static,
) -> impl Generator {
    SepBy {
        generator: Box::new(generator),
        separator: Box::new(separator),
    }
}

/// SepBy is a Generator that will repeat the generator 1 or more times
/// separated by the specified separator. A single match will result in no
/// separator being present, only there there is more than one
#[derive(Debug)]
pub struct SepBy1 {
    pub generator: Box<Generator>,
    pub separator: Box<Generator>,
}

impl Generator for SepBy1 {
    fn generate(&self) -> Vec<u8> {
        trace!("generate SepBy1");
        let limit = thread_rng().gen_range(1, SEP_BY_MAX);

        let mut first = true;
        (0..limit)
            .flat_map(|_| {
                let mut value = self.generator.generate();
                if first {
                    first = false;
                } else {
                    let mut separator = self.separator.generate();
                    separator.extend(self.generator.generate());
                    value = separator;
                }

                value
            })
            .collect()
    }

    fn negate(&self) -> Vec<u8> {
        unimplemented!()
    }
}

/// sep_by1 is a helper to create a SepBy1 Generator
pub fn sep_by1(
    generator: impl Generator + 'static,
    separator: impl Generator + 'static,
) -> impl Generator {
    SepBy1 {
        generator: Box::new(generator),
        separator: Box::new(separator),
    }
}

/// Not is a generator that will return the negation of it's generator. The
/// implemenation is dependent on the negate implementation for all other
/// generators
#[derive(Debug)]
pub struct Not {
    pub generator: Box<Generator>,
}

impl Generator for Not {
    fn generate(&self) -> Vec<u8> {
        trace!("generate Not");
        self.generator.negate()
    }

    fn negate(&self) -> Vec<u8> {
        trace!("negate Not");
        self.generator.generate()
    }
}

/// not is a helper to generate a Not Generator
pub fn not(generator: impl Generator + 'static) -> impl Generator {
    Not {
        generator: Box::new(generator),
    }
}

#[macro_export]
macro_rules! choice {
    ( $( $x:expr ),* ) => {
        choice(vec![
            $(Box::new($x)),*
        ]);
    };
}

#[macro_export]
macro_rules! seq {
    ( $( $x:expr ),* ) => {
        seq(vec![
            $(Box::new($x)),*
        ]);
    };
}

#[macro_export]
macro_rules! join_with {
    ( $delimiter:expr, $( $x:expr ),* ) => {
        join_with(vec![
            $(Box::new($x)),*
        ], $delimiter);
    }
}

#[cfg(test)]
mod test {
    use regex::Regex;

    use super::*;
    use value::byte;

    #[test]
    fn generate_choice() {
        let generator = choice!(byte(0x41), byte(0x42));
        let generated = generator.generate();
        assert!(generated == vec![0x41] || generated == vec![0x42]);
    }

    #[test]
    fn negate_choice() {
        let generator = choice!(byte(0x41), byte(0x42));
        let generated = generator.negate();
        assert!(generated != vec![0x41] && generated != vec![0x42]);
    }

    #[test]
    fn generate_many() {
        let generator = many(byte(0x41));
        let generated = generator.generate();
        let generated_string = String::from_utf8_lossy(&generated);
        // assured that the len will always be >= 0 due to usize constraints
        assert!(generated.len() < MANY_MAX);
        let r = Regex::new(r"\AA*\z").unwrap();
        assert!(r.is_match(&generated_string));
    }

    #[test]
    fn negate_many() {
        let generator = many(byte(0x41));
        let generated = generator.negate();
        let generated_string = String::from_utf8_lossy(&generated);
        // assured that the len will always be >= 0 due to usize constraints
        assert!(generated.len() < MANY_MAX);
        let r = Regex::new(r"\A[^A]*\z").unwrap();
        assert!(r.is_match(&generated_string));
    }

    #[test]
    fn generate_many1() {
        let generator = many1(byte(0x41));
        let generated = generator.generate();
        let generated_string = String::from_utf8_lossy(&generated);
        assert!(generated.len() > 0 && generated.len() < MANY_MAX);
        let r = Regex::new(r"\AA+\z").unwrap();
        assert!(r.is_match(&generated_string));
    }

    #[test]
    fn negate_many1() {
        let generator = many1(byte(0x41));
        let generated = generator.negate();
        let generated_string = String::from_utf8_lossy(&generated);
        // assured that the len will always be >= 0 due to usize constraints
        assert!(generated.len() < MANY_MAX);
        let r = Regex::new(r"\A[^A]*\z").unwrap();
        assert!(r.is_match(&generated_string));
    }

    #[test]
    fn generate_optional() {
        let generator = optional(byte(0x41));
        let generated = generator.generate();
        assert!(generated.len() < 2);
        if generated.len() > 0 {
            assert!(generated == vec![0x41]);
        }
    }

    #[test]
    fn negate_optional() {
        let generator = optional(byte(0x41));
        let generated = generator.negate();
        assert!(generated.len() < 2);
        if generated.len() > 0 {
            assert_ne!(generated, vec![0x41]);
        }
    }

    #[test]
    fn generate_rule() {
        let rules = Arc::new(RwLock::new(HashMap::new()));
        let the_rule = byte(0x41);
        register_rule(&rules, "rule", the_rule);
        let generator = rule("rule", rules);
        let generated = generator.generate();
        assert!(generated == vec![0x41]);
    }

    #[test]
    fn negate_rule() {
        let rules = Arc::new(RwLock::new(HashMap::new()));
        let the_rule = byte(0x41);
        register_rule(&rules, "rule", the_rule);
        let generator = rule("rule", rules);
        let generated = generator.negate();
        assert_ne!(generated, vec![0x41]);
    }

    #[test]
    fn generate_repeatn() {
        let generator = repeat_n(byte(0x41), 5);
        let generated = generator.generate();
        assert!(generated == vec![0x41, 0x41, 0x41, 0x41, 0x41]);
    }

    #[test]
    fn negate_repeatn() {
        let generator = repeat_n(byte(0x41), 5);
        let generated = generator.negate();
        assert_ne!(generated, vec![0x41, 0x41, 0x41, 0x41, 0x41]);
    }

    #[test]
    fn generate_not() {
        let generator = not(byte(0x41));
        let generated = generator.generate();
        assert_ne!(generated, vec![0x41]);
    }

    #[test]
    fn negate_not() {
        let generator = not(byte(0x41));
        let generated = generator.negate();
        assert!(generated == vec![0x41]);
    }
}