qtbridge-runtime 0.1.3

// Copyright (C) 2026 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only


//! This module contains functions to import of artifacts the
//! [Qt Resource System](https://doc.qt.io/qt-6/resources.html).
//!
//! All artifacts must be compiled into dynamic resources with the
//! [`rcc` tool](https://doc.qt.io/qt-6/rcc.html):
//! ```bash, ignore
//! rcc -binary [more options] <inputs>
//! ```
//! before or at compile time.
//! The input for the `rcc` tool are Qt Resource Collection (*.qrc) files,
//! that contain lists of all files to be imported.
//! ```xml, ignore
//! <RCC>
//!     <qresource prefix="/">
//!         <file>images/copy.png</file>
//!         <file>images/cut.png</file>
//!         ...
//!     </qresource>
//! </RCC>
//! ```
//!
//! Dynamic resources can be registered with [`register_bytes`] and
//! are then available at runtime through the `qrc:/` scheme in QML:
//! ```qml, ignore
//! Image {
//!     source: "qrc:/images/copy.png"
//! }
//! ```
//!
//! We further provide the [`include_bytes_qml`] macro that generates the
//! required dynamic resource directly in Rust at compile time.
#[cxx::bridge]
mod ffi {
    unsafe extern "C++" {
        include!("cpp/qresource.h");

        fn register_resource(data: &[u8], resource_root: &str) -> bool;
    }
}

/// Registers Qt resource data from an in-memory byte slice.
///
/// This function registers a dynamic resource generated with `rcc`,
/// making the embedded resources available at runtime through the `qrc:/` scheme.
///
/// # Parameters
///
/// * `data` - A byte slice containing the compiled Qt resource data.
///
/// # Returns
///
/// Returns `true` if the resource was successfully registered, or `false`
/// if registration failed.
pub fn register_bytes(data: &[u8]) -> bool {
    ffi::register_resource(data, "")
}

/// Registers Qt resource data from an in-memory byte slice with a prefix.
///
/// This function registers a dynamic resource generated with `rcc`,
/// making the embedded resources available at runtime through the `qrc:/` scheme.
///
/// # Parameters
///
/// * `data` - A byte slice containing the compiled Qt resource data.
/// * `resource_root` - A string slice with the prefix under which the resources
///    are registered
///
/// # Returns
///
/// Returns `true` if the resource was successfully registered, or `false`
/// if registration failed.
pub fn register_bytes_with_prefix(data: &[u8], resource_root: &str) -> bool {
    ffi::register_resource(data, resource_root)
}