src/lua.h

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