core: Add HarmonyOS platform

.bazelignore

@@ -4,6 +4,7 @@ bazel-out
 bazel-bin
 bazel-testlogs
 .cache
+.pixi
 .idea
 .vscode
 .cxx

.pre-commit-config.yaml

@@ -10,7 +10,7 @@ repos:
       - id: check-yaml
         args: [ --allow-multiple-documents, --unsafe ]
       - id: end-of-file-fixer
-        exclude: 'vendor/.*'
+        exclude: 'vendor/.*|platform/ohos/sample/(\.clangd|entry/oh-package-lock\.json5)$'
       - id: mixed-line-ending
         args: [ --fix=lf ]
         # these are generated by Gradle

CMakeLists.txt

@@ -35,6 +35,16 @@ endif()
 
 project("MapLibre Native" LANGUAGES CXX C)
 
+if(CMAKE_SYSTEM_NAME STREQUAL OHOS)
+    # The OHOS SDK toolchain injects --gcc-toolchain, which clang reports as unused.
+    # OHOS SDK 6.0.1 ships libc++ ranges algorithms behind -fexperimental-library.
+    add_compile_options(
+        $<$<COMPILE_LANGUAGE:C>:-Wno-unused-command-line-argument>
+        $<$<COMPILE_LANGUAGE:CXX>:-Wno-unused-command-line-argument>
+        $<$<COMPILE_LANGUAGE:CXX>:-fexperimental-library>
+    )
+endif()
+
 set_property(GLOBAL PROPERTY USE_FOLDERS ON)
 set_property(GLOBAL PROPERTY PREDEFINED_TARGETS_FOLDER MapLibre)
 
@@ -954,6 +964,7 @@ list(APPEND SRC_FILES
     ${PROJECT_SOURCE_DIR}/src/mbgl/util/quaternion.cpp
     ${PROJECT_SOURCE_DIR}/src/mbgl/util/rapidjson.cpp
     ${PROJECT_SOURCE_DIR}/src/mbgl/util/rapidjson.hpp
+    ${PROJECT_SOURCE_DIR}/src/mbgl/util/source_location.hpp
     ${PROJECT_SOURCE_DIR}/src/mbgl/util/std.hpp
     ${PROJECT_SOURCE_DIR}/src/mbgl/util/stopwatch.cpp
     ${PROJECT_SOURCE_DIR}/src/mbgl/util/stopwatch.hpp
@@ -1275,6 +1286,8 @@ elseif(CMAKE_SYSTEM_NAME STREQUAL Android)
     include(${PROJECT_SOURCE_DIR}/platform/android/android.cmake)
 elseif(CMAKE_SYSTEM_NAME STREQUAL Linux)
     include(${PROJECT_SOURCE_DIR}/platform/linux/linux.cmake)
+elseif(CMAKE_SYSTEM_NAME STREQUAL OHOS)
+    include(${PROJECT_SOURCE_DIR}/platform/ohos/ohos.cmake)
 elseif(CMAKE_SYSTEM_NAME STREQUAL Darwin)
     include(${PROJECT_SOURCE_DIR}/platform/darwin/darwin.cmake)
     include(${PROJECT_SOURCE_DIR}/platform/macos/macos.cmake)

CMakePresets.json

@@ -249,6 +249,57 @@
         "CMAKE_CXX_COMPILER_LAUNCHER": "ccache"
       }
     },
+    {
+      "name": "harmonyos",
+      "hidden": true,
+      "generator": "Ninja",
+      "binaryDir": "${sourceDir}/build-harmonyos",
+      "condition": {
+        "type": "allOf",
+        "conditions": [
+          {
+            "type": "notEquals",
+            "lhs": "$env{HMOS_SDK_NATIVE}",
+            "rhs": ""
+          },
+          {
+            "type": "notEquals",
+            "lhs": "$env{OHOS_SDK_NATIVE}",
+            "rhs": ""
+          }
+        ]
+      },
+      "cacheVariables": {
+        "CMAKE_TOOLCHAIN_FILE": "$env{HMOS_SDK_NATIVE}/build/cmake/hmos.toolchain.cmake",
+        "HMOS_SDK_NATIVE": "$env{HMOS_SDK_NATIVE}",
+        "OHOS_SDK_NATIVE": "$env{OHOS_SDK_NATIVE}",
+        "OHOS_ARCH": "arm64-v8a",
+        "OHOS_STL": "c++_shared",
+        "CMAKE_BUILD_TYPE": "RelWithDebInfo",
+        "MLN_WITH_GLFW": "OFF",
+        "MLN_WITH_OPENGL": "ON",
+        "MLN_WITH_EGL": "ON"
+      }
+    },
+    {
+      "name": "harmonyos-opengl",
+      "inherits": "harmonyos",
+      "binaryDir": "${sourceDir}/build-harmonyos-opengl",
+      "displayName": "HarmonyOS OpenGL",
+      "description": "HarmonyOS GLES/EGL and HMS RCP build"
+    },
+    {
+      "name": "harmonyos-vulkan",
+      "inherits": "harmonyos",
+      "binaryDir": "${sourceDir}/build-harmonyos-vulkan",
+      "displayName": "HarmonyOS Vulkan",
+      "description": "HarmonyOS Vulkan and HMS RCP build",
+      "cacheVariables": {
+        "MLN_WITH_OPENGL": "OFF",
+        "MLN_WITH_EGL": "OFF",
+        "MLN_WITH_VULKAN": "ON"
+      }
+    },
     {
       "name": "windows",
       "hidden": true,
@@ -377,6 +428,37 @@
       "configurePreset": "linux-vulkan",
       "targets": ["mbgl-core"]
     },
+    {
+      "name": "harmonyos-build",
+      "hidden": true,
+      "condition": {
+        "type": "allOf",
+        "conditions": [
+          {
+            "type": "notEquals",
+            "lhs": "$env{HMOS_SDK_NATIVE}",
+            "rhs": ""
+          },
+          {
+            "type": "notEquals",
+            "lhs": "$env{OHOS_SDK_NATIVE}",
+            "rhs": ""
+          }
+        ]
+      }
+    },
+    {
+      "name": "harmonyos-opengl",
+      "inherits": "harmonyos-build",
+      "configurePreset": "harmonyos-opengl",
+      "targets": ["mbgl-core"]
+    },
+    {
+      "name": "harmonyos-vulkan",
+      "inherits": "harmonyos-build",
+      "configurePreset": "harmonyos-vulkan",
+      "targets": ["mbgl-core"]
+    },
     {
       "name": "windows-opengl-core",
       "configurePreset": "windows-opengl",

bazel/core.bzl

@@ -586,6 +586,7 @@ MLN_CORE_SOURCE = [
     "src/mbgl/util/quaternion.hpp",
     "src/mbgl/util/rapidjson.cpp",
     "src/mbgl/util/rapidjson.hpp",
+    "src/mbgl/util/source_location.hpp",
     "src/mbgl/util/std.hpp",
     "src/mbgl/util/stopwatch.cpp",
     "src/mbgl/util/stopwatch.hpp",

include/mbgl/vulkan/renderer_backend.hpp

@@ -31,6 +31,11 @@ class ProgramParameters;
 
 namespace vulkan {
 
+using DynamicLoader = vk::detail::DynamicLoader;
+using DispatchLoaderDynamic = VULKAN_HPP_DISPATCH_LOADER_DYNAMIC_TYPE;
+template <typename OwnerType>
+using ObjectDestroy = vk::detail::ObjectDestroy<OwnerType, DispatchLoaderDynamic>;
+
 class RendererBackend : public gfx::RendererBackend {
 public:
     RendererBackend(gfx::ContextMode);
@@ -40,7 +45,7 @@ class RendererBackend : public gfx::RendererBackend {
     void initShaders(gfx::ShaderRegistry&, const ProgramParameters& programParameters) override;
     void init();
 
-    const vk::DispatchLoaderDynamic& getDispatcher() const { return dispatcher; }
+    const DispatchLoaderDynamic& getDispatcher() const { return dispatcher; }
     const vk::UniqueInstance& getInstance() const { return instance; }
     const vk::PhysicalDevice& getPhysicalDevice() const { return physicalDevice; }
     const vk::UniqueDevice& getDevice() const { return device; }
@@ -97,8 +102,8 @@ class RendererBackend : public gfx::RendererBackend {
     void destroyResources();
 
 protected:
-    vk::DynamicLoader dynamicLoader;
-    vk::DispatchLoaderDynamic dispatcher;
+    DynamicLoader dynamicLoader;
+    DispatchLoaderDynamic dispatcher;
 
     vk::UniqueInstance instance;
     vk::UniqueDebugUtilsMessengerEXT debugUtilsCallback;

platform/glfw/glfw_vulkan_backend.cpp

@@ -82,7 +82,6 @@ class VkContext {
             return device.get();
         }
 
-        const std::vector<const char*> layers = {"VK_LAYER_KHRONOS_validation"};
         const std::vector<const char*> extensions = {
             VK_KHR_SWAPCHAIN_EXTENSION_NAME,
 #ifdef __APPLE__
@@ -93,10 +92,8 @@ class VkContext {
         float queuePriority = 1.0f;
         vk::DeviceQueueCreateInfo queueCreateInfo(vk::DeviceQueueCreateFlags(), getQueueIndex(), 1, &queuePriority);
 
-        auto createInfo = vk::DeviceCreateInfo()
-                              .setQueueCreateInfos(queueCreateInfo)
-                              .setPEnabledExtensionNames(extensions)
-                              .setPEnabledLayerNames(layers);
+        auto createInfo =
+            vk::DeviceCreateInfo().setQueueCreateInfos(queueCreateInfo).setPEnabledExtensionNames(extensions);
 
         device = physicalDevice.createDeviceUnique(createInfo, nullptr, dispatcher);
         dispatcher.init(device.get());
@@ -107,8 +104,8 @@ class VkContext {
     uint32_t getQueueIndex() { return graphicsQueueIndex; }
 
 private:
-    vk::DynamicLoader dynamicLoader;
-    vk::DispatchLoaderDynamic dispatcher;
+    mbgl::vulkan::DynamicLoader dynamicLoader;
+    mbgl::vulkan::DispatchLoaderDynamic dispatcher;
 
     vk::UniqueInstance instance;
     vk::PhysicalDevice physicalDevice;
@@ -136,7 +133,7 @@ class GLFWVulkanRenderableResource final : public mbgl::vulkan::SurfaceRenderabl
         if (result != VK_SUCCESS) throw std::runtime_error("Failed to create glfw window surface");
 
         surface = vk::UniqueSurfaceKHR(surface_,
-                                       vk::ObjectDestroy<vk::Instance, vk::DispatchLoaderDynamic>(
+                                       mbgl::vulkan::ObjectDestroy<vk::Instance>(
                                            backendImpl.getInstance().get(), nullptr, backendImpl.getDispatcher()));
     }
 
@@ -190,7 +187,7 @@ void GLFWVulkanBackend::initInstance() {
 
     // this method is required to set `instance` to a valid vkInstance
     instance = vk::UniqueInstance(VkContext::shared().getInstance(),
-                                  vk::ObjectDestroy<vk::NoParent, vk::DispatchLoaderDynamic>(nullptr, dispatcher));
+                                  mbgl::vulkan::ObjectDestroy<vk::NoParent>(nullptr, dispatcher));
 
     // debug builds also require:
     // - enabling either `VK_EXT_debug_utils` (and updating `debugUtilsEnabled`) or `VK_EXT_debug_report` extension
@@ -207,7 +204,7 @@ void GLFWVulkanBackend::initDevice() {
 
     physicalDevice = VkContext::shared().getPhysicalDevice();
     device = vk::UniqueDevice(VkContext::shared().getDevice(),
-                              vk::ObjectDestroy<vk::NoParent, vk::DispatchLoaderDynamic>(nullptr, dispatcher));
+                              mbgl::vulkan::ObjectDestroy<vk::NoParent>(nullptr, dispatcher));
 
     graphicsQueueIndex = presentQueueIndex = VkContext::shared().getQueueIndex();
     physicalDeviceFeatures = vk::PhysicalDeviceFeatures();

platform/linux/src/gl_functions.cpp

@@ -3,7 +3,6 @@
 #define GL_GLEXT_PROTOTYPES
 
 #include <GLES3/gl3.h>
-#include <GLES3/gl3ext.h>
 
 namespace mbgl {
 namespace platform {

platform/ohos/README.md

@@ -0,0 +1,33 @@
+# HarmonyOS
+
+This platform support is experimental. It targets the HarmonyOS native SDK, not
+yet OpenHarmony.
+
+Public OpenHarmony platform documentation is available in the
+[OpenHarmony docs repository](https://github.com/openharmony/docs).
+
+See [the sample readme](./sample/README.md) to build and run the NAPI/XComponent
+integration example in DevEco Studio.
+
+## CMake Build
+
+When invoking CMake directly from this repository root, set the native SDK paths
+before using the HarmonyOS presets:
+
+```sh
+export HMOS_SDK_NATIVE=/path/to/hms/native
+export OHOS_SDK_NATIVE=/path/to/openharmony/native
+
+cmake --preset harmonyos-opengl
+cmake --build --preset harmonyos-opengl
+
+cmake --preset harmonyos-vulkan
+cmake --build --preset harmonyos-vulkan
+```
+
+The HarmonyOS toolchain wraps the OHOS base toolchain, so both
+`HMOS_SDK_NATIVE` and `OHOS_SDK_NATIVE` are required. The presets are disabled
+until both variables are set.
+
+DevEco Studio and Hvigor provide these paths from the configured HarmonyOS SDK
+when building `platform/ohos/sample`.