Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(macOS): release ns_submenu, ns_menu_item manually #122

Merged
merged 5 commits into from
Sep 18, 2023
Merged

fix(macOS): release ns_submenu, ns_menu_item manually #122

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6898aa0
fix(macOS): remove autorelease from ns_submenu to avoid over release
pewsheen Sep 14, 2023
f2dc7da
refactor(macOS): implement NsMenuItemRef to release NSMenuItem manually
pewsheen Sep 14, 2023
c00a4a3
fix: typo
pewsheen Sep 14, 2023
9719f2e
chnage file
amrbashir Sep 18, 2023
197be68
Update separator-autorelease.md
amrbashir Sep 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changes/separator-autorelease.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"muda": patch
---

On macOS, fix menu crash due to a double freeing the underlying NsMenu.
57 changes: 34 additions & 23 deletions src/platform_impl/macos/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,17 @@ impl Drop for NsMenuRef {
}
}

#[derive(Debug, Clone)]
struct NsMenuItemRef(id);

impl Drop for NsMenuItemRef {
fn drop(&mut self) {
unsafe {
let _: () = msg_send![self.0, release];
}
}
}

#[derive(Debug)]
pub struct Menu {
id: MenuId,
Expand Down Expand Up @@ -185,7 +196,7 @@ pub struct MenuChild {
text: String,
enabled: bool,

ns_menu_items: HashMap<u32, Vec<id>>,
ns_menu_items: HashMap<u32, Vec<NsMenuItemRef>>,

// menu item fields
accelerator: Option<Accelerator>,
Expand Down Expand Up @@ -416,9 +427,9 @@ impl MenuChild {
unsafe {
let title = NSString::alloc(nil).init_str(&self.text).autorelease();
for ns_items in self.ns_menu_items.values() {
for &ns_item in ns_items {
let () = msg_send![ns_item, setTitle: title];
let ns_submenu: id = msg_send![ns_item, submenu];
for ns_item in ns_items {
let () = msg_send![ns_item.0, setTitle: title];
let ns_submenu: id = msg_send![ns_item.0, submenu];
if ns_submenu != nil {
let () = msg_send![ns_submenu, setTitle: title];
}
Expand All @@ -434,9 +445,9 @@ impl MenuChild {
pub fn set_enabled(&mut self, enabled: bool) {
self.enabled = enabled;
for ns_items in self.ns_menu_items.values() {
for &ns_item in ns_items {
for ns_item in ns_items {
unsafe {
let () = msg_send![ns_item, setEnabled: if enabled { YES } else { NO }];
let () = msg_send![ns_item.0, setEnabled: if enabled { YES } else { NO }];
}
}
}
Expand All @@ -461,10 +472,10 @@ impl MenuChild {
.unwrap_or_else(NSEventModifierFlags::empty);

for ns_items in self.ns_menu_items.values() {
for &ns_item in ns_items {
for ns_item in ns_items {
unsafe {
let _: () = msg_send![ns_item, setKeyEquivalent: key_equivalent];
ns_item.setKeyEquivalentModifierMask_(modifier_mask);
let _: () = msg_send![ns_item.0, setKeyEquivalent: key_equivalent];
ns_item.0.setKeyEquivalentModifierMask_(modifier_mask);
}
}
}
Expand All @@ -485,9 +496,9 @@ impl MenuChild {
pub fn set_checked(&mut self, checked: bool) {
self.checked = checked;
for ns_items in self.ns_menu_items.values() {
for &ns_item in ns_items {
for ns_item in ns_items {
unsafe {
let () = msg_send![ns_item, setState: checked as u32];
let () = msg_send![ns_item.0, setState: checked as u32];
}
}
}
Expand All @@ -500,8 +511,8 @@ impl MenuChild {
self.icon = icon.clone();
self.native_icon = None;
for ns_items in self.ns_menu_items.values() {
for &ns_item in ns_items {
menuitem_set_icon(ns_item, icon.as_ref());
for ns_item in ns_items {
menuitem_set_icon(ns_item.0, icon.as_ref());
}
}
}
Expand All @@ -510,8 +521,8 @@ impl MenuChild {
self.native_icon = icon;
self.icon = None;
for ns_items in self.ns_menu_items.values() {
for &ns_item in ns_items {
menuitem_set_native_icon(ns_item, icon);
for ns_item in ns_items {
menuitem_set_native_icon(ns_item.0, icon);
}
}
}
Expand Down Expand Up @@ -668,8 +679,8 @@ impl MenuChild {
let ns_submenu: id;

unsafe {
ns_menu_item = NSMenuItem::alloc(nil).autorelease();
ns_submenu = NSMenu::alloc(nil).autorelease();
ns_menu_item = NSMenuItem::alloc(nil);
ns_submenu = NSMenu::alloc(nil);

let title = NSString::alloc(nil).init_str(&self.text).autorelease();
let () = msg_send![ns_submenu, setTitle: title];
Expand Down Expand Up @@ -698,7 +709,7 @@ impl MenuChild {
self.ns_menu_items
.entry(menu_id)
.or_insert_with(Vec::new)
.push(ns_menu_item);
.push(NsMenuItemRef(ns_menu_item));

Ok(ns_menu_item)
}
Expand All @@ -725,7 +736,7 @@ impl MenuChild {
self.ns_menu_items
.entry(menu_id)
.or_insert_with(Vec::new)
.push(ns_menu_item);
.push(NsMenuItemRef(ns_menu_item));

Ok(ns_menu_item)
}
Expand Down Expand Up @@ -762,7 +773,7 @@ impl MenuChild {
self.ns_menu_items
.entry(menu_id)
.or_insert_with(Vec::new)
.push(ns_menu_item);
.push(NsMenuItemRef(ns_menu_item));

Ok(ns_menu_item)
}
Expand Down Expand Up @@ -792,7 +803,7 @@ impl MenuChild {
self.ns_menu_items
.entry(menu_id)
.or_insert_with(Vec::new)
.push(ns_menu_item);
.push(NsMenuItemRef(ns_menu_item));

Ok(ns_menu_item)
}
Expand Down Expand Up @@ -825,7 +836,7 @@ impl MenuChild {
self.ns_menu_items
.entry(menu_id)
.or_insert_with(Vec::new)
.push(ns_menu_item);
.push(NsMenuItemRef(ns_menu_item));

Ok(ns_menu_item)
}
Expand Down Expand Up @@ -1025,7 +1036,7 @@ fn create_ns_menu_item(
ns_menu_item.initWithTitle_action_keyEquivalent_(title, selector, key_equivalent);
ns_menu_item.setKeyEquivalentModifierMask_(modifier_mask);

Ok(ns_menu_item.autorelease())
Ok(ns_menu_item)
}
}

Expand Down
Loading