annotate src/lua/lauxlib.h @ 340:dea7e476eba7

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