xref: /illumos-gate/usr/src/uts/common/fs/zfs/lua/lua.h (revision dfc11533)
1 /*
2 ** $Id: lua.h,v 1.285.1.4 2015/02/21 14:04:50 roberto Exp $
3 ** Lua - A Scripting Language
4 ** Lua.org, PUC-Rio, Brazil (http://www.lua.org)
5 ** See Copyright Notice at the end of this file
6 */
7 
8 
9 #ifndef lua_h
10 #define lua_h
11 
12 #include <sys/zfs_context.h>
13 
14 #include "luaconf.h"
15 
16 
17 #define LUA_VERSION_MAJOR	"5"
18 #define LUA_VERSION_MINOR	"2"
19 #define LUA_VERSION_NUM		502
20 #define LUA_VERSION_RELEASE	"4"
21 
22 #define LUA_VERSION	"Lua " LUA_VERSION_MAJOR "." LUA_VERSION_MINOR
23 #define LUA_RELEASE	LUA_VERSION "." LUA_VERSION_RELEASE
24 #define LUA_COPYRIGHT	LUA_RELEASE "  Copyright (C) 1994-2015 Lua.org, PUC-Rio"
25 #define LUA_AUTHORS	"R. Ierusalimschy, L. H. de Figueiredo, W. Celes"
26 
27 
28 /* mark for precompiled code ('<esc>Lua') */
29 #define LUA_SIGNATURE	"\033Lua"
30 
31 /* option for multiple returns in 'lua_pcall' and 'lua_call' */
32 #define LUA_MULTRET	(-1)
33 
34 
35 /*
36 ** pseudo-indices
37 */
38 #define LUA_REGISTRYINDEX	LUAI_FIRSTPSEUDOIDX
39 #define lua_upvalueindex(i)	(LUA_REGISTRYINDEX - (i))
40 
41 
42 /* thread status */
43 #define LUA_OK		0
44 #define LUA_YIELD	1
45 #define LUA_ERRRUN	2
46 #define LUA_ERRSYNTAX	3
47 #define LUA_ERRMEM	4
48 #define LUA_ERRGCMM	5
49 #define LUA_ERRERR	6
50 
51 
52 typedef struct lua_State lua_State;
53 
54 typedef int (*lua_CFunction) (lua_State *L);
55 
56 
57 /*
58 ** functions that read/write blocks when loading/dumping Lua chunks
59 */
60 typedef const char * (*lua_Reader) (lua_State *L, void *ud, size_t *sz);
61 
62 typedef int (*lua_Writer) (lua_State *L, const void* p, size_t sz, void* ud);
63 
64 
65 /*
66 ** prototype for memory-allocation functions
67 */
68 typedef void * (*lua_Alloc) (void *ud, void *ptr, size_t osize, size_t nsize);
69 
70 
71 /*
72 ** basic types
73 */
74 #define LUA_TNONE		(-1)
75 
76 #define LUA_TNIL		0
77 #define LUA_TBOOLEAN		1
78 #define LUA_TLIGHTUSERDATA	2
79 #define LUA_TNUMBER		3
80 #define LUA_TSTRING		4
81 #define LUA_TTABLE		5
82 #define LUA_TFUNCTION		6
83 #define LUA_TUSERDATA		7
84 #define LUA_TTHREAD		8
85 
86 #define LUA_NUMTAGS		9
87 
88 
89 
90 /* minimum Lua stack available to a C function */
91 #define LUA_MINSTACK	20
92 
93 
94 /* predefined values in the registry */
95 #define LUA_RIDX_MAINTHREAD	1
96 #define LUA_RIDX_GLOBALS	2
97 #define LUA_RIDX_LAST		LUA_RIDX_GLOBALS
98 
99 
100 /* type of numbers in Lua */
101 typedef LUA_NUMBER lua_Number;
102 
103 
104 /* type for integer functions */
105 typedef LUA_INTEGER lua_Integer;
106 
107 /* unsigned integer type */
108 typedef LUA_UNSIGNED lua_Unsigned;
109 
110 
111 
112 
113 /*
114 ** generic extra include file
115 */
116 #if defined(LUA_USER_H)
117 #include LUA_USER_H
118 #endif
119 
120 
121 /*
122 ** RCS ident string
123 */
124 extern const char lua_ident[];
125 
126 
127 /*
128 ** state manipulation
129 */
130 LUA_API lua_State *(lua_newstate) (lua_Alloc f, void *ud);
131 LUA_API void       (lua_close) (lua_State *L);
132 LUA_API lua_State *(lua_newthread) (lua_State *L);
133 
134 LUA_API lua_CFunction (lua_atpanic) (lua_State *L, lua_CFunction panicf);
135 
136 
137 LUA_API const lua_Number *(lua_version) (lua_State *L);
138 
139 
140 /*
141 ** basic stack manipulation
142 */
143 LUA_API int   (lua_absindex) (lua_State *L, int idx);
144 LUA_API int   (lua_gettop) (lua_State *L);
145 LUA_API void  (lua_settop) (lua_State *L, int idx);
146 LUA_API void  (lua_pushvalue) (lua_State *L, int idx);
147 LUA_API void  (lua_remove) (lua_State *L, int idx);
148 LUA_API void  (lua_insert) (lua_State *L, int idx);
149 LUA_API void  (lua_replace) (lua_State *L, int idx);
150 LUA_API void  (lua_copy) (lua_State *L, int fromidx, int toidx);
151 LUA_API int   (lua_checkstack) (lua_State *L, int sz);
152 
153 LUA_API void  (lua_xmove) (lua_State *from, lua_State *to, int n);
154 
155 
156 /*
157 ** access functions (stack -> C)
158 */
159 
160 LUA_API int             (lua_isnumber) (lua_State *L, int idx);
161 LUA_API int             (lua_isstring) (lua_State *L, int idx);
162 LUA_API int             (lua_iscfunction) (lua_State *L, int idx);
163 LUA_API int             (lua_isuserdata) (lua_State *L, int idx);
164 LUA_API int             (lua_type) (lua_State *L, int idx);
165 LUA_API const char     *(lua_typename) (lua_State *L, int tp);
166 
167 LUA_API lua_Number      (lua_tonumberx) (lua_State *L, int idx, int *isnum);
168 LUA_API lua_Integer     (lua_tointegerx) (lua_State *L, int idx, int *isnum);
169 LUA_API lua_Unsigned    (lua_tounsignedx) (lua_State *L, int idx, int *isnum);
170 LUA_API int             (lua_toboolean) (lua_State *L, int idx);
171 LUA_API const char     *(lua_tolstring) (lua_State *L, int idx, size_t *len);
172 LUA_API size_t          (lua_rawlen) (lua_State *L, int idx);
173 LUA_API lua_CFunction   (lua_tocfunction) (lua_State *L, int idx);
174 LUA_API void	       *(lua_touserdata) (lua_State *L, int idx);
175 LUA_API lua_State      *(lua_tothread) (lua_State *L, int idx);
176 LUA_API const void     *(lua_topointer) (lua_State *L, int idx);
177 
178 
179 /*
180 ** Comparison and arithmetic functions
181 */
182 
183 #define LUA_OPADD	0	/* ORDER TM */
184 #define LUA_OPSUB	1
185 #define LUA_OPMUL	2
186 #define LUA_OPDIV	3
187 #define LUA_OPMOD	4
188 #define LUA_OPPOW	5
189 #define LUA_OPUNM	6
190 
191 LUA_API void  (lua_arith) (lua_State *L, int op);
192 
193 #define LUA_OPEQ	0
194 #define LUA_OPLT	1
195 #define LUA_OPLE	2
196 
197 LUA_API int   (lua_rawequal) (lua_State *L, int idx1, int idx2);
198 LUA_API int   (lua_compare) (lua_State *L, int idx1, int idx2, int op);
199 
200 
201 /*
202 ** push functions (C -> stack)
203 */
204 LUA_API void        (lua_pushnil) (lua_State *L);
205 LUA_API void        (lua_pushnumber) (lua_State *L, lua_Number n);
206 LUA_API void        (lua_pushinteger) (lua_State *L, lua_Integer n);
207 LUA_API void        (lua_pushunsigned) (lua_State *L, lua_Unsigned n);
208 LUA_API const char *(lua_pushlstring) (lua_State *L, const char *s, size_t l);
209 LUA_API const char *(lua_pushstring) (lua_State *L, const char *s);
210 LUA_API const char *(lua_pushvfstring) (lua_State *L, const char *fmt,
211                                                       va_list argp);
212 LUA_API const char *(lua_pushfstring) (lua_State *L, const char *fmt, ...);
213 LUA_API void  (lua_pushcclosure) (lua_State *L, lua_CFunction fn, int n);
214 LUA_API void  (lua_pushboolean) (lua_State *L, int b);
215 LUA_API void  (lua_pushlightuserdata) (lua_State *L, void *p);
216 LUA_API int   (lua_pushthread) (lua_State *L);
217 
218 
219 /*
220 ** get functions (Lua -> stack)
221 */
222 LUA_API void  (lua_getglobal) (lua_State *L, const char *var);
223 LUA_API void  (lua_gettable) (lua_State *L, int idx);
224 LUA_API void  (lua_getfield) (lua_State *L, int idx, const char *k);
225 LUA_API void  (lua_rawget) (lua_State *L, int idx);
226 LUA_API void  (lua_rawgeti) (lua_State *L, int idx, int n);
227 LUA_API void  (lua_rawgetp) (lua_State *L, int idx, const void *p);
228 LUA_API void  (lua_createtable) (lua_State *L, int narr, int nrec);
229 LUA_API void *(lua_newuserdata) (lua_State *L, size_t sz);
230 LUA_API int   (lua_getmetatable) (lua_State *L, int objindex);
231 LUA_API void  (lua_getuservalue) (lua_State *L, int idx);
232 
233 
234 /*
235 ** set functions (stack -> Lua)
236 */
237 LUA_API void  (lua_setglobal) (lua_State *L, const char *var);
238 LUA_API void  (lua_settable) (lua_State *L, int idx);
239 LUA_API void  (lua_setfield) (lua_State *L, int idx, const char *k);
240 LUA_API void  (lua_rawset) (lua_State *L, int idx);
241 LUA_API void  (lua_rawseti) (lua_State *L, int idx, int n);
242 LUA_API void  (lua_rawsetp) (lua_State *L, int idx, const void *p);
243 LUA_API int   (lua_setmetatable) (lua_State *L, int objindex);
244 LUA_API void  (lua_setuservalue) (lua_State *L, int idx);
245 
246 
247 /*
248 ** 'load' and 'call' functions (load and run Lua code)
249 */
250 LUA_API void  (lua_callk) (lua_State *L, int nargs, int nresults, int ctx,
251                            lua_CFunction k);
252 #define lua_call(L,n,r)		lua_callk(L, (n), (r), 0, NULL)
253 
254 LUA_API int   (lua_getctx) (lua_State *L, int *ctx);
255 
256 LUA_API int   (lua_pcallk) (lua_State *L, int nargs, int nresults, int errfunc,
257                             int ctx, lua_CFunction k);
258 #define lua_pcall(L,n,r,f)	lua_pcallk(L, (n), (r), (f), 0, NULL)
259 
260 LUA_API int   (lua_load) (lua_State *L, lua_Reader reader, void *dt,
261                                         const char *chunkname,
262                                         const char *mode);
263 
264 LUA_API int (lua_dump) (lua_State *L, lua_Writer writer, void *data);
265 
266 
267 /*
268 ** coroutine functions
269 */
270 LUA_API int  (lua_yieldk) (lua_State *L, int nresults, int ctx,
271                            lua_CFunction k);
272 #define lua_yield(L,n)		lua_yieldk(L, (n), 0, NULL)
273 LUA_API int  (lua_resume) (lua_State *L, lua_State *from, int narg);
274 LUA_API int  (lua_status) (lua_State *L);
275 
276 /*
277 ** garbage-collection function and options
278 */
279 
280 #define LUA_GCSTOP		0
281 #define LUA_GCRESTART		1
282 #define LUA_GCCOLLECT		2
283 #define LUA_GCCOUNT		3
284 #define LUA_GCCOUNTB		4
285 #define LUA_GCSTEP		5
286 #define LUA_GCSETPAUSE		6
287 #define LUA_GCSETSTEPMUL	7
288 #define LUA_GCSETMAJORINC	8
289 #define LUA_GCISRUNNING		9
290 #define LUA_GCGEN		10
291 #define LUA_GCINC		11
292 
293 LUA_API int (lua_gc) (lua_State *L, int what, int data);
294 
295 
296 /*
297 ** miscellaneous functions
298 */
299 
300 LUA_API int   (lua_error) (lua_State *L);
301 
302 LUA_API int   (lua_next) (lua_State *L, int idx);
303 
304 LUA_API void  (lua_concat) (lua_State *L, int n);
305 LUA_API void  (lua_len)    (lua_State *L, int idx);
306 
307 LUA_API lua_Alloc (lua_getallocf) (lua_State *L, void **ud);
308 LUA_API void      (lua_setallocf) (lua_State *L, lua_Alloc f, void *ud);
309 
310 
311 
312 /*
313 ** ===============================================================
314 ** some useful macros
315 ** ===============================================================
316 */
317 
318 #define lua_tonumber(L,i)	lua_tonumberx(L,i,NULL)
319 #define lua_tointeger(L,i)	lua_tointegerx(L,i,NULL)
320 #define lua_tounsigned(L,i)	lua_tounsignedx(L,i,NULL)
321 
322 #define lua_pop(L,n)		lua_settop(L, -(n)-1)
323 
324 #define lua_newtable(L)		lua_createtable(L, 0, 0)
325 
326 #define lua_register(L,n,f) (lua_pushcfunction(L, (f)), lua_setglobal(L, (n)))
327 
328 #define lua_pushcfunction(L,f)	lua_pushcclosure(L, (f), 0)
329 
330 #define lua_isfunction(L,n)	(lua_type(L, (n)) == LUA_TFUNCTION)
331 #define lua_istable(L,n)	(lua_type(L, (n)) == LUA_TTABLE)
332 #define lua_islightuserdata(L,n)	(lua_type(L, (n)) == LUA_TLIGHTUSERDATA)
333 #define lua_isnil(L,n)		(lua_type(L, (n)) == LUA_TNIL)
334 #define lua_isboolean(L,n)	(lua_type(L, (n)) == LUA_TBOOLEAN)
335 #define lua_isthread(L,n)	(lua_type(L, (n)) == LUA_TTHREAD)
336 #define lua_isnone(L,n)		(lua_type(L, (n)) == LUA_TNONE)
337 #define lua_isnoneornil(L, n)	(lua_type(L, (n)) <= 0)
338 
339 #define lua_pushliteral(L, s)	\
340 	lua_pushlstring(L, "" s, (sizeof(s)/sizeof(char))-1)
341 
342 #define lua_pushglobaltable(L)  \
343 	lua_rawgeti(L, LUA_REGISTRYINDEX, LUA_RIDX_GLOBALS)
344 
345 #define lua_tostring(L,i)	lua_tolstring(L, (i), NULL)
346 
347 
348 
349 /*
350 ** {======================================================================
351 ** Debug API
352 ** =======================================================================
353 */
354 
355 
356 /*
357 ** Event codes
358 */
359 #define LUA_HOOKCALL	0
360 #define LUA_HOOKRET	1
361 #define LUA_HOOKLINE	2
362 #define LUA_HOOKCOUNT	3
363 #define LUA_HOOKTAILCALL 4
364 
365 
366 /*
367 ** Event masks
368 */
369 #define LUA_MASKCALL	(1 << LUA_HOOKCALL)
370 #define LUA_MASKRET	(1 << LUA_HOOKRET)
371 #define LUA_MASKLINE	(1 << LUA_HOOKLINE)
372 #define LUA_MASKCOUNT	(1 << LUA_HOOKCOUNT)
373 
374 typedef struct lua_Debug lua_Debug;  /* activation record */
375 
376 
377 /* Functions to be called by the debugger in specific events */
378 typedef void (*lua_Hook) (lua_State *L, lua_Debug *ar);
379 
380 
381 LUA_API int (lua_getstack) (lua_State *L, int level, lua_Debug *ar);
382 LUA_API int (lua_getinfo) (lua_State *L, const char *what, lua_Debug *ar);
383 LUA_API const char *(lua_getlocal) (lua_State *L, const lua_Debug *ar, int n);
384 LUA_API const char *(lua_setlocal) (lua_State *L, const lua_Debug *ar, int n);
385 LUA_API const char *(lua_getupvalue) (lua_State *L, int funcindex, int n);
386 LUA_API const char *(lua_setupvalue) (lua_State *L, int funcindex, int n);
387 
388 LUA_API void *(lua_upvalueid) (lua_State *L, int fidx, int n);
389 LUA_API void  (lua_upvaluejoin) (lua_State *L, int fidx1, int n1,
390                                                int fidx2, int n2);
391 
392 LUA_API int (lua_sethook) (lua_State *L, lua_Hook func, int mask, int count);
393 LUA_API lua_Hook (lua_gethook) (lua_State *L);
394 LUA_API int (lua_gethookmask) (lua_State *L);
395 LUA_API int (lua_gethookcount) (lua_State *L);
396 
397 
398 struct lua_Debug {
399   int event;
400   const char *name;	/* (n) */
401   const char *namewhat;	/* (n) 'global', 'local', 'field', 'method' */
402   const char *what;	/* (S) 'Lua', 'C', 'main', 'tail' */
403   const char *source;	/* (S) */
404   int currentline;	/* (l) */
405   int linedefined;	/* (S) */
406   int lastlinedefined;	/* (S) */
407   unsigned char nups;	/* (u) number of upvalues */
408   unsigned char nparams;/* (u) number of parameters */
409   char isvararg;        /* (u) */
410   char istailcall;	/* (t) */
411   char short_src[LUA_IDSIZE]; /* (S) */
412   /* private part */
413   struct CallInfo *i_ci;  /* active function */
414 };
415 
416 /* }====================================================================== */
417 
418 
419 /******************************************************************************
420 * Copyright (C) 1994-2015 Lua.org, PUC-Rio.
421 *
422 * Permission is hereby granted, free of charge, to any person obtaining
423 * a copy of this software and associated documentation files (the
424 * "Software"), to deal in the Software without restriction, including
425 * without limitation the rights to use, copy, modify, merge, publish,
426 * distribute, sublicense, and/or sell copies of the Software, and to
427 * permit persons to whom the Software is furnished to do so, subject to
428 * the following conditions:
429 *
430 * The above copyright notice and this permission notice shall be
431 * included in all copies or substantial portions of the Software.
432 *
433 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
434 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
435 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
436 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
437 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
438 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
439 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
440 ******************************************************************************/
441 
442 
443 #endif
444