cxx-qt-build: add ability to specify depends for QML module

Author: ahayzen-kdab

crates/cxx-qt-build/src/lib.rs

@@ -887,6 +887,7 @@ impl CxxQtBuilder {
                 &module_name_from_uri(&qml_module.uri),
                 &qml_module.qml_files,
                 &qml_module.qrc_files,
+                &qml_module.depends,
             );
             if let Some(qmltyperegistrar) = qml_module_registration_files.qmltyperegistrar {
                 cc_builder.file(qmltyperegistrar);

crates/cxx-qt-build/src/qml_modules.rs

@@ -31,6 +31,8 @@ where
     // and an empty slice is likely desired in most cases; most users probably don't
     // care about this field.
     pub qrc_files: &'a [A],
+    /// Dependencies of the QML module
+    pub depends: &'a [&'a str],
 }
 
 impl<A, B> Default for QmlModule<'_, A, B>
@@ -45,6 +47,7 @@ where
             version_minor: 0,
             qml_files: &[],
             qrc_files: &[],
+            depends: &[],
         }
     }
 }
@@ -58,6 +61,7 @@ pub(crate) struct OwningQmlModule {
     pub version_minor: usize,
     pub qml_files: Vec<PathBuf>,
     pub qrc_files: Vec<PathBuf>,
+    pub depends: Vec<String>,
 }
 
 fn collect_pathbuf_vec(asref: &[impl AsRef<Path>]) -> Vec<PathBuf> {
@@ -72,6 +76,11 @@ impl<A: AsRef<Path>, B: AsRef<Path>> From<QmlModule<'_, A, B>> for OwningQmlModu
             version_minor: other.version_minor,
             qml_files: collect_pathbuf_vec(other.qml_files),
             qrc_files: collect_pathbuf_vec(other.qrc_files),
+            depends: other
+                .depends
+                .into_iter()
+                .map(|depend| depend.to_string())
+                .collect(),
         }
     }
 }

crates/qt-build-utils/src/lib.rs

@@ -160,6 +160,7 @@ impl QtBuild {
         plugin_name: &str,
         qml_files: &[impl AsRef<Path>],
         qrc_files: &[impl AsRef<Path>],
+        depends: impl IntoIterator<Item = impl Into<String>>,
     ) -> QmlModuleRegistrationFiles {
         let qml_uri = QmlUri::new(uri.split('.'));
         let qml_uri_dirs = qml_uri.as_dirs();
@@ -181,6 +182,7 @@ impl QtBuild {
         {
             let mut file = File::create(&qmldir_file_path).expect("Could not create qmldir file");
             QmlDirBuilder::new(qml_uri.clone())
+                .depends(depends)
                 .plugin(plugin_name, true)
                 .class_name(&plugin_class_name)
                 .type_info(plugin_type_info)

examples/qml_features/qml/pages/MultipleQObjectsPage.qml

@@ -55,7 +55,6 @@ Page {
         }
 
         Label {
-            // TODO: QColor needs a dependency in qmldir on QtQuick
             color: root.first.color
             Layout.fillWidth: true
             horizontalAlignment: Text.AlignHCenter

examples/qml_features/rust/build.rs

@@ -28,6 +28,8 @@ fn main() {
                 "../qml/pages/ThreadingPage.qml",
                 "../qml/pages/TypesPage.qml",
             ],
+            // Need to depend on QtQuick for QColor to work with qmllint/qmlls
+            depends: &["QtQuick"],
             ..Default::default()
         })
         .files([