forked from swiftwasm/JavaScriptKit
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy path_CJavaScriptKit.h
More file actions
328 lines (299 loc) · 15.4 KB
/
Copy path_CJavaScriptKit.h
File metadata and controls
328 lines (299 loc) · 15.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
#ifndef _CJavaScriptKit_h
#define _CJavaScriptKit_h
#include <stdlib.h>
#include <stdbool.h>
#include <stdint.h>
/// `JavaScriptObjectRef` represents JavaScript object reference that is referenced by Swift side.
/// This value is an address of `SwiftRuntimeHeap`.
typedef unsigned int JavaScriptObjectRef;
/// `JavaScriptHostFuncRef` represents Swift closure that is referenced by JavaScript side.
/// This value is produced by `JSClosure`.
typedef uintptr_t JavaScriptHostFuncRef;
/// `JavaScriptValueKind` represents the kind of JavaScript primitive value.
typedef enum __attribute__((enum_extensibility(closed))) {
JavaScriptValueKindBoolean = 0,
JavaScriptValueKindString = 1,
JavaScriptValueKindNumber = 2,
JavaScriptValueKindObject = 3,
JavaScriptValueKindNull = 4,
JavaScriptValueKindUndefined = 5,
JavaScriptValueKindFunction = 6,
JavaScriptValueKindSymbol = 7,
JavaScriptValueKindBigInt = 8,
} JavaScriptValueKind;
typedef struct {
JavaScriptValueKind kind: 31;
bool isException: 1;
} JavaScriptValueKindAndFlags;
typedef unsigned JavaScriptPayload1;
typedef double JavaScriptPayload2;
/// `RawJSValue` is abstract representaion of JavaScript primitive value.
///
/// For boolean value:
/// payload1: 1 or 0
/// payload2: 0
///
/// For string value:
/// payload1: `JavaScriptObjectRef` of string
/// payload2: 0
///
/// For number value:
/// payload1: 0
/// payload2: double number
///
/// For object value:
/// payload1: `JavaScriptObjectRef`
/// payload2: 0
/// For null value:
/// payload1: 0
/// payload2: 0
///
/// For undefined value:
/// payload1: 0
/// payload2: 0
///
/// For function value:
/// payload1: the target `JavaScriptHostFuncRef`
/// payload2: 0
///
/// For symbol and bigint values:
/// payload1: `JavaScriptObjectRef`
/// payload2: 0
///
typedef struct {
JavaScriptValueKind kind;
JavaScriptPayload1 payload1;
JavaScriptPayload2 payload2;
} RawJSValue;
#if __wasm32__
/// `_set_prop` sets a value of `_this` JavaScript object.
///
/// @param _this The target JavaScript object to set the given value.
/// @param prop A JavaScript string object to reference a member of `_this` object.
/// @param kind A kind of JavaScript value to set the target object.
/// @param payload1 The first payload of JavaScript value to set the target object.
/// @param payload2 The second payload of JavaScript value to set the target object.
__attribute__((__import_module__("javascript_kit"),
__import_name__("swjs_set_prop")))
extern void _set_prop(const JavaScriptObjectRef _this,
const JavaScriptObjectRef prop,
const JavaScriptValueKind kind,
const JavaScriptPayload1 payload1,
const JavaScriptPayload2 payload2);
/// `_get_prop` gets a value of `_this` JavaScript object.
///
/// @param _this The target JavaScript object to get its member value.
/// @param prop A JavaScript string object to reference a member of `_this` object.
/// @param payload1 A result pointer of first payload of JavaScript value to set the target object.
/// @param payload2 A result pointer of second payload of JavaScript value to set the target object.
/// @return A `JavaScriptValueKind` bits represented as 32bit integer for the returned value.
__attribute__((__import_module__("javascript_kit"),
__import_name__("swjs_get_prop")))
extern uint32_t _get_prop(
const JavaScriptObjectRef _this,
const JavaScriptObjectRef prop,
JavaScriptPayload1 *payload1,
JavaScriptPayload2 *payload2
);
/// `_set_subscript` sets a value of `_this` JavaScript object.
///
/// @param _this The target JavaScript object to set its member value.
/// @param index A subscript index to set value.
/// @param kind A kind of JavaScript value to set the target object.
/// @param payload1 The first payload of JavaScript value to set the target object.
/// @param payload2 The second payload of JavaScript value to set the target object.
__attribute__((__import_module__("javascript_kit"),
__import_name__("swjs_set_subscript")))
extern void _set_subscript(const JavaScriptObjectRef _this,
const int index,
const JavaScriptValueKind kind,
const JavaScriptPayload1 payload1,
const JavaScriptPayload2 payload2);
/// `_get_subscript` gets a value of `_this` JavaScript object.
///
/// @param _this The target JavaScript object to get its member value.
/// @param index A subscript index to get value.
/// @param payload1 A result pointer of first payload of JavaScript value to get the target object.
/// @param payload2 A result pointer of second payload of JavaScript value to get the target object.
/// @return A `JavaScriptValueKind` bits represented as 32bit integer for the returned value.
__attribute__((__import_module__("javascript_kit"),
__import_name__("swjs_get_subscript")))
extern uint32_t _get_subscript(
const JavaScriptObjectRef _this,
const int index,
JavaScriptPayload1 *payload1,
JavaScriptPayload2 *payload2
);
/// `_encode_string` encodes the `str_obj` to bytes sequence and returns the length of bytes.
///
/// @param str_obj A JavaScript string object ref to encode.
/// @param bytes_result A result pointer of bytes sequence representation in JavaScript.
/// This value will be used to load the actual bytes using `_load_string`.
/// @result The length of bytes sequence. This value will be used to allocate Swift side string buffer to load the actual bytes.
__attribute__((__import_module__("javascript_kit"),
__import_name__("swjs_encode_string")))
extern int _encode_string(const JavaScriptObjectRef str_obj, JavaScriptObjectRef *bytes_result);
/// `_decode_string` decodes the given bytes sequence into JavaScript string object.
///
/// @param bytes_ptr A `uint8_t` byte sequence to decode.
/// @param length The length of `bytes_ptr`.
/// @result The decoded JavaScript string object.
__attribute__((__import_module__("javascript_kit"),
__import_name__("swjs_decode_string")))
extern JavaScriptObjectRef _decode_string(const unsigned char *bytes_ptr, const int length);
/// `_load_string` loads the actual bytes sequence of `bytes` into `buffer` which is a Swift side memory address.
///
/// @param bytes A bytes sequence representation in JavaScript to load. This value should be derived from `_encode_string`.
/// @param buffer A Swift side string buffer to load the bytes.
__attribute__((__import_module__("javascript_kit"),
__import_name__("swjs_load_string")))
extern void _load_string(const JavaScriptObjectRef bytes, unsigned char *buffer);
/// Converts the provided Int64 or UInt64 to a BigInt in slow path by splitting 64bit integer to two 32bit integers
/// to avoid depending on [JS-BigInt-integration](https://github.com/WebAssembly/JS-BigInt-integration) feature
///
/// @param lower The lower 32bit of the value to convert.
/// @param upper The upper 32bit of the value to convert.
/// @param is_signed Whether to treat the value as a signed integer or not.
__attribute__((__import_module__("javascript_kit"),
__import_name__("swjs_i64_to_bigint_slow")))
extern JavaScriptObjectRef _i64_to_bigint_slow(unsigned int lower, unsigned int upper, bool is_signed);
/// `_call_function` calls JavaScript function with given arguments list.
///
/// @param ref The target JavaScript function to call.
/// @param argv A list of `RawJSValue` arguments to apply.
/// @param argc The length of `argv``.
/// @param result_payload1 A result pointer of first payload of JavaScript value of returned result or thrown exception.
/// @param result_payload2 A result pointer of second payload of JavaScript value of returned result or thrown exception.
/// @return A `JavaScriptValueKindAndFlags` bits represented as 32bit integer for the returned value.
__attribute__((__import_module__("javascript_kit"),
__import_name__("swjs_call_function")))
extern uint32_t _call_function(
const JavaScriptObjectRef ref, const RawJSValue *argv,
const int argc,
JavaScriptPayload1 *result_payload1,
JavaScriptPayload2 *result_payload2
);
/// `_call_function` calls JavaScript function with given arguments list without capturing any exception
///
/// @param ref The target JavaScript function to call.
/// @param argv A list of `RawJSValue` arguments to apply.
/// @param argc The length of `argv``.
/// @param result_payload1 A result pointer of first payload of JavaScript value of returned result or thrown exception.
/// @param result_payload2 A result pointer of second payload of JavaScript value of returned result or thrown exception.
/// @return A `JavaScriptValueKindAndFlags` bits represented as 32bit integer for the returned value.
__attribute__((__import_module__("javascript_kit"),
__import_name__("swjs_call_function_no_catch")))
extern uint32_t _call_function_no_catch(
const JavaScriptObjectRef ref, const RawJSValue *argv,
const int argc,
JavaScriptPayload1 *result_payload1,
JavaScriptPayload2 *result_payload2
);
/// `_call_function_with_this` calls JavaScript function with given arguments list and given `_this`.
///
/// @param _this The value of `this` provided for the call to `func_ref`.
/// @param func_ref The target JavaScript function to call.
/// @param argv A list of `RawJSValue` arguments to apply.
/// @param argc The length of `argv``.
/// @param result_payload1 A result pointer of first payload of JavaScript value of returned result or thrown exception.
/// @param result_payload2 A result pointer of second payload of JavaScript value of returned result or thrown exception.
/// @return A `JavaScriptValueKindAndFlags` bits represented as 32bit integer for the returned value.
__attribute__((__import_module__("javascript_kit"),
__import_name__("swjs_call_function_with_this")))
extern uint32_t _call_function_with_this(
const JavaScriptObjectRef _this,
const JavaScriptObjectRef func_ref,
const RawJSValue *argv, const int argc,
JavaScriptPayload1 *result_payload1,
JavaScriptPayload2 *result_payload2
);
/// `_call_function_with_this` calls JavaScript function with given arguments list and given `_this` without capturing any exception.
///
/// @param _this The value of `this` provided for the call to `func_ref`.
/// @param func_ref The target JavaScript function to call.
/// @param argv A list of `RawJSValue` arguments to apply.
/// @param argc The length of `argv``.
/// @param result_payload1 A result pointer of first payload of JavaScript value of returned result or thrown exception.
/// @param result_payload2 A result pointer of second payload of JavaScript value of returned result or thrown exception.
/// @return A `JavaScriptValueKindAndFlags` bits represented as 32bit integer for the returned value.
__attribute__((__import_module__("javascript_kit"),
__import_name__("swjs_call_function_with_this_no_catch")))
extern uint32_t _call_function_with_this_no_catch(
const JavaScriptObjectRef _this,
const JavaScriptObjectRef func_ref,
const RawJSValue *argv, const int argc,
JavaScriptPayload1 *result_payload1,
JavaScriptPayload2 *result_payload2
);
/// `_call_new` calls JavaScript object constructor with given arguments list.
///
/// @param ref The target JavaScript constructor to call.
/// @param argv A list of `RawJSValue` arguments to apply.
/// @param argc The length of `argv``.
/// @returns A reference to the constructed object.
__attribute__((__import_module__("javascript_kit"),
__import_name__("swjs_call_new")))
extern JavaScriptObjectRef _call_new(const JavaScriptObjectRef ref,
const RawJSValue *argv, const int argc);
/// `_call_throwing_new` calls JavaScript object constructor with given arguments list.
///
/// @param ref The target JavaScript constructor to call.
/// @param argv A list of `RawJSValue` arguments to apply.
/// @param argc The length of `argv``.
/// @param exception_kind A result pointer of JavaScript value kind of thrown exception.
/// @param exception_payload1 A result pointer of first payload of JavaScript value of thrown exception.
/// @param exception_payload2 A result pointer of second payload of JavaScript value of thrown exception.
/// @returns A reference to the constructed object.
__attribute__((__import_module__("javascript_kit"),
__import_name__("swjs_call_throwing_new")))
extern JavaScriptObjectRef _call_throwing_new(const JavaScriptObjectRef ref,
const RawJSValue *argv, const int argc,
JavaScriptValueKindAndFlags *exception_kind,
JavaScriptPayload1 *exception_payload1,
JavaScriptPayload2 *exception_payload2);
/// `_instanceof` acts like JavaScript `instanceof` operator.
///
/// @param obj The target object to check its prototype chain.
/// @param constructor The `constructor` object to check against.
/// @result Return `true` if `constructor` appears anywhere in the prototype chain of `obj`. Return `false` if not.
__attribute__((__import_module__("javascript_kit"),
__import_name__("swjs_instanceof")))
extern bool _instanceof(const JavaScriptObjectRef obj,
const JavaScriptObjectRef constructor);
/// `_create_function` creates a JavaScript thunk function that calls Swift side closure.
/// See also comments on JSFunction.swift
///
/// @param host_func_id The target Swift side function called by the created thunk function.
/// @param line The line where the function is created. Will be used for diagnostics
/// @param file The file name where the function is created. Will be used for diagnostics
/// @returns A reference to the newly-created JavaScript thunk function
__attribute__((__import_module__("javascript_kit"),
__import_name__("swjs_create_function")))
extern JavaScriptObjectRef _create_function(const JavaScriptHostFuncRef host_func_id,
unsigned int line, JavaScriptObjectRef file);
/// Instantiate a new `TypedArray` object with given elements
/// This is used to provide an efficient way to create `TypedArray`.
///
/// @param constructor The `TypedArray` constructor.
/// @param elements_ptr The elements pointer to initialize. They are assumed to be the same size of `constructor` elements size.
/// @param length The length of `elements_ptr`
/// @returns A reference to the constructed typed array
__attribute__((__import_module__("javascript_kit"),
__import_name__("swjs_create_typed_array")))
extern JavaScriptObjectRef _create_typed_array(const JavaScriptObjectRef constructor,
const void *elements_ptr, const int length);
/// Copies the byte contents of a typed array into a Swift side memory buffer.
///
/// @param ref A JavaScript typed array object.
/// @param buffer A Swift side buffer into which to copy the bytes.
__attribute__((__import_module__("javascript_kit"),
__import_name__("swjs_load_typed_array")))
extern void _load_typed_array(const JavaScriptObjectRef ref, unsigned char *buffer);
/// Decrements reference count of `ref` retained by `SwiftRuntimeHeap` in JavaScript side.
///
/// @param ref The target JavaScript object.
__attribute__((__import_module__("javascript_kit"),
__import_name__("swjs_release")))
extern void _release(const JavaScriptObjectRef ref);
#endif
#endif /* _CJavaScriptKit_h */