duktape.h 68 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349
  1. /*
  2. * Duktape public API for Duktape 2.2.0.
  3. *
  4. * See the API reference for documentation on call semantics. The exposed,
  5. * supported API is between the "BEGIN PUBLIC API" and "END PUBLIC API"
  6. * comments. Other parts of the header are Duktape internal and related to
  7. * e.g. platform/compiler/feature detection.
  8. *
  9. * Git commit a459cf3c9bd1779fc01b435d69302b742675a08f (v2.2.0).
  10. * Git branch master.
  11. *
  12. * See Duktape AUTHORS.rst and LICENSE.txt for copyright and
  13. * licensing information.
  14. */
  15. /* LICENSE.txt */
  16. /*
  17. * ===============
  18. * Duktape license
  19. * ===============
  20. *
  21. * (http://opensource.org/licenses/MIT)
  22. *
  23. * Copyright (c) 2013-2017 by Duktape authors (see AUTHORS.rst)
  24. *
  25. * Permission is hereby granted, free of charge, to any person obtaining a copy
  26. * of this software and associated documentation files (the "Software"), to deal
  27. * in the Software without restriction, including without limitation the rights
  28. * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  29. * copies of the Software, and to permit persons to whom the Software is
  30. * furnished to do so, subject to the following conditions:
  31. *
  32. * The above copyright notice and this permission notice shall be included in
  33. * all copies or substantial portions of the Software.
  34. *
  35. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  36. * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  37. * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  38. * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  39. * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  40. * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  41. * THE SOFTWARE.
  42. */
  43. /* AUTHORS.rst */
  44. /*
  45. * ===============
  46. * Duktape authors
  47. * ===============
  48. *
  49. * Copyright
  50. * =========
  51. *
  52. * Duktape copyrights are held by its authors. Each author has a copyright
  53. * to their contribution, and agrees to irrevocably license the contribution
  54. * under the Duktape ``LICENSE.txt``.
  55. *
  56. * Authors
  57. * =======
  58. *
  59. * Please include an e-mail address, a link to your GitHub profile, or something
  60. * similar to allow your contribution to be identified accurately.
  61. *
  62. * The following people have contributed code, website contents, or Wiki contents,
  63. * and agreed to irrevocably license their contributions under the Duktape
  64. * ``LICENSE.txt`` (in order of appearance):
  65. *
  66. * * Sami Vaarala <sami.vaarala@iki.fi>
  67. * * Niki Dobrev
  68. * * Andreas \u00d6man <andreas@lonelycoder.com>
  69. * * L\u00e1szl\u00f3 Lang\u00f3 <llango.u-szeged@partner.samsung.com>
  70. * * Legimet <legimet.calc@gmail.com>
  71. * * Karl Skomski <karl@skomski.com>
  72. * * Bruce Pascoe <fatcerberus1@gmail.com>
  73. * * Ren\u00e9 Hollander <rene@rene8888.at>
  74. * * Julien Hamaide (https://github.com/crazyjul)
  75. * * Sebastian G\u00f6tte (https://github.com/jaseg)
  76. * * Tomasz Magulski (https://github.com/magul)
  77. * * \D. Bohdan (https://github.com/dbohdan)
  78. * * Ond\u0159ej Jirman (https://github.com/megous)
  79. * * Sa\u00fal Ibarra Corretg\u00e9 <saghul@gmail.com>
  80. * * Jeremy HU <huxingyi@msn.com>
  81. * * Ole Andr\u00e9 Vadla Ravn\u00e5s (https://github.com/oleavr)
  82. * * Harold Brenes (https://github.com/harold-b)
  83. * * Oliver Crow (https://github.com/ocrow)
  84. * * Jakub Ch\u0142api\u0144ski (https://github.com/jchlapinski)
  85. * * Brett Vickers (https://github.com/beevik)
  86. * * Dominik Okwieka (https://github.com/okitec)
  87. * * Remko Tron\u00e7on (https://el-tramo.be)
  88. * * Romero Malaquias (rbsm@ic.ufal.br)
  89. * * Michael Drake <michael.drake@codethink.co.uk>
  90. * * Steven Don (https://github.com/shdon)
  91. * * Simon Stone (https://github.com/sstone1)
  92. * * \J. McC. (https://github.com/jmhmccr)
  93. *
  94. * Other contributions
  95. * ===================
  96. *
  97. * The following people have contributed something other than code (e.g. reported
  98. * bugs, provided ideas, etc; roughly in order of appearance):
  99. *
  100. * * Greg Burns
  101. * * Anthony Rabine
  102. * * Carlos Costa
  103. * * Aur\u00e9lien Bouilland
  104. * * Preet Desai (Pris Matic)
  105. * * judofyr (http://www.reddit.com/user/judofyr)
  106. * * Jason Woofenden
  107. * * Micha\u0142 Przyby\u015b
  108. * * Anthony Howe
  109. * * Conrad Pankoff
  110. * * Jim Schimpf
  111. * * Rajaran Gaunker (https://github.com/zimbabao)
  112. * * Andreas \u00d6man
  113. * * Doug Sanden
  114. * * Josh Engebretson (https://github.com/JoshEngebretson)
  115. * * Remo Eichenberger (https://github.com/remoe)
  116. * * Mamod Mehyar (https://github.com/mamod)
  117. * * David Demelier (https://github.com/markand)
  118. * * Tim Caswell (https://github.com/creationix)
  119. * * Mitchell Blank Jr (https://github.com/mitchblank)
  120. * * https://github.com/yushli
  121. * * Seo Sanghyeon (https://github.com/sanxiyn)
  122. * * Han ChoongWoo (https://github.com/tunz)
  123. * * Joshua Peek (https://github.com/josh)
  124. * * Bruce E. Pascoe (https://github.com/fatcerberus)
  125. * * https://github.com/Kelledin
  126. * * https://github.com/sstruchtrup
  127. * * Michael Drake (https://github.com/tlsa)
  128. * * https://github.com/chris-y
  129. * * Laurent Zubiaur (https://github.com/lzubiaur)
  130. * * Neil Kolban (https://github.com/nkolban)
  131. *
  132. * If you are accidentally missing from this list, send me an e-mail
  133. * (``sami.vaarala@iki.fi``) and I'll fix the omission.
  134. */
  135. #if !defined(DUKTAPE_H_INCLUDED)
  136. #define DUKTAPE_H_INCLUDED
  137. #define DUK_SINGLE_FILE
  138. /*
  139. * BEGIN PUBLIC API
  140. */
  141. /*
  142. * Version and Git commit identification
  143. */
  144. /* Duktape version, (major * 10000) + (minor * 100) + patch. Allows C code
  145. * to #if (DUK_VERSION >= NNN) against Duktape API version. The same value
  146. * is also available to Ecmascript code in Duktape.version. Unofficial
  147. * development snapshots have 99 for patch level (e.g. 0.10.99 would be a
  148. * development version after 0.10.0 but before the next official release).
  149. */
  150. #define DUK_VERSION 20200L
  151. /* Git commit, describe, and branch for Duktape build. Useful for
  152. * non-official snapshot builds so that application code can easily log
  153. * which Duktape snapshot was used. Not available in the Ecmascript
  154. * environment.
  155. */
  156. #define DUK_GIT_COMMIT "a459cf3c9bd1779fc01b435d69302b742675a08f"
  157. #define DUK_GIT_DESCRIBE "v2.2.0"
  158. #define DUK_GIT_BRANCH "master"
  159. /* External duk_config.h provides platform/compiler/OS dependent
  160. * typedefs and macros, and DUK_USE_xxx config options so that
  161. * the rest of Duktape doesn't need to do any feature detection.
  162. * DUK_VERSION is defined before including so that configuration
  163. * snippets can react to it.
  164. */
  165. #include "duk_config.h"
  166. /*
  167. * Avoid C++ name mangling
  168. */
  169. #if defined(__cplusplus)
  170. extern "C" {
  171. #endif
  172. /*
  173. * Some defines forwarded from feature detection
  174. */
  175. #undef DUK_API_VARIADIC_MACROS
  176. #if defined(DUK_USE_VARIADIC_MACROS)
  177. #define DUK_API_VARIADIC_MACROS
  178. #endif
  179. #define DUK_API_NORETURN(decl) DUK_NORETURN(decl)
  180. /*
  181. * Public API specific typedefs
  182. *
  183. * Many types are wrapped by Duktape for portability to rare platforms
  184. * where e.g. 'int' is a 16-bit type. See practical typing discussion
  185. * in Duktape web documentation.
  186. */
  187. struct duk_thread_state;
  188. struct duk_memory_functions;
  189. struct duk_function_list_entry;
  190. struct duk_number_list_entry;
  191. struct duk_time_components;
  192. /* duk_context is now defined in duk_config.h because it may also be
  193. * referenced there by prototypes.
  194. */
  195. typedef struct duk_thread_state duk_thread_state;
  196. typedef struct duk_memory_functions duk_memory_functions;
  197. typedef struct duk_function_list_entry duk_function_list_entry;
  198. typedef struct duk_number_list_entry duk_number_list_entry;
  199. typedef struct duk_time_components duk_time_components;
  200. typedef duk_ret_t (*duk_c_function)(duk_context *ctx);
  201. typedef void *(*duk_alloc_function) (void *udata, duk_size_t size);
  202. typedef void *(*duk_realloc_function) (void *udata, void *ptr, duk_size_t size);
  203. typedef void (*duk_free_function) (void *udata, void *ptr);
  204. typedef void (*duk_fatal_function) (void *udata, const char *msg);
  205. typedef void (*duk_decode_char_function) (void *udata, duk_codepoint_t codepoint);
  206. typedef duk_codepoint_t (*duk_map_char_function) (void *udata, duk_codepoint_t codepoint);
  207. typedef duk_ret_t (*duk_safe_call_function) (duk_context *ctx, void *udata);
  208. typedef duk_size_t (*duk_debug_read_function) (void *udata, char *buffer, duk_size_t length);
  209. typedef duk_size_t (*duk_debug_write_function) (void *udata, const char *buffer, duk_size_t length);
  210. typedef duk_size_t (*duk_debug_peek_function) (void *udata);
  211. typedef void (*duk_debug_read_flush_function) (void *udata);
  212. typedef void (*duk_debug_write_flush_function) (void *udata);
  213. typedef duk_idx_t (*duk_debug_request_function) (duk_context *ctx, void *udata, duk_idx_t nvalues);
  214. typedef void (*duk_debug_detached_function) (duk_context *ctx, void *udata);
  215. struct duk_thread_state {
  216. /* XXX: Enough space to hold internal suspend/resume structure.
  217. * This is rather awkward and to be fixed when the internal
  218. * structure is visible for the public API header.
  219. */
  220. char data[128];
  221. };
  222. struct duk_memory_functions {
  223. duk_alloc_function alloc_func;
  224. duk_realloc_function realloc_func;
  225. duk_free_function free_func;
  226. void *udata;
  227. };
  228. struct duk_function_list_entry {
  229. const char *key;
  230. duk_c_function value;
  231. duk_idx_t nargs;
  232. };
  233. struct duk_number_list_entry {
  234. const char *key;
  235. duk_double_t value;
  236. };
  237. struct duk_time_components {
  238. duk_double_t year; /* year, e.g. 2016, Ecmascript year range */
  239. duk_double_t month; /* month: 1-12 */
  240. duk_double_t day; /* day: 1-31 */
  241. duk_double_t hours; /* hour: 0-59 */
  242. duk_double_t minutes; /* minute: 0-59 */
  243. duk_double_t seconds; /* second: 0-59 (in POSIX time no leap second) */
  244. duk_double_t milliseconds; /* may contain sub-millisecond fractions */
  245. duk_double_t weekday; /* weekday: 0-6, 0=Sunday, 1=Monday, ..., 6=Saturday */
  246. };
  247. /*
  248. * Constants
  249. */
  250. /* Duktape debug protocol version used by this build. */
  251. #define DUK_DEBUG_PROTOCOL_VERSION 2
  252. /* Used to represent invalid index; if caller uses this without checking,
  253. * this index will map to a non-existent stack entry. Also used in some
  254. * API calls as a marker to denote "no value".
  255. */
  256. #define DUK_INVALID_INDEX DUK_IDX_MIN
  257. /* Indicates that a native function does not have a fixed number of args,
  258. * and the argument stack should not be capped/extended at all.
  259. */
  260. #define DUK_VARARGS ((duk_int_t) (-1))
  261. /* Number of value stack entries (in addition to actual call arguments)
  262. * guaranteed to be allocated on entry to a Duktape/C function.
  263. */
  264. #define DUK_API_ENTRY_STACK 64U
  265. /* Value types, used by e.g. duk_get_type() */
  266. #define DUK_TYPE_MIN 0U
  267. #define DUK_TYPE_NONE 0U /* no value, e.g. invalid index */
  268. #define DUK_TYPE_UNDEFINED 1U /* Ecmascript undefined */
  269. #define DUK_TYPE_NULL 2U /* Ecmascript null */
  270. #define DUK_TYPE_BOOLEAN 3U /* Ecmascript boolean: 0 or 1 */
  271. #define DUK_TYPE_NUMBER 4U /* Ecmascript number: double */
  272. #define DUK_TYPE_STRING 5U /* Ecmascript string: CESU-8 / extended UTF-8 encoded */
  273. #define DUK_TYPE_OBJECT 6U /* Ecmascript object: includes objects, arrays, functions, threads */
  274. #define DUK_TYPE_BUFFER 7U /* fixed or dynamic, garbage collected byte buffer */
  275. #define DUK_TYPE_POINTER 8U /* raw void pointer */
  276. #define DUK_TYPE_LIGHTFUNC 9U /* lightweight function pointer */
  277. #define DUK_TYPE_MAX 9U
  278. /* Value mask types, used by e.g. duk_get_type_mask() */
  279. #define DUK_TYPE_MASK_NONE (1U << DUK_TYPE_NONE)
  280. #define DUK_TYPE_MASK_UNDEFINED (1U << DUK_TYPE_UNDEFINED)
  281. #define DUK_TYPE_MASK_NULL (1U << DUK_TYPE_NULL)
  282. #define DUK_TYPE_MASK_BOOLEAN (1U << DUK_TYPE_BOOLEAN)
  283. #define DUK_TYPE_MASK_NUMBER (1U << DUK_TYPE_NUMBER)
  284. #define DUK_TYPE_MASK_STRING (1U << DUK_TYPE_STRING)
  285. #define DUK_TYPE_MASK_OBJECT (1U << DUK_TYPE_OBJECT)
  286. #define DUK_TYPE_MASK_BUFFER (1U << DUK_TYPE_BUFFER)
  287. #define DUK_TYPE_MASK_POINTER (1U << DUK_TYPE_POINTER)
  288. #define DUK_TYPE_MASK_LIGHTFUNC (1U << DUK_TYPE_LIGHTFUNC)
  289. #define DUK_TYPE_MASK_THROW (1U << 10) /* internal flag value: throw if mask doesn't match */
  290. #define DUK_TYPE_MASK_PROMOTE (1U << 11) /* internal flag value: promote to object if mask matches */
  291. /* Coercion hints */
  292. #define DUK_HINT_NONE 0 /* prefer number, unless input is a Date, in which
  293. * case prefer string (E5 Section 8.12.8)
  294. */
  295. #define DUK_HINT_STRING 1 /* prefer string */
  296. #define DUK_HINT_NUMBER 2 /* prefer number */
  297. /* Enumeration flags for duk_enum() */
  298. #define DUK_ENUM_INCLUDE_NONENUMERABLE (1U << 0) /* enumerate non-numerable properties in addition to enumerable */
  299. #define DUK_ENUM_INCLUDE_HIDDEN (1U << 1) /* enumerate hidden symbols too (in Duktape 1.x called internal properties) */
  300. #define DUK_ENUM_INCLUDE_SYMBOLS (1U << 2) /* enumerate symbols */
  301. #define DUK_ENUM_EXCLUDE_STRINGS (1U << 3) /* exclude strings */
  302. #define DUK_ENUM_OWN_PROPERTIES_ONLY (1U << 4) /* don't walk prototype chain, only check own properties */
  303. #define DUK_ENUM_ARRAY_INDICES_ONLY (1U << 5) /* only enumerate array indices */
  304. /* XXX: misleading name */
  305. #define DUK_ENUM_SORT_ARRAY_INDICES (1U << 6) /* sort array indices (applied to full enumeration result, including inherited array indices); XXX: misleading name */
  306. #define DUK_ENUM_NO_PROXY_BEHAVIOR (1U << 7) /* enumerate a proxy object itself without invoking proxy behavior */
  307. /* Compilation flags for duk_compile() and duk_eval() */
  308. /* DUK_COMPILE_xxx bits 0-2 are reserved for an internal 'nargs' argument.
  309. */
  310. #define DUK_COMPILE_EVAL (1U << 3) /* compile eval code (instead of global code) */
  311. #define DUK_COMPILE_FUNCTION (1U << 4) /* compile function code (instead of global code) */
  312. #define DUK_COMPILE_STRICT (1U << 5) /* use strict (outer) context for global, eval, or function code */
  313. #define DUK_COMPILE_SHEBANG (1U << 6) /* allow shebang ('#! ...') comment on first line of source */
  314. #define DUK_COMPILE_SAFE (1U << 7) /* (internal) catch compilation errors */
  315. #define DUK_COMPILE_NORESULT (1U << 8) /* (internal) omit eval result */
  316. #define DUK_COMPILE_NOSOURCE (1U << 9) /* (internal) no source string on stack */
  317. #define DUK_COMPILE_STRLEN (1U << 10) /* (internal) take strlen() of src_buffer (avoids double evaluation in macro) */
  318. #define DUK_COMPILE_NOFILENAME (1U << 11) /* (internal) no filename on stack */
  319. #define DUK_COMPILE_FUNCEXPR (1U << 12) /* (internal) source is a function expression (used for Function constructor) */
  320. /* Flags for duk_def_prop() and its variants; base flags + a lot of convenience shorthands */
  321. #define DUK_DEFPROP_WRITABLE (1U << 0) /* set writable (effective if DUK_DEFPROP_HAVE_WRITABLE set) */
  322. #define DUK_DEFPROP_ENUMERABLE (1U << 1) /* set enumerable (effective if DUK_DEFPROP_HAVE_ENUMERABLE set) */
  323. #define DUK_DEFPROP_CONFIGURABLE (1U << 2) /* set configurable (effective if DUK_DEFPROP_HAVE_CONFIGURABLE set) */
  324. #define DUK_DEFPROP_HAVE_WRITABLE (1U << 3) /* set/clear writable */
  325. #define DUK_DEFPROP_HAVE_ENUMERABLE (1U << 4) /* set/clear enumerable */
  326. #define DUK_DEFPROP_HAVE_CONFIGURABLE (1U << 5) /* set/clear configurable */
  327. #define DUK_DEFPROP_HAVE_VALUE (1U << 6) /* set value (given on value stack) */
  328. #define DUK_DEFPROP_HAVE_GETTER (1U << 7) /* set getter (given on value stack) */
  329. #define DUK_DEFPROP_HAVE_SETTER (1U << 8) /* set setter (given on value stack) */
  330. #define DUK_DEFPROP_FORCE (1U << 9) /* force change if possible, may still fail for e.g. virtual properties */
  331. #define DUK_DEFPROP_SET_WRITABLE (DUK_DEFPROP_HAVE_WRITABLE | DUK_DEFPROP_WRITABLE)
  332. #define DUK_DEFPROP_CLEAR_WRITABLE DUK_DEFPROP_HAVE_WRITABLE
  333. #define DUK_DEFPROP_SET_ENUMERABLE (DUK_DEFPROP_HAVE_ENUMERABLE | DUK_DEFPROP_ENUMERABLE)
  334. #define DUK_DEFPROP_CLEAR_ENUMERABLE DUK_DEFPROP_HAVE_ENUMERABLE
  335. #define DUK_DEFPROP_SET_CONFIGURABLE (DUK_DEFPROP_HAVE_CONFIGURABLE | DUK_DEFPROP_CONFIGURABLE)
  336. #define DUK_DEFPROP_CLEAR_CONFIGURABLE DUK_DEFPROP_HAVE_CONFIGURABLE
  337. #define DUK_DEFPROP_W DUK_DEFPROP_WRITABLE
  338. #define DUK_DEFPROP_E DUK_DEFPROP_ENUMERABLE
  339. #define DUK_DEFPROP_C DUK_DEFPROP_CONFIGURABLE
  340. #define DUK_DEFPROP_WE (DUK_DEFPROP_WRITABLE | DUK_DEFPROP_ENUMERABLE)
  341. #define DUK_DEFPROP_WC (DUK_DEFPROP_WRITABLE | DUK_DEFPROP_CONFIGURABLE)
  342. #define DUK_DEFPROP_WEC (DUK_DEFPROP_WRITABLE | DUK_DEFPROP_ENUMERABLE | DUK_DEFPROP_CONFIGURABLE)
  343. #define DUK_DEFPROP_HAVE_W DUK_DEFPROP_HAVE_WRITABLE
  344. #define DUK_DEFPROP_HAVE_E DUK_DEFPROP_HAVE_ENUMERABLE
  345. #define DUK_DEFPROP_HAVE_C DUK_DEFPROP_HAVE_CONFIGURABLE
  346. #define DUK_DEFPROP_HAVE_WE (DUK_DEFPROP_HAVE_WRITABLE | DUK_DEFPROP_HAVE_ENUMERABLE)
  347. #define DUK_DEFPROP_HAVE_WC (DUK_DEFPROP_HAVE_WRITABLE | DUK_DEFPROP_HAVE_CONFIGURABLE)
  348. #define DUK_DEFPROP_HAVE_WEC (DUK_DEFPROP_HAVE_WRITABLE | DUK_DEFPROP_HAVE_ENUMERABLE | DUK_DEFPROP_HAVE_CONFIGURABLE)
  349. #define DUK_DEFPROP_SET_W DUK_DEFPROP_SET_WRITABLE
  350. #define DUK_DEFPROP_SET_E DUK_DEFPROP_SET_ENUMERABLE
  351. #define DUK_DEFPROP_SET_C DUK_DEFPROP_SET_CONFIGURABLE
  352. #define DUK_DEFPROP_SET_WE (DUK_DEFPROP_SET_WRITABLE | DUK_DEFPROP_SET_ENUMERABLE)
  353. #define DUK_DEFPROP_SET_WC (DUK_DEFPROP_SET_WRITABLE | DUK_DEFPROP_SET_CONFIGURABLE)
  354. #define DUK_DEFPROP_SET_WEC (DUK_DEFPROP_SET_WRITABLE | DUK_DEFPROP_SET_ENUMERABLE | DUK_DEFPROP_SET_CONFIGURABLE)
  355. #define DUK_DEFPROP_CLEAR_W DUK_DEFPROP_CLEAR_WRITABLE
  356. #define DUK_DEFPROP_CLEAR_E DUK_DEFPROP_CLEAR_ENUMERABLE
  357. #define DUK_DEFPROP_CLEAR_C DUK_DEFPROP_CLEAR_CONFIGURABLE
  358. #define DUK_DEFPROP_CLEAR_WE (DUK_DEFPROP_CLEAR_WRITABLE | DUK_DEFPROP_CLEAR_ENUMERABLE)
  359. #define DUK_DEFPROP_CLEAR_WC (DUK_DEFPROP_CLEAR_WRITABLE | DUK_DEFPROP_CLEAR_CONFIGURABLE)
  360. #define DUK_DEFPROP_CLEAR_WEC (DUK_DEFPROP_CLEAR_WRITABLE | DUK_DEFPROP_CLEAR_ENUMERABLE | DUK_DEFPROP_CLEAR_CONFIGURABLE)
  361. #define DUK_DEFPROP_ATTR_W (DUK_DEFPROP_HAVE_WEC | DUK_DEFPROP_W)
  362. #define DUK_DEFPROP_ATTR_E (DUK_DEFPROP_HAVE_WEC | DUK_DEFPROP_E)
  363. #define DUK_DEFPROP_ATTR_C (DUK_DEFPROP_HAVE_WEC | DUK_DEFPROP_C)
  364. #define DUK_DEFPROP_ATTR_WE (DUK_DEFPROP_HAVE_WEC | DUK_DEFPROP_WE)
  365. #define DUK_DEFPROP_ATTR_WC (DUK_DEFPROP_HAVE_WEC | DUK_DEFPROP_WC)
  366. #define DUK_DEFPROP_ATTR_WEC (DUK_DEFPROP_HAVE_WEC | DUK_DEFPROP_WEC)
  367. /* Flags for duk_push_thread_raw() */
  368. #define DUK_THREAD_NEW_GLOBAL_ENV (1U << 0) /* create a new global environment */
  369. /* Flags for duk_gc() */
  370. #define DUK_GC_COMPACT (1U << 0) /* compact heap objects */
  371. /* Error codes (must be 8 bits at most, see duk_error.h) */
  372. #define DUK_ERR_NONE 0 /* no error (e.g. from duk_get_error_code()) */
  373. #define DUK_ERR_ERROR 1 /* Error */
  374. #define DUK_ERR_EVAL_ERROR 2 /* EvalError */
  375. #define DUK_ERR_RANGE_ERROR 3 /* RangeError */
  376. #define DUK_ERR_REFERENCE_ERROR 4 /* ReferenceError */
  377. #define DUK_ERR_SYNTAX_ERROR 5 /* SyntaxError */
  378. #define DUK_ERR_TYPE_ERROR 6 /* TypeError */
  379. #define DUK_ERR_URI_ERROR 7 /* URIError */
  380. /* Return codes for C functions (shortcut for throwing an error) */
  381. #define DUK_RET_ERROR (-DUK_ERR_ERROR)
  382. #define DUK_RET_EVAL_ERROR (-DUK_ERR_EVAL_ERROR)
  383. #define DUK_RET_RANGE_ERROR (-DUK_ERR_RANGE_ERROR)
  384. #define DUK_RET_REFERENCE_ERROR (-DUK_ERR_REFERENCE_ERROR)
  385. #define DUK_RET_SYNTAX_ERROR (-DUK_ERR_SYNTAX_ERROR)
  386. #define DUK_RET_TYPE_ERROR (-DUK_ERR_TYPE_ERROR)
  387. #define DUK_RET_URI_ERROR (-DUK_ERR_URI_ERROR)
  388. /* Return codes for protected calls (duk_safe_call(), duk_pcall()) */
  389. #define DUK_EXEC_SUCCESS 0
  390. #define DUK_EXEC_ERROR 1
  391. /* Debug levels for DUK_USE_DEBUG_WRITE(). */
  392. #define DUK_LEVEL_DEBUG 0
  393. #define DUK_LEVEL_DDEBUG 1
  394. #define DUK_LEVEL_DDDEBUG 2
  395. /*
  396. * Macros to create Symbols as C statically constructed strings.
  397. *
  398. * Call e.g. as DUK_HIDDEN_SYMBOL("myProperty") <=> ("\xFF" "myProperty").
  399. * Local symbols have a unique suffix, caller should take care to avoid
  400. * conflicting with the Duktape internal representation by e.g. prepending
  401. * a '!' character: DUK_LOCAL_SYMBOL("myLocal", "!123").
  402. *
  403. * Note that these can only be used for string constants, not dynamically
  404. * created strings.
  405. */
  406. #define DUK_HIDDEN_SYMBOL(x) ("\xFF" x)
  407. #define DUK_GLOBAL_SYMBOL(x) ("\x80" x)
  408. #define DUK_LOCAL_SYMBOL(x,uniq) ("\x81" x "\xff" uniq)
  409. #define DUK_WELLKNOWN_SYMBOL(x) ("\x81" x "\xff")
  410. /*
  411. * If no variadic macros, __FILE__ and __LINE__ are passed through globals
  412. * which is ugly and not thread safe.
  413. */
  414. #if !defined(DUK_API_VARIADIC_MACROS)
  415. DUK_EXTERNAL_DECL const char *duk_api_global_filename;
  416. DUK_EXTERNAL_DECL duk_int_t duk_api_global_line;
  417. #endif
  418. /*
  419. * Context management
  420. */
  421. DUK_EXTERNAL_DECL
  422. duk_context *duk_create_heap(duk_alloc_function alloc_func,
  423. duk_realloc_function realloc_func,
  424. duk_free_function free_func,
  425. void *heap_udata,
  426. duk_fatal_function fatal_handler);
  427. DUK_EXTERNAL_DECL void duk_destroy_heap(duk_context *ctx);
  428. DUK_EXTERNAL_DECL void duk_suspend(duk_context *ctx, duk_thread_state *state);
  429. DUK_EXTERNAL_DECL void duk_resume(duk_context *ctx, const duk_thread_state *state);
  430. #define duk_create_heap_default() \
  431. duk_create_heap(NULL, NULL, NULL, NULL, NULL)
  432. /*
  433. * Memory management
  434. *
  435. * Raw functions have no side effects (cannot trigger GC).
  436. */
  437. DUK_EXTERNAL_DECL void *duk_alloc_raw(duk_context *ctx, duk_size_t size);
  438. DUK_EXTERNAL_DECL void duk_free_raw(duk_context *ctx, void *ptr);
  439. DUK_EXTERNAL_DECL void *duk_realloc_raw(duk_context *ctx, void *ptr, duk_size_t size);
  440. DUK_EXTERNAL_DECL void *duk_alloc(duk_context *ctx, duk_size_t size);
  441. DUK_EXTERNAL_DECL void duk_free(duk_context *ctx, void *ptr);
  442. DUK_EXTERNAL_DECL void *duk_realloc(duk_context *ctx, void *ptr, duk_size_t size);
  443. DUK_EXTERNAL_DECL void duk_get_memory_functions(duk_context *ctx, duk_memory_functions *out_funcs);
  444. DUK_EXTERNAL_DECL void duk_gc(duk_context *ctx, duk_uint_t flags);
  445. /*
  446. * Error handling
  447. */
  448. DUK_API_NORETURN(DUK_EXTERNAL_DECL void duk_throw_raw(duk_context *ctx));
  449. #define duk_throw(ctx) \
  450. (duk_throw_raw((ctx)), (duk_ret_t) 0)
  451. DUK_API_NORETURN(DUK_EXTERNAL_DECL void duk_fatal_raw(duk_context *ctx, const char *err_msg));
  452. #define duk_fatal(ctx,err_msg) \
  453. (duk_fatal_raw((ctx), (err_msg)), (duk_ret_t) 0)
  454. DUK_API_NORETURN(DUK_EXTERNAL_DECL void duk_error_raw(duk_context *ctx, duk_errcode_t err_code, const char *filename, duk_int_t line, const char *fmt, ...));
  455. #if defined(DUK_API_VARIADIC_MACROS)
  456. #define duk_error(ctx,err_code,...) \
  457. (duk_error_raw((ctx), (duk_errcode_t) (err_code), (const char *) (DUK_FILE_MACRO), (duk_int_t) (DUK_LINE_MACRO), __VA_ARGS__), (duk_ret_t) 0)
  458. #define duk_generic_error(ctx,...) \
  459. (duk_error_raw((ctx), (duk_errcode_t) DUK_ERR_ERROR, (const char *) (DUK_FILE_MACRO), (duk_int_t) (DUK_LINE_MACRO), __VA_ARGS__), (duk_ret_t) 0)
  460. #define duk_eval_error(ctx,...) \
  461. (duk_error_raw((ctx), (duk_errcode_t) DUK_ERR_EVAL_ERROR, (const char *) (DUK_FILE_MACRO), (duk_int_t) (DUK_LINE_MACRO), __VA_ARGS__), (duk_ret_t) 0)
  462. #define duk_range_error(ctx,...) \
  463. (duk_error_raw((ctx), (duk_errcode_t) DUK_ERR_RANGE_ERROR, (const char *) (DUK_FILE_MACRO), (duk_int_t) (DUK_LINE_MACRO), __VA_ARGS__), (duk_ret_t) 0)
  464. #define duk_reference_error(ctx,...) \
  465. (duk_error_raw((ctx), (duk_errcode_t) DUK_ERR_REFERENCE_ERROR, (const char *) (DUK_FILE_MACRO), (duk_int_t) (DUK_LINE_MACRO), __VA_ARGS__), (duk_ret_t) 0)
  466. #define duk_syntax_error(ctx,...) \
  467. (duk_error_raw((ctx), (duk_errcode_t) DUK_ERR_SYNTAX_ERROR, (const char *) (DUK_FILE_MACRO), (duk_int_t) (DUK_LINE_MACRO), __VA_ARGS__), (duk_ret_t) 0)
  468. #define duk_type_error(ctx,...) \
  469. (duk_error_raw((ctx), (duk_errcode_t) DUK_ERR_TYPE_ERROR, (const char *) (DUK_FILE_MACRO), (duk_int_t) (DUK_LINE_MACRO), __VA_ARGS__), (duk_ret_t) 0)
  470. #define duk_uri_error(ctx,...) \
  471. (duk_error_raw((ctx), (duk_errcode_t) DUK_ERR_URI_ERROR, (const char *) (DUK_FILE_MACRO), (duk_int_t) (DUK_LINE_MACRO), __VA_ARGS__), (duk_ret_t) 0)
  472. #else /* DUK_API_VARIADIC_MACROS */
  473. /* For legacy compilers without variadic macros a macro hack is used to allow
  474. * variable arguments. While the macro allows "return duk_error(...)", it
  475. * will fail with e.g. "(void) duk_error(...)". The calls are noreturn but
  476. * with a return value to allow the "return duk_error(...)" idiom. This may
  477. * cause some compiler warnings, but without noreturn the generated code is
  478. * often worse. The same approach as with variadic macros (using
  479. * "(duk_error(...), 0)") won't work due to the macro hack structure.
  480. */
  481. DUK_API_NORETURN(DUK_EXTERNAL_DECL duk_ret_t duk_error_stash(duk_context *ctx, duk_errcode_t err_code, const char *fmt, ...));
  482. DUK_API_NORETURN(DUK_EXTERNAL_DECL duk_ret_t duk_generic_error_stash(duk_context *ctx, const char *fmt, ...));
  483. DUK_API_NORETURN(DUK_EXTERNAL_DECL duk_ret_t duk_eval_error_stash(duk_context *ctx, const char *fmt, ...));
  484. DUK_API_NORETURN(DUK_EXTERNAL_DECL duk_ret_t duk_range_error_stash(duk_context *ctx, const char *fmt, ...));
  485. DUK_API_NORETURN(DUK_EXTERNAL_DECL duk_ret_t duk_reference_error_stash(duk_context *ctx, const char *fmt, ...));
  486. DUK_API_NORETURN(DUK_EXTERNAL_DECL duk_ret_t duk_syntax_error_stash(duk_context *ctx, const char *fmt, ...));
  487. DUK_API_NORETURN(DUK_EXTERNAL_DECL duk_ret_t duk_type_error_stash(duk_context *ctx, const char *fmt, ...));
  488. DUK_API_NORETURN(DUK_EXTERNAL_DECL duk_ret_t duk_uri_error_stash(duk_context *ctx, const char *fmt, ...));
  489. #define duk_error \
  490. (duk_api_global_filename = (const char *) (DUK_FILE_MACRO), \
  491. duk_api_global_line = (duk_int_t) (DUK_LINE_MACRO), \
  492. duk_error_stash) /* last value is func pointer, arguments follow in parens */
  493. #define duk_generic_error \
  494. (duk_api_global_filename = (const char *) (DUK_FILE_MACRO), \
  495. duk_api_global_line = (duk_int_t) (DUK_LINE_MACRO), \
  496. duk_generic_error_stash)
  497. #define duk_eval_error \
  498. (duk_api_global_filename = (const char *) (DUK_FILE_MACRO), \
  499. duk_api_global_line = (duk_int_t) (DUK_LINE_MACRO), \
  500. duk_eval_error_stash)
  501. #define duk_range_error \
  502. (duk_api_global_filename = (const char *) (DUK_FILE_MACRO), \
  503. duk_api_global_line = (duk_int_t) (DUK_LINE_MACRO), \
  504. duk_range_error_stash)
  505. #define duk_reference_error \
  506. (duk_api_global_filename = (const char *) (DUK_FILE_MACRO), \
  507. duk_api_global_line = (duk_int_t) (DUK_LINE_MACRO), \
  508. duk_reference_error_stash)
  509. #define duk_syntax_error \
  510. (duk_api_global_filename = (const char *) (DUK_FILE_MACRO), \
  511. duk_api_global_line = (duk_int_t) (DUK_LINE_MACRO), \
  512. duk_syntax_error_stash)
  513. #define duk_type_error \
  514. (duk_api_global_filename = (const char *) (DUK_FILE_MACRO), \
  515. duk_api_global_line = (duk_int_t) (DUK_LINE_MACRO), \
  516. duk_type_error_stash)
  517. #define duk_uri_error \
  518. (duk_api_global_filename = (const char *) (DUK_FILE_MACRO), \
  519. duk_api_global_line = (duk_int_t) (DUK_LINE_MACRO), \
  520. duk_uri_error_stash)
  521. #endif /* DUK_API_VARIADIC_MACROS */
  522. DUK_API_NORETURN(DUK_EXTERNAL_DECL void duk_error_va_raw(duk_context *ctx, duk_errcode_t err_code, const char *filename, duk_int_t line, const char *fmt, va_list ap));
  523. #define duk_error_va(ctx,err_code,fmt,ap) \
  524. (duk_error_va_raw((ctx), (duk_errcode_t) (err_code), (const char *) (DUK_FILE_MACRO), (duk_int_t) (DUK_LINE_MACRO), (fmt), (ap)), (duk_ret_t) 0)
  525. #define duk_generic_error_va(ctx,fmt,ap) \
  526. (duk_error_va_raw((ctx), (duk_errcode_t) DUK_ERR_ERROR, (const char *) (DUK_FILE_MACRO), (duk_int_t) (DUK_LINE_MACRO), (fmt), (ap)), (duk_ret_t) 0)
  527. #define duk_eval_error_va(ctx,fmt,ap) \
  528. (duk_error_va_raw((ctx), (duk_errcode_t) DUK_ERR_EVAL_ERROR, (const char *) (DUK_FILE_MACRO), (duk_int_t) (DUK_LINE_MACRO), (fmt), (ap)), (duk_ret_t) 0)
  529. #define duk_range_error_va(ctx,fmt,ap) \
  530. (duk_error_va_raw((ctx), (duk_errcode_t) DUK_ERR_RANGE_ERROR, (const char *) (DUK_FILE_MACRO), (duk_int_t) (DUK_LINE_MACRO), (fmt), (ap)), (duk_ret_t) 0)
  531. #define duk_reference_error_va(ctx,fmt,ap) \
  532. (duk_error_va_raw((ctx), (duk_errcode_t) DUK_ERR_REFERENCE_ERROR, (const char *) (DUK_FILE_MACRO), (duk_int_t) (DUK_LINE_MACRO), (fmt), (ap)), (duk_ret_t) 0)
  533. #define duk_syntax_error_va(ctx,fmt,ap) \
  534. (duk_error_va_raw((ctx), (duk_errcode_t) DUK_ERR_SYNTAX_ERROR, (const char *) (DUK_FILE_MACRO), (duk_int_t) (DUK_LINE_MACRO), (fmt), (ap)), (duk_ret_t) 0)
  535. #define duk_type_error_va(ctx,fmt,ap) \
  536. (duk_error_va_raw((ctx), (duk_errcode_t) DUK_ERR_TYPE_ERROR, (const char *) (DUK_FILE_MACRO), (duk_int_t) (DUK_LINE_MACRO), (fmt), (ap)), (duk_ret_t) 0)
  537. #define duk_uri_error_va(ctx,fmt,ap) \
  538. (duk_error_va_raw((ctx), (duk_errcode_t) DUK_ERR_URI_ERROR, (const char *) (DUK_FILE_MACRO), (duk_int_t) (DUK_LINE_MACRO), (fmt), (ap)), (duk_ret_t) 0)
  539. /*
  540. * Other state related functions
  541. */
  542. DUK_EXTERNAL_DECL duk_bool_t duk_is_strict_call(duk_context *ctx);
  543. DUK_EXTERNAL_DECL duk_bool_t duk_is_constructor_call(duk_context *ctx);
  544. /*
  545. * Stack management
  546. */
  547. DUK_EXTERNAL_DECL duk_idx_t duk_normalize_index(duk_context *ctx, duk_idx_t idx);
  548. DUK_EXTERNAL_DECL duk_idx_t duk_require_normalize_index(duk_context *ctx, duk_idx_t idx);
  549. DUK_EXTERNAL_DECL duk_bool_t duk_is_valid_index(duk_context *ctx, duk_idx_t idx);
  550. DUK_EXTERNAL_DECL void duk_require_valid_index(duk_context *ctx, duk_idx_t idx);
  551. DUK_EXTERNAL_DECL duk_idx_t duk_get_top(duk_context *ctx);
  552. DUK_EXTERNAL_DECL void duk_set_top(duk_context *ctx, duk_idx_t idx);
  553. DUK_EXTERNAL_DECL duk_idx_t duk_get_top_index(duk_context *ctx);
  554. DUK_EXTERNAL_DECL duk_idx_t duk_require_top_index(duk_context *ctx);
  555. /* Although extra/top could be an unsigned type here, using a signed type
  556. * makes the API more robust to calling code calculation errors or corner
  557. * cases (where caller might occasionally come up with negative values).
  558. * Negative values are treated as zero, which is better than casting them
  559. * to a large unsigned number. (This principle is used elsewhere in the
  560. * API too.)
  561. */
  562. DUK_EXTERNAL_DECL duk_bool_t duk_check_stack(duk_context *ctx, duk_idx_t extra);
  563. DUK_EXTERNAL_DECL void duk_require_stack(duk_context *ctx, duk_idx_t extra);
  564. DUK_EXTERNAL_DECL duk_bool_t duk_check_stack_top(duk_context *ctx, duk_idx_t top);
  565. DUK_EXTERNAL_DECL void duk_require_stack_top(duk_context *ctx, duk_idx_t top);
  566. /*
  567. * Stack manipulation (other than push/pop)
  568. */
  569. DUK_EXTERNAL_DECL void duk_swap(duk_context *ctx, duk_idx_t idx1, duk_idx_t idx2);
  570. DUK_EXTERNAL_DECL void duk_swap_top(duk_context *ctx, duk_idx_t idx);
  571. DUK_EXTERNAL_DECL void duk_dup(duk_context *ctx, duk_idx_t from_idx);
  572. DUK_EXTERNAL_DECL void duk_dup_top(duk_context *ctx);
  573. DUK_EXTERNAL_DECL void duk_insert(duk_context *ctx, duk_idx_t to_idx);
  574. DUK_EXTERNAL_DECL void duk_replace(duk_context *ctx, duk_idx_t to_idx);
  575. DUK_EXTERNAL_DECL void duk_copy(duk_context *ctx, duk_idx_t from_idx, duk_idx_t to_idx);
  576. DUK_EXTERNAL_DECL void duk_remove(duk_context *ctx, duk_idx_t idx);
  577. DUK_EXTERNAL_DECL void duk_xcopymove_raw(duk_context *to_ctx, duk_context *from_ctx, duk_idx_t count, duk_bool_t is_copy);
  578. #define duk_xmove_top(to_ctx,from_ctx,count) \
  579. duk_xcopymove_raw((to_ctx), (from_ctx), (count), 0 /*is_copy*/)
  580. #define duk_xcopy_top(to_ctx,from_ctx,count) \
  581. duk_xcopymove_raw((to_ctx), (from_ctx), (count), 1 /*is_copy*/)
  582. /*
  583. * Push operations
  584. *
  585. * Push functions return the absolute (relative to bottom of frame)
  586. * position of the pushed value for convenience.
  587. *
  588. * Note: duk_dup() is technically a push.
  589. */
  590. DUK_EXTERNAL_DECL void duk_push_undefined(duk_context *ctx);
  591. DUK_EXTERNAL_DECL void duk_push_null(duk_context *ctx);
  592. DUK_EXTERNAL_DECL void duk_push_boolean(duk_context *ctx, duk_bool_t val);
  593. DUK_EXTERNAL_DECL void duk_push_true(duk_context *ctx);
  594. DUK_EXTERNAL_DECL void duk_push_false(duk_context *ctx);
  595. DUK_EXTERNAL_DECL void duk_push_number(duk_context *ctx, duk_double_t val);
  596. DUK_EXTERNAL_DECL void duk_push_nan(duk_context *ctx);
  597. DUK_EXTERNAL_DECL void duk_push_int(duk_context *ctx, duk_int_t val);
  598. DUK_EXTERNAL_DECL void duk_push_uint(duk_context *ctx, duk_uint_t val);
  599. DUK_EXTERNAL_DECL const char *duk_push_string(duk_context *ctx, const char *str);
  600. DUK_EXTERNAL_DECL const char *duk_push_lstring(duk_context *ctx, const char *str, duk_size_t len);
  601. DUK_EXTERNAL_DECL void duk_push_pointer(duk_context *ctx, void *p);
  602. DUK_EXTERNAL_DECL const char *duk_push_sprintf(duk_context *ctx, const char *fmt, ...);
  603. DUK_EXTERNAL_DECL const char *duk_push_vsprintf(duk_context *ctx, const char *fmt, va_list ap);
  604. DUK_EXTERNAL_DECL void duk_push_this(duk_context *ctx);
  605. DUK_EXTERNAL_DECL void duk_push_current_function(duk_context *ctx);
  606. DUK_EXTERNAL_DECL void duk_push_current_thread(duk_context *ctx);
  607. DUK_EXTERNAL_DECL void duk_push_global_object(duk_context *ctx);
  608. DUK_EXTERNAL_DECL void duk_push_heap_stash(duk_context *ctx);
  609. DUK_EXTERNAL_DECL void duk_push_global_stash(duk_context *ctx);
  610. DUK_EXTERNAL_DECL void duk_push_thread_stash(duk_context *ctx, duk_context *target_ctx);
  611. DUK_EXTERNAL_DECL duk_idx_t duk_push_object(duk_context *ctx);
  612. DUK_EXTERNAL_DECL duk_idx_t duk_push_bare_object(duk_context *ctx);
  613. DUK_EXTERNAL_DECL duk_idx_t duk_push_array(duk_context *ctx);
  614. DUK_EXTERNAL_DECL duk_idx_t duk_push_c_function(duk_context *ctx, duk_c_function func, duk_idx_t nargs);
  615. DUK_EXTERNAL_DECL duk_idx_t duk_push_c_lightfunc(duk_context *ctx, duk_c_function func, duk_idx_t nargs, duk_idx_t length, duk_int_t magic);
  616. DUK_EXTERNAL_DECL duk_idx_t duk_push_thread_raw(duk_context *ctx, duk_uint_t flags);
  617. DUK_EXTERNAL_DECL duk_idx_t duk_push_proxy(duk_context *ctx, duk_uint_t proxy_flags);
  618. #define duk_push_thread(ctx) \
  619. duk_push_thread_raw((ctx), 0 /*flags*/)
  620. #define duk_push_thread_new_globalenv(ctx) \
  621. duk_push_thread_raw((ctx), DUK_THREAD_NEW_GLOBAL_ENV /*flags*/)
  622. DUK_EXTERNAL_DECL duk_idx_t duk_push_error_object_raw(duk_context *ctx, duk_errcode_t err_code, const char *filename, duk_int_t line, const char *fmt, ...);
  623. #if defined(DUK_API_VARIADIC_MACROS)
  624. #define duk_push_error_object(ctx,err_code,...) \
  625. duk_push_error_object_raw((ctx), (err_code), (const char *) (DUK_FILE_MACRO), (duk_int_t) (DUK_LINE_MACRO), __VA_ARGS__)
  626. #else
  627. DUK_EXTERNAL_DECL duk_idx_t duk_push_error_object_stash(duk_context *ctx, duk_errcode_t err_code, const char *fmt, ...);
  628. /* Note: parentheses are required so that the comma expression works in assignments. */
  629. #define duk_push_error_object \
  630. (duk_api_global_filename = (const char *) (DUK_FILE_MACRO), \
  631. duk_api_global_line = (duk_int_t) (DUK_LINE_MACRO), \
  632. duk_push_error_object_stash) /* last value is func pointer, arguments follow in parens */
  633. #endif
  634. DUK_EXTERNAL_DECL duk_idx_t duk_push_error_object_va_raw(duk_context *ctx, duk_errcode_t err_code, const char *filename, duk_int_t line, const char *fmt, va_list ap);
  635. #define duk_push_error_object_va(ctx,err_code,fmt,ap) \
  636. duk_push_error_object_va_raw((ctx), (err_code), (const char *) (DUK_FILE_MACRO), (duk_int_t) (DUK_LINE_MACRO), (fmt), (ap))
  637. #define DUK_BUF_FLAG_DYNAMIC (1 << 0) /* internal flag: dynamic buffer */
  638. #define DUK_BUF_FLAG_EXTERNAL (1 << 1) /* internal flag: external buffer */
  639. #define DUK_BUF_FLAG_NOZERO (1 << 2) /* internal flag: don't zero allocated buffer */
  640. DUK_EXTERNAL_DECL void *duk_push_buffer_raw(duk_context *ctx, duk_size_t size, duk_small_uint_t flags);
  641. #define duk_push_buffer(ctx,size,dynamic) \
  642. duk_push_buffer_raw((ctx), (size), (dynamic) ? DUK_BUF_FLAG_DYNAMIC : 0)
  643. #define duk_push_fixed_buffer(ctx,size) \
  644. duk_push_buffer_raw((ctx), (size), 0 /*flags*/)
  645. #define duk_push_dynamic_buffer(ctx,size) \
  646. duk_push_buffer_raw((ctx), (size), DUK_BUF_FLAG_DYNAMIC /*flags*/)
  647. #define duk_push_external_buffer(ctx) \
  648. ((void) duk_push_buffer_raw((ctx), 0, DUK_BUF_FLAG_DYNAMIC | DUK_BUF_FLAG_EXTERNAL))
  649. #define DUK_BUFOBJ_ARRAYBUFFER 0
  650. #define DUK_BUFOBJ_NODEJS_BUFFER 1
  651. #define DUK_BUFOBJ_DATAVIEW 2
  652. #define DUK_BUFOBJ_INT8ARRAY 3
  653. #define DUK_BUFOBJ_UINT8ARRAY 4
  654. #define DUK_BUFOBJ_UINT8CLAMPEDARRAY 5
  655. #define DUK_BUFOBJ_INT16ARRAY 6
  656. #define DUK_BUFOBJ_UINT16ARRAY 7
  657. #define DUK_BUFOBJ_INT32ARRAY 8
  658. #define DUK_BUFOBJ_UINT32ARRAY 9
  659. #define DUK_BUFOBJ_FLOAT32ARRAY 10
  660. #define DUK_BUFOBJ_FLOAT64ARRAY 11
  661. DUK_EXTERNAL_DECL void duk_push_buffer_object(duk_context *ctx, duk_idx_t idx_buffer, duk_size_t byte_offset, duk_size_t byte_length, duk_uint_t flags);
  662. DUK_EXTERNAL_DECL duk_idx_t duk_push_heapptr(duk_context *ctx, void *ptr);
  663. /*
  664. * Pop operations
  665. */
  666. DUK_EXTERNAL_DECL void duk_pop(duk_context *ctx);
  667. DUK_EXTERNAL_DECL void duk_pop_n(duk_context *ctx, duk_idx_t count);
  668. DUK_EXTERNAL_DECL void duk_pop_2(duk_context *ctx);
  669. DUK_EXTERNAL_DECL void duk_pop_3(duk_context *ctx);
  670. /*
  671. * Type checks
  672. *
  673. * duk_is_none(), which would indicate whether index it outside of stack,
  674. * is not needed; duk_is_valid_index() gives the same information.
  675. */
  676. DUK_EXTERNAL_DECL duk_int_t duk_get_type(duk_context *ctx, duk_idx_t idx);
  677. DUK_EXTERNAL_DECL duk_bool_t duk_check_type(duk_context *ctx, duk_idx_t idx, duk_int_t type);
  678. DUK_EXTERNAL_DECL duk_uint_t duk_get_type_mask(duk_context *ctx, duk_idx_t idx);
  679. DUK_EXTERNAL_DECL duk_bool_t duk_check_type_mask(duk_context *ctx, duk_idx_t idx, duk_uint_t mask);
  680. DUK_EXTERNAL_DECL duk_bool_t duk_is_undefined(duk_context *ctx, duk_idx_t idx);
  681. DUK_EXTERNAL_DECL duk_bool_t duk_is_null(duk_context *ctx, duk_idx_t idx);
  682. #define duk_is_null_or_undefined(ctx, idx) \
  683. ((duk_get_type_mask((ctx), (idx)) & (DUK_TYPE_MASK_NULL | DUK_TYPE_MASK_UNDEFINED)) ? 1 : 0)
  684. DUK_EXTERNAL_DECL duk_bool_t duk_is_boolean(duk_context *ctx, duk_idx_t idx);
  685. DUK_EXTERNAL_DECL duk_bool_t duk_is_number(duk_context *ctx, duk_idx_t idx);
  686. DUK_EXTERNAL_DECL duk_bool_t duk_is_nan(duk_context *ctx, duk_idx_t idx);
  687. DUK_EXTERNAL_DECL duk_bool_t duk_is_string(duk_context *ctx, duk_idx_t idx);
  688. DUK_EXTERNAL_DECL duk_bool_t duk_is_object(duk_context *ctx, duk_idx_t idx);
  689. DUK_EXTERNAL_DECL duk_bool_t duk_is_buffer(duk_context *ctx, duk_idx_t idx);
  690. DUK_EXTERNAL_DECL duk_bool_t duk_is_buffer_data(duk_context *ctx, duk_idx_t idx);
  691. DUK_EXTERNAL_DECL duk_bool_t duk_is_pointer(duk_context *ctx, duk_idx_t idx);
  692. DUK_EXTERNAL_DECL duk_bool_t duk_is_lightfunc(duk_context *ctx, duk_idx_t idx);
  693. DUK_EXTERNAL_DECL duk_bool_t duk_is_symbol(duk_context *ctx, duk_idx_t idx);
  694. DUK_EXTERNAL_DECL duk_bool_t duk_is_array(duk_context *ctx, duk_idx_t idx);
  695. DUK_EXTERNAL_DECL duk_bool_t duk_is_function(duk_context *ctx, duk_idx_t idx);
  696. DUK_EXTERNAL_DECL duk_bool_t duk_is_c_function(duk_context *ctx, duk_idx_t idx);
  697. DUK_EXTERNAL_DECL duk_bool_t duk_is_ecmascript_function(duk_context *ctx, duk_idx_t idx);
  698. DUK_EXTERNAL_DECL duk_bool_t duk_is_bound_function(duk_context *ctx, duk_idx_t idx);
  699. DUK_EXTERNAL_DECL duk_bool_t duk_is_thread(duk_context *ctx, duk_idx_t idx);
  700. #define duk_is_callable(ctx,idx) \
  701. duk_is_function((ctx), (idx))
  702. DUK_EXTERNAL_DECL duk_bool_t duk_is_constructable(duk_context *ctx, duk_idx_t idx);
  703. DUK_EXTERNAL_DECL duk_bool_t duk_is_dynamic_buffer(duk_context *ctx, duk_idx_t idx);
  704. DUK_EXTERNAL_DECL duk_bool_t duk_is_fixed_buffer(duk_context *ctx, duk_idx_t idx);
  705. DUK_EXTERNAL_DECL duk_bool_t duk_is_external_buffer(duk_context *ctx, duk_idx_t idx);
  706. /* Buffers and lightfuncs are not considered primitive because they mimic
  707. * objects and e.g. duk_to_primitive() will coerce them instead of returning
  708. * them as is. Symbols are represented as strings internally.
  709. */
  710. #define duk_is_primitive(ctx,idx) \
  711. duk_check_type_mask((ctx), (idx), DUK_TYPE_MASK_UNDEFINED | \
  712. DUK_TYPE_MASK_NULL | \
  713. DUK_TYPE_MASK_BOOLEAN | \
  714. DUK_TYPE_MASK_NUMBER | \
  715. DUK_TYPE_MASK_STRING | \
  716. DUK_TYPE_MASK_POINTER)
  717. /* Symbols are object coercible, covered by DUK_TYPE_MASK_STRING. */
  718. #define duk_is_object_coercible(ctx,idx) \
  719. duk_check_type_mask((ctx), (idx), DUK_TYPE_MASK_BOOLEAN | \
  720. DUK_TYPE_MASK_NUMBER | \
  721. DUK_TYPE_MASK_STRING | \
  722. DUK_TYPE_MASK_OBJECT | \
  723. DUK_TYPE_MASK_BUFFER | \
  724. DUK_TYPE_MASK_POINTER | \
  725. DUK_TYPE_MASK_LIGHTFUNC)
  726. DUK_EXTERNAL_DECL duk_errcode_t duk_get_error_code(duk_context *ctx, duk_idx_t idx);
  727. #define duk_is_error(ctx,idx) \
  728. (duk_get_error_code((ctx), (idx)) != 0)
  729. #define duk_is_eval_error(ctx,idx) \
  730. (duk_get_error_code((ctx), (idx)) == DUK_ERR_EVAL_ERROR)
  731. #define duk_is_range_error(ctx,idx) \
  732. (duk_get_error_code((ctx), (idx)) == DUK_ERR_RANGE_ERROR)
  733. #define duk_is_reference_error(ctx,idx) \
  734. (duk_get_error_code((ctx), (idx)) == DUK_ERR_REFERENCE_ERROR)
  735. #define duk_is_syntax_error(ctx,idx) \
  736. (duk_get_error_code((ctx), (idx)) == DUK_ERR_SYNTAX_ERROR)
  737. #define duk_is_type_error(ctx,idx) \
  738. (duk_get_error_code((ctx), (idx)) == DUK_ERR_TYPE_ERROR)
  739. #define duk_is_uri_error(ctx,idx) \
  740. (duk_get_error_code((ctx), (idx)) == DUK_ERR_URI_ERROR)
  741. /*
  742. * Get operations: no coercion, returns default value for invalid
  743. * indices and invalid value types.
  744. *
  745. * duk_get_undefined() and duk_get_null() would be pointless and
  746. * are not included.
  747. */
  748. DUK_EXTERNAL_DECL duk_bool_t duk_get_boolean(duk_context *ctx, duk_idx_t idx);
  749. DUK_EXTERNAL_DECL duk_double_t duk_get_number(duk_context *ctx, duk_idx_t idx);
  750. DUK_EXTERNAL_DECL duk_int_t duk_get_int(duk_context *ctx, duk_idx_t idx);
  751. DUK_EXTERNAL_DECL duk_uint_t duk_get_uint(duk_context *ctx, duk_idx_t idx);
  752. DUK_EXTERNAL_DECL const char *duk_get_string(duk_context *ctx, duk_idx_t idx);
  753. DUK_EXTERNAL_DECL const char *duk_get_lstring(duk_context *ctx, duk_idx_t idx, duk_size_t *out_len);
  754. DUK_EXTERNAL_DECL void *duk_get_buffer(duk_context *ctx, duk_idx_t idx, duk_size_t *out_size);
  755. DUK_EXTERNAL_DECL void *duk_get_buffer_data(duk_context *ctx, duk_idx_t idx, duk_size_t *out_size);
  756. DUK_EXTERNAL_DECL void *duk_get_pointer(duk_context *ctx, duk_idx_t idx);
  757. DUK_EXTERNAL_DECL duk_c_function duk_get_c_function(duk_context *ctx, duk_idx_t idx);
  758. DUK_EXTERNAL_DECL duk_context *duk_get_context(duk_context *ctx, duk_idx_t idx);
  759. DUK_EXTERNAL_DECL void *duk_get_heapptr(duk_context *ctx, duk_idx_t idx);
  760. /*
  761. * Get-with-explicit default operations: like get operations but with an
  762. * explicit default value.
  763. */
  764. DUK_EXTERNAL_DECL duk_bool_t duk_get_boolean_default(duk_context *ctx, duk_idx_t idx, duk_bool_t def_value);
  765. DUK_EXTERNAL_DECL duk_double_t duk_get_number_default(duk_context *ctx, duk_idx_t idx, duk_double_t def_value);
  766. DUK_EXTERNAL_DECL duk_int_t duk_get_int_default(duk_context *ctx, duk_idx_t idx, duk_int_t def_value);
  767. DUK_EXTERNAL_DECL duk_uint_t duk_get_uint_default(duk_context *ctx, duk_idx_t idx, duk_uint_t def_value);
  768. DUK_EXTERNAL_DECL const char *duk_get_string_default(duk_context *ctx, duk_idx_t idx, const char *def_value);
  769. DUK_EXTERNAL_DECL const char *duk_get_lstring_default(duk_context *ctx, duk_idx_t idx, duk_size_t *out_len, const char *def_ptr, duk_size_t def_len);
  770. DUK_EXTERNAL_DECL void *duk_get_buffer_default(duk_context *ctx, duk_idx_t idx, duk_size_t *out_size, void *def_ptr, duk_size_t def_len);
  771. DUK_EXTERNAL_DECL void *duk_get_buffer_data_default(duk_context *ctx, duk_idx_t idx, duk_size_t *out_size, void *def_ptr, duk_size_t def_len);
  772. DUK_EXTERNAL_DECL void *duk_get_pointer_default(duk_context *ctx, duk_idx_t idx, void *def_value);
  773. DUK_EXTERNAL_DECL duk_c_function duk_get_c_function_default(duk_context *ctx, duk_idx_t idx, duk_c_function def_value);
  774. DUK_EXTERNAL_DECL duk_context *duk_get_context_default(duk_context *ctx, duk_idx_t idx, duk_context *def_value);
  775. DUK_EXTERNAL_DECL void *duk_get_heapptr_default(duk_context *ctx, duk_idx_t idx, void *def_value);
  776. /*
  777. * Opt operations: like require operations but with an explicit default value
  778. * when value is undefined or index is invalid, null and non-matching types
  779. * cause a TypeError.
  780. */
  781. DUK_EXTERNAL_DECL duk_bool_t duk_opt_boolean(duk_context *ctx, duk_idx_t idx, duk_bool_t def_value);
  782. DUK_EXTERNAL_DECL duk_double_t duk_opt_number(duk_context *ctx, duk_idx_t idx, duk_double_t def_value);
  783. DUK_EXTERNAL_DECL duk_int_t duk_opt_int(duk_context *ctx, duk_idx_t idx, duk_int_t def_value);
  784. DUK_EXTERNAL_DECL duk_uint_t duk_opt_uint(duk_context *ctx, duk_idx_t idx, duk_uint_t def_value);
  785. DUK_EXTERNAL_DECL const char *duk_opt_string(duk_context *ctx, duk_idx_t idx, const char *def_ptr);
  786. DUK_EXTERNAL_DECL const char *duk_opt_lstring(duk_context *ctx, duk_idx_t idx, duk_size_t *out_len, const char *def_ptr, duk_size_t def_len);
  787. DUK_EXTERNAL_DECL void *duk_opt_buffer(duk_context *ctx, duk_idx_t idx, duk_size_t *out_size, void *def_ptr, duk_size_t def_size);
  788. DUK_EXTERNAL_DECL void *duk_opt_buffer_data(duk_context *ctx, duk_idx_t idx, duk_size_t *out_size, void *def_ptr, duk_size_t def_size);
  789. DUK_EXTERNAL_DECL void *duk_opt_pointer(duk_context *ctx, duk_idx_t idx, void *def_value);
  790. DUK_EXTERNAL_DECL duk_c_function duk_opt_c_function(duk_context *ctx, duk_idx_t idx, duk_c_function def_value);
  791. DUK_EXTERNAL_DECL duk_context *duk_opt_context(duk_context *ctx, duk_idx_t idx, duk_context *def_value);
  792. DUK_EXTERNAL_DECL void *duk_opt_heapptr(duk_context *ctx, duk_idx_t idx, void *def_value);
  793. /*
  794. * Require operations: no coercion, throw error if index or type
  795. * is incorrect. No defaulting.
  796. */
  797. #define duk_require_type_mask(ctx,idx,mask) \
  798. ((void) duk_check_type_mask((ctx), (idx), (mask) | DUK_TYPE_MASK_THROW))
  799. DUK_EXTERNAL_DECL void duk_require_undefined(duk_context *ctx, duk_idx_t idx);
  800. DUK_EXTERNAL_DECL void duk_require_null(duk_context *ctx, duk_idx_t idx);
  801. DUK_EXTERNAL_DECL duk_bool_t duk_require_boolean(duk_context *ctx, duk_idx_t idx);
  802. DUK_EXTERNAL_DECL duk_double_t duk_require_number(duk_context *ctx, duk_idx_t idx);
  803. DUK_EXTERNAL_DECL duk_int_t duk_require_int(duk_context *ctx, duk_idx_t idx);
  804. DUK_EXTERNAL_DECL duk_uint_t duk_require_uint(duk_context *ctx, duk_idx_t idx);
  805. DUK_EXTERNAL_DECL const char *duk_require_string(duk_context *ctx, duk_idx_t idx);
  806. DUK_EXTERNAL_DECL const char *duk_require_lstring(duk_context *ctx, duk_idx_t idx, duk_size_t *out_len);
  807. DUK_EXTERNAL_DECL void duk_require_object(duk_context *ctx, duk_idx_t idx);
  808. DUK_EXTERNAL_DECL void *duk_require_buffer(duk_context *ctx, duk_idx_t idx, duk_size_t *out_size);
  809. DUK_EXTERNAL_DECL void *duk_require_buffer_data(duk_context *ctx, duk_idx_t idx, duk_size_t *out_size);
  810. DUK_EXTERNAL_DECL void *duk_require_pointer(duk_context *ctx, duk_idx_t idx);
  811. DUK_EXTERNAL_DECL duk_c_function duk_require_c_function(duk_context *ctx, duk_idx_t idx);
  812. DUK_EXTERNAL_DECL duk_context *duk_require_context(duk_context *ctx, duk_idx_t idx);
  813. DUK_EXTERNAL_DECL void duk_require_function(duk_context *ctx, duk_idx_t idx);
  814. #define duk_require_callable(ctx,idx) \
  815. duk_require_function((ctx), (idx))
  816. DUK_EXTERNAL_DECL void *duk_require_heapptr(duk_context *ctx, duk_idx_t idx);
  817. /* Symbols are object coercible and covered by DUK_TYPE_MASK_STRING. */
  818. #define duk_require_object_coercible(ctx,idx) \
  819. ((void) duk_check_type_mask((ctx), (idx), DUK_TYPE_MASK_BOOLEAN | \
  820. DUK_TYPE_MASK_NUMBER | \
  821. DUK_TYPE_MASK_STRING | \
  822. DUK_TYPE_MASK_OBJECT | \
  823. DUK_TYPE_MASK_BUFFER | \
  824. DUK_TYPE_MASK_POINTER | \
  825. DUK_TYPE_MASK_LIGHTFUNC | \
  826. DUK_TYPE_MASK_THROW))
  827. /*
  828. * Coercion operations: in-place coercion, return coerced value where
  829. * applicable. If index is invalid, throw error. Some coercions may
  830. * throw an expected error (e.g. from a toString() or valueOf() call)
  831. * or an internal error (e.g. from out of memory).
  832. */
  833. DUK_EXTERNAL_DECL void duk_to_undefined(duk_context *ctx, duk_idx_t idx);
  834. DUK_EXTERNAL_DECL void duk_to_null(duk_context *ctx, duk_idx_t idx);
  835. DUK_EXTERNAL_DECL duk_bool_t duk_to_boolean(duk_context *ctx, duk_idx_t idx);
  836. DUK_EXTERNAL_DECL duk_double_t duk_to_number(duk_context *ctx, duk_idx_t idx);
  837. DUK_EXTERNAL_DECL duk_int_t duk_to_int(duk_context *ctx, duk_idx_t idx);
  838. DUK_EXTERNAL_DECL duk_uint_t duk_to_uint(duk_context *ctx, duk_idx_t idx);
  839. DUK_EXTERNAL_DECL duk_int32_t duk_to_int32(duk_context *ctx, duk_idx_t idx);
  840. DUK_EXTERNAL_DECL duk_uint32_t duk_to_uint32(duk_context *ctx, duk_idx_t idx);
  841. DUK_EXTERNAL_DECL duk_uint16_t duk_to_uint16(duk_context *ctx, duk_idx_t idx);
  842. DUK_EXTERNAL_DECL const char *duk_to_string(duk_context *ctx, duk_idx_t idx);
  843. DUK_EXTERNAL_DECL const char *duk_to_lstring(duk_context *ctx, duk_idx_t idx, duk_size_t *out_len);
  844. DUK_EXTERNAL_DECL void *duk_to_buffer_raw(duk_context *ctx, duk_idx_t idx, duk_size_t *out_size, duk_uint_t flags);
  845. DUK_EXTERNAL_DECL void *duk_to_pointer(duk_context *ctx, duk_idx_t idx);
  846. DUK_EXTERNAL_DECL void duk_to_object(duk_context *ctx, duk_idx_t idx);
  847. DUK_EXTERNAL_DECL void duk_to_primitive(duk_context *ctx, duk_idx_t idx, duk_int_t hint);
  848. #define DUK_BUF_MODE_FIXED 0 /* internal: request fixed buffer result */
  849. #define DUK_BUF_MODE_DYNAMIC 1 /* internal: request dynamic buffer result */
  850. #define DUK_BUF_MODE_DONTCARE 2 /* internal: don't care about fixed/dynamic nature */
  851. #define duk_to_buffer(ctx,idx,out_size) \
  852. duk_to_buffer_raw((ctx), (idx), (out_size), DUK_BUF_MODE_DONTCARE)
  853. #define duk_to_fixed_buffer(ctx,idx,out_size) \
  854. duk_to_buffer_raw((ctx), (idx), (out_size), DUK_BUF_MODE_FIXED)
  855. #define duk_to_dynamic_buffer(ctx,idx,out_size) \
  856. duk_to_buffer_raw((ctx), (idx), (out_size), DUK_BUF_MODE_DYNAMIC)
  857. /* safe variants of a few coercion operations */
  858. DUK_EXTERNAL_DECL const char *duk_safe_to_lstring(duk_context *ctx, duk_idx_t idx, duk_size_t *out_len);
  859. #define duk_safe_to_string(ctx,idx) \
  860. duk_safe_to_lstring((ctx), (idx), NULL)
  861. /*
  862. * Value length
  863. */
  864. DUK_EXTERNAL_DECL duk_size_t duk_get_length(duk_context *ctx, duk_idx_t idx);
  865. DUK_EXTERNAL_DECL void duk_set_length(duk_context *ctx, duk_idx_t idx, duk_size_t len);
  866. #if 0
  867. /* duk_require_length()? */
  868. /* duk_opt_length()? */
  869. #endif
  870. /*
  871. * Misc conversion
  872. */
  873. DUK_EXTERNAL_DECL const char *duk_base64_encode(duk_context *ctx, duk_idx_t idx);
  874. DUK_EXTERNAL_DECL void duk_base64_decode(duk_context *ctx, duk_idx_t idx);
  875. DUK_EXTERNAL_DECL const char *duk_hex_encode(duk_context *ctx, duk_idx_t idx);
  876. DUK_EXTERNAL_DECL void duk_hex_decode(duk_context *ctx, duk_idx_t idx);
  877. DUK_EXTERNAL_DECL const char *duk_json_encode(duk_context *ctx, duk_idx_t idx);
  878. DUK_EXTERNAL_DECL void duk_json_decode(duk_context *ctx, duk_idx_t idx);
  879. DUK_EXTERNAL_DECL const char *duk_buffer_to_string(duk_context *ctx, duk_idx_t idx);
  880. /*
  881. * Buffer
  882. */
  883. DUK_EXTERNAL_DECL void *duk_resize_buffer(duk_context *ctx, duk_idx_t idx, duk_size_t new_size);
  884. DUK_EXTERNAL_DECL void *duk_steal_buffer(duk_context *ctx, duk_idx_t idx, duk_size_t *out_size);
  885. DUK_EXTERNAL_DECL void duk_config_buffer(duk_context *ctx, duk_idx_t idx, void *ptr, duk_size_t len);
  886. /*
  887. * Property access
  888. *
  889. * The basic function assumes key is on stack. The _string variant takes
  890. * a C string as a property name, while the _index variant takes an array
  891. * index as a property name (e.g. 123 is equivalent to the key "123").
  892. */
  893. DUK_EXTERNAL_DECL duk_bool_t duk_get_prop(duk_context *ctx, duk_idx_t obj_idx);
  894. DUK_EXTERNAL_DECL duk_bool_t duk_get_prop_string(duk_context *ctx, duk_idx_t obj_idx, const char *key);
  895. DUK_EXTERNAL_DECL duk_bool_t duk_get_prop_lstring(duk_context *ctx, duk_idx_t obj_idx, const char *key, duk_size_t key_len);
  896. DUK_EXTERNAL_DECL duk_bool_t duk_get_prop_index(duk_context *ctx, duk_idx_t obj_idx, duk_uarridx_t arr_idx);
  897. DUK_EXTERNAL_DECL duk_bool_t duk_get_prop_heapptr(duk_context *ctx, duk_idx_t obj_idx, void *ptr);
  898. DUK_EXTERNAL_DECL duk_bool_t duk_put_prop(duk_context *ctx, duk_idx_t obj_idx);
  899. DUK_EXTERNAL_DECL duk_bool_t duk_put_prop_string(duk_context *ctx, duk_idx_t obj_idx, const char *key);
  900. DUK_EXTERNAL_DECL duk_bool_t duk_put_prop_lstring(duk_context *ctx, duk_idx_t obj_idx, const char *key, duk_size_t key_len);
  901. DUK_EXTERNAL_DECL duk_bool_t duk_put_prop_index(duk_context *ctx, duk_idx_t obj_idx, duk_uarridx_t arr_idx);
  902. DUK_EXTERNAL_DECL duk_bool_t duk_put_prop_heapptr(duk_context *ctx, duk_idx_t obj_idx, void *ptr);
  903. DUK_EXTERNAL_DECL duk_bool_t duk_del_prop(duk_context *ctx, duk_idx_t obj_idx);
  904. DUK_EXTERNAL_DECL duk_bool_t duk_del_prop_string(duk_context *ctx, duk_idx_t obj_idx, const char *key);
  905. DUK_EXTERNAL_DECL duk_bool_t duk_del_prop_lstring(duk_context *ctx, duk_idx_t obj_idx, const char *key, duk_size_t key_len);
  906. DUK_EXTERNAL_DECL duk_bool_t duk_del_prop_index(duk_context *ctx, duk_idx_t obj_idx, duk_uarridx_t arr_idx);
  907. DUK_EXTERNAL_DECL duk_bool_t duk_del_prop_heapptr(duk_context *ctx, duk_idx_t obj_idx, void *ptr);
  908. DUK_EXTERNAL_DECL duk_bool_t duk_has_prop(duk_context *ctx, duk_idx_t obj_idx);
  909. DUK_EXTERNAL_DECL duk_bool_t duk_has_prop_string(duk_context *ctx, duk_idx_t obj_idx, const char *key);
  910. DUK_EXTERNAL_DECL duk_bool_t duk_has_prop_lstring(duk_context *ctx, duk_idx_t obj_idx, const char *key, duk_size_t key_len);
  911. DUK_EXTERNAL_DECL duk_bool_t duk_has_prop_index(duk_context *ctx, duk_idx_t obj_idx, duk_uarridx_t arr_idx);
  912. DUK_EXTERNAL_DECL duk_bool_t duk_has_prop_heapptr(duk_context *ctx, duk_idx_t obj_idx, void *ptr);
  913. DUK_EXTERNAL_DECL void duk_get_prop_desc(duk_context *ctx, duk_idx_t obj_idx, duk_uint_t flags);
  914. DUK_EXTERNAL_DECL void duk_def_prop(duk_context *ctx, duk_idx_t obj_idx, duk_uint_t flags);
  915. DUK_EXTERNAL_DECL duk_bool_t duk_get_global_string(duk_context *ctx, const char *key);
  916. DUK_EXTERNAL_DECL duk_bool_t duk_get_global_lstring(duk_context *ctx, const char *key, duk_size_t key_len);
  917. DUK_EXTERNAL_DECL duk_bool_t duk_put_global_string(duk_context *ctx, const char *key);
  918. DUK_EXTERNAL_DECL duk_bool_t duk_put_global_lstring(duk_context *ctx, const char *key, duk_size_t key_len);
  919. /*
  920. * Inspection
  921. */
  922. DUK_EXTERNAL_DECL void duk_inspect_value(duk_context *ctx, duk_idx_t idx);
  923. DUK_EXTERNAL_DECL void duk_inspect_callstack_entry(duk_context *ctx, duk_int_t level);
  924. /*
  925. * Object prototype
  926. */
  927. DUK_EXTERNAL_DECL void duk_get_prototype(duk_context *ctx, duk_idx_t idx);
  928. DUK_EXTERNAL_DECL void duk_set_prototype(duk_context *ctx, duk_idx_t idx);
  929. /*
  930. * Object finalizer
  931. */
  932. DUK_EXTERNAL_DECL void duk_get_finalizer(duk_context *ctx, duk_idx_t idx);
  933. DUK_EXTERNAL_DECL void duk_set_finalizer(duk_context *ctx, duk_idx_t idx);
  934. /*
  935. * Global object
  936. */
  937. DUK_EXTERNAL_DECL void duk_set_global_object(duk_context *ctx);
  938. /*
  939. * Duktape/C function magic value
  940. */
  941. DUK_EXTERNAL_DECL duk_int_t duk_get_magic(duk_context *ctx, duk_idx_t idx);
  942. DUK_EXTERNAL_DECL void duk_set_magic(duk_context *ctx, duk_idx_t idx, duk_int_t magic);
  943. DUK_EXTERNAL_DECL duk_int_t duk_get_current_magic(duk_context *ctx);
  944. /*
  945. * Module helpers: put multiple function or constant properties
  946. */
  947. DUK_EXTERNAL_DECL void duk_put_function_list(duk_context *ctx, duk_idx_t obj_idx, const duk_function_list_entry *funcs);
  948. DUK_EXTERNAL_DECL void duk_put_number_list(duk_context *ctx, duk_idx_t obj_idx, const duk_number_list_entry *numbers);
  949. /*
  950. * Object operations
  951. */
  952. DUK_EXTERNAL_DECL void duk_compact(duk_context *ctx, duk_idx_t obj_idx);
  953. DUK_EXTERNAL_DECL void duk_enum(duk_context *ctx, duk_idx_t obj_idx, duk_uint_t enum_flags);
  954. DUK_EXTERNAL_DECL duk_bool_t duk_next(duk_context *ctx, duk_idx_t enum_idx, duk_bool_t get_value);
  955. DUK_EXTERNAL_DECL void duk_seal(duk_context *ctx, duk_idx_t obj_idx);
  956. DUK_EXTERNAL_DECL void duk_freeze(duk_context *ctx, duk_idx_t obj_idx);
  957. /*
  958. * String manipulation
  959. */
  960. DUK_EXTERNAL_DECL void duk_concat(duk_context *ctx, duk_idx_t count);
  961. DUK_EXTERNAL_DECL void duk_join(duk_context *ctx, duk_idx_t count);
  962. DUK_EXTERNAL_DECL void duk_decode_string(duk_context *ctx, duk_idx_t idx, duk_decode_char_function callback, void *udata);
  963. DUK_EXTERNAL_DECL void duk_map_string(duk_context *ctx, duk_idx_t idx, duk_map_char_function callback, void *udata);
  964. DUK_EXTERNAL_DECL void duk_substring(duk_context *ctx, duk_idx_t idx, duk_size_t start_char_offset, duk_size_t end_char_offset);
  965. DUK_EXTERNAL_DECL void duk_trim(duk_context *ctx, duk_idx_t idx);
  966. DUK_EXTERNAL_DECL duk_codepoint_t duk_char_code_at(duk_context *ctx, duk_idx_t idx, duk_size_t char_offset);
  967. /*
  968. * Ecmascript operators
  969. */
  970. DUK_EXTERNAL_DECL duk_bool_t duk_equals(duk_context *ctx, duk_idx_t idx1, duk_idx_t idx2);
  971. DUK_EXTERNAL_DECL duk_bool_t duk_strict_equals(duk_context *ctx, duk_idx_t idx1, duk_idx_t idx2);
  972. DUK_EXTERNAL_DECL duk_bool_t duk_samevalue(duk_context *ctx, duk_idx_t idx1, duk_idx_t idx2);
  973. DUK_EXTERNAL_DECL duk_bool_t duk_instanceof(duk_context *ctx, duk_idx_t idx1, duk_idx_t idx2);
  974. /*
  975. * Function (method) calls
  976. */
  977. DUK_EXTERNAL_DECL void duk_call(duk_context *ctx, duk_idx_t nargs);
  978. DUK_EXTERNAL_DECL void duk_call_method(duk_context *ctx, duk_idx_t nargs);
  979. DUK_EXTERNAL_DECL void duk_call_prop(duk_context *ctx, duk_idx_t obj_idx, duk_idx_t nargs);
  980. DUK_EXTERNAL_DECL duk_int_t duk_pcall(duk_context *ctx, duk_idx_t nargs);
  981. DUK_EXTERNAL_DECL duk_int_t duk_pcall_method(duk_context *ctx, duk_idx_t nargs);
  982. DUK_EXTERNAL_DECL duk_int_t duk_pcall_prop(duk_context *ctx, duk_idx_t obj_idx, duk_idx_t nargs);
  983. DUK_EXTERNAL_DECL void duk_new(duk_context *ctx, duk_idx_t nargs);
  984. DUK_EXTERNAL_DECL duk_int_t duk_pnew(duk_context *ctx, duk_idx_t nargs);
  985. DUK_EXTERNAL_DECL duk_int_t duk_safe_call(duk_context *ctx, duk_safe_call_function func, void *udata, duk_idx_t nargs, duk_idx_t nrets);
  986. /*
  987. * Thread management
  988. */
  989. /* There are currently no native functions to yield/resume, due to the internal
  990. * limitations on coroutine handling. These will be added later.
  991. */
  992. /*
  993. * Compilation and evaluation
  994. */
  995. DUK_EXTERNAL_DECL duk_int_t duk_eval_raw(duk_context *ctx, const char *src_buffer, duk_size_t src_length, duk_uint_t flags);
  996. DUK_EXTERNAL_DECL duk_int_t duk_compile_raw(duk_context *ctx, const char *src_buffer, duk_size_t src_length, duk_uint_t flags);
  997. /* plain */
  998. #define duk_eval(ctx) \
  999. ((void) duk_eval_raw((ctx), NULL, 0, 1 /*args*/ | DUK_COMPILE_EVAL | DUK_COMPILE_NOFILENAME))
  1000. #define duk_eval_noresult(ctx) \
  1001. ((void) duk_eval_raw((ctx), NULL, 0, 1 /*args*/ | DUK_COMPILE_EVAL | DUK_COMPILE_NORESULT | DUK_COMPILE_NOFILENAME))
  1002. #define duk_peval(ctx) \
  1003. (duk_eval_raw((ctx), NULL, 0, 1 /*args*/ | DUK_COMPILE_EVAL | DUK_COMPILE_SAFE | DUK_COMPILE_NOFILENAME))
  1004. #define duk_peval_noresult(ctx) \
  1005. (duk_eval_raw((ctx), NULL, 0, 1 /*args*/ | DUK_COMPILE_EVAL | DUK_COMPILE_SAFE | DUK_COMPILE_NORESULT | DUK_COMPILE_NOFILENAME))
  1006. #define duk_compile(ctx,flags) \
  1007. ((void) duk_compile_raw((ctx), NULL, 0, 2 /*args*/ | (flags)))
  1008. #define duk_pcompile(ctx,flags) \
  1009. (duk_compile_raw((ctx), NULL, 0, 2 /*args*/ | (flags) | DUK_COMPILE_SAFE))
  1010. /* string */
  1011. #define duk_eval_string(ctx,src) \
  1012. ((void) duk_eval_raw((ctx), (src), 0, 0 /*args*/ | DUK_COMPILE_EVAL | DUK_COMPILE_NOSOURCE | DUK_COMPILE_STRLEN | DUK_COMPILE_NOFILENAME))
  1013. #define duk_eval_string_noresult(ctx,src) \
  1014. ((void) duk_eval_raw((ctx), (src), 0, 0 /*args*/ | DUK_COMPILE_EVAL | DUK_COMPILE_NOSOURCE | DUK_COMPILE_STRLEN | DUK_COMPILE_NORESULT | DUK_COMPILE_NOFILENAME))
  1015. #define duk_peval_string(ctx,src) \
  1016. (duk_eval_raw((ctx), (src), 0, 0 /*args*/ | DUK_COMPILE_EVAL | DUK_COMPILE_SAFE | DUK_COMPILE_NOSOURCE | DUK_COMPILE_STRLEN | DUK_COMPILE_NOFILENAME))
  1017. #define duk_peval_string_noresult(ctx,src) \
  1018. (duk_eval_raw((ctx), (src), 0, 0 /*args*/ | DUK_COMPILE_EVAL | DUK_COMPILE_SAFE | DUK_COMPILE_NOSOURCE | DUK_COMPILE_STRLEN | DUK_COMPILE_NORESULT | DUK_COMPILE_NOFILENAME))
  1019. #define duk_compile_string(ctx,flags,src) \
  1020. ((void) duk_compile_raw((ctx), (src), 0, 0 /*args*/ | (flags) | DUK_COMPILE_NOSOURCE | DUK_COMPILE_STRLEN | DUK_COMPILE_NOFILENAME))
  1021. #define duk_compile_string_filename(ctx,flags,src) \
  1022. ((void) duk_compile_raw((ctx), (src), 0, 1 /*args*/ | (flags) | DUK_COMPILE_NOSOURCE | DUK_COMPILE_STRLEN))
  1023. #define duk_pcompile_string(ctx,flags,src) \
  1024. (duk_compile_raw((ctx), (src), 0, 0 /*args*/ | (flags) | DUK_COMPILE_SAFE | DUK_COMPILE_NOSOURCE | DUK_COMPILE_STRLEN | DUK_COMPILE_NOFILENAME))
  1025. #define duk_pcompile_string_filename(ctx,flags,src) \
  1026. (duk_compile_raw((ctx), (src), 0, 1 /*args*/ | (flags) | DUK_COMPILE_SAFE | DUK_COMPILE_NOSOURCE | DUK_COMPILE_STRLEN))
  1027. /* lstring */
  1028. #define duk_eval_lstring(ctx,buf,len) \
  1029. ((void) duk_eval_raw((ctx), buf, len, 0 /*args*/ | DUK_COMPILE_EVAL | DUK_COMPILE_NOSOURCE | DUK_COMPILE_NOFILENAME))
  1030. #define duk_eval_lstring_noresult(ctx,buf,len) \
  1031. ((void) duk_eval_raw((ctx), buf, len, 0 /*args*/ | DUK_COMPILE_EVAL | DUK_COMPILE_NOSOURCE | DUK_COMPILE_NORESULT | DUK_COMPILE_NOFILENAME))
  1032. #define duk_peval_lstring(ctx,buf,len) \
  1033. (duk_eval_raw((ctx), buf, len, 0 /*args*/ | DUK_COMPILE_EVAL | DUK_COMPILE_NOSOURCE | DUK_COMPILE_SAFE | DUK_COMPILE_NOFILENAME))
  1034. #define duk_peval_lstring_noresult(ctx,buf,len) \
  1035. (duk_eval_raw((ctx), buf, len, 0 /*args*/ | DUK_COMPILE_EVAL | DUK_COMPILE_SAFE | DUK_COMPILE_NOSOURCE | DUK_COMPILE_NORESULT | DUK_COMPILE_NOFILENAME))
  1036. #define duk_compile_lstring(ctx,flags,buf,len) \
  1037. ((void) duk_compile_raw((ctx), buf, len, 0 /*args*/ | (flags) | DUK_COMPILE_NOSOURCE | DUK_COMPILE_NOFILENAME))
  1038. #define duk_compile_lstring_filename(ctx,flags,buf,len) \
  1039. ((void) duk_compile_raw((ctx), buf, len, 1 /*args*/ | (flags) | DUK_COMPILE_NOSOURCE))
  1040. #define duk_pcompile_lstring(ctx,flags,buf,len) \
  1041. (duk_compile_raw((ctx), buf, len, 0 /*args*/ | (flags) | DUK_COMPILE_SAFE | DUK_COMPILE_NOSOURCE | DUK_COMPILE_NOFILENAME))
  1042. #define duk_pcompile_lstring_filename(ctx,flags,buf,len) \
  1043. (duk_compile_raw((ctx), buf, len, 1 /*args*/ | (flags) | DUK_COMPILE_SAFE | DUK_COMPILE_NOSOURCE))
  1044. /*
  1045. * Bytecode load/dump
  1046. */
  1047. DUK_EXTERNAL_DECL void duk_dump_function(duk_context *ctx);
  1048. DUK_EXTERNAL_DECL void duk_load_function(duk_context *ctx);
  1049. /*
  1050. * Debugging
  1051. */
  1052. DUK_EXTERNAL_DECL void duk_push_context_dump(duk_context *ctx);
  1053. /*
  1054. * Debugger (debug protocol)
  1055. */
  1056. DUK_EXTERNAL_DECL void duk_debugger_attach(duk_context *ctx,
  1057. duk_debug_read_function read_cb,
  1058. duk_debug_write_function write_cb,
  1059. duk_debug_peek_function peek_cb,
  1060. duk_debug_read_flush_function read_flush_cb,
  1061. duk_debug_write_flush_function write_flush_cb,
  1062. duk_debug_request_function request_cb,
  1063. duk_debug_detached_function detached_cb,
  1064. void *udata);
  1065. DUK_EXTERNAL_DECL void duk_debugger_detach(duk_context *ctx);
  1066. DUK_EXTERNAL_DECL void duk_debugger_cooperate(duk_context *ctx);
  1067. DUK_EXTERNAL_DECL duk_bool_t duk_debugger_notify(duk_context *ctx, duk_idx_t nvalues);
  1068. DUK_EXTERNAL_DECL void duk_debugger_pause(duk_context *ctx);
  1069. /*
  1070. * Time handling
  1071. */
  1072. DUK_EXTERNAL_DECL duk_double_t duk_get_now(duk_context *ctx);
  1073. DUK_EXTERNAL_DECL void duk_time_to_components(duk_context *ctx, duk_double_t timeval, duk_time_components *comp);
  1074. DUK_EXTERNAL_DECL duk_double_t duk_components_to_time(duk_context *ctx, duk_time_components *comp);
  1075. /*
  1076. * Date provider related constants
  1077. *
  1078. * NOTE: These are "semi public" - you should only use these if you write
  1079. * your own platform specific Date provider, see doc/datetime.rst.
  1080. */
  1081. /* Millisecond count constants. */
  1082. #define DUK_DATE_MSEC_SECOND 1000L
  1083. #define DUK_DATE_MSEC_MINUTE (60L * 1000L)
  1084. #define DUK_DATE_MSEC_HOUR (60L * 60L * 1000L)
  1085. #define DUK_DATE_MSEC_DAY (24L * 60L * 60L * 1000L)
  1086. /* Ecmascript date range is 100 million days from Epoch:
  1087. * > 100e6 * 24 * 60 * 60 * 1000 // 100M days in millisecs
  1088. * 8640000000000000
  1089. * (= 8.64e15)
  1090. */
  1091. #define DUK_DATE_MSEC_100M_DAYS (8.64e15)
  1092. #define DUK_DATE_MSEC_100M_DAYS_LEEWAY (8.64e15 + 24 * 3600e3)
  1093. /* Ecmascript year range:
  1094. * > new Date(100e6 * 24 * 3600e3).toISOString()
  1095. * '+275760-09-13T00:00:00.000Z'
  1096. * > new Date(-100e6 * 24 * 3600e3).toISOString()
  1097. * '-271821-04-20T00:00:00.000Z'
  1098. */
  1099. #define DUK_DATE_MIN_ECMA_YEAR (-271821L)
  1100. #define DUK_DATE_MAX_ECMA_YEAR 275760L
  1101. /* Part indices for internal breakdowns. Part order from DUK_DATE_IDX_YEAR
  1102. * to DUK_DATE_IDX_MILLISECOND matches argument ordering of Ecmascript API
  1103. * calls (like Date constructor call). Some functions in duk_bi_date.c
  1104. * depend on the specific ordering, so change with care. 16 bits are not
  1105. * enough for all parts (year, specifically).
  1106. *
  1107. * Must be in-sync with genbuiltins.py.
  1108. */
  1109. #define DUK_DATE_IDX_YEAR 0 /* year */
  1110. #define DUK_DATE_IDX_MONTH 1 /* month: 0 to 11 */
  1111. #define DUK_DATE_IDX_DAY 2 /* day within month: 0 to 30 */
  1112. #define DUK_DATE_IDX_HOUR 3
  1113. #define DUK_DATE_IDX_MINUTE 4
  1114. #define DUK_DATE_IDX_SECOND 5
  1115. #define DUK_DATE_IDX_MILLISECOND 6
  1116. #define DUK_DATE_IDX_WEEKDAY 7 /* weekday: 0 to 6, 0=sunday, 1=monday, etc */
  1117. #define DUK_DATE_IDX_NUM_PARTS 8
  1118. /* Internal API call flags, used for various functions in duk_bi_date.c.
  1119. * Certain flags are used by only certain functions, but since the flags
  1120. * don't overlap, a single flags value can be passed around to multiple
  1121. * functions.
  1122. *
  1123. * The unused top bits of the flags field are also used to pass values
  1124. * to helpers (duk__get_part_helper() and duk__set_part_helper()).
  1125. *
  1126. * Must be in-sync with genbuiltins.py.
  1127. */
  1128. /* NOTE: when writing a Date provider you only need a few specific
  1129. * flags from here, the rest are internal. Avoid using anything you
  1130. * don't need.
  1131. */
  1132. #define DUK_DATE_FLAG_NAN_TO_ZERO (1 << 0) /* timeval breakdown: internal time value NaN -> zero */
  1133. #define DUK_DATE_FLAG_NAN_TO_RANGE_ERROR (1 << 1) /* timeval breakdown: internal time value NaN -> RangeError (toISOString) */
  1134. #define DUK_DATE_FLAG_ONEBASED (1 << 2) /* timeval breakdown: convert month and day-of-month parts to one-based (default is zero-based) */
  1135. #define DUK_DATE_FLAG_EQUIVYEAR (1 << 3) /* timeval breakdown: replace year with equivalent year in the [1971,2037] range for DST calculations */
  1136. #define DUK_DATE_FLAG_LOCALTIME (1 << 4) /* convert time value to local time */
  1137. #define DUK_DATE_FLAG_SUB1900 (1 << 5) /* getter: subtract 1900 from year when getting year part */
  1138. #define DUK_DATE_FLAG_TOSTRING_DATE (1 << 6) /* include date part in string conversion result */
  1139. #define DUK_DATE_FLAG_TOSTRING_TIME (1 << 7) /* include time part in string conversion result */
  1140. #define DUK_DATE_FLAG_TOSTRING_LOCALE (1 << 8) /* use locale specific formatting if available */
  1141. #define DUK_DATE_FLAG_TIMESETTER (1 << 9) /* setter: call is a time setter (affects hour, min, sec, ms); otherwise date setter (affects year, month, day-in-month) */
  1142. #define DUK_DATE_FLAG_YEAR_FIXUP (1 << 10) /* setter: perform 2-digit year fixup (00...99 -> 1900...1999) */
  1143. #define DUK_DATE_FLAG_SEP_T (1 << 11) /* string conversion: use 'T' instead of ' ' as a separator */
  1144. #define DUK_DATE_FLAG_VALUE_SHIFT 12 /* additional values begin at bit 12 */
  1145. /*
  1146. * ROM pointer compression
  1147. */
  1148. /* Support array for ROM pointer compression. Only declared when ROM
  1149. * pointer compression is active.
  1150. */
  1151. #if defined(DUK_USE_ROM_OBJECTS) && defined(DUK_USE_HEAPPTR16)
  1152. DUK_EXTERNAL_DECL const void * const duk_rom_compressed_pointers[];
  1153. #endif
  1154. /*
  1155. * C++ name mangling
  1156. */
  1157. #if defined(__cplusplus)
  1158. /* end 'extern "C"' wrapper */
  1159. }
  1160. #endif
  1161. /*
  1162. * END PUBLIC API
  1163. */
  1164. #endif /* DUKTAPE_H_INCLUDED */