2 ** $Id: lauxlib.h,v 1.88.1.1 2007/12/27 13:02:25 roberto Exp $
3 ** Auxiliary functions for building Lua libraries
4 ** See Copyright Notice in lua.h
18 #define luaL_getn(L,i) ((int)lua_objlen(L, i))
19 #define luaL_setn(L,i,j) ((void)0) /* no op! */
21 /* extra error code for `luaL_load' */
22 #define LUA_ERRFILE (LUA_ERRERR+1)
24 typedef struct luaL_Reg
{
29 LUALIB_API
void (luaL_openlib
) (lua_State
*L
, const char *libname
,
30 const luaL_Reg
*l
, int nup
);
31 LUALIB_API
void (luaL_register
) (lua_State
*L
, const char *libname
,
33 LUALIB_API
int (luaL_getmetafield
) (lua_State
*L
, int obj
, const char *e
);
34 LUALIB_API
int (luaL_callmeta
) (lua_State
*L
, int obj
, const char *e
);
35 LUALIB_API
int (luaL_typerror
) (lua_State
*L
, int narg
, const char *tname
);
36 LUALIB_API
int (luaL_argerror
) (lua_State
*L
, int numarg
, const char *extramsg
);
37 LUALIB_API
const char *(luaL_checklstring
) (lua_State
*L
, int numArg
,
39 LUALIB_API
const char *(luaL_optlstring
) (lua_State
*L
, int numArg
,
40 const char *def
, size_t *l
);
41 LUALIB_API
lua_Number (luaL_checknumber
) (lua_State
*L
, int numArg
);
42 LUALIB_API
lua_Number (luaL_optnumber
) (lua_State
*L
, int nArg
, lua_Number def
);
44 LUALIB_API
lua_Integer (luaL_checkinteger
) (lua_State
*L
, int numArg
);
45 LUALIB_API
lua_Integer (luaL_optinteger
) (lua_State
*L
, int nArg
,
48 LUALIB_API
void (luaL_checkstack
) (lua_State
*L
, int sz
, const char *msg
);
49 LUALIB_API
void (luaL_checktype
) (lua_State
*L
, int narg
, int t
);
50 LUALIB_API
void (luaL_checkany
) (lua_State
*L
, int narg
);
52 LUALIB_API
int (luaL_newmetatable
) (lua_State
*L
, const char *tname
);
53 LUALIB_API
void *(luaL_checkudata
) (lua_State
*L
, int ud
, const char *tname
);
55 LUALIB_API
void (luaL_where
) (lua_State
*L
, int lvl
);
56 LUALIB_API
int (luaL_error
) (lua_State
*L
, const char *fmt
, ...);
58 LUALIB_API
int (luaL_checkoption
) (lua_State
*L
, int narg
, const char *def
,
59 const char *const lst
[]);
61 LUALIB_API
int (luaL_ref
) (lua_State
*L
, int t
);
62 LUALIB_API
void (luaL_unref
) (lua_State
*L
, int t
, int ref
);
64 LUALIB_API
int (luaL_loadfile
) (lua_State
*L
, const char *filename
);
65 LUALIB_API
int (luaL_loadbuffer
) (lua_State
*L
, const char *buff
, size_t sz
,
67 LUALIB_API
int (luaL_loadstring
) (lua_State
*L
, const char *s
);
69 LUALIB_API lua_State
*(luaL_newstate
) (void);
72 LUALIB_API
const char *(luaL_gsub
) (lua_State
*L
, const char *s
, const char *p
,
75 LUALIB_API
const char *(luaL_findtable
) (lua_State
*L
, int idx
,
76 const char *fname
, int szhint
);
79 LUALIB_API
int luaL_fileresult(lua_State
*L
, int stat
, const char *fname
);
80 LUALIB_API
int luaL_execresult(lua_State
*L
, int stat
);
81 LUALIB_API
int (luaL_loadfilex
) (lua_State
*L
, const char *filename
,
83 LUALIB_API
int (luaL_loadbufferx
) (lua_State
*L
, const char *buff
, size_t sz
,
84 const char *name
, const char *mode
);
85 LUALIB_API
void luaL_traceback (lua_State
*L
, lua_State
*L1
, const char *msg
,
90 ** ===============================================================
92 ** ===============================================================
95 #define luaL_argcheck(L, cond,numarg,extramsg) \
96 ((void)((cond) || luaL_argerror(L, (numarg), (extramsg))))
97 #define luaL_checkstring(L,n) (luaL_checklstring(L, (n), NULL))
98 #define luaL_optstring(L,n,d) (luaL_optlstring(L, (n), (d), NULL))
99 #define luaL_checkint(L,n) ((int)luaL_checkinteger(L, (n)))
100 #define luaL_optint(L,n,d) ((int)luaL_optinteger(L, (n), (d)))
101 #define luaL_checklong(L,n) ((long)luaL_checkinteger(L, (n)))
102 #define luaL_optlong(L,n,d) ((long)luaL_optinteger(L, (n), (d)))
104 #define luaL_typename(L,i) lua_typename(L, lua_type(L,(i)))
106 #define luaL_dofile(L, fn) \
107 (luaL_loadfile(L, fn) || lua_pcall(L, 0, LUA_MULTRET, 0))
109 #define luaL_dostring(L, s) \
110 (luaL_loadstring(L, s) || lua_pcall(L, 0, LUA_MULTRET, 0))
112 #define luaL_getmetatable(L,n) (lua_getfield(L, LUA_REGISTRYINDEX, (n)))
114 #define luaL_opt(L,f,n,d) (lua_isnoneornil(L,(n)) ? (d) : f(L,(n)))
117 ** {======================================================
118 ** Generic Buffer manipulation
119 ** =======================================================
124 typedef struct luaL_Buffer
{
125 char *p
; /* current position in buffer */
126 int lvl
; /* number of strings in the stack (level) */
128 char buffer
[LUAL_BUFFERSIZE
];
131 #define luaL_addchar(B,c) \
132 ((void)((B)->p < ((B)->buffer+LUAL_BUFFERSIZE) || luaL_prepbuffer(B)), \
133 (*(B)->p++ = (char)(c)))
135 /* compatibility only */
136 #define luaL_putchar(B,c) luaL_addchar(B,c)
138 #define luaL_addsize(B,n) ((B)->p += (n))
140 LUALIB_API
void (luaL_buffinit
) (lua_State
*L
, luaL_Buffer
*B
);
141 LUALIB_API
char *(luaL_prepbuffer
) (luaL_Buffer
*B
);
142 LUALIB_API
void (luaL_addlstring
) (luaL_Buffer
*B
, const char *s
, size_t l
);
143 LUALIB_API
void (luaL_addstring
) (luaL_Buffer
*B
, const char *s
);
144 LUALIB_API
void (luaL_addvalue
) (luaL_Buffer
*B
);
145 LUALIB_API
void (luaL_pushresult
) (luaL_Buffer
*B
);
148 /* }====================================================== */
151 /* compatibility with ref system */
153 /* pre-defined references */
154 #define LUA_NOREF (-2)
155 #define LUA_REFNIL (-1)
157 #define lua_ref(L,lock) ((lock) ? luaL_ref(L, LUA_REGISTRYINDEX) : \
158 (lua_pushstring(L, "unlocked references are obsolete"), lua_error(L), 0))
160 #define lua_unref(L,ref) luaL_unref(L, LUA_REGISTRYINDEX, (ref))
162 #define lua_getref(L,ref) lua_rawgeti(L, LUA_REGISTRYINDEX, (ref))
165 #define luaL_reg luaL_Reg