9
3

lauxlib.h 8.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264
  1. /*
  2. ** $Id: lauxlib.h,v 1.131 2016/12/06 14:54:31 roberto Exp $
  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 "lua.h"
  11. /* extra error code for 'luaL_loadfilex' */
  12. #define LUA_ERRFILE (LUA_ERRERR+1)
  13. /* key, in the registry, for table of loaded modules */
  14. #define LUA_LOADED_TABLE "_LOADED"
  15. /* key, in the registry, for table of preloaded loaders */
  16. #define LUA_PRELOAD_TABLE "_PRELOAD"
  17. typedef struct luaL_Reg {
  18. const char *name;
  19. lua_CFunction func;
  20. } luaL_Reg;
  21. #define LUAL_NUMSIZES (sizeof(lua_Integer)*16 + sizeof(lua_Number))
  22. LUALIB_API void (luaL_checkversion_) (lua_State *L, lua_Number ver, size_t sz);
  23. #define luaL_checkversion(L) \
  24. luaL_checkversion_(L, LUA_VERSION_NUM, LUAL_NUMSIZES)
  25. LUALIB_API int (luaL_getmetafield) (lua_State *L, int obj, const char *e);
  26. LUALIB_API int (luaL_callmeta) (lua_State *L, int obj, const char *e);
  27. LUALIB_API const char *(luaL_tolstring) (lua_State *L, int idx, size_t *len);
  28. LUALIB_API int (luaL_argerror) (lua_State *L, int arg, const char *extramsg);
  29. LUALIB_API const char *(luaL_checklstring) (lua_State *L, int arg,
  30. size_t *l);
  31. LUALIB_API const char *(luaL_optlstring) (lua_State *L, int arg,
  32. const char *def, size_t *l);
  33. LUALIB_API lua_Number (luaL_checknumber) (lua_State *L, int arg);
  34. LUALIB_API lua_Number (luaL_optnumber) (lua_State *L, int arg, lua_Number def);
  35. LUALIB_API lua_Integer (luaL_checkinteger) (lua_State *L, int arg);
  36. LUALIB_API lua_Integer (luaL_optinteger) (lua_State *L, int arg,
  37. lua_Integer def);
  38. LUALIB_API void (luaL_checkstack) (lua_State *L, int sz, const char *msg);
  39. LUALIB_API void (luaL_checktype) (lua_State *L, int arg, int t);
  40. LUALIB_API void (luaL_checkany) (lua_State *L, int arg);
  41. LUALIB_API int (luaL_newmetatable) (lua_State *L, const char *tname);
  42. LUALIB_API void (luaL_setmetatable) (lua_State *L, const char *tname);
  43. LUALIB_API void *(luaL_testudata) (lua_State *L, int ud, const char *tname);
  44. LUALIB_API void *(luaL_checkudata) (lua_State *L, int ud, const char *tname);
  45. LUALIB_API void (luaL_where) (lua_State *L, int lvl);
  46. LUALIB_API int (luaL_error) (lua_State *L, const char *fmt, ...);
  47. LUALIB_API int (luaL_checkoption) (lua_State *L, int arg, const char *def,
  48. const char *const lst[]);
  49. LUALIB_API int (luaL_fileresult) (lua_State *L, int stat, const char *fname);
  50. LUALIB_API int (luaL_execresult) (lua_State *L, int stat);
  51. /* predefined references */
  52. #define LUA_NOREF (-2)
  53. #define LUA_REFNIL (-1)
  54. LUALIB_API int (luaL_ref) (lua_State *L, int t);
  55. LUALIB_API void (luaL_unref) (lua_State *L, int t, int ref);
  56. LUALIB_API int (luaL_loadfilex) (lua_State *L, const char *filename,
  57. const char *mode);
  58. #define luaL_loadfile(L,f) luaL_loadfilex(L,f,NULL)
  59. LUALIB_API int (luaL_loadbufferx) (lua_State *L, const char *buff, size_t sz,
  60. const char *name, const char *mode);
  61. LUALIB_API int (luaL_loadstring) (lua_State *L, const char *s);
  62. LUALIB_API lua_State *(luaL_newstate) (void);
  63. LUALIB_API lua_Integer (luaL_len) (lua_State *L, int idx);
  64. LUALIB_API const char *(luaL_gsub) (lua_State *L, const char *s, const char *p,
  65. const char *r);
  66. LUALIB_API void (luaL_setfuncs) (lua_State *L, const luaL_Reg *l, int nup);
  67. LUALIB_API int (luaL_getsubtable) (lua_State *L, int idx, const char *fname);
  68. LUALIB_API void (luaL_traceback) (lua_State *L, lua_State *L1,
  69. const char *msg, int level);
  70. LUALIB_API void (luaL_requiref) (lua_State *L, const char *modname,
  71. lua_CFunction openf, int glb);
  72. /*
  73. ** ===============================================================
  74. ** some useful macros
  75. ** ===============================================================
  76. */
  77. #define luaL_newlibtable(L,l) \
  78. lua_createtable(L, 0, sizeof(l)/sizeof((l)[0]) - 1)
  79. #define luaL_newlib(L,l) \
  80. (luaL_checkversion(L), luaL_newlibtable(L,l), luaL_setfuncs(L,l,0))
  81. #define luaL_argcheck(L, cond,arg,extramsg) \
  82. ((void)((cond) || luaL_argerror(L, (arg), (extramsg))))
  83. #define luaL_checkstring(L,n) (luaL_checklstring(L, (n), NULL))
  84. #define luaL_optstring(L,n,d) (luaL_optlstring(L, (n), (d), NULL))
  85. #define luaL_typename(L,i) lua_typename(L, lua_type(L,(i)))
  86. #define luaL_dofile(L, fn) \
  87. (luaL_loadfile(L, fn) || lua_pcall(L, 0, LUA_MULTRET, 0))
  88. #define luaL_dostring(L, s) \
  89. (luaL_loadstring(L, s) || lua_pcall(L, 0, LUA_MULTRET, 0))
  90. #define luaL_getmetatable(L,n) (lua_getfield(L, LUA_REGISTRYINDEX, (n)))
  91. #define luaL_opt(L,f,n,d) (lua_isnoneornil(L,(n)) ? (d) : f(L,(n)))
  92. #define luaL_loadbuffer(L,s,sz,n) luaL_loadbufferx(L,s,sz,n,NULL)
  93. /*
  94. ** {======================================================
  95. ** Generic Buffer manipulation
  96. ** =======================================================
  97. */
  98. typedef struct luaL_Buffer {
  99. char *b; /* buffer address */
  100. size_t size; /* buffer size */
  101. size_t n; /* number of characters in buffer */
  102. lua_State *L;
  103. char initb[LUAL_BUFFERSIZE]; /* initial buffer */
  104. } luaL_Buffer;
  105. #define luaL_addchar(B,c) \
  106. ((void)((B)->n < (B)->size || luaL_prepbuffsize((B), 1)), \
  107. ((B)->b[(B)->n++] = (c)))
  108. #define luaL_addsize(B,s) ((B)->n += (s))
  109. LUALIB_API void (luaL_buffinit) (lua_State *L, luaL_Buffer *B);
  110. LUALIB_API char *(luaL_prepbuffsize) (luaL_Buffer *B, size_t sz);
  111. LUALIB_API void (luaL_addlstring) (luaL_Buffer *B, const char *s, size_t l);
  112. LUALIB_API void (luaL_addstring) (luaL_Buffer *B, const char *s);
  113. LUALIB_API void (luaL_addvalue) (luaL_Buffer *B);
  114. LUALIB_API void (luaL_pushresult) (luaL_Buffer *B);
  115. LUALIB_API void (luaL_pushresultsize) (luaL_Buffer *B, size_t sz);
  116. LUALIB_API char *(luaL_buffinitsize) (lua_State *L, luaL_Buffer *B, size_t sz);
  117. #define luaL_prepbuffer(B) luaL_prepbuffsize(B, LUAL_BUFFERSIZE)
  118. /* }====================================================== */
  119. /*
  120. ** {======================================================
  121. ** File handles for IO library
  122. ** =======================================================
  123. */
  124. /*
  125. ** A file handle is a userdata with metatable 'LUA_FILEHANDLE' and
  126. ** initial structure 'luaL_Stream' (it may contain other fields
  127. ** after that initial structure).
  128. */
  129. #define LUA_FILEHANDLE "FILE*"
  130. typedef struct luaL_Stream {
  131. FILE *f; /* stream (NULL for incompletely created streams) */
  132. lua_CFunction closef; /* to close stream (NULL for closed streams) */
  133. } luaL_Stream;
  134. /* }====================================================== */
  135. /* compatibility with old module system */
  136. #if defined(LUA_COMPAT_MODULE)
  137. LUALIB_API void (luaL_pushmodule) (lua_State *L, const char *modname,
  138. int sizehint);
  139. LUALIB_API void (luaL_openlib) (lua_State *L, const char *libname,
  140. const luaL_Reg *l, int nup);
  141. #define luaL_register(L,n,l) (luaL_openlib(L,(n),(l),0))
  142. #endif
  143. /*
  144. ** {==================================================================
  145. ** "Abstraction Layer" for basic report of messages and errors
  146. ** ===================================================================
  147. */
  148. /* print a string */
  149. #if !defined(lua_writestring)
  150. #define lua_writestring(s,l) fwrite((s), sizeof(char), (l), stdout)
  151. #endif
  152. /* print a newline and flush the output */
  153. #if !defined(lua_writeline)
  154. #define lua_writeline() (lua_writestring("\n", 1), fflush(stdout))
  155. #endif
  156. /* print an error message */
  157. #if !defined(lua_writestringerror)
  158. #define lua_writestringerror(s,p) \
  159. (fprintf(stderr, (s), (p)), fflush(stderr))
  160. #endif
  161. /* }================================================================== */
  162. /*
  163. ** {============================================================
  164. ** Compatibility with deprecated conversions
  165. ** =============================================================
  166. */
  167. #if defined(LUA_COMPAT_APIINTCASTS)
  168. #define luaL_checkunsigned(L,a) ((lua_Unsigned)luaL_checkinteger(L,a))
  169. #define luaL_optunsigned(L,a,d) \
  170. ((lua_Unsigned)luaL_optinteger(L,a,(lua_Integer)(d)))
  171. #define luaL_checkint(L,n) ((int)luaL_checkinteger(L, (n)))
  172. #define luaL_optint(L,n,d) ((int)luaL_optinteger(L, (n), (d)))
  173. #define luaL_checklong(L,n) ((long)luaL_checkinteger(L, (n)))
  174. #define luaL_optlong(L,n,d) ((long)luaL_optinteger(L, (n), (d)))
  175. #endif
  176. /* }============================================================ */
  177. #endif