NAME 
lib/luaaux.pir - Lua Auxiliary PIR Library
DESCRIPTION
Functions
lua_argerror (narg, extramsg, ...)
Raises an error with the following message,
where lua_checkany (narg, arg)
Checks whether the function has an argument of any type (including nil) at position lua_checknumber (narg, arg)
Checks whether the function argument lua_checkoption (narg, val, options)lua_checkstring (narg, arg)
Checks whether the function argument lua_checktype (narg, arg, t)
Checks whether the function argument lua_checkudata (narg, arg, tname)
Checks whether the function argument lua_error (message, ...)
Raises an error.This function never returns.CAUTION: don't used it in an exception handler, but lua_x_error & rethrow.
lua_findtable (t, fname)lua_gc (what, data)
Controls the garbage collector.This function performs several tasks, according to the value of the parameter - "stop" stops the garbage collector.
- "restart" restarts the garbage collector.
- "collect" performs a full garbage-collection cycle.
- "count" returns the total memory in use by Lua (in Kbytes).
- "step" performs an incremental step of garbage collection The step
- "steppause" sets
- "setstepmul" sets
lua_getfenv (o)
Returns the environment table of the argument lua_getmetatable (tname)
Returns the metatable registered with the name lua_gsub (src, pat, repl)
Returns a copy of string lua_isboolean (val)
Returns 1 if the value has type boolean, and 0 otherwise.
lua_isfunction (val)
Returns 1 if the value is a function, and 0 otherwise.
lua_isnil (val)
Returns 1 if the value is nil, and 0 otherwise.
lua_isnumber (val)
Returns 1 if the value is a number or a string convertible to a number, and 0 otherwise.
lua_isstring (val)
Returns 1 if the value is a string or a number (which is always convertible to a string), and 0 otherwise.
lua_istable (val)
Returns 1 if the value is a table, and 0 otherwise.
lua_isuserdata (val)
Returns 1 if the value is a userdata, and 0 otherwise.
lua_load (data, name)
This function only loads a chunk; it does not run it.lua_loadbuffer (buff, name)
Loads a buffer as a Lua chunk.lua_loadfile (filename)
Loads a file as a Lua chunk. If lua_newmetatable (tname)
Unless the registry already has the key lua_newuserdata (data, mt)lua_openlibs ()
Opens all standard Lua libraries.
lua_optint (narg, arg, def)
If the function argument lua_optnumber (narg, arg, def)
If the function argument lua_optstring (narg, arg, def)
If the function argument lua_register (libname, lib, names, env)lua_setfenv (o, table)
Sets the table lua_typerror (narg, got, expec)
Generates an error with a message like the following:
func is retrieved from the call stack:
bad argument #<narg> to <func> (<extramsg>)This function never returns.CAUTION: don't used it in an exception handler, but lua_x_argerror & rethrow.
narg.
narg is a number and returns this number.
narg is a string and returns this string.This function uses tostring to get its result, so all conversions and caveats of that function apply here.
narg has type t.
narg is a userdata of the type tname.
what:
"size" is controlled by data (larger values mean more steps) in a non-specified way. If you want to control the step size you must tune experimentally the value of data. Returns true if the step finished a garbage-collection cycle.
data/100 as the new value for the pause of the collector. The function returns the previous value of the pause.
data/100 as the new value for the step multiplier of the collector. The function returns the previous value of the step multiplier.o.
tname.
src by replacing any occurrence of the string pat with the string rep.
lua_load automatically detects whether the chunk is text or binary, and loads it accordingly.The chunkname argument gives a name to the chunk, which is used for error messages and in debug information.
name is the chunk name, used for debug information and error messages.
filename is a empty string, then it loads from the standard input. The first line in the file is ignored if it starts with a #.This function only loads the chunk; it does not run it.
tname, creates a new table to be used as a metatable for userdata, adds it to the registry with key tname.In both cases returns the final value associated with tname in the registry.
narg is a number, returns this number cast to an int. If this argument is absent or is nil, returns def. Otherwise, raises an error.
narg is a number, returns this number. If this argument is absent or is nil, returns def. Otherwise, raises an error.
narg is a string, returns this string. If this argument is absent or is nil, returns def. Otherwise, raises an error.
table as the new environment for the value o. If the value o is neither a function nor a thread nor a userdata, returns 0. Otherwise it returns 1.
bad argument narg to 'func' (tname expected, got rt)This function never returns.
Others functions
argstolua (env, args)checkforloop (start, limit, step)docall (f, arg)mkarg (argv)
Support variable number of arguments function call.
not_implemented ()tconstruct (table, index, argv)
end of table constructor with argv
