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