文件操作 - lua.bflang2

文件: /usr/share/bluefish/bflang/lua.bflang2

编辑文件内容

<?xml version="1.0"?>


<bflang name="Lua" version="3" contexts="11" matches="329">
<header>
	<mime type="text/x-lua?lua"/>
	<option name="load_reference" default="1"/>
	<option name="load_completion" default="1"/>
	<option name="show_in_menu" default="1"/>
	<option name="Parentheses block_foldable" default="0" description="Allow folding of Parentheses block"/>
	<highlight name="keyword" style="keyword" />
	<highlight name="brackets" style="brackets" />
	<highlight name="type" style="type" />
	<highlight name="comment" style="comment" />
	<highlight name="string" style="string" />
	<highlight name="value" style="value" />
	<highlight name="preprocessor" style="preprocessor" />
	<highlight name="function" style="function" />
</header>
<properties>
	<comment id="cm.blockcomment" type="block" start="--[[" end="]]" />
	<comment id="cm.linecomment" type="line" start="-- " />
	<smartindent characters="{" />
	<smartoutdent characters="}" />
</properties>
<definition>
<context symbols=" ;(){}[]:\&#34;\\',*&amp;^%!+=-|/?#&#9;&#10;&#13;" commentid_block="cm.blockcomment" commentid_line="cm.linecomment">
<group highlight="keyword" >
	<autocomplete enable="1" />
<element pattern="and" />
<element pattern="break" />
<element pattern="do" />
<element pattern="else" />
<element pattern="elseif" />
<element pattern="end" />
<element pattern="false" />
<element pattern="for" />
<element pattern="function" />
<element pattern="if" />
<element pattern="in" />
<element pattern="local" />
<element pattern="nil" />
<element pattern="not" />
<element pattern="or" />
<element pattern="repeat" />
<element pattern="return" />
<element pattern="then" />
<element pattern="true" />
<element pattern="until" />
<element pattern="while" />
</group>
<group highlight="function" >
	<autocomplete append="()" backup_cursor="1" />
<element pattern="lua_atpanic">
<reference>[-0, +0, -]
lua_CFunction lua_atpanic (lua_State *L, lua_CFunction panicf);
Sets a new panic function and returns the old one.
If an error happens outside any protected environment,
Lua calls a panic function
and then calls exit(EXIT_FAILURE),
thus exiting the host application.
Your panic function can avoid this exit by
never returning (e.g., doing a long jump).
The panic function can access the error message at the top of the stack.
</reference>
</element>
<element pattern="lua_call">
<reference>[-(nargs + 1), +nresults, e]
void lua_call (lua_State *L, int nargs, int nresults);
Calls a function.
To call a function you must use the following protocol:
first, the function to be called is pushed onto the stack;
then, the arguments to the function are pushed
in direct order;
that is, the first argument is pushed first.
Finally you call lua_call;
nargs is the number of arguments that you pushed onto the stack.
All arguments and the function value are popped from the stack
when the function is called.
The function results are pushed onto the stack when the function returns.
The number of results is adjusted to nresults,
unless nresults is LUA_MULTRET.
In this case, all results from the function are pushed.
Lua takes care that the returned values fit into the stack space.
The function results are pushed onto the stack in direct order
(the first result is pushed first),
so that after the call the last result is on the top of the stack.
Any error inside the called function is propagated upwards
(with a longjmp).
</reference>
</element>
<element pattern="lua_checkstack">
<reference>[-0, +0, m]
int lua_checkstack (lua_State *L, int extra);
Ensures that there are at least extra free stack slots in the stack.
It returns false if it cannot grow the stack to that size.
This function never shrinks the stack;
if the stack is already larger than the new size,
it is left unchanged.
</reference>
</element>
<element pattern="lua_close">
<reference>[-0, +0, -]
void lua_close (lua_State *L);
Destroys all objects in the given Lua state
(calling the corresponding garbage-collection metamethods, if any)
and frees all dynamic memory used by this state.
On several platforms, you may not need to call this function,
because all resources are naturally released when the host program ends.
On the other hand, long-running programs,
such as a daemon or a web server,
might need to release states as soon as they are not needed,
to avoid growing too large.
</reference>
</element>
<element pattern="lua_concat">
<reference>[-n, +1, e]
void lua_concat (lua_State *L, int n);
Concatenates the n values at the top of the stack,
pops them, and leaves the result at the top.
If n is 1, the result is the single value on the stack
(that is, the function does nothing);
if n is 0, the result is the empty string.
Concatenation is performed following the usual semantics of Lua
(see §2.5.4).
</reference>
</element>
<element pattern="lua_cpcall">
<reference>[-0, +(0|1), -]
int lua_cpcall (lua_State *L, lua_CFunction func, void *ud);
Calls the C function func in protected mode.
func starts with only one element in its stack,
a light userdata containing ud.
In case of errors,
lua_cpcall returns the same error codes as lua_pcall,
plus the error object on the top of the stack;
otherwise, it returns zero, and does not change the stack.
All values returned by func are discarded.
</reference>
</element>
<element pattern="lua_createtable">
<reference>[-0, +1, m]
void lua_createtable (lua_State *L, int narr, int nrec);
Creates a new empty table and pushes it onto the stack.
The new table has space pre-allocated
for narr array elements and nrec non-array elements.
This pre-allocation is useful when you know exactly how many elements
the table will have.
Otherwise you can use the function lua_newtable.
</reference>
</element>
<element pattern="lua_dump">
<reference>[-0, +0, m]
int lua_dump (lua_State *L, lua_Writer writer, void *data);
Dumps a function as a binary chunk.
Receives a Lua function on the top of the stack
and produces a binary chunk that,
if loaded again,
results in a function equivalent to the one dumped.
As it produces parts of the chunk,
lua_dump calls function writer (see lua_Writer)
with the given data
to write them.
The value returned is the error code returned by the last
call to the writer;
0 means no errors.
This function does not pop the Lua function from the stack.
</reference>
</element>
<element pattern="lua_equal">
<reference>[-0, +0, e]
int lua_equal (lua_State *L, int index1, int index2);
Returns 1 if the two values in acceptable indices index1 and
index2 are equal,
following the semantics of the Lua == operator
(that is, may call metamethods).
Otherwise returns 0.
Also returns 0 if any of the indices is non valid.
</reference>
</element>
<element pattern="lua_error">
<reference>[-1, +0, v]
int lua_error (lua_State *L);
Generates a Lua error.
The error message (which can actually be a Lua value of any type)
must be on the stack top.
This function does a long jump,
and therefore never returns.
(see luaL_error).
</reference>
</element>
<element pattern="lua_gc">
<reference>[-0, +0, e]
int lua_gc (lua_State *L, int what, int data);
Controls the garbage collector.
This function performs several tasks,
according to the value of the parameter what:
LUA_GCSTOP:
stops the garbage collector.
LUA_GCRESTART:
restarts the garbage collector.
LUA_GCCOLLECT:
performs a full garbage-collection cycle.
LUA_GCCOUNT:
returns the current amount of memory (in Kbytes) in use by Lua.
LUA_GCCOUNTB:
returns the remainder of dividing the current amount of bytes of
memory in use by Lua by 1024.
LUA_GCSTEP:
performs an incremental step of garbage collection.
The step "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 experimentally tune the value of data.
The function returns 1 if the step finished a
garbage-collection cycle.
LUA_GCSETPAUSE:
sets data as the new value
for the pause of the collector (see §2.10).
The function returns the previous value of the pause.
LUA_GCSETSTEPMUL:
sets data as the new value for the step multiplier of
the collector (see §2.10).
The function returns the previous value of the step multiplier.
</reference>
</element>
<element pattern="lua_getallocf">
<reference>[-0, +0, -]
lua_Alloc lua_getallocf (lua_State *L, void **ud);
Returns the memory-allocation function of a given state.
If ud is not NULL, Lua stores in *ud the
opaque pointer passed to lua_newstate.
</reference>
</element>
<element pattern="lua_getfenv">
<reference>[-0, +1, -]
void lua_getfenv (lua_State *L, int index);
Pushes onto the stack the environment table of
the value at the given index.
</reference>
</element>
<element pattern="lua_getfield">
<reference>[-0, +1, e]
void lua_getfield (lua_State *L, int index, const char *k);
Pushes onto the stack the value t[k],
where t is the value at the given valid index.
As in Lua, this function may trigger a metamethod
for the "index" event (see §2.8).
</reference>
</element>
<element pattern="lua_getglobal">
<reference>[-0, +1, e]
void lua_getglobal (lua_State *L, const char *name);
Pushes onto the stack the value of the global name.
It is defined as a macro:
 #define lua_getglobal(L,s) lua_getfield(L, LUA_GLOBALSINDEX, s)

</reference>
</element>
<element pattern="lua_getmetatable">
<reference>[-0, +(0|1), -]
int lua_getmetatable (lua_State *L, int index);
Pushes onto the stack the metatable of the value at the given
acceptable index.
If the index is not valid,
or if the value does not have a metatable,
the function returns 0 and pushes nothing on the stack.
</reference>
</element>
<element pattern="lua_gettable">
<reference>[-1, +1, e]
void lua_gettable (lua_State *L, int index);
Pushes onto the stack the value t[k],
where t is the value at the given valid index
and k is the value at the top of the stack.
This function pops the key from the stack
(putting the resulting value in its place).
As in Lua, this function may trigger a metamethod
for the "index" event (see §2.8).
</reference>
</element>
<element pattern="lua_gettop">
<reference>[-0, +0, -]
int lua_gettop (lua_State *L);
Returns the index of the top element in the stack.
Because indices start at 1,
this result is equal to the number of elements in the stack
(and so 0 means an empty stack).
</reference>
</element>
<element pattern="lua_insert">
<reference>[-1, +1, -]
void lua_insert (lua_State *L, int index);
Moves the top element into the given valid index,
shifting up the elements above this index to open space.
Cannot be called with a pseudo-index,
because a pseudo-index is not an actual stack position.
</reference>
</element>
<element pattern="lua_isboolean">
<reference>[-0, +0, -]
int lua_isboolean (lua_State *L, int index);
Returns 1 if the value at the given acceptable index has type boolean,
and 0 otherwise.
</reference>
</element>
<element pattern="lua_iscfunction">
<reference>[-0, +0, -]
int lua_iscfunction (lua_State *L, int index);
Returns 1 if the value at the given acceptable index is a C function,
and 0 otherwise.
</reference>
</element>
<element pattern="lua_isfunction">
<reference>[-0, +0, -]
int lua_isfunction (lua_State *L, int index);
Returns 1 if the value at the given acceptable index is a function
(either C or Lua), and 0 otherwise.
</reference>
</element>
<element pattern="lua_islightuserdata">
<reference>[-0, +0, -]
int lua_islightuserdata (lua_State *L, int index);
Returns 1 if the value at the given acceptable index is a light userdata,
and 0 otherwise.
</reference>
</element>
<element pattern="lua_isnil">
<reference>[-0, +0, -]
int lua_isnil (lua_State *L, int index);
Returns 1 if the value at the given acceptable index is nil,
and 0 otherwise.
</reference>
</element>
<element pattern="lua_isnone">
<reference>[-0, +0, -]
int lua_isnone (lua_State *L, int index);
Returns 1 if the given acceptable index is not valid
(that is, it refers to an element outside the current stack),
and 0 otherwise.
</reference>
</element>
<element pattern="lua_isnoneornil">
<reference>[-0, +0, -]
int lua_isnoneornil (lua_State *L, int index);
Returns 1 if the given acceptable index is not valid
(that is, it refers to an element outside the current stack)
or if the value at this index is nil,
and 0 otherwise.
</reference>
</element>
<element pattern="lua_isnumber">
<reference>[-0, +0, -]
int lua_isnumber (lua_State *L, int index);
Returns 1 if the value at the given acceptable index is a number
or a string convertible to a number,
and 0 otherwise.
</reference>
</element>
<element pattern="lua_isstring">
<reference>[-0, +0, -]
int lua_isstring (lua_State *L, int index);
Returns 1 if the value at the given acceptable index is a string
or a number (which is always convertible to a string),
and 0 otherwise.
</reference>
</element>
<element pattern="lua_istable">
<reference>[-0, +0, -]
int lua_istable (lua_State *L, int index);
Returns 1 if the value at the given acceptable index is a table,
and 0 otherwise.
</reference>
</element>
<element pattern="lua_isthread">
<reference>[-0, +0, -]
int lua_isthread (lua_State *L, int index);
Returns 1 if the value at the given acceptable index is a thread,
and 0 otherwise.
</reference>
</element>
<element pattern="lua_isuserdata">
<reference>[-0, +0, -]
int lua_isuserdata (lua_State *L, int index);
Returns 1 if the value at the given acceptable index is a userdata
(either full or light), and 0 otherwise.
</reference>
</element>
<element pattern="lua_lessthan">
<reference>[-0, +0, e]
int lua_lessthan (lua_State *L, int index1, int index2);
Returns 1 if the value at acceptable index index1 is smaller
than the value at acceptable index index2,
following the semantics of the Lua &amp;lt; operator
(that is, may call metamethods).
Otherwise returns 0.
Also returns 0 if any of the indices is non valid.
</reference>
</element>
<element pattern="lua_load">
<reference>[-0, +1, -]
int lua_load (lua_State *L,
 lua_Reader reader,
 void *data,
 const char *chunkname);
Loads a Lua chunk.
If there are no errors,
lua_load pushes the compiled chunk as a Lua
function on top of the stack.
Otherwise, it pushes an error message.
The return values of lua_load are:
0: no errors;
LUA_ERRSYNTAX:
syntax error during pre-compilation;
LUA_ERRMEM:
memory allocation error.
This function only loads a chunk;
it does not run it.
lua_load automatically detects whether the chunk is text or binary,
and loads it accordingly (see program luac).
The lua_load function uses a user-supplied reader function
to read the chunk (see lua_Reader).
The data argument is an opaque value passed to the reader function.
The chunkname argument gives a name to the chunk,
which is used for error messages and in debug information (see §3.8).
</reference>
</element>
<element pattern="lua_newstate">
<reference>[-0, +0, -]
lua_State *lua_newstate (lua_Alloc f, void *ud);
Creates a new, independent state.
Returns NULL if cannot create the state
(due to lack of memory).
The argument f is the allocator function;
Lua does all memory allocation for this state through this function.
The second argument, ud, is an opaque pointer that Lua
simply passes to the allocator in every call.
</reference>
</element>
<element pattern="lua_newtable">
<reference>[-0, +1, m]
void lua_newtable (lua_State *L);
Creates a new empty table and pushes it onto the stack.
It is equivalent to lua_createtable(L, 0, 0).
</reference>
</element>
<element pattern="lua_newthread">
<reference>[-0, +1, m]
lua_State *lua_newthread (lua_State *L);
Creates a new thread, pushes it on the stack,
and returns a pointer to a lua_State that represents this new thread.
The new state returned by this function shares with the original state
all global objects (such as tables),
but has an independent execution stack.
There is no explicit function to close or to destroy a thread.
Threads are subject to garbage collection,
like any Lua object.
</reference>
</element>
<element pattern="lua_newuserdata">
<reference>[-0, +1, m]
void *lua_newuserdata (lua_State *L, size_t size);
This function allocates a new block of memory with the given size,
pushes onto the stack a new full userdata with the block address,
and returns this address.
Userdata represent C values in Lua.
A full userdata represents a block of memory.
It is an object (like a table):
you must create it, it can have its own metatable,
and you can detect when it is being collected.
A full userdata is only equal to itself (under raw equality).
When Lua collects a full userdata with a gc metamethod,
Lua calls the metamethod and marks the userdata as finalized.
When this userdata is collected again then
Lua frees its corresponding memory.
</reference>
</element>
<element pattern="lua_next">
<reference>[-1, +(2|0), e]
int lua_next (lua_State *L, int index);
Pops a key from the stack,
and pushes a key-value pair from the table at the given index
(the "next" pair after the given key).
If there are no more elements in the table,
then lua_next returns 0 (and pushes nothing).
A typical traversal looks like this:
 /* table is in the stack at index 't' */
 lua_pushnil(L); /* first key */
 while (lua_next(L, t) != 0) {
 /* uses 'key' (at index -2) and 'value' (at index -1) */
 printf("%s - %s\n",
 lua_typename(L, lua_type(L, -2)),
 lua_typename(L, lua_type(L, -1)));
 /* removes 'value'; keeps 'key' for next iteration */
 lua_pop(L, 1);
 }

While traversing a table,
do not call lua_tolstring directly on a key,
unless you know that the key is actually a string.
Recall that lua_tolstring changes
the value at the given index;
this confuses the next call to lua_next.
</reference>
</element>
<element pattern="lua_objlen">
<reference>[-0, +0, -]
size_t lua_objlen (lua_State *L, int index);
Returns the "length" of the value at the given acceptable index:
for strings, this is the string length;
for tables, this is the result of the length operator ('#');
for userdata, this is the size of the block of memory allocated
for the userdata;
for other values, it is 0.
</reference>
</element>
<element pattern="lua_pcall">
<reference>[-(nargs + 1), +(nresults|1), -]
int lua_pcall (lua_State *L, int nargs, int nresults, int errfunc);
Calls a function in protected mode.
Both nargs and nresults have the same meaning as
in lua_call.
If there are no errors during the call,
lua_pcall behaves exactly like lua_call.
However, if there is any error,
lua_pcall catches it,
pushes a single value on the stack (the error message),
and returns an error code.
Like lua_call,
lua_pcall always removes the function
and its arguments from the stack.
If errfunc is 0,
then the error message returned on the stack
is exactly the original error message.
Otherwise, errfunc is the stack index of an
error handler function.
(In the current implementation, this index cannot be a pseudo-index.)
In case of runtime errors,
this function will be called with the error message
and its return value will be the message returned on the stack by lua_pcall.
Typically, the error handler function is used to add more debug
information to the error message, such as a stack traceback.
Such information cannot be gathered after the return of lua_pcall,
since by then the stack has unwound.
The lua_pcall function returns 0 in case of success
or one of the following error codes
(defined in lua.h):
LUA_ERRRUN:
a runtime error.
LUA_ERRMEM:
memory allocation error.
For such errors, Lua does not call the error handler function.
LUA_ERRERR:
error while running the error handler function.
</reference>
</element>
<element pattern="lua_pop">
<reference>[-n, +0, -]
void lua_pop (lua_State *L, int n);
Pops n elements from the stack.
</reference>
</element>
<element pattern="lua_pushboolean">
<reference>[-0, +1, -]
void lua_pushboolean (lua_State *L, int b);
Pushes a boolean value with value b onto the stack.
</reference>
</element>
<element pattern="lua_pushcclosure">
<reference>[-n, +1, m]
void lua_pushcclosure (lua_State *L, lua_CFunction fn, int n);
Pushes a new C closure onto the stack.
When a C function is created,
it is possible to associate some values with it,
thus creating a C closure (see §3.4);
these values are then accessible to the function whenever it is called.
To associate values with a C function,
first these values should be pushed onto the stack
(when there are multiple values, the first value is pushed first).
Then lua_pushcclosure
is called to create and push the C function onto the stack,
with the argument n telling how many values should be
associated with the function.
lua_pushcclosure also pops these values from the stack.
The maximum value for n is 255.
</reference>
</element>
<element pattern="lua_pushcfunction">
<reference>[-0, +1, m]
void lua_pushcfunction (lua_State *L, lua_CFunction f);
Pushes a C function onto the stack.
This function receives a pointer to a C function
and pushes onto the stack a Lua value of type function that,
when called, invokes the corresponding C function.
Any function to be registered in Lua must
follow the correct protocol to receive its parameters
and return its results (see lua_CFunction).
lua_pushcfunction is defined as a macro:
 #define lua_pushcfunction(L,f) lua_pushcclosure(L,f,0)

</reference>
</element>
<element pattern="lua_pushfstring">
<reference>[-0, +1, m]
const char *lua_pushfstring (lua_State *L, const char *fmt, ...);
Pushes onto the stack a formatted string
and returns a pointer to this string.
It is similar to the C function sprintf,
but has some important differences:
You do not have to allocate space for the result:
the result is a Lua string and Lua takes care of memory allocation
(and deallocation, through garbage collection).
The conversion specifiers are quite restricted.
There are no flags, widths, or precisions.
The conversion specifiers can only be
'%%' (inserts a '%' in the string),
'%s' (inserts a zero-terminated string, with no size restrictions),
'%f' (inserts a lua_Number),
'%p' (inserts a pointer as a hexadecimal numeral),
'%d' (inserts an int), and
'%c' (inserts an int as a character).
</reference>
</element>
<element pattern="lua_pushinteger">
<reference>[-0, +1, -]
void lua_pushinteger (lua_State *L, lua_Integer n);
Pushes a number with value n onto the stack.
</reference>
</element>
<element pattern="lua_pushlightuserdata">
<reference>[-0, +1, -]
void lua_pushlightuserdata (lua_State *L, void *p);
Pushes a light userdata onto the stack.
Userdata represent C values in Lua.
A light userdata represents a pointer.
It is a value (like a number):
you do not create it, it has no individual metatable,
and it is not collected (as it was never created).
A light userdata is equal to "any"
light userdata with the same C address.
</reference>
</element>
<element pattern="lua_pushliteral">
<reference>[-0, +1, m]
void lua_pushliteral (lua_State *L, const char *s);
This macro is equivalent to lua_pushlstring,
but can be used only when s is a literal string.
In these cases, it automatically provides the string length.
</reference>
</element>
<element pattern="lua_pushlstring">
<reference>[-0, +1, m]
void lua_pushlstring (lua_State *L, const char *s, size_t len);
Pushes the string pointed to by s with size len
onto the stack.
Lua makes (or reuses) an internal copy of the given string,
so the memory at s can be freed or reused immediately after
the function returns.
The string can contain embedded zeros.
</reference>
</element>
<element pattern="lua_pushnil">
<reference>[-0, +1, -]
void lua_pushnil (lua_State *L);
Pushes a nil value onto the stack.
</reference>
</element>
<element pattern="lua_pushnumber">
<reference>[-0, +1, -]
void lua_pushnumber (lua_State *L, lua_Number n);
Pushes a number with value n onto the stack.
</reference>
</element>
<element pattern="lua_pushstring">
<reference>[-0, +1, m]
void lua_pushstring (lua_State *L, const char *s);
Pushes the zero-terminated string pointed to by s
onto the stack.
Lua makes (or reuses) an internal copy of the given string,
so the memory at s can be freed or reused immediately after
the function returns.
The string cannot contain embedded zeros;
it is assumed to end at the first zero.
</reference>
</element>
<element pattern="lua_pushthread">
<reference>[-0, +1, -]
int lua_pushthread (lua_State *L);
Pushes the thread represented by L onto the stack.
Returns 1 if this thread is the main thread of its state.
</reference>
</element>
<element pattern="lua_pushvalue">
<reference>[-0, +1, -]
void lua_pushvalue (lua_State *L, int index);
Pushes a copy of the element at the given valid index
onto the stack.
</reference>
</element>
<element pattern="lua_pushvfstring">
<reference>[-0, +1, m]
const char *lua_pushvfstring (lua_State *L,
 const char *fmt,
 va_list argp);
Equivalent to lua_pushfstring, except that it receives a va_list
instead of a variable number of arguments.
</reference>
</element>
<element pattern="lua_rawequal">
<reference>[-0, +0, -]
int lua_rawequal (lua_State *L, int index1, int index2);
Returns 1 if the two values in acceptable indices index1 and
index2 are primitively equal
(that is, without calling metamethods).
Otherwise returns 0.
Also returns 0 if any of the indices are non valid.
</reference>
</element>
<element pattern="lua_rawget">
<reference>[-1, +1, -]
void lua_rawget (lua_State *L, int index);
Similar to lua_gettable, but does a raw access
(i.e., without metamethods).
</reference>
</element>
<element pattern="lua_rawgeti">
<reference>[-0, +1, -]
void lua_rawgeti (lua_State *L, int index, int n);
Pushes onto the stack the value t[n],
where t is the value at the given valid index.
The access is raw;
that is, it does not invoke metamethods.
</reference>
</element>
<element pattern="lua_rawset">
<reference>[-2, +0, m]
void lua_rawset (lua_State *L, int index);
Similar to lua_settable, but does a raw assignment
(i.e., without metamethods).
</reference>
</element>
<element pattern="lua_rawseti">
<reference>[-1, +0, m]
void lua_rawseti (lua_State *L, int index, int n);
Does the equivalent of t[n] = v,
where t is the value at the given valid index
and v is the value at the top of the stack.
This function pops the value from the stack.
The assignment is raw;
that is, it does not invoke metamethods.
</reference>
</element>
<element pattern="lua_register">
<reference>[-0, +0, e]
void lua_register (lua_State *L,
 const char *name,
 lua_CFunction f);
Sets the C function f as the new value of global name.
It is defined as a macro:
 #define lua_register(L,n,f) \
 (lua_pushcfunction(L, f), lua_setglobal(L, n))

</reference>
</element>
<element pattern="lua_remove">
<reference>[-1, +0, -]
void lua_remove (lua_State *L, int index);
Removes the element at the given valid index,
shifting down the elements above this index to fill the gap.
Cannot be called with a pseudo-index,
because a pseudo-index is not an actual stack position.
</reference>
</element>
<element pattern="lua_replace">
<reference>[-1, +0, -]
void lua_replace (lua_State *L, int index);
Moves the top element into the given position (and pops it),
without shifting any element
(therefore replacing the value at the given position).
</reference>
</element>
<element pattern="lua_resume">
<reference>[-?, +?, -]
int lua_resume (lua_State *L, int narg);
Starts and resumes a coroutine in a given thread.
To start a coroutine, you first create a new thread
(see lua_newthread);
then you push onto its stack the main function plus any arguments;
then you call lua_resume,
with narg being the number of arguments.
This call returns when the coroutine suspends or finishes its execution.
When it returns, the stack contains all values passed to lua_yield,
or all values returned by the body function.
lua_resume returns
LUA_YIELD if the coroutine yields,
0 if the coroutine finishes its execution
without errors,
or an error code in case of errors (see lua_pcall).
In case of errors,
the stack is not unwound,
so you can use the debug API over it.
The error message is on the top of the stack.
To restart a coroutine, you put on its stack only the values to
be passed as results from yield,
and then call lua_resume.
</reference>
</element>
<element pattern="lua_setallocf">
<reference>[-0, +0, -]
void lua_setallocf (lua_State *L, lua_Alloc f, void *ud);
Changes the allocator function of a given state to f
with user data ud.
</reference>
</element>
<element pattern="lua_setfenv">
<reference>[-1, +0, -]
int lua_setfenv (lua_State *L, int index);
Pops a table from the stack and sets it as
the new environment for the value at the given index.
If the value at the given index is
neither a function nor a thread nor a userdata,
lua_setfenv returns 0.
Otherwise it returns 1.
</reference>
</element>
<element pattern="lua_setfield">
<reference>[-1, +0, e]
void lua_setfield (lua_State *L, int index, const char *k);
Does the equivalent to t[k] = v,
where t is the value at the given valid index
and v is the value at the top of the stack.
This function pops the value from the stack.
As in Lua, this function may trigger a metamethod
for the "newindex" event (see §2.8).
</reference>
</element>
<element pattern="lua_setglobal">
<reference>[-1, +0, e]
void lua_setglobal (lua_State *L, const char *name);
Pops a value from the stack and
sets it as the new value of global name.
It is defined as a macro:
 #define lua_setglobal(L,s) lua_setfield(L, LUA_GLOBALSINDEX, s)

</reference>
</element>
<element pattern="lua_setmetatable">
<reference>[-1, +0, -]
int lua_setmetatable (lua_State *L, int index);
Pops a table from the stack and
sets it as the new metatable for the value at the given
acceptable index.
</reference>
</element>
<element pattern="lua_settable">
<reference>[-2, +0, e]
void lua_settable (lua_State *L, int index);
Does the equivalent to t[k] = v,
where t is the value at the given valid index,
v is the value at the top of the stack,
and k is the value just below the top.
This function pops both the key and the value from the stack.
As in Lua, this function may trigger a metamethod
for the "newindex" event (see §2.8).
</reference>
</element>
<element pattern="lua_settop">
<reference>[-?, +?, -]
void lua_settop (lua_State *L, int index);
Accepts any acceptable index, or 0,
and sets the stack top to this index.
If the new top is larger than the old one,
then the new elements are filled with nil.
If index is 0, then all stack elements are removed.
</reference>
</element>
<element pattern="lua_status">
<reference>[-0, +0, -]
int lua_status (lua_State *L);
Returns the status of the thread L.
The status can be 0 for a normal thread,
an error code if the thread finished its execution with an error,
or LUA_YIELD if the thread is suspended.
</reference>
</element>
<element pattern="lua_toboolean">
<reference>[-0, +0, -]
int lua_toboolean (lua_State *L, int index);
Converts the Lua value at the given acceptable index to a C boolean
value (0 or 1).
Like all tests in Lua,
lua_toboolean returns 1 for any Lua value
different from false and nil;
otherwise it returns 0.
It also returns 0 when called with a non-valid index.
(If you want to accept only actual boolean values,
use lua_isboolean to test the value's type.)
</reference>
</element>
<element pattern="lua_tocfunction">
<reference>[-0, +0, -]
lua_CFunction lua_tocfunction (lua_State *L, int index);
Converts a value at the given acceptable index to a C function.
That value must be a C function;
otherwise, returns NULL.
</reference>
</element>
<element pattern="lua_tointeger">
<reference>[-0, +0, -]
lua_Integer lua_tointeger (lua_State *L, int index);
Converts the Lua value at the given acceptable index
to the signed integral type lua_Integer.
The Lua value must be a number or a string convertible to a number
(see §2.2.1);
otherwise, lua_tointeger returns 0.
If the number is not an integer,
it is truncated in some non-specified way.
</reference>
</element>
<element pattern="lua_tolstring">
<reference>[-0, +0, m]
const char *lua_tolstring (lua_State *L, int index, size_t *len);
Converts the Lua value at the given acceptable index to a C string.
If len is not NULL,
it also sets *len with the string length.
The Lua value must be a string or a number;
otherwise, the function returns NULL.
If the value is a number,
then lua_tolstring also
changes the actual value in the stack to a string.
(This change confuses lua_next
when lua_tolstring is applied to keys during a table traversal.)
lua_tolstring returns a fully aligned pointer
to a string inside the Lua state.
This string always has a zero ('\0')
after its last character (as in C),
but can contain other zeros in its body.
Because Lua has garbage collection,
there is no guarantee that the pointer returned by lua_tolstring
will be valid after the corresponding value is removed from the stack.
</reference>
</element>
<element pattern="lua_tonumber">
<reference>[-0, +0, -]
lua_Number lua_tonumber (lua_State *L, int index);
Converts the Lua value at the given acceptable index
to the C type lua_Number (see lua_Number).
The Lua value must be a number or a string convertible to a number
(see §2.2.1);
otherwise, lua_tonumber returns 0.
</reference>
</element>
<element pattern="lua_topointer">
<reference>[-0, +0, -]
const void *lua_topointer (lua_State *L, int index);
Converts the value at the given acceptable index to a generic
C pointer (void*).
The value can be a userdata, a table, a thread, or a function;
otherwise, lua_topointer returns NULL.
Different objects will give different pointers.
There is no way to convert the pointer back to its original value.
Typically this function is used only for debug information.
</reference>
</element>
<element pattern="lua_tostring">
<reference>[-0, +0, m]
const char *lua_tostring (lua_State *L, int index);
Equivalent to lua_tolstring with len equal to NULL.
</reference>
</element>
<element pattern="lua_tothread">
<reference>[-0, +0, -]
lua_State *lua_tothread (lua_State *L, int index);
Converts the value at the given acceptable index to a Lua thread
(represented as lua_State*).
This value must be a thread;
otherwise, the function returns NULL.
</reference>
</element>
<element pattern="lua_touserdata">
<reference>[-0, +0, -]
void *lua_touserdata (lua_State *L, int index);
If the value at the given acceptable index is a full userdata,
returns its block address.
If the value is a light userdata,
returns its pointer.
Otherwise, returns NULL.
</reference>
</element>
<element pattern="lua_type">
<reference>[-0, +0, -]
int lua_type (lua_State *L, int index);
Returns the type of the value in the given acceptable index,
or LUA_TNONE for a non-valid index
(that is, an index to an "empty" stack position).
The types returned by lua_type are coded by the following constants
defined in lua.h:
LUA_TNIL,
LUA_TNUMBER,
LUA_TBOOLEAN,
LUA_TSTRING,
LUA_TTABLE,
LUA_TFUNCTION,
LUA_TUSERDATA,
LUA_TTHREAD,
and
LUA_TLIGHTUSERDATA.
</reference>
</element>
<element pattern="lua_typename">
<reference>[-0, +0, -]
const char *lua_typename (lua_State *L, int tp);
Returns the name of the type encoded by the value tp,
which must be one the values returned by lua_type.
</reference>
</element>
<element pattern="lua_xmove">
<reference>[-?, +?, -]
void lua_xmove (lua_State *from, lua_State *to, int n);
Exchange values between different threads of the same global state.
This function pops n values from the stack from,
and pushes them onto the stack to.
</reference>
</element>
<element pattern="lua_yield">
<reference>[-?, +?, -]
int lua_yield (lua_State *L, int nresults);
Yields a coroutine.
This function should only be called as the
return expression of a C function, as follows:
 return lua_yield (L, nresults);

When a C function calls lua_yield in that way,
the running coroutine suspends its execution,
and the call to lua_resume that started this coroutine returns.
The parameter nresults is the number of values from the stack
that are passed as results to lua_resume.
</reference>
</element>
<element pattern="lua_gethook">
<reference>[-0, +0, -]
lua_Hook lua_gethook (lua_State *L);
Returns the current hook function.
</reference>
</element>
<element pattern="lua_gethookcount">
<reference>[-0, +0, -]
int lua_gethookcount (lua_State *L);
Returns the current hook count.
</reference>
</element>
<element pattern="lua_gethookmask">
<reference>[-0, +0, -]
int lua_gethookmask (lua_State *L);
Returns the current hook mask.
</reference>
</element>
<element pattern="lua_getinfo">
<reference>[-(0|1), +(0|1|2), m]
int lua_getinfo (lua_State *L, const char *what, lua_Debug *ar);
Returns information about a specific function or function invocation.
To get information about a function invocation,
the parameter ar must be a valid activation record that was
filled by a previous call to lua_getstack or
given as argument to a hook (see lua_Hook).
To get information about a function you push it onto the stack
and start the what string with the character '&gt;'.
(In that case,
lua_getinfo pops the function in the top of the stack.)
For instance, to know in which line a function f was defined,
you can write the following code:
 lua_Debug ar;
 lua_getfield(L, LUA_GLOBALSINDEX, "f"); /* get global 'f' */
 lua_getinfo(L, "&gt;S", &amp;ar);
 printf("%d\n", ar.linedefined);

Each character in the string what
selects some fields of the structure ar to be filled or
a value to be pushed on the stack:
'n': fills in the field name and namewhat;
'S':
fills in the fields source, short_src,
linedefined, lastlinedefined, and what;
'l': fills in the field currentline;
'u': fills in the field nups;
'f':
pushes onto the stack the function that is
running at the given level;
'L':
pushes onto the stack a table whose indices are the
numbers of the lines that are valid on the function.
(A valid line is a line with some associated code,
that is, a line where you can put a break point.
Non-valid lines include empty lines and comments.)
This function returns 0 on error
(for instance, an invalid option in what).
</reference>
</element>
<element pattern="lua_getlocal">
<reference>[-0, +(0|1), -]
const char *lua_getlocal (lua_State *L, lua_Debug *ar, int n);
Gets information about a local variable of a given activation record.
The parameter ar must be a valid activation record that was
filled by a previous call to lua_getstack or
given as argument to a hook (see lua_Hook).
The index n selects which local variable to inspect
(1 is the first parameter or active local variable, and so on,
until the last active local variable).
lua_getlocal pushes the variable's value onto the stack
and returns its name.
Variable names starting with '(' (open parentheses)
represent internal variables
(loop control variables, temporaries, and C function locals).
Returns NULL (and pushes nothing)
when the index is greater than
the number of active local variables.
</reference>
</element>
<element pattern="lua_getstack">
<reference>[-0, +0, -]
int lua_getstack (lua_State *L, int level, lua_Debug *ar);
Get information about the interpreter runtime stack.
This function fills parts of a lua_Debug structure with
an identification of the activation record
of the function executing at a given level.
Level 0 is the current running function,
whereas level n+1 is the function that has called level n.
When there are no errors, lua_getstack returns 1;
when called with a level greater than the stack depth,
it returns 0.
</reference>
</element>
<element pattern="lua_getupvalue">
<reference>[-0, +(0|1), -]
const char *lua_getupvalue (lua_State *L, int funcindex, int n);
Gets information about a closure's upvalue.
(For Lua functions,
upvalues are the external local variables that the function uses,
and that are consequently included in its closure.)
lua_getupvalue gets the index n of an upvalue,
pushes the upvalue's value onto the stack,
and returns its name.
funcindex points to the closure in the stack.
(Upvalues have no particular order,
as they are active through the whole function.
So, they are numbered in an arbitrary order.)
Returns NULL (and pushes nothing)
when the index is greater than the number of upvalues.
For C functions, this function uses the empty string ""
as a name for all upvalues.
</reference>
</element>
<element pattern="lua_sethook">
<reference>[-0, +0, -]
int lua_sethook (lua_State *L, lua_Hook f, int mask, int count);
Sets the debugging hook function.
Argument f is the hook function.
mask specifies on which events the hook will be called:
it is formed by a bitwise or of the constants
LUA_MASKCALL,
LUA_MASKRET,
LUA_MASKLINE,
and LUA_MASKCOUNT.
The count argument is only meaningful when the mask
includes LUA_MASKCOUNT.
For each event, the hook is called as explained below:
The call hook: is called when the interpreter calls a function.
The hook is called just after Lua enters the new function,
before the function gets its arguments.
The return hook: is called when the interpreter returns from a function.
The hook is called just before Lua leaves the function.
You have no access to the values to be returned by the function.
The line hook: is called when the interpreter is about to
start the execution of a new line of code,
or when it jumps back in the code (even to the same line).
(This event only happens while Lua is executing a Lua function.)
The count hook: is called after the interpreter executes every
count instructions.
(This event only happens while Lua is executing a Lua function.)
A hook is disabled by setting mask to zero.
</reference>
</element>
<element pattern="lua_setlocal">
<reference>[-(0|1), +0, -]
const char *lua_setlocal (lua_State *L, lua_Debug *ar, int n);
Sets the value of a local variable of a given activation record.
Parameters ar and n are as in lua_getlocal
(see lua_getlocal).
lua_setlocal assigns the value at the top of the stack
to the variable and returns its name.
It also pops the value from the stack.
Returns NULL (and pops nothing)
when the index is greater than
the number of active local variables.
</reference>
</element>
<element pattern="lua_setupvalue">
<reference>[-(0|1), +0, -]
const char *lua_setupvalue (lua_State *L, int funcindex, int n);
Sets the value of a closure's upvalue.
It assigns the value at the top of the stack
to the upvalue and returns its name.
It also pops the value from the stack.
Parameters funcindex and n are as in the lua_getupvalue
(see lua_getupvalue).
Returns NULL (and pops nothing)
when the index is greater than the number of upvalues.
</reference>
</element>
<element pattern="luaL_addchar">
<reference>[-0, +0, m]
void luaL_addchar (luaL_Buffer *B, char c);
Adds the character c to the buffer B
(see luaL_Buffer).
</reference>
</element>
<element pattern="luaL_addlstring">
<reference>[-0, +0, m]
void luaL_addlstring (luaL_Buffer *B, const char *s, size_t l);
Adds the string pointed to by s with length l to
the buffer B
(see luaL_Buffer).
The string may contain embedded zeros.
</reference>
</element>
<element pattern="luaL_addsize">
<reference>[-0, +0, m]
void luaL_addsize (luaL_Buffer *B, size_t n);
Adds to the buffer B (see luaL_Buffer)
a string of length n previously copied to the
buffer area (see luaL_prepbuffer).
</reference>
</element>
<element pattern="luaL_addstring">
<reference>[-0, +0, m]
void luaL_addstring (luaL_Buffer *B, const char *s);
Adds the zero-terminated string pointed to by s
to the buffer B
(see luaL_Buffer).
The string may not contain embedded zeros.
</reference>
</element>
<element pattern="luaL_addvalue">
<reference>[-1, +0, m]
void luaL_addvalue (luaL_Buffer *B);
Adds the value at the top of the stack
to the buffer B
(see luaL_Buffer).
Pops the value.
This is the only function on string buffers that can (and must)
be called with an extra element on the stack,
which is the value to be added to the buffer.
</reference>
</element>
<element pattern="luaL_argcheck">
<reference>[-0, +0, v]
void luaL_argcheck (lua_State *L,
 int cond,
 int narg,
 const char *extramsg);
Checks whether cond is true.
If not, raises an error with the following message,
where func is retrieved from the call stack:
 bad argument #&amp;lt;narg&amp;gt; to &amp;lt;func&amp;gt; (&amp;lt;extramsg&amp;gt;)
</reference>
</element>
<element pattern="luaL_argerror">
<reference>[-0, +0, v]
int luaL_argerror (lua_State *L, int narg, const char *extramsg);
Raises an error with the following message,
where func is retrieved from the call stack:
 bad argument #&amp;lt;narg&amp;gt; to &amp;lt;func&amp;gt; (&amp;lt;extramsg&amp;gt;)
This function never returns,
but it is an idiom to use it in C functions
as return luaL_argerror(args).
</reference>
</element>
<element pattern="luaL_buffinit">
<reference>[-0, +0, e]
void luaL_buffinit (lua_State *L, luaL_Buffer *B);
Initializes a buffer B.
This function does not allocate any space;
the buffer must be declared as a variable
(see luaL_Buffer).
</reference>
</element>
<element pattern="luaL_callmeta">
<reference>[-0, +(0|1), e]
int luaL_callmeta (lua_State *L, int obj, const char *e);
Calls a metamethod.
If the object at index obj has a metatable and this
metatable has a field e,
this function calls this field and passes the object as its only argument.
In this case this function returns 1 and pushes onto the
stack the value returned by the call.
If there is no metatable or no metamethod,
this function returns 0 (without pushing any value on the stack).
</reference>
</element>
<element pattern="luaL_checkany">
<reference>[-0, +0, v]
void luaL_checkany (lua_State *L, int narg);
Checks whether the function has an argument
of any type (including nil) at position narg.
</reference>
</element>
<element pattern="luaL_checkint">
<reference>[-0, +0, v]
int luaL_checkint (lua_State *L, int narg);
Checks whether the function argument narg is a number
and returns this number cast to an int.
</reference>
</element>
<element pattern="luaL_checkinteger">
<reference>[-0, +0, v]
lua_Integer luaL_checkinteger (lua_State *L, int narg);
Checks whether the function argument narg is a number
and returns this number cast to a lua_Integer.
</reference>
</element>
<element pattern="luaL_checklong">
<reference>[-0, +0, v]
long luaL_checklong (lua_State *L, int narg);
Checks whether the function argument narg is a number
and returns this number cast to a long.
</reference>
</element>
<element pattern="luaL_checklstring">
<reference>[-0, +0, v]
const char *luaL_checklstring (lua_State *L, int narg, size_t *l);
Checks whether the function argument narg is a string
and returns this string;
if l is not NULL fills *l
with the string's length.
This function uses lua_tolstring to get its result,
so all conversions and caveats of that function apply here.
</reference>
</element>
<element pattern="luaL_checknumber">
<reference>[-0, +0, v]
lua_Number luaL_checknumber (lua_State *L, int narg);
Checks whether the function argument narg is a number
and returns this number.
</reference>
</element>
<element pattern="luaL_checkoption">
<reference>[-0, +0, v]
int luaL_checkoption (lua_State *L,
 int narg,
 const char *def,
 const char *const lst[]);
Checks whether the function argument narg is a string and
searches for this string in the array lst
(which must be NULL-terminated).
Returns the index in the array where the string was found.
Raises an error if the argument is not a string or
if the string cannot be found.
If def is not NULL,
the function uses def as a default value when
there is no argument narg or if this argument is nil.
This is a useful function for mapping strings to C enums.
(The usual convention in Lua libraries is
to use strings instead of numbers to select options.)
</reference>
</element>
<element pattern="luaL_checkstack">
<reference>[-0, +0, v]
void luaL_checkstack (lua_State *L, int sz, const char *msg);
Grows the stack size to top + sz elements,
raising an error if the stack cannot grow to that size.
msg is an additional text to go into the error message.
</reference>
</element>
<element pattern="luaL_checkstring">
<reference>[-0, +0, v]
const char *luaL_checkstring (lua_State *L, int narg);
Checks whether the function argument narg is a string
and returns this string.
This function uses lua_tolstring to get its result,
so all conversions and caveats of that function apply here.
</reference>
</element>
<element pattern="luaL_checktype">
<reference>[-0, +0, v]
void luaL_checktype (lua_State *L, int narg, int t);
Checks whether the function argument narg has type t.
See lua_type for the encoding of types for t.
</reference>
</element>
<element pattern="luaL_checkudata">
<reference>[-0, +0, v]
void *luaL_checkudata (lua_State *L, int narg, const char *tname);
Checks whether the function argument narg is a userdata
of the type tname (see luaL_newmetatable).
</reference>
</element>
<element pattern="luaL_dofile">
<reference>[-0, +?, m]
int luaL_dofile (lua_State *L, const char *filename);
Loads and runs the given file.
It is defined as the following macro:
 (luaL_loadfile(L, filename) || lua_pcall(L, 0, LUA_MULTRET, 0))
It returns 0 if there are no errors
or 1 in case of errors.
</reference>
</element>
<element pattern="luaL_dostring">
<reference>[-0, +?, m]
int luaL_dostring (lua_State *L, const char *str);
Loads and runs the given string.
It is defined as the following macro:
 (luaL_loadstring(L, str) || lua_pcall(L, 0, LUA_MULTRET, 0))
It returns 0 if there are no errors
or 1 in case of errors.
</reference>
</element>
<element pattern="luaL_error">
<reference>[-0, +0, v]
int luaL_error (lua_State *L, const char *fmt, ...);
Raises an error.
The error message format is given by fmt
plus any extra arguments,
following the same rules of lua_pushfstring.
It also adds at the beginning of the message the file name and
the line number where the error occurred,
if this information is available.
This function never returns,
but it is an idiom to use it in C functions
as return luaL_error(args).
</reference>
</element>
<element pattern="luaL_getmetafield">
<reference>[-0, +(0|1), m]
int luaL_getmetafield (lua_State *L, int obj, const char *e);
Pushes onto the stack the field e from the metatable
of the object at index obj.
If the object does not have a metatable,
or if the metatable does not have this field,
returns 0 and pushes nothing.
</reference>
</element>
<element pattern="luaL_getmetatable">
<reference>[-0, +1, -]
void luaL_getmetatable (lua_State *L, const char *tname);
Pushes onto the stack the metatable associated with name tname
in the registry (see luaL_newmetatable).
</reference>
</element>
<element pattern="luaL_gsub">
<reference>[-0, +1, m]
const char *luaL_gsub (lua_State *L,
 const char *s,
 const char *p,
 const char *r);
Creates a copy of string s by replacing
any occurrence of the string p
with the string r.
Pushes the resulting string on the stack and returns it.
</reference>
</element>
<element pattern="luaL_loadbuffer">
<reference>[-0, +1, m]
int luaL_loadbuffer (lua_State *L,
 const char *buff,
 size_t sz,
 const char *name);
Loads a buffer as a Lua chunk.
This function uses lua_load to load the chunk in the
buffer pointed to by buff with size sz.
This function returns the same results as lua_load.
name is the chunk name,
used for debug information and error messages.
</reference>
</element>
<element pattern="luaL_loadfile">
<reference>[-0, +1, m]
int luaL_loadfile (lua_State *L, const char *filename);
Loads a file as a Lua chunk.
This function uses lua_load to load the chunk in the file
named filename.
If filename is NULL,
then it loads from the standard input.
The first line in the file is ignored if it starts with a #.
This function returns the same results as lua_load,
but it has an extra error code LUA_ERRFILE
if it cannot open/read the file.
As lua_load, this function only loads the chunk;
it does not run it.
</reference>
</element>
<element pattern="luaL_loadstring">
<reference>[-0, +1, m]
int luaL_loadstring (lua_State *L, const char *s);
Loads a string as a Lua chunk.
This function uses lua_load to load the chunk in
the zero-terminated string s.
This function returns the same results as lua_load.
Also as lua_load, this function only loads the chunk;
it does not run it.
</reference>
</element>
<element pattern="luaL_newmetatable">
<reference>[-0, +1, m]
int luaL_newmetatable (lua_State *L, const char *tname);
If the registry already has the key tname,
returns 0.
Otherwise,
creates a new table to be used as a metatable for userdata,
adds it to the registry with key tname,
and returns 1.
In both cases pushes onto the stack the final value associated
with tname in the registry.
</reference>
</element>
<element pattern="luaL_newstate">
<reference>[-0, +0, -]
lua_State *luaL_newstate (void);
Creates a new Lua state.
It calls lua_newstate with an
allocator based on the standard C realloc function
and then sets a panic function (see lua_atpanic) that prints
an error message to the standard error output in case of fatal
errors.
Returns the new state,
or NULL if there is a memory allocation error.
</reference>
</element>
<element pattern="luaL_openlibs">
<reference>[-0, +0, m]
void luaL_openlibs (lua_State *L);
Opens all standard Lua libraries into the given state.
</reference>
</element>
<element pattern="luaL_optint">
<reference>[-0, +0, v]
int luaL_optint (lua_State *L, int narg, int d);
If the function argument narg is a number,
returns this number cast to an int.
If this argument is absent or is nil,
returns d.
Otherwise, raises an error.
</reference>
</element>
<element pattern="luaL_optinteger">
<reference>[-0, +0, v]
lua_Integer luaL_optinteger (lua_State *L,
 int narg,
 lua_Integer d);
If the function argument narg is a number,
returns this number cast to a lua_Integer.
If this argument is absent or is nil,
returns d.
Otherwise, raises an error.
</reference>
</element>
<element pattern="luaL_optlong">
<reference>[-0, +0, v]
long luaL_optlong (lua_State *L, int narg, long d);
If the function argument narg is a number,
returns this number cast to a long.
If this argument is absent or is nil,
returns d.
Otherwise, raises an error.
</reference>
</element>
<element pattern="luaL_optlstring">
<reference>[-0, +0, v]
const char *luaL_optlstring (lua_State *L,
 int narg,
 const char *d,
 size_t *l);
If the function argument narg is a string,
returns this string.
If this argument is absent or is nil,
returns d.
Otherwise, raises an error.
If l is not NULL,
fills the position *l with the results's length.
</reference>
</element>
<element pattern="luaL_optnumber">
<reference>[-0, +0, v]
lua_Number luaL_optnumber (lua_State *L, int narg, lua_Number d);
If the function argument narg is a number,
returns this number.
If this argument is absent or is nil,
returns d.
Otherwise, raises an error.
</reference>
</element>
<element pattern="luaL_optstring">
<reference>[-0, +0, v]
const char *luaL_optstring (lua_State *L,
 int narg,
 const char *d);
If the function argument narg is a string,
returns this string.
If this argument is absent or is nil,
returns d.
Otherwise, raises an error.
</reference>
</element>
<element pattern="luaL_prepbuffer">
<reference>[-0, +0, -]
char *luaL_prepbuffer (luaL_Buffer *B);
Returns an address to a space of size LUAL_BUFFERSIZE
where you can copy a string to be added to buffer B
(see luaL_Buffer).
After copying the string into this space you must call
luaL_addsize with the size of the string to actually add 
it to the buffer.
</reference>
</element>
<element pattern="luaL_pushresult">
<reference>[-?, +1, m]
void luaL_pushresult (luaL_Buffer *B);
Finishes the use of buffer B leaving the final string on
the top of the stack.
</reference>
</element>
<element pattern="luaL_ref">
<reference>[-1, +0, m]
int luaL_ref (lua_State *L, int t);
Creates and returns a reference,
in the table at index t,
for the object at the top of the stack (and pops the object).
A reference is a unique integer key.
As long as you do not manually add integer keys into table t,
luaL_ref ensures the uniqueness of the key it returns.
You can retrieve an object referred by reference r
by calling lua_rawgeti(L, t, r).
Function luaL_unref frees a reference and its associated object.
If the object at the top of the stack is nil,
luaL_ref returns the constant LUA_REFNIL.
The constant LUA_NOREF is guaranteed to be different
from any reference returned by luaL_ref.
</reference>
</element>
<element pattern="luaL_register">
<reference>[-(0|1), +1, m]
void luaL_register (lua_State *L,
 const char *libname,
 const luaL_Reg *l);
Opens a library.
When called with libname equal to NULL,
it simply registers all functions in the list l
(see luaL_Reg) into the table on the top of the stack.
When called with a non-null libname,
luaL_register creates a new table t,
sets it as the value of the global variable libname,
sets it as the value of package.loaded[libname],
and registers on it all functions in the list l.
If there is a table in package.loaded[libname] or in
variable libname,
reuses this table instead of creating a new one.
In any case the function leaves the table
on the top of the stack.
</reference>
</element>
<element pattern="luaL_typename">
<reference>[-0, +0, -]
const char *luaL_typename (lua_State *L, int index);
Returns the name of the type of the value at the given index.
</reference>
</element>
<element pattern="luaL_typerror">
<reference>[-0, +0, v]
int luaL_typerror (lua_State *L, int narg, const char *tname);
Generates an error with a message like the following:
 location: bad argument narg to 'func' (tname expected, got rt)
where location is produced by luaL_where,
func is the name of the current function,
and rt is the type name of the actual argument.
</reference>
</element>
<element pattern="luaL_unref">
<reference>[-0, +0, -]
void luaL_unref (lua_State *L, int t, int ref);
Releases reference ref from the table at index t
(see luaL_ref).
The entry is removed from the table,
so that the referred object can be collected.
The reference ref is also freed to be used again.
If ref is LUA_NOREF or LUA_REFNIL,
luaL_unref does nothing.
</reference>
</element>
<element pattern="luaL_where">
<reference>[-0, +1, m]
void luaL_where (lua_State *L, int lvl);
Pushes onto the stack a string identifying the current position
of the control at level lvl in the call stack.
Typically this string has the following format:
 chunkname:currentline:
Level 0 is the running function,
level 1 is the function that called the running function,
etc.
This function is used to build a prefix for error messages.
</reference>
</element>
<element pattern="assert">
<reference>assert (v [, message])
Issues an error when
the value of its argument v is false (i.e., nil or false);
otherwise, returns all its arguments.
message is an error message;
when absent, it defaults to "assertion failed!"
</reference>
</element>
<element pattern="collectgarbage">
<reference>collectgarbage (opt [, arg])
This function is a generic interface to the garbage collector.
It performs different functions according to its first argument, opt:
"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 a garbage-collection step.
The step "size" is controlled by arg
(larger values mean more steps) in a non-specified way.
If you want to control the step size
you must experimentally tune the value of arg.
Returns true if the step finished a collection cycle.
"setpause":
sets arg as the new value for the pause of
the collector (see §2.10).
Returns the previous value for pause.
"setstepmul":
sets arg as the new value for the step multiplier of
the collector (see §2.10).
Returns the previous value for step.
</reference>
</element>
<element pattern="dofile">
<reference>dofile (filename)
Opens the named file and executes its contents as a Lua chunk.
When called without arguments,
dofile executes the contents of the standard input (stdin).
Returns all values returned by the chunk.
In case of errors, dofile propagates the error
to its caller (that is, dofile does not run in protected mode).
</reference>
</element>
<element pattern="error">
<reference>error (message [, level])
Terminates the last protected function called
and returns message as the error message.
Function error never returns.
Usually, error adds some information about the error position
at the beginning of the message.
The level argument specifies how to get the error position.
With level 1 (the default), the error position is where the
error function was called.
Level 2 points the error to where the function
that called error was called; and so on.
Passing a level 0 avoids the addition of error position information
to the message.
</reference>
</element>
<element pattern="_G">
<reference>A global variable (not a function) that
holds the global environment (that is, _G._G = _G).
Lua itself does not use this variable;
changing its value does not affect any environment,
nor vice-versa.
(Use setfenv to change environments.)
</reference>
</element>
<element pattern="getfenv">
<reference>getfenv ([f])
Returns the current environment in use by the function.
f can be a Lua function or a number
that specifies the function at that stack level:
Level 1 is the function calling getfenv.
If the given function is not a Lua function,
or if f is 0,
getfenv returns the global environment.
The default for f is 1.
</reference>
</element>
<element pattern="getmetatable">
<reference>getmetatable (object)
If object does not have a metatable, returns nil.
Otherwise,
if the object's metatable has a "__metatable" field,
returns the associated value.
Otherwise, returns the metatable of the given object.
</reference>
</element>
<element pattern="ipairs">
<reference>ipairs (t)
Returns three values: an iterator function, the table t, and 0,
so that the construction
 for i,v in ipairs(t) do body end
will iterate over the pairs (1,t[1]), (2,t[2]), ···,
up to the first integer key absent from the table.
</reference>
</element>
<element pattern="load">
<reference>load (func [, chunkname])
Loads a chunk using function func to get its pieces.
Each call to func must return a string that concatenates
with previous results.
A return of an empty string, nil, or no value signals the end of the chunk.
If there are no errors, 
returns the compiled chunk as a function;
otherwise, returns nil plus the error message.
The environment of the returned function is the global environment.
chunkname is used as the chunk name for error messages
and debug information.
When absent,
it defaults to "=(load)".
</reference>
</element>
<element pattern="loadfile">
<reference>loadfile ([filename])
Similar to load,
but gets the chunk from file filename
or from the standard input,
if no file name is given.
</reference>
</element>
<element pattern="loadstring">
<reference>loadstring (string [, chunkname]
Similar to load,
but gets the chunk from the given string.
To load and run a given string, use the idiom
 assert(loadstring(s))()
When absent,
chunkname defaults to the given string.
</reference>
</element>
<element pattern="next">
<reference>next (table [, index])
Allows a program to traverse all fields of a table.
Its first argument is a table and its second argument
is an index in this table.
next returns the next index of the table
and its associated value.
When called with nil as its second argument,
next returns an initial index
and its associated value.
When called with the last index,
or with nil in an empty table,
next returns nil.
If the second argument is absent, then it is interpreted as nil.
In particular,
you can use next(t) to check whether a table is empty.
The order in which the indices are enumerated is not specified,
even for numeric indices.
(To traverse a table in numeric order,
use a numerical for or the ipairs function.)
The behavior of next is undefined if,
during the traversal,
you assign any value to a non-existent field in the table.
You may however modify existing fields.
In particular, you may clear existing fields.
</reference>
</element>
<element pattern="pairs">
<reference>pairs (t)
Returns three values: the next function, the table t, and nil,
so that the construction
 for k,v in pairs(t) do body end
will iterate over all key–value pairs of table t.
See function next for the caveats of modifying
the table during its traversal.
</reference>
</element>
<element pattern="pcall">
<reference>pcall (f, arg1, ···)
Calls function f with
the given arguments in protected mode.
This means that any error inside f is not propagated;
instead, pcall catches the error
and returns a status code.
Its first result is the status code (a boolean),
which is true if the call succeeds without errors.
In such case, pcall also returns all results from the call,
after this first result.
In case of any error, pcall returns false plus the error message.
</reference>
</element>
<element pattern="print">
<reference>print (···)
Receives any number of arguments,
and prints their values to stdout,
using the tostring function to convert them to strings.
print is not intended for formatted output,
but only as a quick way to show a value,
typically for debugging.
For formatted output, use string.format.
</reference>
</element>
<element pattern="rawequal">
<reference>rawequal (v1, v2)
Checks whether v1 is equal to v2,
without invoking any metamethod.
Returns a boolean.
</reference>
</element>
<element pattern="rawget">
<reference>rawget (table, index)
Gets the real value of table[index], without invoking any metamethod. 
table must be a table; index may be any value. 
</reference>
</element>
<element pattern="rawset">
<reference>rawset (table, index, value)
Sets the real value of table[index] to value,
without invoking any metamethod.
table must be a table,
index any value different from nil,
and value any Lua value.
This function returns table.
</reference>
</element>
<element pattern="select">
<reference>select (index, ···)
If index is a number,
returns all arguments after argument number index.
Otherwise, index must be the string "#",
and select returns the total number of extra arguments it received.
</reference>
</element>
<element pattern="setfenv">
<reference>setfenv (f, table)
Sets the environment to be used by the given function.
f can be a Lua function or a number
that specifies the function at that stack level:
Level 1 is the function calling setfenv.
setfenv returns the given function.
As a special case, when f is 0 setfenv changes
the environment of the running thread.
In this case, setfenv returns no values.
</reference>
</element>
<element pattern="setmetatable">
<reference>setmetatable (table, metatable)
Sets the metatable for the given table.
(You cannot change the metatable of other types from Lua, only from C.)
If metatable is nil,
removes the metatable of the given table.
If the original metatable has a "__metatable" field,
raises an error.
This function returns table.
</reference>
</element>
<element pattern="tonumber">
<reference>tonumber (e [, base])
Tries to convert its argument to a number.
If the argument is already a number or a string convertible
to a number, then tonumber returns this number;
otherwise, it returns nil.
An optional argument specifies the base to interpret the numeral.
The base may be any integer between 2 and 36, inclusive.
In bases above 10, the letter 'A' (in either upper or lower case)
represents 10, 'B' represents 11, and so forth,
with 'Z' representing 35.
In base 10 (the default), the number can have a decimal part,
as well as an optional exponent part (see §2.1).
In other bases, only unsigned integers are accepted.
</reference>
</element>
<element pattern="tostring">
<reference>tostring (e)
Receives an argument of any type and
converts it to a string in a reasonable format.
For complete control of how numbers are converted,
use string.format.
If the metatable of e has a "__tostring" field,
then tostring calls the corresponding value
with e as argument,
and uses the result of the call as its result.
</reference>
</element>
<element pattern="type">
<reference>type (v)
Returns the type of its only argument, coded as a string.
The possible results of this function are
"nil" (a string, not the value nil),
"number",
"string",
"boolean",
"table",
"function",
"thread",
and "userdata".
</reference>
</element>
<element pattern="unpack">
<reference>unpack (list [, i [, j]])
Returns the elements from the given table.
This function is equivalent to
 return list[i], list[i+1], ···, list[j]
except that the above code can be written only for a fixed number
of elements.
By default, i is 1 and j is the length of the list,
as defined by the length operator (see §2.5.5).
</reference>
</element>
<element pattern="_VERSION">
<reference>_VERSION
A global variable (not a function) that
holds a string containing the current interpreter version.
The current contents of this variable is "Lua 5.1".
</reference>
</element>
<element pattern="xpcall">
<reference>xpcall (f, err)
This function is similar to pcall,
except that you can set a new error handler.
xpcall calls function f in protected mode,
using err as the error handler.
Any error inside f is not propagated;
instead, xpcall catches the error,
calls the err function with the original error object,
and returns a status code.
Its first result is the status code (a boolean),
which is true if the call succeeds without errors.
In this case, xpcall also returns all results from the call,
after this first result.
In case of any error,
xpcall returns false plus the result from err.
</reference>
</element>
<element pattern="string.byte">
<reference>string.byte (s [, i [, j]])
Returns the internal numerical codes of the characters s[i],
s[i+1], ···, s[j].
The default value for i is 1;
the default value for j is i.
Note that numerical codes are not necessarily portable across platforms.
</reference>
</element>
<element pattern="string.char">
<reference>string.char (···)
Receives zero or more integers.
Returns a string with length equal to the number of arguments,
in which each character has the internal numerical code equal
to its corresponding argument.
Note that numerical codes are not necessarily portable across platforms.
</reference>
</element>
<element pattern="string.dump">
<reference>string.dump (function)
Returns a string containing a binary representation of the given function,
so that a later loadstring on this string returns
a copy of the function.
function must be a Lua function without upvalues.
</reference>
</element>
<element pattern="string.find">
<reference>string.find (s, pattern [, init [, plain]])
Looks for the first match of
pattern in the string s.
If it finds a match, then find returns the indices of s
where this occurrence starts and ends;
otherwise, it returns nil.
A third, optional numerical argument init specifies
where to start the search;
its default value is 1 and can be negative.
A value of true as a fourth, optional argument plain
turns off the pattern matching facilities,
so the function does a plain "find substring" operation,
with no characters in pattern being considered "magic".
Note that if plain is given, then init must be given as well.
If the pattern has captures,
then in a successful match
the captured values are also returned,
after the two indices.
</reference>
</element>
<element pattern="string.format">
<reference>string.format (formatstring, ···)
Returns a formatted version of its variable number of arguments
following the description given in its first argument (which must be a string).
The format string follows the same rules as the printf family of
standard C functions.
The only differences are that the options/modifiers
*, l, L, n, p,
and h are not supported
and that there is an extra option, q.
The q option formats a string in a form suitable to be safely read
back by the Lua interpreter:
the string is written between double quotes,
and all double quotes, newlines, embedded zeros,
and backslashes in the string
are correctly escaped when written.
For instance, the call
 string.format('%q', 'a string with "quotes" and \n new line')
will produce the string:
 "a string with \"quotes\" and \
 new line"
The options c, d, E, e, f,
g, G, i, o, u, X, and x all
expect a number as argument,
whereas q and s expect a string.
This function does not accept string values
containing embedded zeros,
except as arguments to the q option.
</reference>
</element>
<element pattern="string.gmatch">
<reference>string.gmatch (s, pattern)
Returns an iterator function that,
each time it is called,
returns the next captures from pattern over string s.
If pattern specifies no captures,
then the whole match is produced in each call.
As an example, the following loop
 s = "hello world from Lua"
 for w in string.gmatch(s, "%a+") do
 print(w)
 end
will iterate over all the words from string s,
printing one per line.
</reference>
</element>
<element pattern="string.gsub">
<reference>string.gsub (s, pattern, repl [, n])
Returns a copy of s
in which all (or the first n, if given)
occurrences of the pattern have been
replaced by a replacement string specified by repl,
which can be a string, a table, or a function.
gsub also returns, as its second value,
the total number of matches that occurred.
If repl is a string, then its value is used for replacement.
The character % works as an escape character:
any sequence in repl of the form %n,
with n between 1 and 9,
stands for the value of the n-th captured substring (see below).
The sequence %0 stands for the whole match.
The sequence %% stands for a single %.
If repl is a table, then the table is queried for every match,
using the first capture as the key;
if the pattern specifies no captures,
then the whole match is used as the key.
If repl is a function, then this function is called every time a
match occurs, with all captured substrings passed as arguments,
in order;
if the pattern specifies no captures,
then the whole match is passed as a sole argument.
If the value returned by the table query or by the function call
is a string or a number,
then it is used as the replacement string;
otherwise, if it is false or nil,
then there is no replacement
(that is, the original match is kept in the string).
</reference>
</element>
<element pattern="string.len">
<reference>string.len (s)
Receives a string and returns its length.
The empty string "" has length 0.
Embedded zeros are counted,
so "a\000bc\000" has length 5.
</reference>
</element>
<element pattern="string.lower">
<reference>string.lower (s)
Receives a string and returns a copy of this string with all
uppercase letters changed to lowercase.
All other characters are left unchanged.
The definition of what an uppercase letter is depends on the current locale.
</reference>
</element>
<element pattern="string.match">
<reference>string.match (s, pattern [, init])
Looks for the first match of
pattern in the string s.
If it finds one, then match returns
the captures from the pattern;
otherwise it returns nil.
If pattern specifies no captures,
then the whole match is returned.
A third, optional numerical argument init specifies
where to start the search;
its default value is 1 and can be negative.
</reference>
</element>
<element pattern="string.rep">
<reference>string.rep (s, n)
Returns a string that is the concatenation of n copies of
the string s.
</reference>
</element>
<element pattern="string.reverse">
<reference>string.reverse (s)
Returns a string that is the string s reversed.
</reference>
</element>
<element pattern="string.sub">
<reference>string.sub (s, i [, j])
Returns the substring of s that
starts at i and continues until j;
i and j can be negative.
If j is absent, then it is assumed to be equal to -1
(which is the same as the string length).
In particular,
the call string.sub(s,1,j) returns a prefix of s
with length j,
and string.sub(s, -i) returns a suffix of s
with length i.
</reference>
</element>
<element pattern="string.upper">
<reference>string.upper (s)
Receives a string and returns a copy of this string with all
lowercase letters changed to uppercase.
All other characters are left unchanged.
The definition of what a lowercase letter is depends on the current locale.
<h3>5.4.1 - Patterns</h3>
<h4>Character Class:</h4>
A character class is used to represent a set of characters.
The following combinations are allowed in describing a character class:
x:
(where x is not one of the magic characters
^$()%.[]*+-?)
represents the character x itself.
.: (a dot) represents all characters.
%a: represents all letters.
%c: represents all control characters.
%d: represents all digits.
%l: represents all lowercase letters.
%p: represents all punctuation characters.
%s: represents all space characters.
%u: represents all uppercase letters.
%w: represents all alphanumeric characters.
%x: represents all hexadecimal digits.
%z: represents the character with representation 0.
%x: (where x is any non-alphanumeric character)
represents the character x.
This is the standard way to escape the magic characters.
Any punctuation character (even the non magic)
can be preceded by a '%'
when used to represent itself in a pattern.
[set]:
represents the class which is the union of all
characters in set.
A range of characters can be specified by
separating the end characters of the range with a '-'.
All classes %x described above can also be used as
components in set.
All other characters in set represent themselves.
</reference>
</element>
<element pattern="table.concat">
<reference>table.concat (table [, sep [, i [, j]]])
Given an array where all elements are strings or numbers,
returns table[i]..sep..table[i+1] ··· sep..table[j].
The default value for sep is the empty string,
the default for i is 1,
and the default for j is the length of the table.
If i is greater than j, returns the empty string.
</reference>
</element>
<element pattern="table.insert">
<reference>table.insert (table, [pos,] value)
Inserts element value at position pos in table,
shifting up other elements to open space, if necessary.
The default value for pos is n+1,
where n is the length of the table (see §2.5.5),
so that a call table.insert(t,x) inserts x at the end
of table t.
</reference>
</element>table.maxn (table)
<element pattern="table.maxn">
<reference>Returns the largest positive numerical index of the given table,
or zero if the table has no positive numerical indices.
(To do its job this function does a linear traversal of
the whole table.) 
</reference>
</element>
<element pattern="table.remove">
<reference>table.remove (table [, pos])
Removes from table the element at position pos,
shifting down other elements to close the space, if necessary.
Returns the value of the removed element.
The default value for pos is n,
where n is the length of the table,
so that a call table.remove(t) removes the last element
of table t.
</reference>
</element>
<element pattern="table.sort">
<reference>table.sort (table [, comp])
Sorts table elements in a given order, in-place,
from table[1] to table[n],
where n is the length of the table.
If comp is given,
then it must be a function that receives two table elements,
and returns true
when the first is less than the second
(so that not comp(a[i+1],a[i]) will be true after the sort).
If comp is not given,
then the standard Lua operator &amp;lt; is used instead.
The sort algorithm is not stable;
that is, elements considered equal by the given order
may have their relative positions changed by the sort.
</reference>
</element>
<element pattern="math.abs">
<reference>math.abs (x)
Returns the absolute value of x.
</reference>
</element>
<element pattern="math.acos">
<reference>math.acos (x)
Returns the arc cosine of x (in radians).
</reference>
</element>
<element pattern="math.asin">
<reference>math.asin (x)
Returns the arc sine of x (in radians).
</reference>
</element>
<element pattern="math.atan">
<reference>math.atan (x)
Returns the arc tangent of x (in radians).
</reference>
</element>
<element pattern="math.atan2">
<reference>math.atan2 (y, x)
Returns the arc tangent of y/x (in radians),
but uses the signs of both parameters to find the
quadrant of the result.
(It also handles correctly the case of x being zero.)
</reference>
</element>
<element pattern="math.ceil">
<reference>math.ceil (x)
Returns the smallest integer larger than or equal to x.
</reference>
</element>
<element pattern="math.cos">
<reference>math.cos (x)
Returns the cosine of x (assumed to be in radians).
</reference>
</element>
<element pattern="math.cosh">
<reference>math.cosh (x)
Returns the hyperbolic cosine of x.
</reference>
</element>
<element pattern="math.deg">
<reference>math.deg (x)
Returns the angle x (given in radians) in degrees.
</reference>
</element>
<element pattern="math.exp">
<reference>math.exp (x)
Returns the value ex.
</reference>
</element>
<element pattern="math.floor">
<reference>math.floor (x)
Returns the largest integer smaller than or equal to x.
</reference>
</element>
<element pattern="math.fmod">
<reference>math.fmod (x, y)
Returns the remainder of the division of x by y
that rounds the quotient towards zero.
</reference>
</element>
<element pattern="math.frexp">
<reference>math.frexp (x)
Returns m and e such that x = m2e,
e is an integer and the absolute value of m is
in the range [0.5, 1)
(or zero when x is zero).
</reference>
</element>
<element pattern="math.ldexp">
<reference>math.ldexp (m, e)
Returns m2e (e should be an integer).
</reference>
</element>
<element pattern="math.log">
<reference>math.log (x)
Returns the natural logarithm of x.
</reference>
</element>
<element pattern="math.log10">
<reference>math.log10 (x)
Returns the base-10 logarithm of x.
</reference>
</element>
<element pattern="math.max">
<reference>math.max (x, ···)
Returns the maximum value among its arguments.
</reference>
</element>
<element pattern="math.min">
<reference>math.min (x, ···)
Returns the minimum value among its arguments.
</reference>
</element>
<element pattern="math.modf">
<reference>math.modf (x)
Returns two numbers,
the integral part of x and the fractional part of x.
</reference>
</element>
<element pattern="math.pow">
<reference>Returns xy.
(You can also use the expression x^y to compute this value.)
</reference>
</element>
<element pattern="math.rad">
<reference>math.rad (x)
Returns the angle x (given in degrees) in radians.
</reference>
</element>
<element pattern="math.random">
<reference>This function is an interface to the simple
pseudo-random generator function rand provided by ANSI C.
(No guarantees can be given for its statistical properties.)
When called without arguments,
returns a uniform pseudo-random real number
in the range [0,1). 
When called with an integer number m,
math.random returns
a uniform pseudo-random integer in the range [1, m].
When called with two integer numbers m and n,
math.random returns a uniform pseudo-random
integer in the range [m, n].
</reference>
</element>
<element pattern="math.randomseed">
<reference>math.randomseed (x)
Sets x as the "seed"
for the pseudo-random generator:
equal seeds produce equal sequences of numbers.
</reference>
</element>
<element pattern="math.sin">
<reference>math.sin (x)
Returns the sine of x (assumed to be in radians).
</reference>
</element>
<element pattern="math.sinh">
<reference>math.sinh (x)
Returns the hyperbolic sine of x.
</reference>
</element>
<element pattern="math.sqrt">
<reference>math.sqrt (x)
Returns the square root of x.
(You can also use the expression x^0.5 to compute this value.)
</reference>
</element>
<element pattern="math.tan">
<reference>Returns the tangent of x (assumed to be in radians).
</reference>
</element>
<element pattern="math.tanh">
<reference>math.tanh (x)
Returns the hyperbolic tangent of x.
</reference>
</element>
<element pattern="io.close">
<reference>io.close ([file])
Equivalent to file:close().
Without a file, closes the default output file.
</reference>
</element>
<element pattern="io.flush">
<reference>io.flush ()
Equivalent to file:flush over the default output file.
</reference>
</element>
<element pattern="io.input">
<reference>io.input ([file])
When called with a file name, it opens the named file (in text mode),
and sets its handle as the default input file.
When called with a file handle,
it simply sets this file handle as the default input file.
When called without parameters,
it returns the current default input file.
In case of errors this function raises the error,
instead of returning an error code.
</reference>
</element>
<element pattern="io.lines">
<reference>io.lines ([filename])
Opens the given file name in read mode
and returns an iterator function that,
each time it is called,
returns a new line from the file.
Therefore, the construction
 for line in io.lines(filename) do body end
will iterate over all lines of the file.
When the iterator function detects the end of file,
it returns nil (to finish the loop) and automatically closes the file.
The call io.lines() (with no file name) is equivalent
to io.input():lines();
that is, it iterates over the lines of the default input file.
In this case it does not close the file when the loop ends.
</reference>
</element>
<element pattern="io.open">
<reference>io.open (filename [, mode])
This function opens a file,
in the mode specified in the string mode.
It returns a new file handle,
or, in case of errors, nil plus an error message.
The mode string can be any of the following:
"r": read mode (the default);
"w": write mode;
"a": append mode;
"r+": update mode, all previous data is preserved;
"w+": update mode, all previous data is erased;
"a+": append update mode, previous data is preserved,
 writing is only allowed at the end of file.
The mode string can also have a 'b' at the end,
which is needed in some systems to open the file in binary mode.
This string is exactly what is used in the
standard C function fopen.
</reference>
</element>
<element pattern="io.output">
<reference>io.output ([file])
Similar to io.input, but operates over the default output file.
</reference>
</element>
<element pattern="io.popen">
<reference>io.popen (prog [, mode])
Starts program prog in a separated process and returns
a file handle that you can use to read data from this program
(if mode is "r", the default)
or to write data to this program
(if mode is "w").
This function is system dependent and is not available
on all platforms.
</reference>
</element>
<element pattern="io.read">
<reference>io.read (···)
Equivalent to io.input():read.
</reference>
</element>
<element pattern="io.tmpfile">
<reference>io.tmpfile ()
Returns a handle for a temporary file.
This file is opened in update mode
and it is automatically removed when the program ends.
</reference>
</element>
<element pattern="io.type">
<reference>io.type (obj)
Checks whether obj is a valid file handle.
Returns the string "file" if obj is an open file handle,
"closed file" if obj is a closed file handle,
or nil if obj is not a file handle.
</reference>
</element>
<element pattern="io.write">
<reference>io.write (···)
Equivalent to io.output():write.
</reference>
</element>
<element pattern="file:close">
<reference>file:close ()
Closes file.
Note that files are automatically closed when
their handles are garbage collected,
but that takes an unpredictable amount of time to happen.
</reference>
</element>
<element pattern="file:flush">
<reference>file:flush ()
Saves any written data to file.
</reference>
</element>
<element pattern="file:lines">
<reference>file:lines ()
Returns an iterator function that,
each time it is called,
returns a new line from the file.
Therefore, the construction
 for line in file:lines() do body end
will iterate over all lines of the file.
(Unlike io.lines, this function does not close the file
when the loop ends.)
</reference>
</element>
<element pattern="file:read">
<reference>file:read (···)
Reads the file file,
according to the given formats, which specify what to read.
For each format,
the function returns a string (or a number) with the characters read,
or nil if it cannot read data with the specified format.
When called without formats,
it uses a default format that reads the entire next line
(see below).
The available formats are
"*n":
reads a number;
this is the only format that returns a number instead of a string.
"*a":
reads the whole file, starting at the current position.
On end of file, it returns the empty string.
"*l":
reads the next line (skipping the end of line),
returning nil on end of file.
This is the default format.
number:
reads a string with up to this number of characters,
returning nil on end of file.
If number is zero,
it reads nothing and returns an empty string,
or nil on end of file.
</reference>
</element>
<element pattern="file:seek">
<reference>file:seek ([whence] [, offset])
Sets and gets the file position,
measured from the beginning of the file,
to the position given by offset plus a base
specified by the string whence, as follows:
"set": base is position 0 (beginning of the file);
"cur": base is current position;
"end": base is end of file;
In case of success, function seek returns the final file position,
measured in bytes from the beginning of the file.
If this function fails, it returns nil,
plus a string describing the error.
The default value for whence is "cur",
and for offset is 0.
Therefore, the call file:seek() returns the current
file position, without changing it;
the call file:seek("set") sets the position to the
beginning of the file (and returns 0);
and the call file:seek("end") sets the position to the
end of the file, and returns its size.
</reference>
</element>
<element pattern="file:setvbuf">
<reference>file:setvbuf (mode [, size])
Sets the buffering mode for an output file.
There are three available modes:
"no":
no buffering; the result of any output operation appears immediately.
"full":
full buffering; output operation is performed only
when the buffer is full (or when you explicitly flush the file
(see io.flush)).
"line":
line buffering; output is buffered until a newline is output
or there is any input from some special files
(such as a terminal device).
For the last two cases, size
specifies the size of the buffer, in bytes.
The default is an appropriate size.
</reference>
</element>
<element pattern="file:write">
<reference>file:write (··
Writes the value of each of its arguments to
the file.
The arguments must be strings or numbers.
To write other values,
use tostring or string.format before write.
</reference>
</element>
<element pattern="os.clock">
<reference>os.clock ()
Returns an approximation of the amount in seconds of CPU time
used by the program.
</reference>
</element>
<element pattern="os.date">
<reference>os.date ([format [, time]])
Returns a string or a table containing date and time,
formatted according to the given string format.
If the time argument is present,
this is the time to be formatted
(see the os.time function for a description of this value).
Otherwise, date formats the current time.
If format starts with '!',
then the date is formatted in Coordinated Universal Time.
After this optional character,
if format is the string "*t",
then date returns a table with the following fields:
year (four digits), month (1--12), day (1--31),
hour (0--23), min (0--59), sec (0--61),
wday (weekday, Sunday is 1),
yday (day of the year),
and isdst (daylight saving flag, a boolean).
If format is not "*t",
then date returns the date as a string,
formatted according to the same rules as the C function strftime.
When called without arguments,
date returns a reasonable date and time representation that depends on
the host system and on the current locale
(that is, os.date() is equivalent to os.date("%c")).
</reference>
</element>
<element pattern="os.difftime">
<reference>os.difftime (t2, t1)
Returns the number of seconds from time t1 to time t2.
In POSIX, Windows, and some other systems,
this value is exactly t2-t1.
</reference>
</element>
<element pattern="os.execute">
<reference>os.execute ([command])
This function is equivalent to the C function system.
It passes command to be executed by an operating system shell.
It returns a status code, which is system-dependent.
If command is absent, then it returns nonzero if a shell is available
and zero otherwise.
</reference>
</element>
<element pattern="os.exit">
<reference>os.exit ([code])
Calls the C function exit,
with an optional code,
to terminate the host program.
The default value for code is the success code.
</reference>
</element>
<element pattern="os.getenv">
<reference>os.getenv (varname)
Returns the value of the process environment variable varname,
or nil if the variable is not defined.
</reference>
</element>
<element pattern="os.remove">
<reference>os.remove (filename)
Deletes the file or directory with the given name.
Directories must be empty to be removed.
If this function fails, it returns nil,
plus a string describing the error.
</reference>
</element>
<element pattern="os.rename">
<reference>os.rename (oldname, newname)
Renames file or directory named oldname to newname.
If this function fails, it returns nil,
plus a string describing the error.
</reference>
</element>
<element pattern="os.setlocale">
<reference>os.setlocale (locale [, category])
Sets the current locale of the program.
locale is a string specifying a locale;
category is an optional string describing which category to change:
"all", "collate", "ctype",
"monetary", "numeric", or "time";
the default category is "all".
The function returns the name of the new locale,
or nil if the request cannot be honored.
If locale is the empty string,
the current locale is set to an implementation-defined native locale.
If locale is the string "C",
the current locale is set to the standard C locale.
When called with nil as the first argument,
this function only returns the name of the current locale
for the given category.
</reference>
</element>
<element pattern="os.time">
<reference>os.time ([table])
Returns the current time when called without arguments,
or a time representing the date and time specified by the given table.
This table must have fields year, month, and day,
and may have fields hour, min, sec, and isdst
(for a description of these fields, see the os.date function).
The returned value is a number, whose meaning depends on your system.
In POSIX, Windows, and some other systems, this number counts the number
of seconds since some given start time (the "epoch").
In other systems, the meaning is not specified,
and the number returned by time can be used only as an argument to
date and difftime.
</reference>
</element>
<element pattern="os.tmpname">
<reference>os.tmpname ()
Returns a string with a file name that can
be used for a temporary file.
The file must be explicitly opened before its use
and explicitly removed when no longer needed.
On some systems (POSIX),
this function also creates a file with that name,
to avoid security risks.
(Someone else might create the file with wrong permissions
in the time between getting the name and creating the file.)
You still have to open the file to use it
and to remove it (even if you do not use it).
When possible,
you may prefer to use io.tmpfile,
which automatically removes the file when the program ends.
</reference>
</element>
<element pattern="debug.debug">
<reference>debug.debug ()
Enters an interactive mode with the user,
running each string that the user enters.
Using simple commands and other debug facilities,
the user can inspect global and local variables,
change their values, evaluate expressions, and so on.
A line containing only the word cont finishes this function,
so that the caller continues its execution.
Note that commands for debug.debug are not lexically nested
within any function, and so have no direct access to local variables.
</reference>
</element>
<element pattern="debug.getfenv">
<reference>debug.getfenv (o)
Returns the environment of object o.
</reference>
</element>
<element pattern="debug.gethook">
<reference>debug.gethook ([thread])
Returns the current hook settings of the thread, as three values:
the current hook function, the current hook mask,
and the current hook count
(as set by the debug.sethook function).
</reference>
</element>
<element pattern="debug.getinfo">
<reference>debug.getinfo ([thread,] function [, what])
Returns a table with information about a function.
You can give the function directly,
or you can give a number as the value of function,
which means the function running at level function of the call stack
of the given thread:
level 0 is the current function (getinfo itself);
level 1 is the function that called getinfo;
and so on.
If function is a number larger than the number of active functions,
then getinfo returns nil.
The returned table can contain all the fields returned by lua_getinfo,
with the string what describing which fields to fill in.
The default for what is to get all information available,
except the table of valid lines.
If present,
the option 'f'
adds a field named func with the function itself.
If present,
the option 'L'
adds a field named activelines with the table of
valid lines.
For instance, the expression debug.getinfo(1,"n").name returns
a table with a name for the current function,
if a reasonable name can be found,
and the expression debug.getinfo(print)
returns a table with all available information
about the print function.
</reference>
</element>
<element pattern="debug.getlocal">
<reference>debug.getlocal ([thread,] level, local)
This function returns the name and the value of the local variable
with index local of the function at level level of the stack.
(The first parameter or local variable has index 1, and so on,
until the last active local variable.)
The function returns nil if there is no local
variable with the given index,
and raises an error when called with a level out of range.
(You can call debug.getinfo to check whether the level is valid.)
Variable names starting with '(' (open parentheses)
represent internal variables
(loop control variables, temporaries, and C function locals).
</reference>
</element>
<element pattern="debug.getmetatable">
<reference>debug.getmetatable (object)
Returns the metatable of the given object
or nil if it does not have a metatable.
</reference>
</element>
<element pattern="debug.getregistry">
<reference>debug.getregistry ()
Returns the registry table (see §3.5).
</reference>
</element>
<element pattern="debug.getupvalue">
<reference>debug.getupvalue (func, up)
This function returns the name and the value of the upvalue
with index up of the function func.
The function returns nil if there is no upvalue with the given index.
</reference>
</element>
<element pattern="debug.setfenv">
<reference>debug.setfenv (object, table)
Sets the environment of the given object to the given table.
Returns object.
</reference>
</element>
<element pattern="debug.sethook">
<reference>debug.sethook ([thread,] hook, mask [, count])
Sets the given function as a hook.
The string mask and the number count describe
when the hook will be called.
The string mask may have the following characters,
with the given meaning:
"c": the hook is called every time Lua calls a function;
"r": the hook is called every time Lua returns from a function;
"l": the hook is called every time Lua enters a new line of code.
With a count different from zero,
the hook is called after every count instructions.
When called without arguments,
debug.sethook turns off the hook.
When the hook is called, its first parameter is a string
describing the event that has triggered its call:
"call", "return" (or "tail return",
when simulating a return from a tail call),
"line", and "count".
For line events,
the hook also gets the new line number as its second parameter.
Inside a hook,
you can call getinfo with level 2 to get more information about
the running function
(level 0 is the getinfo function,
and level 1 is the hook function),
unless the event is "tail return".
In this case, Lua is only simulating the return,
and a call to getinfo will return invalid data.
</reference>
</element>
<element pattern="debug.setlocal">
<reference>debug.setlocal ([thread,] level, local, value)
This function assigns the value value to the local variable
with index local of the function at level level of the stack.
The function returns nil if there is no local
variable with the given index,
and raises an error when called with a level out of range.
(You can call getinfo to check whether the level is valid.)
Otherwise, it returns the name of the local variable.
</reference>
</element>
<element pattern="debug.setmetatable">
<reference>debug.setmetatable (object, table)
Sets the metatable for the given object to the given table
(which can be nil).
</reference>
</element>
<element pattern="debug.setupvalue">
<reference>debug.setupvalue (func, up, value)
This function assigns the value value to the upvalue
with index up of the function func.
The function returns nil if there is no upvalue
with the given index.
Otherwise, it returns the name of the upvalue.
</reference>
</element>
<element pattern="debug.traceback">
<reference>debug.traceback ([thread,] [message] [, level])
Returns a string with a traceback of the call stack.
An optional message string is appended
at the beginning of the traceback.
An optional level number tells at which level
to start the traceback
(default is 1, the function calling traceback).
</reference>
</element>
</group>

<group highlight="type" >
	<autocomplete enable="1" />
<element pattern="lua_Alloc">
<reference>typedef void * (*lua_Alloc) (void *ud,
 void *ptr,
 size_t osize,
 size_t nsize);
The type of the memory-allocation function used by Lua states.
The allocator function must provide a
functionality similar to realloc,
but not exactly the same.
Its arguments are
ud, an opaque pointer passed to lua_newstate;
ptr, a pointer to the block being allocated/reallocated/freed;
osize, the original size of the block;
nsize, the new size of the block.
ptr is NULL if and only if osize is zero.
When nsize is zero, the allocator must return NULL;
if osize is not zero,
it should free the block pointed to by ptr.
When nsize is not zero, the allocator returns NULL
if and only if it cannot fill the request.
When nsize is not zero and osize is zero,
the allocator should behave like malloc.
When nsize and osize are not zero,
the allocator behaves like realloc.
Lua assumes that the allocator never fails when
osize &amp;gt;= nsize.
</reference>
</element>
<element pattern="lua_CFunction">
<reference>typedef int (*lua_CFunction) (lua_State *L);
Type for C functions.
In order to communicate properly with Lua,
a C function must use the following protocol,
which defines the way parameters and results are passed:
a C function receives its arguments from Lua in its stack
in direct order (the first argument is pushed first).
So, when the function starts,
lua_gettop(L) returns the number of arguments received by the function.
The first argument (if any) is at index 1
and its last argument is at index lua_gettop(L).
To return values to Lua, a C function just pushes them onto the stack,
in direct order (the first result is pushed first),
and returns the number of results.
Any other value in the stack below the results will be properly
discarded by Lua.
Like a Lua function, a C function called by Lua can also return
many results.
</reference>
</element>
<element pattern="lua_Integer">
<reference>typedef ptrdiff_t lua_Integer;
The type used by the Lua API to represent integral values.
By default it is a ptrdiff_t,
which is usually the largest signed integral type the machine handles
"comfortably".
</reference>
</element>
<element pattern="lua_Number">
<reference>typedef double lua_Number;
The type of numbers in Lua.
By default, it is double, but that can be changed in luaconf.h.
Through the configuration file you can change
Lua to operate with another type for numbers (e.g., float or long).
</reference>
</element>
<element pattern="lua_Reader">
<reference>typedef const char * (*lua_Reader) (lua_State *L,
 void *data,
 size_t *size);
The reader function used by lua_load.
Every time it needs another piece of the chunk,
lua_load calls the reader,
passing along its data parameter.
The reader must return a pointer to a block of memory
with a new piece of the chunk
and set size to the block size.
The block must exist until the reader function is called again.
To signal the end of the chunk,
the reader must return NULL or set size to zero.
The reader function may return pieces of any size greater than zero.
</reference>
</element>
<element pattern="lua_State">
<reference>typedef struct lua_State lua_State;
Opaque structure that keeps the whole state of a Lua interpreter.
The Lua library is fully reentrant:
it has no global variables.
All information about a state is kept in this structure.
A pointer to this state must be passed as the first argument to
every function in the library, except to lua_newstate,
which creates a Lua state from scratch.
</reference>
</element>
<element pattern="lua_Writer">
<reference>typedef int (*lua_Writer) (lua_State *L,
 const void* p,
 size_t sz,
 void* ud);
The type of the writer function used by lua_dump.
Every time it produces another piece of chunk,
lua_dump calls the writer,
passing along the buffer to be written (p),
its size (sz),
and the data parameter supplied to lua_dump.
The writer returns an error code:
0 means no errors;
any other value means an error and stops lua_dump from
calling the writer again.
</reference>
</element>
<element pattern="lua_Debug">
<reference>typedef struct lua_Debug {
 int event;
 const char *name; /* (n) */
 const char *namewhat; /* (n) */
 const char *what; /* (S) */
 const char *source; /* (S) */
 int currentline; /* (l) */
 int nups; /* (u) number of upvalues */
 int linedefined; /* (S) */
 int lastlinedefined; /* (S) */
 char short_src[LUA_IDSIZE]; /* (S) */
 /* private part */
 other fields
} lua_Debug;
A structure used to carry different pieces of
information about an active function.
lua_getstack fills only the private part
of this structure, for later use.
To fill the other fields of lua_Debug with useful information,
call lua_getinfo.
The fields of lua_Debug have the following meaning:
source:
If the function was defined in a string,
then source is that string.
If the function was defined in a file,
then source starts with a '@' followed by the file name.
short_src:
a "printable" version of source, to be used in error messages.
linedefined:
the line number where the definition of the function starts.
lastlinedefined:
the line number where the definition of the function ends.
what:
the string "Lua" if the function is a Lua function,
"C" if it is a C function,
"main" if it is the main part of a chunk,
and "tail" if it was a function that did a tail call.
In the latter case,
Lua has no other information about the function.
currentline:
the current line where the given function is executing.
When no line information is available,
currentline is set to -1.
name:
a reasonable name for the given function.
Because functions in Lua are first-class values,
they do not have a fixed name:
some functions can be the value of multiple global variables,
while others can be stored only in a table field.
The lua_getinfo function checks how the function was
called to find a suitable name.
If it cannot find a name,
then name is set to NULL.
namewhat:
explains the name field.
The value of namewhat can be
"global", "local", "method",
"field", "upvalue", or "" (the empty string),
according to how the function was called.
(Lua uses the empty string when no other option seems to apply.)
nups:
the number of upvalues of the function.
</reference>
</element>
<element pattern="lua_Hook">
<reference>typedef void (*lua_Hook) (lua_State *L, lua_Debug *ar);
Type for debugging hook functions.
Whenever a hook is called, its ar argument has its field
event set to the specific event that triggered the hook.
Lua identifies these events with the following constants:
LUA_HOOKCALL, LUA_HOOKRET,
LUA_HOOKTAILRET, LUA_HOOKLINE,
and LUA_HOOKCOUNT.
Moreover, for line events, the field currentline is also set.
To get the value of any other field in ar,
the hook must call lua_getinfo.
For return events, event can be LUA_HOOKRET,
the normal value, or LUA_HOOKTAILRET.
In the latter case, Lua is simulating a return from
a function that did a tail call;
in this case, it is useless to call lua_getinfo.
While Lua is running a hook, it disables other calls to hooks.
Therefore, if a hook calls back Lua to execute a function or a chunk,
this execution occurs without any calls to hooks.
</reference>
</element>
<element pattern="luaL_Reg">
<reference>typedef struct luaL_Reg {
 const char *name;
 lua_CFunction func;
} luaL_Reg;
Type for arrays of functions to be registered by
luaL_register.
name is the function name and func is a pointer to
the function.
Any array of luaL_Reg must end with an sentinel entry
in which both name and func are NULL.
</reference>
</element>
<element pattern="luaL_Buffer">
<reference>typedef struct luaL_Buffer luaL_Buffer;
Type for a string buffer.
A string buffer allows C code to build Lua strings piecemeal.
Its pattern of use is as follows:
First you declare a variable b of type luaL_Buffer.
Then you initialize it with a call luaL_buffinit(L, &amp;b).
Then you add string pieces to the buffer calling any of
the luaL_add* functions.
You finish by calling luaL_pushresult(&amp;b).
This call leaves the final string on the top of the stack.
</reference>
</element>
<element pattern="math.huge">
<reference>The value HUGE_VAL,
a value larger than or equal to any other numerical value.
</reference>
</element>
<element pattern="math.pi">
<reference>The value of pi.
</reference>
</element>
</group>

</context>
</definition>
</bflang>

文件操作 - lua.bflang2

文件: /usr/share/bluefish/bflang/lua.bflang2

编辑文件内容

修改文件时间

删除文件