Improve windows-bindgen dependency targeting consistency and flexibility (#3763)

Author: kennykerr

.github/workflows/clippy.yml

@@ -216,6 +216,8 @@ jobs:
         run:  cargo clippy -p test_interface_core --tests
       - name: Check test_interop
         run:  cargo clippy -p test_interop --tests
+      - name: Check test_just_core
+        run:  cargo clippy -p test_just_core --tests
       - name: Check test_lib
         run:  cargo clippy -p test_lib --tests
       - name: Check test_link
@@ -232,6 +234,8 @@ jobs:
         run:  cargo clippy -p test_metadata --tests
       - name: Check test_msrv
         run:  cargo clippy -p test_msrv --tests
+      - name: Check test_no_core
+        run:  cargo clippy -p test_no_core --tests
       - name: Check test_no_std
         run:  cargo clippy -p test_no_std --tests
       - name: Check test_no_use

.github/workflows/test.yml

@@ -245,6 +245,8 @@ jobs:
         run:  cargo test -p test_interface_core --target ${{ matrix.target }}
       - name: Test test_interop
         run:  cargo test -p test_interop --target ${{ matrix.target }}
+      - name: Test test_just_core
+        run:  cargo test -p test_just_core --target ${{ matrix.target }}
       - name: Test test_lib
         run:  cargo test -p test_lib --target ${{ matrix.target }}
       - name: Test test_link
@@ -257,12 +259,14 @@ jobs:
         run:  cargo test -p test_marshal --target ${{ matrix.target }}
       - name: Test test_match
         run:  cargo test -p test_match --target ${{ matrix.target }}
-      - name: Test test_metadata
-        run:  cargo test -p test_metadata --target ${{ matrix.target }}
       - name: Clean
         run:  cargo clean
+      - name: Test test_metadata
+        run:  cargo test -p test_metadata --target ${{ matrix.target }}
       - name: Test test_msrv
         run:  cargo test -p test_msrv --target ${{ matrix.target }}
+      - name: Test test_no_core
+        run:  cargo test -p test_no_core --target ${{ matrix.target }}
       - name: Test test_no_std
         run:  cargo test -p test_no_std --target ${{ matrix.target }}
       - name: Test test_no_use
@@ -357,12 +361,12 @@ jobs:
         run:  cargo test -p tool_bindings --target ${{ matrix.target }}
       - name: Test tool_gnu
         run:  cargo test -p tool_gnu --target ${{ matrix.target }}
+      - name: Clean
+        run:  cargo clean
       - name: Test tool_license
         run:  cargo test -p tool_license --target ${{ matrix.target }}
       - name: Test tool_merge
         run:  cargo test -p tool_merge --target ${{ matrix.target }}
-      - name: Clean
-        run:  cargo clean
       - name: Test tool_msvc
         run:  cargo test -p tool_msvc --target ${{ matrix.target }}
       - name: Test tool_standalone

crates/libs/bindgen/src/config/mod.rs

@@ -21,6 +21,7 @@ pub struct Config<'a> {
     pub rustfmt: &'a str,
     pub sys: bool,
     pub implement: bool,
+    pub specific_deps: bool,
     pub derive: &'a Derive,
     pub link: &'a str,
     pub warnings: &'a WarningBuilder,

crates/libs/bindgen/src/config/names.rs

@@ -2,6 +2,18 @@ use super::*;
 
 impl Config<'_> {
     pub fn write_core(&self) -> TokenStream {
+        self.write_specific("windows_core")
+    }
+
+    pub fn write_result(&self) -> TokenStream {
+        self.write_specific("windows_result")
+    }
+
+    pub fn write_strings(&self) -> TokenStream {
+        self.write_specific("windows_strings")
+    }
+
+    fn write_specific(&self, specific: &str) -> TokenStream {
         if self.sys {
             if self.package || !self.no_deps {
                 quote! { windows_sys::core:: }
@@ -16,8 +28,10 @@ impl Config<'_> {
 
                 tokens
             }
-        } else {
+        } else if !self.specific_deps {
             quote! { windows_core:: }
+        } else {
+            format!("{specific}::").into()
         }
     }
 

crates/libs/bindgen/src/lib.rs

@@ -274,10 +274,11 @@ where
     let mut no_toml = false;
     let mut package = false;
     let mut implement = false;
+    let mut specific_deps = false;
     let mut rustfmt = String::new();
     let mut output = String::new();
     let mut sys = false;
-    let mut link = "windows_link".to_string();
+    let mut link = String::new();
     let mut index = false;
 
     for arg in &args {
@@ -301,6 +302,7 @@ where
                 "--package" => package = true,
                 "--sys" => sys = true,
                 "--implement" => implement = true,
+                "--specific-deps" => specific_deps = true,
                 "--link" => kind = ArgKind::Link,
                 "--index" => index = true,
                 _ => panic!("invalid option `{arg}`"),
@@ -331,6 +333,14 @@ where
         }
     }
 
+    if link.is_empty() {
+        if sys || specific_deps {
+            link = "windows_link".to_string();
+        } else {
+            link = "windows_core".to_string();
+        }
+    }
+
     if package && flat {
         panic!("cannot combine `--package` and `--flat`");
     }
@@ -389,6 +399,7 @@ where
         output: &output,
         sys,
         implement,
+        specific_deps,
         link: &link,
         warnings: &warnings,
         namespace: "",

crates/libs/bindgen/src/types/class.rs

@@ -65,14 +65,16 @@ impl Class {
             }
         }
 
+        let result = config.write_result();
+
         let new = self.has_default_constructor().then(||
             quote! {
-                pub fn new() -> windows_core::Result<Self> {
+                pub fn new() -> #result Result<Self> {
                     Self::IActivationFactory(|f| f.ActivateInstance::<Self>())
                 }
-                fn IActivationFactory<R, F: FnOnce(&windows_core::imp::IGenericFactory) -> windows_core::Result<R>>(
+                fn IActivationFactory<R, F: FnOnce(&windows_core::imp::IGenericFactory) -> #result Result<R>>(
                     callback: F,
-                ) -> windows_core::Result<R> {
+                ) -> #result Result<R> {
                     static SHARED: windows_core::imp::FactoryCache<#name, windows_core::imp::IGenericFactory> =
                         windows_core::imp::FactoryCache::new();
                     SHARED.call(callback)
@@ -96,9 +98,9 @@ impl Class {
 
                         Some(quote! {
                             #cfg
-                            fn #method_name<R, F: FnOnce(&#interface_type) -> windows_core::Result<R>>(
+                            fn #method_name<R, F: FnOnce(&#interface_type) -> #result Result<R>>(
                                 callback: F,
-                            ) -> windows_core::Result<R> {
+                            ) -> #result Result<R> {
                                 static SHARED: windows_core::imp::FactoryCache<#name, #interface_type> =
                                     windows_core::imp::FactoryCache::new();
                                 SHARED.call(callback)

crates/libs/bindgen/src/types/cpp_const.rs

@@ -50,7 +50,7 @@ impl CppConst {
 
             if field_ty == constant_ty {
                 if field_ty == Type::String {
-                    let crate_name = config.write_core();
+                    let crate_name = config.write_strings();
                     let value = constant.value().write();
 
                     // TODO: if config.no_core then write these literals out as byte strings?

crates/libs/bindgen/src/types/cpp_fn.rs

@@ -90,6 +90,7 @@ impl CppFn {
         let params = method.write_params(config);
         let generics = method.write_generics();
         let abi_return_type = method.write_return(config);
+        let result = config.write_result();
 
         let wrapper = match method.return_hint {
             ReturnHint::Query(..) => {
@@ -98,7 +99,7 @@ impl CppFn {
                 quote! {
                     #cfg
                     #[inline]
-                    pub unsafe fn #name<#generics T>(#params) -> windows_core::Result<T> #where_clause {
+                    pub unsafe fn #name<#generics T>(#params) -> #result Result<T> #where_clause {
                         #link
                         let mut result__ = core::ptr::null_mut();
                         unsafe { #name(#args).and_then(||windows_core::Type::from_abi(result__)) }
@@ -111,7 +112,7 @@ impl CppFn {
                 quote! {
                     #cfg
                     #[inline]
-                    pub unsafe fn #name<#generics T>(#params result__: *mut Option<T>) -> windows_core::Result<()> #where_clause {
+                    pub unsafe fn #name<#generics T>(#params result__: *mut Option<T>) -> #result Result<()> #where_clause {
                         #link
                         unsafe { #name(#args).ok() }
                     }
@@ -126,7 +127,7 @@ impl CppFn {
                 quote! {
                     #cfg
                     #[inline]
-                    pub unsafe fn #name<#generics>(#params) -> windows_core::Result<#return_type> #where_clause {
+                    pub unsafe fn #name<#generics>(#params) -> #result Result<#return_type> #where_clause {
                         #link
                         unsafe {
                             let mut result__ = core::mem::zeroed();
@@ -141,7 +142,7 @@ impl CppFn {
                 quote! {
                     #cfg
                     #[inline]
-                    pub unsafe fn #name<#generics>(#params) -> windows_core::Result<()> #where_clause {
+                    pub unsafe fn #name<#generics>(#params) -> #result Result<()> #where_clause {
                         #link
                         unsafe { #name(#args).ok() }
                     }
@@ -159,7 +160,7 @@ impl CppFn {
                     quote! {
                         #cfg
                         #[inline]
-                        pub unsafe fn #name<#generics>(#params) -> windows_core::Result<#return_type> #where_clause {
+                        pub unsafe fn #name<#generics>(#params) -> #result Result<#return_type> #where_clause {
                             #link
                             unsafe {
                                 let mut result__ = core::mem::zeroed();
@@ -201,7 +202,7 @@ impl CppFn {
                     quote! {
                         #cfg
                         #[inline]
-                        pub unsafe fn #name<#generics>(#params) -> windows_core::Result<#return_type> #where_clause {
+                        pub unsafe fn #name<#generics>(#params) -> #result Result<#return_type> #where_clause {
                             #link
                             let result__ = unsafe { #name(#args) };
                             (!result__.is_invalid()).then_some(result__).ok_or_else(windows_core::Error::from_thread)

crates/libs/bindgen/src/types/cpp_method.rs

@@ -262,13 +262,14 @@ impl CppMethod {
         let params = self.write_params(config);
         let generics = self.write_generics();
         let abi_return_type = self.write_return(config);
+        let result = config.write_result();
 
         match self.return_hint {
             ReturnHint::Query(..) => {
                 let where_clause = self.write_where(config, true);
 
                 quote! {
-                    pub unsafe fn #name<#generics T>(&self, #params) -> windows_core::Result<T> #where_clause {
+                    pub unsafe fn #name<#generics T>(&self, #params) -> #result Result<T> #where_clause {
                         let mut result__ = core::ptr::null_mut();
                         unsafe { (windows_core::Interface::vtable(self).#vname)(windows_core::Interface::as_raw(self),#args).and_then(||windows_core::Type::from_abi(result__)) }
                     }
@@ -278,7 +279,7 @@ impl CppMethod {
                 let where_clause = self.write_where(config, true);
 
                 quote! {
-                    pub unsafe fn #name<#generics T>(&self, #params result__: *mut Option<T>) -> windows_core::Result<()> #where_clause {
+                    pub unsafe fn #name<#generics T>(&self, #params result__: *mut Option<T>) -> #result Result<()> #where_clause {
                         unsafe { (windows_core::Interface::vtable(self).#vname)(windows_core::Interface::as_raw(self),#args).ok() }
                     }
                 }
@@ -292,7 +293,7 @@ impl CppMethod {
                 let return_type = return_type.write_name(config);
 
                 quote! {
-                    pub unsafe fn #name<#generics>(&self, #params) -> windows_core::Result<#return_type> #where_clause {
+                    pub unsafe fn #name<#generics>(&self, #params) -> #result Result<#return_type> #where_clause {
                         unsafe {
                             let mut result__ = core::mem::zeroed();
                             (windows_core::Interface::vtable(self).#vname)(windows_core::Interface::as_raw(self),#args).#map
@@ -304,7 +305,7 @@ impl CppMethod {
                 let where_clause = self.write_where(config, false);
 
                 quote! {
-                    pub unsafe fn #name<#generics>(&self, #params) -> windows_core::Result<()> #where_clause {
+                    pub unsafe fn #name<#generics>(&self, #params) -> #result Result<()> #where_clause {
                         unsafe { (windows_core::Interface::vtable(self).#vname)(windows_core::Interface::as_raw(self),#args).ok() }
                     }
                 }
@@ -318,7 +319,7 @@ impl CppMethod {
                     let return_type = return_type.write_name(config);
 
                     quote! {
-                        pub unsafe fn #name<#generics>(&self, #params) -> windows_core::Result<#return_type> #where_clause {
+                        pub unsafe fn #name<#generics>(&self, #params) -> #result Result<#return_type> #where_clause {
                             unsafe {
                                 let mut result__ = core::mem::zeroed();
                                 (windows_core::Interface::vtable(self).#vname)(windows_core::Interface::as_raw(self), #args);
@@ -441,15 +442,17 @@ impl CppMethod {
             }
         }
 
+        let result = config.write_result();
+
         let return_type = match self.return_hint {
             ReturnHint::Query(..) | ReturnHint::QueryOptional(..) | ReturnHint::ResultVoid => {
-                quote! { -> windows_core::Result<()> }
+                quote! { -> #result Result<()> }
             }
             ReturnHint::ResultValue => {
                 let return_type = self.signature.params[self.signature.params.len() - 1].deref();
                 let return_type = return_type.write_name(config);
 
-                quote! { -> windows_core::Result<#return_type> }
+                quote! { -> #result Result<#return_type> }
             }
             _ => self.write_return(config),
         };

crates/libs/bindgen/src/types/interface.rs

@@ -96,7 +96,7 @@ impl Interface {
 
         let vtbl = {
             let virtual_names = &mut MethodNames::new();
-            let core = config.write_core();
+            let result = config.write_result();
 
             let vtbl_methods = methods.iter().map(|method| match method {
                 MethodOrName::Method(method) => {
@@ -108,14 +108,14 @@ impl Interface {
 
                     if yes.is_empty() {
                         quote! {
-                            pub #name: unsafe extern "system" fn(#vtbl) -> #core HRESULT,
+                            pub #name: unsafe extern "system" fn(#vtbl) -> #result HRESULT,
                         }
                     } else {
                         let no = method_cfg.write(config, true);
 
                         quote! {
                             #yes
-                            pub #name: unsafe extern "system" fn(#vtbl) -> #core HRESULT,
+                            pub #name: unsafe extern "system" fn(#vtbl) -> #result HRESULT,
                             #no
                             #name: usize,
                         }
@@ -133,6 +133,8 @@ impl Interface {
                 quote! { #[doc(hidden)] }
             };
 
+            let core = config.write_core();
+
             quote! {
                 #cfg
                 #[repr(C)]