Some scripting additions

src/anki/script/Logger.cpp

@@ -20,11 +20,14 @@ static inline int pwraplogi(lua_State* l)
 	PtrSize size;
 	(void)size;
 
-	LuaBinder::checkArgsCount(l, 1);
+	if(ANKI_UNLIKELY(LuaBinder::checkArgsCount(l, 1)))
+	{
+		return -1;
+	}
 
 	// Pop arguments
 	const char* arg0;
-	if(LuaBinder::checkString(l, 1, arg0))
+	if(ANKI_UNLIKELY(LuaBinder::checkString(l, 1, arg0)))
 	{
 		return -1;
 	}
@@ -58,11 +61,14 @@ static inline int pwraploge(lua_State* l)
 	PtrSize size;
 	(void)size;
 
-	LuaBinder::checkArgsCount(l, 1);
+	if(ANKI_UNLIKELY(LuaBinder::checkArgsCount(l, 1)))
+	{
+		return -1;
+	}
 
 	// Pop arguments
 	const char* arg0;
-	if(LuaBinder::checkString(l, 1, arg0))
+	if(ANKI_UNLIKELY(LuaBinder::checkString(l, 1, arg0)))
 	{
 		return -1;
 	}
@@ -96,11 +102,14 @@ static inline int pwraplogw(lua_State* l)
 	PtrSize size;
 	(void)size;
 
-	LuaBinder::checkArgsCount(l, 1);
+	if(ANKI_UNLIKELY(LuaBinder::checkArgsCount(l, 1)))
+	{
+		return -1;
+	}
 
 	// Pop arguments
 	const char* arg0;
-	if(LuaBinder::checkString(l, 1, arg0))
+	if(ANKI_UNLIKELY(LuaBinder::checkString(l, 1, arg0)))
 	{
 		return -1;
 	}

src/anki/script/LuaBinder.cpp

@@ -107,15 +107,6 @@ Error LuaBinder::evalString(lua_State* state, const CString& str)
 	return err;
 }
 
-void LuaBinder::checkArgsCount(lua_State* l, I argsCount)
-{
-	I actualArgsCount = lua_gettop(l);
-	if(argsCount != actualArgsCount)
-	{
-		luaL_error(l, "Expecting %d arguments, got %d", argsCount, actualArgsCount);
-	}
-}
-
 void LuaBinder::createClass(lua_State* l, const char* className)
 {
 	lua_newtable(l); // push new table
@@ -219,6 +210,19 @@ Error LuaBinder::checkUserData(lua_State* l, I32 stackIdx, const LuaUserDataType
 	return err;
 }
 
+Error LuaBinder::checkArgsCount(lua_State* l, I argsCount)
+{
+	const I actualArgsCount = lua_gettop(l);
+
+	if(argsCount != actualArgsCount)
+	{
+		lua_pushfstring(l, "Expecting %d arguments, got %d", argsCount, actualArgsCount);
+		return Error::USER_DATA;
+	}
+
+	return Error::NONE;
+}
+
 void* LuaBinder::luaAlloc(lua_State* l, size_t size, U32 alignment)
 {
 	void* ud;

src/anki/script/LuaBinder.h

@@ -230,9 +230,6 @@ public:
 	/// For debugging purposes
 	static void stackDump(lua_State* l);
 
-	/// Make sure that the arguments match the argsCount number
-	static void checkArgsCount(lua_State* l, I argsCount);
-
 	/// Create a new LUA class
 	static void createClass(lua_State* l, const char* className);
 
@@ -248,6 +245,9 @@ public:
 	/// Dump global variables.
 	static void dumpGlobals(lua_State* l, LuaBinderDumpGlobalsCallback& callback);
 
+	/// Make sure that the arguments match the argsCount number
+	static ANKI_USE_RESULT Error checkArgsCount(lua_State* l, I argsCount);
+
 	/// Get a number from the stack.
 	template<typename TNumber>
 	static ANKI_USE_RESULT Error checkNumber(lua_State* l, I stackIdx, TNumber& number)

src/anki/script/Math.xml

@@ -13,12 +13,15 @@ namespace anki {]]></head>
 
 	<classes>
 		<class name="Vec2" serialize="true">
-			<constructor>
-				<args>
-					<arg>F32</arg>
-					<arg>F32</arg>
-				</args>
-			</constructor>
+			<constructors>
+				<constructor></constructor>
+				<constructor>
+					<args>
+						<arg>F32</arg>
+						<arg>F32</arg>
+					</args>
+				</constructor>
+			</constructors>
 			<methods>
 				<method name="getX">
 					<overrideCall>F32 ret = (*self).x();</overrideCall>
@@ -112,13 +115,21 @@ namespace anki {]]></head>
 			</methods>
 		</class>
 		<class name="Vec3" serialize="true">
-			<constructor>
-				<args>
-					<arg>F32</arg>
-					<arg>F32</arg>
-					<arg>F32</arg>
-				</args>
-			</constructor>
+			<constructors>
+				<constructor></constructor>
+				<constructor>
+					<args>
+						<arg>F32</arg>
+					</args>
+				</constructor>
+				<constructor>
+					<args>
+						<arg>F32</arg>
+						<arg>F32</arg>
+						<arg>F32</arg>
+					</args>
+				</constructor>
+			</constructors>
 			<methods>
 				<method name="getX">
 					<overrideCall>F32 ret = (*self).x();</overrideCall>
@@ -224,14 +235,22 @@ namespace anki {]]></head>
 			</methods>
 		</class>
 		<class name="Vec4" serialize="true">
-			<constructor>
-				<args>
-					<arg>F32</arg>
-					<arg>F32</arg>
-					<arg>F32</arg>
-					<arg>F32</arg>
-				</args>
-			</constructor>
+			<constructors>
+				<constructor></constructor>
+				<constructor>
+					<args>
+						<arg>F32</arg>
+					</args>
+				</constructor>
+				<constructor>
+					<args>
+						<arg>F32</arg>
+						<arg>F32</arg>
+						<arg>F32</arg>
+						<arg>F32</arg>
+					</args>
+				</constructor>
+			</constructors>
 			<methods>
 				<method name="getX">
 					<overrideCall>F32 ret = (*self).x();</overrideCall>
@@ -348,7 +367,14 @@ namespace anki {]]></head>
 			</methods>
 		</class>
 		<class name="Mat3">
-			<constructor></constructor>
+			<constructors>
+				<constructor></constructor>
+				<constructor>
+					<args>
+						<arg>F32</arg>
+					</args>
+				</constructor>
+			</constructors>
 			<methods>
 				<method name="operator=">
 					<args>
@@ -388,7 +414,14 @@ namespace anki {]]></head>
 			</methods>
 		</class>
 		<class name="Mat3x4">
-			<constructor></constructor>
+			<constructors>
+				<constructor></constructor>
+				<constructor>
+					<args>
+						<arg>F32</arg>
+					</args>
+				</constructor>
+			</constructors>
 			<methods>
 				<method name="operator=">
 					<args>
@@ -431,7 +464,16 @@ namespace anki {]]></head>
 			</methods>
 		</class>
 		<class name="Transform">
-			<constructor></constructor>
+			<constructors>
+				<constructor></constructor>
+				<constructor>
+					<args>
+						<arg>Vec4</arg>
+						<arg>Mat3x4</arg>
+						<arg>F32</arg>
+					</args>
+				</constructor>
+			</constructors>
 			<methods>
 				<method name="operator=">
 					<args>

src/anki/script/Renderer.cpp

@@ -41,7 +41,10 @@ static inline int pwrapDbggetEnabled(lua_State* l)
 	PtrSize size;
 	(void)size;
 
-	LuaBinder::checkArgsCount(l, 1);
+	if(ANKI_UNLIKELY(LuaBinder::checkArgsCount(l, 1)))
+	{
+		return -1;
+	}
 
 	// Get "this" as "self"
 	if(LuaBinder::checkUserData(l, 1, luaUserDataTypeInfoDbg, ud))
@@ -83,7 +86,10 @@ static inline int pwrapDbgsetEnabled(lua_State* l)
 	PtrSize size;
 	(void)size;
 
-	LuaBinder::checkArgsCount(l, 2);
+	if(ANKI_UNLIKELY(LuaBinder::checkArgsCount(l, 2)))
+	{
+		return -1;
+	}
 
 	// Get "this" as "self"
 	if(LuaBinder::checkUserData(l, 1, luaUserDataTypeInfoDbg, ud))
@@ -95,7 +101,7 @@ static inline int pwrapDbgsetEnabled(lua_State* l)
 
 	// Pop arguments
 	Bool arg0;
-	if(LuaBinder::checkNumber(l, 2, arg0))
+	if(ANKI_UNLIKELY(LuaBinder::checkNumber(l, 2, arg0)))
 	{
 		return -1;
 	}
@@ -147,7 +153,10 @@ static inline int pwrapMainRenderergetAspectRatio(lua_State* l)
 	PtrSize size;
 	(void)size;
 
-	LuaBinder::checkArgsCount(l, 1);
+	if(ANKI_UNLIKELY(LuaBinder::checkArgsCount(l, 1)))
+	{
+		return -1;
+	}
 
 	// Get "this" as "self"
 	if(LuaBinder::checkUserData(l, 1, luaUserDataTypeInfoMainRenderer, ud))
@@ -197,7 +206,10 @@ static inline int pwrapgetMainRenderer(lua_State* l)
 	PtrSize size;
 	(void)size;
 
-	LuaBinder::checkArgsCount(l, 0);
+	if(ANKI_UNLIKELY(LuaBinder::checkArgsCount(l, 0)))
+	{
+		return -1;
+	}
 
 	// Call the function
 	MainRenderer* ret = getMainRenderer(l);

src/anki/script/lua_glue_gen.py

@@ -160,7 +160,7 @@ def arg(arg_txt, stack_index, index):
 
 	if type_is_bool(type) or type_is_number(type):
 		wglue("%s arg%d;" % (type, index))
-		wglue("if(LuaBinder::checkNumber(l, %d, arg%d))" % (stack_index, index))
+		wglue("if(ANKI_UNLIKELY(LuaBinder::checkNumber(l, %d, arg%d)))" % (stack_index, index))
 		wglue("{")
 		ident(1)
 		wglue("return -1;")
@@ -168,7 +168,7 @@ def arg(arg_txt, stack_index, index):
 		wglue("}")
 	elif type == "char" or type == "CString":
 		wglue("const char* arg%d;" % index)
-		wglue("if(LuaBinder::checkString(l, %d, arg%d))" % (stack_index, index))
+		wglue("if(ANKI_UNLIKELY(LuaBinder::checkString(l, %d, arg%d)))" % (stack_index, index))
 		wglue("{")
 		ident(1)
 		wglue("return -1;")
@@ -176,7 +176,7 @@ def arg(arg_txt, stack_index, index):
 		wglue("}")
 	else:
 		wglue("extern LuaUserDataTypeInfo luaUserDataTypeInfo%s;" % type)
-		wglue("if(LuaBinder::checkUserData(l, %d, luaUserDataTypeInfo%s, ud))" % (stack_index, type))
+		wglue("if(ANKI_UNLIKELY(LuaBinder::checkUserData(l, %d, luaUserDataTypeInfo%s, ud)))" % (stack_index, type))
 		wglue("{")
 		ident(1)
 		wglue("return -1;")
@@ -216,18 +216,32 @@ def args(args_el, stack_index):
 
 	return args_str
 
+def count_args(args_el):
+	""" Count the number of arguments """
+
+	if args_el is None:
+		return 0
+
+	count = 0
+	for arg_el in args_el.iter("arg"):
+		count += 1
+
+	return count
+
 def check_args(args_el, bias):
 	""" Check number of args. Call that first because it throws error """
 
-	if args_el is None:
-		wglue("LuaBinder::checkArgsCount(l, %d);" % bias)
+	if args_el is not None:
+		count = bias + count_args(args_el)
 	else:
-		count = 0
-		for arg_el in args_el.iter("arg"):
-			count += 1
-
-		wglue("LuaBinder::checkArgsCount(l, %d);" % (bias + count))
+		count = bias
 
+	wglue("if(ANKI_UNLIKELY(LuaBinder::checkArgsCount(l, %d)))" % count)
+	wglue("{")
+	ident(1)
+	wglue("return -1;")
+	ident(-1)
+	wglue("}")
 	wglue("")
 
 def get_meth_alias(meth_el):
@@ -403,11 +417,11 @@ def static_method(class_name, meth_el):
 	wglue("}")
 	wglue("")
 
-def constructor(constr_el, class_name):
+def constructor(constr_el, class_name, constructor_idx):
 	""" Handle constructor """
 
 	wglue("/// Pre-wrap constructor for %s." % (class_name))
-	wglue("static inline int pwrap%sCtor(lua_State* l)" % class_name)
+	wglue("static inline int pwrap%sCtor%d(lua_State* l)" % (class_name, constructor_idx))
 	wglue("{")
 	ident(1)
 	write_local_vars()
@@ -435,12 +449,53 @@ def constructor(constr_el, class_name):
 	wglue("}")
 	wglue("")
 
-	# Write the actual function
-	wglue("/// Wrap constructor for %s." % class_name)
+def constructors(constructors_el, class_name):
+	""" Wrap all constructors """
+
+	idx = 0
+	func_names_and_arg_counts = []
+
+	# Create the pre-wrap C functions
+	for constructor_el in constructors_el.iter("constructor"):
+		arg_count = count_args(constructor_el.find("args"))
+
+		# Iterate all arg counts and make sure there are no duplicates
+		for i in range(idx):
+			if func_names_and_arg_counts[i][1] == arg_count:
+				raise Exception("Every constructor overload should have a unique arg count. class: %s" % class_name)
+
+		constructor(constructor_el, class_name, idx)
+		func_names_and_arg_counts.append(["pwrap%sCtor%d" % (class_name, idx), arg_count])
+		idx += 1
+
+	if idx == 0:
+		raise Exception("Found no <constructor>")
+
+	# Create the landing function
+	wglue("/// Wrap constructors for %s." % class_name)
 	wglue("static int wrap%sCtor(lua_State* l)" % class_name)
 	wglue("{")
 	ident(1)
-	wglue("int res = pwrap%sCtor(l);" % class_name)
+	if idx == 1:
+		wglue("int res = pwrap%sCtor0(l);" % class_name)
+	else:
+		wglue("// Chose the right overload")
+		wglue("const int argCount = lua_gettop(l);")
+		wglue("int res = 0;")
+		wglue("switch(argCount)")
+		wglue("{")
+		for name_and_arg_count in func_names_and_arg_counts:
+			func_name = name_and_arg_count[0]
+			arg_count = name_and_arg_count[1]
+			wglue("case %d:" % arg_count)
+			wglue("res = %s(l); break;" % func_name)
+
+		wglue("default:")
+		wglue("lua_pushfstring(l, \"Wrong overloaded new. Wrong number of arguments: %d\", argCount);")
+		wglue("res = -1;")
+		wglue("}")
+	wglue("")
+
 	wglue("if(res >= 0)")
 	wglue("{")
 	ident(1)
@@ -461,10 +516,11 @@ def destructor(class_name):
 	wglue("static int wrap%sDtor(lua_State* l)" % class_name)
 	wglue("{")
 	ident(1)
-	write_local_vars();
+	write_local_vars()
 
-	wglue("LuaBinder::checkArgsCount(l, 1);")
-	wglue("if(LuaBinder::checkUserData(l, 1, luaUserDataTypeInfo%s, ud))" % class_name)
+	check_args(None, 1)
+
+	wglue("if(ANKI_UNLIKELY(LuaBinder::checkUserData(l, 1, luaUserDataTypeInfo%s, ud)))" % class_name)
 	wglue("{")
 	ident(1)
 	wglue("return -1;")
@@ -529,10 +585,10 @@ def class_(class_el):
 
 	# Constructor declarations
 	has_constructor = False
-	constructor_el = class_el.find("constructor")
-	if constructor_el is not None:
-		constructor(constructor_el, class_name)
+	constructors_el = class_el.find("constructors")
+	if constructors_el is not None:
 		has_constructor = True
+		constructors(constructors_el, class_name)
 
 	# Destructor declarations
 	if has_constructor:
@@ -707,4 +763,3 @@ def main():
 
 if __name__ == "__main__":
 	main()
-