root/trunk/lua/lua.d

module lua.lua;

private import lua.common;
private import lua.luaconf, lua.lauxlib;

extern (C):

const LUA_VERSION = "Lua 5.1";
const LUA_RELEASE = "Lua 5.1.4";
const LUA_VERSION_NUM = 501;
const LUA_COPYRIGHT = "Copyright (C) 1994-2008 Lua.org, PUC-Rio";
const LUA_AUTHORS = "R. Ierusalimschy, L. H. de Figueiredo & W. Celes";


// mark for precompiled code (`<esc>Lua')
const LUA_SIGNATURE = "\033Lua";

// option for multiple returns in `lua_pcall' and `lua_call'
const LUA_MULTRET = -1;


// pseudo-indices
const LUA_REGISTRYINDEX = -10000;
const LUA_ENVIRONINDEX = -10001;
const LUA_GLOBALSINDEX = -10002;

int lua_upvalueindex (int i) { return LUA_GLOBALSINDEX-i; }


// thread status; 0 is OK
const LUA_YIELD = 1;
const LUA_ERRRUN = 2;
const LUA_ERRSYNTAX = 3;
const LUA_ERRMEM = 4;
const LUA_ERRERR = 5;
const LUA_ERRFILE = LUA_ERRERR+1;

// don't specify lua_State in detail
alias void* lua_State;

typedef int  function(lua_State *L)lua_CFunction;


// functions that read/write blocks when loading/dumping Lua chunks
alias char * function(lua_State *L, void *ud, size_t *sz)lua_Reader;
alias int function(lua_State *L, void *p, size_t sz, void *ud)lua_Writer;

// prototype for memory-allocation functions
alias void * function(void *ud, void *ptr, size_t osize, size_t nsize)lua_Alloc;

// basic types
const LUA_TNONE = -1;
const LUA_TNIL = 0;
const LUA_TBOOLEAN = 1;
const LUA_TLIGHTUSERDATA = 2;
const LUA_TNUMBER = 3;
const LUA_TSTRING = 4;
const LUA_TTABLE = 5;
const LUA_TFUNCTION = 6;
const LUA_TUSERDATA = 7;
const LUA_TTHREAD = 8;

const LUA_MINSTACK = 20;

// type of numbers in Lua */
alias double lua_Number;
alias ptrdiff_t lua_Integer;

// state manipulation
lua_State * lua_newstate(lua_Alloc f, void *ud);
void  lua_close(lua_State *L);
lua_State * lua_newthread(lua_State *L);
lua_CFunction  lua_atpanic(lua_State *L, lua_CFunction panicf);


// basic stack manipulation
int  lua_gettop(lua_State *L);
void  lua_settop(lua_State *L, int idx);
void  lua_pushvalue(lua_State *L, int idx);
void  lua_remove(lua_State *L, int idx);
void  lua_insert(lua_State *L, int idx);
void  lua_replace(lua_State *L, int idx);
int  lua_checkstack(lua_State *L, int sz);

void  lua_xmove(lua_State *from, lua_State *to, int n);


// access functions (stack -> C)
int  lua_isnumber(lua_State *L, int idx);
int  lua_isstring(lua_State *L, int idx);
int  lua_iscfunction(lua_State *L, int idx);
int  lua_isuserdata(lua_State *L, int idx);
int  lua_type(lua_State *L, int idx);
ichar * lua_typename(lua_State *L, int tp);
int  lua_equal(lua_State *L, int idx1, int idx2);
int  lua_rawequal(lua_State *L, int idx1, int idx2);
int  lua_lessthan(lua_State *L, int idx1, int idx2);

lua_Number  lua_tonumber(lua_State *L, int idx);
lua_Integer  lua_tointeger(lua_State *L, int idx);
int  lua_toboolean(lua_State *L, int idx);
ichar * lua_tolstring(lua_State *L, int idx, size_t *len);
size_t  lua_objlen(lua_State *L, int idx);
lua_CFunction  lua_tocfunction(lua_State *L, int idx);
void * lua_touserdata(lua_State *L, int idx);
lua_State * lua_tothread(lua_State *L, int idx);
void * lua_topointer(lua_State *L, int idx);


// push functions (C -> stack)
void  lua_pushnil(lua_State *L);
void  lua_pushnumber(lua_State *L, lua_Number n);
void  lua_pushinteger(lua_State *L, lua_Integer n);
void  lua_pushlstring(lua_State *L, cchar *s, size_t l);
void  lua_pushstring(lua_State *L, cchar *s);
ichar * lua_pushvfstring(lua_State *L, cchar *fmt, ...);
ichar * lua_pushfstring(lua_State *L, cchar *fmt,...);
void  lua_pushcclosure(lua_State *L, lua_CFunction fn, int n);
void  lua_pushboolean(lua_State *L, int b);
void  lua_pushlightuserdata(lua_State *L, void *p);
int  lua_pushthread(lua_State *L);

// get functions (Lua -> stack)
void  lua_gettable(lua_State *L, int idx);
void  lua_getfield(lua_State *L, int idx, cchar *k);
void  lua_rawget(lua_State *L, int idx);
void  lua_rawgeti(lua_State *L, int idx, int n);
void  lua_createtable(lua_State *L, int narr, int nrec);
void * lua_newuserdata(lua_State *L, size_t sz);
int  lua_getmetatable(lua_State *L, int objindex);
void  lua_getfenv(lua_State *L, int idx);

// set functions (stack -> Lua)
void  lua_settable(lua_State *L, int idx);
void  lua_setfield(lua_State *L, int idx, cchar *k);
void  lua_rawset(lua_State *L, int idx);
void  lua_rawseti(lua_State *L, int idx, int n);
int  lua_setmetatable(lua_State *L, int objindex);
int  lua_setfenv(lua_State *L, int idx);

// `load' and `call' functions (load and run Lua code)
void  lua_call(lua_State *L, int nargs, int nresults);
int  lua_pcall(lua_State *L, int nargs, int nresults, int errfunc);
int  lua_cpcall(lua_State *L, lua_CFunction func, void *ud);
int  lua_load(lua_State *L, lua_Reader reader, void *dt, cchar *chunkname);
int  lua_dump(lua_State *L, lua_Writer writer, void *data);


// coroutine functions
int  lua_yield(lua_State *L, int nresults);
int  lua_resume(lua_State *L, int narg);
int  lua_status(lua_State *L);

// garbage-collection function and options
const LUA_GCSTOP = 0;
const LUA_GCRESTART = 1;
const LUA_GCCOLLECT = 2;
const LUA_GCCOUNT = 3;
const LUA_GCCOUNTB = 4;
const LUA_GCSTEP = 5;
const LUA_GCSETPAUSE = 6;
const LUA_GCSETSTEPMUL = 7;

int  lua_gc(lua_State *L, int what, int data);


// miscellaneous functions
int  lua_error(lua_State *L);
int  lua_next(lua_State *L, int idx);
void  lua_concat(lua_State *L, int n);
lua_Alloc  lua_getallocf(lua_State *L, void **ud);
void  lua_setallocf(lua_State *L, lua_Alloc f, void *ud);

// some useful macros
void lua_pop(lua_State* L, int n) { lua_settop(L, -(n)-1); }
void lua_newtable(lua_State* L) { lua_createtable(L, 0, 0); }
void lua_register(lua_State* L, char* n, lua_CFunction f) { lua_pushcfunction(L, f); lua_setglobal(L, n); }
void lua_pushcfunction(lua_State* L, lua_CFunction f) { lua_pushcclosure(L, f, 0); }
int lua_strlen(lua_State* L, int i) { return lua_objlen(L, i); }
bool lua_isfunction(lua_State* L, int n) { return lua_type(L, n) == LUA_TFUNCTION; }
bool lua_istable(lua_State* L, int n) { return lua_type(L, n) == LUA_TTABLE; }
bool lua_islightuserdata(lua_State* L, int n) { return lua_type(L, n) == LUA_TLIGHTUSERDATA; }
bool lua_isnil(lua_State* L, int n) { return lua_type(L, n) == LUA_TNIL; }
bool lua_isboolean(lua_State* L, int n) { return lua_type(L, n) == LUA_TBOOLEAN; }
bool lua_isthread(lua_State* L, int n) { return lua_type(L, n) == LUA_TTHREAD; }
bool lua_isnone(lua_State* L, int n) { return lua_type(L, n) == LUA_TNONE; }
bool lua_isnoneornil(lua_State* L, int n) { return lua_type(L, n) <= 0; }
void lua_pushliteral(lua_State* L, char[] s) { lua_pushlstring(L, (s ~ \0).ptr, s.length);  }
void lua_setglobal(lua_State* L, char* s) { lua_setfield(L, LUA_GLOBALSINDEX, s); }
void lua_getglobal(lua_State* L, char* s) { lua_getfield(L, LUA_GLOBALSINDEX, s); }
ichar* lua_tostring(lua_State* L, int i) { return lua_tolstring(L, i, null); }

// compatibility macros and functions
lua_State* lua_open() { return luaL_newstate(); }
void lua_getregistry(lua_State* L) { lua_pushvalue(L, LUA_REGISTRYINDEX); }
int lua_getgccount(lua_State* L) { return lua_gc(L, LUA_GCCOUNT, 0); }
alias lua_Reader lua_Chunkreader;
alias lua_Writer lua_Chunkwriter;

// hack
void lua_setlevel (lua_State *from, lua_State *to);


// Debug API

// Event codes
const LUA_HOOKCALL = 0;
const LUA_HOOKRET = 1;
const LUA_HOOKLINE = 2;
const LUA_HOOKCOUNT = 3;
const LUA_HOOKTAILRET = 4;

// Event masks
const LUA_MASKCALL = 1 << LUA_HOOKCALL;
const LUA_MASKRET = 1 << LUA_HOOKRET;
const LUA_MASKLINE = 1 << LUA_HOOKLINE;
const LUA_MASKCOUNT = 1 << LUA_HOOKCOUNT;

alias void  function(lua_State *L, lua_Debug *ar)lua_Hook;

int  lua_getstack(lua_State *L, int level, lua_Debug *ar);
int  lua_getinfo(lua_State *L, cchar *what, lua_Debug *ar);
ichar * lua_getlocal(lua_State *L, lua_Debug *ar, int n);
ichar * lua_setlocal(lua_State *L, lua_Debug *ar, int n);
ichar * lua_getupvalue(lua_State *L, int funcindex, int n);
ichar * lua_setupvalue(lua_State *L, int funcindex, int n);
int  lua_sethook(lua_State *L, lua_Hook func, int mask, int count);
lua_Hook  lua_gethook(lua_State *L);
int  lua_gethookmask(lua_State *L);
int  lua_gethookcount(lua_State *L);

struct lua_Debug
{
    int event;
    char *name;
    char *namewhat;
    char *what;
    char *source;
    int currentline;
    int nups;
    int linedefined;
    int lastlinedefined;
    char [LUA_IDSIZE]short_src;
    int i_ci;
}

/******************************************************************************
* Copyright (C) 1994-2008 Lua.org, PUC-Rio.  All rights reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
******************************************************************************/