xref: /arkcompiler/ets_runtime/ecmascript/napi/include/jsnapi_expo.h

53 class Local;
111 using ConcurrentCallback = void (*)(Local<JSValueRef> result, bool success, void *taskInfo, void *data);
213 class ECMA_PUBLIC_API Local {  // NOLINT(cppcoreguidelines-special-member-functions, hicpp-special-member-functions)
215     inline Local() = default;
218     inline Local(const Local<S> &current) : address_(reinterpret_cast<uintptr_t>(*current))
223     Local(const EcmaVM *vm, const Global<T> &current);
225     Local(const EcmaVM *vm, const CopyableGlobal<T> &current);
227     ~Local() = default;
254     explicit inline Local(uintptr_t addr) : address_(addr) {}
309     CopyableGlobal(const EcmaVM *vm, const Local<S> &current);
311     CopyableGlobal(const EcmaVM *vm, const Local<T> &current);
324     Local<T> ToLocal() const
327             return Local<T>();
329         return Local<T>(vm_, *this);
407     Global(const EcmaVM *vm, const Local<S> &current);
413     Local<T> ToLocal() const
416             return Local<T>();
418         return Local<T>(vm_, *this);
421     Local<T> ToLocal(const EcmaVM *vm) const
423         return Local<T>(vm, *this);
475     static Local<PrimitiveRef> Undefined(const EcmaVM *vm);
476     static Local<PrimitiveRef> Null(const EcmaVM *vm);
477     static Local<PrimitiveRef> Hole(const EcmaVM *vm);
478     static Local<PrimitiveRef> True(const EcmaVM *vm);
479     static Local<PrimitiveRef> False(const EcmaVM *vm);
491     Local<NumberRef> ToNumber(const EcmaVM *vm);
492     Local<BooleanRef> ToBoolean(const EcmaVM *vm);
493     Local<BigIntRef> ToBigInt(const EcmaVM *vm);
494     Local<StringRef> ToString(const EcmaVM *vm);
495     Local<ObjectRef> ToObject(const EcmaVM *vm);
496     Local<ObjectRef> ToEcmaObject(const EcmaVM *vm);
497     Local<NativePointerRef> ToNativePointer(const EcmaVM *vm);
586     bool IsStrictEquals(const EcmaVM *vm, Local<JSValueRef> value);
587     Local<StringRef> Typeof(const EcmaVM *vm);
588     bool InstanceOf(const EcmaVM *vm, Local<JSValueRef> value);
630     friend class Local;
642     PropertyAttribute(Local<JSValueRef> value, bool w, bool e, bool c)
692     Local<JSValueRef> GetValue(const EcmaVM *vm) const
699     void SetValue(Local<JSValueRef> value)
707     Local<JSValueRef> GetGetter(const EcmaVM *vm) const
714     void SetGetter(Local<JSValueRef> value)
722     Local<JSValueRef> GetSetter(const EcmaVM *vm) const
729     void SetSetter(Local<JSValueRef> value)
739     Local<JSValueRef> value_;
740     Local<JSValueRef> getter_;
741     Local<JSValueRef> setter_;
752     static Local<NativePointerRef> New(const EcmaVM *vm, void *nativePointer, size_t nativeBindingsize = 0);
753     static Local<NativePointerRef> New(const EcmaVM *vm, void *nativePointer, NativePointerCallback callBack,
755     static Local<NativePointerRef> NewConcurrent(const EcmaVM *vm, void *nativePointer,
758     static Local<NativePointerRef> NewSendable(const EcmaVM *vm,
774         std::vector<Local<JSValueRef>> keys;
783     static Local<ObjectRef> New(const EcmaVM *vm);
785     static Local<ObjectRef> NewS(const EcmaVM *vm);
786     static Local<ObjectRef> NewWithProperties(const EcmaVM *vm, size_t propertyCount, const Local<JSValueRef> *keys,
788     static Local<ObjectRef> NewSWithProperties(const EcmaVM *vm, SendablePropertiesInfo &info);
789     static Local<ObjectRef> NewWithNamedProperties(const EcmaVM *vm, size_t propertyCount, const char **keys,
790                                                    const Local<JSValueRef> *values);
791     static Local<ObjectRef> CreateNativeModuleFailureInfo(const EcmaVM *vm, const std::string &failureInfo);
792     static Local<ObjectRef> CreateAccessorData(const EcmaVM *vm, Local<FunctionRef> getter, Local<FunctionRef> setter);
793     static Local<ObjectRef> CreateSendableAccessorData(const EcmaVM *vm,
794                                                        Local<FunctionRef> getter,
795                                                        Local<FunctionRef> setter);
796     bool ConvertToNativeBindingObject(const EcmaVM *vm, Local<NativePointerRef> value);
797     bool Set(const EcmaVM *vm, Local<JSValueRef> key, Local<JSValueRef> value);
798     bool Set(const EcmaVM *vm, const char *utf8, Local<JSValueRef> value);
799     bool Set(const EcmaVM *vm, uint32_t key, Local<JSValueRef> value);
800     bool SetAccessorProperty(const EcmaVM *vm, Local<JSValueRef> key, Local<FunctionRef> getter,
801                              Local<FunctionRef> setter, PropertyAttribute attribute = PropertyAttribute::Default());
802     Local<JSValueRef> Get(const EcmaVM *vm, Local<JSValueRef> key);
803     Local<JSValueRef> Get(const EcmaVM *vm, const char *utf8);
804     Local<JSValueRef> Get(const EcmaVM *vm, int32_t key);
806     bool GetOwnProperty(const EcmaVM *vm, Local<JSValueRef> key, PropertyAttribute &property);
807     Local<ArrayRef> GetOwnPropertyNames(const EcmaVM *vm);
808     Local<ArrayRef> GetAllPropertyNames(const EcmaVM *vm, uint32_t filter);
809     Local<ArrayRef> GetOwnEnumerablePropertyNames(const EcmaVM *vm);
810     Local<JSValueRef> GetPrototype(const EcmaVM *vm);
811     bool SetPrototype(const EcmaVM *vm, Local<ObjectRef> prototype);
813     bool DefineProperty(const EcmaVM *vm, Local<JSValueRef> key, PropertyAttribute attribute);
815     bool Has(const EcmaVM *vm, Local<JSValueRef> key);
818     bool HasOwnProperty(const EcmaVM *vm, Local<JSValueRef> key);
820     bool Delete(const EcmaVM *vm, Local<JSValueRef> key);
823     Local<JSValueRef> Freeze(const EcmaVM *vm);
824     Local<JSValueRef> Seal(const EcmaVM *vm);
841 using FunctionCallback = Local<JSValueRef>(*)(JsiRuntimeCallInfo*);
850     static Local<FunctionRef> New(EcmaVM *vm, FunctionCallback nativeFunc, NativePointerCallback deleter = nullptr,
852     static Local<FunctionRef> NewConcurrent(EcmaVM *vm,
858     static Local<FunctionRef> New(EcmaVM *vm, InternalFunctionCallback nativeFunc, NativePointerCallback deleter,
860     static Local<FunctionRef> NewConcurrent(EcmaVM *vm,
866     static Local<FunctionRef> NewSendable(EcmaVM *vm,
872     static Local<FunctionRef> NewClassFunction(EcmaVM *vm, FunctionCallback nativeFunc, NativePointerCallback deleter,
874     static Local<FunctionRef> NewConcurrentClassFunction(EcmaVM *vm,
880     static Local<FunctionRef> NewClassFunction(EcmaVM *vm,
886     static Local<FunctionRef> NewSendableClassFunction(const EcmaVM *vm,
890                                                        Local<StringRef> name,
892                                                        Local<FunctionRef> parent,
897     Local<JSValueRef> Call(const EcmaVM *vm, Local<JSValueRef> thisObj, const Local<JSValueRef> argv[],
899     Local<JSValueRef> Constructor(const EcmaVM *vm, const Local<JSValueRef> argv[], int32_t length);
902     Local<JSValueRef> GetFunctionPrototype(const EcmaVM *vm);
903     bool Inherit(const EcmaVM *vm, Local<FunctionRef> parent);
904     void SetName(const EcmaVM *vm, Local<StringRef> name);
905     Local<StringRef> GetName(const EcmaVM *vm);
906     Local<StringRef> GetSourceCode(const EcmaVM *vm, int lineNumber);
914     Local<JSValueRef> GetValue(const EcmaVM *vm);
919     static Local<SymbolRef> New(const EcmaVM *vm, Local<StringRef> description = Local<StringRef>());
920     Local<StringRef> GetDescription(const EcmaVM *vm);
925     static Local<BooleanRef> New(const EcmaVM *vm, bool input);
936     static Local<StringRef> NewFromUtf8WithoutStringTable(const EcmaVM *vm, const char *utf8, int length = -1);
937     static Local<StringRef> NewFromUtf8(const EcmaVM *vm, const char *utf8, int length = -1);
938     static Local<StringRef> NewFromUtf16WithoutStringTable(const EcmaVM *vm, const char16_t *utf16, int length = -1);
939     static Local<StringRef> NewFromUtf16(const EcmaVM *vm, const char16_t *utf16, int length = -1);
947     static Local<StringRef> GetNapiWrapperString(const EcmaVM *vm);
948     Local<TypedArrayRef> EncodeIntoUint8Array(const EcmaVM *vm);
954     PromiseRejectInfo(Local<JSValueRef> promise, Local<JSValueRef> reason,
957     Local<JSValueRef> GetPromise() const;
958     Local<JSValueRef> GetReason() const;
963     Local<JSValueRef> promise_ {};
964     Local<JSValueRef> reason_ {};
983     Local<ObjectRef> GetAndClearException();
984     Local<ObjectRef> GetException();
1008     static Local<BigIntRef> New(const EcmaVM *vm, uint64_t input);
1009     static Local<BigIntRef> New(const EcmaVM *vm, int64_t input);
1010     static Local<JSValueRef> CreateBigWords(const EcmaVM *vm, bool sign, uint32_t size, const uint64_t* words);
1045     inline Local<T> Escape(Local<T> current)
1050         return Local<T>(escapeHandle_);
1060     static Local<IntegerRef> New(const EcmaVM *vm, int input);
1061     static Local<IntegerRef> NewFromUnsigned(const EcmaVM *vm, unsigned int input);
1067     static Local<ArrayBufferRef> New(const EcmaVM *vm, int32_t length);
1068     static Local<ArrayBufferRef> New(const EcmaVM *vm, void *buffer, int32_t length,
1080     static Local<SendableArrayBufferRef> New(const EcmaVM *vm, int32_t length);
1081     static Local<SendableArrayBufferRef> New(const EcmaVM *vm, void *buffer, int32_t length,
1093     static Local<DateRef> New(const EcmaVM *vm, double time);
1094     Local<StringRef> ToString(const EcmaVM *vm);
1103     Local<ArrayBufferRef> GetArrayBuffer(const EcmaVM *vm);
1111     Local<SendableArrayBufferRef> GetArrayBuffer(const EcmaVM *vm);
1116     static Local<ArrayRef> New(const EcmaVM *vm, uint32_t length = 0);
1118     static bool SetValueAt(const EcmaVM *vm, Local<JSValueRef> obj, uint32_t index, Local<JSValueRef> value);
1119     static Local<JSValueRef> GetValueAt(const EcmaVM *vm, Local<JSValueRef> obj, uint32_t index);
1124     static Local<SendableArrayRef> New(const EcmaVM *vm, uint32_t length = 0);
1126     static Local<JSValueRef> GetValueAt(const EcmaVM *vm, Local<JSValueRef> obj, uint32_t index);
1127     static bool SetProperty(const EcmaVM *vm, Local<JSValueRef> obj, uint32_t index, Local<JSValueRef> value);
1132     static Local<Int8ArrayRef> New(const EcmaVM *vm, Local<ArrayBufferRef> buffer, int32_t byteOffset, int32_t length);
1137     static Local<SharedInt8ArrayRef> New(const EcmaVM *vm, Local<SendableArrayBufferRef> buffer,
1143     static Local<Uint8ArrayRef> New(const EcmaVM *vm, Local<ArrayBufferRef> buffer, int32_t byteOffset, int32_t length);
1148     static Local<SharedUint8ArrayRef> New(const EcmaVM *vm, Local<SendableArrayBufferRef> buffer,
1154     static Local<Uint8ClampedArrayRef> New(const EcmaVM *vm, Local<ArrayBufferRef> buffer, int32_t byteOffset,
1160     static Local<Int16ArrayRef> New(const EcmaVM *vm, Local<ArrayBufferRef> buffer, int32_t byteOffset, int32_t length);
1165     static Local<SharedInt16ArrayRef> New(const EcmaVM *vm, Local<SendableArrayBufferRef> buffer,
1171     static Local<Uint16ArrayRef> New(const EcmaVM *vm, Local<ArrayBufferRef> buffer, int32_t byteOffset,
1177     static Local<SharedUint16ArrayRef> New(const EcmaVM *vm, Local<SendableArrayBufferRef> buffer,
1183     static Local<Int32ArrayRef> New(const EcmaVM *vm, Local<ArrayBufferRef> buffer, int32_t byteOffset, int32_t length);
1188     static Local<SharedInt32ArrayRef> New(const EcmaVM *vm, Local<SendableArrayBufferRef> buffer,
1194     static Local<SharedFloat32ArrayRef> New(const EcmaVM *vm, Local<SendableArrayBufferRef> buffer,
1200     static Local<SharedUint8ClampedArrayRef> New(const EcmaVM *vm, Local<SendableArrayBufferRef> buffer,
1206     static Local<Uint32ArrayRef> New(const EcmaVM *vm, Local<ArrayBufferRef> buffer, int32_t byteOffset,
1212     static Local<SharedUint32ArrayRef> New(const EcmaVM *vm, Local<SendableArrayBufferRef> buffer,
1218     static Local<Float32ArrayRef> New(const EcmaVM *vm, Local<ArrayBufferRef> buffer, int32_t byteOffset,
1224     static Local<Float64ArrayRef> New(const EcmaVM *vm, Local<ArrayBufferRef> buffer, int32_t byteOffset,
1230     static Local<BigInt64ArrayRef> New(const EcmaVM *vm, Local<ArrayBufferRef> buffer, int32_t byteOffset,
1236     static Local<BigUint64ArrayRef> New(const EcmaVM *vm, Local<ArrayBufferRef> buffer, int32_t byteOffset,
1242     static Local<JSValueRef> Error(const EcmaVM *vm, Local<StringRef> message);
1243     static Local<JSValueRef> RangeError(const EcmaVM *vm, Local<StringRef> message);
1244     static Local<JSValueRef> ReferenceError(const EcmaVM *vm, Local<StringRef> message);
1245     static Local<JSValueRef> SyntaxError(const EcmaVM *vm, Local<StringRef> message);
1246     static Local<JSValueRef> TypeError(const EcmaVM *vm, Local<StringRef> message);
1247     static Local<JSValueRef> AggregateError(const EcmaVM *vm, Local<StringRef> message);
1248     static Local<JSValueRef> EvalError(const EcmaVM *vm, Local<StringRef> message);
1249     static Local<JSValueRef> OOMError(const EcmaVM *vm, Local<StringRef> message);
1250     static Local<JSValueRef> TerminationError(const EcmaVM *vm, Local<StringRef> message);
1332     inline Local<JSValueRef> GetFunctionRef() const
1337     inline Local<JSValueRef> GetNewTargetRef() const
1342     inline Local<JSValueRef> GetThisRef() const
1347     inline Local<JSValueRef> GetCallArgRef(uint32_t idx) const
1355     Local<JSValueRef> GetArgRef(uint32_t idx) const
1357         return Local<JSValueRef>(GetArgAddress(idx));
1379     Local<JSValueRef> Get(const EcmaVM *vm, Local<JSValueRef> key);
1380     Local<JSValueRef> Get(const EcmaVM *vm, const char *utf8);
1381     Local<JSValueRef> GetKey(const EcmaVM *vm, int entry);
1382     Local<JSValueRef> GetValue(const EcmaVM *vm, int entry);
1383     static Local<MapRef> New(const EcmaVM *vm);
1384     void Set(const EcmaVM *vm, Local<JSValueRef> key, Local<JSValueRef> value);
1385     void Set(const EcmaVM *vm, const char *utf8, Local<JSValueRef> value);
1386     bool Has(const EcmaVM *vm, Local<JSValueRef> key);
1388     void Delete(const EcmaVM *vm, Local<JSValueRef> key);
1390     Local<MapIteratorRef> GetEntries(const EcmaVM *vm);
1391     Local<MapIteratorRef> GetKeys(const EcmaVM *vm);
1392     Local<MapIteratorRef> GetValues(const EcmaVM *vm);
1397     static Local<SendableMapRef> New(const EcmaVM *vm);
1400     Local<JSValueRef> Get(const EcmaVM *vm, Local<JSValueRef> key);
1401     Local<JSValueRef> Get(const EcmaVM *vm, const char *utf8);
1402     Local<JSValueRef> GetKey(const EcmaVM *vm, int entry);
1403     Local<JSValueRef> GetValue(const EcmaVM *vm, int entry);
1404     void Set(const EcmaVM *vm, Local<JSValueRef> key, Local<JSValueRef> value);
1405     void Set(const EcmaVM *vm, const char *utf8, Local<JSValueRef> value);
1406     bool Has(const EcmaVM *vm, Local<JSValueRef> key);
1408     void Delete(const EcmaVM *vm, Local<JSValueRef> key);
1410     Local<SendableMapIteratorRef> GetEntries(const EcmaVM *vm);
1411     Local<SendableMapIteratorRef> GetKeys(const EcmaVM *vm);
1412     Local<SendableMapIteratorRef> GetValues(const EcmaVM *vm);
1417     static Local<SendableSetRef> New(const EcmaVM *vm);
1420     Local<JSValueRef> GetValue(const EcmaVM *vm, int entry);
1421     void Add(const EcmaVM *vm, Local<JSValueRef> value);
1426     static Local<BufferRef> New(const EcmaVM *vm, int32_t length);
1427     static Local<BufferRef> New(const EcmaVM *vm, void *buffer, int32_t length, const NativePointerCallback &deleter,
1437     Local<PromiseRef> Catch(const EcmaVM *vm, Local<FunctionRef> handler);
1438     Local<PromiseRef> Then(const EcmaVM *vm, Local<FunctionRef> handler);
1439     Local<PromiseRef> Finally(const EcmaVM *vm, Local<FunctionRef> handler);
1440     Local<PromiseRef> Then(const EcmaVM *vm, Local<FunctionRef> onFulfilled, Local<FunctionRef> onRejected);
1442     Local<JSValueRef> GetPromiseState(const EcmaVM *vm);
1443     Local<JSValueRef> GetPromiseResult(const EcmaVM *vm);
1448     static Local<PromiseCapabilityRef> New(const EcmaVM *vm);
1450     bool Resolve(const EcmaVM *vm, Local<JSValueRef> value);
1452     bool Reject(const EcmaVM *vm, Local<JSValueRef> reason);
1453     Local<PromiseRef> GetPromise(const EcmaVM *vm);
1458     static Local<NumberRef> New(const EcmaVM *vm, double input);
1459     static Local<NumberRef> New(const EcmaVM *vm, int32_t input);
1460     static Local<NumberRef> New(const EcmaVM *vm, uint32_t input);
1461     static Local<NumberRef> New(const EcmaVM *vm, int64_t input);
1468     static Local<DataViewRef> New(const EcmaVM *vm, Local<ArrayBufferRef> arrayBuffer, uint32_t byteOffset,
1472     Local<ArrayBufferRef> GetArrayBuffer(const EcmaVM *vm);
1478     Local<JSValueRef> GetKind(const EcmaVM *vm);
1479     static Local<MapIteratorRef> New(const EcmaVM *vm, Local<MapRef> map);
1481     static Local<ArrayRef> Next(const EcmaVM *vm, ecmascript::EcmaRuntimeCallInfo* ecmaRuntimeCallInfo);
1482     Local<JSValueRef> Next(const EcmaVM *vm);
1487     Local<JSValueRef> Next(const EcmaVM *vm);
1582     static Local<ObjectRef> GetExportObject(EcmaVM *vm, const std::string &file, const std::string &key);
1583     static Local<ObjectRef> GetExportObjectFromBuffer(EcmaVM *vm, const std::string &file, const std::string &key);
1584     static Local<ObjectRef> GetExportObjectFromOhmUrl(EcmaVM *vm, const std::string &ohmUrl, const std::string &key);
1585     static Local<ObjectRef> ExecuteNativeModule(EcmaVM *vm, const std::string &key);
1586     static Local<ObjectRef> GetModuleNameSpaceFromFile(EcmaVM *vm, const std::string &file,
1588     static Local<ObjectRef> GetModuleNameSpaceWithModuleInfo(EcmaVM *vm, const std::string &file,
1613     static Local<ObjectRef> GetGlobalObject(const EcmaVM *vm);
1626     static void ThrowException(const EcmaVM *vm, Local<JSValueRef> error);
1628     static Local<ObjectRef> GetAndClearUncaughtException(const EcmaVM *vm);
1629     static Local<ObjectRef> GetUncaughtException(const EcmaVM *vm);
1661     static void* SerializeValue(const EcmaVM *vm, Local<JSValueRef> data, Local<JSValueRef> transfer,
1662                                 Local<JSValueRef> cloneList,
1665     static Local<JSValueRef> DeserializeValue(const EcmaVM *vm, void *recoder, void *hint);
1674     static void SetHostEnqueueJob(const EcmaVM* vm, Local<JSValueRef> cb,
1689     static bool IsQuickFixCausedException(EcmaVM *vm, Local<ObjectRef> exception, const std::string &patchFileName);
1716     static bool InitForConcurrentFunction(EcmaVM *vm, Local<JSValueRef> func, void *taskInfo);
1740     static Local<JSValueRef> NapiHasProperty(const EcmaVM *vm, uintptr_t nativeObj, uintptr_t key);
1741     static Local<JSValueRef> NapiHasOwnProperty(const EcmaVM *vm, uintptr_t nativeObj, uintptr_t key);
1742     static Local<JSValueRef> NapiGetProperty(const EcmaVM *vm, uintptr_t nativeObj, uintptr_t key);
1743     static Local<JSValueRef> NapiDeleteProperty(const EcmaVM *vm, uintptr_t nativeObj, uintptr_t key);
1744     static Local<JSValueRef> NapiGetNamedProperty(const EcmaVM *vm, uintptr_t nativeObj, const char* utf8Key);
1746     static Local<JSValueRef> CreateLocal(const EcmaVM *vm, JSValueRef src);
1781     friend class Local;
1787     Local<JSValueRef> GetHandler(const EcmaVM *vm);
1788     Local<JSValueRef> GetTarget(const EcmaVM *vm);
1796     Local<JSValueRef> GetKey(const EcmaVM *vm, int entry);
1797     Local<JSValueRef> GetValue(const EcmaVM *vm, int entry);
1798     static Local<WeakMapRef> New(const EcmaVM *vm);
1799     void Set(const EcmaVM *vm, const Local<JSValueRef> &key, const Local<JSValueRef> &value);
1800     bool Has(const EcmaVM *vm, Local<JSValueRef> key);
1807     Local<JSValueRef> GetValue(const EcmaVM *vm, int entry);
1808     static Local<SetRef> New(const EcmaVM *vm);
1809     void Add(const EcmaVM *vm, Local<JSValueRef> value);
1816     Local<JSValueRef> GetValue(const EcmaVM *vm, int entry);
1817     static Local<WeakSetRef> New(const EcmaVM *vm);
1818     void Add(const EcmaVM *vm, Local<JSValueRef> value);
1824     Local<JSValueRef> GetKind(const EcmaVM *vm);
1825     static Local<SetIteratorRef> New(const EcmaVM *vm, Local<SetRef> set);
1827     static Local<ArrayRef> Next(const EcmaVM *vm, ecmascript::EcmaRuntimeCallInfo *ecmaRuntimeCallInfo);
1838     static Local<StringRef> GetCachedString(const EcmaVM *vm, uint32_t propertyIndex);

Indexes created Thu Nov 07 10:32:03 CST 2024