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 #if defined(LUA_COMPAT_GETN)
19 LUALIB_API int (luaL_getn) (lua_State *L, int t);
20 LUALIB_API void (luaL_setn) (lua_State *L, int t, int n);
22 #define luaL_getn(L,i) ((int)lua_objlen(L, i))
23 #define luaL_setn(L,i,j) ((void)0) /* no op! */
26 #if defined(LUA_COMPAT_OPENLIB)
27 #define luaI_openlib luaL_openlib
31 /* extra error code for `luaL_load' */
32 #define LUA_ERRFILE (LUA_ERRERR+1)
35 typedef struct luaL_Reg {
42 LUALIB_API void (luaI_openlib) (lua_State *L, const char *libname,
43 const luaL_Reg *l, int nup);
44 LUALIB_API void (luaL_register) (lua_State *L, const char *libname,
46 LUALIB_API int (luaL_getmetafield) (lua_State *L, int obj, const char *e);
47 LUALIB_API int (luaL_callmeta) (lua_State *L, int obj, const char *e);
48 LUALIB_API int (luaL_typerror) (lua_State *L, int narg, const char *tname);
49 LUALIB_API int (luaL_argerror) (lua_State *L, int numarg, const char *extramsg);
50 LUALIB_API const char *(luaL_checklstring) (lua_State *L, int numArg,
52 LUALIB_API const char *(luaL_optlstring) (lua_State *L, int numArg,
53 const char *def, size_t *l);
54 LUALIB_API lua_Number (luaL_checknumber) (lua_State *L, int numArg);
55 LUALIB_API lua_Number (luaL_optnumber) (lua_State *L, int nArg, lua_Number def);
57 LUALIB_API lua_Integer (luaL_checkinteger) (lua_State *L, int numArg);
58 LUALIB_API lua_Integer (luaL_optinteger) (lua_State *L, int nArg,
60 #define luaL_checkint32(L,narg) ((int)luaL_checkinteger(L,narg))
61 #define luaL_optint32(L,narg,def) ((int)luaL_optinteger(L,narg,def))
64 LUALIB_API lua_Complex (luaL_checkcomplex) (lua_State *L, int narg);
67 LUALIB_API void (luaL_checkstack) (lua_State *L, int sz, const char *msg);
68 LUALIB_API void (luaL_checktype) (lua_State *L, int narg, int t);
69 LUALIB_API void (luaL_checkany) (lua_State *L, int narg);
71 LUALIB_API int (luaL_newmetatable) (lua_State *L, const char *tname);
72 LUALIB_API void *(luaL_checkudata) (lua_State *L, int ud, const char *tname);
74 LUALIB_API void (luaL_where) (lua_State *L, int lvl);
75 LUALIB_API int (luaL_error) (lua_State *L, const char *fmt, ...);
77 LUALIB_API int (luaL_checkoption) (lua_State *L, int narg, const char *def,
78 const char *const lst[]);
80 LUALIB_API int (luaL_ref) (lua_State *L, int t);
81 LUALIB_API void (luaL_unref) (lua_State *L, int t, int ref);
83 LUALIB_API int (luaL_loadfile) (lua_State *L, const char *filename);
84 LUALIB_API int (luaL_loadbuffer) (lua_State *L, const char *buff, size_t sz,
86 LUALIB_API int (luaL_loadstring) (lua_State *L, const char *s);
88 LUALIB_API lua_State *(luaL_newstate) (void);
91 LUALIB_API const char *(luaL_gsub) (lua_State *L, const char *s, const char *p,
94 LUALIB_API const char *(luaL_findtable) (lua_State *L, int idx,
95 const char *fname, int szhint);
101 ** ===============================================================
102 ** some useful macros
103 ** ===============================================================
106 #define luaL_argcheck(L, cond,numarg,extramsg) \
107 ((void)((cond) || luaL_argerror(L, (numarg), (extramsg))))
108 #define luaL_checkstring(L,n) (luaL_checklstring(L, (n), NULL))
109 #define luaL_optstring(L,n,d) (luaL_optlstring(L, (n), (d), NULL))
110 #define luaL_checkint(L,n) ((int)luaL_checkinteger(L, (n)))
111 #define luaL_optint(L,n,d) ((int)luaL_optinteger(L, (n), (d)))
112 #define luaL_checklong(L,n) ((long)luaL_checkinteger(L, (n)))
113 #define luaL_optlong(L,n,d) ((long)luaL_optinteger(L, (n), (d)))
115 #define luaL_typename(L,i) lua_typename(L, lua_type(L,(i)))
117 #define luaL_dofile(L, fn) \
118 (luaL_loadfile(L, fn) || lua_pcall(L, 0, LUA_MULTRET, 0))
120 #define luaL_dostring(L, s) \
121 (luaL_loadstring(L, s) || lua_pcall(L, 0, LUA_MULTRET, 0))
123 #define luaL_getmetatable(L,n) (lua_getfield(L, LUA_REGISTRYINDEX, (n)))
125 #define luaL_opt(L,f,n,d) (lua_isnoneornil(L,(n)) ? (d) : f(L,(n)))
128 ** {======================================================
129 ** Generic Buffer manipulation
130 ** =======================================================
135 typedef struct luaL_Buffer {
136 char *p; /* current position in buffer */
137 int lvl; /* number of strings in the stack (level) */
139 char buffer[LUAL_BUFFERSIZE];
142 #define luaL_addchar(B,c) \
143 ((void)((B)->p < ((B)->buffer+LUAL_BUFFERSIZE) || luaL_prepbuffer(B)), \
144 (*(B)->p++ = (char)(c)))
146 /* compatibility only */
147 #define luaL_putchar(B,c) luaL_addchar(B,c)
149 #define luaL_addsize(B,n) ((B)->p += (n))
151 LUALIB_API void (luaL_buffinit) (lua_State *L, luaL_Buffer *B);
152 LUALIB_API char *(luaL_prepbuffer) (luaL_Buffer *B);
153 LUALIB_API void (luaL_addlstring) (luaL_Buffer *B, const char *s, size_t l);
154 LUALIB_API void (luaL_addstring) (luaL_Buffer *B, const char *s);
155 LUALIB_API void (luaL_addvalue) (luaL_Buffer *B);
156 LUALIB_API void (luaL_pushresult) (luaL_Buffer *B);
159 /* }====================================================== */
162 /* compatibility with ref system */
164 /* pre-defined references */
165 #define LUA_NOREF (-2)
166 #define LUA_REFNIL (-1)
168 #define lua_ref(L,lock) ((lock) ? luaL_ref(L, LUA_REGISTRYINDEX) : \
169 (lua_pushstring(L, "unlocked references are obsolete"), lua_error(L), 0))
171 #define lua_unref(L,ref) luaL_unref(L, LUA_REGISTRYINDEX, (ref))
173 #define lua_getref(L,ref) lua_rawgeti(L, LUA_REGISTRYINDEX, (ref))
176 #define luaL_reg luaL_Reg