Skip to content

Commit

Permalink
Fix macos memory leaks (#2739)
Browse files Browse the repository at this point in the history
* Use a weak reference from WinitView to WinitWindow

* Allow patched objc2 version

* Add changelog entry
  • Loading branch information
madsmtm authored and kchibisov committed Mar 16, 2023
1 parent d102c21 commit dec45bb
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 6 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ And please only add new entries to the top of this list, right below the `# Unre

# Unreleased

- Fix macOS memory leaks.

# 0.28.2

- Implement `HasRawDisplayHandle` for `EventLoop`.
Expand Down
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ ndk = "0.7.0"

[target.'cfg(any(target_os = "ios", target_os = "macos"))'.dependencies]
core-foundation = "0.9.3"
objc2 = "=0.3.0-beta.3"
objc2 = ">=0.3.0-beta.3, <0.3.0-beta.4" # Allow `0.3.0-beta.3.patch-leaks`

[target.'cfg(target_os = "macos")'.dependencies]
core-graphics = "0.22.3"
Expand Down
14 changes: 9 additions & 5 deletions src/platform_impl/macos/view.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ use objc2::foundation::{
NSArray, NSAttributedString, NSAttributedStringKey, NSCopying, NSMutableAttributedString,
NSObject, NSPoint, NSRange, NSRect, NSSize, NSString, NSUInteger,
};
use objc2::rc::{Id, Owned, Shared};
use objc2::rc::{Id, Owned, Shared, WeakId};
use objc2::runtime::{Object, Sel};
use objc2::{class, declare_class, msg_send, msg_send_id, sel, ClassType};

Expand Down Expand Up @@ -136,7 +136,8 @@ declare_class!(
#[derive(Debug)]
#[allow(non_snake_case)]
pub(super) struct WinitView {
_ns_window: IvarDrop<Id<WinitWindow, Shared>>,
// Weak reference because the window keeps a strong reference to the view
_ns_window: IvarDrop<Box<WeakId<WinitWindow>>>,
pub(super) state: IvarDrop<Box<ViewState>>,
marked_text: IvarDrop<Id<NSMutableAttributedString, Owned>>,
accepts_first_mouse: bool,
Expand Down Expand Up @@ -167,7 +168,10 @@ declare_class!(
forward_key_to_app: false,
};

Ivar::write(&mut this._ns_window, window.retain());
Ivar::write(
&mut this._ns_window,
Box::new(WeakId::new(&window.retain())),
);
Ivar::write(&mut this.state, Box::new(state));
Ivar::write(&mut this.marked_text, NSMutableAttributedString::new());
Ivar::write(&mut this.accepts_first_mouse, accepts_first_mouse);
Expand Down Expand Up @@ -873,11 +877,11 @@ impl WinitView {
// (which is incompatible with `frameDidChange:`)
//
// unsafe { msg_send_id![self, window] }
(*self._ns_window).clone()
self._ns_window.load().expect("view to have a window")
}

fn window_id(&self) -> WindowId {
WindowId(self._ns_window.id())
WindowId(self.window().id())
}

fn queue_event(&self, event: WindowEvent<'static>) {
Expand Down

0 comments on commit dec45bb

Please sign in to comment.