Merge pull request #130 from gilzoide/feature/typed-dictionary

Add support for defining typed dictionaries in Lua

Author: gilzoide

CHANGELOG.md

@@ -2,12 +2,15 @@
 ## [Unreleased](https://github.com/gilzoide/lua-gdextension/compare/0.5.0...HEAD)
 ### Added
 - Support for constructing typed arrays in Lua using the idiom `Array[some_type]()`
-- Support for typed arrays and classes in exported properties:
+- Support for constructing typed dictionaries in Lua using the idiom `Dictionary[key_type][value_type]()`
+- Support for typed arrays, typed dictionaries and classes in exported properties:
   ```lua
   MyScript.exported_node_array = export(Array[Node])
+  MyScript.exported_int_valued_dict = export(Dictionary[Variant][int])
   MyScript.exported_texture_property = export(Texture)
   -- or
   MyScript.exported_node_array = export({ type = Array[Node] })
+  MyScript.exported_int_valued_dict = export({ type = Dictionary[Variant][int] })
   MyScript.exported_texture_property = export({ type = Texture })
   ```
 

README.md

@@ -25,7 +25,8 @@ This plugin is available in the Asset Library as:
     + Create and manipulate Variant values
     + Instantiate objects and access class constants
     + Access singleton objects by name
-    + Utility functions, like `print_rich`, `lerp` and `is_same`
+    + Global utility functions, like Godot's `print_rich`, `lerp` and `is_same`.
+      Also adds an `await` function that mimics GDScript's `await` keyword (only supported when running in a coroutine).
     + Global enums, like `OK`, `TYPE_STRING` and `SIDE_LEFT`
     + Patch Lua `package.searchers`, `require`, `loadfile` and `dofile` to accept paths relative to `res://` and `user://`
 - Editor plugin with Lua REPL for testing out Lua snippets
@@ -134,6 +135,18 @@ lua.do_string("""
   print(n:is_inside_tree())  -- false
   n:queue_free()
   ```
+- Typed Arrays and Dictionaries are also supported
+  ```lua
+  -- Element type: int
+  local int_array = Array[int]()
+  -- Element type: Node
+  local node_array = Array[Node]()
+  
+  -- Key: int, Value: bool
+  local int_to_bool_dict = Dictionary[int][bool]()
+  -- Key: Variant, Value: Node
+  local node_valued_dict = Dictionary[Variant][Node]()
+  ```
 - Call Godot utility functions.
   ```lua
   local d1 = Dictionary()

src/luaopen/variant.cpp

@@ -31,7 +31,6 @@
 #include "../utils/IndexedIterator.hpp"
 #include "../utils/ObjectIterator.hpp"
 #include "../utils/VariantType.hpp"
-#include "../utils/VariantTypedArray.hpp"
 #include "../utils/MethodBindByName.hpp"
 #include "../utils/convert_godot_lua.hpp"
 #include "../utils/convert_godot_std.hpp"
@@ -227,7 +226,6 @@ extern "C" int luaopen_godot_variant(lua_State *L) {
 
 	MethodBindByName::register_usertype(state);
 	VariantType::register_usertype(state);
-	VariantTypedArray::register_usertype(state);
 
 	state.set("typeof", &variant_get_type);
 

src/script-language/LuaScriptProperty.cpp

@@ -27,7 +27,6 @@
 #include "../utils/Class.hpp"
 #include "../utils/VariantArguments.hpp"
 #include "../utils/VariantType.hpp"
-#include "../utils/VariantTypedArray.hpp"
 #include "../utils/convert_godot_lua.hpp"
 
 #include <godot_cpp/classes/node.hpp>
@@ -53,14 +52,12 @@ static LuaScriptProperty lua_property(sol::this_state L, sol::stack_object value
 	// index 1: either a Variant type or the default value
 	if (auto type = table.get<sol::optional<VariantType>>(1)) {
 		property.type = type->get_type();
+		if (type->has_type_hints()) {
+			property.hint = type->get_property_hint();
+			property.hint_string = type->get_property_hint_string();
+		}
 		property.default_value = type->construct_default();
 	}
-	else if (auto typed_array = table.get<sol::optional<VariantTypedArray>>(1)) {
-		property.type = Variant::Type::ARRAY;
-		property.hint = PROPERTY_HINT_ARRAY_TYPE;
-		property.hint_string = typed_array->get_hint_string();
-		property.default_value = typed_array->construct_default();
-	}
 	else if (auto cls = table.get<sol::optional<Class>>(1)) {
 		property.type = Variant::Type::OBJECT;
 		property.class_name = cls->get_name();
@@ -80,16 +77,12 @@ static LuaScriptProperty lua_property(sol::this_state L, sol::stack_object value
 	// PropertyInfo fields
 	if (auto type = table.get<sol::optional<VariantType>>("type")) {
 		property.type = type->get_type();
-		if (property.default_value.get_type() == Variant::Type::NIL) {
-			property.default_value = type->construct_default();
+		if (type->has_type_hints()) {
+			property.hint = type->get_property_hint();
+			property.hint_string = type->get_property_hint_string();
 		}
-	}
-	else if (auto typed_array = table.get<sol::optional<VariantTypedArray>>("type")) {
-		property.type = Variant::Type::ARRAY;
-		property.hint = PROPERTY_HINT_ARRAY_TYPE;
-		property.hint_string = typed_array->get_hint_string();
-		if (property.default_value.get_type() == Variant::Type::NIL) {
-			property.default_value = typed_array->construct_default();
+		if (property.default_value == Variant()) {
+			property.default_value = type->construct_default();
 		}
 	}
 	if (auto hint = table.get<sol::optional<uint32_t>>("hint")) {
@@ -125,10 +118,11 @@ static LuaScriptProperty lua_property(sol::this_state L, sol::stack_object value
 	}
 
 	if (property.type == 0) {
-		property.type = property.default_value.get_type();
-		if (property.default_value.get_type() == Variant::Type::ARRAY && Array(property.default_value).is_typed()) {
-			property.hint = PROPERTY_HINT_ARRAY_TYPE;
-			property.hint_string = VariantTypedArray::of(property.default_value).get_hint_string();
+		VariantType type = VariantType::from_variant(property.default_value);
+		property.type = type.get_type();
+		if (type.has_type_hints()) {
+			property.hint = type.get_property_hint();
+			property.hint_string = type.get_property_hint_string();
 		}
 	}
 	property.usage |= PROPERTY_USAGE_SCRIPT_VARIABLE;