- Main Page
- Classes
- Files

# lauxlib.h

Go to the documentation of this file.

    00001 /*
    00002 ** $Id: lauxlib.h,v 1.88.1.1 2007/12/27 13:02:25 roberto Exp $
    00003 ** Auxiliary functions for building Lua libraries
    00004 ** See Copyright Notice in lua.h
    00005 */
    00006
    00007
    00008 #ifndef lauxlib_h
    00009 #define lauxlib_h
    00010
    00011
    00012 #include <stddef.h>
    00013 #include <stdio.h>
    00014
    00015 #include "lua.h"
    00016
    00017
    00018 #if defined(LUA_COMPAT_GETN)
    00019 LUALIB_API int (luaL_getn) (lua_State *L, int t);
    00020 LUALIB_API void (luaL_setn) (lua_State *L, int t, int n);
    00021 #else
    00022 #define luaL_getn(L,i)          ((int)lua_objlen(L, i))
    00023 #define luaL_setn(L,i,j)        ((void)0)  /* no op! */
    00024 #endif
    00025
    00026 #if defined(LUA_COMPAT_OPENLIB)
    00027 #define luaI_openlib    luaL_openlib
    00028 #endif
    00029
    00030
    00031 /* extra error code for `luaL_load' */
    00032 #define LUA_ERRFILE     (LUA_ERRERR+1)
    00033
    00034
    00035 typedef struct luaL_Reg {
    00036   const char *name;
    00037   lua_CFunction func;
    00038 } luaL_Reg;
    00039
    00040
    00041
    00042 LUALIB_API void (luaI_openlib) (lua_State *L, const char *libname,
    00043                                 const luaL_Reg *l, int nup);
    00044 LUALIB_API void (luaL_register) (lua_State *L, const char *libname,
    00045                                 const luaL_Reg *l);
    00046 LUALIB_API int (luaL_getmetafield) (lua_State *L, int obj, const char *e);
    00047 LUALIB_API int (luaL_callmeta) (lua_State *L, int obj, const char *e);
    00048 LUALIB_API int (luaL_typerror) (lua_State *L, int narg, const char *tname);
    00049 LUALIB_API int (luaL_argerror) (lua_State *L, int numarg, const char *extramsg);
    00050 LUALIB_API char *(luaL_checklstring) (lua_State *L, int numArg,
    00051                                                           size_t *l);
    00052 LUALIB_API const char *(luaL_optlstring) (lua_State *L, int numArg,
    00053                                           const char *def, size_t *l);
    00054 LUALIB_API lua_Number (luaL_checknumber) (lua_State *L, int numArg);
    00055 LUALIB_API lua_Number (luaL_optnumber) (lua_State *L, int nArg, lua_Number def);
    00056
    00057 LUALIB_API lua_Integer (luaL_checkinteger) (lua_State *L, int numArg);
    00058 LUALIB_API lua_Integer (luaL_optinteger) (lua_State *L, int nArg,
    00059                                           lua_Integer def);
    00060
    00061 LUALIB_API void (luaL_checkstack) (lua_State *L, int sz, const char *msg);
    00062 LUALIB_API void (luaL_checktype) (lua_State *L, int narg, int t);
    00063 LUALIB_API void (luaL_checkany) (lua_State *L, int narg);
    00064
    00065 LUALIB_API int   (luaL_newmetatable) (lua_State *L, const char *tname);
    00066 LUALIB_API void *(luaL_checkudata) (lua_State *L, int ud, const char *tname);
    00067
    00068 LUALIB_API void (luaL_where) (lua_State *L, int lvl);
    00069 LUALIB_API int (luaL_error) (lua_State *L, const char *fmt, ...);
    00070
    00071 LUALIB_API int (luaL_checkoption) (lua_State *L, int narg, const char *def,
    00072                                    const char *const lst[]);
    00073
    00074 LUALIB_API int (luaL_ref) (lua_State *L, int t);
    00075 LUALIB_API void (luaL_unref) (lua_State *L, int t, int ref);
    00076
    00077 LUALIB_API int (luaL_loadfile) (lua_State *L, const char *filename);
    00078 LUALIB_API int (luaL_loadbuffer) (lua_State *L, const char *buff, size_t sz,
    00079                                   const char *name);
    00080 LUALIB_API int (luaL_loadstring) (lua_State *L, const char *s);
    00081
    00082 LUALIB_API lua_State *(luaL_newstate) (void);
    00083
    00084
    00085 LUALIB_API const char *(luaL_gsub) (lua_State *L, const char *s, const char *p,
    00086                                                   const char *r);
    00087
    00088 LUALIB_API const char *(luaL_findtable) (lua_State *L, int idx,
    00089                                          const char *fname, int szhint);
    00090
    00091
    00092
    00093
    00094 /*
    00095 ** ===============================================================
    00096 ** some useful macros
    00097 ** ===============================================================
    00098 */
    00099
    00100 #define luaL_argcheck(L, cond,numarg,extramsg)  \
    00101                 ((void)((cond) || luaL_argerror(L, (numarg), (extramsg))))
    00102 #define luaL_checkstring(L,n)   (luaL_checklstring(L, (n), NULL))
    00103 #define luaL_optstring(L,n,d)   (luaL_optlstring(L, (n), (d), NULL))
    00104 #define luaL_checkint(L,n)      ((int)luaL_checkinteger(L, (n)))
    00105 #define luaL_optint(L,n,d)      ((int)luaL_optinteger(L, (n), (d)))
    00106 #define luaL_checklong(L,n)     ((long)luaL_checkinteger(L, (n)))
    00107 #define luaL_optlong(L,n,d)     ((long)luaL_optinteger(L, (n), (d)))
    00108
    00109 #define luaL_typename(L,i)      lua_typename(L, lua_type(L,(i)))
    00110
    00111 #define luaL_dofile(L, fn) \
    00112         (luaL_loadfile(L, fn) || lua_pcall(L, 0, LUA_MULTRET, 0))
    00113
    00114 #define luaL_dostring(L, s) \
    00115         (luaL_loadstring(L, s) || lua_pcall(L, 0, LUA_MULTRET, 0))
    00116
    00117 #define luaL_getmetatable(L,n)  (lua_getfield(L, LUA_REGISTRYINDEX, (n)))
    00118
    00119 #define luaL_opt(L,f,n,d)       (lua_isnoneornil(L,(n)) ? (d) : f(L,(n)))
    00120
    00121 /*
    00122 ** {======================================================
    00123 ** Generic Buffer manipulation
    00124 ** =======================================================
    00125 */
    00126
    00127
    00128
    00129 typedef struct luaL_Buffer {
    00130   char *p;                      /* current position in buffer */
    00131   int lvl;  /* number of strings in the stack (level) */
    00132   lua_State *L;
    00133   char buffer[LUAL_BUFFERSIZE];
    00134 } luaL_Buffer;
    00135
    00136 #define luaL_addchar(B,c) \
    00137   ((void)((B)->p < ((B)->buffer+LUAL_BUFFERSIZE) || luaL_prepbuffer(B)), \
    00138    (*(B)->p++ = (char)(c)))
    00139
    00140 /* compatibility only */
    00141 #define luaL_putchar(B,c)       luaL_addchar(B,c)
    00142
    00143 #define luaL_addsize(B,n)       ((B)->p += (n))
    00144
    00145 LUALIB_API void (luaL_buffinit) (lua_State *L, luaL_Buffer *B);
    00146 LUALIB_API char *(luaL_prepbuffer) (luaL_Buffer *B);
    00147 LUALIB_API void (luaL_addlstring) (luaL_Buffer *B, const char *s, size_t l);
    00148 LUALIB_API void (luaL_addstring) (luaL_Buffer *B, const char *s);
    00149 LUALIB_API void (luaL_addvalue) (luaL_Buffer *B);
    00150 LUALIB_API void (luaL_pushresult) (luaL_Buffer *B);
    00151
    00152
    00153 /* }====================================================== */
    00154
    00155
    00156 /* compatibility with ref system */
    00157
    00158 /* pre-defined references */
    00159 #define LUA_NOREF       (-2)
    00160 #define LUA_REFNIL      (-1)
    00161
    00162 #define lua_ref(L,lock) ((lock) ? luaL_ref(L, LUA_REGISTRYINDEX) : \
    00163       (lua_pushstring(L, "unlocked references are obsolete"), lua_error(L), 0))
    00164
    00165 #define lua_unref(L,ref)        luaL_unref(L, LUA_REGISTRYINDEX, (ref))
    00166
    00167 #define lua_getref(L,ref)       lua_rawgeti(L, LUA_REGISTRYINDEX, (ref))
    00168
    00169
    00170 #define luaL_reg        luaL_Reg
    00171
    00172 #endif
    00173
    00174