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