Sample module deep test renamed deep_userdata_example

9 files changed, 195 insertions, 36 deletions

diff --git a/deep_test/deep_test.args.json b/deep_userdata_example/deep_userdata_example.args.json
index a1654a6..a1654a6 100644
--- a/deep_test/deep_test.args.json
+++ b/deep_userdata_example/deep_userdata_example.args.json
diff --git a/deep_test/deep_test.cpp b/deep_userdata_example/deep_userdata_example.cpp
index cbc33ca..a45cc7f 100644
--- a/deep_test/deep_test.cpp
+++ b/deep_userdata_example/deep_userdata_example.cpp
@@ -19,7 +19,7 @@ class MyDeepFactory final : public DeepFactory
     [[nodiscard]]
     DeepPrelude* newDeepObjectInternal(lua_State* const L_) const override;
     [[nodiscard]]
-    std::string_view moduleName() const override { return std::string_view{ "deep_test" }; }
+    std::string_view moduleName() const override { return std::string_view{ "deep_userdata_example" }; }
 };
 /*static*/ MyDeepFactory MyDeepFactory::Instance{};
 
@@ -315,7 +315,7 @@ static luaL_Reg const deep_module[] = {
 
 // #################################################################################################
 
-LANES_API int luaopen_deep_test(lua_State* L)
+LANES_API int luaopen_deep_userdata_example(lua_State* L)
 {
     luaG_newlib<std::size(deep_module)>(L, deep_module);                                           // M
 
diff --git a/deep_test/deep_test.vcxproj b/deep_userdata_example/deep_userdata_example.vcxproj
index 78706ed..839e5c8 100644
--- a/deep_test/deep_test.vcxproj
+++ b/deep_userdata_example/deep_userdata_example.vcxproj
@@ -857,7 +857,7 @@
   <ItemGroup>
     <ClCompile Include="..\src\compat.cpp" />
     <ClCompile Include="..\src\deep.cpp" />
-    <ClCompile Include="deep_test.cpp" />
+    <ClCompile Include="deep_userdata_example.cpp" />
   </ItemGroup>
   <ItemGroup>
     <ClInclude Include="..\src\compat.hpp" />
diff --git a/deep_test/deep_test.vcxproj.filters b/deep_userdata_example/deep_userdata_example.vcxproj.filters
index 1e8f8c1..1e8f8c1 100644
--- a/deep_test/deep_test.vcxproj.filters
+++ b/deep_userdata_example/deep_userdata_example.vcxproj.filters
diff --git a/deep_test/deep_test.vcxproj.user b/deep_userdata_example/deep_userdata_example.vcxproj.user
index e798643..01e9a17 100644
--- a/deep_test/deep_test.vcxproj.user
+++ b/deep_userdata_example/deep_userdata_example.vcxproj.user
@@ -4,116 +4,116 @@
     <LocalDebuggerCommand>$(SolutionDir)..\Lua53\bin\$(Platform)\Debug\lua53.exe</LocalDebuggerCommand>
     <DebuggerFlavor>WindowsLocalDebugger</DebuggerFlavor>
     <LocalDebuggerCommandArguments>deeptest.lua</LocalDebuggerCommandArguments>
-    <LocalDebuggerWorkingDirectory>$(SolutionDir)Lanes\lanes\deep_test\</LocalDebuggerWorkingDirectory>
+    <LocalDebuggerWorkingDirectory>$(SolutionDir)Lanes\lanes\deep_userdata_example\</LocalDebuggerWorkingDirectory>
     <RemoteDebuggerCommandArguments>deeptest.lua</RemoteDebuggerCommandArguments>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug 5.1|x64'">
     <LocalDebuggerCommand>$(SolutionDir)..\Lua51\bin\$(Platform)\Debug\lua51.exe</LocalDebuggerCommand>
     <DebuggerFlavor>WindowsLocalDebugger</DebuggerFlavor>
     <LocalDebuggerCommandArguments>-i deeptest.lua</LocalDebuggerCommandArguments>
-    <LocalDebuggerWorkingDirectory>$(SolutionDir)Lanes\lanes\deep_test\</LocalDebuggerWorkingDirectory>
+    <LocalDebuggerWorkingDirectory>$(SolutionDir)Lanes\lanes\deep_userdata_example\</LocalDebuggerWorkingDirectory>
     <RemoteDebuggerCommandArguments>-i deeptest.lua</RemoteDebuggerCommandArguments>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug 5.2|x64'">
     <LocalDebuggerCommand>$(SolutionDir)..\Lua52\bin\$(Platform)\Debug\lua52.exe</LocalDebuggerCommand>
     <DebuggerFlavor>WindowsLocalDebugger</DebuggerFlavor>
     <LocalDebuggerCommandArguments>-i deeptest.lua</LocalDebuggerCommandArguments>
-    <LocalDebuggerWorkingDirectory>$(SolutionDir)Lanes\lanes\deep_test\</LocalDebuggerWorkingDirectory>
+    <LocalDebuggerWorkingDirectory>$(SolutionDir)Lanes\lanes\deep_userdata_example\</LocalDebuggerWorkingDirectory>
     <RemoteDebuggerCommandArguments>-i deeptest.lua</RemoteDebuggerCommandArguments>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug LuaJIT 2.1.0-beta3|x64'">
     <LocalDebuggerCommand>$(SolutionDir)..\LuaJIT-2.1.0-beta3\bin\$(Platform)\luajit210.exe</LocalDebuggerCommand>
     <DebuggerFlavor>WindowsLocalDebugger</DebuggerFlavor>
     <LocalDebuggerCommandArguments>-i</LocalDebuggerCommandArguments>
-    <LocalDebuggerWorkingDirectory>$(SolutionDir)Lanes\lanes\deep_test\</LocalDebuggerWorkingDirectory>
+    <LocalDebuggerWorkingDirectory>$(SolutionDir)Lanes\lanes\deep_userdata_example\</LocalDebuggerWorkingDirectory>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug LuaJIT 2.0.5|x64'">
     <LocalDebuggerCommand>$(SolutionDir)..\LuaJIT-2.0.5\bin\$(Platform)\luajit205.exe</LocalDebuggerCommand>
     <DebuggerFlavor>WindowsLocalDebugger</DebuggerFlavor>
     <LocalDebuggerCommandArguments>-i</LocalDebuggerCommandArguments>
-    <LocalDebuggerWorkingDirectory>$(SolutionDir)Lanes\lanes\deep_test\</LocalDebuggerWorkingDirectory>
+    <LocalDebuggerWorkingDirectory>$(SolutionDir)Lanes\lanes\deep_userdata_example\</LocalDebuggerWorkingDirectory>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug LuaJIT GIT|x64'">
     <LocalDebuggerCommand>$(SolutionDir)..\LuaJIT-GIT\bin\$(Platform)\luajitgit.exe</LocalDebuggerCommand>
     <DebuggerFlavor>WindowsLocalDebugger</DebuggerFlavor>
     <LocalDebuggerCommandArguments>-i</LocalDebuggerCommandArguments>
-    <LocalDebuggerWorkingDirectory>$(SolutionDir)Lanes\lanes\deep_test\</LocalDebuggerWorkingDirectory>
+    <LocalDebuggerWorkingDirectory>$(SolutionDir)Lanes\lanes\deep_userdata_example\</LocalDebuggerWorkingDirectory>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug 5.4|x64'">
     <LocalDebuggerCommand>$(SolutionDir)..\framework\lua54.exe</LocalDebuggerCommand>
     <DebuggerFlavor>WindowsLocalDebugger</DebuggerFlavor>
     <LocalDebuggerCommandArguments>deeptest.lua</LocalDebuggerCommandArguments>
-    <LocalDebuggerWorkingDirectory>$(SolutionDir)Lanes\lanes\deep_test\</LocalDebuggerWorkingDirectory>
+    <LocalDebuggerWorkingDirectory>$(SolutionDir)Lanes\lanes\deep_userdata_example\</LocalDebuggerWorkingDirectory>
     <RemoteDebuggerCommandArguments>deeptest.lua</RemoteDebuggerCommandArguments>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug MoonJIT|x64'">
     <LocalDebuggerCommand>$(SolutionDir)..\MoonJIT\bin\$(Platform)\moonjit.exe</LocalDebuggerCommand>
     <DebuggerFlavor>WindowsLocalDebugger</DebuggerFlavor>
     <LocalDebuggerCommandArguments>-i deeptest.lua</LocalDebuggerCommandArguments>
-    <LocalDebuggerWorkingDirectory>$(SolutionDir)Lanes\lanes\deep_test\</LocalDebuggerWorkingDirectory>
+    <LocalDebuggerWorkingDirectory>$(SolutionDir)Lanes\lanes\deep_userdata_example\</LocalDebuggerWorkingDirectory>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release 5.3|x64'">
     <LocalDebuggerCommand>$(SolutionDir)..\Lua53\bin\$(Platform)\Release\lua53.exe</LocalDebuggerCommand>
     <DebuggerFlavor>WindowsLocalDebugger</DebuggerFlavor>
     <LocalDebuggerCommandArguments>-i -- deeptest.lua</LocalDebuggerCommandArguments>
-    <LocalDebuggerWorkingDirectory>$(SolutionDir)Lanes\lanes\deep_test\</LocalDebuggerWorkingDirectory>
+    <LocalDebuggerWorkingDirectory>$(SolutionDir)Lanes\lanes\deep_userdata_example\</LocalDebuggerWorkingDirectory>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release 5.4|x64'">
     <LocalDebuggerCommand>$(SolutionDir)..\framework\lua54.exe</LocalDebuggerCommand>
     <DebuggerFlavor>WindowsLocalDebugger</DebuggerFlavor>
     <LocalDebuggerCommandArguments>-i -- deeptest.lua</LocalDebuggerCommandArguments>
-    <LocalDebuggerWorkingDirectory>$(SolutionDir)Lanes\lanes\deep_test\</LocalDebuggerWorkingDirectory>
+    <LocalDebuggerWorkingDirectory>$(SolutionDir)Lanes\lanes\deep_userdata_example\</LocalDebuggerWorkingDirectory>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug LuaJIT 2.1.0-beta3|Win32'">
     <LocalDebuggerCommand>$(SolutionDir)..\LuaJIT-2.1.0-beta3\bin\$(Platform)\luajit210.exe</LocalDebuggerCommand>
     <DebuggerFlavor>WindowsLocalDebugger</DebuggerFlavor>
     <LocalDebuggerCommandArguments>-i</LocalDebuggerCommandArguments>
-    <LocalDebuggerWorkingDirectory>$(SolutionDir)Lanes\lanes\deep_test\</LocalDebuggerWorkingDirectory>
+    <LocalDebuggerWorkingDirectory>$(SolutionDir)Lanes\lanes\deep_userdata_example\</LocalDebuggerWorkingDirectory>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug LuaJIT 2.0.5|Win32'">
     <LocalDebuggerCommand>$(SolutionDir)..\LuaJIT-2.0.5\bin\$(Platform)\luajit205.exe</LocalDebuggerCommand>
     <DebuggerFlavor>WindowsLocalDebugger</DebuggerFlavor>
     <LocalDebuggerCommandArguments>-i</LocalDebuggerCommandArguments>
-    <LocalDebuggerWorkingDirectory>$(SolutionDir)Lanes\lanes\deep_test\</LocalDebuggerWorkingDirectory>
+    <LocalDebuggerWorkingDirectory>$(SolutionDir)Lanes\lanes\deep_userdata_example\</LocalDebuggerWorkingDirectory>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug LuaJIT GIT|Win32'">
     <LocalDebuggerCommand>$(SolutionDir)..\LuaJIT-2.0.5\bin\$(Platform)\luajit205.exe</LocalDebuggerCommand>
     <DebuggerFlavor>WindowsLocalDebugger</DebuggerFlavor>
     <LocalDebuggerCommandArguments>-i</LocalDebuggerCommandArguments>
-    <LocalDebuggerWorkingDirectory>$(SolutionDir)Lanes\lanes\deep_test\</LocalDebuggerWorkingDirectory>
+    <LocalDebuggerWorkingDirectory>$(SolutionDir)Lanes\lanes\deep_userdata_example\</LocalDebuggerWorkingDirectory>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release 5.4|Win32'">
-    <LocalDebuggerWorkingDirectory>$(SolutionDir)Lanes\lanes\deep_test\</LocalDebuggerWorkingDirectory>
+    <LocalDebuggerWorkingDirectory>$(SolutionDir)Lanes\lanes\deep_userdata_example\</LocalDebuggerWorkingDirectory>
     <DebuggerFlavor>WindowsLocalDebugger</DebuggerFlavor>
     <LocalDebuggerCommand>$(SolutionDir)..\framework\lua54.exe</LocalDebuggerCommand>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug 5.1|Win32'">
-    <LocalDebuggerWorkingDirectory>$(SolutionDir)Lanes\lanes\deep_test\</LocalDebuggerWorkingDirectory>
+    <LocalDebuggerWorkingDirectory>$(SolutionDir)Lanes\lanes\deep_userdata_example\</LocalDebuggerWorkingDirectory>
     <DebuggerFlavor>WindowsLocalDebugger</DebuggerFlavor>
     <LocalDebuggerCommand>$(SolutionDir)..\Lua52\bin\$(Platform)\Debug\lua51.exe</LocalDebuggerCommand>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug 5.2|Win32'">
-    <LocalDebuggerWorkingDirectory>$(SolutionDir)Lanes\lanes\deep_test\</LocalDebuggerWorkingDirectory>
+    <LocalDebuggerWorkingDirectory>$(SolutionDir)Lanes\lanes\deep_userdata_example\</LocalDebuggerWorkingDirectory>
     <DebuggerFlavor>WindowsLocalDebugger</DebuggerFlavor>
     <LocalDebuggerCommand>$(SolutionDir)..\Lua51\bin\$(Platform)\Debug\lua52.exe</LocalDebuggerCommand>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug 5.3|Win32'">
-    <LocalDebuggerWorkingDirectory>$(SolutionDir)Lanes\lanes\deep_test\</LocalDebuggerWorkingDirectory>
+    <LocalDebuggerWorkingDirectory>$(SolutionDir)Lanes\lanes\deep_userdata_example\</LocalDebuggerWorkingDirectory>
     <DebuggerFlavor>WindowsLocalDebugger</DebuggerFlavor>
     <LocalDebuggerCommand>$(SolutionDir)..\Lua53\bin\$(Platform)\Debug\lua53.exe</LocalDebuggerCommand>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug 5.4|Win32'">
-    <LocalDebuggerWorkingDirectory>$(SolutionDir)Lanes\lanes\deep_test\</LocalDebuggerWorkingDirectory>
+    <LocalDebuggerWorkingDirectory>$(SolutionDir)Lanes\lanes\deep_userdata_example\</LocalDebuggerWorkingDirectory>
     <DebuggerFlavor>WindowsLocalDebugger</DebuggerFlavor>
     <LocalDebuggerCommand>$(SolutionDir)..\framework\lua54.exe</LocalDebuggerCommand>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug MoonJIT|Win32'">
-    <LocalDebuggerWorkingDirectory>$(SolutionDir)Lanes\lanes\deep_test\</LocalDebuggerWorkingDirectory>
+    <LocalDebuggerWorkingDirectory>$(SolutionDir)Lanes\lanes\deep_userdata_example\</LocalDebuggerWorkingDirectory>
     <DebuggerFlavor>WindowsLocalDebugger</DebuggerFlavor>
     <LocalDebuggerCommand>$(SolutionDir)..\MoonJIT\bin\$(Platform)\moonjit.exe</LocalDebuggerCommand>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release 5.3|Win32'">
-    <LocalDebuggerWorkingDirectory>$(SolutionDir)Lanes\lanes\deep_test\</LocalDebuggerWorkingDirectory>
+    <LocalDebuggerWorkingDirectory>$(SolutionDir)Lanes\lanes\deep_userdata_example\</LocalDebuggerWorkingDirectory>
     <DebuggerFlavor>WindowsLocalDebugger</DebuggerFlavor>
     <LocalDebuggerCommand>$(SolutionDir)..\Lua53\bin\$(Platform)\Release\lua53.exe</LocalDebuggerCommand>
   </PropertyGroup>
diff --git a/deep_userdata_example/deeptest.lua b/deep_userdata_example/deeptest.lua
new file mode 100644
index 0000000..6ef4b74
--- /dev/null
+++ b/deep_userdata_example/deeptest.lua
@@ -0,0 +1,159 @@
+local lanes = require("lanes").configure{ with_timers = false}
+local l = lanes.linda "my linda"
+
+local table_unpack = table.unpack or unpack -- Lua 5.1 support
+
+-- we will transfer userdata created by this module, so we need to make Lanes aware of it
+local dt = lanes.require "deep_userdata_example"
+
+-- set DEEP to any non-false value to run the Deep Userdata tests. "gc" selects a special test for debug purposes
+DEEP = DEEP or true
+-- set CLONABLE to any non-false value to run the Clonable Userdata tests
+CLONABLE = CLONABLE or true
+
+-- lua 5.1->5.2 support a single table uservalue
+-- lua 5.3->5.4 supports an arbitrary type uservalue
+local test_uvtype = (_VERSION == "Lua 5.4") and "function" or (_VERSION == "Lua 5.3") and "string" or "table"
+-- lua 5.4 supports multiple uservalues
+local nupvals = _VERSION == "Lua 5.4" and 3 or 1
+
+local makeUserValue = function( obj_)
+        if test_uvtype == "table" then
+                return {"some uservalue"}
+        elseif test_uvtype == "string" then
+                return "some uservalue"
+        elseif test_uvtype == "function" then
+                -- a function that pull the userdata as upvalue
+                local f = function()
+                        return "-> '" .. tostring( obj_) .. "'"
+                end
+                return f
+        end
+end
+
+local printDeep = function( prefix_, obj_, t_)
+        print( prefix_, obj_)
+        for uvi = 1, nupvals do
+                local uservalue = obj_:getuv(uvi)
+                print ("uv #" .. uvi, type( uservalue), uservalue, type(uservalue) == "function" and uservalue() or "")
+        end
+        if t_ then
+                local count = 0
+                for k, v in ipairs( t_) do
+                        print( "t["..tostring(k).."]", v)
+                        count = count + 1
+                end
+                -- we should have only 2 indexed entries with the same value
+                assert(count == 2 and t_[1] == t_[2])
+        end
+        print()
+end
+
+local performTest = function( obj_)
+        -- setup the userdata with some value and a uservalue
+        obj_:set( 666)
+        obj_:setuv( 1, makeUserValue( obj_))
+        if nupvals > 1 then
+                -- keep uv #2 as nil
+                obj_:setuv( 3, "ENDUV")
+        end
+
+        local t =
+        {
+                -- two indices with an identical value: we should also have identical values on the other side (even if not the same as the original ones when they are clonables)
+                obj_,
+                obj_,
+                -- this one won't transfer because we don't support full uservalue as keys
+                [obj_] = "val"
+        }
+
+        -- read back the contents of the object
+        printDeep( "immediate:", obj_, t)
+
+        -- send the object in a linda, get it back out, read the contents
+        l:set( "key", obj_, t)
+        -- when obj_ is a deep userdata, out is the same userdata as obj_ (not another one pointing on the same deep memory block) because of an internal cache table [deep*] -> proxy)
+        -- when obj_ is a clonable userdata, we get a different clone everytime we cross a linda or lane barrier
+        local _n, _val1, _val2 = l:get( "key", 2)
+        assert(_n == (_val2 and 2 or 1))
+        printDeep( "out of linda:", _val1, _val2)
+
+        -- send the object in a lane through argument passing, the lane body returns it as return value, read the contents
+        local g = lanes.gen(
+                "package"
+                , {
+                        required = { "deep_userdata_example"} -- we will transfer userdata created by this module, so we need to make this lane aware of it
+                }
+                , function( arg_, t_)
+                        -- read contents inside lane: arg_ and t_ by argument
+                        printDeep( "in lane, as arguments:", arg_, t_)
+                        -- read contents inside lane: obj_ and t by upvalue
+                        printDeep( "in lane, as upvalues:", obj_, t)
+                        -- read contents inside lane: in linda
+                        local _n, _val1, _val2 = l:get( "key", 2)
+                        assert(_n == (_val2 and 2 or 1))
+                        printDeep( "in lane, from linda:", _val1, _val2)
+                        return arg_, t_
+                end
+        )
+        h = g( obj_, t)
+        -- when obj_ is a deep userdata, from_lane is the same userdata as obj_ (not another one pointing on the same deep memory block) because of an internal cache table [deep*] -> proxy)
+        -- when obj_ is a clonable userdata, we get a different clone everytime we cross a linda or lane barrier
+        printDeep( "from lane:", h[1], h[2])
+end
+
+if DEEP then
+        print "================================================================"
+        print "DEEP"
+        local d = dt.new_deep(nupvals)
+        if type(DEEP) == "string" then
+                local gc_tests = {
+                        thrasher = function(repeat_, size_)
+                                print "in thrasher"
+                                -- result is a table of repeat_ tables, each containing size_ entries
+                                local result = {}
+                                for i = 1, repeat_ do
+                                        local batch_values = {}
+                                        for j = 1, size_ do
+                                                table.insert(batch_values, j)
+                                        end
+                                        table.insert(result, batch_values)
+                                end
+                                print "thrasher done"
+                                return result
+                        end,
+                        stack_abuser = function(repeat_, size_)
+                                print "in stack_abuser"
+                                for i = 1, repeat_ do
+                                        local batch_values = {}
+                                        for j = 1, size_ do
+                                                table.insert(batch_values, j)
+                                        end
+                                        -- return size_ values
+                                        local _ = table_unpack(batch_values)
+                                end
+                                print "stack_abuser done"
+                                return result
+                        end
+                }
+                -- have the object call the function from inside one of its functions, to detect if it gets collected from there (while in use!)
+                local testf = gc_tests[DEEP]
+                if testf then
+                        local r = d:invoke(gc_tests[DEEP], REPEAT or 10, SIZE or 10)
+                        print("invoke -> ", tostring(r))
+                else
+                        print("unknown test '" .. DEEP .. "'")
+                end
+        else
+                performTest(d)
+        end
+end
+
+if CLONABLE then
+        print "================================================================"
+        print "CLONABLE"
+        performTest( dt.new_clonable(nupvals))
+end
+
+print "================================================================"
+print "TEST OK"
\ No newline at end of file
diff --git a/docs/index.html b/docs/index.html
index 49cb592..d7717dc 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -1832,7 +1832,7 @@ static int clonable_lanesclone(lua_State* L)
         <b>NOTE</b>: In the event the source userdata has uservalues, it is not necessary to create them for the clone, Lanes will handle their cloning.<br />
         Of course, more complex objects may require smarter cloning behavior than a simple <tt>memcpy</tt>. Also, the module initialisation code should make each metatable accessible from the module table itself as in:
 <table border="1" bgcolor="#FFFFE0" cellpadding="10" style="width:50%"><tr><td><pre>
-int luaopen_deep_test(lua_State* L)
+int luaopen_deep_userdata_example(lua_State* L)
 {
         luaL_newlib(L, deep_module);
 
@@ -1898,7 +1898,7 @@ static MyDeepFactory g_MyDeepFactory;
                         <li><tt>createMetatable()</tt>: should build a metatable for the object. Don't cache the metatable yourself, Lanes takes care of it (<tt>createMetatable</tt> should only be invoked once per state). Just push the metatable on the stack.</li>
                         <li><tt>moduleName()</tt>: requests the name of the module that exports the factory, to be returned. It is necessary so that Lanes can require it in any lane state that receives a userdata. This is to prevent crashes in situations where the module could be unloaded while the factory pointer is still held.</li>
                 </ul>
-                Take a look at <tt>LindaFactory</tt> in <tt>lindafactory.cpp</tt> or <tt>MyDeepFactory</tt> in <tt>deep_test.cpp</tt>.
+                Take a look at <tt>LindaFactory</tt> in <tt>lindafactory.cpp</tt> or <tt>MyDeepFactory</tt> in <tt>deep_userdata_example.cpp</tt>.
         </li>
         <li>Include <tt>"_pch.hpp", "deep.hpp"</tt> and either link against Lanes or statically compile <tt>compat.cpp deep.cpp</tt> into your module if you want to avoid a runtime dependency for users that will use your module without Lanes.
         <li>Instanciate your userdata using <tt>yourFactoryObject.pushDeepUserdata()</tt>, instead of the regular <tt>lua_newuserdata()</tt>. Given a <tt>factory</tt>, it sets up the support structures and returns a state-specific proxy full userdata for accessing your data. This proxy can also be copied over to other lanes.</li>
diff --git a/unit_tests/deep_tests.cpp b/unit_tests/deep_tests.cpp
index 2c9ccdf..e21072c 100644
--- a/unit_tests/deep_tests.cpp
+++ b/unit_tests/deep_tests.cpp
@@ -2,19 +2,19 @@
 #include "shared.h"
 
 // yeah it's dirty, I will do better someday
-#include "../deep_test/deep_test.cpp"
+#include "../deep_userdata_example/deep_userdata_example.cpp"
 
 
 // #################################################################################################
 // #################################################################################################
 
-TEST_CASE("misc.deep_test")
+TEST_CASE("misc.deep_userdata.example")
 {
     LuaState S{ LuaState::WithBaseLibs{ true }, LuaState::WithFixture{ true } };
     S.requireSuccess(
         " lanes = require 'lanes'.configure()"
         " fixture = require 'fixture'"
-        " deep_test = require 'deep_test'"
+        " due = require 'deep_userdata_example'"
     );
 
     SECTION("garbage collection collects")
@@ -24,8 +24,8 @@ TEST_CASE("misc.deep_test")
         if constexpr (LUA_VERSION_NUM >= 503) { // Lua < 5.3 only supports a table uservalue
             S.requireSuccess(
                 // create a deep userdata object without referencing it. First uservalue is a function, and should be called on __gc
-                " deep_test.new_deep(1):setuv(1, function() collected = collected and collected + 1 or 1 end)"
-                " deep_test.new_deep(1):setuv(1, function() collected = collected and collected + 1 or 1 end)"
+                " due.new_deep(1):setuv(1, function() collected = collected and collected + 1 or 1 end)"
+                " due.new_deep(1):setuv(1, function() collected = collected and collected + 1 or 1 end)"
                 " collectgarbage()"                         // and collect it
                 " assert(collected == 2)"
             );
@@ -37,7 +37,7 @@ TEST_CASE("misc.deep_test")
     SECTION("reference counting")
     {
         S.requireSuccess(
-            " d = deep_test.new_deep(1)"                   // create a deep userdata object
+            " d = due.new_deep(1)"                         // create a deep userdata object
             " d:set(42)"                                   // set some value
             " assert(d:refcount() == 1)"
         );
@@ -73,7 +73,7 @@ TEST_CASE("misc.deep_test")
     SECTION("collection from inside a Linda")
     {
         S.requireSuccess(
-            " d = deep_test.new_deep(1)"                   // create a deep userdata object
+            " d = due.new_deep(1)"                         // create a deep userdata object
             " d:set(42)"                                   // set some value
             " assert(d:refcount() == 1)"
         );
@@ -89,7 +89,7 @@ TEST_CASE("misc.deep_test")
             " l = nil"
             " collectgarbage()"                            // clears the linda, removes its storage from the keeper
             " lanes.collectgarbage()"                      // collect garbage inside the keepers too, to finish cleanup
-            " assert(deep_test.get_deep_count() == 0)"
+            " assert(due.get_deep_count() == 0)"
         );
     }
 }
\ No newline at end of file
diff --git a/unit_tests/shared.cpp b/unit_tests/shared.cpp
index 0c9516f..08025f2 100644
--- a/unit_tests/shared.cpp
+++ b/unit_tests/shared.cpp
@@ -8,7 +8,7 @@
 // #################################################################################################
 // #################################################################################################
 
-LANES_API int luaopen_deep_test(lua_State* L_);
+LANES_API int luaopen_deep_userdata_example(lua_State* L_);
 
 namespace
 {
@@ -70,7 +70,7 @@ namespace
         // a function that enables any lane to require "fixture"
         lua_CFunction sOnStateCreate = +[](lua_State* const L_) {
             PreloadModule(L_, "fixture", luaopen_fixture);
-            PreloadModule(L_, "deep_test", luaopen_deep_test);
+            PreloadModule(L_, "deep_userdata_example", luaopen_deep_userdata_example);
             return 0;
         };
 
@@ -181,7 +181,7 @@ LuaState::LuaState(WithBaseLibs const withBaseLibs_, WithFixture const withFixtu
     if (withFixture_) {
         // make require "fixture" call luaopen_fixture
         local::PreloadModule(L, "fixture", luaopen_fixture);
-        local::PreloadModule(L, "deep_test", luaopen_deep_test);
+        local::PreloadModule(L, "deep_userdata_example", luaopen_deep_userdata_example);
     }
     STACK_CHECK(L, 0);
 }