sixu 0.14.1

Experimental Visual Novel Scripting Language
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

use std::collections::HashMap;

use crate::error::{Result, RuntimeError};
use crate::format::{Literal, Story};

use super::ExecutionState;

/// Loop control signal for `#break` and `#continue` system calls
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum LoopControl {
    /// Break out of the current loop
    Break,
    /// Skip the rest of the current iteration and re-evaluate the loop condition
    Continue,
}

/// Runtime context that holds the execution state and data
#[derive(Debug, Clone)]
pub struct RuntimeContext {
    /// Loaded stories
    stories: Vec<Story>,
    /// Current execution state stack
    stack: Vec<ExecutionState>,
    /// Game session variables
    archive_variables: Literal,
    /// Permanent variables
    global_variables: Literal,
    /// Pending loop control signal
    loop_control: Option<LoopControl>,
}

impl Default for RuntimeContext {
    fn default() -> Self {
        Self {
            stories: Vec::new(),
            stack: Vec::new(),
            archive_variables: Literal::Object(Default::default()),
            global_variables: Literal::Object(Default::default()),
            loop_control: None,
        }
    }
}

impl RuntimeContext {
    pub fn new() -> Self {
        Self::default()
    }

    pub fn stories(&self) -> &Vec<Story> {
        &self.stories
    }

    pub fn stories_mut(&mut self) -> &mut Vec<Story> {
        &mut self.stories
    }

    pub fn stack(&self) -> &Vec<ExecutionState> {
        &self.stack
    }

    pub fn stack_mut(&mut self) -> &mut Vec<ExecutionState> {
        &mut self.stack
    }

    pub fn archive_variables(&self) -> &Literal {
        &self.archive_variables
    }

    pub fn archive_variables_mut(&mut self) -> &mut Literal {
        &mut self.archive_variables
    }

    pub fn global_variables(&self) -> &Literal {
        &self.global_variables
    }

    pub fn global_variables_mut(&mut self) -> &mut Literal {
        &mut self.global_variables
    }

    pub fn current_paragraph_locals(&self) -> Option<&HashMap<String, Literal>> {
        self.stack.iter().rev().find_map(|state| state.locals.as_ref())
    }

    pub fn current_paragraph_locals_mut(&mut self) -> Option<&mut HashMap<String, Literal>> {
        self.stack
            .iter_mut()
            .rev()
            .find_map(|state| state.locals.as_mut())
    }

    pub fn get_local(&self, name: &str) -> Option<&Literal> {
        self.current_paragraph_locals()
            .and_then(|locals| locals.get(name))
    }

    pub fn set_local(&mut self, name: String, value: Literal) -> Result<()> {
        let locals = self
            .current_paragraph_locals_mut()
            .ok_or(RuntimeError::ParagraphScopeUnavailable)?;
        locals.insert(name, value);
        Ok(())
    }

    pub fn set_locals(&mut self, variables: HashMap<String, Literal>) -> Result<()> {
        let locals = self
            .current_paragraph_locals_mut()
            .ok_or(RuntimeError::ParagraphScopeUnavailable)?;
        locals.extend(variables);
        Ok(())
    }

    /// Set a loop control signal
    pub fn set_loop_control(&mut self, control: LoopControl) {
        self.loop_control = Some(control);
    }

    /// Take the pending loop control signal (if any), clearing it
    pub fn take_loop_control(&mut self) -> Option<LoopControl> {
        self.loop_control.take()
    }
}