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 (http://www.lua.org)
5 ** See Copyright Notice at the end of this file
6 */
7 
8 // Modified by Aster Jian for Urho3D
9 
10 #ifndef lua_h
11 #define lua_h
12 
13 #include <stdarg.h>
14 #include <stddef.h>
15 
16 
17 #include "luaconf.h"
18 
19 
20 #define LUA_VERSION	"Lua 5.1"
21 #define LUA_RELEASE	"Lua 5.1.4"
22 #define LUA_VERSION_NUM	501
23 #define LUA_COPYRIGHT	"Copyright (C) 1994-2008 Lua.org, PUC-Rio"
24 #define LUA_AUTHORS	"R. Ierusalimschy, L. H. de Figueiredo & W. Celes"
25 
26 
27 /* mark for precompiled code (`<esc>Lua') */
28 #define	LUA_SIGNATURE	"\033Lua"
29 
30 /* option for multiple returns in `lua_pcall' and `lua_call' */
31 #define LUA_MULTRET	(-1)
32 
33 
34 /*
35 ** pseudo-indices
36 */
37 #define LUA_REGISTRYINDEX	(-10000)
38 #define LUA_ENVIRONINDEX	(-10001)
39 #define LUA_GLOBALSINDEX	(-10002)
40 #define lua_upvalueindex(i)	(LUA_GLOBALSINDEX-(i))
41 
42 
43 /* thread status; 0 is OK */
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 // Urho3D
115 LUA_API lua_State *(lua_getmainthread) (lua_State *L);
116 
117 LUA_API lua_CFunction (lua_atpanic) (lua_State *L, lua_CFunction panicf);
118 
119 
120 /*
121 ** basic stack manipulation
122 */
123 LUA_API int   (lua_gettop) (lua_State *L);
124 LUA_API void  (lua_settop) (lua_State *L, int idx);
125 LUA_API void  (lua_pushvalue) (lua_State *L, int idx);
126 LUA_API void  (lua_remove) (lua_State *L, int idx);
127 LUA_API void  (lua_insert) (lua_State *L, int idx);
128 LUA_API void  (lua_replace) (lua_State *L, int idx);
129 LUA_API int   (lua_checkstack) (lua_State *L, int sz);
130 
131 LUA_API void  (lua_xmove) (lua_State *from, lua_State *to, int n);
132 
133 
134 /*
135 ** access functions (stack -> C)
136 */
137 
138 LUA_API int             (lua_isnumber) (lua_State *L, int idx);
139 LUA_API int             (lua_isstring) (lua_State *L, int idx);
140 LUA_API int             (lua_iscfunction) (lua_State *L, int idx);
141 LUA_API int             (lua_isuserdata) (lua_State *L, int idx);
142 LUA_API int             (lua_type) (lua_State *L, int idx);
143 LUA_API const char     *(lua_typename) (lua_State *L, int tp);
144 
145 LUA_API int            (lua_equal) (lua_State *L, int idx1, int idx2);
146 LUA_API int            (lua_rawequal) (lua_State *L, int idx1, int idx2);
147 LUA_API int            (lua_lessthan) (lua_State *L, int idx1, int idx2);
148 
149 LUA_API lua_Number      (lua_tonumber) (lua_State *L, int idx);
150 LUA_API lua_Integer     (lua_tointeger) (lua_State *L, int idx);
151 LUA_API int             (lua_toboolean) (lua_State *L, int idx);
152 LUA_API const char     *(lua_tolstring) (lua_State *L, int idx, size_t *len);
153 LUA_API size_t          (lua_objlen) (lua_State *L, int idx);
154 LUA_API lua_CFunction   (lua_tocfunction) (lua_State *L, int idx);
155 LUA_API void	       *(lua_touserdata) (lua_State *L, int idx);
156 LUA_API lua_State      *(lua_tothread) (lua_State *L, int idx);
157 LUA_API const void     *(lua_topointer) (lua_State *L, int idx);
158 
159 
160 /*
161 ** push functions (C -> stack)
162 */
163 LUA_API void  (lua_pushnil) (lua_State *L);
164 LUA_API void  (lua_pushnumber) (lua_State *L, lua_Number n);
165 LUA_API void  (lua_pushinteger) (lua_State *L, lua_Integer n);
166 LUA_API void  (lua_pushlstring) (lua_State *L, const char *s, size_t l);
167 LUA_API void  (lua_pushstring) (lua_State *L, const char *s);
168 LUA_API const char *(lua_pushvfstring) (lua_State *L, const char *fmt,
169                                                       va_list argp);
170 LUA_API const char *(lua_pushfstring) (lua_State *L, const char *fmt, ...);
171 LUA_API void  (lua_pushcclosure) (lua_State *L, lua_CFunction fn, int n);
172 LUA_API void  (lua_pushboolean) (lua_State *L, int b);
173 LUA_API void  (lua_pushlightuserdata) (lua_State *L, void *p);
174 LUA_API int   (lua_pushthread) (lua_State *L);
175 
176 
177 /*
178 ** get functions (Lua -> stack)
179 */
180 LUA_API void  (lua_gettable) (lua_State *L, int idx);
181 LUA_API void  (lua_getfield) (lua_State *L, int idx, const char *k);
182 LUA_API void  (lua_rawget) (lua_State *L, int idx);
183 LUA_API void  (lua_rawgeti) (lua_State *L, int idx, int n);
184 LUA_API void  (lua_createtable) (lua_State *L, int narr, int nrec);
185 LUA_API void *(lua_newuserdata) (lua_State *L, size_t sz);
186 LUA_API int   (lua_getmetatable) (lua_State *L, int objindex);
187 LUA_API void  (lua_getfenv) (lua_State *L, int idx);
188 
189 
190 /*
191 ** set functions (stack -> Lua)
192 */
193 LUA_API void  (lua_settable) (lua_State *L, int idx);
194 LUA_API void  (lua_setfield) (lua_State *L, int idx, const char *k);
195 LUA_API void  (lua_rawset) (lua_State *L, int idx);
196 LUA_API void  (lua_rawseti) (lua_State *L, int idx, int n);
197 LUA_API int   (lua_setmetatable) (lua_State *L, int objindex);
198 LUA_API int   (lua_setfenv) (lua_State *L, int idx);
199 
200 
201 /*
202 ** `load' and `call' functions (load and run Lua code)
203 */
204 LUA_API void  (lua_call) (lua_State *L, int nargs, int nresults);
205 LUA_API int   (lua_pcall) (lua_State *L, int nargs, int nresults, int errfunc);
206 LUA_API int   (lua_cpcall) (lua_State *L, lua_CFunction func, void *ud);
207 LUA_API int   (lua_load) (lua_State *L, lua_Reader reader, void *dt,
208                                         const char *chunkname);
209 
210 LUA_API int (lua_dump) (lua_State *L, lua_Writer writer, void *data);
211 
212 
213 /*
214 ** coroutine functions
215 */
216 LUA_API int  (lua_yield) (lua_State *L, int nresults);
217 LUA_API int  (lua_resume) (lua_State *L, int narg);
218 LUA_API int  (lua_status) (lua_State *L);
219 
220 /*
221 ** garbage-collection function and options
222 */
223 
224 #define LUA_GCSTOP		0
225 #define LUA_GCRESTART		1
226 #define LUA_GCCOLLECT		2
227 #define LUA_GCCOUNT		3
228 #define LUA_GCCOUNTB		4
229 #define LUA_GCSTEP		5
230 #define LUA_GCSETPAUSE		6
231 #define LUA_GCSETSTEPMUL	7
232 #define LUA_GCISRUNNING		9
233 
234 LUA_API int (lua_gc) (lua_State *L, int what, int data);
235 
236 
237 /*
238 ** miscellaneous functions
239 */
240 
241 LUA_API int   (lua_error) (lua_State *L);
242 
243 LUA_API int   (lua_next) (lua_State *L, int idx);
244 
245 LUA_API void  (lua_concat) (lua_State *L, int n);
246 
247 LUA_API lua_Alloc (lua_getallocf) (lua_State *L, void **ud);
248 LUA_API void lua_setallocf (lua_State *L, lua_Alloc f, void *ud);
249 
250 
251 
252 /*
253 ** ===============================================================
254 ** some useful macros
255 ** ===============================================================
256 */
257 
258 #define lua_pop(L,n)		lua_settop(L, -(n)-1)
259 
260 #define lua_newtable(L)		lua_createtable(L, 0, 0)
261 
262 #define lua_register(L,n,f) (lua_pushcfunction(L, (f)), lua_setglobal(L, (n)))
263 
264 #define lua_pushcfunction(L,f)	lua_pushcclosure(L, (f), 0)
265 
266 #define lua_strlen(L,i)		lua_objlen(L, (i))
267 
268 #define lua_isfunction(L,n)	(lua_type(L, (n)) == LUA_TFUNCTION)
269 #define lua_istable(L,n)	(lua_type(L, (n)) == LUA_TTABLE)
270 #define lua_islightuserdata(L,n)	(lua_type(L, (n)) == LUA_TLIGHTUSERDATA)
271 #define lua_isnil(L,n)		(lua_type(L, (n)) == LUA_TNIL)
272 #define lua_isboolean(L,n)	(lua_type(L, (n)) == LUA_TBOOLEAN)
273 #define lua_isthread(L,n)	(lua_type(L, (n)) == LUA_TTHREAD)
274 #define lua_isnone(L,n)		(lua_type(L, (n)) == LUA_TNONE)
275 #define lua_isnoneornil(L, n)	(lua_type(L, (n)) <= 0)
276 
277 #define lua_pushliteral(L, s)	\
278 	lua_pushlstring(L, "" s, (sizeof(s)/sizeof(char))-1)
279 
280 #define lua_setglobal(L,s)	lua_setfield(L, LUA_GLOBALSINDEX, (s))
281 #define lua_getglobal(L,s)	lua_getfield(L, LUA_GLOBALSINDEX, (s))
282 
283 #define lua_tostring(L,i)	lua_tolstring(L, (i), NULL)
284 
285 
286 
287 /*
288 ** compatibility macros and functions
289 */
290 
291 #define lua_open()	luaL_newstate()
292 
293 #define lua_getregistry(L)	lua_pushvalue(L, LUA_REGISTRYINDEX)
294 
295 #define lua_getgccount(L)	lua_gc(L, LUA_GCCOUNT, 0)
296 
297 #define lua_Chunkreader		lua_Reader
298 #define lua_Chunkwriter		lua_Writer
299 
300 
301 /* hack */
302 LUA_API void lua_setlevel	(lua_State *from, lua_State *to);
303 
304 
305 /*
306 ** {======================================================================
307 ** Debug API
308 ** =======================================================================
309 */
310 
311 
312 /*
313 ** Event codes
314 */
315 #define LUA_HOOKCALL	0
316 #define LUA_HOOKRET	1
317 #define LUA_HOOKLINE	2
318 #define LUA_HOOKCOUNT	3
319 #define LUA_HOOKTAILRET 4
320 
321 
322 /*
323 ** Event masks
324 */
325 #define LUA_MASKCALL	(1 << LUA_HOOKCALL)
326 #define LUA_MASKRET	(1 << LUA_HOOKRET)
327 #define LUA_MASKLINE	(1 << LUA_HOOKLINE)
328 #define LUA_MASKCOUNT	(1 << LUA_HOOKCOUNT)
329 
330 typedef struct lua_Debug lua_Debug;  /* activation record */
331 
332 
333 /* Functions to be called by the debuger in specific events */
334 typedef void (*lua_Hook) (lua_State *L, lua_Debug *ar);
335 
336 
337 LUA_API int lua_getstack (lua_State *L, int level, lua_Debug *ar);
338 LUA_API int lua_getinfo (lua_State *L, const char *what, lua_Debug *ar);
339 LUA_API const char *lua_getlocal (lua_State *L, const lua_Debug *ar, int n);
340 LUA_API const char *lua_setlocal (lua_State *L, const lua_Debug *ar, int n);
341 LUA_API const char *lua_getupvalue (lua_State *L, int funcindex, int n);
342 LUA_API const char *lua_setupvalue (lua_State *L, int funcindex, int n);
343 LUA_API int lua_sethook (lua_State *L, lua_Hook func, int mask, int count);
344 LUA_API lua_Hook lua_gethook (lua_State *L);
345 LUA_API int lua_gethookmask (lua_State *L);
346 LUA_API int lua_gethookcount (lua_State *L);
347 
348 /* From Lua 5.2. */
349 LUA_API void *lua_upvalueid (lua_State *L, int idx, int n);
350 LUA_API void lua_upvaluejoin (lua_State *L, int idx1, int n1, int idx2, int n2);
351 LUA_API int lua_loadx (lua_State *L, lua_Reader reader, void *dt,
352 		       const char *chunkname, const char *mode);
353 
354 
355 struct lua_Debug {
356   int event;
357   const char *name;	/* (n) */
358   const char *namewhat;	/* (n) `global', `local', `field', `method' */
359   const char *what;	/* (S) `Lua', `C', `main', `tail' */
360   const char *source;	/* (S) */
361   int currentline;	/* (l) */
362   int nups;		/* (u) number of upvalues */
363   int linedefined;	/* (S) */
364   int lastlinedefined;	/* (S) */
365   char short_src[LUA_IDSIZE]; /* (S) */
366   /* private part */
367   int i_ci;  /* active function */
368 };
369 
370 /* }====================================================================== */
371 
372 
373 /******************************************************************************
374 * Copyright (C) 1994-2008 Lua.org, PUC-Rio.  All rights reserved.
375 *
376 * Permission is hereby granted, free of charge, to any person obtaining
377 * a copy of this software and associated documentation files (the
378 * "Software"), to deal in the Software without restriction, including
379 * without limitation the rights to use, copy, modify, merge, publish,
380 * distribute, sublicense, and/or sell copies of the Software, and to
381 * permit persons to whom the Software is furnished to do so, subject to
382 * the following conditions:
383 *
384 * The above copyright notice and this permission notice shall be
385 * included in all copies or substantial portions of the Software.
386 *
387 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
388 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
389 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
390 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
391 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
392 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
393 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
394 ******************************************************************************/
395 
396 
397 #endif
398