lauxlib.h 9.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292
  1. /*
  2. ** $Id: lauxlib.h,v 1.131.1.1 2017/04/19 17:20:42 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 int (luaL_rometatable) (lua_State *L, const char* tname, const ROTable *p);
  46. LUALIB_API void (luaL_where) (lua_State *L, int lvl);
  47. LUALIB_API int (luaL_error) (lua_State *L, const char *fmt, ...);
  48. LUALIB_API int (luaL_checkoption) (lua_State *L, int arg, const char *def,
  49. const char *const lst[]);
  50. LUALIB_API int (luaL_fileresult) (lua_State *L, int stat, const char *fname);
  51. LUALIB_API int (luaL_execresult) (lua_State *L, int stat);
  52. /* predefined references */
  53. #define LUA_NOREF (-2)
  54. #define LUA_REFNIL (-1)
  55. LUALIB_API int (luaL_ref) (lua_State *L, int t);
  56. LUALIB_API void (luaL_unref) (lua_State *L, int t, int ref);
  57. #define luaL_unref2(l,t,r) luaL_unref(L, (t), (r)); r = LUA_NOREF
  58. LUALIB_API void (luaL_reref) (lua_State *L, int t, int *ref);
  59. LUALIB_API int (luaL_loadfilex) (lua_State *L, const char *filename,
  60. const char *mode);
  61. #define luaL_loadfile(L,f) luaL_loadfilex(L,f,NULL)
  62. LUALIB_API int (luaL_loadbufferx) (lua_State *L, const char *buff, size_t sz,
  63. const char *name, const char *mode);
  64. LUALIB_API int (luaL_loadstring) (lua_State *L, const char *s);
  65. LUALIB_API lua_State *(luaL_newstate) (void);
  66. LUALIB_API lua_Integer (luaL_len) (lua_State *L, int idx);
  67. LUALIB_API const char *(luaL_gsub) (lua_State *L, const char *s, const char *p,
  68. const char *r);
  69. LUALIB_API void (luaL_setfuncs) (lua_State *L, const luaL_Reg *l, int nup);
  70. LUALIB_API int (luaL_getsubtable) (lua_State *L, int idx, const char *fname);
  71. LUALIB_API void (luaL_traceback) (lua_State *L, lua_State *L1,
  72. const char *msg, int level);
  73. LUALIB_API void (luaL_requiref) (lua_State *L, const char *modname,
  74. lua_CFunction openf, int glb);
  75. /*
  76. ** ===============================================================
  77. ** some useful macros
  78. ** ===============================================================
  79. */
  80. #define luaL_newlibtable(L,l) \
  81. lua_createtable(L, 0, sizeof(l)/sizeof((l)[0]) - 1)
  82. #define luaL_newlib(L,l) \
  83. (luaL_checkversion(L), luaL_newlibtable(L,l), luaL_setfuncs(L,l,0))
  84. #define luaL_argcheck(L, cond,arg,extramsg) \
  85. ((void)((cond) || luaL_argerror(L, (arg), (extramsg))))
  86. #define luaL_checkstring(L,n) (luaL_checklstring(L, (n), NULL))
  87. #define luaL_optstring(L,n,d) (luaL_optlstring(L, (n), (d), NULL))
  88. #define luaL_typename(L,i) lua_typename(L, lua_type(L,(i)))
  89. #define luaL_dofile(L, fn) \
  90. (luaL_loadfile(L, fn) || lua_pcall(L, 0, LUA_MULTRET, 0))
  91. #define luaL_dostring(L, s) \
  92. (luaL_loadstring(L, s) || lua_pcall(L, 0, LUA_MULTRET, 0))
  93. #define luaL_getmetatable(L,n) (lua_getfield(L, LUA_REGISTRYINDEX, (n)))
  94. #define luaL_opt(L,f,n,d) (lua_isnoneornil(L,(n)) ? (d) : f(L,(n)))
  95. #define luaL_loadbuffer(L,s,sz,n) luaL_loadbufferx(L,s,sz,n,NULL)
  96. /*
  97. ** {======================================================
  98. ** Generic Buffer manipulation
  99. ** =======================================================
  100. */
  101. typedef struct luaL_Buffer {
  102. char *b; /* buffer address */
  103. size_t size; /* buffer size */
  104. size_t n; /* number of characters in buffer */
  105. lua_State *L;
  106. char initb[LUAL_BUFFERSIZE]; /* initial buffer */
  107. } luaL_Buffer;
  108. #define luaL_addchar(B,c) \
  109. ((void)((B)->n < (B)->size || luaL_prepbuffsize((B), 1)), \
  110. ((B)->b[(B)->n++] = (c)))
  111. #define luaL_addsize(B,s) ((B)->n += (s))
  112. LUALIB_API void (luaL_buffinit) (lua_State *L, luaL_Buffer *B);
  113. LUALIB_API char *(luaL_prepbuffsize) (luaL_Buffer *B, size_t sz);
  114. LUALIB_API void (luaL_addlstring) (luaL_Buffer *B, const char *s, size_t l);
  115. LUALIB_API void (luaL_addstring) (luaL_Buffer *B, const char *s);
  116. LUALIB_API void (luaL_addvalue) (luaL_Buffer *B);
  117. LUALIB_API void (luaL_pushresult) (luaL_Buffer *B);
  118. LUALIB_API void (luaL_pushresultsize) (luaL_Buffer *B, size_t sz);
  119. LUALIB_API char *(luaL_buffinitsize) (lua_State *L, luaL_Buffer *B, size_t sz);
  120. #define luaL_prepbuffer(B) luaL_prepbuffsize(B, LUAL_BUFFERSIZE)
  121. /* }====================================================== */
  122. /*
  123. ** {======================================================
  124. ** File handles for IO library
  125. ** =======================================================
  126. */
  127. /*
  128. ** A file handle is a userdata with metatable 'LUA_FILEHANDLE' and
  129. ** initial structure 'luaL_Stream' (it may contain other fields
  130. ** after that initial structure).
  131. */
  132. #define LUA_FILEHANDLE "FILE*"
  133. typedef struct luaL_Stream {
  134. FILE *f; /* stream (NULL for incompletely created streams) */
  135. lua_CFunction closef; /* to close stream (NULL for closed streams) */
  136. } luaL_Stream;
  137. /* }====================================================== */
  138. LUALIB_API int (luaL_rometatable) (lua_State *L, const char* tname, const ROTable *t);
  139. /* }====================================================== */
  140. /* compatibility with old module system */
  141. #if defined(LUA_COMPAT_MODULE)
  142. LUALIB_API void (luaL_pushmodule) (lua_State *L, const char *modname,
  143. int sizehint);
  144. LUALIB_API void (luaL_openlib) (lua_State *L, const char *libname,
  145. const luaL_Reg *l, int nup);
  146. #define luaL_register(L,n,l) (luaL_openlib(L,(n),(l),0))
  147. #endif
  148. /*
  149. ** {==================================================================
  150. ** "Abstraction Layer" for basic report of messages and errors
  151. ** ===================================================================
  152. */
  153. /* print a string */
  154. #if !defined(lua_writestring)
  155. #ifdef LUA_USE_ESP8266
  156. #define lua_writestring(s,l) output_redirect((s),(l))
  157. #else
  158. #define lua_writestring(s,l) fwrite((s), sizeof(char), (l), stdout)
  159. #endif
  160. #endif
  161. /* print a newline and flush the output */
  162. #if !defined(lua_writeline)
  163. #ifdef LUA_USE_ESP8266
  164. #define lua_writeline() lua_writestring("\n", 1)
  165. #else
  166. #define lua_writeline() (lua_writestring("\n", 1), fflush(stdout))
  167. #endif
  168. #endif
  169. /* print an error message. This is a primitive error output */
  170. #if !defined(lua_writestringerror)
  171. #ifdef LUA_USE_ESP8266
  172. extern void dbg_printf(const char *fmt, ...);
  173. #define lua_writestringerror(s,p) dbg_printf((s), (p))
  174. #else
  175. #define lua_writestringerror(s,p) (fprintf(stderr, (s), (p)), fflush(stderr))
  176. #endif
  177. #endif
  178. /* }================================================================== */
  179. /*
  180. ** {============================================================
  181. ** Compatibility with deprecated conversions
  182. ** =============================================================
  183. */
  184. #if defined(LUA_COMPAT_APIINTCASTS)
  185. #define luaL_checkunsigned(L,a) ((lua_Unsigned)luaL_checkinteger(L,a))
  186. #define luaL_optunsigned(L,a,d) \
  187. ((lua_Unsigned)luaL_optinteger(L,a,(lua_Integer)(d)))
  188. #define luaL_checkint(L,n) ((int)luaL_checkinteger(L, (n)))
  189. #define luaL_optint(L,n,d) ((int)luaL_optinteger(L, (n), (d)))
  190. #define luaL_checklong(L,n) ((long)luaL_checkinteger(L, (n)))
  191. #define luaL_optlong(L,n,d) ((long)luaL_optinteger(L, (n), (d)))
  192. #endif
  193. /* }============================================================ */
  194. /*
  195. ** {==================================================================
  196. ** NodeMCU extensions
  197. ** ===================================================================
  198. */
  199. #define LUA_TASK_LOW 0
  200. #define LUA_TASK_MEDIUM 1
  201. #define LUA_TASK_HIGH 2
  202. LUALIB_API int (luaL_posttask) (lua_State* L, int prio);
  203. LUALIB_API int (luaL_pcallx) (lua_State *L, int narg, int nres);
  204. /* }============================================================ */
  205. #endif