From 2a36ab2d7b492b8aecf54fea5fe0084e7edc8f2c Mon Sep 17 00:00:00 2001
From: Joshua Goins <joshua.goins@kdab.com>
Date: Mon, 9 Dec 2024 21:12:01 -0500
Subject: [PATCH] cxx-qt-lib: Add binding for
 QQmlApplicationEngine::addImageProvider

Upstreamed from the patch in #785, this adds a way to add image
providers written in Rust to the QML engine.
---
 CHANGELOG.md                                  |  1 +
 .../src/qml/qqmlapplicationengine.rs          | 31 +++++++++++++++++++
 2 files changed, 32 insertions(+)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 01c066438..01b360096 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -38,6 +38,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - QObject subclasses can now inherit from other CXX-Qt generated QObject classes
 - `BUILD_WASM` CMake option to support WebAssembly builds and a book page for building for WASM
 - Add support for cxx_name and rust_name on qproperty attributes which applies to the QProperty generated as well as functions
+- Add support for adding custom image providers for QML.
 
 ### Changed
 
diff --git a/crates/cxx-qt-lib/src/qml/qqmlapplicationengine.rs b/crates/cxx-qt-lib/src/qml/qqmlapplicationengine.rs
index 9e7b848a2..9fcdd093f 100644
--- a/crates/cxx-qt-lib/src/qml/qqmlapplicationengine.rs
+++ b/crates/cxx-qt-lib/src/qml/qqmlapplicationengine.rs
@@ -12,10 +12,20 @@ mod ffi {
         type QStringList = crate::QStringList;
         include!("cxx-qt-lib/qurl.h");
         type QUrl = crate::QUrl;
+        include!(<QQmlImageProviderBase>);
+        type QQmlImageProviderBase;
+        include!(<QtQuick/QQuickImageProvider>);
+        type QQuickImageProvider;
+        include!(<QtQuick/QQuickAsyncImageProvider>);
+        type QQuickAsyncImageProvider;
 
         include!("cxx-qt-lib/qqmlapplicationengine.h");
         type QQmlApplicationEngine;
 
+        #[doc(hidden)]
+        #[rust_name = "add_image_provider_internal"]
+        unsafe fn addImageProvider(self: Pin<&mut QQmlApplicationEngine>, provider_id: &QString, provider: *mut QQmlImageProviderBase);
+
         /// Adds path as a directory where the engine searches for installed modules in a URL-based directory structure.
         #[rust_name = "add_import_path"]
         fn addImportPath(self: Pin<&mut QQmlApplicationEngine>, path: &QString);
@@ -90,6 +100,14 @@ use crate::QQmlEngine;
 use core::pin::Pin;
 
 pub use ffi::QQmlApplicationEngine;
+use crate::QString;
+use ffi::QQmlImageProviderBase;
+
+#[allow(dead_code)]
+pub enum QQmlImageProviderBasePointer {
+    QQuickImageProvider(*mut ffi::QQuickImageProvider),
+    QQuickAsyncImageProvider(*mut ffi::QQuickAsyncImageProvider)
+}
 
 impl QQmlApplicationEngine {
     /// Convert the existing [QQmlApplicationEngine] to a [QQmlEngine]
@@ -101,4 +119,17 @@ impl QQmlApplicationEngine {
     pub fn new() -> cxx::UniquePtr<Self> {
         ffi::qqmlapplicationengine_new()
     }
+
+    /// Sets the provider to use for images requested via the image: url scheme, with host proveri_id. The QQmlEngine takes ownership of provider.
+    pub unsafe fn add_image_provider(self: Pin<&mut QQmlApplicationEngine>, provider_id: &QString, provider: QQmlImageProviderBasePointer) {
+        let ptr = match provider {
+            QQmlImageProviderBasePointer::QQuickAsyncImageProvider(ptr) => {
+                ptr as *mut QQmlImageProviderBase
+            },
+            QQmlImageProviderBasePointer::QQuickImageProvider(ptr) => {
+                ptr as *mut QQmlImageProviderBase
+            }
+        };
+        self.add_image_provider_internal(provider_id, ptr);
+    }
 }