Mercurial

comparison third_party/luajit/src/lua.h @ 186:8cf4ec5e2191 hg-web

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fixed merge conflict.
author MrJuneJune <me@mrjunejune.com>
date Fri, 23 Jan 2026 22:38:59 -0800
parents 94705b5986b3
children
comparison
equal deleted inserted replaced
176:fed99fc04e12 186:8cf4ec5e2191
1 /*
2 ** $Id: lua.h,v 1.218.1.5 2008/08/06 13:30:12 roberto Exp $
3 ** Lua - An Extensible Extension Language
4 ** Lua.org, PUC-Rio, Brazil (https://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 "Lua 5.1"
20 #define LUA_RELEASE "Lua 5.1.4"
21 #define LUA_VERSION_NUM 501
22 #define LUA_COPYRIGHT "Copyright (C) 1994-2008 Lua.org, PUC-Rio"
23 #define LUA_AUTHORS "R. Ierusalimschy, L. H. de Figueiredo & W. Celes"
24
25
26 /* mark for precompiled code (`<esc>Lua') */
27 #define LUA_SIGNATURE "\033Lua"
28
29 /* option for multiple returns in `lua_pcall' and `lua_call' */
30 #define LUA_MULTRET (-1)
31
32
33 /*
34 ** pseudo-indices
35 */
36 #define LUA_REGISTRYINDEX (-10000)
37 #define LUA_ENVIRONINDEX (-10001)
38 #define LUA_GLOBALSINDEX (-10002)
39 #define lua_upvalueindex(i) (LUA_GLOBALSINDEX-(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_ERRERR 5
49
50
51 typedef struct lua_State lua_State;
52
53 typedef int (*lua_CFunction) (lua_State *L);
54
55
56 /*
57 ** functions that read/write blocks when loading/dumping Lua chunks
58 */
59 typedef const char * (*lua_Reader) (lua_State *L, void *ud, size_t *sz);
60
61 typedef int (*lua_Writer) (lua_State *L, const void* p, size_t sz, void* ud);
62
63
64 /*
65 ** prototype for memory-allocation functions
66 */
67 typedef void * (*lua_Alloc) (void *ud, void *ptr, size_t osize, size_t nsize);
68
69
70 /*
71 ** basic types
72 */
73 #define LUA_TNONE (-1)
74
75 #define LUA_TNIL 0
76 #define LUA_TBOOLEAN 1
77 #define LUA_TLIGHTUSERDATA 2
78 #define LUA_TNUMBER 3
79 #define LUA_TSTRING 4
80 #define LUA_TTABLE 5
81 #define LUA_TFUNCTION 6
82 #define LUA_TUSERDATA 7
83 #define LUA_TTHREAD 8
84
85
86
87 /* minimum Lua stack available to a C function */
88 #define LUA_MINSTACK 20
89
90
91 /*
92 ** generic extra include file
93 */
94 #if defined(LUA_USER_H)
95 #include LUA_USER_H
96 #endif
97
98
99 /* type of numbers in Lua */
100 typedef LUA_NUMBER lua_Number;
101
102
103 /* type for integer functions */
104 typedef LUA_INTEGER lua_Integer;
105
106
107
108 /*
109 ** state manipulation
110 */
111 LUA_API lua_State *(lua_newstate) (lua_Alloc f, void *ud);
112 LUA_API void (lua_close) (lua_State *L);
113 LUA_API lua_State *(lua_newthread) (lua_State *L);
114
115 LUA_API lua_CFunction (lua_atpanic) (lua_State *L, lua_CFunction panicf);
116
117
118 /*
119 ** basic stack manipulation
120 */
121 LUA_API int (lua_gettop) (lua_State *L);
122 LUA_API void (lua_settop) (lua_State *L, int idx);
123 LUA_API void (lua_pushvalue) (lua_State *L, int idx);
124 LUA_API void (lua_remove) (lua_State *L, int idx);
125 LUA_API void (lua_insert) (lua_State *L, int idx);
126 LUA_API void (lua_replace) (lua_State *L, int idx);
127 LUA_API int (lua_checkstack) (lua_State *L, int sz);
128
129 LUA_API void (lua_xmove) (lua_State *from, lua_State *to, int n);
130
131
132 /*
133 ** access functions (stack -> C)
134 */
135
136 LUA_API int (lua_isnumber) (lua_State *L, int idx);
137 LUA_API int (lua_isstring) (lua_State *L, int idx);
138 LUA_API int (lua_iscfunction) (lua_State *L, int idx);
139 LUA_API int (lua_isuserdata) (lua_State *L, int idx);
140 LUA_API int (lua_type) (lua_State *L, int idx);
141 LUA_API const char *(lua_typename) (lua_State *L, int tp);
142
143 LUA_API int (lua_equal) (lua_State *L, int idx1, int idx2);
144 LUA_API int (lua_rawequal) (lua_State *L, int idx1, int idx2);
145 LUA_API int (lua_lessthan) (lua_State *L, int idx1, int idx2);
146
147 LUA_API lua_Number (lua_tonumber) (lua_State *L, int idx);
148 LUA_API lua_Integer (lua_tointeger) (lua_State *L, int idx);
149 LUA_API int (lua_toboolean) (lua_State *L, int idx);
150 LUA_API const char *(lua_tolstring) (lua_State *L, int idx, size_t *len);
151 LUA_API size_t (lua_objlen) (lua_State *L, int idx);
152 LUA_API lua_CFunction (lua_tocfunction) (lua_State *L, int idx);
153 LUA_API void *(lua_touserdata) (lua_State *L, int idx);
154 LUA_API lua_State *(lua_tothread) (lua_State *L, int idx);
155 LUA_API const void *(lua_topointer) (lua_State *L, int idx);
156
157
158 /*
159 ** push functions (C -> stack)
160 */
161 LUA_API void (lua_pushnil) (lua_State *L);
162 LUA_API void (lua_pushnumber) (lua_State *L, lua_Number n);
163 LUA_API void (lua_pushinteger) (lua_State *L, lua_Integer n);
164 LUA_API void (lua_pushlstring) (lua_State *L, const char *s, size_t l);
165 LUA_API void (lua_pushstring) (lua_State *L, const char *s);
166 LUA_API const char *(lua_pushvfstring) (lua_State *L, const char *fmt,
167 va_list argp);
168 LUA_API const char *(lua_pushfstring) (lua_State *L, const char *fmt, ...);
169 LUA_API void (lua_pushcclosure) (lua_State *L, lua_CFunction fn, int n);
170 LUA_API void (lua_pushboolean) (lua_State *L, int b);
171 LUA_API void (lua_pushlightuserdata) (lua_State *L, void *p);
172 LUA_API int (lua_pushthread) (lua_State *L);
173
174
175 /*
176 ** get functions (Lua -> stack)
177 */
178 LUA_API void (lua_gettable) (lua_State *L, int idx);
179 LUA_API void (lua_getfield) (lua_State *L, int idx, const char *k);
180 LUA_API void (lua_rawget) (lua_State *L, int idx);
181 LUA_API void (lua_rawgeti) (lua_State *L, int idx, int n);
182 LUA_API void (lua_createtable) (lua_State *L, int narr, int nrec);
183 LUA_API void *(lua_newuserdata) (lua_State *L, size_t sz);
184 LUA_API int (lua_getmetatable) (lua_State *L, int objindex);
185 LUA_API void (lua_getfenv) (lua_State *L, int idx);
186
187
188 /*
189 ** set functions (stack -> Lua)
190 */
191 LUA_API void (lua_settable) (lua_State *L, int idx);
192 LUA_API void (lua_setfield) (lua_State *L, int idx, const char *k);
193 LUA_API void (lua_rawset) (lua_State *L, int idx);
194 LUA_API void (lua_rawseti) (lua_State *L, int idx, int n);
195 LUA_API int (lua_setmetatable) (lua_State *L, int objindex);
196 LUA_API int (lua_setfenv) (lua_State *L, int idx);
197
198
199 /*
200 ** `load' and `call' functions (load and run Lua code)
201 */
202 LUA_API void (lua_call) (lua_State *L, int nargs, int nresults);
203 LUA_API int (lua_pcall) (lua_State *L, int nargs, int nresults, int errfunc);
204 LUA_API int (lua_cpcall) (lua_State *L, lua_CFunction func, void *ud);
205 LUA_API int (lua_load) (lua_State *L, lua_Reader reader, void *dt,
206 const char *chunkname);
207
208 LUA_API int (lua_dump) (lua_State *L, lua_Writer writer, void *data);
209
210
211 /*
212 ** coroutine functions
213 */
214 LUA_API int (lua_yield) (lua_State *L, int nresults);
215 LUA_API int (lua_resume) (lua_State *L, int narg);
216 LUA_API int (lua_status) (lua_State *L);
217
218 /*
219 ** garbage-collection function and options
220 */
221
222 #define LUA_GCSTOP 0
223 #define LUA_GCRESTART 1
224 #define LUA_GCCOLLECT 2
225 #define LUA_GCCOUNT 3
226 #define LUA_GCCOUNTB 4
227 #define LUA_GCSTEP 5
228 #define LUA_GCSETPAUSE 6
229 #define LUA_GCSETSTEPMUL 7
230 #define LUA_GCISRUNNING 9
231
232 LUA_API int (lua_gc) (lua_State *L, int what, int data);
233
234
235 /*
236 ** miscellaneous functions
237 */
238
239 LUA_API int (lua_error) (lua_State *L);
240
241 LUA_API int (lua_next) (lua_State *L, int idx);
242
243 LUA_API void (lua_concat) (lua_State *L, int n);
244
245 LUA_API lua_Alloc (lua_getallocf) (lua_State *L, void **ud);
246 LUA_API void lua_setallocf (lua_State *L, lua_Alloc f, void *ud);
247
248
249
250 /*
251 ** ===============================================================
252 ** some useful macros
253 ** ===============================================================
254 */
255
256 #define lua_pop(L,n) lua_settop(L, -(n)-1)
257
258 #define lua_newtable(L) lua_createtable(L, 0, 0)
259
260 #define lua_register(L,n,f) (lua_pushcfunction(L, (f)), lua_setglobal(L, (n)))
261
262 #define lua_pushcfunction(L,f) lua_pushcclosure(L, (f), 0)
263
264 #define lua_strlen(L,i) lua_objlen(L, (i))
265
266 #define lua_isfunction(L,n) (lua_type(L, (n)) == LUA_TFUNCTION)
267 #define lua_istable(L,n) (lua_type(L, (n)) == LUA_TTABLE)
268 #define lua_islightuserdata(L,n) (lua_type(L, (n)) == LUA_TLIGHTUSERDATA)
269 #define lua_isnil(L,n) (lua_type(L, (n)) == LUA_TNIL)
270 #define lua_isboolean(L,n) (lua_type(L, (n)) == LUA_TBOOLEAN)
271 #define lua_isthread(L,n) (lua_type(L, (n)) == LUA_TTHREAD)
272 #define lua_isnone(L,n) (lua_type(L, (n)) == LUA_TNONE)
273 #define lua_isnoneornil(L, n) (lua_type(L, (n)) <= 0)
274
275 #define lua_pushliteral(L, s) \
276 lua_pushlstring(L, "" s, (sizeof(s)/sizeof(char))-1)
277
278 #define lua_setglobal(L,s) lua_setfield(L, LUA_GLOBALSINDEX, (s))
279 #define lua_getglobal(L,s) lua_getfield(L, LUA_GLOBALSINDEX, (s))
280
281 #define lua_tostring(L,i) lua_tolstring(L, (i), NULL)
282
283
284
285 /*
286 ** compatibility macros and functions
287 */
288
289 #define lua_open() luaL_newstate()
290
291 #define lua_getregistry(L) lua_pushvalue(L, LUA_REGISTRYINDEX)
292
293 #define lua_getgccount(L) lua_gc(L, LUA_GCCOUNT, 0)
294
295 #define lua_Chunkreader lua_Reader
296 #define lua_Chunkwriter lua_Writer
297
298
299 /* hack */
300 LUA_API void lua_setlevel (lua_State *from, lua_State *to);
301
302
303 /*
304 ** {======================================================================
305 ** Debug API
306 ** =======================================================================
307 */
308
309
310 /*
311 ** Event codes
312 */
313 #define LUA_HOOKCALL 0
314 #define LUA_HOOKRET 1
315 #define LUA_HOOKLINE 2
316 #define LUA_HOOKCOUNT 3
317 #define LUA_HOOKTAILRET 4
318
319
320 /*
321 ** Event masks
322 */
323 #define LUA_MASKCALL (1 << LUA_HOOKCALL)
324 #define LUA_MASKRET (1 << LUA_HOOKRET)
325 #define LUA_MASKLINE (1 << LUA_HOOKLINE)
326 #define LUA_MASKCOUNT (1 << LUA_HOOKCOUNT)
327
328 typedef struct lua_Debug lua_Debug; /* activation record */
329
330
331 /* Functions to be called by the debuger in specific events */
332 typedef void (*lua_Hook) (lua_State *L, lua_Debug *ar);
333
334
335 LUA_API int lua_getstack (lua_State *L, int level, lua_Debug *ar);
336 LUA_API int lua_getinfo (lua_State *L, const char *what, lua_Debug *ar);
337 LUA_API const char *lua_getlocal (lua_State *L, const lua_Debug *ar, int n);
338 LUA_API const char *lua_setlocal (lua_State *L, const lua_Debug *ar, int n);
339 LUA_API const char *lua_getupvalue (lua_State *L, int funcindex, int n);
340 LUA_API const char *lua_setupvalue (lua_State *L, int funcindex, int n);
341 LUA_API int lua_sethook (lua_State *L, lua_Hook func, int mask, int count);
342 LUA_API lua_Hook lua_gethook (lua_State *L);
343 LUA_API int lua_gethookmask (lua_State *L);
344 LUA_API int lua_gethookcount (lua_State *L);
345
346 /* From Lua 5.2. */
347 LUA_API void *lua_upvalueid (lua_State *L, int idx, int n);
348 LUA_API void lua_upvaluejoin (lua_State *L, int idx1, int n1, int idx2, int n2);
349 LUA_API int lua_loadx (lua_State *L, lua_Reader reader, void *dt,
350 const char *chunkname, const char *mode);
351 LUA_API const lua_Number *lua_version (lua_State *L);
352 LUA_API void lua_copy (lua_State *L, int fromidx, int toidx);
353 LUA_API lua_Number lua_tonumberx (lua_State *L, int idx, int *isnum);
354 LUA_API lua_Integer lua_tointegerx (lua_State *L, int idx, int *isnum);
355
356 /* From Lua 5.3. */
357 LUA_API int lua_isyieldable (lua_State *L);
358
359
360 struct lua_Debug {
361 int event;
362 const char *name; /* (n) */
363 const char *namewhat; /* (n) `global', `local', `field', `method' */
364 const char *what; /* (S) `Lua', `C', `main', `tail' */
365 const char *source; /* (S) */
366 int currentline; /* (l) */
367 int nups; /* (u) number of upvalues */
368 int linedefined; /* (S) */
369 int lastlinedefined; /* (S) */
370 char short_src[LUA_IDSIZE]; /* (S) */
371 /* private part */
372 int i_ci; /* active function */
373 };
374
375 /* }====================================================================== */
376
377
378 /******************************************************************************
379 * Copyright (C) 1994-2008 Lua.org, PUC-Rio. All rights reserved.
380 *
381 * Permission is hereby granted, free of charge, to any person obtaining
382 * a copy of this software and associated documentation files (the
383 * "Software"), to deal in the Software without restriction, including
384 * without limitation the rights to use, copy, modify, merge, publish,
385 * distribute, sublicense, and/or sell copies of the Software, and to
386 * permit persons to whom the Software is furnished to do so, subject to
387 * the following conditions:
388 *
389 * The above copyright notice and this permission notice shall be
390 * included in all copies or substantial portions of the Software.
391 *
392 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
393 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
394 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
395 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
396 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
397 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
398 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
399 ******************************************************************************/
400
401
402 #endif