mirror of
https://github.com/lua/lua
synced 2024-11-30 08:33:16 +03:00
425 lines
10 KiB
C
425 lines
10 KiB
C
/*
|
|
** $Id: lobject.h,v 2.44 2010/12/06 21:08:36 roberto Exp roberto $
|
|
** Type definitions for Lua objects
|
|
** See Copyright Notice in lua.h
|
|
*/
|
|
|
|
|
|
#ifndef lobject_h
|
|
#define lobject_h
|
|
|
|
|
|
#include <stdarg.h>
|
|
|
|
|
|
#include "llimits.h"
|
|
#include "lua.h"
|
|
|
|
|
|
/*
|
|
** Extra tags for non-values
|
|
*/
|
|
#define LUA_TPROTO LUA_NUMTAGS
|
|
#define LUA_TUPVAL (LUA_NUMTAGS+1)
|
|
#define LUA_TDEADKEY (LUA_NUMTAGS+2)
|
|
|
|
|
|
/*
|
|
** Variant tag for light C functions (negative to be considered
|
|
** non collectable by 'iscollectable')
|
|
*/
|
|
#define LUA_TLCF (~0x0F | LUA_TFUNCTION)
|
|
|
|
/*
|
|
** Union of all collectable objects
|
|
*/
|
|
typedef union GCObject GCObject;
|
|
|
|
|
|
/*
|
|
** Common Header for all collectable objects (in macro form, to be
|
|
** included in other objects)
|
|
*/
|
|
#define CommonHeader GCObject *next; lu_byte tt; lu_byte marked
|
|
|
|
|
|
/*
|
|
** Common header in struct form
|
|
*/
|
|
typedef struct GCheader {
|
|
CommonHeader;
|
|
} GCheader;
|
|
|
|
|
|
|
|
/*
|
|
** Union of all Lua values
|
|
*/
|
|
typedef union {
|
|
GCObject *gc; /* collectable objects */
|
|
void *p; /* light userdata */
|
|
lua_Number n; /* numbers */
|
|
int b; /* booleans */
|
|
lua_CFunction f; /* light C functions */
|
|
} Value;
|
|
|
|
|
|
|
|
/*
|
|
** Tagged Values. This is the basic representation of values in Lua,
|
|
** an actual value plus a tag with its type.
|
|
*/
|
|
|
|
#define TValuefields Value value_; int tt_
|
|
|
|
typedef struct lua_TValue {
|
|
TValuefields;
|
|
} TValue;
|
|
|
|
|
|
/* macro defining a nil value */
|
|
#define NILCONSTANT {NULL}, LUA_TNIL
|
|
|
|
|
|
/*
|
|
** type tag of a TValue
|
|
*/
|
|
#define ttype(o) ((o)->tt_)
|
|
|
|
|
|
/*
|
|
** type tag of a TValue with no variants
|
|
*/
|
|
#define ttypenv(o) (ttype(o) & 0x0F)
|
|
|
|
|
|
/* Macros to test type */
|
|
#define ttisnil(o) (ttype(o) == LUA_TNIL)
|
|
#define ttisnumber(o) (ttype(o) == LUA_TNUMBER)
|
|
#define ttisstring(o) (ttype(o) == LUA_TSTRING)
|
|
#define ttistable(o) (ttype(o) == LUA_TTABLE)
|
|
#define ttisfunction(o) (ttypenv(o) == LUA_TFUNCTION)
|
|
#define ttisclosure(o) (ttype(o) == LUA_TFUNCTION)
|
|
#define ttislcf(o) (ttype(o) == LUA_TLCF)
|
|
#define ttisboolean(o) (ttype(o) == LUA_TBOOLEAN)
|
|
#define ttisuserdata(o) (ttype(o) == LUA_TUSERDATA)
|
|
#define ttisthread(o) (ttype(o) == LUA_TTHREAD)
|
|
#define ttislightuserdata(o) (ttype(o) == LUA_TLIGHTUSERDATA)
|
|
#define ttisdeadkey(o) (ttype(o) == LUA_TDEADKEY)
|
|
|
|
/* Macros to access values */
|
|
#define gcvalue(o) check_exp(iscollectable(o), (o)->value_.gc)
|
|
#define pvalue(o) check_exp(ttislightuserdata(o), (o)->value_.p)
|
|
#define nvalue(o) check_exp(ttisnumber(o), (o)->value_.n)
|
|
#define rawtsvalue(o) check_exp(ttisstring(o), &(o)->value_.gc->ts)
|
|
#define tsvalue(o) (&rawtsvalue(o)->tsv)
|
|
#define rawuvalue(o) check_exp(ttisuserdata(o), &(o)->value_.gc->u)
|
|
#define uvalue(o) (&rawuvalue(o)->uv)
|
|
#define clvalue(o) check_exp(ttisclosure(o), &(o)->value_.gc->cl)
|
|
#define fvalue(o) check_exp(ttislcf(o), (o)->value_.f)
|
|
#define hvalue(o) check_exp(ttistable(o), &(o)->value_.gc->h)
|
|
#define bvalue(o) check_exp(ttisboolean(o), (o)->value_.b)
|
|
#define thvalue(o) check_exp(ttisthread(o), &(o)->value_.gc->th)
|
|
|
|
#define l_isfalse(o) (ttisnil(o) || (ttisboolean(o) && bvalue(o) == 0))
|
|
|
|
|
|
#define iscollectable(o) (ttype(o) >= LUA_TSTRING)
|
|
|
|
|
|
/* Macros for internal tests */
|
|
#define righttt(obj) (ttype(obj) == gcvalue(obj)->gch.tt)
|
|
|
|
#define checkconsistency(obj) lua_assert(!iscollectable(obj) || righttt(obj))
|
|
|
|
#define checkliveness(g,obj) \
|
|
lua_assert(!iscollectable(obj) || (righttt(obj) && !isdead(g,gcvalue(obj))))
|
|
|
|
|
|
/* Macros to set values */
|
|
#define setnilvalue(obj) ((obj)->tt_=LUA_TNIL)
|
|
|
|
#define setnvalue(obj,x) \
|
|
{ TValue *i_o=(obj); i_o->value_.n=(x); i_o->tt_=LUA_TNUMBER; }
|
|
|
|
#define setfvalue(obj,x) \
|
|
{ TValue *i_o=(obj); i_o->value_.f=(x); i_o->tt_=LUA_TLCF; }
|
|
|
|
#define changenvalue(o,x) check_exp((o)->tt_==LUA_TNUMBER, (o)->value_.n=(x))
|
|
|
|
#define setpvalue(obj,x) \
|
|
{ TValue *i_o=(obj); i_o->value_.p=(x); i_o->tt_=LUA_TLIGHTUSERDATA; }
|
|
|
|
#define setbvalue(obj,x) \
|
|
{ TValue *i_o=(obj); i_o->value_.b=(x); i_o->tt_=LUA_TBOOLEAN; }
|
|
|
|
#define setgcovalue(L,obj,x) \
|
|
{ TValue *i_o=(obj); GCObject *i_g=(x); \
|
|
i_o->value_.gc=i_g; i_o->tt_=gch(i_g)->tt; }
|
|
|
|
#define setsvalue(L,obj,x) \
|
|
{ TValue *i_o=(obj); \
|
|
i_o->value_.gc=cast(GCObject *, (x)); i_o->tt_=LUA_TSTRING; \
|
|
checkliveness(G(L),i_o); }
|
|
|
|
#define setuvalue(L,obj,x) \
|
|
{ TValue *i_o=(obj); \
|
|
i_o->value_.gc=cast(GCObject *, (x)); i_o->tt_=LUA_TUSERDATA; \
|
|
checkliveness(G(L),i_o); }
|
|
|
|
#define setthvalue(L,obj,x) \
|
|
{ TValue *i_o=(obj); \
|
|
i_o->value_.gc=cast(GCObject *, (x)); i_o->tt_=LUA_TTHREAD; \
|
|
checkliveness(G(L),i_o); }
|
|
|
|
#define setclvalue(L,obj,x) \
|
|
{ TValue *i_o=(obj); \
|
|
i_o->value_.gc=cast(GCObject *, (x)); i_o->tt_=LUA_TFUNCTION; \
|
|
checkliveness(G(L),i_o); }
|
|
|
|
#define sethvalue(L,obj,x) \
|
|
{ TValue *i_o=(obj); \
|
|
i_o->value_.gc=cast(GCObject *, (x)); i_o->tt_=LUA_TTABLE; \
|
|
checkliveness(G(L),i_o); }
|
|
|
|
#define setptvalue(L,obj,x) \
|
|
{ TValue *i_o=(obj); \
|
|
i_o->value_.gc=cast(GCObject *, (x)); i_o->tt_=LUA_TPROTO; \
|
|
checkliveness(G(L),i_o); }
|
|
|
|
#define setdeadvalue(obj) ((obj)->tt_=LUA_TDEADKEY)
|
|
|
|
|
|
|
|
#define setobj(L,obj1,obj2) \
|
|
{ const TValue *o2=(obj2); TValue *o1=(obj1); \
|
|
o1->value_ = o2->value_; o1->tt_=o2->tt_; \
|
|
checkliveness(G(L),o1); }
|
|
|
|
|
|
/*
|
|
** different types of assignments, according to destination
|
|
*/
|
|
|
|
/* from stack to (same) stack */
|
|
#define setobjs2s setobj
|
|
/* to stack (not from same stack) */
|
|
#define setobj2s setobj
|
|
#define setsvalue2s setsvalue
|
|
#define sethvalue2s sethvalue
|
|
#define setptvalue2s setptvalue
|
|
/* from table to same table */
|
|
#define setobjt2t setobj
|
|
/* to table */
|
|
#define setobj2t setobj
|
|
/* to new object */
|
|
#define setobj2n setobj
|
|
#define setsvalue2n setsvalue
|
|
|
|
|
|
|
|
typedef TValue *StkId; /* index to stack elements */
|
|
|
|
|
|
/*
|
|
** Header for string value; string bytes follow the end of this structure
|
|
*/
|
|
typedef union TString {
|
|
L_Umaxalign dummy; /* ensures maximum alignment for strings */
|
|
struct {
|
|
CommonHeader;
|
|
lu_byte reserved;
|
|
unsigned int hash;
|
|
size_t len;
|
|
} tsv;
|
|
} TString;
|
|
|
|
|
|
/* get the actual string (array of bytes) from a TString */
|
|
#define getstr(ts) cast(const char *, (ts) + 1)
|
|
|
|
/* get the actual string (array of bytes) from a Lua value */
|
|
#define svalue(o) getstr(rawtsvalue(o))
|
|
|
|
|
|
/*
|
|
** Header for userdata; memory area follows the end of this structure
|
|
*/
|
|
typedef union Udata {
|
|
L_Umaxalign dummy; /* ensures maximum alignment for `local' udata */
|
|
struct {
|
|
CommonHeader;
|
|
struct Table *metatable;
|
|
struct Table *env;
|
|
size_t len;
|
|
} uv;
|
|
} Udata;
|
|
|
|
|
|
|
|
/*
|
|
** Description of an upvalue for function prototypes
|
|
*/
|
|
typedef struct Upvaldesc {
|
|
TString *name; /* upvalue name (for debug information) */
|
|
lu_byte instack; /* whether it is in stack */
|
|
lu_byte idx; /* index of upvalue (in stack or in outer function's list) */
|
|
} Upvaldesc;
|
|
|
|
|
|
/*
|
|
** Description of a local variable for function prototypes
|
|
** (used for debug information)
|
|
*/
|
|
typedef struct LocVar {
|
|
TString *varname;
|
|
int startpc; /* first point where variable is active */
|
|
int endpc; /* first point where variable is dead */
|
|
} LocVar;
|
|
|
|
|
|
/*
|
|
** Function Prototypes
|
|
*/
|
|
typedef struct Proto {
|
|
CommonHeader;
|
|
TValue *k; /* constants used by the function */
|
|
Instruction *code;
|
|
struct Proto **p; /* functions defined inside the function */
|
|
int *lineinfo; /* map from opcodes to source lines */
|
|
LocVar *locvars; /* information about local variables */
|
|
Upvaldesc *upvalues; /* upvalue information */
|
|
union Closure *cache; /* last created closure with this prototype */
|
|
TString *source;
|
|
int sizeupvalues; /* size of 'upvalues' */
|
|
int sizek; /* size of `k' */
|
|
int sizecode;
|
|
int sizelineinfo;
|
|
int sizep; /* size of `p' */
|
|
int sizelocvars;
|
|
int linedefined;
|
|
int lastlinedefined;
|
|
GCObject *gclist;
|
|
lu_byte numparams; /* number of fixed parameters */
|
|
lu_byte is_vararg;
|
|
lu_byte maxstacksize; /* maximum stack used by this function */
|
|
} Proto;
|
|
|
|
|
|
|
|
/*
|
|
** Lua Upvalues
|
|
*/
|
|
typedef struct UpVal {
|
|
CommonHeader;
|
|
TValue *v; /* points to stack or to its own value */
|
|
union {
|
|
TValue value; /* the value (when closed) */
|
|
struct { /* double linked list (when open) */
|
|
struct UpVal *prev;
|
|
struct UpVal *next;
|
|
} l;
|
|
} u;
|
|
} UpVal;
|
|
|
|
|
|
/*
|
|
** Closures
|
|
*/
|
|
|
|
#define ClosureHeader \
|
|
CommonHeader; lu_byte isC; lu_byte nupvalues; GCObject *gclist
|
|
|
|
typedef struct CClosure {
|
|
ClosureHeader;
|
|
lua_CFunction f;
|
|
TValue upvalue[1]; /* list of upvalues */
|
|
} CClosure;
|
|
|
|
|
|
typedef struct LClosure {
|
|
ClosureHeader;
|
|
struct Proto *p;
|
|
UpVal *upvals[1]; /* list of upvalues */
|
|
} LClosure;
|
|
|
|
|
|
typedef union Closure {
|
|
CClosure c;
|
|
LClosure l;
|
|
} Closure;
|
|
|
|
|
|
#define isLfunction(o) (ttisclosure(o) && !clvalue(o)->c.isC)
|
|
|
|
#define getproto(o) (clvalue(o)->l.p)
|
|
|
|
|
|
/*
|
|
** Tables
|
|
*/
|
|
|
|
typedef union TKey {
|
|
struct {
|
|
TValuefields;
|
|
struct Node *next; /* for chaining */
|
|
} nk;
|
|
TValue tvk;
|
|
} TKey;
|
|
|
|
|
|
typedef struct Node {
|
|
TValue i_val;
|
|
TKey i_key;
|
|
} Node;
|
|
|
|
|
|
typedef struct Table {
|
|
CommonHeader;
|
|
lu_byte flags; /* 1<<p means tagmethod(p) is not present */
|
|
lu_byte lsizenode; /* log2 of size of `node' array */
|
|
struct Table *metatable;
|
|
TValue *array; /* array part */
|
|
Node *node;
|
|
Node *lastfree; /* any free position is before this position */
|
|
GCObject *gclist;
|
|
int sizearray; /* size of `array' array */
|
|
} Table;
|
|
|
|
|
|
|
|
/*
|
|
** `module' operation for hashing (size is always a power of 2)
|
|
*/
|
|
#define lmod(s,size) \
|
|
(check_exp((size&(size-1))==0, (cast(int, (s) & ((size)-1)))))
|
|
|
|
|
|
#define twoto(x) (1<<(x))
|
|
#define sizenode(t) (twoto((t)->lsizenode))
|
|
|
|
|
|
/*
|
|
** (address of) a fixed nil value
|
|
*/
|
|
#define luaO_nilobject (&luaO_nilobject_)
|
|
|
|
|
|
LUAI_DDEC const TValue luaO_nilobject_;
|
|
|
|
LUAI_FUNC int luaO_int2fb (unsigned int x);
|
|
LUAI_FUNC int luaO_fb2int (int x);
|
|
LUAI_FUNC int luaO_ceillog2 (lu_int32 x);
|
|
LUAI_FUNC lua_Number luaO_arith (int op, lua_Number v1, lua_Number v2);
|
|
LUAI_FUNC int luaO_rawequalObj (const TValue *t1, const TValue *t2);
|
|
LUAI_FUNC int luaO_str2d (const char *s, size_t len, lua_Number *result);
|
|
LUAI_FUNC int luaO_hexavalue (int c);
|
|
LUAI_FUNC const char *luaO_pushvfstring (lua_State *L, const char *fmt,
|
|
va_list argp);
|
|
LUAI_FUNC const char *luaO_pushfstring (lua_State *L, const char *fmt, ...);
|
|
LUAI_FUNC void luaO_chunkid (char *out, const char *source, size_t len);
|
|
|
|
|
|
#endif
|
|
|