lauxlib.h (7338B)
1 /* 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 5 */ 6 7 8 #ifndef lauxlib_h 9 #define lauxlib_h 10 11 12 #include <stddef.h> 13 #include <stdio.h> 14 15 #include "lua.h" 16 17 18 #define luaL_getn(L,i) ((int)lua_objlen(L, i)) 19 #define luaL_setn(L,i,j) ((void)0) /* no op! */ 20 21 /* extra error code for `luaL_load' */ 22 #define LUA_ERRFILE (LUA_ERRERR+1) 23 24 typedef struct luaL_Reg { 25 const char *name; 26 lua_CFunction func; 27 } luaL_Reg; 28 29 LUALIB_API int (luaL_len) (lua_State *L, int i); 30 LUALIB_API void (luaL_setfuncs) (lua_State *L, const luaL_Reg *l, int nup); 31 32 LUALIB_API int (luaL_getsubtable) (lua_State *L, int idx, const char *fname); 33 LUALIB_API void (luaL_requiref) (lua_State *L, const char *modname, 34 lua_CFunction openf, int glb); 35 LUALIB_API void (luaL_openlib) (lua_State *L, const char *libname, 36 const luaL_Reg *l, int nup); 37 LUALIB_API void (luaL_register) (lua_State *L, const char *libname, 38 const luaL_Reg *l); 39 LUALIB_API void (luaL_pushmodule) (lua_State *L, const char *modname, 40 int sizehint); 41 LUALIB_API int (luaL_getmetafield) (lua_State *L, int obj, const char *e); 42 LUALIB_API int (luaL_callmeta) (lua_State *L, int obj, const char *e); 43 LUALIB_API int (luaL_typerror) (lua_State *L, int narg, const char *tname); 44 LUALIB_API int (luaL_argerror) (lua_State *L, int numarg, const char *extramsg); 45 LUALIB_API const char *(luaL_checklstring) (lua_State *L, int numArg, 46 size_t *l); 47 LUALIB_API const char *luaL_tolstring (lua_State *L, int idx, size_t *len); 48 LUALIB_API const char *(luaL_optlstring) (lua_State *L, int numArg, 49 const char *def, size_t *l); 50 LUALIB_API lua_Number (luaL_checknumber) (lua_State *L, int numArg); 51 LUALIB_API lua_Number (luaL_optnumber) (lua_State *L, int nArg, lua_Number def); 52 53 LUALIB_API lua_Integer (luaL_checkinteger) (lua_State *L, int numArg); 54 LUALIB_API lua_Unsigned (luaL_checkunsigned) (lua_State *L, int numArg); 55 LUALIB_API lua_Integer (luaL_optinteger) (lua_State *L, int nArg, 56 lua_Integer def); 57 LUALIB_API lua_Unsigned (luaL_optunsigned) (lua_State *L, int nArg, 58 lua_Unsigned def); 59 60 61 LUALIB_API void (luaL_checkstack) (lua_State *L, int sz, const char *msg); 62 LUALIB_API void (luaL_checktype) (lua_State *L, int narg, int t); 63 LUALIB_API void (luaL_checkany) (lua_State *L, int narg); 64 65 LUALIB_API int (luaL_newmetatable) (lua_State *L, const char *tname); 66 LUALIB_API void (luaL_setmetatable) (lua_State *L, const char *tname); 67 LUALIB_API void *(luaL_testudata) (lua_State *L, int ud, const char *tname); 68 LUALIB_API void *(luaL_checkudata) (lua_State *L, int ud, const char *tname); 69 70 LUALIB_API void (luaL_where) (lua_State *L, int lvl); 71 LUALIB_API int (luaL_error) (lua_State *L, const char *fmt, ...); 72 LUALIB_API int (luaL_fileresult) (lua_State *L, int stat, const char *fname); 73 74 LUALIB_API int (luaL_checkoption) (lua_State *L, int narg, const char *def, 75 const char *const lst[]); 76 77 LUALIB_API int (luaL_ref) (lua_State *L, int t); 78 LUALIB_API void (luaL_unref) (lua_State *L, int t, int ref); 79 80 LUALIB_API int (luaL_loadfile) (lua_State *L, const char *filename); 81 LUALIB_API int (luaL_loadbuffer) (lua_State *L, const char *buff, size_t sz, 82 const char *name); 83 LUALIB_API int (luaL_loadstring) (lua_State *L, const char *s); 84 85 LUALIB_API lua_State *(luaL_newstate) (void); 86 LUALIB_API void (luaL_checkversion_) (lua_State *L, lua_Number ver); 87 #define luaL_checkversion(L) luaL_checkversion_(L, LUA_VERSION_NUM) 88 89 LUALIB_API const char *(luaL_gsub) (lua_State *L, const char *s, const char *p, 90 const char *r); 91 92 LUALIB_API const char *(luaL_findtable) (lua_State *L, int idx, 93 const char *fname, int szhint); 94 95 /* From Lua 5.2. */ 96 LUALIB_API int luaL_fileresult(lua_State *L, int stat, const char *fname); 97 LUALIB_API int luaL_execresult(lua_State *L, int stat); 98 LUALIB_API int (luaL_loadfilex) (lua_State *L, const char *filename, 99 const char *mode); 100 LUALIB_API int (luaL_loadbufferx) (lua_State *L, const char *buff, size_t sz, 101 const char *name, const char *mode); 102 LUALIB_API void luaL_traceback (lua_State *L, lua_State *L1, const char *msg, 103 int level); 104 105 106 /* 107 ** =============================================================== 108 ** some useful macros 109 ** =============================================================== 110 */ 111 112 #define luaL_newlibtable(L,l) \ 113 lua_createtable(L, 0, sizeof(l)/sizeof((l)[0]) - 1) 114 #define luaL_newlib(L,l) (luaL_newlibtable(L,l), luaL_setfuncs(L,l,0)) 115 116 #define luaL_argcheck(L, cond,numarg,extramsg) \ 117 ((void)((cond) || luaL_argerror(L, (numarg), (extramsg)))) 118 #define luaL_checkstring(L,n) (luaL_checklstring(L, (n), NULL)) 119 #define luaL_optstring(L,n,d) (luaL_optlstring(L, (n), (d), NULL)) 120 #define luaL_checkint(L,n) ((int)luaL_checkinteger(L, (n))) 121 #define luaL_optint(L,n,d) ((int)luaL_optinteger(L, (n), (d))) 122 #define luaL_checklong(L,n) ((long)luaL_checkinteger(L, (n))) 123 #define luaL_optlong(L,n,d) ((long)luaL_optinteger(L, (n), (d))) 124 125 #define luaL_typename(L,i) lua_typename(L, lua_type(L,(i))) 126 127 #define luaL_dofile(L, fn) \ 128 (luaL_loadfile(L, fn) || lua_pcall(L, 0, LUA_MULTRET, 0)) 129 130 #define luaL_dostring(L, s) \ 131 (luaL_loadstring(L, s) || lua_pcall(L, 0, LUA_MULTRET, 0)) 132 133 #define luaL_getmetatable(L,n) (lua_getfield(L, LUA_REGISTRYINDEX, (n))) 134 135 #define luaL_opt(L,f,n,d) (lua_isnoneornil(L,(n)) ? (d) : f(L,(n))) 136 137 /* 138 ** {====================================================== 139 ** Generic Buffer manipulation 140 ** ======================================================= 141 */ 142 143 144 145 typedef struct luaL_Buffer { 146 char *p; /* current position in buffer */ 147 int lvl; /* number of strings in the stack (level) */ 148 lua_State *L; 149 char buffer[LUAL_BUFFERSIZE]; 150 } luaL_Buffer; 151 152 #define luaL_addchar(B,c) \ 153 ((void)((B)->p < ((B)->buffer+LUAL_BUFFERSIZE) || luaL_prepbuffer(B)), \ 154 (*(B)->p++ = (char)(c))) 155 156 /* compatibility only */ 157 #define luaL_putchar(B,c) luaL_addchar(B,c) 158 159 #define luaL_addsize(B,n) ((B)->p += (n)) 160 161 LUALIB_API void (luaL_buffinit) (lua_State *L, luaL_Buffer *B); 162 LUALIB_API char *(luaL_prepbuffer) (luaL_Buffer *B); 163 LUALIB_API char *(luaL_prepbuffsize) (luaL_Buffer *B, size_t size); 164 LUALIB_API void (luaL_addlstring) (luaL_Buffer *B, const char *s, size_t l); 165 LUALIB_API void (luaL_addstring) (luaL_Buffer *B, const char *s); 166 LUALIB_API void (luaL_addvalue) (luaL_Buffer *B); 167 LUALIB_API void (luaL_pushresult) (luaL_Buffer *B); 168 169 170 /* }====================================================== */ 171 172 173 /* compatibility with ref system */ 174 175 /* pre-defined references */ 176 #define LUA_NOREF (-2) 177 #define LUA_REFNIL (-1) 178 179 #define lua_ref(L,lock) ((lock) ? luaL_ref(L, LUA_REGISTRYINDEX) : \ 180 (lua_pushstring(L, "unlocked references are obsolete"), lua_error(L), 0)) 181 182 #define lua_unref(L,ref) luaL_unref(L, LUA_REGISTRYINDEX, (ref)) 183 184 #define lua_getref(L,ref) lua_rawgeti(L, LUA_REGISTRYINDEX, (ref)) 185 186 187 #define luaL_reg luaL_Reg 188 189 #endif