feat(ohos): export prop handle c interface in hippy.h

Author: etkmao

framework/examples/ohos-demo/src/main/cpp/CMakeLists.txt

@@ -18,6 +18,7 @@
 # limitations under the License.
 #
 
+# 示例一：
 # 对于需要源码依赖 Hippy c++ 代码的特别需求，需要做2点：
 # 1 集成 Hippy c++ 源码，生成使用方自己的 so，类似下面配置。
 # 2 Hippy 内部不再编译 hippy so，注释掉 Hippy/framework/ohos/src/main/cpp/CMakeLists.txt 里内容。
@@ -49,3 +50,20 @@ set(PUBLIC_SOURCE_SET
 target_sources(${PROJECT_NAME} PRIVATE ${SOURCE_SET} PUBLIC ${PUBLIC_SOURCE_SET})
 
 #]]
+
+
+# 示例二：
+# 下面是监听Hippy组件设置非内部属性的例子（外部判断是否自己关心的属性，用来处理上报等）：
+
+project(hippy_ex)
+cmake_minimum_required(VERSION 3.14)
+
+add_library(${PROJECT_NAME} SHARED)
+
+set(PUBLIC_SOURCE_SET
+  hippy_extend/src/example_external_prop_handler.cc
+  )
+target_sources(${PROJECT_NAME} PUBLIC ${PUBLIC_SOURCE_SET})
+
+find_package(hippy)
+target_link_libraries(${PROJECT_NAME} PUBLIC hippy::hippy libhilog_ndk.z.so)

framework/examples/ohos-demo/src/main/cpp/hippy_extend/src/example_external_prop_handler.cc

@@ -0,0 +1,81 @@
+/*
+ *
+ * Tencent is pleased to support the open source community by making
+ * Hippy available.
+ *
+ * Copyright (C) 2019 THL A29 Limited, a Tencent company.
+ * All rights reserved.
+ *
+ * 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.
+ *
+ */
+
+#include <hippy.h>
+#include <hr_any_data.h>
+#include <string>
+#include <hilog/log.h>
+
+#define LOG_DOMAIN 0x0020  // 自定义domain值（16进制）
+#define LOG_TAG "MyApp"    // 自定义TAG字符串
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+bool ExampleRenderViewOnSetProp(void *arkui_handle, const char *propKey, HRAnyData propValue) {
+  // 下面是示例代码：
+  std::string value;
+  if (HRAnyDataIsString(propValue)) {
+    value = HRAnyDataGetString(propValue);
+  } else if (HRAnyDataIsInt(propValue)) {
+    int32_t t = 0;
+    HRAnyDataGetInt(propValue, &t);
+    value = std::to_string(t);
+  } else if (HRAnyDataIsUint(propValue)) {
+    uint32_t t = 0;
+    HRAnyDataGetUint(propValue, &t);
+    value = std::to_string(t);
+  } else if (HRAnyDataIsDouble(propValue)) {
+    double t = 0;
+    HRAnyDataGetDouble(propValue, &t);
+    value = std::to_string(t);
+  } else if (HRAnyDataIsBool(propValue)) {
+    bool t = false;
+    HRAnyDataGetBool(propValue, &t);
+    value = std::to_string(t);
+  } else if (HRAnyDataIsArray(propValue)) {
+    int arraySize = 0;
+    HRAnyDataGetArraySize(propValue, &arraySize);
+    value = "size:" + std::to_string(arraySize);
+    if (arraySize > 0) {
+      HRAnyData elementValue = nullptr;
+      HRAnyDataGetArrayElement(propValue, &elementValue, 0);
+      bool isStr = HRAnyDataIsString(elementValue);
+      value += ",[0:";
+      value += std::to_string(isStr);
+      value += ",...]";
+    }
+  }
+  OH_LOG_INFO(LOG_APP, "hippy demo, on set prop, key: %{public}s, value: %{public}s", propKey, value.c_str());
+  return true;
+}
+
+#ifdef __cplusplus
+}
+#endif
+
+// 这里使用了全局函数的调用来注册prop handler，如果断点这里不执行，请检查对应so是否加载了
+auto RegisterHippyRenderViewPropHandlerOnLoad = []() {
+  HRRenderViewSetExternalPropHandler(ExampleRenderViewOnSetProp, nullptr);
+  return 0;
+}();

framework/examples/ohos-demo/src/main/cpp/hippy_extend/src/example_view_provider.cc

@@ -20,7 +20,7 @@
  *
  */
 
-#include "renderer/api/hippy_view_provider.h"
+#include "renderer/api_internal/hippy_view_provider.h"
 #include "../include/example_view_a.h"
 #include "../include/example_view_b.h"
 

framework/examples/ohos-demo/src/main/ets/entryability/EntryAbility.ets

@@ -27,6 +27,7 @@ import font from '@ohos.font';
 import { EngineInitParams } from 'hippy';
 import { BusinessError } from '@kit.BasicServicesKit';
 import fs from '@ohos.file.fs';
+import libHippyEx from 'libhippy_ex.so'
 
 export default class EntryAbility extends UIAbility {
   onCreate(want: Want, launchParam: AbilityConstant.LaunchParam) {
@@ -36,6 +37,8 @@ export default class EntryAbility extends UIAbility {
     AppStorage.setOrCreate("libHippy", libHippy)
     AppStorage.setOrCreate("abilityContext", this.context)
 
+    AppStorage.setOrCreate("libHippyEx", libHippyEx)
+
     let pageManagementItems:Object[] = []
     AppStorage.setOrCreate("pageManagementItems", pageManagementItems)
   }

framework/ohos/build-profile.json5

@@ -1,6 +1,9 @@
 {
   "apiType": "stageMode",
   "buildOption": {
+    "nativeLib": {
+      "headerPath": "./src/main/cpp/impl/renderer/native/include/renderer/api"
+    },
     "sourceOption": {
       "workers": [
         "./src/main/ets/support/workers/worker.ets",

framework/ohos/src/main/cpp/impl/renderer/native/CMakeLists.txt

@@ -149,7 +149,9 @@ set(PUBLIC_SOURCE_SET
   src/native_render_provider_capi.cc
   src/native_render_provider_napi.cc
   src/api/hippy_view_provider.cc
-  src/api_c/hippy.cc
+  src/api/hippy.cc
+  src/api/hr_any_data.cc
+  src/api_c/hippy_c.cc
   )
 target_sources(${PROJECT_NAME} PRIVATE ${SOURCE_SET} PUBLIC ${PUBLIC_SOURCE_SET})
 # endregion

framework/ohos/src/main/cpp/impl/renderer/native/include/renderer/api/hippy.h

@@ -0,0 +1,54 @@
+/*
+ *
+ * Tencent is pleased to support the open source community by making
+ * Hippy available.
+ *
+ * Copyright (C) 2019 THL A29 Limited, a Tencent company.
+ * All rights reserved.
+ *
+ * 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.
+ *
+ */
+
+#pragma once
+
+#include "hr_any_data.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * 自定义属性handler
+ * @param arkui_handle view对应的ohos capi的handle，类型为ArkUI_NodeHandle
+ * @param propKey 属性名称
+ * @param propValue 属性值
+ */
+typedef bool (*HRRenderViewOnSetProp)(void *arkui_handle, const char *propKey, HRAnyData propValue);
+
+/**
+ * 自定义属性重置handler
+ * @param arkui_handle view对应的ohos capi的handle，类型为ArkUI_NodeHandle
+ * @param propKey 属性名称
+ */
+typedef bool (*HRRenderViewOnResetProp)(void *arkui_handle, const char *propKey);
+
+/**
+ * 设置自定义属性handler
+ * @param handler
+ */
+void HRRenderViewSetExternalPropHandler(HRRenderViewOnSetProp set, HRRenderViewOnResetProp reset);
+
+#ifdef __cplusplus
+}
+#endif