1 /* 2 ** $Id: lua.h,v 1.332.1.2 2018/06/13 16:58:17 roberto Exp $ 3 ** Lua - A Scripting 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_MAJOR "5" 20 #define LUA_VERSION_MINOR "3" 21 #define LUA_VERSION_NUM 503 22 #define LUA_VERSION_RELEASE "5" 23 24 #define LUA_VERSION "Lua " LUA_VERSION_MAJOR "." LUA_VERSION_MINOR 25 #define LUA_RELEASE LUA_VERSION "." LUA_VERSION_RELEASE 26 #define LUA_COPYRIGHT LUA_RELEASE " Copyright (C) 1994-2018 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 "\x1bLua" 32 33 /* option for multiple returns in 'lua_pcall' and 'lua_call' */ 34 #define LUA_MULTRET (-1) 35 36 37 /* 38 ** Pseudo-indices 39 ** (-LUAI_MAXSTACK is the minimum valid index; we keep some free empty 40 ** space after that to help overflow detection) 41 */ 42 #define LUA_REGISTRYINDEX (-LUAI_MAXSTACK - 1000) 43 #define lua_upvalueindex(i) (LUA_REGISTRYINDEX - (i)) 44 45 46 /* thread status */ 47 #define LUA_OK 0 48 #define LUA_YIELD 1 49 #define LUA_ERRRUN 2 50 #define LUA_ERRSYNTAX 3 51 #define LUA_ERRMEM 4 52 #define LUA_ERRGCMM 5 53 #define LUA_ERRERR 6 54 55 56 typedef struct lua_State lua_State; 57 58 59 /* 60 ** basic types 61 */ 62 #define LUA_TNONE (-1) 63 64 #define LUA_TNIL 0 65 #define LUA_TBOOLEAN 1 66 #define LUA_TLIGHTUSERDATA 2 67 #define LUA_TNUMBER 3 68 #define LUA_TSTRING 4 69 #define LUA_TTABLE 5 70 #define LUA_TFUNCTION 6 71 #define LUA_TUSERDATA 7 72 #define LUA_TTHREAD 8 73 74 #define LUA_NUMTAGS 9 75 76 77 78 /* minimum Lua stack available to a C function */ 79 #define LUA_MINSTACK 20 80 81 82 /* predefined values in the registry */ 83 #define LUA_RIDX_MAINTHREAD 1 84 #define LUA_RIDX_GLOBALS 2 85 #define LUA_RIDX_LAST LUA_RIDX_GLOBALS 86 87 88 /* type of numbers in Lua */ 89 typedef LUA_NUMBER lua_Number; 90 91 92 /* type for integer functions */ 93 typedef LUA_INTEGER lua_Integer; 94 95 /* unsigned integer type */ 96 typedef LUA_UNSIGNED lua_Unsigned; 97 98 /* type for continuation-function contexts */ 99 typedef LUA_KCONTEXT lua_KContext; 100 101 102 /* 103 ** Type for C functions registered with Lua 104 */ 105 typedef int (*lua_CFunction) (lua_State *L); 106 107 /* 108 ** Type for continuation functions 109 */ 110 typedef int (*lua_KFunction) (lua_State *L, int status, lua_KContext ctx); 111 112 113 /* 114 ** Type for functions that read/write blocks when loading/dumping Lua chunks 115 */ 116 typedef const char * (*lua_Reader) (lua_State *L, void *ud, size_t *sz); 117 118 typedef int (*lua_Writer) (lua_State *L, const void *p, size_t sz, void *ud); 119 120 121 /* 122 ** Type for memory-allocation functions 123 */ 124 typedef void * (*lua_Alloc) (void *ud, void *ptr, size_t osize, size_t nsize); 125 126 127 128 /* 129 ** generic extra include file 130 */ 131 #if defined(LUA_USER_H) 132 #include LUA_USER_H 133 #endif 134 135 136 /* 137 ** RCS ident string 138 */ 139 extern const char lua_ident[]; 140 141 142 /* 143 ** state manipulation 144 */ 145 LUA_API lua_State *(lua_newstate) (lua_Alloc f, void *ud); 146 LUA_API void (lua_close) (lua_State *L); 147 LUA_API lua_State *(lua_newthread) (lua_State *L); 148 149 LUA_API lua_CFunction (lua_atpanic) (lua_State *L, lua_CFunction panicf); 150 151 152 LUA_API const lua_Number *(lua_version) (lua_State *L); 153 154 155 /* 156 ** basic stack manipulation 157 */ 158 LUA_API int (lua_absindex) (lua_State *L, int idx); 159 LUA_API int (lua_gettop) (lua_State *L); 160 LUA_API void (lua_settop) (lua_State *L, int idx); 161 LUA_API void (lua_pushvalue) (lua_State *L, int idx); 162 LUA_API void (lua_rotate) (lua_State *L, int idx, int n); 163 LUA_API void (lua_copy) (lua_State *L, int fromidx, int toidx); 164 LUA_API int (lua_checkstack) (lua_State *L, int n); 165 166 LUA_API void (lua_xmove) (lua_State *from, lua_State *to, int n); 167 168 169 /* 170 ** access functions (stack -> C) 171 */ 172 173 LUA_API int (lua_isnumber) (lua_State *L, int idx); 174 LUA_API int (lua_isstring) (lua_State *L, int idx); 175 LUA_API int (lua_iscfunction) (lua_State *L, int idx); 176 LUA_API int (lua_isinteger) (lua_State *L, int idx); 177 LUA_API int (lua_isuserdata) (lua_State *L, int idx); 178 LUA_API int (lua_type) (lua_State *L, int idx); 179 LUA_API const char *(lua_typename) (lua_State *L, int tp); 180 181 LUA_API lua_Number (lua_tonumberx) (lua_State *L, int idx, int *isnum); 182 LUA_API lua_Integer (lua_tointegerx) (lua_State *L, int idx, int *isnum); 183 LUA_API int (lua_toboolean) (lua_State *L, int idx); 184 LUA_API const char *(lua_tolstring) (lua_State *L, int idx, size_t *len); 185 LUA_API size_t (lua_rawlen) (lua_State *L, int idx); 186 LUA_API lua_CFunction (lua_tocfunction) (lua_State *L, int idx); 187 LUA_API void *(lua_touserdata) (lua_State *L, int idx); 188 LUA_API lua_State *(lua_tothread) (lua_State *L, int idx); 189 LUA_API const void *(lua_topointer) (lua_State *L, int idx); 190 191 192 /* 193 ** Comparison and arithmetic functions 194 */ 195 196 #define LUA_OPADD 0 /* ORDER TM, ORDER OP */ 197 #define LUA_OPSUB 1 198 #define LUA_OPMUL 2 199 #define LUA_OPMOD 3 200 #define LUA_OPPOW 4 201 #define LUA_OPDIV 5 202 #define LUA_OPIDIV 6 203 #define LUA_OPBAND 7 204 #define LUA_OPBOR 8 205 #define LUA_OPBXOR 9 206 #define LUA_OPSHL 10 207 #define LUA_OPSHR 11 208 #define LUA_OPUNM 12 209 #define LUA_OPBNOT 13 210 211 LUA_API void (lua_arith) (lua_State *L, int op); 212 213 #define LUA_OPEQ 0 214 #define LUA_OPLT 1 215 #define LUA_OPLE 2 216 217 LUA_API int (lua_rawequal) (lua_State *L, int idx1, int idx2); 218 LUA_API int (lua_compare) (lua_State *L, int idx1, int idx2, int op); 219 220 221 /* 222 ** push functions (C -> stack) 223 */ 224 LUA_API void (lua_pushnil) (lua_State *L); 225 LUA_API void (lua_pushnumber) (lua_State *L, lua_Number n); 226 LUA_API void (lua_pushinteger) (lua_State *L, lua_Integer n); 227 LUA_API const char *(lua_pushlstring) (lua_State *L, const char *s, size_t len); 228 LUA_API const char *(lua_pushstring) (lua_State *L, const char *s); 229 LUA_API const char *(lua_pushvfstring) (lua_State *L, const char *fmt, 230 va_list argp); 231 LUA_API const char *(lua_pushfstring) (lua_State *L, const char *fmt, ...); 232 LUA_API void (lua_pushcclosure) (lua_State *L, lua_CFunction fn, int n); 233 LUA_API void (lua_pushboolean) (lua_State *L, int b); 234 LUA_API void (lua_pushlightuserdata) (lua_State *L, void *p); 235 LUA_API int (lua_pushthread) (lua_State *L); 236 237 238 /* 239 ** get functions (Lua -> stack) 240 */ 241 LUA_API int (lua_getglobal) (lua_State *L, const char *name); 242 LUA_API int (lua_gettable) (lua_State *L, int idx); 243 LUA_API int (lua_getfield) (lua_State *L, int idx, const char *k); 244 LUA_API int (lua_geti) (lua_State *L, int idx, lua_Integer n); 245 LUA_API int (lua_rawget) (lua_State *L, int idx); 246 LUA_API int (lua_rawgeti) (lua_State *L, int idx, lua_Integer n); 247 LUA_API int (lua_rawgetp) (lua_State *L, int idx, const void *p); 248 249 LUA_API void (lua_createtable) (lua_State *L, int narr, int nrec); 250 LUA_API void *(lua_newuserdata) (lua_State *L, size_t sz); 251 LUA_API int (lua_getmetatable) (lua_State *L, int objindex); 252 LUA_API int (lua_getuservalue) (lua_State *L, int idx); 253 254 255 /* 256 ** set functions (stack -> Lua) 257 */ 258 LUA_API void (lua_setglobal) (lua_State *L, const char *name); 259 LUA_API void (lua_settable) (lua_State *L, int idx); 260 LUA_API void (lua_setfield) (lua_State *L, int idx, const char *k); 261 LUA_API void (lua_seti) (lua_State *L, int idx, lua_Integer n); 262 LUA_API void (lua_rawset) (lua_State *L, int idx); 263 LUA_API void (lua_rawseti) (lua_State *L, int idx, lua_Integer n); 264 LUA_API void (lua_rawsetp) (lua_State *L, int idx, const void *p); 265 LUA_API int (lua_setmetatable) (lua_State *L, int objindex); 266 LUA_API void (lua_setuservalue) (lua_State *L, int idx); 267 268 269 /* 270 ** 'load' and 'call' functions (load and run Lua code) 271 */ 272 LUA_API void (lua_callk) (lua_State *L, int nargs, int nresults, 273 lua_KContext ctx, lua_KFunction k); 274 #define lua_call(L,n,r) lua_callk(L, (n), (r), 0, NULL) 275 276 LUA_API int (lua_pcallk) (lua_State *L, int nargs, int nresults, int errfunc, 277 lua_KContext ctx, lua_KFunction k); 278 #define lua_pcall(L,n,r,f) lua_pcallk(L, (n), (r), (f), 0, NULL) 279 280 LUA_API int (lua_load) (lua_State *L, lua_Reader reader, void *dt, 281 const char *chunkname, const char *mode); 282 283 LUA_API int (lua_dump) (lua_State *L, lua_Writer writer, void *data, int strip); 284 285 286 /* 287 ** coroutine functions 288 */ 289 LUA_API int (lua_yieldk) (lua_State *L, int nresults, lua_KContext ctx, 290 lua_KFunction k); 291 LUA_API int (lua_resume) (lua_State *L, lua_State *from, int narg); 292 LUA_API int (lua_status) (lua_State *L); 293 LUA_API int (lua_isyieldable) (lua_State *L); 294 295 #define lua_yield(L,n) lua_yieldk(L, (n), 0, NULL) 296 297 298 /* 299 ** garbage-collection function and options 300 */ 301 302 #define LUA_GCSTOP 0 303 #define LUA_GCRESTART 1 304 #define LUA_GCCOLLECT 2 305 #define LUA_GCCOUNT 3 306 #define LUA_GCCOUNTB 4 307 #define LUA_GCSTEP 5 308 #define LUA_GCSETPAUSE 6 309 #define LUA_GCSETSTEPMUL 7 310 #define LUA_GCISRUNNING 9 311 312 LUA_API int (lua_gc) (lua_State *L, int what, int data); 313 314 LUA_API void (lua_mlock) (lua_State *L, int enable); 315 316 317 /* 318 ** miscellaneous functions 319 */ 320 321 LUA_API int (lua_error) (lua_State *L); 322 323 LUA_API int (lua_next) (lua_State *L, int idx); 324 325 LUA_API void (lua_concat) (lua_State *L, int n); 326 LUA_API void (lua_len) (lua_State *L, int idx); 327 328 LUA_API size_t (lua_stringtonumber) (lua_State *L, const char *s); 329 330 LUA_API lua_Alloc (lua_getallocf) (lua_State *L, void **ud); 331 LUA_API void (lua_setallocf) (lua_State *L, lua_Alloc f, void *ud); 332 333 334 335 /* 336 ** {============================================================== 337 ** some useful macros 338 ** =============================================================== 339 */ 340 341 #define lua_getextraspace(L) ((void *)((char *)(L) - LUA_EXTRASPACE)) 342 343 #define lua_tonumber(L,i) lua_tonumberx(L,(i),NULL) 344 #define lua_tointeger(L,i) lua_tointegerx(L,(i),NULL) 345 346 #define lua_pop(L,n) lua_settop(L, -(n)-1) 347 348 #define lua_newtable(L) lua_createtable(L, 0, 0) 349 350 #define lua_register(L,n,f) (lua_pushcfunction(L, (f)), lua_setglobal(L, (n))) 351 352 #define lua_pushcfunction(L,f) lua_pushcclosure(L, (f), 0) 353 354 #define lua_isfunction(L,n) (lua_type(L, (n)) == LUA_TFUNCTION) 355 #define lua_istable(L,n) (lua_type(L, (n)) == LUA_TTABLE) 356 #define lua_islightuserdata(L,n) (lua_type(L, (n)) == LUA_TLIGHTUSERDATA) 357 #define lua_isnil(L,n) (lua_type(L, (n)) == LUA_TNIL) 358 #define lua_isboolean(L,n) (lua_type(L, (n)) == LUA_TBOOLEAN) 359 #define lua_isthread(L,n) (lua_type(L, (n)) == LUA_TTHREAD) 360 #define lua_isnone(L,n) (lua_type(L, (n)) == LUA_TNONE) 361 #define lua_isnoneornil(L, n) (lua_type(L, (n)) <= 0) 362 363 #define lua_pushliteral(L, s) lua_pushstring(L, "" s) 364 365 #define lua_pushglobaltable(L) \ 366 ((void)lua_rawgeti(L, LUA_REGISTRYINDEX, LUA_RIDX_GLOBALS)) 367 368 #define lua_tostring(L,i) lua_tolstring(L, (i), NULL) 369 370 371 #define lua_insert(L,idx) lua_rotate(L, (idx), 1) 372 373 #define lua_remove(L,idx) (lua_rotate(L, (idx), -1), lua_pop(L, 1)) 374 375 #define lua_replace(L,idx) (lua_copy(L, -1, (idx)), lua_pop(L, 1)) 376 377 /* }============================================================== */ 378 379 380 /* 381 ** {============================================================== 382 ** compatibility macros for unsigned conversions 383 ** =============================================================== 384 */ 385 #if defined(LUA_COMPAT_APIINTCASTS) 386 387 #define lua_pushunsigned(L,n) lua_pushinteger(L, (lua_Integer)(n)) 388 #define lua_tounsignedx(L,i,is) ((lua_Unsigned)lua_tointegerx(L,i,is)) 389 #define lua_tounsigned(L,i) lua_tounsignedx(L,(i),NULL) 390 391 #endif 392 /* }============================================================== */ 393 394 /* 395 ** {====================================================================== 396 ** Debug API 397 ** ======================================================================= 398 */ 399 400 401 /* 402 ** Event codes 403 */ 404 #define LUA_HOOKCALL 0 405 #define LUA_HOOKRET 1 406 #define LUA_HOOKLINE 2 407 #define LUA_HOOKCOUNT 3 408 #define LUA_HOOKTAILCALL 4 409 410 411 /* 412 ** Event masks 413 */ 414 #define LUA_MASKCALL (1 << LUA_HOOKCALL) 415 #define LUA_MASKRET (1 << LUA_HOOKRET) 416 #define LUA_MASKLINE (1 << LUA_HOOKLINE) 417 #define LUA_MASKCOUNT (1 << LUA_HOOKCOUNT) 418 419 typedef struct lua_Debug lua_Debug; /* activation record */ 420 421 422 /* Functions to be called by the debugger in specific events */ 423 typedef void (*lua_Hook) (lua_State *L, lua_Debug *ar); 424 425 426 LUA_API int (lua_getstack) (lua_State *L, int level, lua_Debug *ar); 427 LUA_API int (lua_getinfo) (lua_State *L, const char *what, lua_Debug *ar); 428 LUA_API const char *(lua_getlocal) (lua_State *L, const lua_Debug *ar, int n); 429 LUA_API const char *(lua_setlocal) (lua_State *L, const lua_Debug *ar, int n); 430 LUA_API const char *(lua_getupvalue) (lua_State *L, int funcindex, int n); 431 LUA_API const char *(lua_setupvalue) (lua_State *L, int funcindex, int n); 432 433 LUA_API void *(lua_upvalueid) (lua_State *L, int fidx, int n); 434 LUA_API void (lua_upvaluejoin) (lua_State *L, int fidx1, int n1, 435 int fidx2, int n2); 436 437 LUA_API void (lua_sethook) (lua_State *L, lua_Hook func, int mask, int count); 438 LUA_API lua_Hook (lua_gethook) (lua_State *L); 439 LUA_API int (lua_gethookmask) (lua_State *L); 440 LUA_API int (lua_gethookcount) (lua_State *L); 441 442 443 struct lua_Debug { 444 int event; 445 const char *name; /* (n) */ 446 const char *namewhat; /* (n) 'global', 'local', 'field', 'method' */ 447 const char *what; /* (S) 'Lua', 'C', 'main', 'tail' */ 448 const char *source; /* (S) */ 449 int currentline; /* (l) */ 450 int linedefined; /* (S) */ 451 int lastlinedefined; /* (S) */ 452 unsigned char nups; /* (u) number of upvalues */ 453 unsigned char nparams;/* (u) number of parameters */ 454 char isvararg; /* (u) */ 455 char istailcall; /* (t) */ 456 char short_src[LUA_IDSIZE]; /* (S) */ 457 /* private part */ 458 struct CallInfo *i_ci; /* active function */ 459 }; 460 461 /* }====================================================================== */ 462 463 464 /****************************************************************************** 465 * Copyright (C) 1994-2018 Lua.org, PUC-Rio. 466 * 467 * Permission is hereby granted, free of charge, to any person obtaining 468 * a copy of this software and associated documentation files (the 469 * "Software"), to deal in the Software without restriction, including 470 * without limitation the rights to use, copy, modify, merge, publish, 471 * distribute, sublicense, and/or sell copies of the Software, and to 472 * permit persons to whom the Software is furnished to do so, subject to 473 * the following conditions: 474 * 475 * The above copyright notice and this permission notice shall be 476 * included in all copies or substantial portions of the Software. 477 * 478 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 479 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 480 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 481 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY 482 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, 483 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 484 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 485 ******************************************************************************/ 486 487 488 #endif 489