Auto-generate parts of dispatch2::ffi

To:
- Ensure that it's correct and complete.
- Enable better documentation once we translate header comments too.
- Allow better integration with frameworks in the future.

Part of #77.

Author: madsmtm

Cargo.lock

@@ -3,6 +3,7 @@ crate = "block2"
 required-crates = []
 link = false
 skipped = true
+is-library = true
 
 macos = "10.6"
 maccatalyst = "13.0"

crates/block2/translation-config.toml

@@ -6,8 +6,53 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ## Unreleased - YYYY-MM-DD
 
+### Added
+- Added support for `objc2` encodings.
+- Added initial support for `block2`.
+- Autogenerated `ffi` bindings, which adds:
+  - `dispatch_data_applier_t`.
+  - `dispatch_fd_t`.
+  - `dispatch_io_close_flags_t`.
+  - `dispatch_io_handler_t`.
+  - `dispatch_io_interval_flags_t`.
+  - `dispatch_io_s` / `dispatch_io_t`.
+  - `dispatch_io_type_t`.
+  - `DISPATCH_WALLTIME_NOW`.
+  - `_dispatch_source_type_mach_recv`.
+  - `_dispatch_source_type_proc`.
+  - `_dispatch_source_type_signal`.
+  - `_dispatch_source_type_vnode`.
+  - `dispatch_allow_send_signals`.
+  - `dispatch_apply`.
+  - `dispatch_cancel`.
+  - `dispatch_data_apply`.
+  - `dispatch_get_current_queueDeprecated`.
+  - `dispatch_get_main_queue`.
+  - `dispatch_io_barrier`.
+  - `dispatch_io_close`.
+  - `dispatch_io_create`.
+  - `dispatch_io_create_with_io`.
+  - `dispatch_io_create_with_path`.
+  - `dispatch_io_get_descriptor`.
+  - `dispatch_io_read`.
+  - `dispatch_io_set_high_water`.
+  - `dispatch_io_set_interval`.
+  - `dispatch_io_set_low_water`.
+  - `dispatch_io_write`.
+  - `dispatch_notify`.
+  - `dispatch_read`.
+  - `dispatch_testcancel`.
+  - `dispatch_wait`.
+  - `dispatch_write`.
+- Added `#[must_use]` in bindings where the source uses it.
+
 ### Changed
 - Moved to the `objc2` project.
+- **BREAKING**: Made `Queue::set_specific` take a key pointer instead of a `usize`.
+
+### Fixed
+- **BREAKING**: Use `extern "C-unwind"` instead of `extern "C"` in certain functions that required that.
+- **BREAKING**: Use `isize` instead of `usize` in certain functions where that is more correct.
 
 
 ## 0.1.0 - 2022-10-02

crates/dispatch2/CHANGELOG.md

@@ -0,0 +1,11 @@
+[package]
+version = "0.1.0" # Remember to update html_root_url in lib.rs
+description = "Bindings and wrappers for Apple's Grand Central Dispatch (GCD)"
+keywords = ["gcd", "macos", "ios", "dispatch", "libdispatch"]
+authors = ["Mads Marquart <[email protected]>", "Mary <[email protected]>"]
+license = "Apache-2.0 OR MIT"
+
+[package.metadata.release]
+shared-version = false
+tag-prefix = "dispatch"
+enable-features = []

crates/dispatch2/Cargo.modified.toml

@@ -1,41 +1,57 @@
+# This file has been automatically generated by `objc2`'s `header-translator`.
+# DO NOT EDIT
+
 [package]
 name = "dispatch2"
 version = "0.1.0" # Remember to update html_root_url in lib.rs
 description = "Bindings and wrappers for Apple's Grand Central Dispatch (GCD)"
-keywords = ["gcd", "macos", "ios", "dispatch", "libdispatch"]
-categories = [
-    "api-bindings",
-    "development-tools::ffi",
-    "os::macos-apis",
-    "external-ffi-bindings",
-]
-authors = ["Mads Marquart <[email protected]>", "Mary <[email protected]>"]
 edition.workspace = true
 rust-version.workspace = true
+keywords = ["gcd", "macos", "ios", "dispatch", "libdispatch"]
+categories.workspace = true
 repository.workspace = true
 license = "Apache-2.0 OR MIT"
+authors = ["Mads Marquart <[email protected]>", "Mary <[email protected]>"]
 
 [lints]
 workspace = true
 
 [dependencies]
-libc = "0.2"
+bitflags = { version = "2.5.0", default-features = false }
+block2 = { path = "../block2", version = "0.5.1", default-features = false, optional = true }
+libc = { version = "0.2.80", default-features = false, optional = true }
+objc2 = { path = "../objc2", version = "0.5.2", default-features = false, optional = true }
 
 [package.metadata.docs.rs]
 default-target = "aarch64-apple-darwin"
-features = []
+features = ["all"]
 targets = [
     "aarch64-apple-darwin",
     "x86_64-apple-darwin",
     "aarch64-apple-ios",
-    "x86_64-apple-ios",
     "aarch64-apple-tvos",
     "aarch64-apple-watchos",
     "aarch64-apple-ios-macabi",
     "x86_64-unknown-linux-gnu",
     "i686-unknown-linux-gnu",
 ]
 
+[features]
+default = ["std"]
+
+# Currently not possible to turn off, put here for forwards compatibility.
+std = ["alloc", "bitflags/std", "block2?/std", "libc?/std", "objc2?/std"]
+alloc = ["block2?/alloc", "objc2?/alloc"]
+block2 = ["dep:block2"]
+libc = ["dep:libc"]
+objc2 = ["dep:objc2"]
+
+all = [
+    "block2",
+    "libc",
+    "objc2",
+]
+
 [package.metadata.release]
 shared-version = false
 tag-prefix = "dispatch"

crates/dispatch2/Cargo.toml

@@ -1,17 +1,14 @@
 # `dispatch2`
 
 [![Latest version](https://badgen.net/crates/v/dispatch2)](https://crates.io/crates/dispatch2)
-[![License](https://badgen.net/static/license/MIT%20OR%20Apache%202.0/blue)](https://github.com/madsmtm/objc2/blob/master/LICENSE.txt)
+[![License](https://badgen.net/badge/license/MIT%20OR%20Apache%202.0/blue)](../LICENSE.txt)
 [![Documentation](https://docs.rs/dispatch2/badge.svg)](https://docs.rs/dispatch2/)
 [![CI](https://github.com/madsmtm/objc2/actions/workflows/ci.yml/badge.svg)](https://github.com/madsmtm/objc2/actions/workflows/ci.yml)
 
-Apple's Grand Central Dispatch interface in Rust.
+Rust bindings to Apple's Grand Central Dispatch.
 
-This crate provides a safe and sound interface to Apple's Grand Central
-dispatch, as well as the ability to drop into lower-level bindings.
-
-This README is kept intentionally small in an effort to consolidate the
-documentation, see [the Rust docs](https://docs.rs/dispatch2/) for more details.
+This README is kept intentionally small to consolidate the documentation, see
+[the Rust docs](https://docs.rs/dispatch2/) for more details on this crate.
 
 This crate is part of the [`objc2` project](https://github.com/madsmtm/objc2),
 see that for related crates.