1/*
2** $Id: lauxlib.h,v 1.88.1.1 2007/12/27 13:02:25 roberto Exp $
3** Auxiliary functions for building Lua libraries
4** See Copyright Notice in lua.h
5*/
6
7
8#ifndef lauxlib_h
9#define lauxlib_h
10
11
12#include <stddef.h>
13#include <stdio.h>
14
15#include "lua.h"
16
17
18#define luaL_getn(L,i) ((int)lua_objlen(L, i))
19#define luaL_setn(L,i,j) ((void)0) /* no op! */
20
21/* extra error code for `luaL_load' */
22#define LUA_ERRFILE (LUA_ERRERR+1)
23
24typedef struct luaL_Reg {
25 const char *name;
26 lua_CFunction func;
27} luaL_Reg;
28
29LUALIB_API void (luaL_openlib) (lua_State *L, const char *libname,
30 const luaL_Reg *l, int nup);
31LUALIB_API void (luaL_register) (lua_State *L, const char *libname,
32 const luaL_Reg *l);
33LUALIB_API int (luaL_getmetafield) (lua_State *L, int obj, const char *e);
34LUALIB_API int (luaL_callmeta) (lua_State *L, int obj, const char *e);
35LUALIB_API int (luaL_typerror) (lua_State *L, int narg, const char *tname);
36LUALIB_API int (luaL_argerror) (lua_State *L, int numarg, const char *extramsg);
37LUALIB_API const char *(luaL_checklstring) (lua_State *L, int numArg,
38 size_t *l);
39LUALIB_API const char *(luaL_optlstring) (lua_State *L, int numArg,
40 const char *def, size_t *l);
41LUALIB_API lua_Number (luaL_checknumber) (lua_State *L, int numArg);
42LUALIB_API lua_Number (luaL_optnumber) (lua_State *L, int nArg, lua_Number def);
43
44LUALIB_API lua_Integer (luaL_checkinteger) (lua_State *L, int numArg);
45LUALIB_API lua_Integer (luaL_optinteger) (lua_State *L, int nArg,
46 lua_Integer def);
47
48LUALIB_API void (luaL_checkstack) (lua_State *L, int sz, const char *msg);
49LUALIB_API void (luaL_checktype) (lua_State *L, int narg, int t);
50LUALIB_API void (luaL_checkany) (lua_State *L, int narg);
51
52LUALIB_API int (luaL_newmetatable) (lua_State *L, const char *tname);
53LUALIB_API void *(luaL_checkudata) (lua_State *L, int ud, const char *tname);
54
55LUALIB_API void (luaL_where) (lua_State *L, int lvl);
56LUALIB_API int (luaL_error) (lua_State *L, const char *fmt, ...);
57
58LUALIB_API int (luaL_checkoption) (lua_State *L, int narg, const char *def,
59 const char *const lst[]);
60
61LUALIB_API int (luaL_ref) (lua_State *L, int t);
62LUALIB_API void (luaL_unref) (lua_State *L, int t, int ref);
63
64LUALIB_API int (luaL_loadfile) (lua_State *L, const char *filename);
65LUALIB_API int (luaL_loadbuffer) (lua_State *L, const char *buff, size_t sz,
66 const char *name);
67LUALIB_API int (luaL_loadstring) (lua_State *L, const char *s);
68
69LUALIB_API lua_State *(luaL_newstate) (void);
70
71
72LUALIB_API const char *(luaL_gsub) (lua_State *L, const char *s, const char *p,
73 const char *r);
74
75LUALIB_API const char *(luaL_findtable) (lua_State *L, int idx,
76 const char *fname, int szhint);
77
78/* From Lua 5.2. */
79LUALIB_API int luaL_fileresult(lua_State *L, int stat, const char *fname);
80LUALIB_API int luaL_execresult(lua_State *L, int stat);
81LUALIB_API int (luaL_loadfilex) (lua_State *L, const char *filename,
82 const char *mode);
83LUALIB_API int (luaL_loadbufferx) (lua_State *L, const char *buff, size_t sz,
84 const char *name, const char *mode);
85LUALIB_API void luaL_traceback (lua_State *L, lua_State *L1, const char *msg,
86 int level);
87
88
89/*
90** ===============================================================
91** some useful macros
92** ===============================================================
93*/
94
95#define luaL_argcheck(L, cond,numarg,extramsg) \
96 ((void)((cond) || luaL_argerror(L, (numarg), (extramsg))))
97#define luaL_checkstring(L,n) (luaL_checklstring(L, (n), NULL))
98#define luaL_optstring(L,n,d) (luaL_optlstring(L, (n), (d), NULL))
99#define luaL_checkint(L,n) ((int)luaL_checkinteger(L, (n)))
100#define luaL_optint(L,n,d) ((int)luaL_optinteger(L, (n), (d)))
101#define luaL_checklong(L,n) ((long)luaL_checkinteger(L, (n)))
102#define luaL_optlong(L,n,d) ((long)luaL_optinteger(L, (n), (d)))
103
104#define luaL_typename(L,i) lua_typename(L, lua_type(L,(i)))
105
106#define luaL_dofile(L, fn) \
107 (luaL_loadfile(L, fn) || lua_pcall(L, 0, LUA_MULTRET, 0))
108
109#define luaL_dostring(L, s) \
110 (luaL_loadstring(L, s) || lua_pcall(L, 0, LUA_MULTRET, 0))
111
112#define luaL_getmetatable(L,n) (lua_getfield(L, LUA_REGISTRYINDEX, (n)))
113
114#define luaL_opt(L,f,n,d) (lua_isnoneornil(L,(n)) ? (d) : f(L,(n)))
115
116/*
117** {======================================================
118** Generic Buffer manipulation
119** =======================================================
120*/
121
122
123
124typedef struct luaL_Buffer {
125 char *p; /* current position in buffer */
126 int lvl; /* number of strings in the stack (level) */
127 lua_State *L;
128 char buffer[LUAL_BUFFERSIZE];
129} luaL_Buffer;
130
131#define luaL_addchar(B,c) \
132 ((void)((B)->p < ((B)->buffer+LUAL_BUFFERSIZE) || luaL_prepbuffer(B)), \
133 (*(B)->p++ = (char)(c)))
134
135/* compatibility only */
136#define luaL_putchar(B,c) luaL_addchar(B,c)
137
138#define luaL_addsize(B,n) ((B)->p += (n))
139
140LUALIB_API void (luaL_buffinit) (lua_State *L, luaL_Buffer *B);
141LUALIB_API char *(luaL_prepbuffer) (luaL_Buffer *B);
142LUALIB_API void (luaL_addlstring) (luaL_Buffer *B, const char *s, size_t l);
143LUALIB_API void (luaL_addstring) (luaL_Buffer *B, const char *s);
144LUALIB_API void (luaL_addvalue) (luaL_Buffer *B);
145LUALIB_API void (luaL_pushresult) (luaL_Buffer *B);
146
147
148/* }====================================================== */
149
150
151/* compatibility with ref system */
152
153/* pre-defined references */
154#define LUA_NOREF (-2)
155#define LUA_REFNIL (-1)
156
157#define lua_ref(L,lock) ((lock) ? luaL_ref(L, LUA_REGISTRYINDEX) : \
158 (lua_pushstring(L, "unlocked references are obsolete"), lua_error(L), 0))
159
160#define lua_unref(L,ref) luaL_unref(L, LUA_REGISTRYINDEX, (ref))
161
162#define lua_getref(L,ref) lua_rawgeti(L, LUA_REGISTRYINDEX, (ref))
163
164
165#define luaL_reg luaL_Reg
166
167#endif
168