inkcpp_rb 0.1.0

data/ext/inkcpp_rb/inkcpp/inkcpp_py/tests/test_Snapshot.py

@@ -0,0 +1,57 @@
+import inkcpp_py as ink
+import pytest
+
+def check_end(runner):
+    assert runner.num_choices() == 3
+    runner.choose(2)
+    while runner.can_continue():
+        runner.getline()
+    assert runner.num_choices() == 2
+
+class TestSnapshot:
+    def test_snapshot(self, assets, generate):
+        [story, glob, runner] = generate(assets['SimpleStoryFlow'])
+        runner2 = story.new_runner(glob)
+        runner.getline()
+        assert runner.num_choices() == 3
+        snap0 = runner.create_snapshot()
+
+        runner.choose(2)
+
+        snap1 = runner.create_snapshot()
+
+        cnt = 0
+        while runner.can_continue():
+            runner.getline()
+            cnt += 1
+
+        snap2 = runner.create_snapshot()
+
+        check_end(runner)
+
+        glob = story.new_globals_from_snapshot(snap0)
+        runner = story.new_runner_from_snapshot(snap0, glob, 0)
+        assert runner.num_choices() == 3
+        runner.choose(2)
+        cnt_x = 0
+        while runner.can_continue():
+            runner.getline()
+            cnt_x += 1
+        assert cnt_x == cnt
+
+        check_end(runner)
+
+        glob = story.new_globals_from_snapshot(snap1)
+        runner = story.new_runner_from_snapshot(snap1, glob, 0)
+        cnt_x = 0
+        while runner.can_continue():
+            runner.getline()
+            cnt_x += 1
+        assert cnt_x == cnt
+
+        check_end(runner)
+
+        glob = story.new_globals_from_snapshot(snap2)
+        runner = story.new_runner_from_snapshot(snap2, glob, 0)
+        assert not runner.can_continue()
+        check_end(runner)

data/ext/inkcpp_rb/inkcpp/inkcpp_py/unreal_example.ink

@@ -0,0 +1,71 @@
+->Start
+EXTERNAL SetBrightness(x)
+=== function SetBrightness(x) ===
+      ~ return
+
+EXTERNAL GetGreeting()
+=== function GetGreeting() ===
+	~ return "Hey, "
+
+VAR brightness = 50
+
+VAR date = "???"
+
+LIST background = (a), b, c
+
+=== Start ===
+{GetGreeting()}, your personal assistent here.  # Story Start
+Today is the {date}
+Why we don't start with some customisation options:
+* [Yes]
+	-> Settings ->
+	How The story looks now? much better :)
+	->DONE
+* [I Don't like you.]
+	Then Bye
+	->DONE
+
+=== Settings ===
+
+= All
+Let Start with the color.
+->Color->
+The illumination seems off?
+->Brightness->
+And now some custom background :)
+->Background->
+->->
+
+= Color
+Which color do like?
++ [Magenta # c:mag]
+	A wired choice ... # setColor_255_0_255
++ [Cyan # c:cya]
+	A think this will be a intense experience. # setColor_0_255_255
++ [Yellow # c:yel]
+	A delighting decision. # setColor_255_255_0
+- Do You Like your decision?
++ [Yes] ->->
++ [No] -> Color
+
+= Brightness
+Do you like the Brightness level?
++ [A bit more please.]
+	~ brightness += 5
++ [A bit less.]
+	~ brightness -= 5
++ [The settings {is fine| is now to my compliance!}]
+	->->
+-   ~ SetBrightness(brightness)
+	->Brightness
+
+= Background
+>> SetBg({background})
+How do you like this image?
++ {background < LIST_MAX(LIST_ALL(background))} [Mhe the next please.]
+	~ background++
++ {background > LIST_MIN(LIST_ALL(background))} [Can you show me the previous please?]
+	~ background--
++ [This is great]
+	->->
+- -> Background

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

@@ -0,0 +1,115 @@
+#include "catch.hpp"
+
+#include "..//inkcpp/array.h"
+
+using namespace ink;
+using ink::runtime::internal::allocated_restorable_array;
+
+typedef allocated_restorable_array<uint32_t> test_array;
+
+SCENARIO("a restorable array can hold values", "[array]")
+{
+	GIVEN("an empty array")
+	{
+		const ink::size_t length = 10;
+		test_array array = test_array(length, 0, ~0);
+
+		THEN("the default values should be zero")
+		{
+			for (ink::size_t i = 0; i < length; i++)
+			{
+				REQUIRE(array[i] == 0);
+			}
+		}
+
+		WHEN("we assign a value")
+		{
+			array.set(3, 15);
+
+			THEN("the value should be set")
+			{
+				REQUIRE(array[3] == 15);
+			}
+
+			THEN("the other values should be zero still")
+			{
+				for (ink::size_t i = 0; i < length; i++)
+				{
+					if (i == 3)
+						continue;
+
+					REQUIRE(array[i] == 0);
+				}
+			}
+		}
+	}
+}
+
+SCENARIO("a restorable array can save/restore/forget", "[array]")
+{
+	GIVEN("a saved array with a few values")
+	{
+		// Load up the array
+		test_array array = test_array(5, 0, ~0);
+		array.set(0, 0);
+		array.set(1, 1);
+		array.set(2, 2);
+		array.set(3, 3);
+		array.set(4, 4);
+
+		// Save its state
+		array.save();
+
+		WHEN("we change some values")
+		{
+			array.set(0, 10);
+			array.set(1, 11);
+
+			THEN("the new values should be returned")
+			{
+				REQUIRE(array[0] == 10);
+				REQUIRE(array[1] == 11);
+			}
+
+			THEN("old values should be returned when not changed")
+			{
+				REQUIRE(array[2] == 2);
+				REQUIRE(array[3] == 3);
+				REQUIRE(array[4] == 4);
+			}
+
+			WHEN("we restore the array")
+			{
+				array.restore();
+
+				THEN("we should get our old values back")
+				{
+					REQUIRE(array[0] == 0);
+					REQUIRE(array[1] == 1);
+				}
+
+				WHEN("we save again")
+				{
+					array.save();
+
+					THEN("we shouldn't get the weird values")
+					{
+						REQUIRE(array[0] == 0);
+						REQUIRE(array[1] == 1);
+					}
+				}
+			}
+
+			WHEN("we forget the save")
+			{
+				array.forget();
+
+				THEN("we should still have the new values")
+				{
+					REQUIRE(array[0] == 10);
+					REQUIRE(array[1] == 11);
+				}
+			}
+		}
+	}
+}

data/ext/inkcpp_rb/inkcpp/inkcpp_test/CMakeLists.txt

@@ -0,0 +1,117 @@
+add_executable(inkcpp_test catch.hpp Main.cpp 
+  Array.cpp
+  Pointer.cpp
+  Stack.cpp
+  Callstack.cpp
+  Restorable.cpp
+  Value.cpp
+  Globals.cpp
+  Lists.cpp
+  Tags.cpp
+  NewLines.cpp
+  FallbackFunction.cpp
+  LabelCondition.cpp
+  Observer.cpp
+  InkyJson.cpp
+  SpaceAfterBracketChoice.cpp
+  ThirdTierChoiceAfterBrackets.cpp
+  NoEarlyTags.cpp
+  ExternalFunctionsExecuteProperly.cpp
+  LookaheadSafe.cpp
+  EmptyStringForDivert.cpp
+  MoveTo.cpp
+)
+
+target_link_libraries(inkcpp_test PUBLIC inkcpp inkcpp_compiler inkcpp_shared)
+target_include_directories(inkcpp_test PRIVATE ../shared/private/)
+
+# For https://en.cppreference.com/w/cpp/filesystem#Notes
+if(CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
+  if(CMAKE_CXX_COMPILER_VERSION VERSION_LESS "9.1")
+    target_link_libraries(inkcpp_test PRIVATE stdc++fs)
+  endif()
+elseif(CMAKE_CXX_COMPILER_ID STREQUAL "Clang")
+  if(CMAKE_CXX_COMPILER_VERSION VERSION_LESS "9.0")
+    target_link_libraries(inkcpp_test PRIVATE stdc++fs)
+  endif()
+endif()
+
+add_test(NAME UnitTests COMMAND $<TARGET_FILE:inkcpp_test>)
+
+if ($ENV{INKLECATE})
+  set(INKLECATE_CMD $ENV{INKLECATE})
+else()
+  set(INKLECATE_CMD "inklecate")
+endif()
+
+string(TOUPPER "${INKCPP_INKLECATE}" inkcpp_inklecate_upper)
+if((inkcpp_inklecate_upper STREQUAL "ALL") OR (inkcpp_inklecate_upper STREQUAL "OS"))
+  if(UNIX AND NOT APPLE)
+    FetchContent_GetProperties(inklecate_linux)
+    if(inklecate_linux_POPULATED)
+      set(INKLECATE_CMD "${inklecate_linux_SOURCE_DIR}/inklecate")
+    else()
+    message(FATAL_ERROR "inklecate download is not provided, please check if the download failed.
+      You may set INCPP_INKLECATE=NONE and provide inkcleate via your PATH or the INKLECATE enviroment variable.
+      You can also disable tests altogether by setting INKCPP_TEST=OFF")
+    endif(inklecate_linux_POPULATED)
+  elseif(APPLE)
+    if(inklecate_mac_POPULATED)
+      set(INKLECATE_CMD "${inklecate_mac_SOURCE_DIR}/inklecate")
+    else()
+    message(FATAL_ERROR "inklecate download is not provided, please check if the download failed.
+      You may set INCPP_INKLECATE=NONE and provide inkcleate via your PATH or the INKLECATE enviroment variable.
+      You can also disable tests altogether by setting INKCPP_TEST=OFF")
+    endif(inklecate_mac_POPULATED)
+  elseif(MSYS OR MINGW OR WIN32 OR CYGWIN)
+    if(inklecate_windows_POPULATED)
+      set(INKLECATE_CMD "${inklecate_windows_SOURCE_DIR}/inklecate")
+    else()
+    message(FATAL_ERROR "inklecate download is not provided, please check if the download failed.
+      You may set INCPP_INKLECATE=NONE and provide inkcleate via your PATH or the INKLECATE enviroment variable.
+      You can also disable tests altogether by setting INKCPP_TEST=OFF")
+    endif(inklecate_windows_POPULATED)
+  else()
+    message(FATAL_ERROR "Current os could not be identified, therfore inklecate must be provided explicit for the tests to work
+      please set INKCPP_INKLECATE=NONE and provide inklecate via your PATH or the INKLECATE enviroment variables.
+      Alternatily disable tests by setting INKCPP_TEST=OFF.")
+  endif()
+endif((inkcpp_inklecate_upper STREQUAL "ALL") OR (inkcpp_inklecate_upper STREQUAL "OS"))
+
+set(INK_TEST_RESOURCE_DIR "${PROJECT_BINARY_DIR}/ink")
+file(MAKE_DIRECTORY "${INK_TEST_RESOURCE_DIR}")
+
+target_compile_definitions(inkcpp_test PRIVATE 
+  INK_TEST_RESOURCE_DIR="${INK_TEST_RESOURCE_DIR}/") 
+
+file(GLOB JSON_FILES "${CMAKE_CURRENT_SOURCE_DIR}/ink/*.json")
+file(COPY ${JSON_FILES} DESTINATION ${INK_TEST_RESOURCE_DIR}) 
+
+file(GLOB INK_FILES "${CMAKE_CURRENT_SOURCE_DIR}/ink/*.ink")
+foreach(INK_FILE IN LISTS INK_FILES)
+  get_filename_component(INK_FILENAME ${INK_FILE} NAME_WE)
+  set(output "${INK_TEST_RESOURCE_DIR}/${INK_FILENAME}.bin")
+  add_custom_command(
+    OUTPUT ${output} 
+    COMMAND $<TARGET_FILE:inkcpp_cl> -o "${output}" --inklecate "${INKLECATE_CMD}" "${INK_FILE}"
+    DEPENDS ${INK_FILE}
+    COMMENT "Compile test ink file '${INK_FILENAME}.ink' -> '${output}'"
+  )
+  list(APPEND INK_OUT_FILES ${output})
+endforeach()
+target_sources(inkcpp_test PRIVATE ${INK_OUT_FILES})
+
+if(TARGET inkcpp_c)
+  file(GLOB TEST_FILES "${PROJECT_SOURCE_DIR}/inkcpp_c/tests/*.c")
+  foreach(TEST_FILE IN LISTS TEST_FILES)
+    get_filename_component(TEST_NAME ${TEST_FILE} NAME_WE)
+    add_executable(${TEST_NAME} ${TEST_FILE})
+    target_link_libraries(${TEST_NAME} PRIVATE inkcpp_c)
+    target_compile_definitions(${TEST_NAME} PRIVATE 
+      INK_TEST_RESOURCE_DIR="${INK_TEST_RESOURCE_DIR}/") 
+    add_test(
+      NAME ${TEST_NAME}
+      COMMAND $<TARGET_FILE:${TEST_NAME}>
+    )
+  endforeach()
+endif(TARGET inkcpp_c)