2f9a5b5e67
- Adds a new `ObjcProperty` type, which wraps our Objective-C objects in a Rust-backed Rc/Refcell combo. This in general makes understanding reference counting/storage more digestable when reading through the codebase and leans more on Rust to do its thing than the Objective-C runtime. - Most widgets that need to implement `Layout` now only need to provide a slot for running a handler with the underlying node. - Further documentation work ongoing.
124 lines
4.4 KiB
Rust
124 lines
4.4 KiB
Rust
//! Utils is a dumping ground for various methods that don't really have a particular module they
|
|
//! belong to. These are typically internal, and if you rely on them... well, don't be surprised if
|
|
//! they go away one day.
|
|
|
|
use core_graphics::base::CGFloat;
|
|
|
|
use objc::{class, msg_send, sel, sel_impl};
|
|
|
|
use objc::{Encode, Encoding};
|
|
use objc::runtime::Object;
|
|
use objc_id::ShareId;
|
|
|
|
use crate::foundation::{id, BOOL, YES, NO};
|
|
|
|
mod cell_factory;
|
|
pub use cell_factory::CellFactory;
|
|
|
|
pub mod os;
|
|
pub mod properties;
|
|
|
|
/// A generic trait that's used throughout multiple different controls in this framework - acts as
|
|
/// a guard for whether something is a (View|Window|etc)Controller.
|
|
pub trait Controller {
|
|
/// Returns the underlying Objective-C object.
|
|
fn get_backing_node(&self) -> ShareId<Object>;
|
|
}
|
|
|
|
/// Utility method for taking a pointer and grabbing the corresponding delegate in Rust. This is
|
|
/// theoretically safe:
|
|
///
|
|
/// - The object (`this`) is owned by the wrapping component (e.g, a `Window`). It's released when
|
|
/// the `Window` is released.
|
|
/// - The only other place where you can retrieve a `Window` (or such control) is in the respective
|
|
/// delegate `did_load()` method, where you're passed one. This variant never includes the
|
|
/// delegate.
|
|
/// - Thus, provided the root object still exists, this pointer should be valid (root objects Box
|
|
/// them, so they ain't movin').
|
|
/// - The way this _could_ fail would be if the programmer decides to clone their `Window` or such
|
|
/// object deeper into the stack (or elsewhere in general). This is why we don't allow them to be
|
|
/// cloned, though.
|
|
///
|
|
/// This is, like much in this framework, subject to revision pending more thorough testing and
|
|
/// checking.
|
|
pub fn load<'a, T>(this: &'a Object, ptr_name: &str) -> &'a T {
|
|
unsafe {
|
|
let ptr: usize = *this.get_ivar(ptr_name);
|
|
let obj = ptr as *const T;
|
|
&*obj
|
|
}
|
|
}
|
|
|
|
/// Asynchronously execute a callback on the main thread via Grand Central Dispatch.
|
|
pub fn async_main_thread<F>(method: F)
|
|
where
|
|
F: Fn() + Send + 'static
|
|
{
|
|
let queue = dispatch::Queue::main();
|
|
queue.exec_async(method);
|
|
}
|
|
|
|
/// Synchronously execute a callback on the main thread via Grand Central Dispatch.
|
|
pub fn sync_main_thread<F>(method: F)
|
|
where
|
|
F: Fn() + Send + 'static
|
|
{
|
|
let queue = dispatch::Queue::main();
|
|
queue.exec_sync(method);
|
|
}
|
|
|
|
/// Upstream core graphics does not implement Encode for certain things, so we wrap them here -
|
|
/// these are only used in reading certain types passed to us from some delegate methods.
|
|
#[repr(C)]
|
|
#[derive(Clone, Copy, Debug, Default, PartialEq)]
|
|
pub struct CGSize {
|
|
/// The width of this size.
|
|
pub width: CGFloat,
|
|
|
|
/// The height of this size.
|
|
pub height: CGFloat,
|
|
}
|
|
|
|
impl CGSize {
|
|
/// Create and return a new `CGSize`.
|
|
pub fn new(width: CGFloat, height: CGFloat) -> Self {
|
|
CGSize { width, height }
|
|
}
|
|
|
|
/// Create and return a `CGSizeZero` equivalent.
|
|
pub fn zero() -> Self {
|
|
CGSize { width: 0., height: 0. }
|
|
}
|
|
}
|
|
|
|
unsafe impl Encode for CGSize {
|
|
/// Adds support for CGSize Objective-C encoding.
|
|
fn encode() -> Encoding {
|
|
let encoding = format!("{{CGSize={}{}}}",
|
|
CGFloat::encode().as_str(),
|
|
CGFloat::encode().as_str()
|
|
);
|
|
|
|
unsafe { Encoding::from_str(&encoding) }
|
|
}
|
|
}
|
|
|
|
/// A helper method for ensuring that Cocoa is running in multi-threaded mode.
|
|
///
|
|
/// Why do we need this? According to Apple, if you're going to make use of standard POSIX threads,
|
|
/// you need to, before creating and using a POSIX thread, first create and immediately detach a
|
|
/// `NSThread`. This ensures that Cocoa utilizes proper locking in certain places where it might
|
|
/// not be doing so for performance reasons.
|
|
///
|
|
/// In general, you should aim to just start all of your work inside of your `AppDelegate` methods.
|
|
/// There are some cases where you might want to do things before that, though - and if you spawn a
|
|
/// thread there, just call this first... otherwise you may have some unexpected issues later on.
|
|
///
|
|
/// _(This is called inside the `App::new()` construct for you already, so as long as you're doing
|
|
/// nothing before your `AppDelegate`, you can pay this no mind)._
|
|
pub fn activate_cocoa_multithreading() {
|
|
unsafe {
|
|
let thread: id = msg_send![class!(NSThread), new];
|
|
let _: () = msg_send![thread, start];
|
|
}
|
|
}
|