Replace "!" in Lua path/cpath when changing it

This way we match Lua's behavior of replacing "!" when opening the package library instead of doing so in every call to searchpath

Author: gilzoide

CHANGELOG.md

@@ -8,6 +8,9 @@
 - `LuaState.LoadMode` enum for specifying the Lua load mode: text, binary or any
 - `LuaState.do_buffer` and `LuaState.load_buffer` methods for loading Lua code from possibly binary chunks
 - `LuaState.package_path` and `LuaState.package_cpath` properties for accessing the value of Lua's [`package.path`](https://www.lua.org/manual/5.4/manual.html#pdf-package.path) and [`package.cpath`](https://www.lua.org/manual/5.4/manual.html#pdf-package.cpath)
+- `LuaState.get_lua_exec_dir` static method to get the executable directory used to replace "!" when setting `package_path` and `package_cpath` properties.
+  When running in the Godot editor, it returns the globalized version of `res://` path.
+  Otherwise, it returns the base directory of the executable.
 - Advanced project settings for setting the `LuaScriptLanguage` state's `package_path` and `package_cpath` properties
 
 ### Changed

src/LuaState.cpp

@@ -28,7 +28,9 @@
 #include "utils/module_names.hpp"
 
 #include <godot_cpp/core/binder_common.hpp>
-#include <godot_cpp/classes/file_access.hpp>
+#include <godot_cpp/classes/engine.hpp>
+#include <godot_cpp/classes/os.hpp>
+#include <godot_cpp/classes/project_settings.hpp>
 #include <luaconf.h>
 
 namespace luagdextension {
@@ -191,6 +193,7 @@ void LuaState::set_package_path(const String& path) {
 			path.replace(";;", LUA_PATH_SEP LUA_PATH_DEFAULT LUA_PATH_SEP)
 				.rstrip(LUA_PATH_SEP)
 				.lstrip(LUA_PATH_SEP)
+				.replace(LUA_EXEC_DIR, get_lua_exec_dir())
 		);
 	}
 	else {
@@ -204,13 +207,20 @@ void LuaState::set_package_cpath(const String& cpath) {
 			cpath.replace(";;", LUA_PATH_SEP LUA_CPATH_DEFAULT LUA_PATH_SEP)
 				.rstrip(LUA_PATH_SEP)
 				.lstrip(LUA_PATH_SEP)
+				.replace(LUA_EXEC_DIR, get_lua_exec_dir())
 		);
 	}
 	else {
 		ERR_FAIL_MSG("LUA_PACKAGE library is not opened");
 	}
 }
 
+String LuaState::get_lua_exec_dir() {
+	return Engine::get_singleton()->is_editor_hint()
+		? ProjectSettings::get_singleton()->globalize_path("res://")
+		: OS::get_singleton()->get_executable_path().get_base_dir();
+}
+
 LuaState *LuaState::find_lua_state(lua_State *L) {
 	L = sol::main_thread(L);
 	if (LuaState **ptr = valid_states.getptr(L)) {
@@ -268,6 +278,7 @@ void LuaState::_bind_methods() {
 	ClassDB::bind_method(D_METHOD("get_package_cpath"), &LuaState::get_package_cpath);
 	ClassDB::bind_method(D_METHOD("set_package_path", "path"), &LuaState::set_package_path);
 	ClassDB::bind_method(D_METHOD("set_package_cpath", "cpath"), &LuaState::set_package_cpath);
+	ClassDB::bind_static_method(LuaState::get_class_static(), D_METHOD("get_lua_exec_dir"), &LuaState::get_lua_exec_dir);
 
 	// Properties
 	ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "globals", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NONE, LuaTable::get_class_static()), "", "get_globals");

src/LuaState.hpp

@@ -120,6 +120,7 @@ class LuaState : public RefCounted {
 
 	operator String() const;
 
+	static String get_lua_exec_dir();
 	static LuaState *find_lua_state(lua_State *L);
 
 protected:

src/luaopen/local_paths.cpp

@@ -21,17 +21,12 @@
  */
 
 #include "../LuaTable.hpp"
+#include "../generated/package_searcher.h"
 #include "../utils/convert_godot_lua.hpp"
 #include "../utils/load_fileaccess.hpp"
-#include "sol/forward.hpp"
-#include "sol/load_result.hpp"
 
-#include <godot_cpp/classes/engine.hpp>
 #include <godot_cpp/classes/file_access.hpp>
-#include <godot_cpp/classes/os.hpp>
-#include <godot_cpp/classes/project_settings.hpp>
-
-#include "../generated/package_searcher.h"
+#include <luaconf.h>
 
 using namespace luagdextension;
 
@@ -43,15 +38,11 @@ static int l_searchpath(lua_State *L) {
 	if (!sep.is_empty()) {
 		name = name.replace(sep, rep);
 	}
-
-	String execdir_repl = Engine::get_singleton()->is_editor_hint()
-		? ProjectSettings::get_singleton()->globalize_path("res://")
-		: OS::get_singleton()->get_executable_path().get_base_dir();
 
-	PackedStringArray path_list = path.split(";", false);
+	PackedStringArray path_list = path.split(LUA_PATH_SEP, false);
 	PackedStringArray not_found_list;
 	for (const String& path_template : path_list) {
-		String filename = path_template.replace("?", name).replace("!", execdir_repl);
+		String filename = path_template.replace(LUA_PATH_MARK, name);
 		if (FileAccess::file_exists(filename)) {
 			sol::stack::push(L, filename);
 			return 1;

test/gdscript_tests/package_path.gd

@@ -7,7 +7,6 @@ var initial_package_cpath
 
 func _init():
 	lua_state = LuaState.new()
-	lua_state.registry.LUA_NOENV = true
 	lua_state.open_libraries()
 	initial_package_path = lua_state.package_path
 	initial_package_cpath = lua_state.package_cpath
@@ -25,6 +24,7 @@ func test_package_path() -> bool:
 func test_package_cpath() -> bool:
 	var package_cpath = "!/?.so"
 	lua_state.package_cpath = package_cpath
+	package_cpath = package_cpath.replace("!", LuaState.get_lua_exec_dir())
 	assert(lua_state.package_cpath == package_cpath)
 	assert(lua_state.globals.package.path != package_cpath)
 	assert(lua_state.globals.package.cpath == package_cpath)