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