inkcpp_rb 0.1.0

data/ext/inkcpp_rb/inkcpp/inkcpp_test/Lists.cpp

@@ -0,0 +1,144 @@
+#include "catch.hpp"
+
+#include <story.h>
+#include <runner.h>
+#include <globals.h>
+#include <compiler.h>
+#include <choice.h>
+
+#include <string.h>
+
+using namespace ink::runtime;
+
+SCENARIO("List logic operations", "[lists]")
+{
+	GIVEN("a demo story")
+	{
+		auto   ink    = story::from_file(INK_TEST_RESOURCE_DIR "ListLogicStory.bin");
+		runner thread = ink->new_runner();
+		WHEN("just run")
+		{
+			std::string out = thread->getall();
+
+			REQUIRE(out == R"==(A, C
+yes
+false
+true
+true
+true
+true
+A
+B
+>B
+>
+> Z, A, B, C
+>
+>
+B, C
+>C > > >
+>A, C >B >
+>B
+>
+> >Z >A >
+Hey
+)==");
+		}
+	}
+}
+SCENARIO("run a story with lists", "[lists]")
+{
+	GIVEN("a story with multi lists")
+	{
+		auto    ink     = story::from_file(INK_TEST_RESOURCE_DIR "ListStory.bin");
+		globals globals = ink->new_globals();
+		runner thread = ink->new_runner(globals);
+
+		WHEN("just run")
+		{
+			std::string out = thread->getall();
+			std::string choice1 = thread->get_choice(0)->text();
+			thread->choose(0);
+			std::string out2 = thread->getall();
+			THEN("should output expected")
+			{
+				REQUIRE(out == "cat, snake\n");
+				REQUIRE(choice1 == "list: bird, red, yellow");
+				REQUIRE(out2 == "list: bird, red, yellow\ncat, snake\nbird, red, yellow\n");
+			}
+		}
+
+		WHEN("modify with full flag name")
+		{
+			std::string out     = thread->getall();
+			std::string choice1 = thread->get_choice(0)->text();
+			thread->choose(0);
+
+			list l1 = *globals->get<list>("list");
+			l1->add("animals.dog");
+			l1->remove("colors.red");
+			REQUIRE(globals->set<list>("list", l1));
+
+			std::string out2 = thread->getall();
+
+			THEN("Output should be changed")
+			{
+				REQUIRE(out2 == "list: bird, dog, yellow\ncat, snake\nbird, dog, yellow\n");
+			}
+		}
+
+		WHEN("modify")
+		{
+			std::string out = thread->getall();
+			std::string choice1 = thread->get_choice(0)->text();
+			thread->choose(0);
+
+			list l1 = *globals->get<list>("list");
+			l1->add("dog");
+			l1->remove("red");
+			REQUIRE(globals->set<list>("list", l1));
+
+			l1 = *globals->get<list>("animals");
+			l1->add("bird");
+			l1->add("dog");
+			l1->remove("snake");
+			l1->remove("cat");
+			l1->add("cat");
+			REQUIRE(globals->set<list>("animals", l1));
+
+			std::string out2 = thread->getall();
+			THEN("should output change")
+			{
+				REQUIRE(out == "cat, snake\n");
+				REQUIRE(choice1 == "list: bird, red, yellow");
+				// changing the list will also change the text of the repeated choice
+				REQUIRE(out2 == "list: bird, dog, yellow\nbird, cat, dog\nbird, dog, yellow\n");
+			}
+
+			THEN("list should contain things")
+			{
+				l1 = *globals->get<list>("list");
+				REQUIRE(l1->contains("bird"));
+				REQUIRE(l1->contains("dog"));
+				REQUIRE(l1->contains("yellow"));
+
+				REQUIRE_FALSE(l1->contains("cat"));
+				REQUIRE_FALSE(l1->contains("snake"));
+				REQUIRE_FALSE(l1->contains("blue"));
+				REQUIRE_FALSE(l1->contains("white"));
+			}
+
+			THEN("should iterate all contained flags")
+			{
+				l1 = *globals->get<list>("list");
+				for(auto flag : *l1) {
+					INFO(flag);
+					REQUIRE((strcmp(flag.list_name, "colors")==0 || strcmp(flag.list_name, "animals") == 0));
+					REQUIRE((strcmp(flag.flag_name, "bird") == 0
+						|| strcmp(flag.flag_name, "dog") == 0
+						|| strcmp(flag.flag_name, "yellow") == 0
+					));
+				}
+			}
+		}
+	}
+}

data/ext/inkcpp_rb/inkcpp/inkcpp_test/LookaheadSafe.cpp

@@ -0,0 +1,46 @@
+#include "catch.hpp"
+
+#include <story.h>
+#include <globals.h>
+#include <runner.h>
+#include <compiler.h>
+
+using namespace ink::runtime;
+
+SCENARIO("A story with external functions and glue", "[external]")
+{
+	GIVEN("The story")
+	{
+		auto ink = story::from_file(INK_TEST_RESOURCE_DIR "LookaheadSafe.bin");
+
+		int  cnt = 0;
+		auto foo = [&cnt]() {
+			cnt += 1;
+		};
+		WHEN("the function in lookahead save")
+		{
+			auto thread = ink->new_runner();
+			thread->bind("foo", foo, true);
+			std::string out = thread->getline();
+			REQUIRE(cnt == 3);
+			REQUIRE(out == "Call1 glued to Call 2\n");
+			out = thread->getline();
+			REQUIRE(out == "Call 3 is seperated\n");
+			REQUIRE(cnt == 4);
+		}
+		WHEN("the function is not lookahead save")
+		{
+			auto thread = ink->new_runner();
+			thread->bind("foo", foo, false);
+			std::string out = thread->getline();
+			REQUIRE(out == "Call1\n");
+			REQUIRE(cnt == 1);
+			out = thread->getline();
+			REQUIRE(out == "glued to Call 2\n");
+			REQUIRE(cnt == 2);
+			out = thread->getline();
+			REQUIRE(out == "Call 3 is seperated\n");
+			REQUIRE(cnt == 3);
+		}
+	}
+}

data/ext/inkcpp_rb/inkcpp/inkcpp_test/Main.cpp

@@ -0,0 +1,7 @@
+#define CATCH_CONFIG_MAIN
+#include "catch.hpp"
+
+/*void ink::assert(bool condition, const char* msg)
+{
+	REQUIRE(condition); // todo: message
+}*/

data/ext/inkcpp_rb/inkcpp/inkcpp_test/MoveTo.cpp

@@ -0,0 +1,95 @@
+#include "catch.hpp"
+#include "system.h"
+
+#include <story.h>
+#include <globals.h>
+#include <choice.h>
+#include <runner.h>
+
+using namespace ink::runtime;
+
+SCENARIO("run a story, but jump around manually", "[move_to]")
+{
+	GIVEN("a story with side talking points")
+	{
+		auto    ink       = story::from_file(INK_TEST_RESOURCE_DIR "MoveTo.bin");
+		globals globStore = ink->new_globals();
+		runner  main      = ink->new_runner(globStore);
+		runner  side      = ink->new_runner(globStore);
+
+		WHEN("just run main story")
+		{
+			THEN("expect normal output")
+			{
+				REQUIRE(
+				    main->getall()
+				    == "Lava kadaver a very boring introduction\nYou are head to head to the minister\n"
+				);
+				REQUIRE(main->num_choices() == 1);
+				REQUIRE(main->get_choice(0)->text() == std::string("Hellow mister menistery"));
+				main->choose(0);
+				REQUIRE(main->getall() == "Hellow mister menistery\nYou are head to head to the minister\nIt seems you are out of options, you shold give up\n");
+			}
+		}
+
+		WHEN("skip intorduction")
+		{
+			main->move_to(ink::hash_string("Dialog.core"));
+			THEN("expect output minus introduction")
+			{
+				REQUIRE(main->getall() == "You are head to head to the minister\n");
+				REQUIRE(main->num_choices() == 1);
+				REQUIRE(main->get_choice(0)->text() == std::string("Hellow mister menistery"));
+				main->choose(0);
+				REQUIRE(main->getall() == "Hellow mister menistery\nYou are head to head to the minister\nIt seems you are out of options, you shold give up\n");
+			}
+		}
+
+		WHEN("second runner is executed")
+		{
+			main->move_to(ink::hash_string("Dialog.core"));
+			side->move_to(ink::hash_string("Transformations.Nothing"));
+			THEN("normal main output, and side output")
+			{
+				REQUIRE(side->getall() == "Hard you could transform if you would like\n");
+
+				REQUIRE(main->getall() == "You are head to head to the minister\n");
+				REQUIRE(main->num_choices() == 1);
+				REQUIRE(main->get_choice(0)->text() == std::string("Hellow mister menistery"));
+				main->choose(0);
+				REQUIRE(main->getall() == "Hellow mister menistery\nYou are head to head to the minister\nIt seems you are out of options, you shold give up\n");
+			}
+		}
+		WHEN("second runner modifies value")
+		{
+			main->move_to(ink::hash_string("Dialog.core"));
+			side->move_to(ink::hash_string("Transformations.ToTiger"));
+			THEN("main thread output changes")
+			{
+				REQUIRE(side->getall()  == "Your body growths, and growth, you feel the muscels building.\nAnd there you are, a tiger.\n");
+				REQUIRE(main->getall() == "You are head to head to the minister\n");
+				REQUIRE(main->num_choices() == 1);
+				REQUIRE(main->get_choice(0)->text() == std::string("Roar"));
+				main->choose(0);
+				REQUIRE(main->getall() == "Grrrrh, Roarrr\nThe people are quit confused\nYou are head to head to the minister\nIt seems you are out of options, you shold give up\n");
+			}
+		}
+		WHEN("execute mutliple small runners with sideeffects")
+		{
+			main->move_to(ink::hash_string("Dialog.core"));
+			side->move_to(ink::hash_string("Transformations.ToTiger"));
+			runner side2 = ink->new_runner(globStore);
+			side2->move_to(ink::hash_string("Transformations.ToOwl"));
+			THEN("side threads should influence each other")
+			{
+				REQUIRE(side2->getall() == "You Shrink and you get feathers. And, now you are a Owl\n");
+				REQUIRE(side->getall()  == "Your body growths, and growth, you feel the muscels building.\nAnd there you are, a tiger.\nyou puke a few feathers, where are they coming from?\n");
+				REQUIRE(main->getall() == "You are head to head to the minister\n");
+				REQUIRE(main->num_choices() == 1);
+				REQUIRE(main->get_choice(0)->text() == std::string("Roar"));
+				main->choose(0);
+				REQUIRE(main->getall() == "Grrrrh, Roarrr\nThe people are quit confused\nYou are head to head to the minister\nIt seems you are out of options, you shold give up\n");
+			}
+		}
+	}
+}

data/ext/inkcpp_rb/inkcpp/inkcpp_test/NewLines.cpp

@@ -0,0 +1,76 @@
+#include "catch.hpp"
+
+#include <story.h>
+#include <globals.h>
+#include <runner.h>
+#include <compiler.h>
+
+using namespace ink::runtime;
+
+SCENARIO("a story has the proper line breaks", "[lines]")
+{
+	GIVEN("a story with line breaks")
+	{
+		auto   ink    = story::from_file(INK_TEST_RESOURCE_DIR "LinesStory.bin");
+		runner thread = ink->new_runner();
+		WHEN("start thread")
+		{
+			THEN("thread can continue") { REQUIRE(thread->can_continue()); }
+			WHEN("consume lines")
+			{
+				std::string line1 = thread->getline();
+				std::string line2 = thread->getline();
+				std::string line3 = thread->getline();
+				std::string line4 = thread->getline();
+				THEN("lines are correct")
+				{
+					REQUIRE(line1 == "Line 1\n");
+					REQUIRE(line2 == "Line 2\n");
+					REQUIRE(line3 == "Line 3\n");
+					REQUIRE(line4 == "Line 4\n");
+				}
+			}
+			WHEN("consume lines with functions")
+			{
+				thread->move_to(ink::hash_string("Functions"));
+				std::string line1 = thread->getline();
+				std::string line2 = thread->getline();
+
+				THEN("function lines are correct")
+				{
+					REQUIRE(line1 == "Function Line\n");
+					REQUIRE(line2 == "Function Result\n");
+				}
+			}
+			WHEN("consume lines with tunnels")
+			{
+				thread->move_to(ink::hash_string("Tunnels"));
+				std::string line1 = thread->getline();
+				std::string line2 = thread->getline();
+
+				THEN("tunnel lines are correct")
+				{
+					REQUIRE(line1 == "Tunnel Line\n");
+					REQUIRE(line2 == "Tunnel Result\n");
+				}
+
+				THEN("thread cannot continue") { REQUIRE(! thread->can_continue()); }
+			}
+		}
+	}
+	GIVEN("a complex story")
+	{
+		auto   ink    = story::from_file(INK_TEST_RESOURCE_DIR "TheIntercept.bin");
+		runner thread = ink->new_runner();
+		// based on issue #82
+		WHEN("run sequence 1 3 3 3 2 3")
+		{
+			for (int i : {1, 3, 3, 3, 2, 3}) {
+				thread->getall();
+				thread->choose(i - 1);
+			}
+			std::string text = thread->getall();
+			THEN("no newline before dot") { REQUIRE(text == "\"I don't see why,\" I reply.\n"); }
+		}
+	}
+}

data/ext/inkcpp_rb/inkcpp/inkcpp_test/NoEarlyTags.cpp

@@ -0,0 +1,33 @@
+#include "catch.hpp"
+
+#include <compiler.h>
+#include <globals.h>
+#include <runner.h>
+#include <story.h>
+
+using namespace ink::runtime;
+
+SCENARIO("Story with tags and glues", "[glue, tags]")
+{
+	GIVEN("lines intersected with tags and glue")
+	{
+		auto ink    = story::from_file(INK_TEST_RESOURCE_DIR "NoEarlyTags.bin");
+		auto thread = ink->new_runner();
+		WHEN("no glue")
+		{
+			std::string out = thread->getline();
+			REQUIRE(out == "Hey there, nice to meet you!\n");
+			REQUIRE(thread->num_tags() == 2);
+		}
+		WHEN("glue: tags will stop lookahead")
+		{
+			thread->getline();
+			std::string out = thread->getline();
+			REQUIRE(out == "Hey, I'm Hey and this is YOU, nice to meet you too!\n");
+			REQUIRE(thread->num_tags() == 3);
+			out = thread->getline();
+			REQUIRE(out == "I'm Do! Most people can't pronounce it, just think 'Kee-vah\".\n");
+			REQUIRE(thread->num_tags() == 5);
+		}
+	}
+}

data/ext/inkcpp_rb/inkcpp/inkcpp_test/Observer.cpp

@@ -0,0 +1,245 @@
+#include "catch.hpp"
+
+#include <choice.h>
+#include <compiler.h>
+#include <globals.h>
+#include <runner.h>
+#include <story.h>
+
+using namespace ink::runtime;
+
+SCENARIO("Observer", "[variables]")
+{
+	GIVEN("a story which changes variables")
+	{
+		auto   ink     = story::from_file(INK_TEST_RESOURCE_DIR "ObserverStory.bin");
+		auto   globals = ink->new_globals();
+		runner thread  = ink->new_runner(globals);
+		WHEN("Run without observers")
+		{
+			std::string out = thread->getall();
+			REQUIRE(out == "hello line 1 1 hello line 2 5 test line 3 5\n");
+		}
+		WHEN("Run with observers read only, with specific type")
+		{
+			int  var1_cnt = 0;
+			auto var1     = [&var1_cnt](int32_t i) {
+        if (var1_cnt++ == 0) {
+          REQUIRE(i == 1);
+        } else {
+          REQUIRE(i == 5);
+        }
+			};
+			int  var2_cnt = 0;
+			auto var2     = [&var2_cnt](const char* s) {
+        std::string str(s);
+        if (var2_cnt++ == 0) {
+          REQUIRE(str == "hello");
+        } else {
+          REQUIRE(str == "test");
+        }
+			};
+
+			globals->observe("var1", var1);
+			globals->observe("var2", var2);
+			std::string out = thread->getall();
+
+			REQUIRE(out == "hello line 1 1 hello line 2 5 test line 3 5\n");
+			REQUIRE(var1_cnt == 2);
+			REQUIRE(var2_cnt == 2);
+		}
+		WHEN("Run with generic observer")
+		{
+			int  var1_cnt = 0;
+			auto var1     = [&var1_cnt](value v) {
+        REQUIRE(v.type == value::Type::Int32);
+        if (var1_cnt++ == 0) {
+					REQUIRE(v.get<value::Type::Int32>() == 1);
+				} else {
+					REQUIRE(v.get<value::Type::Int32>() == 5);
+				}
+			};
+			int  var2_cnt = 0;
+			auto var2     = [&var2_cnt](value v) {
+        REQUIRE(v.type == value::Type::String);
+				std::string str(v.get<value::Type::String>());
+				if (var2_cnt++ == 0) {
+					REQUIRE(str == "hello");
+				} else {
+					REQUIRE(str == "test");
+				}
+			};
+
+			globals->observe("var1", var1);
+			globals->observe("var2", var2);
+			std::string out = thread->getall();
+
+			REQUIRE(out == "hello line 1 1 hello line 2 5 test line 3 5\n");
+			REQUIRE(var1_cnt == 2);
+			REQUIRE(var2_cnt == 2);
+		}
+		WHEN("Bind multiple observer to same variables")
+		{
+			int  var1_cnt = 0;
+			auto var1     = [&var1_cnt](int32_t i) {
+        if (var1_cnt++ < 2) {
+          REQUIRE(i == 1);
+        } else {
+          REQUIRE(i == 5);
+        }
+			};
+			globals->observe("var1", var1);
+			globals->observe("var1", var1);
+			std::string out = thread->getall();
+
+			REQUIRE(out == "hello line 1 1 hello line 2 5 test line 3 5\n");
+			REQUIRE(var1_cnt == 4);
+		}
+		WHEN("Run with missmatching type")
+		{
+			auto var1 = [](uint32_t i) {
+			};
+			CHECK_THROWS(globals->observe("var1", var1));
+		}
+		WHEN("Just get pinged")
+		{
+			int  var1_cnt = 0;
+			auto var1     = [&var1_cnt]() {
+        var1_cnt++;
+			};
+			globals->observe("var1", var1);
+			std::string out = thread->getall();
+
+			REQUIRE(out == "hello line 1 1 hello line 2 5 test line 3 5\n");
+			REQUIRE(var1_cnt == 2);
+		}
+		WHEN("call with new and old value")
+		{
+			int  var1_cnt = 0;
+			auto var1     = [&var1_cnt](int32_t i, ink::optional<int32_t> o_i) {
+        if (var1_cnt++ == 0) {
+          REQUIRE(i == 1);
+          REQUIRE_FALSE(o_i.has_value());
+        } else {
+          REQUIRE(i == 5);
+          REQUIRE(o_i.has_value());
+          REQUIRE(o_i.value() == 1);
+        }
+			};
+
+			int  var2_cnt = 0;
+			auto var2     = [&var2_cnt](value v, ink::optional<value> o_v) {
+        REQUIRE(v.type == value::Type::String);
+				std::string str(v.get<value::Type::String>());
+				if (var2_cnt++ == 0) {
+					REQUIRE(str == "hello");
+					REQUIRE_FALSE(o_v.has_value());
+				} else {
+					REQUIRE(str == "test");
+					REQUIRE(o_v.has_value());
+					REQUIRE(o_v.value().type == value::Type::String);
+					std::string str2(o_v.value().get<value::Type::String>());
+					REQUIRE(str2 == "hello");
+				}
+			};
+
+			globals->observe("var1", var1);
+			globals->observe("var2", var2);
+			std::string out = thread->getall();
+
+			REQUIRE(out == "hello line 1 1 hello line 2 5 test line 3 5\n");
+			REQUIRE(var1_cnt == 2);
+			REQUIRE(var2_cnt == 2);
+		}
+		WHEN("Changing Same value at runtime")
+		{
+			int  var1_cnt = 0;
+			auto var1     = [&var1_cnt, &globals](int32_t i) {
+        ++var1_cnt;
+        if (var1_cnt == 1) {
+          REQUIRE(i == 1);
+        } else if (var1_cnt == 2) {
+          REQUIRE(i == 5);
+          globals->set<int32_t>("var1", 8);
+        } else if (var1_cnt == 3) {
+          REQUIRE(i == 8);
+        }
+			};
+			globals->observe("var1", var1);
+			std::string out = thread->getall();
+
+			REQUIRE(8 == globals->get<int32_t>("var1").value());
+			REQUIRE(out == "hello line 1 1 hello line 2 8 test line 3 8\n");
+			REQUIRE(var1_cnt == 3);
+		}
+		WHEN("Changing Sam value at bind time")
+		{
+			int  var1_cnt = 0;
+			auto var1     = [&var1_cnt, &globals](int32_t i) {
+        ++var1_cnt;
+        if (var1_cnt == 1) {
+          REQUIRE(i == 1);
+          globals->set<int32_t>("var1", 8);
+        } else if (var1_cnt == 2) {
+          REQUIRE(i == 8);
+        } else if (var1_cnt == 3) {
+          REQUIRE(i == 5);
+        }
+			};
+			globals->observe("var1", var1);
+			std::string out = thread->getall();
+
+			REQUIRE(5 == globals->get<int32_t>("var1").value());
+			REQUIRE(out == "hello line 1 8 hello line 2 5 test line 3 5\n");
+			REQUIRE(var1_cnt == 3);
+		}
+		WHEN("Changing Same value multiple times")
+		{
+			int  var1_cnt = 0;
+			auto var1     = [&var1_cnt, &globals](int32_t i) {
+        ++var1_cnt;
+        if (var1_cnt == 1) {
+          REQUIRE(i == 1);
+          globals->set<int32_t>("var1", 8);
+        } else if (var1_cnt == 2) {
+          REQUIRE(i == 8);
+          globals->set<int32_t>("var1", 10);
+        } else if (var1_cnt == 3) {
+          REQUIRE(i == 10);
+        } else if (var1_cnt == 4) {
+          REQUIRE(i == 5);
+        }
+			};
+			globals->observe("var1", var1);
+			std::string out = thread->getall();
+
+			REQUIRE(5 == globals->get<int32_t>("var1").value());
+			REQUIRE(out == "hello line 1 10 hello line 2 5 test line 3 5\n");
+			REQUIRE(var1_cnt == 4);
+		}
+		WHEN("Changing Other value")
+		{
+			int  var1_cnt = 0;
+			auto var1     = [&var1_cnt, &globals](int32_t i) {
+        if (var1_cnt++ == 0) {
+          REQUIRE(i == 1);
+        } else {
+          REQUIRE(i == 5);
+          globals->set<const char*>("var2", "didum");
+        }
+			};
+			int  var2_cnt = 0;
+			auto var2     = [&var2_cnt]() {
+        ++var2_cnt;
+			};
+
+			globals->observe("var1", var1);
+			globals->observe("var2", var2);
+			std::string out = thread->getall();
+
+			REQUIRE(out == "hello line 1 1 didum line 2 5 test line 3 5\n");
+			REQUIRE(var1_cnt == 2);
+			REQUIRE(var2_cnt == 3);
+		}
+	}
+}