diff --git a/crates/icrate/CHANGELOG.md b/crates/icrate/CHANGELOG.md index 1dda9ef6c..3a7bf5e2f 100644 --- a/crates/icrate/CHANGELOG.md +++ b/crates/icrate/CHANGELOG.md @@ -10,6 +10,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). ## icrate Unreleased - YYYY-MM-DD +### Changed +* Moved the `ns_string!` macro to `icrate::Foundation::ns_string`. The old + location in the crate root is deprecated. + ## icrate 0.0.4 - 2023-07-31 diff --git a/crates/icrate/README.md b/crates/icrate/README.md index dc1cb50dc..076242216 100644 --- a/crates/icrate/README.md +++ b/crates/icrate/README.md @@ -27,8 +27,7 @@ Currently supports: ## Example ```rust -use icrate::Foundation::{NSCopying, NSArray}; -use icrate::ns_string; +use icrate::Foundation::{ns_string, NSCopying, NSArray}; let string = ns_string!("world"); println!("hello {string}"); diff --git a/crates/icrate/examples/basic_usage.rs b/crates/icrate/examples/basic_usage.rs index 4d841ac9d..711273a10 100644 --- a/crates/icrate/examples/basic_usage.rs +++ b/crates/icrate/examples/basic_usage.rs @@ -1,6 +1,5 @@ -use icrate::ns_string; use icrate::objc2::rc::autoreleasepool; -use icrate::Foundation::{NSArray, NSDictionary, NSObject}; +use icrate::Foundation::{ns_string, NSArray, NSDictionary, NSObject}; fn main() { // Create and compare NSObjects diff --git a/crates/icrate/examples/browser.rs b/crates/icrate/examples/browser.rs index 3d932f527..6a8c4dd82 100644 --- a/crates/icrate/examples/browser.rs +++ b/crates/icrate/examples/browser.rs @@ -1,7 +1,6 @@ #![deny(unsafe_op_in_unsafe_fn)] use icrate::{ - ns_string, AppKit::{ NSApplication, NSApplicationActivationPolicyRegular, NSBackingStoreBuffered, NSBezelStyleShadowlessSquare, NSButton, NSColor, NSControl, NSControlTextEditingDelegate, @@ -11,7 +10,9 @@ use icrate::{ NSUserInterfaceLayoutOrientationVertical, NSWindow, NSWindowStyleMaskClosable, NSWindowStyleMaskResizable, NSWindowStyleMaskTitled, }, - Foundation::{NSObject, NSObjectProtocol, NSPoint, NSRect, NSSize, NSURLRequest, NSURL}, + Foundation::{ + ns_string, NSObject, NSObjectProtocol, NSPoint, NSRect, NSSize, NSURLRequest, NSURL, + }, WebKit::{WKNavigation, WKNavigationDelegate, WKWebView}, }; use objc2::{ diff --git a/crates/icrate/examples/delegate.rs b/crates/icrate/examples/delegate.rs index 2204ab74d..3380f9b13 100644 --- a/crates/icrate/examples/delegate.rs +++ b/crates/icrate/examples/delegate.rs @@ -2,8 +2,7 @@ #![cfg_attr(not(target_os = "macos"), allow(unused))] use std::ptr::NonNull; -use icrate::ns_string; -use icrate::Foundation::{NSCopying, NSObject, NSString}; +use icrate::Foundation::{ns_string, NSCopying, NSObject, NSString}; use objc2::declare::{Ivar, IvarBool, IvarDrop, IvarEncode}; use objc2::rc::Id; use objc2::runtime::AnyObject; diff --git a/crates/icrate/examples/speech_synthesis.rs b/crates/icrate/examples/speech_synthesis.rs index 8cb151a25..80ee7c33a 100644 --- a/crates/icrate/examples/speech_synthesis.rs +++ b/crates/icrate/examples/speech_synthesis.rs @@ -10,8 +10,7 @@ use std::thread; use std::time::Duration; -use icrate::ns_string; -use icrate::Foundation::{NSObject, NSString}; +use icrate::Foundation::{ns_string, NSObject, NSString}; use objc2::mutability::InteriorMutable; use objc2::rc::Id; use objc2::{extern_class, msg_send, msg_send_id, ClassType}; diff --git a/crates/icrate/src/Foundation/additions/dictionary.rs b/crates/icrate/src/Foundation/additions/dictionary.rs index 2a6071679..c0526f43d 100644 --- a/crates/icrate/src/Foundation/additions/dictionary.rs +++ b/crates/icrate/src/Foundation/additions/dictionary.rs @@ -92,8 +92,7 @@ extern_methods!( )), doc = "```ignore" )] - /// use icrate::Foundation::{NSMutableDictionary, NSMutableString, NSString}; - /// use icrate::ns_string; + /// use icrate::Foundation::{ns_string, NSMutableDictionary, NSMutableString, NSString}; /// /// let mut dict = NSMutableDictionary::new(); /// dict.insert(NSString::from_str("one"), NSMutableString::new()); @@ -227,8 +226,7 @@ impl NSMutableDictionary { /// # Examples /// /// ``` - /// use icrate::Foundation::{NSMutableDictionary, NSObject, NSString}; - /// use icrate::ns_string; + /// use icrate::Foundation::{ns_string, NSMutableDictionary, NSObject, NSString}; /// /// let mut dict = NSMutableDictionary::new(); /// dict.insert(NSString::from_str("one"), NSObject::new()); diff --git a/crates/icrate/src/Foundation/additions/set.rs b/crates/icrate/src/Foundation/additions/set.rs index a0c5ba528..0f3c9f7db 100644 --- a/crates/icrate/src/Foundation/additions/set.rs +++ b/crates/icrate/src/Foundation/additions/set.rs @@ -254,8 +254,7 @@ extern_methods!( /// # Examples /// /// ``` - /// use icrate::Foundation::{NSSet, NSString}; - /// use icrate::ns_string; + /// use icrate::Foundation::{ns_string, NSSet, NSString}; /// /// let strs = ["one", "two", "three"].map(NSString::from_str); /// let set = NSSet::from_id_slice(&strs); @@ -272,8 +271,7 @@ extern_methods!( /// # Examples /// /// ``` - /// use icrate::Foundation::{NSSet, NSString}; - /// use icrate::ns_string; + /// use icrate::Foundation::{ns_string, NSSet, NSString}; /// /// let strs = ["one", "two", "three"].map(NSString::from_str); /// let set = NSSet::from_id_slice(&strs); @@ -384,8 +382,7 @@ impl NSMutableSet { /// # Examples /// /// ``` - /// use icrate::Foundation::{NSMutableSet, NSString}; - /// use icrate::ns_string; + /// use icrate::Foundation::{ns_string, NSMutableSet, NSString}; /// /// let mut set = NSMutableSet::new(); /// diff --git a/crates/icrate/src/Foundation/additions/string.rs b/crates/icrate/src/Foundation/additions/string.rs index 41e2e042c..a94156a72 100644 --- a/crates/icrate/src/Foundation/additions/string.rs +++ b/crates/icrate/src/Foundation/additions/string.rs @@ -119,7 +119,7 @@ impl NSString { /// /// Prefer using the [`ns_string!`] macro when possible. /// - /// [`ns_string!`]: crate::ns_string + /// [`ns_string!`]: crate::Foundation::ns_string #[doc(alias = "initWithBytes")] #[doc(alias = "initWithBytes:length:encoding:")] #[allow(clippy::should_implement_trait)] // Not really sure of a better name diff --git a/crates/icrate/src/Foundation/macros/ns_string.rs b/crates/icrate/src/Foundation/macros/ns_string.rs index b122ad43f..82fbf64c3 100644 --- a/crates/icrate/src/Foundation/macros/ns_string.rs +++ b/crates/icrate/src/Foundation/macros/ns_string.rs @@ -36,8 +36,7 @@ /// Creating a static `NSString`. /// /// ``` -/// use icrate::ns_string; -/// use icrate::Foundation::NSString; +/// use icrate::Foundation::{ns_string, NSString}; /// /// let hello: &'static NSString = ns_string!("hello"); /// assert_eq!(hello.to_string(), "hello"); @@ -46,7 +45,7 @@ /// Creating a `NSString` from a `const` `&str`. /// /// ``` -/// # use icrate::ns_string; +/// # use icrate::Foundation::ns_string; /// const EXAMPLE: &str = "example"; /// assert_eq!(ns_string!(EXAMPLE).to_string(), EXAMPLE); /// ``` @@ -54,7 +53,7 @@ /// Creating unicode strings. /// /// ``` -/// # use icrate::ns_string; +/// # use icrate::Foundation::ns_string; /// let hello_ru = ns_string!("Привет"); /// assert_eq!(hello_ru.to_string(), "Привет"); /// ``` @@ -62,13 +61,18 @@ /// Creating a string containing a NUL byte: /// /// ``` -/// # use icrate::ns_string; +/// # use icrate::Foundation::ns_string; /// assert_eq!(ns_string!("example\0").to_string(), "example\0"); /// assert_eq!(ns_string!("exa\0mple").to_string(), "exa\0mple"); /// ``` -#[cfg(feature = "Foundation_NSString")] // For auto_doc_cfg +// For auto_doc_cfg +#[cfg(feature = "Foundation_NSString")] #[macro_export] -macro_rules! ns_string { +// `macro_export` places the macro in the crate root, while we'd rather have +// it scoped under `Foundation`; so let's call this something private, and +// export it there with `#[doc(inline)]` instead. +#[doc(hidden)] +macro_rules! __ns_string { ($s:expr) => {{ // Immediately place in constant for better UI const INPUT: &str = $s; diff --git a/crates/icrate/src/Foundation/mod.rs b/crates/icrate/src/Foundation/mod.rs index 56abe549b..18d00e5b7 100644 --- a/crates/icrate/src/Foundation/mod.rs +++ b/crates/icrate/src/Foundation/mod.rs @@ -87,6 +87,10 @@ pub use self::additions::*; pub use self::fixes::*; pub use self::generated::*; +#[cfg(feature = "Foundation_NSString")] +#[doc(inline)] +pub use crate::__ns_string as ns_string; + // Available under Foundation, so makes sense here as well: // https://developer.apple.com/documentation/foundation/numbers_data_and_basic_values?language=objc pub use objc2::ffi::{NSInteger, NSUInteger}; diff --git a/crates/icrate/src/lib.rs b/crates/icrate/src/lib.rs index 66b0d2dcd..1e4dae41b 100644 --- a/crates/icrate/src/lib.rs +++ b/crates/icrate/src/lib.rs @@ -148,3 +148,13 @@ pub mod UniformTypeIdentifiers; pub mod UserNotifications; #[cfg(feature = "WebKit")] pub mod WebKit; + +/// Deprecated alias of [`Foundation::ns_string`][crate::Foundation::ns_string]. +#[macro_export] +#[deprecated = "use icrate::Foundation::ns_string instead"] +#[cfg(feature = "Foundation_NSString")] +macro_rules! ns_string { + ($s:expr) => { + $crate::Foundation::ns_string!($s) + }; +} diff --git a/crates/icrate/tests/error.rs b/crates/icrate/tests/error.rs index 564d2734c..a2f9c4e1e 100644 --- a/crates/icrate/tests/error.rs +++ b/crates/icrate/tests/error.rs @@ -1,7 +1,6 @@ #![cfg(feature = "Foundation_NSError")] #![cfg(feature = "Foundation_NSString")] -use icrate::ns_string; -use icrate::Foundation::{NSError, NSURLErrorDomain}; +use icrate::Foundation::{ns_string, NSError, NSURLErrorDomain}; #[test] fn basic() { diff --git a/crates/icrate/tests/mutable_set.rs b/crates/icrate/tests/mutable_set.rs index 92715a163..a94b94b37 100644 --- a/crates/icrate/tests/mutable_set.rs +++ b/crates/icrate/tests/mutable_set.rs @@ -2,8 +2,7 @@ #![cfg(feature = "Foundation_NSString")] use objc2::rc::{__RcTestObject, __ThreadTestData}; -use icrate::ns_string; -use icrate::Foundation::{self, NSMutableSet, NSSet, NSString}; +use icrate::Foundation::{self, ns_string, NSMutableSet, NSSet, NSString}; #[test] fn test_insert() { diff --git a/crates/icrate/tests/set.rs b/crates/icrate/tests/set.rs index fe543ad23..5979bf77e 100644 --- a/crates/icrate/tests/set.rs +++ b/crates/icrate/tests/set.rs @@ -4,8 +4,7 @@ use objc2::rc::{__RcTestObject, __ThreadTestData}; -use icrate::ns_string; -use icrate::Foundation::{self, NSNumber, NSObject, NSSet, NSString}; +use icrate::Foundation::{self, ns_string, NSNumber, NSObject, NSSet, NSString}; #[test] fn test_new() { diff --git a/crates/icrate/tests/string.rs b/crates/icrate/tests/string.rs index 3b23a6051..e59bef05e 100644 --- a/crates/icrate/tests/string.rs +++ b/crates/icrate/tests/string.rs @@ -3,8 +3,7 @@ use std::ptr; use objc2::rc::autoreleasepool; -use icrate::ns_string; -use icrate::Foundation::{self, NSString}; +use icrate::Foundation::{self, ns_string, NSString}; #[test] fn test_equality() { diff --git a/crates/objc2/CHANGELOG.md b/crates/objc2/CHANGELOG.md index fff46341f..bbe0ffa5b 100644 --- a/crates/objc2/CHANGELOG.md +++ b/crates/objc2/CHANGELOG.md @@ -6,7 +6,6 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). ## Unreleased - YYYY-MM-DD - ## 0.4.1 - 2023-07-31 ### Added diff --git a/crates/test-assembly/crates/test_ns_string/lib.rs b/crates/test-assembly/crates/test_ns_string/lib.rs index dc4719895..f70e83d13 100644 --- a/crates/test-assembly/crates/test_ns_string/lib.rs +++ b/crates/test-assembly/crates/test_ns_string/lib.rs @@ -1,8 +1,7 @@ //! Test the output of the `ns_string!` macro. #![cfg(feature = "Foundation_NSString")] -use icrate::ns_string; -use icrate::Foundation::NSString; +use icrate::Foundation::{ns_string, NSString}; // Temporary to allow testing putting string references in statics. // This doesn't yet compile on other platforms, but could in the future! diff --git a/crates/test-ui/ui/invalid_ns_string_input.rs b/crates/test-ui/ui/invalid_ns_string_input.rs index b8f7503ac..28225dff4 100644 --- a/crates/test-ui/ui/invalid_ns_string_input.rs +++ b/crates/test-ui/ui/invalid_ns_string_input.rs @@ -1,4 +1,4 @@ -use icrate::ns_string; +use icrate::Foundation::ns_string; fn main() { let _ = ns_string!(1u8); diff --git a/crates/test-ui/ui/invalid_ns_string_output.rs b/crates/test-ui/ui/invalid_ns_string_output.rs index a25d965f2..b248979f6 100644 --- a/crates/test-ui/ui/invalid_ns_string_output.rs +++ b/crates/test-ui/ui/invalid_ns_string_output.rs @@ -1,4 +1,4 @@ -use icrate::ns_string; +use icrate::Foundation::ns_string; fn main() { let _: u8 = ns_string!("abc"); diff --git a/crates/test-ui/ui/ns_string_not_const.rs b/crates/test-ui/ui/ns_string_not_const.rs index 1e7885be1..67390875f 100644 --- a/crates/test-ui/ui/ns_string_not_const.rs +++ b/crates/test-ui/ui/ns_string_not_const.rs @@ -1,4 +1,4 @@ -use icrate::ns_string; +use icrate::Foundation::ns_string; fn main() { let s: &str = "abc"; diff --git a/crates/test-ui/ui/ns_string_output_not_const.rs b/crates/test-ui/ui/ns_string_output_not_const.rs index 9ad16b88b..08396d70d 100644 --- a/crates/test-ui/ui/ns_string_output_not_const.rs +++ b/crates/test-ui/ui/ns_string_output_not_const.rs @@ -1,5 +1,4 @@ -use icrate::ns_string; -use icrate::Foundation::NSString; +use icrate::Foundation::{ns_string, NSString}; fn main() { static STRING: &NSString = ns_string!("abc");