lauxlib.h

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