From 91bbd74648591b9ed6c6a99b6cda6c9eb74f99ce Mon Sep 17 00:00:00 2001
From: chenraozhong <chenraozhong1@huawei.com>
Date: Fri, 15 Nov 2024 09:44:50 +0800
Subject: [PATCH] Add OH_JSVM_DefineClassWithOptoins

Signed-off-by: chenraozhong <chenraozhong1@huawei.com>
---
 ark_runtime/jsvm/jsvm.h           | 40 +++++++++++++++++++++++++++
 ark_runtime/jsvm/jsvm_types.h     | 45 +++++++++++++++++++++++++++++++
 ark_runtime/jsvm/libjsvm.ndk.json |  4 +++
 3 files changed, 89 insertions(+)

diff --git a/ark_runtime/jsvm/jsvm.h b/ark_runtime/jsvm/jsvm.h
index 88d4d4010..024a009ae 100644
--- a/ark_runtime/jsvm/jsvm.h
+++ b/ark_runtime/jsvm/jsvm.h
@@ -3386,6 +3386,46 @@ JSVM_EXTERN JSVM_Status OH_JSVM_TraceStart(size_t count, const JSVM_TraceCategor
  * @since 16
  */
 JSVM_EXTERN JSVM_Status OH_JSVM_TraceStop(JSVM_OutputStream stream, void* streamData);
+
+/**
+ * @brief When wrapping a C++ class, the C++ constructor callback passed via constructor
+ * should be a static method on the class that calls the actual class constructor, then
+ * wraps the new C++ instance in a JavaScript object according to the different Options
+ * passed in, and returns the wrapper object.
+ *
+ * @param env The environment that the API is invoked under.
+ * @param utf8name Name of the JavaScript constructor function. For clarity, it is
+ * recommended to use the C++ class name when wrapping a C++ class.
+ * @param length The length of the utf8name in bytes, or JSVM_AUTO_LENGTH if it
+ * is null-terminated.
+ * @param constructor Struct include callback function that handles constructing instances of the class.
+ * When wrapping a C++ class, this method must be a static member with the JSVM_Callback.callback
+ * signature. A C++ class constructor cannot be used.
+ * Include Optional data to be passed to the constructor callback as the data
+ * property of the callback info. JSVM_Callback provides more details.
+ * @param propertyCount Number of items in the properties array argument.
+ * @param properties Array of property descriptors describing static and instance data
+ * properties, accessors, and methods on the class See JSVM_PropertyDescriptor.
+ * @param parentClass The parent-class of the currently defined class.
+ * @param option_count Number of items in an option array argument.
+ * @param options DefineClass options to be passed.
+ * @param result A JSVM_Value representing the constructor function for the class.
+ * @return Returns JSVM functions result code.
+ *         {@link JSVM_OK } if the function executed successfully. \n
+ *         {@link JSVM_INVALID_ARG } if any of the pointer arguments is NULL. \n
+ *         {@link JSVM_GENERIC_FAILURE} if the input utf8name | constructor | properties is invalid. \n
+ * @since 16
+ */
+JSVM_EXTERN JSVM_Status OH_JSVM_DefineClassWithOptions(JSVM_Env env,
+                                                       const char* utf8name,
+                                                       size_t length,
+                                                       JSVM_Callback constructor,
+                                                       size_t propertyCount,
+                                                       const JSVM_PropertyDescriptor* properties,
+                                                       JSVM_Value parentClass,
+                                                       size_t option_count,
+                                                       JSVM_DefineClassOptions options[],
+                                                       JSVM_Value* result);
 EXTERN_C_END
 /** @} */
 #endif /* ARK_RUNTIME_JSVM_JSVM_H */
diff --git a/ark_runtime/jsvm/jsvm_types.h b/ark_runtime/jsvm/jsvm_types.h
index d61367a4b..5df9be08f 100644
--- a/ark_runtime/jsvm/jsvm_types.h
+++ b/ark_runtime/jsvm/jsvm_types.h
@@ -810,5 +810,50 @@ typedef enum {
     /** Tracing more detailed interface invoking of WASM, such as background compilation and wrappers. */
     JSVM_TRACE_WASM_DETAILED
 } JSVM_TraceCategory;
+
+/**
+ * @brief DefineClass options id.
+ *
+ * @since 16
+ */
+typedef enum {
+    /** Defining a class in normal mode. */
+    JSVM_DEFINE_CLASS_NORMAL,
+    /** Defining a class with count. */
+    JSVM_DEFINE_CLASS_WITH_COUNT,
+    /** Defining a class with property handler. */
+    JSVM_DEFINE_CLASS_WITH_PROPERTY_HANDLER,
+} JSVM_DefineClassOptionsId;
+
+/**
+ * @brief DefineClass options.
+ *
+ * @since 16
+ */
+typedef struct {
+    /** DefineClass option id. */
+    JSVM_DefineClassOptionsId id;
+    /** option content. */
+    union {
+        /** for option value with pointer type. */
+        void* ptr;
+        /** for option value with integer type  */
+        int num;
+        /** for option value with bool type */
+        bool boolean;
+    } content;
+} JSVM_DefineClassOptions;
+
+/**
+ * @brief The property-handler used to define class.
+ *
+ * @since 16
+ */
+typedef struct {
+  /** The instance object triggers the corresponding callback function. */
+  JSVM_PropertyHandlerCfg propertyHandlerCfg;
+  /** Calling an instance object as a function will trigger this callback. */
+  JSVM_Callback callAsFunctionCallback;
+} JSVM_PropertyHandler;
 /** @} */
 #endif /* ARK_RUNTIME_JSVM_JSVM_TYPE_H */
diff --git a/ark_runtime/jsvm/libjsvm.ndk.json b/ark_runtime/jsvm/libjsvm.ndk.json
index a21c03271..235fddc61 100644
--- a/ark_runtime/jsvm/libjsvm.ndk.json
+++ b/ark_runtime/jsvm/libjsvm.ndk.json
@@ -826,5 +826,9 @@
     {
         "first_introduced": "16",
         "name": "OH_JSVM_TraceStop"
+    },
+    {
+        "first_introduced": "16",
+        "name": "OH_JSVM_DefineClassWithOptions"
     }
 ]
-- 
Gitee