ScummVM API documentation
lua.h
1 /*
2 ** $Id$
3 ** Lua - An Extensible Extension 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 "common/scummsys.h"
13 
14 #include <stdarg.h>
15 #include <stddef.h>
16 
17 
18 #include "common/lua/luaconf.h"
19 
20 
21 #define LUA_VERSION "Lua 5.1"
22 #define LUA_RELEASE "Lua 5.1.3"
23 #define LUA_VERSION_NUM 501
24 #define LUA_COPYRIGHT "Copyright (C) 1994-2008 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 (-10000)
39 #define LUA_ENVIRONINDEX (-10001)
40 #define LUA_GLOBALSINDEX (-10002)
41 #define lua_upvalueindex(i) (LUA_GLOBALSINDEX-(i))
42 
43 
44 /* thread status; 0 is OK */
45 #define LUA_YIELD 1
46 #define LUA_ERRRUN 2
47 #define LUA_ERRSYNTAX 3
48 #define LUA_ERRMEM 4
49 #define LUA_ERRERR 5
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 
231 LUA_API int (lua_gc) (lua_State *L, int what, int data);
232 
233 
234 /*
235 ** miscellaneous functions
236 */
237 
238 LUA_API int (lua_error) (lua_State *L);
239 
240 LUA_API int (lua_next) (lua_State *L, int idx);
241 
242 LUA_API void (lua_concat) (lua_State *L, int n);
243 
244 LUA_API lua_Alloc (lua_getallocf) (lua_State *L, void **ud);
245 LUA_API void lua_setallocf (lua_State *L, lua_Alloc f, void *ud);
246 
247 
248 
249 /*
250 ** ===============================================================
251 ** some useful macros
252 ** ===============================================================
253 */
254 
255 #define lua_pop(L,n) lua_settop(L, -(n)-1)
256 
257 #define lua_newtable(L) lua_createtable(L, 0, 0)
258 
259 #define lua_register(L,n,f) (lua_pushcfunction(L, (f)), lua_setglobal(L, (n)))
260 
261 #define lua_pushcfunction(L,f) lua_pushcclosure(L, (f), 0)
262 
263 #define lua_strlen(L,i) lua_objlen(L, (i))
264 
265 #define lua_isfunction(L,n) (lua_type(L, (n)) == LUA_TFUNCTION)
266 #define lua_istable(L,n) (lua_type(L, (n)) == LUA_TTABLE)
267 #define lua_islightuserdata(L,n) (lua_type(L, (n)) == LUA_TLIGHTUSERDATA)
268 #define lua_isnil(L,n) (lua_type(L, (n)) == LUA_TNIL)
269 #define lua_isboolean(L,n) (lua_type(L, (n)) == LUA_TBOOLEAN)
270 #define lua_isthread(L,n) (lua_type(L, (n)) == LUA_TTHREAD)
271 #define lua_isnone(L,n) (lua_type(L, (n)) == LUA_TNONE)
272 #define lua_isnoneornil(L, n) (lua_type(L, (n)) <= 0)
273 
274 #define lua_pushliteral(L, s) \
275  lua_pushlstring(L, "" s, (sizeof(s)/sizeof(char))-1)
276 
277 #define lua_setglobal(L,s) lua_setfield(L, LUA_GLOBALSINDEX, (s))
278 #define lua_getglobal(L,s) lua_getfield(L, LUA_GLOBALSINDEX, (s))
279 
280 #define lua_tostring(L,i) lua_tolstring(L, (i), NULL)
281 
282 
283 
284 /*
285 ** compatibility macros and functions
286 */
287 
288 #define lua_open() luaL_newstate()
289 
290 #define lua_getregistry(L) lua_pushvalue(L, LUA_REGISTRYINDEX)
291 
292 #define lua_getgccount(L) lua_gc(L, LUA_GCCOUNT, 0)
293 
294 #define lua_Chunkreader lua_Reader
295 #define lua_Chunkwriter lua_Writer
296 
297 
298 /* hack */
299 LUA_API void lua_setlevel (lua_State *from, lua_State *to);
300 
301 
302 /*
303 ** {======================================================================
304 ** Debug API
305 ** =======================================================================
306 */
307 
308 
309 /*
310 ** Event codes
311 */
312 #define LUA_HOOKCALL 0
313 #define LUA_HOOKRET 1
314 #define LUA_HOOKLINE 2
315 #define LUA_HOOKCOUNT 3
316 #define LUA_HOOKTAILRET 4
317 
318 
319 /*
320 ** Event masks
321 */
322 #define LUA_MASKCALL (1 << LUA_HOOKCALL)
323 #define LUA_MASKRET (1 << LUA_HOOKRET)
324 #define LUA_MASKLINE (1 << LUA_HOOKLINE)
325 #define LUA_MASKCOUNT (1 << LUA_HOOKCOUNT)
326 
327 typedef struct lua_Debug lua_Debug; /* activation record */
328 
329 
330 /* Functions to be called by the debuger in specific events */
331 typedef void (*lua_Hook) (lua_State *L, lua_Debug *ar);
332 
333 
334 LUA_API int lua_getstack (lua_State *L, int level, lua_Debug *ar);
335 LUA_API int lua_getinfo (lua_State *L, const char *what, lua_Debug *ar);
336 LUA_API const char *lua_getlocal (lua_State *L, const lua_Debug *ar, int n);
337 LUA_API const char *lua_setlocal (lua_State *L, const lua_Debug *ar, int n);
338 LUA_API const char *lua_getupvalue (lua_State *L, int funcindex, int n);
339 LUA_API const char *lua_setupvalue (lua_State *L, int funcindex, int n);
340 
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 
347 struct lua_Debug {
348  int event;
349  const char *name; /* (n) */
350  const char *namewhat; /* (n) `global', `local', `field', `method' */
351  const char *what; /* (S) `Lua', `C', `main', `tail' */
352  const char *source; /* (S) */
353  int currentline; /* (l) */
354  int nups; /* (u) number of upvalues */
355  int linedefined; /* (S) */
356  int lastlinedefined; /* (S) */
357  char short_src[LUA_IDSIZE]; /* (S) */
358  /* private part */
359  int i_ci; /* active function */
360 };
361 
362 /* }====================================================================== */
363 
364 
365 /******************************************************************************
366 * Copyright (C) 1994-2008 Lua.org, PUC-Rio. All rights reserved.
367 *
368 * Permission is hereby granted, free of charge, to any person obtaining
369 * a copy of this software and associated documentation files (the
370 * "Software"), to deal in the Software without restriction, including
371 * without limitation the rights to use, copy, modify, merge, publish,
372 * distribute, sublicense, and/or sell copies of the Software, and to
373 * permit persons to whom the Software is furnished to do so, subject to
374 * the following conditions:
375 *
376 * The above copyright notice and this permission notice shall be
377 * included in all copies or substantial portions of the Software.
378 *
379 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
380 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
381 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
382 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
383 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
384 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
385 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
386 ******************************************************************************/
387 
388 
389 #endif
Definition: lstate.h:100
Definition: lua.h:347