Streamed Json Parser

.github/workflows/ci.yml

@@ -26,4 +26,6 @@ jobs:
       run: cargo fmt -- --check
 
     - name: Test
-      run: cargo test 
+      run: |
+        cargo test
+        cargo test --features stream-json-parser

cli-player/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "binkplayer"
-version = "1.0.3"
+version = "1.1.0"
 description = """
 Console player for compiled .json Ink story files.
 """
@@ -16,7 +16,7 @@ path = "src/main.rs"
 
 [dependencies]
 anyhow = "1.0.75"
-bladeink = { path = "../lib", "version" = "1.0.3" }
+bladeink = { path = "../lib", "version" = "1.1.0" }
 clap = { "version" = "4.4.6", features = ["derive"] }
 rand = "0.8.5"
 

lib/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "bladeink"
-version = "1.0.3"
+version = "1.1.0"
 authors = ["Rafael Garcia <bladecoder@gmail.com>"]
 description = """
 This is a Rust port of inkle's ink, a scripting language for writing interactive narrative.
@@ -23,7 +23,9 @@ strum = { version = "0.26.3", features = ["derive"] }
 as-any = "0.3.0"
 rand = "0.8.5"
 instant = "0.1.12"
+stringreader = "0.1.1"
 
 [features]
+stream-json-parser = []
 stdweb = ["instant/stdweb"]
 wasm-bindgen = ["instant/wasm-bindgen"]

lib/src/callstack.rs

@@ -4,7 +4,7 @@ use serde_json::{json, Map};
 
 use crate::{
     container::Container,
-    json_read, json_write,
+    json::{json_read, json_write},
     object::Object,
     path::Path,
     pointer::{self, Pointer},

lib/src/flow.rs

@@ -6,7 +6,7 @@ use crate::{
     callstack::{CallStack, Thread},
     choice::Choice,
     container::Container,
-    json_read, json_write,
+    json::{json_read, json_write},
     object::RTObject,
     story_error::StoryError,
 };

lib/src/json_read.rs → lib/src/json/json_read.rs

@@ -3,15 +3,88 @@ use std::{collections::HashMap, rc::Rc};
 use serde_json::Map;
 
 use crate::{
-    choice::Choice, choice_point::ChoicePoint, container::Container,
-    control_command::ControlCommand, divert::Divert, glue::Glue, ink_list::InkList,
-    ink_list_item::InkListItem, list_definition::ListDefinition,
-    list_definitions_origin::ListDefinitionsOrigin, native_function_call::NativeFunctionCall,
-    object::RTObject, path::Path, push_pop::PushPopType, story_error::StoryError, tag::Tag,
-    value::Value, variable_assigment::VariableAssignment, variable_reference::VariableReference,
+    choice::Choice,
+    choice_point::ChoicePoint,
+    container::Container,
+    control_command::ControlCommand,
+    divert::Divert,
+    glue::Glue,
+    ink_list::InkList,
+    ink_list_item::InkListItem,
+    list_definition::ListDefinition,
+    list_definitions_origin::ListDefinitionsOrigin,
+    native_function_call::NativeFunctionCall,
+    object::RTObject,
+    path::Path,
+    push_pop::PushPopType,
+    story::{INK_VERSION_CURRENT, INK_VERSION_MINIMUM_COMPATIBLE},
+    story_error::StoryError,
+    tag::Tag,
+    value::Value,
+    variable_assigment::VariableAssignment,
+    variable_reference::VariableReference,
     void::Void,
 };
 
+pub fn load_from_string(
+    s: &str,
+) -> Result<(i32, Rc<Container>, Rc<ListDefinitionsOrigin>), StoryError> {
+    let json: serde_json::Value = match serde_json::from_str(s) {
+        Ok(value) => value,
+        Err(_) => return Err(StoryError::BadJson("Story not in JSON format.".to_owned())),
+    };
+
+    let version_opt = json.get("inkVersion");
+
+    if version_opt.is_none() || !version_opt.unwrap().is_number() {
+        return Err(StoryError::BadJson(
+            "ink version number not found. Are you sure it's a valid .ink.json file?".to_owned(),
+        ));
+    }
+
+    let version: i32 = version_opt.unwrap().as_i64().unwrap().try_into().unwrap();
+
+    if version > INK_VERSION_CURRENT {
+        return Err(StoryError::BadJson(
+            "Version of ink used to build story was newer than the current version of the engine"
+                .to_owned(),
+        ));
+    } else if version < INK_VERSION_MINIMUM_COMPATIBLE {
+        return Err(StoryError::BadJson("Version of ink used to build story is too old to be loaded by this version of the engine".to_owned()));
+    }
+
+    let root_token = match json.get("root") {
+        Some(value) => value,
+        None => {
+            return Err(StoryError::BadJson(
+                "Root node for ink not found. Are you sure it's a valid .ink.json file?".to_owned(),
+            ))
+        }
+    };
+
+    let list_definitions = match json.get("listDefs") {
+        Some(def) => Rc::new(jtoken_to_list_definitions(def)?),
+        None => return Err(StoryError::BadJson(
+            "List Definitions node for ink not found. Are you sure it's a valid .ink.json file?"
+                .to_owned(),
+        )),
+    };
+
+    let main_content_container = jtoken_to_runtime_object(root_token, None)?;
+
+    let main_content_container = main_content_container.into_any().downcast::<Container>();
+
+    if main_content_container.is_err() {
+        return Err(StoryError::BadJson(
+            "Root node for ink is not a container?".to_owned(),
+        ));
+    };
+
+    let main_content_container = main_content_container.unwrap(); // unwrap: checked for err above
+
+    Ok((version, main_content_container, list_definitions))
+}
+
 pub fn jtoken_to_runtime_object(
     token: &serde_json::Value,
     name: Option<String>,