apps/plugins/lua/lauxlib.h

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