cxx-qt-build: return an Interface rather than taking as input

Author: ahayzen-kdab

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

@@ -104,7 +104,9 @@ impl Interface {
         self
     }
 
-    pub(crate) fn export(mut self) {
+    /// Export the manifest for this crate so that is can be used by downstream
+    /// crates or CMake
+    pub fn export(mut self) {
         self.write_exported_include_directories();
 
         // We automatically reexport all qt_modules and downstream dependencies

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

@@ -370,7 +370,6 @@ pub struct CxxQtBuilder {
     qt_modules: HashSet<String>,
     qml_modules: Vec<OwningQmlModule>,
     cc_builder: cc::Build,
-    public_interface: Option<Interface>,
     include_prefix: String,
 }
 
@@ -410,7 +409,6 @@ impl CxxQtBuilder {
             qt_modules,
             qml_modules: vec![],
             cc_builder: cc::Build::new(),
-            public_interface: None,
             include_prefix: crate_name(),
         }
     }
@@ -419,15 +417,12 @@ impl CxxQtBuilder {
     /// included by later dependencies.
     ///
     /// The headers generated for this crate will be specified
-    pub fn library(interface_definition: Interface) -> Self {
-        let mut this = Self::new();
-        this.public_interface = Some(interface_definition);
-
+    pub fn library() -> Self {
         if link_name().is_none() {
             panic!("Building a Cxx-Qt based library requires setting a `links` field in the Cargo.toml file.\nConsider adding:\n\tlinks = \"{}\"\nto your Cargo.toml\n", crate_name());
         }
 
-        this
+        Self::new()
     }
 
     /// Specify rust file paths to parse through the cxx-qt marco
@@ -1049,7 +1044,7 @@ extern "C" bool {init_fun}() {{
 
     /// Generate and compile cxx-qt C++ code, as well as compile any additional files from
     /// [CxxQtBuilder::qobject_header] and [CxxQtBuilder::cc_builder].
-    pub fn build(mut self) {
+    pub fn build(mut self) -> Interface {
         dir::clean(dir::crate_target()).expect("Failed to clean crate export directory!");
 
         // We will do these two steps first, as setting up the dependencies can modify flags we
@@ -1125,17 +1120,17 @@ extern "C" bool {init_fun}() {{
             self.cc_builder.compile(&static_lib_name());
         }
 
-        if let Some(mut interface) = self.public_interface {
-            interface.manifest = Manifest {
+        Interface {
+            manifest: Manifest {
                 name: crate_name(),
                 link_name: link_name()
                     .expect("The links key must be set when creating a library with CXX-Qt-build!"),
                 initializers: vec![public_initializer.strip_file()],
                 qt_modules: qt_modules.into_iter().collect(),
                 exported_include_prefixes: vec![],
-            };
-            interface.dependencies = dependencies;
-            interface.export();
+            },
+            dependencies,
+            ..Default::default()
         }
     }
 }

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

@@ -42,13 +42,7 @@ fn write_headers() {
 fn main() {
     write_headers();
 
-    let interface = cxx_qt_build::Interface::default()
-        // Disable exporting the standard include directory, as we are exporting custom headers
-        .export_include_prefixes([])
-        .export_include_directory(header_dir(), "cxx-qt-lib-extras")
-        .reexport_dependency("cxx-qt-lib");
-
-    let mut builder = CxxQtBuilder::library(interface)
+    let mut builder = CxxQtBuilder::library()
         .qt_module("Gui")
         .qt_module("Widgets");
 
@@ -80,7 +74,16 @@ fn main() {
     });
     println!("cargo::rerun-if-changed=src/assertion_utils.h");
 
-    // Use a short name due to the Windows file path limit!
-    // We don't re-export these headers anyway.
-    builder.include_prefix("private").build();
+    let interface = builder
+        // Use a short name due to the Windows file path limit!
+        // We don't re-export these headers anyway.
+        .include_prefix("private")
+        .build();
+
+    // Disable exporting the standard include directory, as we are exporting custom header
+    interface
+        .export_include_prefixes([])
+        .export_include_directory(header_dir(), "cxx-qt-lib-extras")
+        .reexport_dependency("cxx-qt-lib")
+        .export();
 }

crates/cxx-qt-lib/build.rs

@@ -346,12 +346,7 @@ fn main() {
         cpp_files.extend(["core/qdatetime", "core/qtimezone"]);
     }
 
-    let interface = cxx_qt_build::Interface::default()
-        .export_include_prefixes([])
-        .export_include_directory(header_dir(), "cxx-qt-lib")
-        .reexport_dependency("cxx-qt");
-
-    let mut builder = CxxQtBuilder::library(interface)
+    let mut builder = CxxQtBuilder::library()
         // Use a short name due to the Windows file path limit!
         // We don't re-export these headers anyway
         .include_prefix("private")
@@ -389,5 +384,11 @@ fn main() {
         cc.file("src/qt_types.cpp");
         println!("cargo::rerun-if-changed=src/qt_types.cpp");
     });
-    builder.build();
+
+    let interface = builder.build();
+    interface
+        .export_include_prefixes([])
+        .export_include_directory(header_dir(), "cxx-qt-lib")
+        .reexport_dependency("cxx-qt")
+        .export();
 }

crates/cxx-qt/build.rs

@@ -5,7 +5,7 @@
 
 use std::path::PathBuf;
 
-use cxx_qt_build::{CxxQtBuilder, Interface};
+use cxx_qt_build::CxxQtBuilder;
 
 fn header_dir() -> PathBuf {
     PathBuf::from(std::env::var("OUT_DIR").unwrap())
@@ -34,11 +34,7 @@ fn write_headers() {
 fn main() {
     write_headers();
 
-    let interface = Interface::default()
-        .export_include_prefixes([])
-        .export_include_directory(header_dir(), "cxx-qt");
-
-    let mut builder = CxxQtBuilder::library(interface);
+    let mut builder = CxxQtBuilder::library();
 
     let cpp_files = ["src/connection.cpp"];
     let rust_bridges = ["src/connection.rs", "src/qobject.rs"];
@@ -58,5 +54,9 @@ fn main() {
         ..qt_build_utils::Initializer::default_signature("init_cxx_qt_core")
     });
 
-    builder.build();
+    let interface = builder.build();
+    interface
+        .export_include_prefixes([])
+        .export_include_directory(header_dir(), "cxx-qt")
+        .export();
 }

examples/qml_multi_crates/rust/sub1/build.rs

@@ -3,16 +3,16 @@
 //
 // SPDX-License-Identifier: MIT OR Apache-2.0
 
-use cxx_qt_build::{CxxQtBuilder, Interface, QmlModule};
+use cxx_qt_build::{CxxQtBuilder, QmlModule};
 
 fn main() {
-    let interface = Interface::default();
-    CxxQtBuilder::library(interface)
+    CxxQtBuilder::library()
         .qt_module("Network")
         .qml_module(QmlModule::<_, &str> {
             uri: "com.kdab.cxx_qt.demo.sub1",
             rust_files: &["src/sub1_object.rs"],
             ..Default::default()
         })
-        .build();
+        .build()
+        .export();
 }

examples/qml_multi_crates/rust/sub2/build.rs

@@ -3,15 +3,15 @@
 //
 // SPDX-License-Identifier: MIT OR Apache-2.0
 
-use cxx_qt_build::{CxxQtBuilder, Interface, QmlModule};
+use cxx_qt_build::{CxxQtBuilder, QmlModule};
 
 fn main() {
-    let interface = Interface::default();
-    CxxQtBuilder::library(interface)
+    CxxQtBuilder::library()
         .qml_module(QmlModule::<_, &str> {
             uri: "com.kdab.cxx_qt.demo.sub2",
             rust_files: &["src/sub2_object.rs"],
             ..Default::default()
         })
-        .build();
+        .build()
+        .export();
 }