lua-repl.h
Go to the documentation of this file.
1 /*
2  * Copied from the Lua sources.
3  */
4 
5 /*
6 ** $Id: lua.h,v 1.218.1.5 2008/08/06 13:30:12 roberto Exp $
7 ** Lua - An Extensible Extension Language
8 ** Lua.org, PUC-Rio, Brazil (http://www.lua.org)
9 ** See Copyright Notice at the end of this file
10 */
11 
12 
13 #ifndef lua_h
14 #define lua_h
15 
16 #include <stdarg.h>
17 #include <stddef.h>
18 
19 
20 #include "luaconf.h"
21 
22 
23 #define LUA_VERSION "Lua 5.1"
24 #define LUA_RELEASE "Lua 5.1.4"
25 #define LUA_VERSION_NUM 501
26 #define LUA_COPYRIGHT "Copyright (C) 1994-2008 Lua.org, PUC-Rio"
27 #define LUA_AUTHORS "R. Ierusalimschy, L. H. de Figueiredo & W. Celes"
28 
29 
30 /* mark for precompiled code (`<esc>Lua') */
31 #define LUA_SIGNATURE "\033Lua"
32 
33 /* option for multiple returns in `lua_pcall' and `lua_call' */
34 #define LUA_MULTRET (-1)
35 
36 
37 /*
38 ** pseudo-indices
39 */
40 #define LUA_REGISTRYINDEX (-10000)
41 #define LUA_ENVIRONINDEX (-10001)
42 #define LUA_GLOBALSINDEX (-10002)
43 #define lua_upvalueindex(i) (LUA_GLOBALSINDEX-(i))
44 
45 
46 /* thread status; 0 is OK */
47 #define LUA_YIELD 1
48 #define LUA_ERRRUN 2
49 #define LUA_ERRSYNTAX 3
50 #define LUA_ERRMEM 4
51 #define LUA_ERRERR 5
52 
53 
54 typedef struct lua_State lua_State;
55 
56 typedef int (*lua_CFunction) (lua_State *L);
57 
58 
59 /*
60 ** functions that read/write blocks when loading/dumping Lua chunks
61 */
62 typedef const char * (*lua_Reader) (lua_State *L, void *ud, size_t *sz);
63 
64 typedef int (*lua_Writer) (lua_State *L, const void* p, size_t sz, void* ud);
65 
66 
67 /*
68 ** prototype for memory-allocation functions
69 */
70 typedef void * (*lua_Alloc) (void *ud, void *ptr, size_t osize, size_t nsize);
71 
72 
73 /*
74 ** basic types
75 */
76 #define LUA_TNONE (-1)
77 
78 #define LUA_TNIL 0
79 #define LUA_TBOOLEAN 1
80 #define LUA_TLIGHTUSERDATA 2
81 #define LUA_TNUMBER 3
82 #define LUA_TSTRING 4
83 #define LUA_TTABLE 5
84 #define LUA_TFUNCTION 6
85 #define LUA_TUSERDATA 7
86 #define LUA_TTHREAD 8
87 
88 /* minimum Lua stack available to a C function */
89 #define LUA_MINSTACK 20
90 
91 
92 /*
93 ** generic extra include file
94 */
95 #if defined(LUA_USER_H)
96 #include LUA_USER_H
97 #endif
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 
108 
109 /*
110 ** state manipulation
111 */
112 LUA_API lua_State *(lua_newstate) (lua_Alloc f, void *ud);
113 LUA_API void (lua_close) (lua_State *L);
114 LUA_API lua_State *(lua_newthread) (lua_State *L);
115 
116 LUA_API lua_CFunction (lua_atpanic) (lua_State *L, lua_CFunction panicf);
117 
118 
119 /*
120 ** basic stack manipulation
121 */
122 LUA_API int (lua_gettop) (lua_State *L);
123 LUA_API void (lua_settop) (lua_State *L, int idx);
124 LUA_API void (lua_pushvalue) (lua_State *L, int idx);
125 LUA_API void (lua_remove) (lua_State *L, int idx);
126 LUA_API void (lua_insert) (lua_State *L, int idx);
127 LUA_API void (lua_replace) (lua_State *L, int idx);
128 LUA_API int (lua_checkstack) (lua_State *L, int sz);
129 
130 LUA_API void (lua_xmove) (lua_State *from, lua_State *to, int n);
131 
132 
133 /*
134 ** access functions (stack -> C)
135 */
136 
137 LUA_API int (lua_isnumber) (lua_State *L, int idx);
138 LUA_API int (lua_isstring) (lua_State *L, int idx);
139 LUA_API int (lua_iscfunction) (lua_State *L, int idx);
140 LUA_API int (lua_isuserdata) (lua_State *L, int idx);
141 LUA_API int (lua_type) (lua_State *L, int idx);
142 LUA_API const char *(lua_typename) (lua_State *L, int tp);
143 
144 LUA_API int (lua_equal) (lua_State *L, int idx1, int idx2);
145 LUA_API int (lua_rawequal) (lua_State *L, int idx1, int idx2);
146 LUA_API int (lua_lessthan) (lua_State *L, int idx1, int idx2);
147 
148 LUA_API lua_Number (lua_tonumber) (lua_State *L, int idx);
149 LUA_API lua_Integer (lua_tointeger) (lua_State *L, int idx);
150 LUA_API int (lua_toboolean) (lua_State *L, int idx);
151 LUA_API const char *(lua_tolstring) (lua_State *L, int idx, size_t *len);
152 LUA_API size_t (lua_objlen) (lua_State *L, int idx);
153 LUA_API lua_CFunction (lua_tocfunction) (lua_State *L, int idx);
154 LUA_API void *(lua_touserdata) (lua_State *L, int idx);
155 LUA_API lua_State *(lua_tothread) (lua_State *L, int idx);
156 LUA_API const void *(lua_topointer) (lua_State *L, int idx);
157 
158 
159 /*
160 ** push functions (C -> stack)
161 */
162 LUA_API void (lua_pushnil) (lua_State *L);
163 LUA_API void (lua_pushnumber) (lua_State *L, lua_Number n);
164 LUA_API void (lua_pushinteger) (lua_State *L, lua_Integer n);
165 LUA_API void (lua_pushlstring) (lua_State *L, const char *s, size_t l);
166 LUA_API void (lua_pushstring) (lua_State *L, const char *s);
167 LUA_API const char *(lua_pushvfstring) (lua_State *L, const char *fmt,
168  va_list argp);
169 LUA_API const char *(lua_pushfstring) (lua_State *L, const char *fmt, ...);
170 LUA_API void (lua_pushcclosure) (lua_State *L, lua_CFunction fn, int n);
171 LUA_API void (lua_pushboolean) (lua_State *L, int b);
172 LUA_API void (lua_pushlightuserdata) (lua_State *L, void *p);
173 LUA_API int (lua_pushthread) (lua_State *L);
174 
175 
176 /*
177 ** get functions (Lua -> stack)
178 */
179 LUA_API void (lua_gettable) (lua_State *L, int idx);
180 LUA_API void (lua_getfield) (lua_State *L, int idx, const char *k);
181 LUA_API void (lua_rawget) (lua_State *L, int idx);
182 LUA_API void (lua_rawgeti) (lua_State *L, int idx, int n);
183 LUA_API void (lua_createtable) (lua_State *L, int narr, int nrec);
184 LUA_API void *(lua_newuserdata) (lua_State *L, size_t sz);
185 LUA_API int (lua_getmetatable) (lua_State *L, int objindex);
186 LUA_API void (lua_getfenv) (lua_State *L, int idx);
187 
188 
189 /*
190 ** set functions (stack -> Lua)
191 */
192 LUA_API void (lua_settable) (lua_State *L, int idx);
193 LUA_API void (lua_setfield) (lua_State *L, int idx, const char *k);
194 LUA_API void (lua_rawset) (lua_State *L, int idx);
195 LUA_API void (lua_rawseti) (lua_State *L, int idx, int n);
196 LUA_API int (lua_setmetatable) (lua_State *L, int objindex);
197 LUA_API int (lua_setfenv) (lua_State *L, int idx);
198 
199 
200 /*
201 ** `load' and `call' functions (load and run Lua code)
202 */
203 LUA_API void (lua_call) (lua_State *L, int nargs, int nresults);
204 LUA_API int (lua_pcall) (lua_State *L, int nargs, int nresults, int errfunc);
205 LUA_API int (lua_cpcall) (lua_State *L, lua_CFunction func, void *ud);
206 LUA_API int (lua_load) (lua_State *L, lua_Reader reader, void *dt,
207  const char *chunkname);
208 
209 LUA_API int (lua_dump) (lua_State *L, lua_Writer writer, void *data);
210 
211 
212 /*
213 ** coroutine functions
214 */
215 LUA_API int (lua_yield) (lua_State *L, int nresults);
216 LUA_API int (lua_resume) (lua_State *L, int narg);
217 LUA_API int (lua_status) (lua_State *L);
218 
219 /*
220 ** garbage-collection function and options
221 */
222 
223 #define LUA_GCSTOP 0
224 #define LUA_GCRESTART 1
225 #define LUA_GCCOLLECT 2
226 #define LUA_GCCOUNT 3
227 #define LUA_GCCOUNTB 4
228 #define LUA_GCSTEP 5
229 #define LUA_GCSETPAUSE 6
230 #define LUA_GCSETSTEPMUL 7
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 
342 LUA_API int lua_sethook (lua_State *L, lua_Hook func, int mask, int count);
343 LUA_API lua_Hook lua_gethook (lua_State *L);
344 LUA_API int lua_gethookmask (lua_State *L);
345 LUA_API int lua_gethookcount (lua_State *L);
346 
347 
348 struct lua_Debug {
349  int event;
350  const char *name; /* (n) */
351  const char *namewhat; /* (n) `global', `local', `field', `method' */
352  const char *what; /* (S) `Lua', `C', `main', `tail' */
353  const char *source; /* (S) */
354  int currentline; /* (l) */
355  int nups; /* (u) number of upvalues */
356  int linedefined; /* (S) */
357  int lastlinedefined; /* (S) */
358  char short_src[LUA_IDSIZE]; /* (S) */
359  /* private part */
360  int i_ci; /* active function */
361 };
362 
363 /* }====================================================================== */
364 
365 
366 /******************************************************************************
367 * Copyright (C) 1994-2008 Lua.org, PUC-Rio. All rights reserved.
368 *
369 * Permission is hereby granted, free of charge, to any person obtaining
370 * a copy of this software and associated documentation files (the
371 * "Software"), to deal in the Software without restriction, including
372 * without limitation the rights to use, copy, modify, merge, publish,
373 * distribute, sublicense, and/or sell copies of the Software, and to
374 * permit persons to whom the Software is furnished to do so, subject to
375 * the following conditions:
376 *
377 * The above copyright notice and this permission notice shall be
378 * included in all copies or substantial portions of the Software.
379 *
380 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
381 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
382 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
383 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
384 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
385 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
386 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
387 ******************************************************************************/
388 
389 
390 #endif
const char * what
Definition: lua-repl.h:352
LUA_API int() lua_resume(lua_State *L, int narg)
LUA_API int() lua_error(lua_State *L)
LUA_API int() lua_pcall(lua_State *L, int nargs, int nresults, int errfunc)
LUA_API int() lua_getmetatable(lua_State *L, int objindex)
LUA_API void() lua_replace(lua_State *L, int idx)
LUA_API const char *() lua_typename(lua_State *L, int tp)
LUA_API void() lua_setfield(lua_State *L, int idx, const char *k)
LUA_API lua_Alloc() lua_getallocf(lua_State *L, void **ud)
LUA_API void() lua_pushstring(lua_State *L, const char *s)
LUA_API int lua_gethookcount(lua_State *L)
LUA_API const char * lua_setlocal(lua_State *L, const lua_Debug *ar, int n)
LUA_API void() lua_gettable(lua_State *L, int idx)
LUA_API void() lua_pushcclosure(lua_State *L, lua_CFunction fn, int n)
LUA_API void() lua_pushinteger(lua_State *L, lua_Integer n)
LUA_API void() lua_pushvalue(lua_State *L, int idx)
LUA_API void *() lua_newuserdata(lua_State *L, size_t sz)
LUA_API int() lua_equal(lua_State *L, int idx1, int idx2)
const char * name
Definition: lua-repl.h:350
int(* lua_CFunction)(lua_State *L)
Definition: lua-repl.h:56
LUA_API void() lua_pushlightuserdata(lua_State *L, void *p)
LUA_API int() lua_pushthread(lua_State *L)
const char * source
Definition: lua-repl.h:353
LUA_API void() lua_insert(lua_State *L, int idx)
LUA_API lua_Integer() lua_tointeger(lua_State *L, int idx)
int event
Definition: lua-repl.h:349
LUA_API void lua_setlevel(lua_State *from, lua_State *to)
LUA_API int() lua_type(lua_State *L, int idx)
char short_src[LUA_IDSIZE]
Definition: lua-repl.h:358
LUA_API int() lua_setfenv(lua_State *L, int idx)
int nups
Definition: lua-repl.h:355
const char * namewhat
Definition: lua-repl.h:351
LUA_API int() lua_isnumber(lua_State *L, int idx)
LUA_API const char *() lua_pushvfstring(lua_State *L, const char *fmt, va_list argp)
LUA_API void() lua_xmove(lua_State *from, lua_State *to, int n)
LUA_API int() lua_rawequal(lua_State *L, int idx1, int idx2)
LUA_NUMBER lua_Number
Definition: lua-repl.h:101
LUA_API int() lua_toboolean(lua_State *L, int idx)
LUA_API lua_State *() lua_tothread(lua_State *L, int idx)
LUA_API lua_CFunction() lua_tocfunction(lua_State *L, int idx)
const char *(* lua_Reader)(lua_State *L, void *ud, size_t *sz)
Definition: lua-repl.h:62
int lastlinedefined
Definition: lua-repl.h:357
LUA_API void() lua_concat(lua_State *L, int n)
LUA_API const char * lua_getlocal(lua_State *L, const lua_Debug *ar, int n)
LUA_API void() lua_rawset(lua_State *L, int idx)
LUA_API lua_State *() lua_newstate(lua_Alloc f, void *ud)
LUA_API void() lua_rawget(lua_State *L, int idx)
LUA_API lua_Hook lua_gethook(lua_State *L)
LUA_API int lua_getstack(lua_State *L, int level, lua_Debug *ar)
LUA_API int() lua_yield(lua_State *L, int nresults)
LUA_API int() lua_load(lua_State *L, lua_Reader reader, void *dt, const char *chunkname)
LUA_API int() lua_dump(lua_State *L, lua_Writer writer, void *data)
LUA_API lua_CFunction() lua_atpanic(lua_State *L, lua_CFunction panicf)
LUA_API void() lua_pushnumber(lua_State *L, lua_Number n)
LUA_API void() lua_rawgeti(lua_State *L, int idx, int n)
LUA_API int() lua_setmetatable(lua_State *L, int objindex)
LUA_API lua_State *() lua_newthread(lua_State *L)
LUA_API int() lua_isuserdata(lua_State *L, int idx)
LUA_API void() lua_createtable(lua_State *L, int narr, int nrec)
LUA_API int() lua_cpcall(lua_State *L, lua_CFunction func, void *ud)
struct lua_State lua_State
Definition: lua-repl.h:54
LUA_API void() lua_pushboolean(lua_State *L, int b)
LUA_API int lua_gethookmask(lua_State *L)
LUA_API int() lua_isstring(lua_State *L, int idx)
LUA_API int() lua_gc(lua_State *L, int what, int data)
LUA_API int() lua_iscfunction(lua_State *L, int idx)
LUA_API void() lua_close(lua_State *L)
LUA_API size_t() lua_objlen(lua_State *L, int idx)
LUA_API void() lua_rawseti(lua_State *L, int idx, int n)
LUA_API void() lua_getfield(lua_State *L, int idx, const char *k)
int i_ci
Definition: lua-repl.h:360
LUA_API void() lua_remove(lua_State *L, int idx)
LUA_API int lua_getinfo(lua_State *L, const char *what, lua_Debug *ar)
LUA_API int() lua_gettop(lua_State *L)
void(* lua_Hook)(lua_State *L, lua_Debug *ar)
Definition: lua-repl.h:332
LUA_API int() lua_next(lua_State *L, int idx)
LUA_API void() lua_call(lua_State *L, int nargs, int nresults)
LUA_API void *() lua_touserdata(lua_State *L, int idx)
LUA_API void() lua_pushnil(lua_State *L)
LUA_API const char * lua_setupvalue(lua_State *L, int funcindex, int n)
LUA_API void() lua_pushlstring(lua_State *L, const char *s, size_t l)
LUA_API void() lua_settable(lua_State *L, int idx)
LUA_API const char *() lua_tolstring(lua_State *L, int idx, size_t *len)
void *(* lua_Alloc)(void *ud, void *ptr, size_t osize, size_t nsize)
Definition: lua-repl.h:70
LUA_API const char * lua_getupvalue(lua_State *L, int funcindex, int n)
LUA_API void() lua_getfenv(lua_State *L, int idx)
int currentline
Definition: lua-repl.h:354
LUA_API int() lua_lessthan(lua_State *L, int idx1, int idx2)
LUA_API const char *() lua_pushfstring(lua_State *L, const char *fmt,...)
LUA_API void() lua_settop(lua_State *L, int idx)
LUA_API lua_Number() lua_tonumber(lua_State *L, int idx)
LUA_API int() lua_status(lua_State *L)
LUA_INTEGER lua_Integer
Definition: lua-repl.h:105
LUA_API void lua_setallocf(lua_State *L, lua_Alloc f, void *ud)
LUA_API int lua_sethook(lua_State *L, lua_Hook func, int mask, int count)
int(* lua_Writer)(lua_State *L, const void *p, size_t sz, void *ud)
Definition: lua-repl.h:64
int linedefined
Definition: lua-repl.h:356
LUA_API const void *() lua_topointer(lua_State *L, int idx)
LUA_API int() lua_checkstack(lua_State *L, int sz)


ocl
Author(s): OCL Development Team
autogenerated on Mon Mar 23 2020 04:47:19