yarnspinner_runtime 0.8.0

Runtime / VM for Yarn Spinner for Rust, the friendly tool for writing game dialogue
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

//! Adapted from <https://github.com/YarnSpinnerTool/YarnSpinner/blob/da39c7195107d8211f21c263e4084f773b84eaff/YarnSpinner/Analyser.cs>

pub(crate) use self::default_analysers::*;
pub use self::{context::*, diagnosis::*};
use crate::prelude::*;
use core::fmt::Debug;

mod context;
pub(crate) mod default_analysers;
mod diagnosis;

/// A trait for analysing a compiled Yarn program. Can be used by adding them to a [`Context`] with [`Context::add_analyser`] and then applied to a
/// compiled Yarn program with [`Dialogue::analyse`](crate::prelude::Dialogue).
pub trait CompiledProgramAnalyser: Debug {
    /// Reads data from the provided program that is later used in [`CompiledProgramAnalyser::collect_diagnoses`].
    fn diagnose(&mut self, program: &Program);

    /// Takes the data collected by [`CompiledProgramAnalyser::diagnose`], analyzes it and returns the resulting [`Diagnosis`] instances.
    ///
    /// ## Implementation note
    /// Corresponds to the original `GatherDiagnoses`, but was renamed to `collect_diagnoses` because that terminology is more idiomatic in Rust.
    fn collect_diagnoses(&self) -> Vec<Diagnosis>;
}