sixu 0.12.0

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

use crate::error::Result;
use crate::format::*;

use super::RuntimeContext;

/// Trait defining the executor behavior for runtime execution
pub trait RuntimeExecutor: Send + Sync {
    /// Handle a command line input, returns true if next line should be executed immediately
    fn handle_command(
        &mut self,
        ctx: &mut RuntimeContext,
        command_line: &ResolvedCommandLine,
    ) -> Result<bool>;
    /// Handle an extra system call line input, returns true if next line should be executed immediately
    fn handle_extra_system_call(
        &mut self,
        ctx: &mut RuntimeContext,
        systemcall_line: &ResolvedSystemCallLine,
    ) -> Result<bool>;
    /// Handle text output, returns true if next line should be executed immediately
    fn handle_text(
        &mut self,
        ctx: &mut RuntimeContext,
        leading: Option<&str>,
        text: Option<&str>,
        tailing: Option<&str>,
    ) -> Result<bool>;
    /// Called when the scenario execution is finished
    fn finished(&mut self, ctx: &mut RuntimeContext);

    /// Helper method to get variable value from context
    ///
    /// NOTE: This is a default implementation and should not be overridden in most cases
    fn get_variable<'a>(
        &self,
        ctx: &'a RuntimeContext,
        value: &'a Variable,
    ) -> Result<&'a Literal> {
        if value.chain.len() == 1 {
            let name = &value.chain[0];
            let v = ctx
                .archive_variables()
                .as_object()?
                .get(name)
                .or_else(|| {
                    ctx.global_variables()
                        .as_object()
                        .map(|o| o.get(name))
                        .unwrap_or_else(|_| Some(&Literal::Null))
                })
                .unwrap_or(&Literal::Null);
            Ok(v)
        } else {
            log::warn!(
                "Variable chain with more than one element is not supported: {:?}",
                value.chain
            );
            Ok(&Literal::Null)
        }
    }

    /// Helper method to calculate template literal from context
    ///
    /// NOTE: This is a default implementation and should not be overridden in most cases
    fn calculate_template_literal<'a>(
        &self,
        ctx: &'a RuntimeContext,
        template: &'a crate::format::TemplateLiteral,
    ) -> Result<String> {
        let text = template
            .parts
            .iter()
            .map(|part| match part {
                crate::format::TemplateLiteralPart::Text(text) => text.to_owned(),
                crate::format::TemplateLiteralPart::Value(value) => {
                    match self.get_rvalue(ctx, value) {
                        Ok(v) => v.to_string(),
                        Err(err) => {
                            log::error!(
                                "Failed to get rvalue from template literal: {:?}.\
                                             Error: {:?}",
                                value,
                                err
                            );
                            "[Error]".to_string()
                        }
                    }
                }
            })
            .collect::<String>();
        Ok(text)
    }

    /// Helper method to get RValue from context
    ///
    /// NOTE: This is a default implementation and should not be overridden in most cases
    fn get_rvalue<'a>(&self, ctx: &'a RuntimeContext, value: &'a RValue) -> Result<&'a Literal> {
        match value {
            RValue::Literal(s) => Ok(s),
            RValue::Variable(v) => self.get_variable(ctx, v),
        }
    }
}