1 /* 2 * Copyright (c) 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 NAPI_ARK_INTEROP_NAPI_H 17 #define NAPI_ARK_INTEROP_NAPI_H 18 19 #include <cstdint> 20 #include <cstddef> 21 #include <iostream> 22 23 #include "ark_interop_macro.h" 24 25 DECL_START 26 27 /** 28 * es6 types (corresponds to typeof) 29 */ 30 typedef enum { 31 N_UNDEFINED, 32 N_NULL, 33 N_NUMBER, 34 N_BOOL, 35 N_BIGINT, 36 N_STRING, 37 N_SYMBOL, 38 N_OBJECT, 39 N_FUNCTION, 40 N_EXTERNAL, 41 } ARKTS_ValueType; 42 43 /** 44 * js object property descriptor attribute 45 */ 46 typedef enum { 47 N_WRITABLE = 0x1, 48 N_ENUMERABLE = 0x2, 49 N_CONFIGURABLE = 0x4, 50 } ARKTS_PropertyFlag; 51 52 typedef struct ARKTS_Value_* ARKTS_Value; 53 typedef struct ARKTS_Env_* ARKTS_Env; 54 typedef struct ARKTS_CallInfo_* ARKTS_CallInfo; 55 typedef struct ARKTS_Result_* ARKTS_Result; 56 /** 57 * be caution: ARKTS_Promise is not ARKTS_Value, you may not cast ARKTS_Promise to ARKTS_Value. 58 */ 59 typedef struct ARKTS_Promise_* ARKTS_Promise; 60 typedef struct ARKTS_Scope_* ARKTS_Scope; 61 typedef struct ARKTS_Global_* ARKTS_Global; 62 typedef struct ARKTS_Engine_* ARKTS_Engine; 63 64 typedef ARKTS_Result (*ARKTS_Callback)(ARKTS_CallInfo); 65 typedef ARKTS_Value (*ARKTS_ModuleExporter)(ARKTS_Env env, ARKTS_Value); 66 67 EXPORT ARKTS_Value ARKTS_GetGlobalConstant(ARKTS_Env env); 68 EXPORT uint64_t ARKTS_GetPosixThreadId(); 69 70 EXPORT ARKTS_ValueType ARKTS_GetValueType(ARKTS_Env env, ARKTS_Value src); 71 EXPORT bool ARKTS_StrictEqual(ARKTS_Env env, ARKTS_Value a, ARKTS_Value b); 72 73 EXPORT double ARKTS_GetValueNumber(ARKTS_Value value); 74 EXPORT bool ARKTS_IsNumber(ARKTS_Value value); 75 EXPORT ARKTS_Value ARKTS_CreateF64(double value); 76 EXPORT ARKTS_Value ARKTS_CreateI32(int32_t value); 77 78 EXPORT int32_t ARKTS_GetValueUtf8(ARKTS_Env env, ARKTS_Value value, int32_t capacity, char* buffer); 79 EXPORT int32_t ARKTS_GetValueUtf8Size(ARKTS_Env env, ARKTS_Value value); 80 EXPORT ARKTS_Value ARKTS_CreateUtf8(ARKTS_Env env, const char* value, int32_t size); 81 /** 82 * the result requires manually free, use ARKTS_FreeCString 83 */ 84 EXPORT const char* ARKTS_GetValueCString(ARKTS_Env env, ARKTS_Value value); 85 EXPORT void ARKTS_FreeCString(const char* src); 86 EXPORT bool ARKTS_IsString(ARKTS_Env env, ARKTS_Value value); 87 88 EXPORT ARKTS_Value ARKTS_CreateFunc(ARKTS_Env env, int64_t lambdaId); 89 /** 90 * logically equals to typeof(value) == "function" 91 */ 92 EXPORT bool ARKTS_IsCallable(ARKTS_Env env, ARKTS_Value value); 93 94 EXPORT bool ARKTS_IsClass(ARKTS_Env env, ARKTS_Value value); 95 EXPORT ARKTS_Value ARKTS_CreateClass(ARKTS_Env env, int64_t lambdaId, ARKTS_Value super); 96 EXPORT ARKTS_Value ARKTS_GetPrototype(ARKTS_Env env, ARKTS_Value value); 97 EXPORT bool ARKTS_InstanceOf(ARKTS_Env env, ARKTS_Value object, ARKTS_Value clazz); 98 99 EXPORT ARKTS_Env ARKTS_GetCallEnv(ARKTS_CallInfo info); 100 EXPORT uint32_t ARKTS_GetArgCount(ARKTS_CallInfo info); 101 EXPORT ARKTS_Value ARKTS_GetArg(ARKTS_CallInfo info, uint32_t index); 102 EXPORT ARKTS_Value ARKTS_GetThisArg(ARKTS_CallInfo info); 103 104 EXPORT ARKTS_Value ARKTS_Call(ARKTS_Env env, ARKTS_Value func, ARKTS_Value thisArg, 105 int32_t numArgs, ARKTS_Value args[]); 106 EXPORT ARKTS_Value ARKTS_New(ARKTS_Env env, ARKTS_Value clazz, int32_t numArgs, ARKTS_Value args[]); 107 108 EXPORT ARKTS_Value ARKTS_CreateNull(); 109 EXPORT bool ARKTS_IsNull(ARKTS_Value value); 110 EXPORT ARKTS_Value ARKTS_CreateUndefined(); 111 EXPORT bool ARKTS_IsUndefined(ARKTS_Value value); 112 EXPORT ARKTS_Value ARKTS_CreateBool(bool value); 113 EXPORT bool ARKTS_IsBool(ARKTS_Value value); 114 EXPORT bool ARKTS_GetValueBool(ARKTS_Value value); 115 116 EXPORT ARKTS_Value ARKTS_CreateObject(ARKTS_Env env); 117 /** 118 * js types excludes [number, boolean, null, undefined] are JSHeapObject 119 */ 120 EXPORT bool ARKTS_IsHeapObject(ARKTS_Value value); 121 122 // only available for JSObject, any other heap object(like JSArray, JSProxy...) supposed to call it's type-specific api 123 EXPORT bool ARKTS_IsObject(ARKTS_Env env, ARKTS_Value value); 124 EXPORT bool ARKTS_HasOwnProperty(ARKTS_Env env, ARKTS_Value jobj, ARKTS_Value jkey); 125 EXPORT ARKTS_Value ARKTS_EnumOwnProperties(ARKTS_Env env, ARKTS_Value jobj); 126 EXPORT void ARKTS_DefineOwnProperty(ARKTS_Env env, ARKTS_Value jobj, ARKTS_Value jkey, 127 ARKTS_Value jvalue, ARKTS_PropertyFlag attrs); 128 129 typedef struct ARKTS_Accessor_ { 130 ARKTS_Value getter; 131 ARKTS_Value setter; 132 ARKTS_PropertyFlag attrs; 133 } ARKTS_Accessor; 134 135 EXPORT void ARKTS_DefineAccessors(ARKTS_Env env, ARKTS_Value jobj, ARKTS_Value jkey, ARKTS_Accessor accessor); 136 EXPORT void ARKTS_SetProperty(ARKTS_Env env, ARKTS_Value jobj, ARKTS_Value jkey, ARKTS_Value jvalue); 137 EXPORT ARKTS_Value ARKTS_GetProperty(ARKTS_Env env, ARKTS_Value jobj, ARKTS_Value jkey); 138 139 EXPORT ARKTS_Value ARKTS_CreateArray(ARKTS_Env env, uint32_t size); 140 EXPORT ARKTS_Value ARKTS_CreateArrayWithInit(ARKTS_Env env, uint32_t size, ARKTS_Value data[]); 141 EXPORT uint32_t ARKTS_GetArrayLength(ARKTS_Env env, ARKTS_Value array); 142 EXPORT void ARKTS_SetElement(ARKTS_Env env, ARKTS_Value array, uint32_t index, ARKTS_Value value); 143 EXPORT ARKTS_Value ARKTS_GetElement(ARKTS_Env env, ARKTS_Value array, uint32_t index); 144 EXPORT bool ARKTS_IsArray(ARKTS_Env env, ARKTS_Value value); 145 146 EXPORT ARKTS_Global ARKTS_CreateGlobal(ARKTS_Env env, ARKTS_Value value); 147 EXPORT ARKTS_Value ARKTS_GetGlobalValue(ARKTS_Global global); 148 EXPORT void ARKTS_DisposeGlobal(ARKTS_Env env, ARKTS_Global global); 149 150 EXPORT ARKTS_Value ARKTS_CreateExternal(ARKTS_Env env, void* data); 151 EXPORT bool ARKTS_IsExternal(ARKTS_Env env, ARKTS_Value value); 152 EXPORT void* ARKTS_GetExternalData(ARKTS_Env env, ARKTS_Value value); 153 154 EXPORT ARKTS_Value ARKTS_CreateSymbol(ARKTS_Env env, const char* description, int32_t length); 155 EXPORT bool ARKTS_IsSymbol(ARKTS_Env env, ARKTS_Value value); 156 EXPORT const char* ARKTS_GetSymbolDesc(ARKTS_Env env, ARKTS_Value value); 157 158 EXPORT ARKTS_Engine ARKTS_CreateEngine(); 159 EXPORT void* ARKTS_GetNAPIEnv(ARKTS_Engine engine); 160 EXPORT void ARKTS_DestroyEngine(ARKTS_Engine engine); 161 EXPORT ARKTS_Env ARKTS_GetContext(ARKTS_Engine engine); 162 EXPORT ARKTS_Engine ARKTS_CreateEngineWithNewThread(); 163 EXPORT uint64_t ARKTS_GetThreadIdOfEngine(ARKTS_Engine engine); 164 165 EXPORT bool ARKTS_LoadEntryFromAbc(ARKTS_Engine engine, const char* filePath, const char* entryPoint, 166 bool forceReload); 167 EXPORT ARKTS_Value ARKTS_ImportFromEntry(ARKTS_Engine engine, const char* entryPoint, const char* importName); 168 169 EXPORT ARKTS_Value ARKTS_Require(ARKTS_Env env, const char* target, bool isNativeModule, bool isAppModule, 170 const char* relativePath); 171 172 /** 173 * promise in js and native are in different forms, 174 * ARKTS_Promise the native form, ARKTS_Value is the js form, never cast one to another 175 * the interface returns both forms, native ARKTS_Promise returns by params 'out', 176 * ARKTS_Promise won't be collected until ARKTS_PromiseCapabilityResolve or ARKTS_PromiseCapabilityReject 177 */ 178 EXPORT ARKTS_Promise ARKTS_CreatePromiseCapability(ARKTS_Env env); 179 EXPORT ARKTS_Value ARKTS_GetPromiseFromCapability(ARKTS_Env env, ARKTS_Promise prom); 180 EXPORT void ARKTS_PromiseCapabilityResolve(ARKTS_Env env, ARKTS_Promise prom, ARKTS_Value result); 181 EXPORT void ARKTS_PromiseCapabilityReject(ARKTS_Env env, ARKTS_Promise prom, ARKTS_Value result); 182 EXPORT bool ARKTS_IsPromise(ARKTS_Env env, ARKTS_Value value); 183 EXPORT ARKTS_Value ARKTS_PromiseThen(ARKTS_Env env, ARKTS_Value prom, ARKTS_Value onFulfilled, 184 ARKTS_Value onRejected); 185 EXPORT void ARKTS_PromiseCatch(ARKTS_Env env, ARKTS_Value prom, ARKTS_Value callback); 186 187 EXPORT void ARKTS_CreateAsyncTask(ARKTS_Env env, int64_t callbackId); 188 189 /** 190 * if native func call js function, GC would be triggered and objects created by native would be collected. 191 * objects created in scope will keep alive 192 * scope will close by ARKTS_Return 193 */ 194 EXPORT ARKTS_Scope ARKTS_OpenScope(ARKTS_Env env); 195 EXPORT void ARKTS_CloseScope(ARKTS_Env env, ARKTS_Scope scope); 196 EXPORT ARKTS_Result ARKTS_Return(ARKTS_Env env, ARKTS_Scope scope, ARKTS_Value value); 197 198 /** 199 * if error supposed to be catch by js, returns asap, 200 * some native api may lead to native exception handling procedural 201 */ 202 EXPORT void ARKTS_Throw(ARKTS_Env env, ARKTS_Value error); 203 204 EXPORT ARKTS_Value ARKTS_CreateArrayBuffer(ARKTS_Env env, int32_t); 205 EXPORT ARKTS_Value ARKTS_CreateArrayBufferWithData(ARKTS_Env env, void* buffer, int32_t length, 206 int64_t finalizerHint); 207 EXPORT bool ARKTS_IsArrayBuffer(ARKTS_Env env, ARKTS_Value value); 208 EXPORT int32_t ARKTS_GetArrayBufferLength(ARKTS_Env env, ARKTS_Value value); 209 EXPORT void* ARKTS_GetArrayBufferRawPtr(ARKTS_Env env, ARKTS_Value value); 210 EXPORT int32_t ARKTS_ArrayBufferReadBytes(ARKTS_Env env, ARKTS_Value buffer, void* dest, int32_t count); 211 212 EXPORT ARKTS_Value ARKTS_CreateBigInt(ARKTS_Env env, int64_t value); 213 EXPORT ARKTS_Value ARKTS_CreateBigIntWithBytes(ARKTS_Env env, bool isNegative, int64_t size, const uint8_t bytes[]); 214 EXPORT bool ARKTS_IsBigInt(ARKTS_Env env, ARKTS_Value value); 215 EXPORT int64_t ARKTS_BigIntGetByteSize(ARKTS_Env env, ARKTS_Value value); 216 EXPORT void ARKTS_BigIntReadBytes(ARKTS_Env env, ARKTS_Value value, bool* isNegative, 217 int64_t byteCount, uint8_t bytes[]); 218 219 EXPORT void ARKTS_InitEventHandle(ARKTS_Env env); 220 221 EXPORT void* ARKTS_GetGlobalNapiEnv(ARKTS_Env env); 222 223 DECL_END 224 225 #endif //NAPI_ARK_INTEROP_NAPI_H 226