/*
 * Copyright (c) 2021 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef ARK_RUNTIME_JSVM_JSVM_H
#define ARK_RUNTIME_JSVM_JSVM_H

/**
 * @addtogroup JSVM
 * @{
 *
 * @brief 提供标准的JavaScript引擎能力。
 *
 * 功能概述：
 * 标准JS引擎是严格遵守Ecmascript规范的JavaScript代码执行引擎。
 * 支持Ecmascript规范定义的标准库，提供完备的C++交互JS的native API。
 * 通过jit加速代码执行，为应用提供安全、高效的JS执行能力。
 * 标准JS引擎的能力通过一套稳定的ABI，即JSVM-API提供。JSVM-API支持动态链接到不同版本的JS引擎库，
 * 从而为开发者屏蔽掉不同引擎接口的差异。JSVM-API提供引擎生命周期管理、JS context管理、
 * JS代码执行、JS/C++互操作、执行环境快照、codecache等能力。
 * 使用平台：arm64平台。
 * 使用方法：链接SDK中的libjsvm.so，并在C++代码中包含ark_runtime/jsvm.h头文件。
 *
 * @since 11
 */

/**
 * @file jsvm.h
 *
 * @brief 提供JSVM-API接口定义。
 *
 * 通过API接口为开发者提供独立、标准、完整的JavaScript引擎能力，
 * 包括管理引擎生命周期、编译运行JS代码、实现JS/C++跨语言调用、拍摄快照等。
 * @library libjsvm.so
 * @syscap SystemCapability.ArkCompiler.JSVM
 * @since 11
 */

// 此文件必须与C编译器兼容。
#include <stdbool.h>  // NOLINT(modernize-deprecated-headers)
#include <stddef.h>   // NOLINT(modernize-deprecated-headers)

// 使用INT_MAX，只能由预处理器消费。
#define JSVM_VERSION_EXPERIMENTAL 2147483647
#ifndef JSVM_VERSION
#ifdef JSVM_EXPERIMENTAL
#define JSVM_VERSION JSVM_VERSION_EXPERIMENTAL
#else

#define JSVM_VERSION 8
#endif
#endif

#include "jsvm_types.h"

#ifndef JSVM_EXTERN
#ifdef _WIN32
/**
 * @brief 对外可见。
 *
 * @since 11
 */
#define JSVM_EXTERN __declspec(dllexport)
#elif defined(__wasm__)
#define JSVM_EXTERN                                           \
    __attribute__((visibility("default")))                    \
    __attribute__((__import_module__("jsvm")))
#else
#define JSVM_EXTERN __attribute__((visibility("default")))
#endif
#endif

/**
 * @brief 自动长度。
 *
 * @since 11
 */
#define JSVM_AUTO_LENGTH SIZE_MAX

#ifdef __cplusplus
#define EXTERN_C_START extern "C" {
#define EXTERN_C_END }
#else
#define EXTERN_C_START
#define EXTERN_C_END
#endif

EXTERN_C_START

/**
 * @brief 初始化一个JavaScript虚拟机。
 *
 * @param options 用于初始化JavaScript虚拟机的选项。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_Init(const JSVM_InitOptions* options);

/**
 * @brief 创建一个虚拟机实例。
 *
 * @param options 用于创建虚拟机实例的选项。
 * @param result 新的虚拟机实例。
 * @return 成功则返回JSVM_OK，失败可能返回JSVM_INVALID_ARG。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_CreateVM(const JSVM_CreateVMOptions* options,
                                         JSVM_VM* result);

/**
 * @brief 销毁一个虚拟机实例。
 *
 * @param vm 待销毁的虚拟机实例。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_DestroyVM(JSVM_VM vm);

/**
 * @brief 为虚拟机实例打开一个新的虚拟机作用域。
 *
 * @param vm 目标虚拟机实例。
 * @param result 新的虚拟机作用域。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_OpenVMScope(JSVM_VM vm,
                                            JSVM_VMScope* result);

/**
 * @brief 关闭虚拟机实例的虚拟机作用域。
 *
 * @param vm 目标虚拟机实例。
 * @param scope 将要关闭的虚拟机作用域。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_CloseVMScope(JSVM_VM vm,
                                             JSVM_VMScope scope);

/**
 * @brief 基于新环境上下文的可选属性，创建一个新环境。
 *
 * @param vm 虚拟机实例，新环境将在该实例中创建。
 * @param propertyCount 属性数组中元素的个数。
 * @param properties 属性描述符的数组。
 * @param result 创建的新环境。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_CreateEnv(JSVM_VM vm,
                                          size_t propertyCount,
                                          const JSVM_PropertyDescriptor* properties,
                                          JSVM_Env* result);

/**
 * @brief 基于虚拟机的起始快照，创建一个新的环境。
 *
 * @param vm 虚拟机实例，新环境将在该实例中创建。
 * @param index 环境在快照中的索引。
 * @param result 创建的新环境。
 * @return 成功则返回JSVM_OK，失败可能返回JSVM_GENERIC_FAILURE。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_CreateEnvFromSnapshot(JSVM_VM vm,
                                                      size_t index,
                                                      JSVM_Env* result);

/**
 * @brief 销毁环境。
 *
 * @param env 待销毁的环境。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_DestroyEnv(JSVM_Env env);

/**
 * @brief 打开一个新的环境作用域。
 *
 * @param env 目标环境，JSVM-API接口将在该环境下调用。
 * @param result 新的环境作用域。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_OpenEnvScope(JSVM_Env env,
                                             JSVM_EnvScope* result);

/**
 * @brief 关闭环境作用域。
 *
 * @param env 目标环境，JSVM-API接口将在该环境下调用。
 * @param scope 将要关闭的环境作用域。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_CloseEnvScope(JSVM_Env env,
                                              JSVM_EnvScope scope);

/**
 * @brief 编译一串JavaScript代码，并返回编译后的脚本。
 *
 * @param env 目标环境，JSVM-API接口将在该环境下调用。
 * @param script 包含要编译的脚本的JavaScript代码。
 * @param cachedData 可选。脚本的代码缓存数据。
 * @param cacheDataLength cachedData数组的长度。
 * @param eagerCompile 是否立即编译脚本。
 * @param cacheRejected 代码缓存是否被编译拒绝。
 * @param result 编译后的脚本。
 * @return 成功则返回JSVM_OK，失败可能返回JSVM_STRING_EXPECTED或JSVM_GENERIC_FAILURE。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_CompileScript(JSVM_Env env,
                                              JSVM_Value script,
                                              const uint8_t* cachedData,
                                              size_t cacheDataLength,
                                              bool eagerCompile,
                                              bool* cacheRejected,
                                              JSVM_Script* result);

/**
 * @brief 为编译后的脚本创建代码缓存。
 *
 * @param env 目标环境，JSVM-API接口将在该环境下调用。
 * @param script 目标编译脚本。
 * @param data 代码缓存的数据。
 * @param length 代码缓存数据的长度。
 * @return 成功则返回JSVM_OK，失败可能返回JSVM_GENERIC_FAILURE。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_CreateCodeCache(JSVM_Env env,
                                                JSVM_Script script,
                                                const uint8_t** data,
                                                size_t* length);

/**
 * @brief 执行一串JavaScript代码并返回其结果，其中包含以下注意事项：
 * 与eval不同的是，该函数不允许脚本访问当前词法作用域，因此也不允许访问模块作用域，
 * 这意味着require等伪全局变量将不可用。
 * 脚本可以访问全局作用域。
 * 脚本中的函数和var声明将被添加到全局对象。
 * 使用let和const的变量声明将全局可见，但不会被添加到全局对象。
 * this的值在脚本内是global。
 *
 * @param env 调用JSVM-API的环境。
 * @param script 包含要执行的脚本的JavaScript字符串。
 * @param result 执行脚本产生的值。
 * @return 成功则返回JSVM_OK，失败可能返回JSVM_GENERIC_FAILURE。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_RunScript(JSVM_Env env,
                                          JSVM_Script script,
                                          JSVM_Value* result);

/**
 * @brief 将data与当前运行的JSVM环境相关联。后续可以使用OH_JSVM_GetInstanceData()检索data。
 * 通过先前调用OH_JSVM_SetInstanceData()设置的任何与当前运行的JSVM环境相关联的现有数据都将
 * 被覆盖。如果先前提供了finalizeCb，则不会调用它。
 *
 * @param env 调用JSVM-API的环境。
 * @param data 可用于此实例的绑定的数据项。
 * @param finalizeCb 销毁环境时调用的函数，该函数接收data以便释放它。
 * @param finalizeHint 在收集期间传递给最终回调的可选提示。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_SetInstanceData(JSVM_Env env,
                                                void* data,
                                                JSVM_Finalize finalizeCb,
                                                void* finalizeHint);

/**
 * @brief 检索通过OH_JSVM_SetInstanceData()与当前运行的JSVM环境相关联的数据。
 * 如果未设置任何关联数据，该函数调用将成功，且data设置为NULL。
 *
 * @param env 调用JSVM-API的环境。
 * @param data 之前通过调用OH_JSVM_SetInstanceData()与当前运行的JSVM环境关联的数据项。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_GetInstanceData(JSVM_Env env,
                                                void** data);

/**
 * @brief 检索JSVM_ExtendedErrorInfo结构，其中包含有关发生的最后一个错误的信息。
 * 返回的JSVM_ExtendedErrorInfo的内容仅在对同一env调用JSVM-API函数之前有效。
 * 这包括对OH_JSVM_IsExceptionPending的调用，因此可能经常需要复制信息以便以后使用。
 * error_message中返回的指针指向一个静态定义的字符串，因此如果你在调用另一个JSVM-API
 * 函数之前将它从error_message字段（将被覆盖）中复制出来，则可以安全地使用该指针。
 *
 * @param env 调用JSVM-API的环境。
 * @param result 包含有关错误的更多信息的JSVM_ExtendedErrorInfo结构。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_GetLastErrorInfo(JSVM_Env env,
                                                 const JSVM_ExtendedErrorInfo** result);

/**
 * @brief 抛出提供的JavaScript值。
 *
 * @param env 调用JSVM-API的环境。
 * @param error 要抛出的JavaScript值。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_Throw(JSVM_Env env,
                                      JSVM_Value error);

/**
 * @brief 会抛出带有所提供文本的JavaScript Error。
 *
 * @param env 调用JSVM-API的环境。
 * @param code 要在错误上设置的可选错误代码。
 * @param msg 表示与错误关联的文本的C字符串。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_ThrowError(JSVM_Env env,
                                           const char* code,
                                           const char* msg);

/**
 * @brief 会抛出带有所提供文本的JavaScript TypeError。
 *
 * @param env 调用JSVM-API的环境。
 * @param code 要在错误上设置的可选错误代码。
 * @param msg 表示与错误关联的文本的C字符串。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_ThrowTypeError(JSVM_Env env,
                                               const char* code,
                                               const char* msg);

/**
 * @brief 会抛出带有所提供文本的JavaScript RangeError。
 *
 * @param env 调用JSVM-API的环境。
 * @param code 要在错误上设置的可选错误代码。
 * @param msg 表示与错误关联的文本的C字符串。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_ThrowRangeError(JSVM_Env env,
                                                const char* code,
                                                const char* msg);

/**
 * @brief 会抛出带有所提供文本的JavaScript SyntaxError。
 *
 * @param env 调用JSVM-API的环境。
 * @param code 要在错误上设置的可选错误代码。
 * @param msg 表示与错误关联的文本的C字符串。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_ThrowSyntaxError(JSVM_Env env,
                                                 const char* code,
                                                 const char* msg);

/**
 * @brief 查询JSVM_Value以检查它是否表示错误对象。
 *
 * @param env 调用JSVM-API的环境。
 * @param value 待检查的JSVM_Value。
 * @param result 如果JSVM_Value表示错误，则设置为true的布尔值，否则设置为false。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_IsError(JSVM_Env env,
                                        JSVM_Value value,
                                        bool* result);

/**
 * @brief 返回带有所提供文本的JavaScript Error。
 *
 * @param env 调用JSVM-API的环境。
 * @param code 可选的JSVM_Value，带有与错误关联的错误代码的字符串。
 * @param msg 引用JavaScript string用作Error的消息。
 * @param result 表示创建的错误。
 * @return 成功则返回JSVM_OK，失败可能返回JSVM_STRING_EXPECTED。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_CreateError(JSVM_Env env,
                                            JSVM_Value code,
                                            JSVM_Value msg,
                                            JSVM_Value* result);

/**
 * @brief 返回带有所提供文本的JavaScript TypeError。
 *
 * @param env 调用JSVM-API的环境。
 * @param code 可选的JSVM_Value，带有与错误关联的错误代码的字符串。
 * @param msg 引用JavaScript string用作Error的消息。
 * @param result 表示创建的错误。
 * @return 成功则返回JSVM_OK，失败可能返回JSVM_STRING_EXPECTED。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_CreateTypeError(JSVM_Env env,
                                                JSVM_Value code,
                                                JSVM_Value msg,
                                                JSVM_Value* result);

/**
 * @brief  返回带有所提供文本的JavaScript RangeError。
 *
 * @param env 调用JSVM-API的环境。
 * @param code 可选的JSVM_Value，带有与错误关联的错误代码的字符串。
 * @param msg 引用JavaScript string用作Error的消息。
 * @param result 表示创建的错误。
 * @return 成功则返回JSVM_OK，失败可能返回JSVM_STRING_EXPECTED。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_CreateRangeError(JSVM_Env env,
                                                 JSVM_Value code,
                                                 JSVM_Value msg,
                                                 JSVM_Value* result);

/**
 * @brief 返回带有所提供文本的JavaScript SyntaxError。
 *
 * @param env 调用JSVM-API的环境。
 * @param code 可选的JSVM_Value，带有与错误关联的错误代码的字符串。
 * @param msg 引用JavaScript string用作Error的消息。
 * @param result 表示创建的错误。
 * @return 成功则返回JSVM_OK，失败可能返回JSVM_STRING_EXPECTED。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_CreateSyntaxError(JSVM_Env env,
                                                  JSVM_Value code,
                                                  JSVM_Value msg,
                                                  JSVM_Value* result);

/**
 * @brief 获取并清除上一次异常。如果出现挂起，则返回JavaScript异常，否则返回NULL。
 *
 * @param env 调用JSVM-API的环境。
 * @param result 如果出现挂起则返回异常，否则为NULL。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_GetAndClearLastException(JSVM_Env env,
                                                         JSVM_Value* result);

/**
 * @brief 查询上一次异常是否由挂起导致的。如果由异常导致，则返回true，否则返回false。
 *
 * @param env 调用JSVM-API的环境。
 * @param result 如果异常挂起，则设置为true的布尔值。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_IsExceptionPending(JSVM_Env env,
                                                   bool* result);

/**
 * @brief 开辟了一个新的作用域。
 *
 * @param env 调用JSVM-API的环境。
 * @param result 代表新作用域。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_OpenHandleScope(JSVM_Env env,
                                                JSVM_HandleScope* result);

/**
 * @brief 关闭传入的作用域。必须按照创建作用域的相反顺序关闭作用域。
 *
 * @param env 调用JSVM-API的环境。
 * @param scope 表示要关闭的作用域。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_CloseHandleScope(JSVM_Env env,
                                                 JSVM_HandleScope scope);

/**
 * @brief 会打开一个新作用域，从中可以将一个对象提升到外部作用域。
 *
 * @param env 调用JSVM-API的环境。
 * @param result 代表新作用域。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_OpenEscapableHandleScope(JSVM_Env env,
                                                         JSVM_EscapableHandleScope* result);

/**
 * @brief 关闭传入的作用域。必须按照创建作用域的相反顺序关闭作用域。
 * 即使存在挂起的JavaScript异常，也可以调用此JSVM_API。
 *
 * @param env 调用JSVM-API的环境。
 * @param scope 表示要关闭的作用域。
 * @return 成功则返回JSVM_OK，失败可能返回JSVM_HANDLE_SCOPE_MISMATCH。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_CloseEscapableHandleScope(JSVM_Env env,
                                                          JSVM_EscapableHandleScope scope);

/**
 * @brief 提升JavaScript对象的句柄，使其在外部作用域的生命周期内有效。
 * 每个作用域只能调用一次。如果多次调用，将返回错误。
 *
 * @param env 调用JSVM-API的环境。
 * @param scope 表示当前的作用域。
 * @param escapee 表示要提升的JavaScript Object。
 * @param result 被提升的Object在外部作用域中的句柄。
 * @return 成功则返回JSVM_OK，失败可能返回JSVM_ESCAPE_CALLED_TWICE。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_EscapeHandle(JSVM_Env env,
                                             JSVM_EscapableHandleScope scope,
                                             JSVM_Value escapee,
                                             JSVM_Value* result);

/**
 * @brief 对传入的值创建一个具有指定引用计数的新引用。
 *
 * @param env 调用JSVM-API的环境。
 * @param value 正在为其创建引用的JSVM_Value。
 * @param initialRefcount 新引用的初始引用计数。
 * @param result 指向新的引用。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_CreateReference(JSVM_Env env,
                                                JSVM_Value value,
                                                uint32_t initialRefcount,
                                                JSVM_Ref* result);

/**
 * @brief 删除传入的引用。
 *
 * @param env 调用JSVM-API的环境。
 * @param ref 需删除的JSVM_Ref。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_DeleteReference(JSVM_Env env,
                                                JSVM_Ref ref);

/**
 * @brief 增加传入引用的引用计数并返回生成的引用计数。
 *
 * @param env 调用JSVM-API的环境。
 * @param ref 传入的引用，其引用计数将增加。
 * @param result 新的引用计数。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_ReferenceRef(JSVM_Env env,
                                             JSVM_Ref ref,
                                             uint32_t* result);

/**
 * @brief 递减传入引用的引用计数并返回生成的引用计数。
 *
 * @param env 调用JSVM-API的环境。
 * @param ref 将减少其引用计数的JSVM_Ref。
 * @param result 新的引用计数。
 * @return 成功则返回JSVM_OK，失败可能返回JSVM_GENERIC_FAILURE。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_ReferenceUnref(JSVM_Env env,
                                               JSVM_Ref ref,
                                               uint32_t* result);

/**
 * @brief 如果仍然有效，此JSVM-API将返回JSVM_Value，
 * 表示与JSVM_Ref关联的JavaScript值。否则，结果将为NULL。
 *
 * @param env 调用JSVM-API的环境。
 * @param ref 请求相应值的JSVM_Ref。
 * @param result JSVM_Ref引用的JSVM_Value。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_GetReferenceValue(JSVM_Env env,
                                                  JSVM_Ref ref,
                                                  JSVM_Value* result);

/**
 * @brief 返回对应于JavaScript Array类型的JSVM-API值。
 *
 * @param env 调用JSVM-API的环境。
 * @param result 代表JavaScript Array的JSVM_Value。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_CreateArray(JSVM_Env env,
                                            JSVM_Value* result);


/**
 * @brief 返回对应于JavaScript Array类型的JSVM-API值。Array
 * 的长度属性设置为传入的长度参数。但是，不保证底层缓冲区在创建
 * 数组时由VM预先分配。该行为留给底层VM实现。
 *
 * @param env 调用JSVM-API的环境。
 * @param length 数组的初始长度。
 * @param result 代表JavaScript Array的JSVM_Value。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_CreateArrayWithLength(JSVM_Env env,
                                                      size_t length,
                                                      JSVM_Value* result);

/**
 * @brief 返回JavaScript ArrayBuffer类型对应的JSVM-API值。ArrayBuffer用于
 * 表示固定长度的二进制数据缓冲区。通常用作TypedArray对象的后备缓冲区。
 * 分配的ArrayBuffer有一个底层字节缓冲区，其大小由传入的length参数决定。
 * 底层缓冲区可选择返回给调用方，调用方可直接操作该缓冲区。
 * 此缓冲区只能直接从native代码写入。如果想从JavaScript写入该缓冲区，
 * 需创建TypedArray或DataView对象。
 *
 * @param env 调用JSVM-API的环境。
 * @param byteLength 要创建的数组缓冲区的字节长度。
 * @param data 指向ArrayBuffer的底层字节缓冲区的指针。data可以选择性地通过传递NULL来忽略。
 * @param result 代表JavaScript ArrayBuffer的JSVM_Value。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_CreateArraybuffer(JSVM_Env env,
                                                  size_t byteLength,
                                                  void** data,
                                                  JSVM_Value* result);

/**
 * @brief 分配一个JavaScript Date对象。此API不处理闰秒。
 * 这是因为ECMAScript遵循POSIX时间规范，对闰秒进行忽略。
 *
 * @param env 调用JSVM-API的环境。
 * @param time 自1970年1月1日UTC以来的ECMAScript时间值（以毫秒为单位）。
 * @param result 表示JavaScript Date对象的JSVM_Value。
 * @return 成功则返回JSVM_OK，失败可能返回JSVM_GENERIC_FAILURE。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_CreateDate(JSVM_Env env,
                                           double time,
                                           JSVM_Value* result);

/**
 * @brief 分配一个带有外部数据的JavaScript值。这用于通过JavaScript代码传递外部数据。
 * 后续可以使用OH_JSVM_GetValueExternal由native代码检索。
 * 该API添加了一个JSVM_Finalize回调，当刚刚创建的JavaScript对象被垃圾回收时将调用该回调。
 * 创建的值不是一个对象，因此不支持附加属性。它被认为是一个独特的值类型：
 * 使用外部值调用OH_JSVM_Typeof()会生成JSVM_EXTERNAL。
 *
 * @param env 调用JSVM-API的环境。
 * @param data 指向外部数据的原始指针。
 * @param finalizeCb 收集外部值时调用的可选回调。JSVM_Finalize提供了更多详细信息。
 * @param finalizeHint 在收集期间传递给最终回调的可选提示。
 * @param result 表示外部值的JSVM_Value。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_CreateExternal(JSVM_Env env,
                                               void* data,
                                               JSVM_Finalize finalizeCb,
                                               void* finalizeHint,
                                               JSVM_Value* result);

/**
 * @brief 分配一个默认的JavaScript对象。该函数功能等同于在JavaScript中执行new Object()。
 *
 * @param env 调用JSVM-API的环境。
 * @param result 表示JavaScript对象的JSVM_Value。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_CreateObject(JSVM_Env env,
                                             JSVM_Value* result);

/**
 * @brief 从UTF8 编码的C字符串创建JavaScript symbol值。
 *
 * @param env 调用JSVM-API的环境。
 * @param description 可选的JSVM_Value，它指的是要设置为符号描述的JavaScript string。
 * @param result 代表JavaScript symbol的JSVM_Value。
 * @return 成功则返回JSVM_OK，失败可能返回JSVM_STRING_EXPECTED。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_CreateSymbol(JSVM_Env env,
                                             JSVM_Value description,
                                             JSVM_Value* result);

/**
 * @brief 在全局注册表中搜索具有给定描述的现有符号。如果该
 * 符号已经存在，它将被返回，否则将在注册表中创建一个新符号。
 *
 * @param env 调用JSVM-API的环境。
 * @param utf8description UTF-8 C 字符串，表示用作符号描述的文本。
 * @param length 描述字符串的长度，以字节为单位。如果字符串以null结尾，则为JSVM_AUTO_LENGTH。
 * @param result 表示JavaScript 符号的JSVM_Value。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_SymbolFor(JSVM_Env env,
                                          const char* utf8description,
                                          size_t length,
                                          JSVM_Value* result);

/**
 * @brief 基于已有的ArrayBuffer对象，创建一个JavaScript TypedArray对象。TypedArray
 * 对象在底层数据缓冲区上提供了一个类似数组的视图，其中每个元素都具有
 * 相同的底层二进制标量数据类型。要求：（length* 元素大小）+ byteOffset
 * 小于等于传入的数组的大小（以字节为单位）。否则，将抛出范围错误（RangeError）。
 *
 * @param env 调用JSVM-API的环境。
 * @param type TypedArray中元素的标量数据类型。
 * @param length TypedArray中的元素个数。
 * @param arraybuffer ArrayBuffer是类型化数组的基础。
 * @param byteOffset ArrayBuffer中开始投影TypedArray的字节偏移量。
 * @param result 表示JavaScript TypedArray的JSVM_Value。
 * @return 成功则返回JSVM_OK，失败可能返回JSVM_INVALID_ARG。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_CreateTypedarray(JSVM_Env env,
                                                 JSVM_TypedarrayType type,
                                                 size_t length,
                                                 JSVM_Value arraybuffer,
                                                 size_t byteOffset,
                                                 JSVM_Value* result);

/**
 * @brief 基于已有的ArrayBuffer对象，创建一个JavaScript DataView对象。DataView
 * 对象在底层数据缓冲区上提供了一个类似数组的视图，其中的元素可以具有不同的大小和类型。
 * 要求：二进制的length + byteOffset
 * 小于或等于传入的数组的大小（以字节为单位）。否则，将抛出范围错误（RangeError）。
 *
 * @param env 调用JSVM-API的环境。
 * @param length DataView中的元素个数。
 * @param arraybuffer 位于DataView底层的ArrayBuffer。
 * @param byteOffset ArrayBuffer中的字节偏移量，指示投影DataView的开始位置。
 * @param result 表示JavaScript DataView对象的JSVM_Value。
 * @return 成功则返回JSVM_OK，失败可能返回JSVM_PENDING_EXCEPTION。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_CreateDataview(JSVM_Env env,
                                               size_t length,
                                               JSVM_Value arraybuffer,
                                               size_t byteOffset,
                                               JSVM_Value* result);

/**
 * @brief 将C int32_t类型的值转换为JavaScript number类型。
 *
 * @param env 调用JSVM-API的环境。
 * @param value 要在JavaScript中表示的整数值。
 * @param result 表示JavaScript number类型的JSVM_Value。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_CreateInt32(JSVM_Env env,
                                            int32_t value,
                                            JSVM_Value* result);

/**
 * @brief 将C uint32_t类型的值转换为JavaScript number类型。
 *
 * @param env 调用JSVM-API的环境。
 * @param value 要在JavaScript中表示的无符号整数值。
 * @param result 表示JavaScript number类型的JSVM_Value。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_CreateUint32(JSVM_Env env,
                                             uint32_t value,
                                             JSVM_Value* result);

/**
 * @brief 将C int64_t类型的值转换为JavaScript number类型。
 *
 * @param env 调用JSVM-API的环境。
 * @param value 要在JavaScript中表示的整数值。
 * @param result 代表JavaScript number类型的JSVM_Value。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_CreateInt64(JSVM_Env env,
                                            int64_t value,
                                            JSVM_Value* result);

/**
 * @brief 将C double类型的值转换为JavaScript number类型。
 *
 * @param env 调用JSVM-API的环境。
 * @param value 要在JavaScript中表现的双精度值。
 * @param result 代表JavaScript number类型的JSVM_Value。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_CreateDouble(JSVM_Env env,
                                             double value,
                                             JSVM_Value* result);

/**
 * @brief 将C int64_t类型的值转换为JavaScript BigInt类型。
 *
 * @param env 调用JSVM-API的环境。
 * @param value 要在JavaScript中表现的整数值。
 * @param result 表示JavaScript BigInt类型的JSVM_Value。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_CreateBigintInt64(JSVM_Env env,
                                                  int64_t value,
                                                  JSVM_Value* result);

/**
 * @brief 将C uint64_t类型的值转换为JavaScript BigInt类型。
 *
 * @param env 调用JSVM-API的环境。
 * @param value 要在JavaScript中表示的无符号整数值。
 * @param result 代表JavaScript BigInt类型的JSVM_Value。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_CreateBigintUint64(JSVM_Env env,
                                                   uint64_t value,
                                                   JSVM_Value* result);

/**
 * @brief 将一组无符号64位字转换为单个BigInt值。
 *
 * @param env 调用JSVM-API的环境。
 * @param signBit 确定生成的BigInt是正数还是负数。
 * @param wordCount words数组的长度。
 * @param words uint64_t little-endian 64位字数组。
 * @param result 代表JavaScript BigInt类型的JSVM_Value。
 * @return 成功则返回JSVM_OK，失败可能返回JSVM_INVALID_ARG或JSVM_GENERIC_FAILURE。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_CreateBigintWords(JSVM_Env env,
                                                  int signBit,
                                                  size_t wordCount,
                                                  const uint64_t* words,
                                                  JSVM_Value* result);

/**
 * @brief 将采用ISO-8859-1编码的C字符串转换为JavaScript string值。
 * 复制原生字符串。
 *
 * @param env 调用JSVM-API的环境。
 * @param str 表示ISO-8859-1编码的字符串的字符缓冲区。
 * @param length 字符串的长度，以字节为单位。如果它以null结尾，则为JSVM_AUTO_LENGTH。
 * @param result 表示JavaScript字符串的JSVM_Value。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_CreateStringLatin1(JSVM_Env env,
                                                   const char* str,
                                                   size_t length,
                                                   JSVM_Value* result);

/**
 * @brief 将采用UTF16-LE编码的C字符串转换为JavaScript字符串值。
 * 复制原生字符串。
 *
 * @param env 调用JSVM-API的环境。
 * @param str 表示UTF16-LE编码的字符串的字符缓冲区。
 * @param length 以两字节代码单元表示的字符串长度，如果它以null终止，则为JSVM_AUTO_LENGTH。
 * @param result 代表JavaScript string的JSVM_Value。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_CreateStringUtf16(JSVM_Env env,
                                                  const char16_t* str,
                                                  size_t length,
                                                  JSVM_Value* result);

/**
 * @brief 从UTF8编码的C字符串创建JavaScript string值。
 * 复制原生字符串。
 *
 * @param env 调用JSVM-API的环境。
 * @param str 表示UTF8编码字符串的字符缓冲区。
 * @param length 字符串的长度，以字节为单位。如果字符串以null结尾，则为JSVM_AUTO_LENGTH。
 * @param result 代表JavaScript字符串的JSVM_Value。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_CreateStringUtf8(JSVM_Env env,
                                                 const char* str,
                                                 size_t length,
                                                 JSVM_Value* result);

/**
 * @brief 返回数组的长度。
 *
 * @param env 调用JSVM-API的环境。
 * @param value: 代表查询长度的JavaScript Array。
 * @param result uint32代表数组的长度。
 * @return 成功则返回JSVM_OK，失败可能返回JSVM_ARRAY_EXPECTED。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_GetArrayLength(JSVM_Env env,
                                               JSVM_Value value,
                                               uint32_t* result);

/**
 * @brief 用于检索ArrayBuffer的底层数据缓冲区及其长度。
 *
 * @param env 调用JSVM-API的环境。
 * @param arraybuffer 代表被查询的ArrayBuffer。
 * @param data ArrayBuffer的底层数据缓冲区。如果byte_length为0，则该值可能为NULL
 * 或任何其他指针值。
 * @param byteLength 底层数据缓冲区的字节长度。
 * @return 成功则返回JSVM_OK，失败可能返回JSVM_INVALID_ARG。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_GetArraybufferInfo(JSVM_Env env,
                                                   JSVM_Value arraybuffer,
                                                   void** data,
                                                   size_t* byteLength);

/**
 * @brief 返回对象的原型。
 *
 * @param env 调用JSVM-API的环境。
 * @param object 表示待返回其原型的JavaScript object。
 * 这将返回Object.getPrototypeOf的等价值（与函数的prototype属性不同）。
 * @param result 表示给定对象的原型。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_GetPrototype(JSVM_Env env,
                                             JSVM_Value object,
                                             JSVM_Value* result);

/**
 * @brief 返回类型化数组的各种属性。如果不需要该属性，则任何输出参数都可以是 NULL。
 *
 * @param env 调用JSVM-API的环境。
 * @param typedarray 表示要查询其属性的TypedArray。
 * @param type TypedArray中元素的标量数据类型。
 * @param length TypedArray中的元素数。
 * @param data TypedArray底层的数据缓冲区由byte_offset值调整，使其指向TypedArray
 * 中的第一个元素。如果数组的长度是0，这可能是NULL或任何其他指针值。
 * @param arraybuffer 位于TypedArray下的ArrayBuffer。
 * @param byteOffset 数组的第一个元素所在的基础原生数组中的字节偏移量。
 * data 参数的值已经过调整，因此data指向数组中的第一个元素。因此，
 * 原生数组的第一个字节将位于data - byte_offset。
 * @return 成功则返回JSVM_OK，失败可能返回JSVM_INVALID_ARG。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_GetTypedarrayInfo(JSVM_Env env,
                                                  JSVM_Value typedarray,
                                                  JSVM_TypedarrayType* type,
                                                  size_t* length,
                                                  void** data,
                                                  JSVM_Value* arraybuffer,
                                                  size_t* byteOffset);

/**
 * @brief 返回DataView的各种属性。
 * 如果不需要某一属性，则任何出参都可以设置为NULL。
 *
 * @param env 调用JSVM-API的环境。
 * @param dataview  表示要查询其属性的DataView。
 * @param bytelength DataView中的字节个数。
 * @param data DataView下的数据缓冲区。如果bytelength是0，
 * 则这可能是NULL或任何其他指针值。
 * @param arraybuffer ArrayBuffer是DataView的基础。
 * @param byteOffset 开始投影DataView的数据缓冲区中的字节偏移量。
 * @return 成功则返回JSVM_OK，失败可能返回JSVM_INVALID_ARG。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_GetDataviewInfo(JSVM_Env env,
                                                JSVM_Value dataview,
                                                size_t* bytelength,
                                                void** data,
                                                JSVM_Value* arraybuffer,
                                                size_t* byteOffset);

/**
 * @brief 返回给定JavaScript Date的时间值的C双精度基础类型。如果调用成功，返回JSVM_OK。
 * 如果传入一个非JavaScript Date类型的JSVM_Value，返回JSVM_DATA_EXPECTED。
 *
 * @param env 调用JSVM-API的环境。
 * @param value 代表一个JavaScript Date。
 * @param result 作为double的时间值表示为自1970年1月1日UTC午夜以来的毫秒数。
 * @return 成功则返回JSVM_OK，失败可能返回JSVM_DATE_EXPECTED。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_GetDateValue(JSVM_Env env,
                                             JSVM_Value value,
                                             double* result);

/**
 * @brief 返回给定JavaScript Boolean的C布尔基础类型等价值。
 *
 * @param env 调用JSVM-API的环境。
 * @param value 代表JavaScript Boolean。
 * @param result 给定JavaScript Boolean的C布尔基础类型等价值。
 * @return 成功则返回JSVM_OK。如果传入非布尔值的JSVM_Value，则返回JSVM_BOOLEAN_EXPECTED。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_GetValueBool(JSVM_Env env,
                                             JSVM_Value value,
                                             bool* result);

/**
 * @brief 返回给定JavaScript number的C双精度基础类型等价值。
 *
 * @param env 调用JSVM-API的环境。
 * @param value 代表JavaScript number。
 * @param result 给定的JavaScript number的C双精度基础类型等价值。
 * @return 成功则返回JSVM_OK。如果传入非数字的JSVM_Value，则返回JSVM_NUMBER_EXPECTED。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_GetValueDouble(JSVM_Env env,
                                               JSVM_Value value,
                                               double* result);

/**
 * @brief 返回给定JavaScript BigInt的C int64_t基础类型等价值。
 * 如果需要，它将截断该值，将lossless设置为false。
 *
 * @param env 调用JSVM-API的环境。
 * @param value 代表JavaScript BigInt。
 * @param result 给定的JavaScript BigInt的C int64_t基础类型等价值。
 * @param lossless 指示BigInt值是否已无损转换。
 * @return 成功则返回JSVM_OK。如果传入的值非BigInt，则返回JSVM_BIGINT_EXPECTED。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_GetValueBigintInt64(JSVM_Env env,
                                                    JSVM_Value value,
                                                    int64_t* result,
                                                    bool* lossless);

/**
 * @brief 返回给定JavaScript BigInt的C uint64_t基础类型等价值。
 * 如果需要，它将截断该值，将lossless设置为false。
 *
 * @param env 调用JSVM-API的环境。
 * @param value 代表JavaScript BigInt。
 * @param result 给定的JavaScript BigInt的C uint64_t基础类型等价值。
 * @param lossless 指示BigInt值是否已无损转换。
 * @return 成功则返回JSVM_OK。如果传入的值非BigInt，则返回JSVM_BIGINT_EXPECTED。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_GetValueBigintUint64(JSVM_Env env,
                                                     JSVM_Value value,
                                                     uint64_t* result,
                                                     bool* lossless);

/**
 * @brief 将单个BigInt值转换为符号位、64位小端数组和数组中的元素数。
 * signBit和words参数可以都设置为NULL。这种情况下，只获取wordCount。
 *
 * @param env 调用JSVM-API的环境。
 * @param value 代表JavaScript BigInt。
 * @param signBit 表示JavaScript BigInt是正数还是负数的整数。
 * @param wordCount 必须初始化为words数组的长度。返回后，将被设置为存储此BigInt所需的实际字数。
 * @param words 指向预分配的64位字数组的指针。
 * @return 成功则返回JSVM_OK，失败可能返回JSVM_BIGINT_EXPECTED。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_GetValueBigintWords(JSVM_Env env,
                                                    JSVM_Value value,
                                                    int* signBit,
                                                    size_t* wordCount,
                                                    uint64_t* words);

/**
 * @brief 检索之前传递给OH_JSVM_CreateExternal()的外部数据指针。
 *
 * @param env 调用JSVM-API的环境。
 * @param value 代表JavaScript外部值。
 * @param result 指向被JavaScript外部值封装的数据的指针。
 * @return 成功则返回JSVM_OK。如果传入非外部的JSVM_Value，则返回JSVM_INVALID_ARG。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_GetValueExternal(JSVM_Env env,
                                                 JSVM_Value value,
                                                 void** result);

/**
 * @brief 返回给定JavaScript number的C int32基础类型等价值。
 *
 * @param env 调用JSVM-API的环境。
 * @param value 代表JavaScript number。
 * @param result 给定的JavaScript number的C int32基础类型等价值。
 * @return 成功则返回JSVM_OK。如果传入非数字的JSVM_Value，则返回JSVM_NUMBER_EXPECTED。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_GetValueInt32(JSVM_Env env,
                                              JSVM_Value value,
                                              int32_t* result);

/**
 * @brief 返回给定JavaScript number的C int64基础类型等价值。
 *
 * @param env 调用JSVM-API的环境。
 * @param value 代表JavaScript number。
 * @param result 给定的JavaScript number的C int64基础类型等价值。
 * @return 成功则返回JSVM_OK。如果传入非数字的JSVM_Value，则返回JSVM_NUMBER_EXPECTED。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_GetValueInt64(JSVM_Env env,
                                              JSVM_Value value,
                                              int64_t* result);

/**
 * @brief  返回对应于传入值的ISO-8859-1编码字符串
 *
 * @param env 调用JSVM-API的环境。
 * @param value 代表JavaScript number。
 * @param buf 写入ISO-8859-1编码字符串的缓冲区。如果传入NULL，则将在result中返回
 * 字符串的长度（以字节为单位，不包括null结束符）。
 * @param bufsize 目的缓冲区大小。当大小不够时，返回的字符串将被截断并以null结尾。
 * @param result 复制到缓冲区中的字节数，不包括空终止符。
 * @return 成功则返回JSVM_OK。如果传入非string的JSVM_Value，则返回JSVM_STRING_EXPECTED。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_GetValueStringLatin1(JSVM_Env env,
                                                     JSVM_Value value,
                                                     char* buf,
                                                     size_t bufsize,
                                                     size_t* result);

/**
 * @brief 返回对应于传入值的UTF8编码字符串。
 *
 * @param env 调用JSVM-API的环境。
 * @param value 代表JavaScript字符串。
 * @param buf 将UTF8编码的字符串写入的缓冲区。如果传入NULL，则在result中
 * 返回以字节为单位的字符串长度，不包括空终止符。
 * @param bufsize 目标缓冲区的大小。当此值不足时，返回的字符串将被截断并以null终止。
 * @param result 复制到缓冲区的字节数，不包括null结束符。
 * @return 成功则返回JSVM_OK。如果传入非string的JSVM_Value，则返回JSVM_STRING_EXPECTED。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_GetValueStringUtf8(JSVM_Env env,
                                                   JSVM_Value value,
                                                   char* buf,
                                                   size_t bufsize,
                                                   size_t* result);

/**
 * @brief 基于传入的值，查询对应的采用UTF16编码的字符串。
 *
 * @param env 调用JSVM-API的环境。
 * @param value 代表JavaScript字符串。
 * @param buf 将UTF16-LE编码字符串写入的缓冲区。如果传入NULL，则返回字符串的
 * 2字节代码单元长度，不包括空终止符。
 * @param bufsize 目标缓冲区的大小。当此值不足时，返回的字符串将被截断并以null终止。
 * @param result 复制到缓冲区中的2字节代码单元数，不包括空终止符。
 * @return 成功则返回JSVM_OK。如果传入非string的JSVM_Value，则返回JSVM_STRING_EXPECTED。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_GetValueStringUtf16(JSVM_Env env,
                                                    JSVM_Value value,
                                                    char16_t* buf,
                                                    size_t bufsize,
                                                    size_t* result);

/**
 * @brief 返回给定JavaScript number的C uint_32基础类型等价值。
 *
 * @param env 调用JSVM-API的环境。
 * @param value 代表JavaScript number。
 * @param result 将给定的JSVM_Value等效为uint32_t 的C基础类型。
 * @return 成功则返回JSVM_OK。如果传入非数字的JSVM_Value，则返回JSVM_NUMBER_EXPECTED。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_GetValueUint32(JSVM_Env env,
                                               JSVM_Value value,
                                               uint32_t* result);

/**
 * @brief 返回用于表示给定布尔值的JavaScript单例对象。
 *
 * @param env 调用JSVM-API的环境。
 * @param value 要检索的布尔值。
 * @param result 表示待检索的JavaScript Boolean单例。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_GetBoolean(JSVM_Env env,
                                           bool value,
                                           JSVM_Value* result);

/**
 * @brief 返回global对象。
 *
 * @param env 调用JSVM-API的环境。
 * @param result 代表JavaScript global对象。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_GetGlobal(JSVM_Env env,
                                          JSVM_Value* result);

/**
 * @brief 返回null对象。
 *
 * @param env 调用JSVM-API的环境。
 * @param result 代表JavaScript null对象。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_GetNull(JSVM_Env env,
                                        JSVM_Value* result);

/**
 * @brief 返回Undefined对象。
 *
 * @param env 调用JSVM-API的环境。
 * @param value 代表JavaScript undefined值。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_GetUndefined(JSVM_Env env,
                                             JSVM_Value* result);

/**
 * @brief 实现抽象操作ToBoolean()。
 *
 * @param env 调用JSVM-API的环境。
 * @param value 要强制转换的JavaScript值。
 * @param result 代表强制的JavaScript Boolean。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_CoerceToBool(JSVM_Env env,
                                             JSVM_Value value,
                                             JSVM_Value* result);

/**
 * @brief 实现抽象操作ToNumber()。
 * 如果传入的值是对象，则函数可能会运行JavaScript代码。
 *
 * @param env 调用JSVM-API的环境。
 * @param value 要强制转换的JavaScript值。
 * @param result 代表强制的JavaScript number。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_CoerceToNumber(JSVM_Env env,
                                               JSVM_Value value,
                                               JSVM_Value* result);

/**
 * @brief 实现抽象操作ToObject()。
 *
 * @param env 调用JSVM-API的环境。
 * @param value 要强制转换的JavaScript值。
 * @param result 代表强制的JavaScript object。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_CoerceToObject(JSVM_Env env,
                                               JSVM_Value value,
                                               JSVM_Value* result);

/**
 * @brief 实现抽象操作ToString()。
 * 如果传入的值是对象，则函数可能会运行JavaScript代码。
 *
 * @param env 调用JSVM-API的环境。
 * @param value 要强制转换的JavaScript值。
 * @param result 代表强制的JavaScript string。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_CoerceToString(JSVM_Env env,
                                               JSVM_Value value,
                                               JSVM_Value* result);

/**
 * @brief 提供类似于在定义的对象上调用typeof运算符的行为。
 * 不同点在于，该函数支持检测外部值；它将null检测为单独的类型，
 * 而ECMAScript typeof将用于检测object。如果value的类型无效，则返回错误。
 *
 * @param env 调用JSVM-API的环境。
 * @param value 要查询其类型的JavaScript值。
 * @param result JavaScript值的类型。
 * @return 成功则返回JSVM_OK，失败可能返回JSVM_INVALID_ARG。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_Typeof(JSVM_Env env,
                                       JSVM_Value value,
                                       JSVM_ValueType* result);

/**
 * @brief 提供类似于在对象上调用instanceof运算符的行为。
 *
 * @param env 调用JSVM-API的环境。
 * @param value 要检查的JavaScript值。
 * @param constructor 要检查的构造函数的JavaScript函数对象
 * @param result 如果object instanceof constructor为true，则设置为true的布尔值。
 * @return 成功则返回JSVM_OK，失败可能返回JSVM_FUNCTION_EXPECTED或JSVM_GENERIC_FAILURE。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_Instanceof(JSVM_Env env,
                                           JSVM_Value object,
                                           JSVM_Value constructor,
                                           bool* result);

/**
 * @brief 提供类似于在对象上调用IsArray的行为。
 *
 * @param env 调用JSVM-API的环境。
 * @param value 待检查的JavaScript值。
 * @param result 表示给定的对象是否为数组。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_IsArray(JSVM_Env env,
                                        JSVM_Value value,
                                        bool* result);

/**
 * @brief 检查传入的对象是否为ArrayBuffer。
 *
 * @param env 调用JSVM-API的环境。
 * @param value 待检查的JavaScript值。
 * @param result 表示指定的对象是否为ArrayBuffer。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_IsArraybuffer(JSVM_Env env,
                                              JSVM_Value value,
                                              bool* result);

/**
 * @brief 检查传入的Object是否为日期。
 *
 * @param env 调用JSVM-API的环境。
 * @param value 待检查的JavaScript值。
 * @param isDate 给定的JSVM_Value是否表示JavaScript Date对象。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_IsDate(JSVM_Env env,
                                       JSVM_Value value,
                                       bool* isDate);

/**
 * @brief 检查传入的Object是否为类型化数组。
 *
 * @param env 调用JSVM-API的环境。
 * @param value 待检查的JavaScript值。
 * @param result 给定的JSVM_Value是否代表TypedArray。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_IsTypedarray(JSVM_Env env,
                                             JSVM_Value value,
                                             bool* result);

/**
 * @brief 检查传入的对象是否是DataView。
 *
 * @param env 调用JSVM-API的环境。
 * @param value 待检查的JavaScript值。
 * @param result 给定的JSVM_Value是否代表DataView。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_IsDataview(JSVM_Env env,
                                           JSVM_Value value,
                                           bool* result);

/**
 * @brief 提供类似调用严格相等算法的行为。
 *
 * @param env 调用JSVM-API的环境。
 * @param lhs 待检查的JavaScript值。
 * @param rhs 要检查的JavaScript值。
 * @param result 表示两个JSVM_Value对象是否相等。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_StrictEquals(JSVM_Env env,
                                             JSVM_Value lhs,
                                             JSVM_Value rhs,
                                             bool* result);

/**
 * @brief 提供类似于调用ArrayBuffer detach操作的行为。
 *
 * @param env 调用JSVM-API的环境。
 * @param arraybuffer 待分离的JavaScript ArrayBuffer。
 * @return 如果成功则返回JSVM_OK。如果传入的是不可拆解的ArrayBuffer，
 * 则返回JSVM_DETACHABLE_ARRAYBUFFER_EXPECTED。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_DetachArraybuffer(JSVM_Env env,
                                                  JSVM_Value arraybuffer);

/**
 * @brief 提供类似调用ArrayBuffer IsDetachedBuffer操作的行为。
 *
 * @param env 调用JSVM-API的环境。
 * @param value 待检查的JavaScript ArrayBuffer。
 * @param result 表示ArrayBuffer是否被分离。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_IsDetachedArraybuffer(JSVM_Env env,
                                                      JSVM_Value value,
                                                      bool* result);

/**
 * @brief 以字符数数组的形式返回object的可枚举属性的名称。
 * key为符号的object的属性将不会被包含在内。
 *
 * @param env 调用JSVM-API的环境。
 * @param object 待进行属性检索的对象。
 * @param result 表示一个JavaScript值的数组，这些值表示对象的属性名称。
 * 可以使用OH_JSVM_GetArrayLength以及OH_JSVM_GetElement对结果进行迭代。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_GetPropertyNames(JSVM_Env env,
                                                 JSVM_Value object,
                                                 JSVM_Value* result);

/**
 * @brief 返回一个数组，其中包含此对象的可用属性的名称。
 *
 * @param env 调用JSVM-API的环境。
 * @param object 从中检索属性的对象。
 * @param keyMode 是否也检索原型属性。
 * @param keyFilter 要检索哪些属性（可枚举/可读/可写）。
 * @param keyConversion 表示是否将编号的属性键转换为字符串。
 * @param result 表示JavaScript值的数组，这些值表示对象的属性名称。
 * 可以使用OH_JSVM_GetArrayLength和OH_JSVM_GetElement对结果进行迭代。
 * @return 成功则返回JSVM_OK，失败可能返回JSVM_INVALID_ARG或JSVM_GENERIC_FAILURE。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_GetAllPropertyNames(JSVM_Env env,
                                                    JSVM_Value object,
                                                    JSVM_KeyCollectionMode keyMode,
                                                    JSVM_KeyFilter keyFilter,
                                                    JSVM_KeyConversion keyConversion,
                                                    JSVM_Value* result);

/**
 * @brief 为传入的object设置一个属性。
 *
 * @param env 调用JSVM-API的环境。
 * @param object 将进行属性设置的对象。
 * @param key 待设置的属性名。
 * @param value 属性值。
 * @return 成功则返回JSVM_OK，失败可能返回JSVM_GENERIC_FAILURE。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_SetProperty(JSVM_Env env,
                                            JSVM_Value object,
                                            JSVM_Value key,
                                            JSVM_Value value);

/**
 * @brief 从传入的object中获取请求的属性。
 *
 * @param env 调用JSVM-API的环境。
 * @param object 从中检索属性的对象。
 * @param key 要检索的属性的名称。
 * @param result 属性值。
 * @return 成功则返回JSVM_OK，失败可能返回JSVM_GENERIC_FAILURE。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_GetProperty(JSVM_Env env,
                                            JSVM_Value object,
                                            JSVM_Value key,
                                            JSVM_Value* result);

/**
 * @brief 检查传入的Object是否具有指定命名的属性。
 *
 * @param env 调用JSVM-API的环境。
 * @param object 待查询的对象。
 * @param key 要检查其存在的属性的名称。
 * @param result 该属性是否存在于对象上。
 * @return 成功则返回JSVM_OK，可能返回JSVM_GENERIC_FAILURE。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_HasProperty(JSVM_Env env,
                                            JSVM_Value object,
                                            JSVM_Value key,
                                            bool* result);

/**
 * @brief  尝试从object中删除key自己的属性。
 *
 * @param env 调用JSVM-API的环境。
 * @param object 待查询的对象。
 * @param key 待删除的属性名。
 * @param result 表示属性删除是否成功。result可以选择性地通过传递NULL来忽略。
 * @return 成功则返回JSVM_OK，失败可能返回JSVM_GENERIC_FAILURE。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_DeleteProperty(JSVM_Env env,
                                               JSVM_Value object,
                                               JSVM_Value key,
                                               bool* result);

/**
 * @brief 检查传入的Object是否具有命名的自己的属性。key必须是string或symbol，
 * 否则将抛出错误。JSVM-API不会执行任何数据类型之间的转换。
 *
 * @param env 调用JSVM-API的环境。
 * @param object 待查询的对象。
 * @param key 要检查其存在的自有属性的名称。
 * @param result 表示对象上是否存在该自身属性。
 * @return 成功则返回JSVM_OK，失败可能返回JSVM_NAME_EXPECTED或JSVM_GENERIC_FAILURE。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_HasOwnProperty(JSVM_Env env,
                                               JSVM_Value object,
                                               JSVM_Value key,
                                               bool* result);

/**
 * @brief 此方法等效于调用OH_JSVM_SetProperty，
 * 其中，通过utf8Name传入的字符串用于创建JSVM_Value。
 *
 * @param env 调用JSVM-API的环境。
 * @param object 要对其设置属性的对象。
 * @param utf8Name 要设置的属性的名称。
 * @param value 属性值。
 * @return 成功则返回JSVM_OK，失败可能返回JSVM_GENERIC_FAILURE。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_SetNamedProperty(JSVM_Env env,
                                                 JSVM_Value object,
                                                 const char* utf8name,
                                                 JSVM_Value value);

/**
 * @brief 此方法等效于调用OH_JSVM_GetProperty，
 * 其中，通过utf8Name传入的字符串用于创建JSVM_Value。
 *
 * @param env 调用JSVM-API的环境。
 * @param object 从中检索属性的对象。
 * @param utf8Name 要获取的属性名。
 * @param result 属性值。
 * @return 成功则返回JSVM_OK，失败可能返回JSVM_GENERIC_FAILURE。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_GetNamedProperty(JSVM_Env env,
                                                 JSVM_Value object,
                                                 const char* utf8name,
                                                 JSVM_Value* result);

/**
 * @brief 此方法等效于使用从作为utf8Name传入的字符串创建的JSVM_Value
 * 调用OH_JSVM_HasProperty。
 *
 * @param env 调用JSVM-API的环境。
 * @param object 待查询的对象。
 * @param utf8Name 待检查的属性名。
 * @param result 该属性是否存在于对象上。
 * @return 成功则返回JSVM_OK，失败可能返回JSVM_GENERIC_FAILURE。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_HasNamedProperty(JSVM_Env env,
                                                 JSVM_Value object,
                                                 const char* utf8name,
                                                 bool* result);

/**
 * @brief 在传入的Object上设置一个元素。
 *
 * @param env 调用JSVM-API的环境。
 * @param object 待进行属性设置的对象。
 * @param index 要设置的属性的索引。
 * @param value 属性值。
 * @return 成功则返回JSVM_OK，失败可能返回JSVM_GENERIC_FAILURE。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_SetElement(JSVM_Env env,
                                           JSVM_Value object,
                                           uint32_t index,
                                           JSVM_Value value);

/**
 * @brief 获取请求索引处的元素。
 *
 * @param env 调用JSVM-API的环境。
 * @param object 待进行属性检索的对象。
 * @param index 要获取的属性的索引。
 * @param result 属性值。
 * @return 成功则返回JSVM_OK，失败可能返回JSVM_GENERIC_FAILURE。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_GetElement(JSVM_Env env,
                                           JSVM_Value object,
                                           uint32_t index,
                                           JSVM_Value* result);

/**
 * @brief 如果传入的Object在指定的索引处有一个元素，则此JSVM-API返回true。
 *
 * @param env 调用JSVM-API的环境。
 * @param object 待查询的对象。
 * @param index 待确定是否存在元素的索引位置。
 * @param result 该属性是否存在于对象上。
 * @return 成功则返回JSVM_OK，失败可能返回JSVM_GENERIC_FAILURE。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_HasElement(JSVM_Env env,
                                           JSVM_Value object,
                                           uint32_t index,
                                           bool* result);

/**
 * @brief 尝试从object中删除指定index处的元素。
 *
 * @param env 调用JSVM-API的环境。
 * @param object 待查询的对象。
 * @param index 要删除的属性的索引。
 * @param result 表示元素删除是否成功。
 * @return 成功则返回JSVM_OK，失败可能返回JSVM_GENERIC_FAILURE。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_DeleteElement(JSVM_Env env,
                                              JSVM_Value object,
                                              uint32_t index,
                                              bool* result);

/**
 * @brief 通过此方法可以在给定对象上高效定义多个属性，
 * 这些属性使用属性描述符进行定义。通过一个属性描述符的数组，
 * 此API将为对象依次设置数组中的属性。
 *
 * @param env 调用JSVM-API的环境。
 * @param object 待进行属性检索的对象。
 * @param propertyCount properties数组中的元素数。
 * @param properties 属性描述符的数组。
 * @return 成功则返回JSVM_OK，失败可能返回JSVM_INVALID_ARG或JSVM_GENERIC_FAILURE。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_DefineProperties(JSVM_Env env,
                                                 JSVM_Value object,
                                                 size_t propertyCount,
                                                 const JSVM_PropertyDescriptor* properties);

/**
 * @brief 冻结指定的对象。这样可以防止为其添加新的属性、删除现有属性、更改现有属性的
 * 可枚举性、可配置性或可写性、或者更改现有属性的值。它还可以防止改变对象的原型。
 *
 * @param env 调用JSVM-API的环境。
 * @param object 待冻结的对象。
 * @return 成功则返回JSVM_OK，失败可能返回JSVM_GENERIC_FAILURE。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_ObjectFreeze(JSVM_Env env,
                                             JSVM_Value object);

/**
 * @brief 封装指定的对象。这样可以防止为其添加新的属性并且将所有现有属性标记为不可配置。
 *
 * @param env 调用JSVM-API的环境。
 * @param object 待封装的对象。
 * @return 成功则返回JSVM_OK，失败可能返回JSVM_GENERIC_FAILURE。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_ObjectSeal(JSVM_Env env,
                                           JSVM_Value object);

/**
 * @brief 支持从native代码调用JavaScript函数对象，
 * 这是从native代码回调到JavaScript的主要机制。
 *
 * @param env 调用JSVM-API的环境。
 * @param recv 传递给被调用函数的this值。
 * @param func 表示将调用的JavaScript函数。
 * @param argc argv数组中的元素个数。
 * @param argv JSVM_values数组，表示将作为参数传递给函数的JavaScript值。
 * @param result 表示返回的JavaScript对象。
 * @return 成功则返回JSVM_OK，失败可能返回JSVM_PENDING_EXCEPTION或JSVM_GENERIC_FAILURE。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_CallFunction(JSVM_Env env,
                                             JSVM_Value recv,
                                             JSVM_Value func,
                                             size_t argc,
                                             const JSVM_Value* argv,
                                             JSVM_Value* result);

 /**
 * @brief 支持在native代码中创建函数对象，这是从JavaScript调用native代码的主要机制。
 * 在此调用之后，新创建的函数在脚本中不再自动可见。相反，必须在JavaScript可见的任何对象上显示设置属性，
 * 才能从脚本访问该函数。
 *
 * @param env 调用JSVM-API的环境。
 * @param utf8Name 编码为UTF8的函数的可选名称。这在JavaScript中是可见的，
 * 作为新函数对象的name属性。
 * @param length utf8name的长度（以字节为单位）或JSVM_AUTO_LENGTH（如果以 null 结尾）。
 * @param cb 调用此函数对象时应调用的native函数。详情请参考JSVM_Callback。
 * @param result 表示新创建函数的JavaScript函数对象。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_CreateFunction(JSVM_Env env,
                                               const char* utf8name,
                                               size_t length,
                                               JSVM_Callback cb,
                                               JSVM_Value* result);

 /**
 * @brief 此方法在回调函数中用于检索有关调用的详细信息，
 * 例如来自给定回调信息的参数和this指针。
 *
 * @param env 调用JSVM-API的环境。
 * @param cbinfo 传入回调函数的回调信息。
 * @param argc 指定所提供的argv数组的长度并接收参数的实际数量，
 * 可以通过传递NULL来选择性地忽略。
 * @param argv JSVM_Value的C数组，用于存储复制的参数。如果参数数量超过提供的数量，
 * 则只复制请求数量的参数。如果提供的参数比声明的少，则argv的其余部分将由代表undefined
 * 的JSVM_Value值填充。可以通过传递NULL来忽略argv。
 * @param thisArg 接收调用的JavaScript this参数。thisArg可以通过传递NULL来进行忽略。
 * @param data 接收回调的数据指针。data可以通过传递NULL来进行忽略。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_GetCbInfo(JSVM_Env env,
                                          JSVM_CallbackInfo cbinfo,
                                          size_t* argc,
                                          JSVM_Value* argv,
                                          JSVM_Value* thisArg,
                                          void** data);

/**
 * @brief 返回构造函数调用的new target。
 * 如果当前回调不是构造函数调用，结果为NULL。
 *
 * @param env 调用JSVM-API的环境。
 * @param cbinfo 传递给回调函数的回调信息。
 * @param result 构造函数调用的new target。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_GetNewTarget(JSVM_Env env,
                                             JSVM_CallbackInfo cbinfo,
                                             JSVM_Value* result);

/**
 * @brief 使用给定的JSVM_Value表示的构造函数来实例化新的JavaScript值。
 *
 * @param env 调用JSVM-API的环境。
 * @param constructor 表示将作为构造函数调用的JavaScript函数。
 * @param argc argv数组中的元素个数。
 * @param argv JavaScript值数组。其中JSVM_Value表示构造函数的参数。
 * 如果argc为零，则可以通过传入NULL来忽略此参数。
 * @param result 表示返回的JavaScript对象，
 * 在本例中是构造的对象。
 * @return 成功则返回JSVM_OK，失败可能返回JSVM_PENDING_EXCEPTION。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_NewInstance(JSVM_Env env,
                                            JSVM_Value constructor,
                                            size_t argc,
                                            const JSVM_Value* argv,
                                            JSVM_Value* result);

/**
 * @brief 定义一个JavaScript类。
 *
 * @param env 调用JSVM-API的环境。
 * @param utf8name JavaScript构造函数的名称，建议在包装C++类时使用C++类名。
 * @param length utf8name的长度（以字节为单位）或JSVM_AUTO_LENGTH（如果以 null 结尾）。
 * @param constructor 用于创建类的构造函数的回调函数。包装C++类时，此方法必须是符合JSVM_Callback。
 * callback签名的静态成员。不能使用C++类构造函数。详情请参考JSVM_Callback。
 * @param propertyCount properties数组参数中的项数。
 * @param properties 类的属性描述符，用于定义类的属性和方法。
 * @param result 表示类的构造函数的JSVM_Value。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_DefineClass(JSVM_Env env,
                                            const char* utf8name,
                                            size_t length,
                                            JSVM_Callback constructor,
                                            size_t propertyCount,
                                            const JSVM_PropertyDescriptor* properties,
                                            JSVM_Value* result);

/**
 * @brief 在JavaScript对象中封装native实例。native实例
 * 后续可以通过OH_JSVM_Unwrap()进行检索。
 *
 * @param env 调用JSVM-API的环境。
 * @param jsObject 将成为原生对象封装器的JavaScript对象。
 * @param nativeObject 将封装在JavaScript对象中的native实例。
 * @param finalizeCb 可选的原生回调，可用于在 JavaScript 对象被垃圾回收时释放native实例。
 * @param finalizeHint 传递给完成回调的可选上下文提示。
 * @param result 对封装对象的可选引用。
 * @return 成功则返回JSVM_OK，如果jsObject传入的不是一个对象，失败返回JSVM_INVALID_ARG。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_Wrap(JSVM_Env env,
                                     JSVM_Value jsObject,
                                     void* nativeObject,
                                     JSVM_Finalize finalizeCb,
                                     void* finalizeHint,
                                     JSVM_Ref* result);

/**
 * @brief 当JavaScript代码调用类的方法或属性访问器时，对应的JSVM_Callback将被调用。
 * 如果回调是针对实例方法或访问器的，则回调的this参数是封装器对象；然后可以通过调用
 * 封装器对象的OH_JSVM_Unwrap()获得作为调用目标的C++实例。
 *
 * @param env 调用JSVM-API的环境。
 * @param jsObject 与native实例关联的对象。
 * @param result 指向封装的native实例的指针。
 * @return 成功则返回JSVM_OK，如果jsObject传入的不是一个对象，失败返回JSVM_INVALID_ARG。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_Unwrap(JSVM_Env env,
                                       JSVM_Value jsObject,
                                       void** result);

/**
 * @brief 使用OH_JSVM_Wrap()检索先前封装在JavaScript对象js_object中的native实例并移除封装。
 * 如果finalize回调与封装相关联，则当JavaScript对象被垃圾回收时将不再调用它。
 *
 * @param env 调用JSVM-API的环境。
 * @param jsObject 与native实例关联的对象。
 * @param result 指向封装的native实例的指针。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_RemoveWrap(JSVM_Env env,
                                           JSVM_Value jsObject,
                                           void** result);

/**
 * @brief 将typeTag指针的值与JavaScript对象或外部值相关联。可调用OH_JSVM_CheckObjectTypeTag()
 * 判断附加在对象上的标记类型，以确保对象的类型正确。如果对象已经有关联的类型标记，则返回JSVM_INVALID_ARG。
 *
 * @param env 调用JSVM-API的环境。
 * @param value 要标记的JavaScript对象或外部值。
 * @param typeTag 要标记对象的标签。
 * @return 成功则返回JSVM_OK，失败可能返回JSVM_GENERIC_FAILURE或JSVM_INVALID_ARG。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_TypeTagObject(JSVM_Env env,
                                              JSVM_Value value,
                                              const JSVM_TypeTag* typeTag);

/**
 * @brief 将类型标签typeTag与JavaScript对象或外部值上的标签作对比。如果找到相同标签，
 * 设置result为true，否则为false。
 *
 * @param env 调用JSVM-API的环境。
 * @param value 待检查类型标记的JavaScript对象或外部值。
 * @param typeTag 用于比较在对象上找到的任何标签的标签。
 * @param result 表示指定的类型标记是否与对象上的类型标记匹配。如果在对象上找不到该类型标记，也会返回false。
 * @return 成功则返回JSVM_OK，失败可能返回JSVM_GENERIC_FAILURE。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_CheckObjectTypeTag(JSVM_Env env,
                                                   JSVM_Value value,
                                                   const JSVM_TypeTag* typeTag,
                                                   bool* result);

/**
 * @brief 为JavaScript对象添加JSVM_Finalize回调，当JavaScript对象被垃圾回收时调用该回调函数。
 * 可以在单个JavaScript对象上多次调用OH_JSVM_AddFinalizer。
 *
 * @param env 调用JSVM-API的环境。
 * @param jsObject 关联native数据的JavaScript对象。
 * @param finalizeData 要传递给finalizeCb的可选数据。
 * @param finalizeCb 当JavaScript对象被垃圾回收时，将用于释放native
 * 数据的原生回调。JSVM_Finalize提供了更多详细信息。
 * @param finalizeHint 传递给finalize回调的可选上下文提示。
 * @param result 可选的对JavaScript对象的引用。
 * @return 成功则返回JSVM_OK，失败可能返回JSVM_INVALID_ARG。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_AddFinalizer(JSVM_Env env,
                                             JSVM_Value jsObject,
                                             void* finalizeData,
                                             JSVM_Finalize finalizeCb,
                                             void* finalizeHint,
                                             JSVM_Ref* result);

/**
 * @brief 返回JSVM运行时支持的最高JSVM-API版本。
 * 后续将新增JSVM-API，以便支持更多的功能。引入该API的目的：在支持某功能的JSVM版本，
 * 可以使用新的功能；在不支持某功能的JSVM版本，可以提供回调行为。
 *
 * @param env 调用JSVM-API的环境。
 * @param result 支持的最高版本的JSVM-API。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_GetVersion(JSVM_Env env,
                                           uint32_t* result);

/**
 * @brief 返回虚拟机的信息。
 *
 * @param result 虚拟机的信息。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_GetVMInfo(JSVM_VMInfo* result);

/**
 * @brief 此函数将因JavaScript对象而保持活跃的外部分配的内存大小通知给底层虚拟机。
 * 注册外部分配的内存将比其他方式更频繁地触发全局垃圾回收。
 *
 * @param env 调用JSVM-API的环境。
 * @param changeInBytes 因JavaScript对象而保持活动状态的外部分配内存的变化。
 * @param result 调整值。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_AdjustExternalMemory(JSVM_Env env,
                                                     int64_t changeInBytes,
                                                     int64_t* result);

/**
 * @brief 通知虚拟机系统内存不足并有选择地触发垃圾回收。
 *
 * @param env 调用JSVM-API的环境。
 * @param level 要为当前虚拟机设置的内存压力等级。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_MemoryPressureNotification(JSVM_Env env,
                                                           JSVM_MemoryPressureLevel level);

/**
 * @brief 创建一个延迟对象和一个JavaScript promise。
 *
 * @param env 调用JSVM-API的环境。
 * @param deferred 一个新创建的延迟对象，后续可以传递给OH_JSVM_ResolveDeferred()或
 * OH_JSVM_RejectDeferred()以解析resp。或拒绝相关的Promise。
 * @param promise 与延迟对象关联的JavaScript Promise。
 * @return 成功则返回JSVM_OK，失败可能返回JSVM_GENERIC_FAILURE。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_CreatePromise(JSVM_Env env,
                                              JSVM_Deferred* deferred,
                                              JSVM_Value* promise);

/**
 * @brief 通过与之关联的延迟对象来解析JavaScript promise。
 * 它只能用于解析对应的可用的延迟对象的JavaScript Promise。
 * 这意味着Promise必须使用OH_JSVM_CreatePromise()创建，并且
 * 从该调用返回的对象必须保留，才能将其传递给此API。
 *
 * @param env 调用JSVM-API的环境。
 * @param deferred 要解析其关联promise的延迟对象。
 * @param resolution 用来解决Promise的值。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_ResolveDeferred(JSVM_Env env,
                                                JSVM_Deferred deferred,
                                                JSVM_Value resolution);

/**
 * @brief 通过与之关联的延迟对象来拒绝JavaScript Promise。
 * 它只能用于拒绝对应的可用延迟对象的JavaScript Promise。
 * 这意味着Promise必须使用OH_JSVM_CreatePromise()创建，并且
 * 从该调用返回的对象必须保留，才能将其传递给此API。
 *
 * @param env 调用JSVM-API的环境。
 * @param deferred 要解析其关联promise的延迟对象。
 * @param rejection 用来拒绝Promise的值。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_RejectDeferred(JSVM_Env env,
                                               JSVM_Deferred deferred,
                                               JSVM_Value rejection);

/**
 * @brief 查询Promise是否为原生Promise对象。
 * @param env 调用JSVM-API的环境。
 * @param value 待检查的值。
 * @param isPromise 表示是否为原生Promise对象（即底层引擎创建的promise对象）的标志。
 * @return 成功则返回JSVM_OK。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_IsPromise(JSVM_Env env,
                                          JSVM_Value value,
                                          bool* isPromise);

/**
 * @brief 解析JSON字符串，并返回成功解析的值。
 * @param env 调用JSVM-API的环境。
 * @param jsonString 待解析的字符串。
 * @param result 成功解析的值。
 * @return 成功则返回JSVM_OK，失败可能返回JSVM_STRING_EXPECTED或JSVM_GENERIC_FAILURE。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_JsonParse(JSVM_Env env,
                                          JSVM_Value jsonString,
                                          JSVM_Value* result);

/**
 * @brief 将对象字符串化，并返回成功转换后的字符串。
 * @param env 调用JSVM-API的环境。
 * @param jsonObject 待字符串化的对象。
 * @param result 成功转换后返回的字符串。
 * @return 成功则返回JSVM_OK，失败可能返回JSVM_GENERIC_FAILURE。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_JsonStringify(JSVM_Env env,
                                              JSVM_Value jsonObject,
                                              JSVM_Value* result);

/**
 * @brief 创建虚拟机的启动快照。
 * @param vm 目标环境，API接口将在该环境下调用。
 * @param contextCount 上下文个数。
 * @param contexts 要添加到快照的上下文数组。
 * @param blobData 快照数据。
 * @param blobSize 快照数据的大小。
 * @return 成功则返回JSVM_OK，失败可能返回JSVM_GENERIC_FAILURE。
 * @since 11
 */
JSVM_EXTERN JSVM_Status OH_JSVM_CreateSnapshot(JSVM_VM vm,
                                               size_t contextCount,
                                               const JSVM_Env* contexts,
                                               const char** blobData,
                                               size_t* blobSize);

EXTERN_C_END

/** @} */
#endif /* ARK_RUNTIME_JSVM_JSVM_H */