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