Pike Module Reference:

Get string version for LUA_ERR* code

The lua Object class

This is class is made static because it should only be created by a Lua.State class to represent lua objects, functions and values. Anything on the stack, basically.

Get the type of stack value this represents.

The stack index this object points to.

If this object represents a function, call this function. Oterwhise a error is thrown.

Access the elements of a lua table.

Update table with new value.

The Lua State class

To be documented..

Creates a new lua state.

Defines what lua libraries to load. Default is to load all libraries, except debug. Available libraries: base, trable, io, string, math, debug.

pop top value from stack

Get lua object from globals

Tries to get lua object from globals if s isn't defined in the State class.

Runs the string s as lua code, or loads the file if it is a filename

Get global value

Set global value

Registers the pike function fun with lua, as name in the table at stack index table, or the global scope (LUA_GLOBALSINDEX) if omited.

Open base libarary.

Open table library.

Open io library.

Open string library.

Open math library.

Open debug library.

Because indices start at 1, the result of gettop is equal to the number of elements in the stack (and so 0 means an empty stack).

Accepts any acceptable index, or 0, and sets the stack top to that 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.

Pushes onto the stack a copy of the element at the given index.

Removes the element at the given position, shifting down the elements above that position to fill the gap.

Moves the top element into the given position, shifting up the elements above that position to open space.

Moves the top element into the given position, without shifting any element (therefore replacing the value at the given position).

Grows the stack size to top + extra elements; 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.

NOTE: When you interact with Lua API, you are responsible for controlling stack overflow.

Whenever Lua calls C, it ensures that at least LUA_MINSTACK stack positions are available. LUA_MINSTACK is defined in lua.h as 20, so that usually you do not have to worry about stack space unless your code has loops pushing elements onto the stack.

Most query functions accept as indices any value inside the available stack space, that is, indices up to the maximum stack size you have set through lua_checkstack. Such indices are called acceptable indices. More formally, we define an acceptable index as follows: (index < 0 && abs(index) <= top) || (index > 0 && index <= stackspace)

Note that 0 is never an acceptable index.

Unless otherwise noted, any function that accepts valid indices can also be called with pseudo-indices, which represent some Lua values that are accessible to the C code but are not in the stack. Pseudo-indices are used to access the global environment, the registry, and the upvalues of a C function (see 3.17).

Return 1 if the object is compatible with the given type, and 0 otherwise.

Return 1 if the object is compatible with the given type, and 0 otherwise.

Return 1 if the object is compatible with the given type, and 0 otherwise.

Return 1 if the object is compatible with the given type, and 0 otherwise.

Returns the type of a value in the stack, or LUA_TNONE for a non-valid index (that is, if that stack position is "empty").

Translates a lua type to a string.

FIXME: make sure lua_Number and pike float's are the same size (lua_Number defaults to double). configure pike with: --with-double-precision to make pike float's double.