Check - Revision history

Tails at 23:03, 17 July 2018

2018-07-17T23:03:41Z

← Older revision		Revision as of 23:03, 17 July 2018
Line 15:		Line 15:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function check(pattern, ...)		function check(pattern, ...)
	if ~~not pattern or~~ type(pattern) ~= 'string' then check('s', pattern) end		if type(pattern) ~= 'string' then check('s', pattern) end
	local types = {s = "string", n = "number", b = "boolean", f = "function", t = "table", u = "userdata"}		local types = {s = "string", n = "number", b = "boolean", f = "function", t = "table", u = "userdata"}
	for i=1, #pattern do		for i=1, #pattern do
	local c = pattern:sub(i,i)		local c = pattern:sub(i,i)
	local t = arg.n > 0 and type(arg[i])		local t = #arg > 0 and type(arg[i])
	if not t then error('got pattern but missing args') end		if not t then error('got pattern but missing args') end
	if t ~= types[c] then error("bad argument #~~"..i.. "~~ to '"..debug.getinfo(2, "n").name~~.."' ("..~~types[c]~~.." expected~~, ~~got "..~~tostring(t)~~.."~~)", 3) end		if t ~= types[c] then error(("bad argument #%s to '%s' (%s expected, got %s)"):format(i, debug.getinfo(2, "n").name, types[c], tostring(t)), 3) end
	end		end
	end		end

Tails at 22:46, 4 June 2018

2018-06-04T22:46:01Z

← Older revision		Revision as of 22:46, 4 June 2018
Line 1:		Line 1:
	{{Useful Function}} __NOTOC__		{{Useful Function}}
			<lowercasetitle></lowercasetitle>
			__NOTOC__
	This function checks the given arguments and calls the error-function if something is wrong. Finally it makes debugging easier since you'll get useful error-messages when calling a selfmade function with wrong or malformed arguments.		This function checks the given arguments and calls the error-function if something is wrong. Finally it makes debugging easier since you'll get useful error-messages when calling a selfmade function with wrong or malformed arguments.

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">void ~~Check~~( string ~~funcname, var types1, var arg1, string argname1~~, [ ~~..., ...,~~ ... ] )</syntaxhighlight>		<syntaxhighlight lang="lua">void check(string pattern, arguments [...])</syntaxhighlight>

	===~~Required~~ Arguments===		===Arguments===
	* '''~~funcname~~''': ~~Name~~ of the ~~function in which~~ the ~~Check-~~function ~~is called.~~		* '''pattern''': a string consisting of the first letter of each datatype passed into the function (see example)
	* '''types1''': Type(s) that arg1 should/may be of. It's a string if only one type is possible, otherwise it can be a table with strings. Possible types are "nil", "boolean", "number", "string", "function", "table", "thread" and "userdata".		* '''arguments''': arguments to match the pattern
	* '''~~arg1~~''': ~~Value of~~ the ~~argument that should be checked.~~
	* '''argname1''': Name of the argument whose value is arg1.

	~~===Optional Arguments===~~
	~~{{OptionalArg}}~~
	* '''...''': You may pass as many triples as you want to.

	==Code==		==Code==
	<section name="Server~~- and/or clientside Script~~" class="~~both~~" show="true">		<section name="Client/Server" class="generic" show="true">
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function ~~Check~~(~~funcname~~, ...)		function check(pattern, ...)
	~~local arg = {...}~~		if not pattern or type(pattern) ~= 'string' then check('s', pattern) end
			local types = {s = "string", n = "number", b = "boolean", f = "function", t = "table", u = "userdata"}
	if (type(~~funcname~~) ~= "string") then		for i=1, #pattern do
	~~error~~(~~"Argument type mismatch at~~ '~~Check' ('funcname~~')~~. Expected '~~string', ~~got '~~"~~..type(funcname)..~~"'.", 2)		local c = pattern:sub(i,i)
	~~end~~		local t = arg.n > 0 and type(arg[i])
	~~if (#arg % 3 > 0) then~~		if not t then error('got pattern but missing args') end
	~~error(~~"~~Argument number mismatch at 'Check'. Expected #arg % 3 to be 0~~, ~~but it is~~ "~~..(#arg % 3)..~~"."~~, 2)~~		if t ~= types[c] then error("bad argument #"..i.. " to '"..debug.getinfo(2, "n").name.."' ("..types[c].." expected, got "..tostring(t)..")", 3) end
	~~end~~		end

	for i=1, #~~arg-2, 3~~ do
	~~if (type~~(~~arg[~~i~~]) ~= "string" and type(arg[~~i]) ~= ~~"table") then~~
	~~error("Argument type mismatch at 'Check' (~~arg ~~#"..i.."). Expected 'string' or 'table', got '".~~.type(arg[i]~~).."'.", 2~~)
	~~elseif (type(arg[i+2]) ~= "string")~~ then
	error(~~"Argument type mismatch at~~ '~~Check' (arg #"..(i+2).."). Expected 'string',~~ got '~~"..type(arg[i+2]).."'.", 2~~)
	end

	if ~~(type(arg[i])~~ =~~= "table") then~~
	~~local aType = type(arg~~[~~i+1~~])
	~~for _, pType in next, arg[i] do~~
	~~if (aType == pType) then~~
	~~aType = nil~~
	~~break~~
	~~end~~
	~~end~~
	~~if (aType)~~ then
	error("~~Argument type mismatch at '"..funcname.."' ('~~"..~~arg[~~i~~+2]~~.."~~'). Expected~~ '"..~~table~~.~~concat~~(~~arg[i]~~, "~~' or '~~").~~."', got '"..aType~~.."'~~.", 3)~~
	~~end~~
	~~elseif (type~~(~~arg[i+1]) ~= arg[i]) then~~
	~~error("Argument type mismatch at '~~"..~~funcname.."' ('"..arg~~[~~i+2~~].."~~'). Expected '"..arg[i].."'~~, got '"..~~type~~(~~arg[i+1]~~).."'.", 3)
	end
	end
	end		end
	</syntaxhighlight>		</syntaxhighlight>
Line 55:		Line 28:

	==Example==		==Example==
	<section name="Server~~- and/or clientside Example~~" class="both" show="true">		<section name="Client/Server" class="both" show="true">
	~~This example shows the Check-function's usage in case of a more or less useless division function.~~
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~-- define the~~ function		function warpPlayer(player, x, y, z)
	~~function divide~~(~~dividend~~, ~~divisor~~, ~~round~~)		check('unnn', player, x, y, z) -- 'unnn' means userdata (player in this case), number, number, number
	-- check ~~the passed arguments~~
	~~Check~~(~~"divide", "number", dividend, "dividend", "number", divisor, "divisor"~~, ~~{"nil"~~,~~"boolean"}~~, ~~round~~, ~~"round"~~)

	-- ~~error if divisor is 0~~
	if (~~divisor == 0) then error("Someone tried to divide by 0. YOU MUST NOT DO THAT!!!") end~~

	~~-- calculate the result~~
	~~local quotient = dividend / divisor~~
	~~-- round the result if round is true~~
	~~if (round) then quotient = math.floor(quotient + .5~~)

	~~-- return the result~~		print("The check passed!")
	~~return quotient~~
	end		end
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>

	~~Author: NeonBlack~~

	==See Also==		==See Also==
	{{Useful_Functions}}		{{Useful_Functions}}

Qaisjp: update synax

2015-08-20T14:33:15Z

update synax

← Older revision		Revision as of 14:33, 20 August 2015
Line 3:		Line 3:

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">void Check( string funcname, var types1, var arg1, string argname1, [ ... ] )</syntaxhighlight>		<syntaxhighlight lang="lua">void Check( string funcname, var types1, var arg1, string argname1, [ ..., ..., ... ] )</syntaxhighlight>

	===Required Arguments===		===Required Arguments===

Qaisjp: fix 2

2015-08-20T14:32:50Z

fix 2

← Older revision		Revision as of 14:32, 20 August 2015
Line 1:		Line 1:
	{{Useful Function}}		{{Useful Function}} __NOTOC__
	~~__NOTOC__~~ This function checks the given arguments and calls the error-function if something is wrong. Finally it makes debugging easier since you'll get useful error-messages when calling a selfmade function with wrong or malformed arguments.		This function checks the given arguments and calls the error-function if something is wrong. Finally it makes debugging easier since you'll get useful error-messages when calling a selfmade function with wrong or malformed arguments.

	==Syntax==		==Syntax==

Qaisjp: fix test 1

2015-08-20T14:32:39Z

fix test 1

← Older revision		Revision as of 14:32, 20 August 2015
Line 1:		Line 1:
	{{Useful Function}}		{{Useful Function}}
	__NOTOC__		__NOTOC__ This function checks the given arguments and calls the error-function if something is wrong. Finally it makes debugging easier since you'll get useful error-messages when calling a selfmade function with wrong or malformed arguments.
	This function checks the given arguments and calls the error-function if something is wrong. Finally it makes debugging easier since you'll get useful error-messages when calling a selfmade function with wrong or malformed arguments.

	==Syntax==		==Syntax==

Flobu: /* Example */ changed third and fourth dividend to divisor

2009-07-18T11:57:24Z

Example: changed third and fourth dividend to divisor

← Older revision		Revision as of 11:57, 18 July 2009
Line 62:		Line 62:
	function divide(dividend, divisor, round)		function divide(dividend, divisor, round)
	-- check the passed arguments		-- check the passed arguments
	Check("divide", "number", dividend, "dividend", "number", ~~dividend~~, "~~dividend~~", {"nil","boolean"}, round, "round")		Check("divide", "number", dividend, "dividend", "number", divisor, "divisor", {"nil","boolean"}, round, "round")

	-- error if divisor is 0		-- error if divisor is 0

NeonBlack: new useful function: Check

2009-07-14T20:30:38Z

new useful function: Check

New page

{{Useful Function}}
__NOTOC__
This function checks the given arguments and calls the error-function if something is wrong. Finally it makes debugging easier since you'll get useful error-messages when calling a selfmade function with wrong or malformed arguments.

==Syntax==
<syntaxhighlight lang="lua">void Check( string funcname, var types1, var arg1, string argname1, [ ... ] )</syntaxhighlight>

===Required Arguments===
* '''funcname''': Name of the function in which the Check-function is called.
* '''types1''': Type(s) that arg1 should/may be of. It's a string if only one type is possible, otherwise it can be a table with strings. Possible types are "nil", "boolean", "number", "string", "function", "table", "thread" and "userdata".
* '''arg1''': Value of the argument that should be checked.
* '''argname1''': Name of the argument whose value is arg1.

===Optional Arguments===
{{OptionalArg}}
* '''...''': You may pass as many triples as you want to.

==Code==
<section name="Server- and/or clientside Script" class="both" show="true">
<syntaxhighlight lang="lua">
function Check(funcname, ...)
local arg = {...}

if (type(funcname) ~= "string") then
error("Argument type mismatch at 'Check' ('funcname'). Expected 'string', got '"..type(funcname).."'.", 2)
end
if (#arg % 3 > 0) then
error("Argument number mismatch at 'Check'. Expected #arg % 3 to be 0, but it is "..(#arg % 3)..".", 2)
end

for i=1, #arg-2, 3 do
if (type(arg[i]) ~= "string" and type(arg[i]) ~= "table") then
error("Argument type mismatch at 'Check' (arg #"..i.."). Expected 'string' or 'table', got '"..type(arg[i]).."'.", 2)
elseif (type(arg[i+2]) ~= "string") then
error("Argument type mismatch at 'Check' (arg #"..(i+2).."). Expected 'string', got '"..type(arg[i+2]).."'.", 2)
end

if (type(arg[i]) == "table") then
local aType = type(arg[i+1])
for _, pType in next, arg[i] do
if (aType == pType) then
aType = nil
break
end
end
if (aType) then
error("Argument type mismatch at '"..funcname.."' ('"..arg[i+2].."'). Expected '"..table.concat(arg[i], "' or '").."', got '"..aType.."'.", 3)
end
elseif (type(arg[i+1]) ~= arg[i]) then
error("Argument type mismatch at '"..funcname.."' ('"..arg[i+2].."'). Expected '"..arg[i].."', got '"..type(arg[i+1]).."'.", 3)
end
end
end
</syntaxhighlight>
</section>

==Example==
<section name="Server- and/or clientside Example" class="both" show="true">
This example shows the Check-function's usage in case of a more or less useless division function.
<syntaxhighlight lang="lua">
-- define the function
function divide(dividend, divisor, round)
-- check the passed arguments
Check("divide", "number", dividend, "dividend", "number", dividend, "dividend", {"nil","boolean"}, round, "round")

-- error if divisor is 0
if (divisor == 0) then error("Someone tried to divide by 0. YOU MUST NOT DO THAT!!!") end

-- calculate the result
local quotient = dividend / divisor
-- round the result if round is true
if (round) then quotient = math.floor(quotient + .5)

-- return the result
return quotient
end
</syntaxhighlight>
</section>

Author: NeonBlack

==See Also==
{{Useful_Functions}}