gecko-dev/widget/cocoa/NativeMenuMac.h
Markus Stange 43e5d7e69f Bug 1707598 - When opening a new menu just after closing an old menu, make sure we exit the nested event loop for the old NSMenu before we ask the new NSMenu to open. r=harry
On CI, where we open and close menu items in quick succession, we sometimes got
into a state where the new menu was opened while we were still in the old menu's
nested event loop. So we had the following sequence of events:

```
 - old menu +[NSMenu popUpContextMenu:withEvent:forView:]
   - nested event loop for old menu
     - old menu -[NSMenu cancelTrackingWithoutAnimation]
     - new menu +[NSMenu popUpContextMenu:withEvent:forView:]
       - nested event loop for new menu
         - new menu -[NSMenu cancelTrackingWithoutAnimation]
     - new menu's event loop is exited, but old menu's event loop remains on the
       stack
     - shutdown hang here
```

MOZMenuOpeningCoordinator makes sure that +[NSMenu popUpContextMenu:withEvent:forView:]
is always called in sequence, never in a nested fashion.

Differential Revision: https://phabricator.services.mozilla.com/D113373
2021-04-26 20:57:20 +00:00

92 lines
2.8 KiB
C++

/* -*- Mode: c++; tab-width: 2; indent-tabs-mode: nil; -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef NativeMenuMac_h
#define NativeMenuMac_h
#include "mozilla/widget/NativeMenu.h"
#include "nsMenuItemIconX.h"
#include "nsMenuX.h"
class nsIContent;
class nsMenuGroupOwnerX;
namespace mozilla {
namespace dom {
class Element;
}
namespace widget {
class NativeMenuMac : public NativeMenu,
public nsMenuItemIconX::Listener,
public nsMenuX::Observer {
public:
explicit NativeMenuMac(mozilla::dom::Element* aElement);
// NativeMenu
void ShowAsContextMenu(const mozilla::DesktopPoint& aPosition) override;
bool Close() override;
void ActivateItem(dom::Element* aItemElement, Modifiers aModifiers, int16_t aButton,
ErrorResult& aRv) override;
void OpenSubmenu(dom::Element* aMenuElement) override;
void CloseSubmenu(dom::Element* aMenuElement) override;
RefPtr<dom::Element> Element() override;
void AddObserver(NativeMenu::Observer* aObserver) override {
mObservers.AppendElement(aObserver);
}
void RemoveObserver(NativeMenu::Observer* aObserver) override {
mObservers.RemoveElement(aObserver);
}
// nsMenuItemIconX::Listener
void IconUpdated() override;
// nsMenuX::Observer
void OnMenuWillOpen(mozilla::dom::Element* aPopupElement) override;
void OnMenuDidOpen(mozilla::dom::Element* aPopupElement) override;
void OnMenuClosed(mozilla::dom::Element* aPopupElement) override;
NSMenu* NativeNSMenu() { return mMenu ? mMenu->NativeNSMenu() : nil; }
void MenuWillOpen();
// Returns whether a menu item was found at the specified path.
bool ActivateNativeMenuItemAt(const nsAString& aIndexString);
void ForceUpdateNativeMenuAt(const nsAString& aIndexString);
void Dump();
// If this menu is the menu of a system status bar item (NSStatusItem),
// let the menu know about the status item so that it can propagate
// any icon changes to the status item.
void SetContainerStatusBarItem(NSStatusItem* aItem);
protected:
virtual ~NativeMenuMac();
// Find the deepest nsMenuX which contains aElement, only descending into open
// menus.
// Returns nullptr if the element was not found or if the menus on the path
// were not all open.
RefPtr<nsMenuX> GetOpenMenuContainingElement(dom::Element* aElement);
RefPtr<dom::Element> mElement;
RefPtr<nsMenuGroupOwnerX> mMenuGroupOwner;
RefPtr<nsMenuX> mMenu;
nsTArray<NativeMenu::Observer*> mObservers;
NSStatusItem* mContainerStatusBarItem;
// Non-zero after a call to ShowAsContextMenu. Stores the handle from the
// MOZMenuOpeningCoordinator.
NSInteger mOpeningHandle = 0;
};
} // namespace widget
} // namespace mozilla
#endif