Merge pull request #222 from madsmtm/move-foundation

Move `objc2-foundation` to `objc2::foundation`

Author: madsmtm

Cargo.toml

@@ -3,7 +3,6 @@ members = [
     "objc2",
     "objc-sys",
     "objc2-encode",
-    "objc2-foundation",
     "objc2-proc-macros",
     "block2",
     "block-sys",

objc2-foundation/Cargo.toml

@@ -1,6 +1,7 @@
 # Changelog
 
-Notable changes to this crate will be documented in this file.
+Notable changes to this crate will be documented in this file. See the
+`CHANGELOG_FOUNDATION.md` file for changes to the `objc2::foundation` module!
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
@@ -9,6 +10,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 ### Added
 * Added the `"unstable-static-class"` and `"unstable-static-class-inlined"`
   feature flags to make the `class!` macro zero cost.
+* Moved the external crate `objc2_foundation` into `objc2::foundation` under
+  (default) feature flag `"foundation"`.
+* Added `declare_class!`, `extern_class!` and `ns_string!` macros from
+  `objc2-foundation`.
+
+### Changed
+* Change selector syntax in `declare_class!` macro to be more Rust-like.
 
 
 ## 0.3.0-beta.1 - 2022-07-19

objc2-foundation/README.md

@@ -1,6 +1,8 @@
 # Changelog
 
-Notable changes to this crate will be documented in this file.
+Changes to the `objc2::foundation` module will be documented in this file.
+This previously existed as a separate crate `objc2_foundation`, hence the
+separation.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
@@ -14,7 +16,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 * Add extra `Extend<&u8>` impl for `NSMutableData`.
 
 ### Changed
-* Change selector syntax in `declare_class!` macro to be more Rust-like.
+* **BREAKING**: Moved from external crate `objc2_foundation` into
+  `objc2::foundation`.
 
 ### Fixed
 * Made `Debug` impls for all objects print something useful.
@@ -25,22 +28,24 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
   `Debug`.
 
 
-## 0.2.0-alpha.6 - 2022-07-19
+## objc2-foundation 0.2.0-alpha.6 - 2022-07-19
 
 ### Added
 * Added `MainThreadMarker` to help with designing APIs where a method is only
   safe to call on the main thread.
 * Added `NSException` object.
 * Added `extern_class!` macro to help with defining interfaces to classes.
+  Further changelog for this can be found in `CHANGELOG.md`.
 * Added `declare_class!` macro to help with declaring custom classes.
+  Further changelog for this can be found in `CHANGELOG.md`.
 * Expose the `objc2` version that this uses in the crate root.
 * Added `NSZone`.
 
 ### Changed
 * Changed a few `Debug` impls.
 
 
-## 0.2.0-alpha.5 - 2022-06-13
+## objc2-foundation 0.2.0-alpha.5 - 2022-06-13
 
 ### Added
 * Objects now `Deref` to their superclasses. E.g. `NSMutableArray` derefs to
@@ -109,7 +114,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
   easily lead to hard-to-diagnose performance issues.
 
 
-## 0.2.0-alpha.3 - 2021-12-22
+## objc2-foundation 0.2.0-alpha.3 - 2021-12-22
 
 ### Added
 * **BREAKING**: Added associated `Ownership` type to `NSCopying`.
@@ -135,7 +140,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
   subclasses may not be).
 
 
-## 0.2.0-alpha.2 - 2021-11-22
+## objc2-foundation 0.2.0-alpha.2 - 2021-11-22
 
 ### Added
 * **BREAKING**: Added associated `Ownership` type to `INSObject` to specify
@@ -197,7 +202,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 * Fixed `NSData::from_vec` on GNUStep.
 
 
-## 0.2.0-alpha.1 - 2021-10-28
+## objc2-foundation 0.2.0-alpha.1 - 2021-10-28
 
 ### Added
 * Implement new `RefEncode` trait for objects.
@@ -213,7 +218,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 * `INSString::from_str` on GNUStep (`UTF8_ENCODING` was the wrong type).
 
 
-## 0.2.0-alpha.0 - 2021-08-29
+## objc2-foundation 0.2.0-alpha.0 - 2021-08-29
 
 Note: This is the version that is, as of this writing, available on the
 `master` branch in the original `objc-foundation` project.
@@ -229,27 +234,27 @@ Note: This is the version that is, as of this writing, available on the
 * Fixed types in various calls to `objc::msg_send!` for better verification.
 
 
-## [0.1.1] - 2016-06-19
+## objc-foundation [0.1.1] - 2016-06-19
 
 ### Fixed
 * An issue with passing functions (instead of function pointers) in
   `INSMutableArray::sort_by`.
 
 
-## [0.1.0] - 2016-03-20
+## objc-foundation [0.1.0] - 2016-03-20
 
 ### Changed
 * Update `objc` to `v0.2`.
 * Update `objc_id` to `v0.1`.
 
 
-## [0.0.4] - 2015-12-09
+## objc-foundation [0.0.4] - 2015-12-09
 
 ### Removed
 * `libc` dependency.
 
 
-## [0.0.3] - 2015-11-07
+## objc-foundation [0.0.3] - 2015-11-07
 
 ### Added
 * `object_struct!` macro.
@@ -258,13 +263,13 @@ Note: This is the version that is, as of this writing, available on the
 * `libc` version can both be `0.1` and `0.2`.
 
 
-## [0.0.2] - 2015-09-03
+## objc-foundation [0.0.2] - 2015-09-03
 
 ### Added
 * `Any` bound on `INSObject`, because of a change in `objc` `v0.1.6`.
 
 
-## [0.0.1] - 2015-06-13
+## objc-foundation [0.0.1] - 2015-06-13
 
 Initial release.
 

objc2/CHANGELOG.md

@@ -4,8 +4,8 @@ version = "0.3.0-beta.1" # Remember to update html_root_url in lib.rs
 authors = ["Steven Sheldon", "Mads Marquart <mads@marquart.dk>"]
 edition = "2021"
 
-description = "Objective-C interface and runtime bindings"
-keywords = ["objective-c", "macos", "ios", "objc_msgSend"]
+description = "Objective-C interface and bindings to the Cocoa Foundation framework"
+keywords = ["objective-c", "macos", "ios", "objc_msgSend", "cocoa"]
 categories = [
     "api-bindings",
     "development-tools::ffi",
@@ -19,11 +19,14 @@ license = "MIT"
 # NOTE: 'unstable' features are _not_ considered part of the SemVer contract,
 # and may be removed in a minor release.
 [features]
-default = ["std", "apple"]
+default = ["std", "apple", "foundation"]
 
 # Currently not possible to turn off, put here for forwards compatibility.
-std = ["alloc", "objc2-encode/std", "objc-sys/std"]
-alloc = ["objc2-encode/alloc", "objc-sys/alloc"]
+std = ["alloc", "objc2-encode/std", "objc-sys/std", "block2?/std"]
+alloc = ["objc2-encode/alloc", "objc-sys/alloc", "block2?/alloc"]
+
+# Enable the `objc2::foundation` submodule. It is enabled by default.
+foundation = []
 
 # Enables `objc2::exception::throw` and `objc2::exception::catch`
 exception = ["objc-sys/unstable-exception"]
@@ -41,6 +44,9 @@ verify_message = ["malloc"] # TODO: Remove malloc feature here
 # increases compilation time.
 malloc = ["malloc_buf"]
 
+# Expose features that requires creating blocks.
+block = ["block2"]
+
 # Make the `sel!` macro look up the selector statically.
 #
 # The plan is to enable this by default, but right now we are uncertain of
@@ -64,18 +70,22 @@ unstable-c-unwind = ["objc-sys/unstable-c-unwind"]
 unstable-docsrs = []
 
 # Runtime selection. See `objc-sys` for details.
-apple = ["objc-sys/apple"]
-gnustep-1-7 = ["objc-sys/gnustep-1-7"]
-gnustep-1-8 = ["gnustep-1-7", "objc-sys/gnustep-1-8"]
-gnustep-1-9 = ["gnustep-1-8", "objc-sys/gnustep-1-9"]
-gnustep-2-0 = ["gnustep-1-9", "objc-sys/gnustep-2-0"]
-gnustep-2-1 = ["gnustep-2-0", "objc-sys/gnustep-2-1"]
+apple = ["objc-sys/apple", "block2?/apple"]
+gnustep-1-7 = ["objc-sys/gnustep-1-7", "block2?/gnustep-1-7"]
+gnustep-1-8 = ["gnustep-1-7", "objc-sys/gnustep-1-8", "block2?/gnustep-1-8"]
+gnustep-1-9 = ["gnustep-1-8", "objc-sys/gnustep-1-9", "block2?/gnustep-1-9"]
+gnustep-2-0 = ["gnustep-1-9", "objc-sys/gnustep-2-0", "block2?/gnustep-2-0"]
+gnustep-2-1 = ["gnustep-2-0", "objc-sys/gnustep-2-1", "block2?/gnustep-2-1"]
 
 [dependencies]
 malloc_buf = { version = "1.0", optional = true }
 objc-sys = { path = "../objc-sys", version = "=0.2.0-beta.1", default-features = false }
 objc2-encode = { path = "../objc2-encode", version = "=2.0.0-pre.1", default-features = false }
 objc2-proc-macros = { path = "../objc2-proc-macros", version = "0.1.0", optional = true }
+block2 = { path = "../block2", version = "=0.2.0-alpha.5", default-features = false, optional = true }
+
+# Provide methods to convert between `uuid::Uuid` and `objc2::foundation::NSUUID`
+uuid = { version = "1.1.2", optional = true, default-features = false }
 
 [dev-dependencies]
 iai = { version = "0.1", git = "https://github.com/madsmtm/iai", branch = "callgrind" }
@@ -86,7 +96,7 @@ harness = false
 
 [package.metadata.docs.rs]
 default-target = "x86_64-apple-darwin"
-features = ["exception", "malloc", "unstable-docsrs"]
+features = ["exception", "malloc", "block", "uuid", "unstable-docsrs"]
 
 targets = [
     # MacOS

objc2-foundation/CHANGELOG.md renamed to objc2/CHANGELOG_FOUNDATION.md

@@ -5,10 +5,11 @@
 [![Documentation](https://docs.rs/objc2/badge.svg)](https://docs.rs/objc2/)
 [![CI](https://github.com/madsmtm/objc2/actions/workflows/ci.yml/badge.svg)](https://github.com/madsmtm/objc2/actions/workflows/ci.yml)
 
-Objective-C interface and runtime bindings for Rust.
+Objective-C interface and bindings to the `Foundation` framework in Rust.
 
 Most of the core libraries and frameworks that are in use on Apple systems are
-written in Objective-C; this crate enables you to interract with those.
+written in Objective-C; this crate enables you to interract with those, and
+provides ready-made bindings for the `Foundation` framework in particular.
 
 ## Example
 

objc2/Cargo.toml

@@ -1,5 +1,6 @@
+use objc2::foundation::{NSArray, NSDictionary, NSObject};
+use objc2::ns_string;
 use objc2::rc::autoreleasepool;
-use objc2_foundation::{ns_string, NSArray, NSDictionary, NSObject};
 
 fn main() {
     // Create and compare NSObjects

objc2/README.md

@@ -3,11 +3,11 @@ use std::marker::PhantomData;
 use std::sync::Once;
 
 use objc2::declare::ClassBuilder;
+use objc2::foundation::NSObject;
 use objc2::rc::{Id, Owned, Shared};
 use objc2::runtime::{Class, Object, Sel};
 use objc2::{msg_send, msg_send_id, sel};
 use objc2::{Encoding, Message, RefEncode};
-use objc2_foundation::NSObject;
 
 #[repr(C)]
 pub struct MyObject<'a> {

objc2-foundation/examples/basic_usage.rs renamed to objc2/examples/basic_usage.rs

@@ -1,11 +1,11 @@
 use std::sync::Once;
 
 use objc2::declare::{ClassBuilder, Ivar, IvarType};
+use objc2::foundation::NSObject;
 use objc2::rc::{Id, Owned};
 use objc2::runtime::{Class, Object, Sel};
 use objc2::{msg_send, msg_send_id, sel};
 use objc2::{Encoding, Message, RefEncode};
-use objc2_foundation::NSObject;
 
 struct NumberIvar;
 unsafe impl IvarType for NumberIvar {