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
646
647
648
649
650
use crate::line::ParsedLine;

use super::node::{DialogueNode, NodeItem, NodeType};

/// Used to parse the input lines from beginning to end, returning the constructed `DialogueNode`.
pub fn parse_full_node(lines: &[ParsedLine]) -> DialogueNode {
    let mut items = Vec::new();

    let mut index = 0;

    while index < lines.len() {
        let line = &lines[index];

        match line {
            ParsedLine::Line(line) => {
                let item = NodeItem::Line(line.clone());
                items.push(item);
            }
            ParsedLine::Choice { level, .. } => {
                let (item, gather) = parse_choice_set_with_gather(&mut index, *level, lines);
                items.push(item);

                if let Some(line) = gather {
                    items.push(line);

                    // `parse_choice_set_with_gather` advances the index to the next line
                    // after this group if a gather was found, but this loop also does that
                    // at every iteration. Retract the index once to compensate.
                    index -= 1;
                }
            }
            ParsedLine::Gather { line, .. } => {
                let item = NodeItem::Line(line.clone());
                items.push(item);
            }
        };

        index += 1;
    }

    DialogueNode::with_items(items)
}

/// After parsing a group of choices, check whether it ended because of a `Gather`.
/// If so, return the `NodeItem::Line` object from that gather so that it can be appended
/// *after* the node, not inside it.
fn parse_choice_set_with_gather(
    index: &mut usize,
    current_level: u8,
    lines: &[ParsedLine],
) -> (NodeItem, Option<NodeItem>) {
    let node = parse_choice_set(index, current_level, lines);
    let mut gather = None;

    if let Some(ParsedLine::Gather { level, line }) = lines.get(*index) {
        if *level == current_level {
            gather.replace(NodeItem::Line(line.clone()));
            *index += 1;
        }
    }

    (node, gather)
}

/// Parse a set of `Choice`s with the same level, grouping them into a single `ChoiceSet`
/// node that is returned.
fn parse_choice_set(index: &mut usize, current_level: u8, lines: &[ParsedLine]) -> NodeItem {
    let mut choices = Vec::new();

    while let Some(choice) = parse_single_choice(index, current_level, lines) {
        choices.push(choice);
    }

    let node = DialogueNode::with_items(choices);

    NodeItem::Node {
        kind: NodeType::ChoiceSet,
        node: Box::new(node),
    }
}

/// Parse a single `Choice` node. The node ends either when another `Choice` node with
/// the same level or below is encountered, when a `Gather` with the same level or below
/// is encountered or when all lines are read.
fn parse_single_choice(
    index: &mut usize,
    current_level: u8,
    lines: &[ParsedLine],
) -> Option<NodeItem> {
    if *index >= lines.len() {
        return None;
    }

    let mut items = Vec::new();

    let head = &lines[*index];

    let choice = match head {
        ParsedLine::Choice { level, .. } if *level < current_level => {
            return None;
        }
        ParsedLine::Gather { level, .. } if *level <= current_level => {
            return None;
        }
        ParsedLine::Choice { choice, .. } => choice.clone(),
        _ => panic!(
            "could not correctly parse a `NodeItem` of type `Choice`: \
             expected first line to be a `ParsedLine::Choice` object, but was {:?}",
            &head
        ),
    };

    items.push(NodeItem::Line(choice.line.clone()));

    // This skips to the next index, where the choice's content or a new choice will appear
    *index += 1;

    while *index < lines.len() {
        let line = &lines[*index];

        match line {
            ParsedLine::Line(line) => {
                let item = NodeItem::Line(line.clone());
                items.push(item);
            }
            ParsedLine::Choice { level, .. } if *level == current_level => break,
            ParsedLine::Choice { level, .. } if *level > current_level => {
                let (multi_choice, gather) = parse_choice_set_with_gather(index, *level, lines);

                items.push(multi_choice);

                if let Some(line) = gather {
                    items.push(line);
                }

                // `parse_choice_set` advances the index to the next line after the group,
                // but this loop also does that at every iteration. Retract the index once
                // to compensate.
                *index -= 1;
            }
            ParsedLine::Choice { .. } => {
                break;
            }
            ParsedLine::Gather { level, .. } => {
                if *level <= current_level {
                    break;
                }
            }
        }

        *index += 1;
    }

    let node = DialogueNode::with_items(items);

    Some(NodeItem::Node {
        kind: NodeType::Choice(choice),
        node: Box::new(node),
    })
}

#[cfg(test)]
mod tests {
    use super::*;

    use std::str::FromStr;

    use crate::line::{
        choice::tests::ChoiceBuilder, line::tests::LineBuilder, ChoiceData, LineData,
    };

    #[test]
    fn parsing_choices_at_same_level_returns_when_encountering_other_choice() {
        let level = 1;
        let choice = get_empty_choice(level);

        let lines = vec![choice.clone(), choice.clone(), choice.clone()];

        let mut index = 0;

        let first = parse_single_choice(&mut index, level, &lines).unwrap();
        assert_eq!(index, 1);
        assert!(first.is_choice());
        assert_eq!(first.node().items.len(), 1);

        let second = parse_single_choice(&mut index, level, &lines).unwrap();
        assert_eq!(index, 2);
        assert!(second.is_choice());
        assert_eq!(second.node().items.len(), 1);

        let third = parse_single_choice(&mut index, level, &lines).unwrap();
        assert_eq!(index, 3);
        assert!(third.is_choice());
        assert_eq!(third.node().items.len(), 1);

        assert!(parse_single_choice(&mut index, level, &lines).is_none());
    }

    #[test]
    fn parsing_choice_sets_choice_line_in_items_if_not_empty() {
        let line = LineData::from_str("Choice line").unwrap();
        let choice = ChoiceBuilder::empty().with_line(line.clone()).build();
        let parsed_choice = ParsedLine::Choice { level: 1, choice };

        let lines = vec![parsed_choice];

        let mut index = 0;
        let node_item = parse_single_choice(&mut index, 0, &lines).unwrap();

        match node_item {
            NodeItem::Node { node, .. } => {
                assert_eq!(node.items.len(), 1);
            }
            _ => panic!(),
        }
    }

    #[test]
    fn parsing_choice_sets_choice_line_in_items_if_it_has_a_divert() {
        let line = LineBuilder::new("").with_divert("to_knot").build();
        let choice = ChoiceBuilder::empty().with_line(line.clone()).build();
        let parsed_choice = ParsedLine::Choice { level: 1, choice };

        let lines = vec![parsed_choice];

        let mut index = 0;
        let node_item = parse_single_choice(&mut index, 0, &lines).unwrap();

        match node_item {
            NodeItem::Node { node, .. } => {
                assert_eq!(node.items.len(), 1);
            }
            _ => panic!(),
        }
    }

    #[test]
    fn parsing_choice_returns_choice_data_in_root() {
        let text = "\"To Netherfield Park, then\", I exclaimed.";

        let line = LineData::from_str(text).unwrap();
        let choice = ChoiceBuilder::empty()
            .with_displayed(line.clone())
            .with_line(line.clone())
            .build();

        let input = ParsedLine::Choice {
            level: 1,
            choice: choice.clone(),
        };

        let lines = vec![input];

        let mut index = 0;

        match parse_single_choice(&mut index, 1, &lines).unwrap() {
            NodeItem::Node {
                kind: NodeType::Choice(parsed),
                ..
            } => {
                assert_eq!(parsed, choice);
            }
            _ => panic!("result not a `NodeItem::Node { kind: NodeType::Choice, .. }"),
        }
    }

    #[test]
    fn parsing_choices_adds_found_regular_lines_as_items() {
        let level = 1;
        let choice = get_empty_choice(level);
        let line = get_parsed_line("");

        let lines = vec![
            choice.clone(),
            line.clone(),
            line.clone(),
            choice.clone(),
            line.clone(),
        ];

        let mut index = 0;

        let first = parse_single_choice(&mut index, level, &lines).unwrap();
        let second = parse_single_choice(&mut index, level, &lines).unwrap();
        assert_eq!(index, 5);

        assert!(first.is_choice());
        assert_eq!(first.len(), 3);
        assert!(first.node().items[0].is_line());
        assert!(first.node().items[1].is_line());
        assert!(first.node().items[2].is_line());

        assert!(second.is_choice());
        assert_eq!(second.len(), 2);
        assert!(second.node().items[0].is_line());
        assert!(second.node().items[1].is_line());
    }

    #[test]
    fn parsing_choices_stops_when_a_lower_level_choice_is_encountered() {
        let choice1 = get_empty_choice(1);
        let choice2 = get_empty_choice(2);

        let lines = vec![choice2.clone(), choice2.clone(), choice1.clone()];

        let mut index = 0;

        assert!(parse_single_choice(&mut index, 2, &lines).is_some());
        assert!(parse_single_choice(&mut index, 2, &lines).is_some());
        assert!(parse_single_choice(&mut index, 2, &lines).is_none());

        assert_eq!(index, 2);
    }

    #[test]
    fn parsing_choice_set_returns_all_choices_with_nested_content() {
        let choice = get_empty_choice(1);
        let line1 = ParsedLine::Line(LineData::from_str("one").unwrap());
        let line2 = ParsedLine::Line(LineData::from_str("two").unwrap());
        let line3 = ParsedLine::Line(LineData::from_str("three").unwrap());

        let lines = vec![
            choice.clone(),
            line1.clone(),
            line2.clone(),
            choice.clone(),
            line3.clone(),
            choice.clone(),
        ];

        let mut index = 0;

        let root = parse_choice_set(&mut index, 1, &lines);

        assert_eq!(index, 6);
        assert!(root.is_choice_set());

        assert_eq!(root.len(), 3);

        for item in &root.node().items {
            assert!(item.is_choice());
        }

        assert_eq!(root[0].len(), 3);
        assert_eq!(root[1].len(), 2);
        assert_eq!(root[2].len(), 1);
    }

    #[test]
    fn parsing_choices_turns_nested_choices_into_choice_sets() {
        let choice1 = get_empty_choice(1);
        let choice2 = get_empty_choice(2);
        let lines = vec![choice1.clone(), choice2.clone()];

        let mut index = 0;

        let root = parse_single_choice(&mut index, 1, &lines).unwrap();

        assert!(root.is_choice());
        assert_eq!(index, 2);

        assert_eq!(root.len(), 2);
        assert!(root[1].is_choice_set());
        assert!(root[1][0].is_choice());
    }

    #[test]
    fn parsing_choice_set_returns_early_if_lower_level_choice_is_encountered() {
        let choice1 = get_empty_choice(1);
        let choice2 = get_empty_choice(2);

        let lines = vec![choice2.clone(), choice1.clone()];

        let mut index = 0;

        let root = parse_choice_set(&mut index, 2, &lines);

        assert_eq!(index, 1);
        assert_eq!(root.len(), 1);
    }

    #[test]
    fn parsing_choice_set_returns_handles_multiple_simultaneous_drops_in_level() {
        let choice2 = get_empty_choice(2);
        let choice3 = get_empty_choice(3);
        let choice4 = get_empty_choice(4);

        let lines = vec![
            choice2.clone(),
            choice3.clone(),
            choice4.clone(),
            choice2.clone(),
        ];

        let mut index = 0;

        let root = parse_choice_set(&mut index, 2, &lines);

        assert_eq!(index, 4);
        assert_eq!(root.len(), 2);
    }

    #[test]
    fn parsing_complex_nested_structure_works() {
        let choice1 = get_empty_choice(1);
        let choice2 = get_empty_choice(2);
        let choice3 = get_empty_choice(3);
        let choice4 = get_empty_choice(4);

        let line = get_parsed_line("");

        let lines = vec![
            choice1.clone(), // 0
            choice2.clone(),
            choice2.clone(),
            choice1.clone(), // 1
            choice2.clone(), //
            choice3.clone(),
            line.clone(),
            line.clone(),
            choice4.clone(),
            choice1.clone(), // 2
        ];

        let mut index = 0;

        let root = parse_choice_set(&mut index, 1, &lines);

        assert_eq!(index, 10);
        assert!(root.is_choice_set());

        // Assert that the level 3 choice has two lines and one final choice_set
        let node = &root[1][1][0][1][0];

        assert_eq!(node.len(), 4);
        assert!(node[0].is_line());
        assert!(node[1].is_line());
        assert!(node[2].is_line());
        assert!(node[3].is_choice_set());
    }

    #[test]
    fn choice_set_wrapper_adds_gather_line_if_present() {
        let choice1 = get_empty_choice(1);
        let gather1 = get_empty_gather(1);

        let lines_without_gather = vec![choice1.clone(), choice1.clone(), choice1.clone()];

        let mut index = 0;

        let (root, line) = parse_choice_set_with_gather(&mut index, 1, &lines_without_gather);

        assert!(root.is_choice_set());
        assert_eq!(root.len(), 3);
        assert!(line.is_none());

        let lines_with_gather = vec![
            choice1.clone(),
            choice1.clone(),
            gather1.clone(),
            choice1.clone(),
        ];

        index = 0;

        let (root, line) = parse_choice_set_with_gather(&mut index, 1, &lines_with_gather);

        assert!(root.is_choice_set());
        assert_eq!(root.len(), 2);
        assert!(line.unwrap().is_line());
    }

    #[test]
    fn choice_set_wrapper_increments_index_if_gather() {
        let choice1 = get_empty_choice(1);
        let gather1 = get_empty_gather(1);

        let lines_without_gather = vec![choice1.clone()];

        let mut index = 0;

        parse_choice_set_with_gather(&mut index, 1, &lines_without_gather);

        assert_eq!(index, 1);

        let lines_with_gather = vec![choice1.clone(), gather1.clone()];

        index = 0;

        parse_choice_set_with_gather(&mut index, 1, &lines_with_gather);

        assert_eq!(index, 2);
    }

    #[test]
    fn gathers_end_choice_sets_at_same_level() {
        let choice1 = get_empty_choice(1);
        let gather1 = get_empty_gather(1);

        let lines = vec![
            choice1.clone(),
            choice1.clone(),
            gather1.clone(),
            choice1.clone(),
        ];

        let mut index = 0;

        let root = parse_choice_set(&mut index, 1, &lines);

        assert_eq!(index, 2);
        assert_eq!(root.len(), 2);
    }

    #[test]
    fn multilevel_gather_check() {
        let choice1 = get_empty_choice(1);
        let choice2 = get_empty_choice(2);
        let gather1 = get_empty_gather(1);
        let gather2 = get_empty_gather(2);

        let lines = vec![
            choice1.clone(),
            choice1.clone(),
            choice2.clone(),
            choice2.clone(),
            gather2.clone(),
            choice2.clone(),
            choice2.clone(),
            choice1.clone(),
            gather1.clone(),
            choice1.clone(), // 9
        ];

        let mut index = 0;

        let (root, _) = parse_choice_set_with_gather(&mut index, 1, &lines);

        assert_eq!(index, 9);
        assert_eq!(root.len(), 3);
    }

    #[test]
    fn parse_node_with_two_initial_items_then_nest_into_a_choice_set() {
        let line = get_parsed_line("");
        let choice1 = get_empty_choice(1);

        let lines = vec![line.clone(), line.clone(), choice1.clone(), choice1.clone()];

        let root = parse_full_node(&lines);

        assert_eq!(root.items.len(), 3);
        assert!(root.items[0].is_line());
        assert!(root.items[1].is_line());
        assert!(root.items[2].is_choice_set());
    }

    #[test]
    fn parse_node_with_a_gather_adds_line() {
        let line = get_parsed_line("");
        let choice1 = get_empty_choice(1);
        let choice2 = get_empty_choice(2);
        let gather1 = get_empty_gather(1);
        let gather2 = get_empty_gather(2);

        let lines = vec![
            line.clone(),
            choice1.clone(), // ChoiceSet starts here as second level-1 element
            choice2.clone(), // First element of level-2 ChoiceSet
            choice2.clone(),
            gather2.clone(), // Breaks level-2 ChoiceSet; becomes second element
            choice1.clone(),
            gather2.clone(),
            choice1.clone(),
            gather1.clone(), // Breaks ChoiceSet; becomes third level-1 element
            choice1.clone(), // Fourth level-1 element due to gather
        ];

        let root = parse_full_node(&lines);

        assert_eq!(root.items.len(), 4);
        assert!(root.items[1].is_choice_set());
        assert!(root.items[2].is_line());
        assert!(root.items[3].is_choice_set());

        assert_eq!(root.items[1][0].len(), 3);
        assert!(root.items[1][0][2].is_line());
    }

    #[test]
    fn parse_empty_list_return_empty_node() {
        let root = parse_full_node(&[]);
        assert_eq!(root.items.len(), 0);
    }

    #[test]
    fn parse_list_with_only_choices_works() {
        let choice = get_empty_choice(1);
        let root = parse_full_node(&[choice.clone(), choice.clone(), choice.clone()]);

        assert_eq!(root.items.len(), 1);
        assert!(root.items[0].is_choice_set());
        assert_eq!(root.items[0].len(), 3);
    }

    #[test]
    fn parse_list_with_non_matched_gathers_turns_them_into_lines() {
        let gather = get_empty_gather(1);
        let root = parse_full_node(&[gather.clone(), gather.clone(), gather.clone()]);

        assert_eq!(root.items.len(), 3);

        for item in root.items {
            assert!(item.is_line());
        }
    }

    #[test]
    fn parse_list_with_high_leveled_choices_still_just_nests_them() {
        let choice1 = get_empty_choice(64);
        let choice2 = get_empty_choice(128);

        let root = parse_full_node(&[
            choice1.clone(),
            choice1.clone(),
            choice2.clone(),
            choice2.clone(),
            choice1.clone(),
        ]);

        assert_eq!(root.items.len(), 1);
        assert_eq!(root.items[0].len(), 3);
        assert_eq!(root.items[0][1][1].len(), 2);
    }

    pub fn get_empty_choice(level: u8) -> ParsedLine {
        let choice = ChoiceData::empty();
        ParsedLine::Choice { level, choice }
    }

    pub fn get_empty_gather(level: u8) -> ParsedLine {
        let line = LineData::from_str("").unwrap();

        ParsedLine::Gather { level, line }
    }

    pub fn get_parsed_line(s: &str) -> ParsedLine {
        ParsedLine::Line(LineData::from_str(s).unwrap())
    }
}