Make new windows-strings crate Windows-only (#3143)

microsoft · Jul 3, 2024 · ab03721 · ab03721
1 parent f6c49f4
commit ab03721
Show file tree

Hide file tree

Showing 10 changed files with 90 additions and 98 deletions.
diff --git a/crates/libs/core/src/inspectable.rs b/crates/libs/core/src/inspectable.rs
@@ -1,6 +1,5 @@
 use super::*;
 use core::ffi::c_void;
-use core::mem::{transmute, transmute_copy};
 use core::ptr::null_mut;
 
 /// A WinRT object that may be used as a polymorphic stand-in for any WinRT class, interface, or boxed value.
@@ -15,19 +14,20 @@ interface_hierarchy!(IInspectable, IUnknown);
 
 impl IInspectable {
     /// Returns the canonical type name for the underlying object.
+    #[cfg(windows)]
     pub fn GetRuntimeClassName(&self) -> Result<HSTRING> {
         unsafe {
             let mut abi = null_mut();
-            (self.vtable().GetRuntimeClassName)(transmute_copy(self), &mut abi).ok()?;
-            Ok(transmute::<*mut c_void, HSTRING>(abi))
+            (self.vtable().GetRuntimeClassName)(core::mem::transmute_copy(self), &mut abi).ok()?;
+            Ok(core::mem::transmute::<*mut c_void, HSTRING>(abi))
         }
     }
 
     /// Gets the trust level of the current object.
     pub fn GetTrustLevel(&self) -> Result<i32> {
         unsafe {
             let mut value = 0;
-            (self.vtable().GetTrustLevel)(transmute_copy(self), &mut value).ok()?;
+            (self.vtable().GetTrustLevel)(core::mem::transmute_copy(self), &mut value).ok()?;
             Ok(value)
         }
     }
@@ -82,8 +82,17 @@ impl IInspectable_Vtbl {
             if value.is_null() {
                 return imp::E_POINTER;
             }
-            let h: HSTRING = T::NAME.into(); // TODO: should be try_into
-            *value = transmute::<HSTRING, *mut c_void>(h);
+
+            #[cfg(windows)]
+            {
+                *value = core::mem::transmute::<HSTRING, *mut c_void>(T::NAME.into());
+            }
+
+            #[cfg(not(windows))]
+            {
+                *value = core::ptr::null_mut();
+            }
+
             HRESULT(0)
         }
         unsafe extern "system" fn GetTrustLevel<T: IUnknownImpl, const OFFSET: isize>(

diff --git a/crates/libs/core/src/lib.rs b/crates/libs/core/src/lib.rs
@@ -58,4 +58,3 @@ pub use weak::*;
 pub use windows_implement::implement;
 pub use windows_interface::interface;
 pub use windows_result::*;
-pub use windows_strings::*;
diff --git a/crates/libs/core/src/param.rs b/crates/libs/core/src/param.rs
@@ -61,27 +61,3 @@ where
         ParamValue::Owned(transmute_copy(&self))
     }
 }
-
-impl Param<PCWSTR> for &BSTR {
-    unsafe fn param(self) -> ParamValue<PCWSTR> {
-        ParamValue::Owned(PCWSTR(self.as_ptr()))
-    }
-}
-
-impl Param<PCWSTR> for &HSTRING {
-    unsafe fn param(self) -> ParamValue<PCWSTR> {
-        ParamValue::Owned(PCWSTR(self.as_ptr()))
-    }
-}
-
-impl Param<PCWSTR> for PWSTR {
-    unsafe fn param(self) -> ParamValue<PCWSTR> {
-        ParamValue::Owned(PCWSTR(self.0))
-    }
-}
-
-impl Param<PCSTR> for PSTR {
-    unsafe fn param(self) -> ParamValue<PCSTR> {
-        ParamValue::Owned(PCSTR(self.0))
-    }
-}
diff --git a/crates/libs/core/src/runtime_type.rs b/crates/libs/core/src/runtime_type.rs
@@ -28,7 +28,3 @@ primitives! {
     (f32, b"f4"),
     (f64, b"f8")
 }
-
-impl RuntimeType for HSTRING {
-    const SIGNATURE: imp::ConstBuffer = imp::ConstBuffer::from_slice(b"string");
-}
diff --git a/crates/libs/core/src/type.rs b/crates/libs/core/src/type.rs
@@ -98,27 +98,3 @@ primitives!(bool, i8, u8, i16, u16, i32, u32, i64, u64, f32, f64, usize, isize);
 
 #[doc(hidden)]
 pub type AbiType<T> = <T as Type<T>>::Abi;
-
-impl TypeKind for PWSTR {
-    type TypeKind = CopyType;
-}
-
-impl TypeKind for PSTR {
-    type TypeKind = CopyType;
-}
-
-impl TypeKind for PCWSTR {
-    type TypeKind = CopyType;
-}
-
-impl TypeKind for PCSTR {
-    type TypeKind = CopyType;
-}
-
-impl TypeKind for HSTRING {
-    type TypeKind = CloneType;
-}
-
-impl TypeKind for BSTR {
-    type TypeKind = CloneType;
-}
diff --git a/crates/libs/core/src/windows.rs b/crates/libs/core/src/windows.rs
@@ -15,8 +15,62 @@ pub use handles::*;
 mod variant;
 pub use variant::*;
 
+pub use windows_strings::*;
+
 /// Attempts to load the factory object for the given WinRT class.
 /// This can be used to access COM interfaces implemented on a Windows Runtime class factory.
 pub fn factory<C: RuntimeName, I: Interface>() -> Result<I> {
     imp::factory::<C, I>()
 }
+
+impl Param<PCWSTR> for &BSTR {
+    unsafe fn param(self) -> ParamValue<PCWSTR> {
+        ParamValue::Owned(PCWSTR(self.as_ptr()))
+    }
+}
+
+impl Param<PCWSTR> for &HSTRING {
+    unsafe fn param(self) -> ParamValue<PCWSTR> {
+        ParamValue::Owned(PCWSTR(self.as_ptr()))
+    }
+}
+
+impl Param<PCWSTR> for PWSTR {
+    unsafe fn param(self) -> ParamValue<PCWSTR> {
+        ParamValue::Owned(PCWSTR(self.0))
+    }
+}
+
+impl Param<PCSTR> for PSTR {
+    unsafe fn param(self) -> ParamValue<PCSTR> {
+        ParamValue::Owned(PCSTR(self.0))
+    }
+}
+
+impl RuntimeType for HSTRING {
+    const SIGNATURE: imp::ConstBuffer = imp::ConstBuffer::from_slice(b"string");
+}
+
+impl TypeKind for PWSTR {
+    type TypeKind = CopyType;
+}
+
+impl TypeKind for PSTR {
+    type TypeKind = CopyType;
+}
+
+impl TypeKind for PCWSTR {
+    type TypeKind = CopyType;
+}
+
+impl TypeKind for PCSTR {
+    type TypeKind = CopyType;
+}
+
+impl TypeKind for HSTRING {
+    type TypeKind = CloneType;
+}
+
+impl TypeKind for BSTR {
+    type TypeKind = CloneType;
+}
diff --git a/crates/libs/strings/src/hstring.rs b/crates/libs/strings/src/hstring.rs
@@ -54,7 +54,7 @@ impl HSTRING {
     }
 
     /// Get the contents of this `HSTRING` as a OsString.
-    #[cfg(all(feature = "std", windows))]
+    #[cfg(feature = "std")]
     pub fn to_os_string(&self) -> std::ffi::OsString {
         std::os::windows::ffi::OsStringExt::from_wide(self.as_wide())
     }
@@ -154,14 +154,14 @@ impl From<&String> for HSTRING {
     }
 }
 
-#[cfg(all(feature = "std", windows))]
+#[cfg(feature = "std")]
 impl From<&std::path::Path> for HSTRING {
     fn from(value: &std::path::Path) -> Self {
         value.as_os_str().into()
     }
 }
 
-#[cfg(all(feature = "std", windows))]
+#[cfg(feature = "std")]
 impl From<&std::ffi::OsStr> for HSTRING {
     fn from(value: &std::ffi::OsStr) -> Self {
         unsafe {
@@ -174,14 +174,14 @@ impl From<&std::ffi::OsStr> for HSTRING {
     }
 }
 
-#[cfg(all(feature = "std", windows))]
+#[cfg(feature = "std")]
 impl From<std::ffi::OsString> for HSTRING {
     fn from(value: std::ffi::OsString) -> Self {
         value.as_os_str().into()
     }
 }
 
-#[cfg(all(feature = "std", windows))]
+#[cfg(feature = "std")]
 impl From<&std::ffi::OsString> for HSTRING {
     fn from(value: &std::ffi::OsString) -> Self {
         value.as_os_str().into()
@@ -286,28 +286,28 @@ impl PartialEq<&HSTRING> for String {
     }
 }
 
-#[cfg(all(feature = "std", windows))]
+#[cfg(feature = "std")]
 impl PartialEq<std::ffi::OsString> for HSTRING {
     fn eq(&self, other: &std::ffi::OsString) -> bool {
         *self == **other
     }
 }
 
-#[cfg(all(feature = "std", windows))]
+#[cfg(feature = "std")]
 impl PartialEq<std::ffi::OsString> for &HSTRING {
     fn eq(&self, other: &std::ffi::OsString) -> bool {
         **self == **other
     }
 }
 
-#[cfg(all(feature = "std", windows))]
+#[cfg(feature = "std")]
 impl PartialEq<&std::ffi::OsString> for HSTRING {
     fn eq(&self, other: &&std::ffi::OsString) -> bool {
         *self == ***other
     }
 }
 
-#[cfg(all(feature = "std", windows))]
+#[cfg(feature = "std")]
 impl PartialEq<std::ffi::OsStr> for HSTRING {
     fn eq(&self, other: &std::ffi::OsStr) -> bool {
         self.as_wide()
@@ -317,56 +317,56 @@ impl PartialEq<std::ffi::OsStr> for HSTRING {
     }
 }
 
-#[cfg(all(feature = "std", windows))]
+#[cfg(feature = "std")]
 impl PartialEq<std::ffi::OsStr> for &HSTRING {
     fn eq(&self, other: &std::ffi::OsStr) -> bool {
         **self == *other
     }
 }
 
-#[cfg(all(feature = "std", windows))]
+#[cfg(feature = "std")]
 impl PartialEq<&std::ffi::OsStr> for HSTRING {
     fn eq(&self, other: &&std::ffi::OsStr) -> bool {
         *self == **other
     }
 }
 
-#[cfg(all(feature = "std", windows))]
+#[cfg(feature = "std")]
 impl PartialEq<HSTRING> for std::ffi::OsStr {
     fn eq(&self, other: &HSTRING) -> bool {
         *other == *self
     }
 }
 
-#[cfg(all(feature = "std", windows))]
+#[cfg(feature = "std")]
 impl PartialEq<HSTRING> for &std::ffi::OsStr {
     fn eq(&self, other: &HSTRING) -> bool {
         *other == **self
     }
 }
 
-#[cfg(all(feature = "std", windows))]
+#[cfg(feature = "std")]
 impl PartialEq<&HSTRING> for std::ffi::OsStr {
     fn eq(&self, other: &&HSTRING) -> bool {
         **other == *self
     }
 }
 
-#[cfg(all(feature = "std", windows))]
+#[cfg(feature = "std")]
 impl PartialEq<HSTRING> for std::ffi::OsString {
     fn eq(&self, other: &HSTRING) -> bool {
         *other == **self
     }
 }
 
-#[cfg(all(feature = "std", windows))]
+#[cfg(feature = "std")]
 impl PartialEq<HSTRING> for &std::ffi::OsString {
     fn eq(&self, other: &HSTRING) -> bool {
         *other == ***self
     }
 }
 
-#[cfg(all(feature = "std", windows))]
+#[cfg(feature = "std")]
 impl PartialEq<&HSTRING> for std::ffi::OsString {
     fn eq(&self, other: &&HSTRING) -> bool {
         **other == **self
@@ -389,14 +389,14 @@ impl TryFrom<HSTRING> for String {
     }
 }
 
-#[cfg(all(feature = "std", windows))]
+#[cfg(feature = "std")]
 impl<'a> From<&'a HSTRING> for std::ffi::OsString {
     fn from(hstring: &HSTRING) -> Self {
         hstring.to_os_string()
     }
 }
 
-#[cfg(all(feature = "std", windows))]
+#[cfg(feature = "std")]
 impl From<HSTRING> for std::ffi::OsString {
     fn from(hstring: HSTRING) -> Self {
         Self::from(&hstring)

diff --git a/crates/libs/strings/src/hstring_header.rs b/crates/libs/strings/src/hstring_header.rs
@@ -23,19 +23,9 @@ impl HStringHeader {
         // The space for the terminating null character is already accounted for inside of `HStringHeader`.
         let bytes = core::mem::size_of::<Self>() + 2 * len as usize;
 
-        #[cfg(windows)]
         let header =
             unsafe { bindings::HeapAlloc(bindings::GetProcessHeap(), 0, bytes) } as *mut Self;
 
-        #[cfg(not(windows))]
-        let header = unsafe {
-            extern "C" {
-                fn malloc(bytes: usize) -> *mut core::ffi::c_void;
-            }
-
-            malloc(bytes) as *mut Self
-        };
-
         if header.is_null() {
             return Err(Error::from_hresult(HRESULT(bindings::E_OUTOFMEMORY)));
         }
@@ -56,17 +46,7 @@ impl HStringHeader {
             return;
         }
 
-        #[cfg(windows)]
         bindings::HeapFree(bindings::GetProcessHeap(), 0, header as *mut _);
-
-        #[cfg(not(windows))]
-        {
-            extern "C" {
-                fn free(ptr: *mut core::ffi::c_void);
-            }
-
-            free(header as *mut _);
-        }
     }
 
     pub fn duplicate(&self) -> Result<*mut Self> {

diff --git a/crates/libs/strings/src/lib.rs b/crates/libs/strings/src/lib.rs
@@ -2,6 +2,7 @@
 Learn more about Rust for Windows here: <https://github.com/microsoft/windows-rs>
 */
 
+#![cfg(windows)]
 #![allow(non_snake_case)]
 #![cfg_attr(
     windows_debugger_visualizer,

diff --git a/crates/libs/windows/src/lib.rs b/crates/libs/windows/src/lib.rs
@@ -6,6 +6,7 @@ Learn more about Rust for Windows here: <https://github.com/microsoft/windows-rs
 [Feature search](https://microsoft.github.io/windows-rs/features/#/0.57.0)
 */
 
+#![cfg(windows)]
 #![doc(html_no_source)]
 #![allow(non_snake_case, clashing_extern_declarations, non_upper_case_globals, non_camel_case_types, missing_docs, clippy::all)]
 #![cfg_attr(not(feature = "docs"), doc(hidden))]