rrthomas / clue Goto Github PK

                   Clue: minimal C-Lua integration
                   -------------------------------

                   by Reuben Thomas <[email protected]>
                  http://luaforge.net/projects/clue

                              release 8


clue is a minimal C-Lua integration framework, based around just three
calls: CLUE_GET and CLUE_SET get and set Lua variables, and clue_do
executes a string of Lua code.

clue is copyright Reuben Thomas 2007-2011, and is released under the
MIT license, like Lua (see http://www.lua.org/copyright.html; it's
basically the same as the BSD license). There is no warranty.

Please report bugs and make suggestions to the email address above.


Usage
-----

In each file that uses a clue API, #include "clue.h". clue.c must be
compiled as part of the program.


clue_State *clue_init(void)

creates a new clue state (including a Lua state with standard
libraries opened), returning a pointer to the state, or NULL on error.


void clue_close(clue_State *L)

frees a clue state; you only need to call it if you care about freeing
the memory used.


void clue_do(clue_State *L, const char *code)

runs some Lua code `code' in the given state. On error, a traceback is
printed and SIGABRT is raised (but using raise, not abort, so you can
catch it if you really want to). The function is not re-entrant.


int clue_pdo(clue_State *L, const char *code)

works like clue_do, but errors are caught and returned.


int clue_call(clue_State *L, const char *func, const char *sig, ...)

calls the given function with the given signature, which is of the
form [abc][>xyz], where the "abc" are argument types and the "xyz" are
result types. Valid types are:

  n = lua_Number
  i = lua_Integer
  b = boolean (int)
  s = const char *
  S = counted string (const char *, size_t)
  z = nil (only argument, not return value)
  u = lightuserdata (void *)
  f = lua_CFunction (only argument, not return value)

The variadic arguments are the argument values followed by pointers in
which to store the results. Nil is accepted as a boolean or userdata
result, and converted to false or NULL respectively.


To get and set Lua variables, two macros are used:

CLUE_SET(L, lvar, lty, cval)

sets a Lua variable `lvar' of type `lty' to C value `cval in state L.


CLUE_GET(L, lvar, lty, cvar)

reads a value of type `lty' from Lua global `lvar' into C variable
`cvar' in state L. Strings should be copied if their value is required
after further clue calls.


Valid values for `lty' are: boolean, integer, number, string,
cfunction, userdata (for CLUE_GET), and lightuserdata (for CLUE_SET).
(Under the hood, these are the suffixes of the corresponding
lua_push... and lua_to... functions.) These are symbols, not strings;
for example:

  CLUE_SET(L, x, string, "hello");