xref: /illumos-gate/usr/src/uts/common/fs/zfs/lua/lauxlib.h (revision bde334a8dbd66dfa70ce4d7fc9dcad6e1ae45fe4)
1 /*
2 ** $Id: lauxlib.h,v 1.120.1.1 2013/04/12 18:48:47 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 <sys/zfs_context.h>
13 
14 #include "lua.h"
15 
16 
17 
18 /* extra error code for `luaL_load' */
19 #define LUA_ERRFILE     (LUA_ERRERR+1)
20 
21 
22 typedef struct luaL_Reg {
23   const char *name;
24   lua_CFunction func;
25 } luaL_Reg;
26 
27 
28 LUALIB_API void (luaL_checkversion_) (lua_State *L, lua_Number ver);
29 #define luaL_checkversion(L)	luaL_checkversion_(L, LUA_VERSION_NUM)
30 
31 LUALIB_API int (luaL_getmetafield) (lua_State *L, int obj, const char *e);
32 LUALIB_API int (luaL_callmeta) (lua_State *L, int obj, const char *e);
33 LUALIB_API const char *(luaL_tolstring) (lua_State *L, int idx, size_t *len);
34 LUALIB_API int (luaL_argerror) (lua_State *L, int numarg, const char *extramsg);
35 LUALIB_API const char *(luaL_checklstring) (lua_State *L, int numArg,
36                                                           size_t *l);
37 LUALIB_API const char *(luaL_optlstring) (lua_State *L, int numArg,
38                                           const char *def, size_t *l);
39 LUALIB_API lua_Number (luaL_checknumber) (lua_State *L, int numArg);
40 LUALIB_API lua_Number (luaL_optnumber) (lua_State *L, int nArg, lua_Number def);
41 
42 LUALIB_API lua_Integer (luaL_checkinteger) (lua_State *L, int numArg);
43 LUALIB_API lua_Integer (luaL_optinteger) (lua_State *L, int nArg,
44                                           lua_Integer def);
45 LUALIB_API lua_Unsigned (luaL_checkunsigned) (lua_State *L, int numArg);
46 LUALIB_API lua_Unsigned (luaL_optunsigned) (lua_State *L, int numArg,
47                                             lua_Unsigned def);
48 
49 LUALIB_API void (luaL_checkstack) (lua_State *L, int sz, const char *msg);
50 LUALIB_API void (luaL_checktype) (lua_State *L, int narg, int t);
51 LUALIB_API void (luaL_checkany) (lua_State *L, int narg);
52 
53 LUALIB_API int   (luaL_newmetatable) (lua_State *L, const char *tname);
54 LUALIB_API void  (luaL_setmetatable) (lua_State *L, const char *tname);
55 LUALIB_API void *(luaL_testudata) (lua_State *L, int ud, const char *tname);
56 LUALIB_API void *(luaL_checkudata) (lua_State *L, int ud, const char *tname);
57 
58 LUALIB_API void (luaL_where) (lua_State *L, int lvl);
59 LUALIB_API int (luaL_error) (lua_State *L, const char *fmt, ...);
60 
61 LUALIB_API int (luaL_checkoption) (lua_State *L, int narg, const char *def,
62                                    const char *const lst[]);
63 
64 /* pre-defined references */
65 #define LUA_NOREF       (-2)
66 #define LUA_REFNIL      (-1)
67 
68 LUALIB_API int (luaL_ref) (lua_State *L, int t);
69 LUALIB_API void (luaL_unref) (lua_State *L, int t, int ref);
70 
71 LUALIB_API int (luaL_loadbufferx) (lua_State *L, const char *buff, size_t sz,
72                                    const char *name, const char *mode);
73 LUALIB_API int (luaL_loadstring) (lua_State *L, const char *s);
74 
75 LUALIB_API int (luaL_len) (lua_State *L, int idx);
76 
77 LUALIB_API const char *(luaL_gsub) (lua_State *L, const char *s, const char *p,
78                                                   const char *r);
79 
80 LUALIB_API void (luaL_setfuncs) (lua_State *L, const luaL_Reg *l, int nup);
81 
82 LUALIB_API int (luaL_getsubtable) (lua_State *L, int idx, const char *fname);
83 
84 LUALIB_API void (luaL_traceback) (lua_State *L, lua_State *L1,
85                                   const char *msg, int level);
86 
87 LUALIB_API void (luaL_requiref) (lua_State *L, const char *modname,
88                                  lua_CFunction openf, int glb);
89 
90 /*
91 ** ===============================================================
92 ** some useful macros
93 ** ===============================================================
94 */
95 
96 
97 #define luaL_newlibtable(L,l)	\
98   lua_createtable(L, 0, sizeof(l)/sizeof((l)[0]) - 1)
99 
100 #define luaL_newlib(L,l)	(luaL_newlibtable(L,l), luaL_setfuncs(L,l,0))
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 #define luaL_loadbuffer(L,s,sz,n)	luaL_loadbufferx(L,s,sz,n,NULL)
124 
125 
126 /*
127 ** {======================================================
128 ** Generic Buffer manipulation
129 ** =======================================================
130 */
131 
132 typedef struct luaL_Buffer {
133   char *b;  /* buffer address */
134   size_t size;  /* buffer size */
135   size_t n;  /* number of characters in buffer */
136   lua_State *L;
137   char initb[LUAL_BUFFERSIZE];  /* initial buffer */
138 } luaL_Buffer;
139 
140 
141 #define luaL_addchar(B,c) \
142   ((void)((B)->n < (B)->size || luaL_prepbuffsize((B), 1)), \
143    ((B)->b[(B)->n++] = (c)))
144 
145 #define luaL_addsize(B,s)	((B)->n += (s))
146 
147 LUALIB_API void (luaL_buffinit) (lua_State *L, luaL_Buffer *B);
148 LUALIB_API char *(luaL_prepbuffsize) (luaL_Buffer *B, size_t sz);
149 LUALIB_API void (luaL_addlstring) (luaL_Buffer *B, const char *s, size_t l);
150 LUALIB_API void (luaL_addstring) (luaL_Buffer *B, const char *s);
151 LUALIB_API void (luaL_addvalue) (luaL_Buffer *B);
152 LUALIB_API void (luaL_pushresult) (luaL_Buffer *B);
153 LUALIB_API void (luaL_pushresultsize) (luaL_Buffer *B, size_t sz);
154 LUALIB_API char *(luaL_buffinitsize) (lua_State *L, luaL_Buffer *B, size_t sz);
155 
156 #define luaL_prepbuffer(B)	luaL_prepbuffsize(B, LUAL_BUFFERSIZE)
157 
158 /* }====================================================== */
159 
160 
161 /* compatibility with old module system */
162 #if defined(LUA_COMPAT_MODULE)
163 
164 LUALIB_API void (luaL_pushmodule) (lua_State *L, const char *modname,
165                                    int sizehint);
166 LUALIB_API void (luaL_openlib) (lua_State *L, const char *libname,
167                                 const luaL_Reg *l, int nup);
168 
169 #define luaL_register(L,n,l)	(luaL_openlib(L,(n),(l),0))
170 
171 #endif
172 
173 
174 #endif
175 
176 
177