]> git.proxmox.com Git - ceph.git/blame - ceph/src/civetweb/src/third_party/duktape-1.8.0/src-separate/duk_api_internal.h
import 12.2.13 release
[ceph.git] / ceph / src / civetweb / src / third_party / duktape-1.8.0 / src-separate / duk_api_internal.h
CommitLineData
7c673cae
FG
1/*
2 * Internal API calls which have (stack and other) semantics similar
3 * to the public API.
4 */
5
6#ifndef DUK_API_INTERNAL_H_INCLUDED
7#define DUK_API_INTERNAL_H_INCLUDED
8
9/* duk_push_sprintf constants */
10#define DUK_PUSH_SPRINTF_INITIAL_SIZE 256L
11#define DUK_PUSH_SPRINTF_SANITY_LIMIT (1L * 1024L * 1024L * 1024L)
12
13/* Flag ORed to err_code to indicate __FILE__ / __LINE__ is not
14 * blamed as source of error for error fileName / lineNumber.
15 */
16#define DUK_ERRCODE_FLAG_NOBLAME_FILELINE (1L << 24)
17
18/* Valstack resize flags */
19#define DUK_VSRESIZE_FLAG_SHRINK (1 << 0)
20#define DUK_VSRESIZE_FLAG_COMPACT (1 << 1)
21#define DUK_VSRESIZE_FLAG_THROW (1 << 2)
22
23/* Current convention is to use duk_size_t for value stack sizes and global indices,
24 * and duk_idx_t for local frame indices.
25 */
26DUK_INTERNAL_DECL
27duk_bool_t duk_valstack_resize_raw(duk_context *ctx,
28 duk_size_t min_new_size,
29 duk_small_uint_t flags);
30
37b3c998
TL
31#if defined(DUK_USE_VERBOSE_ERRORS) && defined(DUK_USE_PARANOID_ERRORS)
32DUK_INTERNAL_DECL const char *duk_get_type_name(duk_context *ctx, duk_idx_t index);
33#endif
34
7c673cae
FG
35DUK_INTERNAL_DECL duk_tval *duk_get_tval(duk_context *ctx, duk_idx_t index);
36DUK_INTERNAL_DECL duk_tval *duk_require_tval(duk_context *ctx, duk_idx_t index);
37DUK_INTERNAL_DECL void duk_push_tval(duk_context *ctx, duk_tval *tv);
38
39/* Push the current 'this' binding; throw TypeError if binding is not object
40 * coercible (CheckObjectCoercible).
41 */
42DUK_INTERNAL_DECL void duk_push_this_check_object_coercible(duk_context *ctx);
43
44/* duk_push_this() + CheckObjectCoercible() + duk_to_object() */
45DUK_INTERNAL_DECL duk_hobject *duk_push_this_coercible_to_object(duk_context *ctx);
46
47/* duk_push_this() + CheckObjectCoercible() + duk_to_string() */
48DUK_INTERNAL_DECL duk_hstring *duk_push_this_coercible_to_string(duk_context *ctx);
49
50/* Get a borrowed duk_tval pointer to the current 'this' binding. Caller must
51 * make sure there's an active callstack entry. Note that the returned pointer
52 * is unstable with regards to side effects.
53 */
54DUK_INTERNAL_DECL duk_tval *duk_get_borrowed_this_tval(duk_context *ctx);
55
56/* XXX: add fastint support? */
57#define duk_push_u64(ctx,val) \
58 duk_push_number((ctx), (duk_double_t) (val))
59#define duk_push_i64(ctx,val) \
60 duk_push_number((ctx), (duk_double_t) (val))
61
62/* duk_push_(u)int() is guaranteed to support at least (un)signed 32-bit range */
63#define duk_push_u32(ctx,val) \
64 duk_push_uint((ctx), (duk_uint_t) (val))
65#define duk_push_i32(ctx,val) \
66 duk_push_int((ctx), (duk_int_t) (val))
67
68/* sometimes stack and array indices need to go on the stack */
69#define duk_push_idx(ctx,val) \
70 duk_push_int((ctx), (duk_int_t) (val))
71#define duk_push_uarridx(ctx,val) \
72 duk_push_uint((ctx), (duk_uint_t) (val))
73#define duk_push_size_t(ctx,val) \
74 duk_push_uint((ctx), (duk_uint_t) (val)) /* XXX: assumed to fit for now */
75
7c673cae
FG
76DUK_INTERNAL_DECL duk_hstring *duk_get_hstring(duk_context *ctx, duk_idx_t index);
77DUK_INTERNAL_DECL duk_hobject *duk_get_hobject(duk_context *ctx, duk_idx_t index);
78DUK_INTERNAL_DECL duk_hbuffer *duk_get_hbuffer(duk_context *ctx, duk_idx_t index);
79DUK_INTERNAL_DECL duk_hthread *duk_get_hthread(duk_context *ctx, duk_idx_t index);
80DUK_INTERNAL_DECL duk_hcompiledfunction *duk_get_hcompiledfunction(duk_context *ctx, duk_idx_t index);
81DUK_INTERNAL_DECL duk_hnativefunction *duk_get_hnativefunction(duk_context *ctx, duk_idx_t index);
82
37b3c998 83DUK_INTERNAL_DECL duk_hobject *duk_get_hobject_with_class(duk_context *ctx, duk_idx_t index, duk_small_uint_t classnum);
7c673cae
FG
84
85#if 0 /* This would be pointless: unexpected type and lightfunc would both return NULL */
86DUK_INTERNAL_DECL duk_hobject *duk_get_hobject_or_lfunc(duk_context *ctx, duk_idx_t index);
87#endif
88DUK_INTERNAL_DECL duk_hobject *duk_get_hobject_or_lfunc_coerce(duk_context *ctx, duk_idx_t index);
89
90#if 0 /*unused*/
91DUK_INTERNAL_DECL void *duk_get_voidptr(duk_context *ctx, duk_idx_t index);
92#endif
93
94DUK_INTERNAL_DECL duk_hstring *duk_to_hstring(duk_context *ctx, duk_idx_t index);
37b3c998
TL
95#if defined(DUK_USE_DEBUGGER_SUPPORT) /* only needed by debugger for now */
96DUK_INTERNAL_DECL duk_hstring *duk_safe_to_hstring(duk_context *ctx, duk_idx_t index);
97#endif
98DUK_INTERNAL_DECL void duk_to_object_class_string_top(duk_context *ctx);
99#if !defined(DUK_USE_PARANOID_ERRORS)
100DUK_INTERNAL_DECL void duk_push_hobject_class_string(duk_context *ctx, duk_hobject *h);
101#endif
102
7c673cae
FG
103DUK_INTERNAL_DECL duk_int_t duk_to_int_clamped_raw(duk_context *ctx, duk_idx_t index, duk_int_t minval, duk_int_t maxval, duk_bool_t *out_clamped); /* out_clamped=NULL, RangeError if outside range */
104DUK_INTERNAL_DECL duk_int_t duk_to_int_clamped(duk_context *ctx, duk_idx_t index, duk_int_t minval, duk_int_t maxval);
105DUK_INTERNAL_DECL duk_int_t duk_to_int_check_range(duk_context *ctx, duk_idx_t index, duk_int_t minval, duk_int_t maxval);
106#if defined(DUK_USE_BUFFEROBJECT_SUPPORT)
107DUK_INTERNAL_DECL duk_uint8_t duk_to_uint8clamped(duk_context *ctx, duk_idx_t index);
108#endif
109
110DUK_INTERNAL_DECL duk_hstring *duk_require_hstring(duk_context *ctx, duk_idx_t index);
111DUK_INTERNAL_DECL duk_hobject *duk_require_hobject(duk_context *ctx, duk_idx_t index);
112DUK_INTERNAL_DECL duk_hbuffer *duk_require_hbuffer(duk_context *ctx, duk_idx_t index);
113DUK_INTERNAL_DECL duk_hthread *duk_require_hthread(duk_context *ctx, duk_idx_t index);
114DUK_INTERNAL_DECL duk_hcompiledfunction *duk_require_hcompiledfunction(duk_context *ctx, duk_idx_t index);
115DUK_INTERNAL_DECL duk_hnativefunction *duk_require_hnativefunction(duk_context *ctx, duk_idx_t index);
116
37b3c998 117DUK_INTERNAL_DECL duk_hobject *duk_require_hobject_with_class(duk_context *ctx, duk_idx_t index, duk_small_uint_t classnum);
7c673cae
FG
118
119DUK_INTERNAL_DECL duk_hobject *duk_require_hobject_or_lfunc(duk_context *ctx, duk_idx_t index);
120DUK_INTERNAL_DECL duk_hobject *duk_require_hobject_or_lfunc_coerce(duk_context *ctx, duk_idx_t index);
121
7c673cae
FG
122DUK_INTERNAL_DECL void duk_push_hstring(duk_context *ctx, duk_hstring *h);
123DUK_INTERNAL_DECL void duk_push_hstring_stridx(duk_context *ctx, duk_small_int_t stridx);
124DUK_INTERNAL_DECL void duk_push_hobject(duk_context *ctx, duk_hobject *h);
125DUK_INTERNAL_DECL void duk_push_hbuffer(duk_context *ctx, duk_hbuffer *h);
126#define duk_push_hthread(ctx,h) \
127 duk_push_hobject((ctx), (duk_hobject *) (h))
128#define duk_push_hcompiledfunction(ctx,h) \
129 duk_push_hobject((ctx), (duk_hobject *) (h))
130#define duk_push_hnativefunction(ctx,h) \
131 duk_push_hobject((ctx), (duk_hobject *) (h))
132DUK_INTERNAL_DECL void duk_push_hobject_bidx(duk_context *ctx, duk_small_int_t builtin_idx);
133DUK_INTERNAL_DECL duk_idx_t duk_push_object_helper(duk_context *ctx, duk_uint_t hobject_flags_and_class, duk_small_int_t prototype_bidx);
134DUK_INTERNAL_DECL duk_idx_t duk_push_object_helper_proto(duk_context *ctx, duk_uint_t hobject_flags_and_class, duk_hobject *proto);
135DUK_INTERNAL_DECL duk_idx_t duk_push_object_internal(duk_context *ctx);
136DUK_INTERNAL_DECL duk_idx_t duk_push_compiledfunction(duk_context *ctx);
137DUK_INTERNAL_DECL void duk_push_c_function_noexotic(duk_context *ctx, duk_c_function func, duk_int_t nargs);
138DUK_INTERNAL_DECL void duk_push_c_function_noconstruct_noexotic(duk_context *ctx, duk_c_function func, duk_int_t nargs);
139
140DUK_INTERNAL_DECL void duk_push_string_funcptr(duk_context *ctx, duk_uint8_t *ptr, duk_size_t sz);
141DUK_INTERNAL_DECL void duk_push_lightfunc_name(duk_context *ctx, duk_tval *tv);
142DUK_INTERNAL_DECL void duk_push_lightfunc_tostring(duk_context *ctx, duk_tval *tv);
143DUK_INTERNAL_DECL duk_hbufferobject *duk_push_bufferobject_raw(duk_context *ctx, duk_uint_t hobject_flags_and_class, duk_small_int_t prototype_bidx);
144
37b3c998
TL
145#if !defined(DUK_USE_PARANOID_ERRORS)
146DUK_INTERNAL_DECL const char *duk_push_string_readable(duk_context *ctx, duk_idx_t index);
147DUK_INTERNAL_DECL const char *duk_push_string_tval_readable(duk_context *ctx, duk_tval *tv);
148#endif
149
7c673cae
FG
150DUK_INTERNAL_DECL duk_bool_t duk_get_prop_stridx(duk_context *ctx, duk_idx_t obj_index, duk_small_int_t stridx); /* [] -> [val] */
151DUK_INTERNAL_DECL duk_bool_t duk_put_prop_stridx(duk_context *ctx, duk_idx_t obj_index, duk_small_int_t stridx); /* [val] -> [] */
152DUK_INTERNAL_DECL duk_bool_t duk_del_prop_stridx(duk_context *ctx, duk_idx_t obj_index, duk_small_int_t stridx); /* [] -> [] */
153DUK_INTERNAL_DECL duk_bool_t duk_has_prop_stridx(duk_context *ctx, duk_idx_t obj_index, duk_small_int_t stridx); /* [] -> [] */
154
155DUK_INTERNAL_DECL duk_bool_t duk_get_prop_stridx_boolean(duk_context *ctx, duk_idx_t obj_index, duk_small_int_t stridx, duk_bool_t *out_has_prop); /* [] -> [] */
156
157DUK_INTERNAL_DECL void duk_xdef_prop(duk_context *ctx, duk_idx_t obj_index, duk_small_uint_t desc_flags); /* [key val] -> [] */
158DUK_INTERNAL_DECL void duk_xdef_prop_index(duk_context *ctx, duk_idx_t obj_index, duk_uarridx_t arr_index, duk_small_uint_t desc_flags); /* [val] -> [] */
159DUK_INTERNAL_DECL void duk_xdef_prop_stridx(duk_context *ctx, duk_idx_t obj_index, duk_small_int_t stridx, duk_small_uint_t desc_flags); /* [val] -> [] */
160DUK_INTERNAL_DECL void duk_xdef_prop_stridx_builtin(duk_context *ctx, duk_idx_t obj_index, duk_small_int_t stridx, duk_small_int_t builtin_idx, duk_small_uint_t desc_flags); /* [] -> [] */
161DUK_INTERNAL_DECL void duk_xdef_prop_stridx_thrower(duk_context *ctx, duk_idx_t obj_index, duk_small_int_t stridx, duk_small_uint_t desc_flags); /* [] -> [] */
162
163/* These are macros for now, but could be separate functions to reduce code
164 * footprint (check call site count before refactoring).
165 */
166#define duk_xdef_prop_wec(ctx,obj_index) \
167 duk_xdef_prop((ctx), (obj_index), DUK_PROPDESC_FLAGS_WEC)
168#define duk_xdef_prop_index_wec(ctx,obj_index,arr_index) \
169 duk_xdef_prop_index((ctx), (obj_index), (arr_index), DUK_PROPDESC_FLAGS_WEC)
170#define duk_xdef_prop_stridx_wec(ctx,obj_index,stridx) \
171 duk_xdef_prop_stridx((ctx), (obj_index), (stridx), DUK_PROPDESC_FLAGS_WEC)
172
173/* Set object 'length'. */
174DUK_INTERNAL_DECL void duk_set_length(duk_context *ctx, duk_idx_t index, duk_size_t length);
175
37b3c998
TL
176/* Raw internal valstack access macros: access is unsafe so call site
177 * must have a guarantee that the index is valid. When that is the case,
178 * using these macro results in faster and smaller code than duk_get_tval().
179 * Both 'ctx' and 'idx' are evaluted multiple times, but only for asserts.
180 */
181#define DUK_ASSERT_VALID_NEGIDX(ctx,idx) \
182 (DUK_ASSERT_EXPR((idx) < 0), DUK_ASSERT_EXPR(duk_is_valid_index((ctx), (idx))))
183#define DUK_ASSERT_VALID_POSIDX(ctx,idx) \
184 (DUK_ASSERT_EXPR((idx) >= 0), DUK_ASSERT_EXPR(duk_is_valid_index((ctx), (idx))))
185#define DUK_GET_TVAL_NEGIDX(ctx,idx) \
186 (DUK_ASSERT_VALID_NEGIDX((ctx),(idx)), ((duk_hthread *) (ctx))->valstack_top + (idx))
187#define DUK_GET_TVAL_POSIDX(ctx,idx) \
188 (DUK_ASSERT_VALID_POSIDX((ctx),(idx)), ((duk_hthread *) (ctx))->valstack_bottom + (idx))
189#define DUK_GET_HOBJECT_NEGIDX(ctx,idx) \
190 (DUK_ASSERT_VALID_NEGIDX((ctx),(idx)), DUK_TVAL_GET_OBJECT(((duk_hthread *) (ctx))->valstack_top + (idx)))
191#define DUK_GET_HOBJECT_POSIDX(ctx,idx) \
192 (DUK_ASSERT_VALID_POSIDX((ctx),(idx)), DUK_TVAL_GET_OBJECT(((duk_hthread *) (ctx))->valstack_bottom + (idx)))
193
7c673cae 194#endif /* DUK_API_INTERNAL_H_INCLUDED */