1 /**
2 * Copyright (c) 2021-2024 Huawei Device Co., Ltd.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16 #ifndef PANDA_PLUGINS_ETS_RUNTIME_INTEROP_JS_JS_CONVERT_H
17 #define PANDA_PLUGINS_ETS_RUNTIME_INTEROP_JS_JS_CONVERT_H
18
19 #include "js_convert_base.h"
20
21 namespace panda::ets::interop::js {
22
23 template <typename Cpptype>
24 struct JSConvertNumeric : public JSConvertBase<JSConvertNumeric<Cpptype>, Cpptype> {
25 static constexpr const char *TYPE_NAME = "number";
26
27 template <typename P = Cpptype>
WrapImplJSConvertNumeric28 static std::enable_if_t<std::is_integral_v<P>, napi_value> WrapImpl(napi_env env, Cpptype etsVal)
29 {
30 napi_value jsVal;
31 if constexpr (sizeof(Cpptype) >= sizeof(int32_t)) {
32 NAPI_CHECK_FATAL(napi_create_int64(env, etsVal, &jsVal));
33 } else if constexpr (std::is_signed_v<Cpptype>) {
34 NAPI_CHECK_FATAL(napi_create_int32(env, etsVal, &jsVal));
35 } else {
36 NAPI_CHECK_FATAL(napi_create_uint32(env, etsVal, &jsVal));
37 }
38 return jsVal;
39 }
40
41 template <typename P = Cpptype>
UnwrapImplJSConvertNumeric42 static std::enable_if_t<std::is_integral_v<P>, std::optional<Cpptype>> UnwrapImpl([[maybe_unused]] InteropCtx *ctx,
43 napi_env env, napi_value jsVal)
44 {
45 if (UNLIKELY(GetValueType(env, jsVal) != napi_number)) {
46 JSConvertNumeric::TypeCheckFailed();
47 return {};
48 }
49 Cpptype etsVal;
50 if constexpr (sizeof(Cpptype) >= sizeof(int32_t)) {
51 int64_t val;
52 NAPI_CHECK_FATAL(napi_get_value_int64(env, jsVal, &val));
53 etsVal = val;
54 } else if constexpr (std::is_signed_v<Cpptype>) {
55 int32_t val;
56 NAPI_CHECK_FATAL(napi_get_value_int32(env, jsVal, &val));
57 etsVal = val;
58 } else {
59 uint32_t val;
60 NAPI_CHECK_FATAL(napi_get_value_uint32(env, jsVal, &val));
61 etsVal = val;
62 }
63 return etsVal;
64 }
65
66 template <typename P = Cpptype>
WrapImplJSConvertNumeric67 static std::enable_if_t<std::is_floating_point_v<P>, napi_value> WrapImpl(napi_env env, Cpptype etsVal)
68 {
69 napi_value jsVal;
70 NAPI_CHECK_FATAL(napi_create_double(env, etsVal, &jsVal));
71 return jsVal;
72 }
73
74 template <typename P = Cpptype>
UnwrapImplJSConvertNumeric75 static std::enable_if_t<std::is_floating_point_v<P>, std::optional<Cpptype>> UnwrapImpl(
76 [[maybe_unused]] InteropCtx *ctx, napi_env env, napi_value jsVal)
77 {
78 if (UNLIKELY(GetValueType(env, jsVal) != napi_number)) {
79 JSConvertNumeric::TypeCheckFailed();
80 return {};
81 }
82 double val;
83 NAPI_CHECK_FATAL(napi_get_value_double(env, jsVal, &val));
84 return val;
85 }
86 };
87
88 using JSConvertI8 = JSConvertNumeric<int8_t>;
89 using JSConvertU8 = JSConvertNumeric<uint8_t>;
90 using JSConvertI16 = JSConvertNumeric<int16_t>;
91 using JSConvertU16 = JSConvertNumeric<uint16_t>;
92 using JSConvertI32 = JSConvertNumeric<int32_t>;
93 using JSConvertU32 = JSConvertNumeric<uint32_t>;
94 using JSConvertI64 = JSConvertNumeric<int64_t>;
95 using JSConvertU64 = JSConvertNumeric<uint64_t>;
96 using JSConvertF32 = JSConvertNumeric<float>;
97 using JSConvertF64 = JSConvertNumeric<double>;
98
99 JSCONVERT_DEFINE_TYPE(U1, bool);
JSCONVERT_WRAP(U1)100 JSCONVERT_WRAP(U1)
101 {
102 napi_value jsVal;
103 NAPI_CHECK_FATAL(napi_get_boolean(env, static_cast<bool>(etsVal), &jsVal));
104 return jsVal;
105 }
JSCONVERT_UNWRAP(U1)106 JSCONVERT_UNWRAP(U1)
107 {
108 if (UNLIKELY(GetValueType(env, jsVal) != napi_boolean)) {
109 TypeCheckFailed();
110 return {};
111 }
112 bool val;
113 NAPI_CHECK_FATAL(napi_get_value_bool(env, jsVal, &val));
114 return val;
115 }
116
117 JSCONVERT_DEFINE_TYPE(StdlibBoolean, EtsObject *);
JSCONVERT_WRAP(StdlibBoolean)118 JSCONVERT_WRAP(StdlibBoolean)
119 {
120 auto *val = reinterpret_cast<EtsBoxPrimitive<EtsBoolean> *>(etsVal);
121 napi_value jsVal;
122 NAPI_CHECK_FATAL(napi_get_boolean(env, val->GetValue(), &jsVal));
123 return jsVal;
124 }
JSCONVERT_UNWRAP(StdlibBoolean)125 JSCONVERT_UNWRAP(StdlibBoolean)
126 {
127 bool val;
128 NAPI_CHECK_FATAL(napi_get_value_bool(env, jsVal, &val));
129 return EtsBoxPrimitive<EtsBoolean>::Create(EtsCoroutine::GetCurrent(), static_cast<EtsBoolean>(val));
130 }
131
132 JSCONVERT_DEFINE_TYPE(StdlibByte, EtsObject *);
JSCONVERT_WRAP(StdlibByte)133 JSCONVERT_WRAP(StdlibByte)
134 {
135 auto *val = reinterpret_cast<EtsBoxPrimitive<EtsByte> *>(etsVal);
136 napi_value jsVal;
137 NAPI_CHECK_FATAL(napi_create_int32(env, val->GetValue(), &jsVal));
138 return jsVal;
139 }
JSCONVERT_UNWRAP(StdlibByte)140 JSCONVERT_UNWRAP(StdlibByte)
141 {
142 int32_t val;
143 NAPI_CHECK_FATAL(napi_get_value_int32(env, jsVal, &val));
144 if (val < std::numeric_limits<EtsByte>::min() || val > std::numeric_limits<EtsByte>::max()) {
145 TypeCheckFailed();
146 return {};
147 }
148 return EtsBoxPrimitive<EtsByte>::Create(EtsCoroutine::GetCurrent(), val);
149 }
150
151 JSCONVERT_DEFINE_TYPE(StdlibChar, EtsObject *);
JSCONVERT_WRAP(StdlibChar)152 JSCONVERT_WRAP(StdlibChar)
153 {
154 auto *val = reinterpret_cast<EtsBoxPrimitive<EtsChar> *>(etsVal);
155 napi_value jsVal;
156 std::array<char16_t, 2U> str = {static_cast<char16_t>(val->GetValue()), 0};
157 NAPI_CHECK_FATAL(napi_create_string_utf16(env, str.data(), 1, &jsVal));
158 return jsVal;
159 }
JSCONVERT_UNWRAP(StdlibChar)160 JSCONVERT_UNWRAP(StdlibChar)
161 {
162 napi_valuetype type;
163 napi_typeof(env, jsVal, &type);
164 EtsChar val;
165 if (type == napi_number) {
166 int32_t ival;
167 NAPI_CHECK_FATAL(napi_get_value_int32(env, jsVal, &ival));
168 if (ival < 0 || ival > std::numeric_limits<EtsChar>::max()) {
169 TypeCheckFailed();
170 return {};
171 }
172 val = static_cast<uint16_t>(ival);
173 } else if (type == napi_string) {
174 size_t len = 0;
175 NAPI_CHECK_FATAL(napi_get_value_string_utf16(env, jsVal, nullptr, 0, &len));
176 if (len != 1) {
177 TypeCheckFailed();
178 return {};
179 }
180 char16_t cval;
181 NAPI_CHECK_FATAL(napi_get_value_string_utf16(env, jsVal, &cval, 1, &len));
182 val = static_cast<EtsChar>(cval);
183 } else {
184 TypeCheckFailed();
185 return {};
186 }
187 return EtsBoxPrimitive<EtsChar>::Create(EtsCoroutine::GetCurrent(), val);
188 }
189
190 JSCONVERT_DEFINE_TYPE(StdlibShort, EtsObject *);
JSCONVERT_WRAP(StdlibShort)191 JSCONVERT_WRAP(StdlibShort)
192 {
193 auto *val = reinterpret_cast<EtsBoxPrimitive<EtsShort> *>(etsVal);
194 napi_value jsVal;
195 NAPI_CHECK_FATAL(napi_create_int32(env, val->GetValue(), &jsVal));
196 return jsVal;
197 }
JSCONVERT_UNWRAP(StdlibShort)198 JSCONVERT_UNWRAP(StdlibShort)
199 {
200 int32_t val;
201 NAPI_CHECK_FATAL(napi_get_value_int32(env, jsVal, &val));
202 if (val < std::numeric_limits<EtsShort>::min() || val > std::numeric_limits<EtsShort>::max()) {
203 TypeCheckFailed();
204 return {};
205 }
206 return EtsBoxPrimitive<EtsShort>::Create(EtsCoroutine::GetCurrent(), static_cast<EtsShort>(val));
207 }
208
209 JSCONVERT_DEFINE_TYPE(StdlibInt, EtsObject *);
JSCONVERT_WRAP(StdlibInt)210 JSCONVERT_WRAP(StdlibInt)
211 {
212 auto *val = reinterpret_cast<EtsBoxPrimitive<EtsInt> *>(etsVal);
213 napi_value jsVal;
214 NAPI_CHECK_FATAL(napi_create_int32(env, val->GetValue(), &jsVal));
215 return jsVal;
216 }
JSCONVERT_UNWRAP(StdlibInt)217 JSCONVERT_UNWRAP(StdlibInt)
218 {
219 EtsInt val;
220 NAPI_CHECK_FATAL(napi_get_value_int32(env, jsVal, &val));
221 return EtsBoxPrimitive<EtsInt>::Create(EtsCoroutine::GetCurrent(), val);
222 }
223
224 JSCONVERT_DEFINE_TYPE(StdlibLong, EtsObject *);
JSCONVERT_WRAP(StdlibLong)225 JSCONVERT_WRAP(StdlibLong)
226 {
227 auto *val = reinterpret_cast<EtsBoxPrimitive<EtsLong> *>(etsVal);
228 napi_value jsVal;
229 NAPI_CHECK_FATAL(napi_create_int64(env, val->GetValue(), &jsVal));
230 return jsVal;
231 }
JSCONVERT_UNWRAP(StdlibLong)232 JSCONVERT_UNWRAP(StdlibLong)
233 {
234 EtsLong val;
235 NAPI_CHECK_FATAL(napi_get_value_int64(env, jsVal, &val));
236 return EtsBoxPrimitive<EtsLong>::Create(EtsCoroutine::GetCurrent(), val);
237 }
238
239 JSCONVERT_DEFINE_TYPE(StdlibFloat, EtsObject *);
JSCONVERT_WRAP(StdlibFloat)240 JSCONVERT_WRAP(StdlibFloat)
241 {
242 auto *val = reinterpret_cast<EtsBoxPrimitive<EtsFloat> *>(etsVal);
243 napi_value jsVal;
244 NAPI_CHECK_FATAL(napi_create_double(env, static_cast<double>(val->GetValue()), &jsVal));
245 return jsVal;
246 }
JSCONVERT_UNWRAP(StdlibFloat)247 JSCONVERT_UNWRAP(StdlibFloat)
248 {
249 double val;
250 NAPI_CHECK_FATAL(napi_get_value_double(env, jsVal, &val));
251 auto fval = static_cast<EtsFloat>(val);
252 if (fval != val) {
253 TypeCheckFailed();
254 return {};
255 }
256 return EtsBoxPrimitive<EtsFloat>::Create(EtsCoroutine::GetCurrent(), fval);
257 }
258
259 JSCONVERT_DEFINE_TYPE(StdlibDouble, EtsObject *);
JSCONVERT_WRAP(StdlibDouble)260 JSCONVERT_WRAP(StdlibDouble)
261 {
262 auto *val = reinterpret_cast<EtsBoxPrimitive<EtsDouble> *>(etsVal);
263 napi_value jsVal;
264 NAPI_CHECK_FATAL(napi_create_double(env, val->GetValue(), &jsVal));
265 return jsVal;
266 }
JSCONVERT_UNWRAP(StdlibDouble)267 JSCONVERT_UNWRAP(StdlibDouble)
268 {
269 EtsDouble val;
270 NAPI_CHECK_FATAL(napi_get_value_double(env, jsVal, &val));
271 return EtsBoxPrimitive<EtsDouble>::Create(EtsCoroutine::GetCurrent(), val);
272 }
273
274 JSCONVERT_DEFINE_TYPE(String, EtsString *);
JSCONVERT_WRAP(String)275 JSCONVERT_WRAP(String)
276 {
277 napi_value jsVal;
278 if (UNLIKELY(etsVal->IsUtf16())) {
279 auto str = reinterpret_cast<char16_t *>(etsVal->GetDataUtf16());
280 NAPI_CHECK_FATAL(napi_create_string_utf16(env, str, etsVal->GetUtf16Length(), &jsVal));
281 } else {
282 auto str = utf::Mutf8AsCString(etsVal->GetDataMUtf8());
283 // -1 for NULL terminated Mutf8 string!!!
284 NAPI_CHECK_FATAL(napi_create_string_utf8(env, str, etsVal->GetMUtf8Length() - 1, &jsVal));
285 }
286 return jsVal;
287 }
JSCONVERT_UNWRAP(String)288 JSCONVERT_UNWRAP(String)
289 {
290 if (UNLIKELY(GetValueType(env, jsVal) != napi_string)) {
291 TypeCheckFailed();
292 return {};
293 }
294 std::string value = GetString(env, jsVal);
295 return EtsString::CreateFromUtf8(value.data(), value.length());
296 }
297
298 JSCONVERT_DEFINE_TYPE(Void, EtsVoid *);
JSCONVERT_WRAP(Void)299 JSCONVERT_WRAP(Void)
300 {
301 napi_value jsVal;
302 NAPI_CHECK_FATAL(napi_get_undefined(env, &jsVal));
303 return jsVal;
304 }
JSCONVERT_UNWRAP(Void)305 JSCONVERT_UNWRAP(Void)
306 {
307 return EtsVoid::GetInstance();
308 }
309
310 JSCONVERT_DEFINE_TYPE(JSValue, JSValue *);
JSCONVERT_WRAP(JSValue)311 JSCONVERT_WRAP(JSValue)
312 {
313 return etsVal->GetNapiValue(env);
314 }
JSCONVERT_UNWRAP(JSValue)315 JSCONVERT_UNWRAP(JSValue)
316 {
317 return JSValue::Create(EtsCoroutine::GetCurrent(), ctx, jsVal);
318 }
319
320 // JSError convertors are supposed to box JSValue objects, do not treat them in any other way
321 JSCONVERT_DEFINE_TYPE(JSError, EtsObject *);
JSCONVERT_WRAP(JSError)322 JSCONVERT_WRAP(JSError)
323 {
324 auto coro = EtsCoroutine::GetCurrent();
325 auto ctx = InteropCtx::Current(coro);
326
327 auto klass = etsVal->GetClass();
328 INTEROP_FATAL_IF(klass->GetRuntimeClass() != ctx->GetJSErrorClass());
329
330 // NOTE(vpukhov): remove call after adding a mirror-class for JSError
331 auto method = klass->GetMethod("getValue");
332 ASSERT(method != nullptr);
333 std::array args = {Value(etsVal->GetCoreType())};
334 auto val = JSValue::FromCoreType(method->GetPandaMethod()->Invoke(coro, args.data()).GetAs<ObjectHeader *>());
335 INTEROP_FATAL_IF(val == nullptr);
336 return val->GetNapiValue(env);
337 }
JSCONVERT_UNWRAP(JSError)338 JSCONVERT_UNWRAP(JSError)
339 {
340 auto coro = EtsCoroutine::GetCurrent();
341 auto value = JSValue::Create(coro, ctx, jsVal);
342 if (UNLIKELY(value == nullptr)) {
343 return {};
344 }
345 auto res = ctx->CreateETSCoreJSError(coro, value);
346 if (UNLIKELY(res == nullptr)) {
347 return {};
348 }
349 return res;
350 }
351
352 JSCONVERT_DEFINE_TYPE(Promise, EtsPromise *);
353
JSCONVERT_WRAP(Promise)354 JSCONVERT_WRAP(Promise)
355 {
356 napi_deferred deferred;
357 napi_value jsPromise;
358 NAPI_CHECK_FATAL(napi_create_promise(env, &deferred, &jsPromise));
359 auto *coro = EtsCoroutine::GetCurrent();
360 if (etsVal->GetState() != EtsPromise::STATE_PENDING) {
361 EtsObject *value = etsVal->GetValue(coro);
362 napi_value completionValue;
363 auto ctx = InteropCtx::Current(coro);
364 if (value == nullptr) {
365 completionValue = GetNull(env);
366 } else {
367 auto refconv = JSRefConvertResolve(ctx, value->GetClass()->GetRuntimeClass());
368 completionValue = refconv->Wrap(ctx, value);
369 }
370 if (etsVal->IsResolved()) {
371 NAPI_CHECK_FATAL(napi_resolve_deferred(env, deferred, completionValue));
372 } else {
373 NAPI_CHECK_FATAL(napi_reject_deferred(env, deferred, completionValue));
374 }
375 } else {
376 coro->GetPandaVM()->AddPromiseListener(etsVal, MakePandaUnique<PendingPromiseListener>(deferred));
377 }
378 return jsPromise;
379 }
380
JSCONVERT_UNWRAP(Promise)381 JSCONVERT_UNWRAP(Promise)
382 {
383 bool isPromise = false;
384 NAPI_CHECK_FATAL(napi_is_promise(env, jsVal, &isPromise));
385 if (!isPromise) {
386 InteropCtx::Fatal("Passed object is not a promise!");
387 UNREACHABLE();
388 }
389 auto currentCoro = EtsCoroutine::GetCurrent();
390 [[maybe_unused]] EtsHandleScope s(currentCoro);
391 auto *promise = EtsPromise::Create(currentCoro);
392 EtsHandle<EtsPromise> hpromise(currentCoro, promise);
393 auto *jsval = JSValue::Create(currentCoro, ctx, jsVal);
394 hpromise->SetLinkedPromise(currentCoro, jsval->AsObject());
395 return hpromise.GetPtr();
396 }
397
398 JSCONVERT_DEFINE_TYPE(ArrayBuffer, EtsArrayBuffer *);
399
JSCONVERT_WRAP(ArrayBuffer)400 JSCONVERT_WRAP(ArrayBuffer)
401 {
402 napi_value buf;
403 void *data;
404 NAPI_CHECK_FATAL(napi_create_arraybuffer(env, etsVal->GetByteLength(), &data, &buf));
405 std::copy_n(reinterpret_cast<const uint8_t *>(etsVal->GetData()->GetData<const void *>()), etsVal->GetByteLength(),
406 reinterpret_cast<uint8_t *>(data));
407 return buf;
408 }
409
JSCONVERT_UNWRAP(ArrayBuffer)410 JSCONVERT_UNWRAP(ArrayBuffer)
411 {
412 bool isArraybuf = false;
413 NAPI_CHECK_FATAL(napi_is_arraybuffer(env, jsVal, &isArraybuf));
414 if (!isArraybuf) {
415 InteropCtx::Fatal("Passed object is not an ArrayBuffer!");
416 UNREACHABLE();
417 }
418 void *data = nullptr;
419 size_t byteLength = 0;
420 NAPI_CHECK_FATAL(napi_get_arraybuffer_info(env, jsVal, &data, &byteLength));
421 auto *currentCoro = EtsCoroutine::GetCurrent();
422 [[maybe_unused]] EtsHandleScope s(currentCoro);
423 EtsClass *arraybufKlass = currentCoro->GetPandaVM()->GetClassLinker()->GetArrayBufferClass();
424 EtsHandle<EtsArrayBuffer> buf(currentCoro,
425 reinterpret_cast<EtsArrayBuffer *>(EtsObject::Create(currentCoro, arraybufKlass)));
426 buf->SetByteLength(static_cast<EtsInt>(byteLength));
427 buf->SetData(currentCoro, EtsArray::CreateForPrimitive<EtsByteArray>(EtsClassRoot::BYTE_ARRAY, byteLength));
428 std::copy_n(reinterpret_cast<uint8_t *>(data), byteLength, buf->GetData()->GetData<EtsByte>());
429 return buf.GetPtr();
430 }
431
432 JSCONVERT_DEFINE_TYPE(EtsVoid, EtsVoid *);
JSCONVERT_WRAP(EtsVoid)433 JSCONVERT_WRAP(EtsVoid)
434 {
435 return GetUndefined(env);
436 }
JSCONVERT_UNWRAP(EtsVoid)437 JSCONVERT_UNWRAP(EtsVoid)
438 {
439 return EtsVoid::GetInstance();
440 }
441
442 JSCONVERT_DEFINE_TYPE(EtsUndefined, EtsObject *);
JSCONVERT_WRAP(EtsUndefined)443 JSCONVERT_WRAP(EtsUndefined)
444 {
445 return GetUndefined(env);
446 }
447
JSCONVERT_UNWRAP(EtsUndefined)448 JSCONVERT_UNWRAP(EtsUndefined)
449 {
450 if (UNLIKELY(!IsUndefined(env, jsVal))) {
451 TypeCheckFailed();
452 return {};
453 }
454 return ctx->GetUndefinedObject();
455 }
456
457 #undef JSCONVERT_DEFINE_TYPE
458 #undef JSCONVERT_WRAP
459 #undef JSCONVERT_UNWRAP
460
461 template <typename T>
JSValueGetByName(InteropCtx * ctx,JSValue * jsvalue,const char * name)462 static ALWAYS_INLINE inline std::optional<typename T::cpptype> JSValueGetByName(InteropCtx *ctx, JSValue *jsvalue,
463 const char *name)
464 {
465 auto env = ctx->GetJSEnv();
466 napi_value jsVal = jsvalue->GetNapiValue(env);
467 napi_status rc = napi_get_named_property(env, jsVal, name, &jsVal);
468 if (UNLIKELY(NapiThrownGeneric(rc))) {
469 return {};
470 }
471 return T::UnwrapWithNullCheck(ctx, env, jsVal);
472 }
473
474 template <typename T>
JSValueSetByName(InteropCtx * ctx,JSValue * jsvalue,const char * name,typename T::cpptype etsPropVal)475 [[nodiscard]] static ALWAYS_INLINE inline bool JSValueSetByName(InteropCtx *ctx, JSValue *jsvalue, const char *name,
476 typename T::cpptype etsPropVal)
477 {
478 auto env = ctx->GetJSEnv();
479 napi_value jsVal = jsvalue->GetNapiValue(env);
480 napi_value jsPropVal = T::WrapWithNullCheck(env, etsPropVal);
481 if (UNLIKELY(jsPropVal == nullptr)) {
482 return false;
483 }
484 napi_status rc = napi_set_named_property(env, jsVal, name, jsPropVal);
485 return !NapiThrownGeneric(rc);
486 }
487
488 } // namespace panda::ets::interop::js
489
490 #endif // !PANDA_PLUGINS_ETS_RUNTIME_INTEROP_JS_JS_CONVERT_H
491