Experimental ravi support (#125)

.github/workflows/build_linux.yml

@@ -75,3 +75,7 @@ jobs:
     - name: Test Luau
       working-directory: ${{runner.workspace}}/build/Tests
       run: ./LuaBridgeTestsLuau
+
+    - name: Test Ravi
+      working-directory: ${{runner.workspace}}/build/Tests
+      run: ./LuaBridgeTestsRavi

.github/workflows/build_macos.yml

@@ -72,3 +72,7 @@ jobs:
     - name: Test Luau
       working-directory: ${{runner.workspace}}/build/Tests
       run: ./LuaBridgeTestsLuau
+
+    - name: Test Ravi
+      working-directory: ${{runner.workspace}}/build/Tests
+      run: ./LuaBridgeTestsRavi

.github/workflows/build_windows.yml

@@ -67,18 +67,20 @@ jobs:
         ./LuaBridgeTests54.exe
         ./LuaBridgeTests54Noexcept.exe
 
-    #- name: Test LuaJIT
-    #  working-directory: ${{runner.workspace}}/build/Tests/Release
-    #  shell: bash
-    #  run: ./LuaBridgeTestsLuaJIT.exe
-
-    - name: Test LuaJIT - No Exceptions
+    - name: Test LuaJIT
       working-directory: ${{runner.workspace}}/build/Tests/Release
       shell: bash
-      run: |
-        ./LuaBridgeTestsLuaJITNoexcept.exe
+      # run: ./LuaBridgeTestsLuaJIT.exe
+      run: ./LuaBridgeTestsLuaJITNoexcept.exe
 
     - name: Test Luau
       working-directory: ${{runner.workspace}}/build/Tests/Release
       shell: bash
       run: ./LuaBridgeTestsLuau.exe
+
+    - name: Test Ravi
+      working-directory: ${{runner.workspace}}/build/Tests/Release
+      shell: bash
+      run: |
+        cp ../ravi/Release/libravi.dll .
+        ./LuaBridgeTestsRavi.exe

.gitmodules

@@ -3,4 +3,7 @@
 	url = https://github.com/kunitoki/luau.git
 [submodule "ThirdParty/googletest"]
 	path = ThirdParty/googletest
-	url = https://github.com/kunitoki/googletest.git
+	url = https://github.com/kunitoki/googletest.git
+[submodule "ThirdParty/ravi"]
+	path = ThirdParty/ravi
+	url = https://github.com/dibyendumajumdar/ravi.git

Manual.md

@@ -72,13 +72,13 @@ Contents
 1 - Introduction
 ================
 
-[LuaBridge](https://github.com/kunitoki/LuaBridge3) is a lightweight and dependency-free library for mapping data, functions, and classes back and forth between C++ and [Lua](http://wwww.lua.org), a powerful, fast, lightweight, embeddable scripting language. LuaBridge has been tested and works with Lua 5.1.5, 5.2.4, 5.3.6 and 5.4.4. It also works transparently with [LuaJIT](http://luajit.org/) 2.x onwards and for the first time also with [Luau](https://luau-lang.org/) 0.556 onwards.
+[LuaBridge](https://github.com/kunitoki/LuaBridge3) is a lightweight and dependency-free library for mapping data, functions, and classes back and forth between C++ and [Lua](http://wwww.lua.org), a powerful, fast, lightweight, embeddable scripting language. LuaBridge has been tested and works with Lua 5.1.5, 5.2.4, 5.3.6 and 5.4.4. It also works transparently with [LuaJIT](http://luajit.org/) 2.x onwards and for the first time also with [Luau](https://luau-lang.org/) 0.556 onwards and [Ravi](https://github.com/dibyendumajumdar/ravi) 1.0-beta11.
 
 LuaBridge is usable from a compliant C++17 and offers the following features:
 
 * [MIT Licensed](http://www.opensource.org/licenses/mit-license.html), no usage restrictions!
 * Headers-only: No Makefile, no .cpp files, just one `#include` and one header file (optional) !
-* Works with ANY lua version out there (PUC-Lua, LuaJIT, Luau, you name it).
+* Works with ANY lua version out there (PUC-Lua, LuaJIT, Luau, Ravi, you name it).
 * Simple, light, and nothing else needed.
 * No macros, settings, or configuration scripts needed.
 * Supports different object lifetime management models.
@@ -91,7 +91,7 @@ LuaBridge is usable from a compliant C++17 and offers the following features:
 
 It also offers a set of improvements compared to vanilla LuaBridge:
 
-* The only binder library that works with PUC-Lua as well as LuaJIT and Luau, wonderful for game development !
+* The only binder library that works with PUC-Lua as well as LuaJIT, Luau and Ravi, wonderful for game development !
 * Can work with both c++ exceptions and without (Works with `-fno-exceptions` and `/EHsc-`).
 * Can safely register and use classes exposed across shared library boundaries.
 * Full support for capturing lambdas in all namespace and class methods.

README.md

@@ -8,19 +8,19 @@
 
 # LuaBridge 3.0
 
-[LuaBridge3][1] is a lightweight and dependency-free library for mapping data,
-functions, and classes back and forth between C++ and [Lua][2] (a powerful,
+[LuaBridge3](https://github.com/kunitoki/LuaBridge3) is a lightweight and dependency-free library for mapping data,
+functions, and classes back and forth between C++ and [Lua](http://wwww.lua.org) (a powerful,
 fast, lightweight, embeddable scripting language). LuaBridge has been tested
-and works with Lua 5.1.5, 5.2.4, 5.3.6 and 5.4.4 as well as [LuaJit][3] 2.x onwards
-and for the first time also with [Luau][4] 0.556 onwards.
+and works with Lua 5.1.5, 5.2.4, 5.3.6 and 5.4.4 as well as [LuaJit](https://luajit.org/) 2.x onwards
+and for the first time also with [Luau](https://luau-lang.org/) 0.556 onwards and [Ravi](https://github.com/dibyendumajumdar/ravi) 1.0-beta11.
 
 ## Features
 
 LuaBridge3 is usable from a compliant C++17 compiler and offers the following features:
 
-* [MIT Licensed][5], no usage restrictions!
+* [MIT Licensed](https://www.opensource.org/licenses/mit-license.html), no usage restrictions!
 * Headers-only: No Makefile, no .cpp files, just one `#include` and one header file (optional) !
-* Works with ANY lua version out there (PUC-Lua, LuaJIT, Luau, you name it).
+* Works with ANY lua version out there (PUC-Lua, LuaJIT, Luau, Ravi, you name it).
 * Simple, light, and nothing else needed.
 * Fast to compile (even in release mode), scaling linearly with the size of your binded code.
 * No macros, settings, or configuration scripts needed.
@@ -37,7 +37,7 @@ LuaBridge3 is usable from a compliant C++17 compiler and offers the following fe
 
 LuaBridge3 offers a set of improvements compared to vanilla LuaBridge:
 
-* The only binder library that works with PUC-Lua as well as LuaJIT and Luau, wonderful for game development !
+* The only binder library that works with PUC-Lua as well as LuaJIT, Luau and Ravi, wonderful for game development !
 * Can work with both c++ exceptions and without (Works with `-fno-exceptions` and `/EHsc-`).
 * Can safely register and use classes exposed across shared library boundaries.
 * Full support for capturing lambdas in all namespace and class methods.
@@ -64,11 +64,11 @@ LuaBridge3 offers a set of improvements compared to vanilla LuaBridge:
 
 ## Documentation
 
-Please read the [LuaBridge3 Reference Manual][6] for more details on the API.
+Please read the [LuaBridge3 Reference Manual](https://kunitoki.github.io/LuaBridge3/Manual) for more details on the API.
 
 ## Release Notes
 
-Plase read the [LuaBridge3 Release Notes][7] for more details
+Plase read the [LuaBridge3 Release Notes](https://kunitoki.github.io/LuaBridge3/CHANGES) for more details
 
 ## Installing LuaBridge3 (vcpkg)
 
@@ -121,8 +121,10 @@ There are 11 unit test flavors:
 * `LuaBridgeTestsLuaJIT` - uses LuaJIT 2.1
 * `LuaBridgeTestsLuaJITNoexcept` - uses LuaJIT 2.1 without exceptions enabled
 * `LuaBridgeTestsLuau` - uses Luau
+* `LuaBridgeTestsRavi` - uses Ravi
 
 (Luau compiler needs exceptions, so there are no test targets on Luau without exceptions)
+(Ravi doesn't fully work without exceptions, so there are no test targets on Ravi without exceptions)
 
 Generate Unix Makefiles and build on Linux:
 ```bash
@@ -162,7 +164,7 @@ popd
 
 ## Official Repository
 
-LuaBridge3 is published under the terms of the [MIT License][5].
+LuaBridge3 is published under the terms of the [MIT License](https://www.opensource.org/licenses/mit-license.html).
 
 The original version of LuaBridge3 was written by Nathan Reed. The project has
 been taken over by Vinnie Falco, who added new functionality, wrote the new
@@ -178,11 +180,3 @@ Copyright 2019, Dmitry Tarakanov<br>
 Copyright 2012, Vinnie Falco (<vinnie.falco@gmail.com>)<br>
 Copyright 2008, Nigel Atkinson<br>
 Copyright 2007, Nathan Reed<br>
-
-[1]:  https://github.com/kunitoki/LuaBridge3 "LuaBridge3"
-[2]:  https://lua.org "The Lua Programming Language"
-[3]:  https://luajit.org/ "The LuaJIT Project"
-[4]:  https://luau-lang.org/ "The Luau Project"
-[5]:  https://www.opensource.org/licenses/mit-license.html "The MIT License"
-[6]:  https://kunitoki.github.io/LuaBridge3/Manual "LuaBridge3 Reference Manual"
-[7]:  https://kunitoki.github.io/LuaBridge3/CHANGES "LuaBridge3 Release Notes"

Source/LuaBridge/detail/Config.h

@@ -46,6 +46,8 @@
 #define LUABRIDGE_ON_LUAU 1
 #elif defined(LUAJIT_VERSION)
 #define LUABRIDGE_ON_LUAJIT 1
+#elif defined(RAVI_OPTION_STRING2)
+#define LUABRIDGE_ON_RAVI 1
 #elif defined(LUA_VERSION_NUM)
 #define LUABRIDGE_ON_LUA 1
 #else

Source/LuaBridge/detail/LuaHelpers.h

@@ -132,14 +132,14 @@ inline lua_Integer to_integerx(lua_State* L, int idx, int* isnum)
         {
             if (isnum)
                 *isnum = 1;
-            
+
             return int_n;
         }
     }
 
     if (isnum)
         *isnum = 0;
-    
+
     return 0;
 }
 
@@ -513,8 +513,11 @@ inline int raise_lua_error(lua_State* L, const char* fmt, ...)
     va_end(argp);
 
     const char* message = lua_tostring(L, -1);
-    if (message != nullptr && std::string_view(message)[0] == '[')
-        return lua_error_x(L);
+    if (message != nullptr)
+    {
+        if (auto str = std::string_view(message); !str.empty() && str[0] == '[')
+            return lua_error_x(L);
+    }
 
     bool pushed_error = false;
     for (int level = 1; level <= 2; ++level)
@@ -564,7 +567,7 @@ constexpr bool is_integral_representable_by(T value)
 
         if constexpr (std::is_unsigned_v<T>)
             return value <= static_cast<T>((std::numeric_limits<U>::max)());
-        
+
         return value >= static_cast<T>((std::numeric_limits<U>::min)())
             && static_cast<U>(value) <= (std::numeric_limits<U>::max)();
     }

Tests/CMakeLists.txt

@@ -4,8 +4,10 @@ cmake_minimum_required (VERSION 3.5)
 
 set (LUABRIDGE_LUAJIT_LOCATION "${CMAKE_CURRENT_LIST_DIR}/Lua/LuaJIT.2.1")
 set (LUABRIDGE_LUAU_LOCATION "${CMAKE_CURRENT_LIST_DIR}/../ThirdParty/luau")
+set (LUABRIDGE_RAVI_LOCATION "${CMAKE_CURRENT_LIST_DIR}/../ThirdParty/ravi")
 
 add_subdirectory(${LUABRIDGE_LUAJIT_LOCATION})
+add_subdirectory(${LUABRIDGE_RAVI_LOCATION} ravi)
 
 # ====================================================== Unit Tests Files
 
@@ -89,10 +91,16 @@ file (GLOB_RECURSE LUABRIDGE_TEST_LUAJIT_FILES
   Lua/LuaLibrary.h
 )
 
+# ====================================================== Ravi
+
+file (GLOB_RECURSE LUABRIDGE_TEST_RAVI_FILES
+  Lua/LuaLibrary.h
+)
+
 # ====================================================== Shared Library
 
 file (GLOB_RECURSE LUABRIDGE_TEST_SHARED_LIBRARY_FILES
-  Source/SharedCode.ch
+  Source/SharedCode.h
   Source/SharedCode.cpp
 )
 
@@ -151,6 +159,7 @@ function (setup_coverage_single_target)
       -a "coverage/LuaBridgeTestsLuaJIT.info"
       -a "coverage/LuaBridgeTestsLuaJITNoexcept.info"
       -a "coverage/LuaBridgeTestsLuau.info"
+      -a "coverage/LuaBridgeTestsRavi.info"
       -o "coverage/Merged.info"
     COMMAND ${GENHTML_EXECUTABLE}
       --rc lcov_branch_coverage=1
@@ -167,6 +176,7 @@ function (setup_coverage_single_target)
       "coverage/LuaBridgeTestsLuaJIT.info"
       "coverage/LuaBridgeTestsLuaJITNoexcept.info"
       "coverage/LuaBridgeTestsLuau.info"
+      "coverage/LuaBridgeTestsRavi.info"
     WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
     VERBATIM)
 
@@ -229,6 +239,9 @@ macro (add_test_app LUABRIDGE_TEST_NAME LUA_VERSION LUABRIDGE_TEST_LUA_LIBRARY_F
   elseif (${LUA_VERSION} STREQUAL "LUAJIT")
     target_compile_definitions (${LUABRIDGE_TEST_NAME} PRIVATE LUABRIDGEDEMO_LUAJIT=1)
     target_compile_definitions (${LUABRIDGE_TESTLIB_NAME} PRIVATE LUABRIDGEDEMO_LUAJIT=1)
+  elseif (${LUA_VERSION} STREQUAL "RAVI")
+    target_compile_definitions (${LUABRIDGE_TEST_NAME} PRIVATE LUABRIDGEDEMO_RAVI=1)
+    target_compile_definitions (${LUABRIDGE_TESTLIB_NAME} PRIVATE LUABRIDGEDEMO_RAVI=1)
   else () # if(${LUA_VERSION} MATCHES "^[0-9]*")
     target_compile_definitions (${LUABRIDGE_TEST_NAME} PRIVATE LUABRIDGEDEMO_LUA_VERSION=${LUA_VERSION})
     target_compile_definitions (${LUABRIDGE_TESTLIB_NAME} PRIVATE LUABRIDGEDEMO_LUA_VERSION=${LUA_VERSION})
@@ -291,6 +304,9 @@ add_test_app (LuaBridgeTestsLuaJITNoexcept "LUAJIT" "${LUABRIDGE_TEST_LUAJIT_FIL
 add_test_app (LuaBridgeTestsLuau "LUAU" "${LUABRIDGE_TEST_LUAU_FILES}" 1 "")
 #add_test_app (LuaBridgeTestsLuauNoexcept "LUAU" "${LUABRIDGE_TEST_LUAU_FILES}" 0 "")
 
+add_test_app (LuaBridgeTestsRavi "RAVI" "${LUABRIDGE_TEST_RAVI_FILES}" 1 "libravi")
+#add_test_app (LuaBridgeTestsRaviNoexcept "RAVI" "${LUABRIDGE_TEST_RAVI_FILES}" 0 "libravi")
+
 if (LUABRIDGE_COVERAGE)
   setup_coverage_single_target ()
 endif ()

Tests/Lua/LuaLibrary.h

@@ -43,6 +43,9 @@
 #include "../../ThirdParty/luau/VM/include/luaconf.h"
 #include "../../ThirdParty/luau/VM/include/lualib.h"
 
+#elif LUABRIDGEDEMO_RAVI
+#include "../../ThirdParty/ravi/include/lua.hpp"
+
 #elif LUABRIDGEDEMO_LUAJIT
 #include "LuaJIT.2.1/src/lua.hpp"
 

Tests/Source/CoroutineTests.cpp

@@ -7,9 +7,9 @@
 namespace {
 int lua_resume_x(lua_State* L, int nargs)
 {
-#if LUABRIDGEDEMO_LUAJIT || LUABRIDGEDEMO_LUA_VERSION == 501
+#if LUABRIDGEDEMO_LUAJIT || LUA_VERSION_NUM == 501
     return lua_resume(L, nargs);
-#elif LUABRIDGEDEMO_LUAU || LUABRIDGEDEMO_LUA_VERSION < 504
+#elif LUABRIDGEDEMO_LUAU || LUABRIDGEDEMO_RAVI || LUA_VERSION_NUM < 504
     return lua_resume(L, nullptr, nargs);
 #else
     [[maybe_unused]] int nresults = 0;

Tests/Source/Tests.cpp

@@ -381,7 +381,7 @@ TEST_F(LuaBridgeTest, ClassFunction)
 #endif
 }
 
-TEST_F(LuaBridgeTest, PropertyGetterFailOnUnregistredClass)
+TEST_F(LuaBridgeTest, PropertyGetterFailOnUnregisteredClass)
 {
     struct Clazz {} clazz;
 
@@ -391,7 +391,7 @@ TEST_F(LuaBridgeTest, PropertyGetterFailOnUnregistredClass)
         .endNamespace();
 
 #if LUABRIDGE_HAS_EXCEPTIONS
-    EXPECT_THROW(runLua("result = ns.clazz"), std::runtime_error);
+    EXPECT_ANY_THROW(runLua("result = ns.clazz"));
 #else
     EXPECT_FALSE(runLua("result = ns.clazz"));
 #endif
@@ -732,6 +732,10 @@ TEST_F(LuaBridgeTest, StdSharedPtrDerivedPolymorphic)
 #endif
     }
 
+#if LUABRIDGE_ON_RAVI
+    return; // TODO - Ravi asserts on the lua state being invalid because of the previous exception
+#endif
+
     EXPECT_TRUE(runLua("local x = test.A(2); result = x:myNameIs()"));
     auto x1 = result<std::string>();
     EXPECT_EQ("VirtualA", x1);