lauxlib.h 9.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304
  1. /*
  2. ** $Id: lauxlib.h $
  3. ** Auxiliary functions for building Lua libraries
  4. ** See Copyright Notice in lua.h
  5. */
  6. #ifndef lauxlib_h
  7. #define lauxlib_h
  8. #include <stddef.h>
  9. #include <stdio.h>
  10. #include "luaconf.h"
  11. #include "lua.h"
  12. /* global table */
  13. #define LUA_GNAME "_G"
  14. typedef struct luaL_Buffer luaL_Buffer;
  15. /* extra error code for 'luaL_loadfilex' */
  16. #define LUA_ERRFILE (LUA_ERRERR+1)
  17. /* key, in the registry, for table of loaded modules */
  18. #define LUA_LOADED_TABLE "_LOADED"
  19. /* key, in the registry, for table of preloaded loaders */
  20. #define LUA_PRELOAD_TABLE "_PRELOAD"
  21. typedef struct luaL_Reg {
  22. const char *name;
  23. lua_CFunction func;
  24. } luaL_Reg;
  25. #define LUAL_NUMSIZES (sizeof(lua_Integer)*16 + sizeof(lua_Number))
  26. LUALIB_API void (luaL_checkversion_) (lua_State *L, lua_Number ver, size_t sz);
  27. #define luaL_checkversion(L) \
  28. luaL_checkversion_(L, LUA_VERSION_NUM, LUAL_NUMSIZES)
  29. LUALIB_API int (luaL_getmetafield) (lua_State *L, int obj, const char *e);
  30. LUALIB_API int (luaL_callmeta) (lua_State *L, int obj, const char *e);
  31. LUALIB_API const char *(luaL_tolstring) (lua_State *L, int idx, size_t *len);
  32. LUALIB_API int (luaL_argerror) (lua_State *L, int arg, const char *extramsg);
  33. LUALIB_API int (luaL_typeerror) (lua_State *L, int arg, const char *tname);
  34. LUALIB_API const char *(luaL_checklstring) (lua_State *L, int arg,
  35. size_t *l);
  36. LUALIB_API const char *(luaL_optlstring) (lua_State *L, int arg,
  37. const char *def, size_t *l);
  38. LUALIB_API lua_Number (luaL_checknumber) (lua_State *L, int arg);
  39. LUALIB_API lua_Number (luaL_optnumber) (lua_State *L, int arg, lua_Number def);
  40. LUALIB_API lua_Integer (luaL_checkinteger) (lua_State *L, int arg);
  41. LUALIB_API lua_Integer (luaL_optinteger) (lua_State *L, int arg,
  42. lua_Integer def);
  43. LUALIB_API void (luaL_checkstack) (lua_State *L, int sz, const char *msg);
  44. LUALIB_API void (luaL_checktype) (lua_State *L, int arg, int t);
  45. LUALIB_API void (luaL_checkany) (lua_State *L, int arg);
  46. LUALIB_API int (luaL_newmetatable) (lua_State *L, const char *tname);
  47. LUALIB_API void (luaL_setmetatable) (lua_State *L, const char *tname);
  48. LUALIB_API void *(luaL_testudata) (lua_State *L, int ud, const char *tname);
  49. LUALIB_API void *(luaL_checkudata) (lua_State *L, int ud, const char *tname);
  50. LUALIB_API void (luaL_where) (lua_State *L, int lvl);
  51. LUALIB_API int (luaL_error) (lua_State *L, const char *fmt, ...);
  52. LUALIB_API int (luaL_checkoption) (lua_State *L, int arg, const char *def,
  53. const char *const lst[]);
  54. LUALIB_API int (luaL_fileresult) (lua_State *L, int stat, const char *fname);
  55. LUALIB_API int (luaL_execresult) (lua_State *L, int stat);
  56. /* predefined references */
  57. #define LUA_NOREF (-2)
  58. #define LUA_REFNIL (-1)
  59. LUALIB_API int (luaL_ref) (lua_State *L, int t);
  60. LUALIB_API void (luaL_unref) (lua_State *L, int t, int ref);
  61. LUALIB_API int (luaL_loadfilex) (lua_State *L, const char *filename,
  62. const char *mode);
  63. LUALIB_API int (luaL_loadfilex_) (lua_State *L, const char *filename,
  64. const char *mode);
  65. #define luaL_loadfile(L,f) luaL_loadfilex(L,f,NULL)
  66. LUALIB_API int (luaL_loadbufferx) (lua_State *L, const char *buff, size_t sz,
  67. const char *name, const char *mode);
  68. LUALIB_API int (luaL_loadstring) (lua_State *L, const char *s);
  69. LUALIB_API lua_State *(luaL_newstate) (void);
  70. LUALIB_API lua_Integer (luaL_len) (lua_State *L, int idx);
  71. LUALIB_API void (luaL_addgsub) (luaL_Buffer *b, const char *s,
  72. const char *p, const char *r);
  73. LUALIB_API const char *(luaL_gsub) (lua_State *L, const char *s,
  74. const char *p, const char *r);
  75. LUALIB_API void (luaL_setfuncs) (lua_State *L, const luaL_Reg *l, int nup);
  76. LUALIB_API int (luaL_getsubtable) (lua_State *L, int idx, const char *fname);
  77. LUALIB_API void (luaL_traceback) (lua_State *L, lua_State *L1,
  78. const char *msg, int level);
  79. LUALIB_API void (luaL_requiref) (lua_State *L, const char *modname,
  80. lua_CFunction openf, int glb);
  81. /*
  82. ** ===============================================================
  83. ** some useful macros
  84. ** ===============================================================
  85. */
  86. #define luaL_newlibtable(L,l) \
  87. lua_createtable(L, 0, sizeof(l)/sizeof((l)[0]) - 1)
  88. #define luaL_newlib(L,l) \
  89. (luaL_checkversion(L), luaL_newlibtable(L,l), luaL_setfuncs(L,l,0))
  90. #define luaL_argcheck(L, cond,arg,extramsg) \
  91. ((void)(luai_likely(cond) || luaL_argerror(L, (arg), (extramsg))))
  92. #define luaL_argexpected(L,cond,arg,tname) \
  93. ((void)(luai_likely(cond) || luaL_typeerror(L, (arg), (tname))))
  94. #define luaL_checkstring(L,n) (luaL_checklstring(L, (n), NULL))
  95. #define luaL_optstring(L,n,d) (luaL_optlstring(L, (n), (d), NULL))
  96. #define luaL_typename(L,i) lua_typename(L, lua_type(L,(i)))
  97. #define luaL_dofile(L, fn) \
  98. (luaL_loadfile(L, fn) || lua_pcall(L, 0, LUA_MULTRET, 0))
  99. #define luaL_dostring(L, s) \
  100. (luaL_loadstring(L, s) || lua_pcall(L, 0, LUA_MULTRET, 0))
  101. #define luaL_getmetatable(L,n) (lua_getfield(L, LUA_REGISTRYINDEX, (n)))
  102. #define luaL_opt(L,f,n,d) (lua_isnoneornil(L,(n)) ? (d) : f(L,(n)))
  103. #define luaL_loadbuffer(L,s,sz,n) luaL_loadbufferx(L,s,sz,n,NULL)
  104. /*
  105. ** Perform arithmetic operations on lua_Integer values with wrap-around
  106. ** semantics, as the Lua core does.
  107. */
  108. #define luaL_intop(op,v1,v2) \
  109. ((lua_Integer)((lua_Unsigned)(v1) op (lua_Unsigned)(v2)))
  110. /* push the value used to represent failure/error */
  111. #define luaL_pushfail(L) lua_pushnil(L)
  112. /*
  113. ** Internal assertions for in-house debugging
  114. */
  115. #if !defined(lua_assert)
  116. #if defined LUAI_ASSERT
  117. #include <assert.h>
  118. #define lua_assert(c) assert(c)
  119. #else
  120. #define lua_assert(c) ((void)0)
  121. #endif
  122. #endif
  123. /*
  124. ** {======================================================
  125. ** Generic Buffer manipulation
  126. ** =======================================================
  127. */
  128. struct luaL_Buffer {
  129. char *b; /* buffer address */
  130. size_t size; /* buffer size */
  131. size_t n; /* number of characters in buffer */
  132. lua_State *L;
  133. union {
  134. LUAI_MAXALIGN; /* ensure maximum alignment for buffer */
  135. char b[LUAL_BUFFERSIZE]; /* initial buffer */
  136. } init;
  137. };
  138. #define luaL_bufflen(bf) ((bf)->n)
  139. #define luaL_buffaddr(bf) ((bf)->b)
  140. #define luaL_addchar(B,c) \
  141. ((void)((B)->n < (B)->size || luaL_prepbuffsize((B), 1)), \
  142. ((B)->b[(B)->n++] = (c)))
  143. #define luaL_addsize(B,s) ((B)->n += (s))
  144. #define luaL_buffsub(B,s) ((B)->n -= (s))
  145. LUALIB_API void (luaL_buffinit) (lua_State *L, luaL_Buffer *B);
  146. LUALIB_API char *(luaL_prepbuffsize) (luaL_Buffer *B, size_t sz);
  147. LUALIB_API void (luaL_addlstring) (luaL_Buffer *B, const char *s, size_t l);
  148. LUALIB_API void (luaL_addstring) (luaL_Buffer *B, const char *s);
  149. LUALIB_API void (luaL_addvalue) (luaL_Buffer *B);
  150. LUALIB_API void (luaL_pushresult) (luaL_Buffer *B);
  151. LUALIB_API void (luaL_pushresultsize) (luaL_Buffer *B, size_t sz);
  152. LUALIB_API char *(luaL_buffinitsize) (lua_State *L, luaL_Buffer *B, size_t sz);
  153. #define luaL_prepbuffer(B) luaL_prepbuffsize(B, LUAL_BUFFERSIZE)
  154. /* }====================================================== */
  155. /*
  156. ** {======================================================
  157. ** File handles for IO library
  158. ** =======================================================
  159. */
  160. /*
  161. ** A file handle is a userdata with metatable 'LUA_FILEHANDLE' and
  162. ** initial structure 'luaL_Stream' (it may contain other fields
  163. ** after that initial structure).
  164. */
  165. #define LUA_FILEHANDLE "FILE*"
  166. typedef struct luaL_Stream {
  167. FILE *f; /* stream (NULL for incompletely created streams) */
  168. lua_CFunction closef; /* to close stream (NULL for closed streams) */
  169. } luaL_Stream;
  170. /* }====================================================== */
  171. /*
  172. ** {==================================================================
  173. ** "Abstraction Layer" for basic report of messages and errors
  174. ** ===================================================================
  175. */
  176. /* print a string */
  177. #if !defined(lua_writestring)
  178. #define lua_writestring(s,l) fwrite((s), sizeof(char), (l), stdout)
  179. #endif
  180. /* print a newline and flush the output */
  181. #if !defined(lua_writeline)
  182. #define lua_writeline() (lua_writestring("\n", 1), fflush(stdout))
  183. #endif
  184. /* print an error message */
  185. #if !defined(lua_writestringerror)
  186. #define lua_writestringerror(s,p) \
  187. (fprintf(stderr, (s), (p)), fflush(stderr))
  188. #endif
  189. /* }================================================================== */
  190. /*
  191. ** {============================================================
  192. ** Compatibility with deprecated conversions
  193. ** =============================================================
  194. */
  195. #if defined(LUA_COMPAT_APIINTCASTS)
  196. #define luaL_checkunsigned(L,a) ((lua_Unsigned)luaL_checkinteger(L,a))
  197. #define luaL_optunsigned(L,a,d) \
  198. ((lua_Unsigned)luaL_optinteger(L,a,(lua_Integer)(d)))
  199. #define luaL_checkint(L,n) ((int)luaL_checkinteger(L, (n)))
  200. #define luaL_optint(L,n,d) ((int)luaL_optinteger(L, (n), (d)))
  201. #define luaL_checklong(L,n) ((long)luaL_checkinteger(L, (n)))
  202. #define luaL_optlong(L,n,d) ((long)luaL_optinteger(L, (n), (d)))
  203. #endif
  204. /* }============================================================ */
  205. #endif