MacViews: Run native Cocoa context menus to support Services.

ui/views/controls/menu/menu_runner.cc

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "ui/views/controls/menu/menu_runner.h"
 
-#include <set>
-
-#include "base/memory/weak_ptr.h"
-#include "ui/base/models/menu_model.h"
-#include "ui/views/controls/button/menu_button.h"
-#include "ui/views/controls/menu/menu_controller.h"
-#include "ui/views/controls/menu/menu_controller_delegate.h"
 #include "ui/views/controls/menu/menu_delegate.h"
 #include "ui/views/controls/menu/menu_item_view.h"
 #include "ui/views/controls/menu/menu_model_adapter.h"
 #include "ui/views/controls/menu/menu_runner_handler.h"
-#include "ui/views/widget/widget.h"
-
-#if defined(OS_WIN)
-#include "base/win/win_util.h"
-#endif
+#include "ui/views/controls/menu/menu_runner_impl.h"
 
 namespace views {
 
-namespace internal {
-
-// Manages the menu. To destroy a MenuRunnerImpl invoke Release(). Release()
-// deletes immediately if the menu isn't showing. If the menu is showing
-// Release() cancels the menu and when the nested RunMenuAt() call returns
-// deletes itself and the menu.
-class MenuRunnerImpl : public internal::MenuControllerDelegate {
- public:
-  explicit MenuRunnerImpl(MenuItemView* menu);
-
-  MenuItemView* menu() { return menu_; }
-
-  bool running() const { return running_; }
-
-  // See description above class for details.
-  void Release();
-
-  // Runs the menu.
-  MenuRunner::RunResult RunMenuAt(Widget* parent,
-                                  MenuButton* button,
-                                  const gfx::Rect& bounds,
-                                  MenuAnchorPosition anchor,
-                                  int32 types) WARN_UNUSED_RESULT;
-
-  void Cancel();
-
-  // Returns the time from the event which closed the menu - or 0.
-  base::TimeDelta closing_event_time() const;
-
-  // MenuControllerDelegate:
-  virtual void DropMenuClosed(NotifyType type, MenuItemView* menu) OVERRIDE;
-  virtual void SiblingMenuCreated(MenuItemView* menu) OVERRIDE;
-
- private:
-  virtual ~MenuRunnerImpl();
-
-  // Cleans up after the menu is no longer showing. |result| is the menu that
-  // the user selected, or NULL if nothing was selected.
-  MenuRunner::RunResult MenuDone(MenuItemView* result, int mouse_event_flags);
-
-  // Returns true if mnemonics should be shown in the menu.
-  bool ShouldShowMnemonics(MenuButton* button);
-
-  // The menu. We own this. We don't use scoped_ptr as the destructor is
-  // protected and we're a friend.
-  MenuItemView* menu_;
-
-  // Any sibling menus. Does not include |menu_|. We own these too.
-  std::set<MenuItemView*> sibling_menus_;
-
-  // Created and set as the delegate of the MenuItemView if Release() is
-  // invoked.  This is done to make sure the delegate isn't notified after
-  // Release() is invoked. We do this as we assume the delegate is no longer
-  // valid if MenuRunner has been deleted.
-  scoped_ptr<MenuDelegate> empty_delegate_;
-
-  // Are we in run waiting for it to return?
-  bool running_;
-
-  // Set if |running_| and Release() has been invoked.
-  bool delete_after_run_;
-
-  // Are we running for a drop?
-  bool for_drop_;
-
-  // The controller.
-  MenuController* controller_;
-
-  // Do we own the controller?
-  bool owns_controller_;
-
-  // The timestamp of the event which closed the menu - or 0.
-  base::TimeDelta closing_event_time_;
-
-  // Used to detect deletion of |this| when notifying delegate of success.
-  base::WeakPtrFactory<MenuRunnerImpl> weak_factory_;
-
-  DISALLOW_COPY_AND_ASSIGN(MenuRunnerImpl);
-};
-
-MenuRunnerImpl::MenuRunnerImpl(MenuItemView* menu)
-    : menu_(menu),
-      running_(false),
-      delete_after_run_(false),
-      for_drop_(false),
-      controller_(NULL),
-      owns_controller_(false),
-      closing_event_time_(base::TimeDelta()),
-      weak_factory_(this) {
+MenuRunner::MenuRunner(ui::MenuModel* menu_model)
+    : menu_model_(menu_model), menu_view_(NULL), holder_(NULL) {

[tapted, 2014/06/25 08:30:28]

What are the prospects of refactoring call sites so that `types` is moved to a
MenuRunner constructor argument, or into the menu model itself?


Then I think you can still initialize holder_ here

Something like

holder_(MenuRunnerImplInterface::Create(menu_model, NULL))

and in the other constructor

holder_(MenuRunnerImplInterface::Create(NULL, menu_view))


then with that stuff from my earlier comment - something like

MenuRunnerImplInterface* MenuRunnerImplInterface::Create(.., ..) {
  MenuRunnerImplInterface* holder = NULL;
  if (menu_model)
    holder = MenuRunnerImplInterface::CreateForType(menu_model_, type);

  if (holder)
    return holder;

  /* create adapter */
  return new MenuRunnerImplInterface(things);
}



but then if there's a caller that uses the same MenuRunner for both context
menus and something else we might be breaking a valid use case. But I think the
lazy-holder_-init approach would be breaking that anyway, so better to make it
explicit.

[Andre, 2014/06/27 01:18:08]

It's a lot of changes, but looks doable.
I've uploaded a patch and sending it to the trybot to check if I got them all.
I also made MenuRunnerImplAdapter to keep the adaptation nicely separated.

 }
 
-void MenuRunnerImpl::Release() {
-  if (running_) {
-    if (delete_after_run_)
-      return;  // We already canceled.
-
-    // The menu is running a nested message loop, we can't delete it now
-    // otherwise the stack would be in a really bad state (many frames would
-    // have deleted objects on them). Instead cancel the menu, when it returns
-    // Holder will delete itself.
-    delete_after_run_ = true;
-
-    // Swap in a different delegate. That way we know the original MenuDelegate
-    // won't be notified later on (when it's likely already been deleted).
-    if (!empty_delegate_.get())
-      empty_delegate_.reset(new MenuDelegate());
-    menu_->set_delegate(empty_delegate_.get());
-
-    DCHECK(controller_);
-    // Release is invoked when MenuRunner is destroyed. Assume this is happening
-    // because the object referencing the menu has been destroyed and the menu
-    // button is no longer valid.
-    controller_->Cancel(MenuController::EXIT_DESTROYED);
-  } else {
-    delete this;
-  }
-}
-
-MenuRunner::RunResult MenuRunnerImpl::RunMenuAt(Widget* parent,
-                                                MenuButton* button,
-                                                const gfx::Rect& bounds,
-                                                MenuAnchorPosition anchor,
-                                                int32 types) {
-  closing_event_time_ = base::TimeDelta();
-  if (running_) {
-    // Ignore requests to show the menu while it's already showing. MenuItemView
-    // doesn't handle this very well (meaning it crashes).
-    return MenuRunner::NORMAL_EXIT;
-  }
-
-  MenuController* controller = MenuController::GetActiveInstance();
-  if (controller) {
-    if ((types & MenuRunner::IS_NESTED) != 0) {
-      if (!controller->IsBlockingRun()) {
-        controller->CancelAll();
-        controller = NULL;
-      }
-    } else {
-      // There's some other menu open and we're not nested. Cancel the menu.
-      controller->CancelAll();
-      if ((types & MenuRunner::FOR_DROP) == 0) {
-        // We can't open another menu, otherwise the message loop would become
-        // twice nested. This isn't necessarily a problem, but generally isn't
-        // expected.
-        return MenuRunner::NORMAL_EXIT;
-      }
-      // Drop menus don't block the message loop, so it's ok to create a new
-      // MenuController.
-      controller = NULL;
-    }
-  }
-
-  running_ = true;
-  for_drop_ = (types & MenuRunner::FOR_DROP) != 0;
-  bool has_mnemonics = (types & MenuRunner::HAS_MNEMONICS) != 0 && !for_drop_;
-  owns_controller_ = false;
-  if (!controller) {
-    // No menus are showing, show one.
-    ui::NativeTheme* theme = parent ? parent->GetNativeTheme() :
-        ui::NativeTheme::instance();
-    controller = new MenuController(theme, !for_drop_, this);
-    owns_controller_ = true;
-  }
-  controller->set_is_combobox((types & MenuRunner::COMBOBOX) != 0);
-  controller_ = controller;
-  menu_->set_controller(controller_);
-  menu_->PrepareForRun(owns_controller_,
-                       has_mnemonics,
-                       !for_drop_ && ShouldShowMnemonics(button));
-
-  // Run the loop.
-  int mouse_event_flags = 0;
-  MenuItemView* result = controller->Run(parent, button, menu_, bounds, anchor,
-                                        (types & MenuRunner::CONTEXT_MENU) != 0,
-                                         &mouse_event_flags);
-  // Get the time of the event which closed this menu.
-  closing_event_time_ = controller->closing_event_time();
-  if (for_drop_) {
-    // Drop menus return immediately. We finish processing in DropMenuClosed.
-    return MenuRunner::NORMAL_EXIT;
-  }
-  return MenuDone(result, mouse_event_flags);
-}
-
-void MenuRunnerImpl::Cancel() {
-  if (running_)
-    controller_->Cancel(MenuController::EXIT_ALL);
-}
-
-base::TimeDelta MenuRunnerImpl::closing_event_time() const {
-  return closing_event_time_;
-}
-
-void MenuRunnerImpl::DropMenuClosed(NotifyType type, MenuItemView* menu) {
-  MenuDone(NULL, 0);
-
-  if (type == NOTIFY_DELEGATE && menu->GetDelegate()) {
-    // Delegate is null when invoked from the destructor.
-    menu->GetDelegate()->DropMenuClosed(menu);
-  }
-}
-
-void MenuRunnerImpl::SiblingMenuCreated(MenuItemView* menu) {
-  if (menu != menu_ && sibling_menus_.count(menu) == 0)
-    sibling_menus_.insert(menu);
-}
-
-MenuRunnerImpl::~MenuRunnerImpl() {
-  delete menu_;
-  for (std::set<MenuItemView*>::iterator i = sibling_menus_.begin();
-       i != sibling_menus_.end(); ++i)
-    delete *i;
-}
-
-MenuRunner::RunResult MenuRunnerImpl::MenuDone(MenuItemView* result,
-                                               int mouse_event_flags) {
-  menu_->RemoveEmptyMenus();
-  menu_->set_controller(NULL);
-
-  if (owns_controller_) {
-    // We created the controller and need to delete it.
-    delete controller_;
-    owns_controller_ = false;
-  }
-  controller_ = NULL;
-  // Make sure all the windows we created to show the menus have been
-  // destroyed.
-  menu_->DestroyAllMenuHosts();
-  if (delete_after_run_) {
-    delete this;
-    return MenuRunner::MENU_DELETED;
-  }
-  running_ = false;
-  if (result && menu_->GetDelegate()) {
-    // Executing the command may also delete this.
-    base::WeakPtr<MenuRunnerImpl> ref(weak_factory_.GetWeakPtr());
-    menu_->GetDelegate()->ExecuteCommand(result->GetCommand(),
-                                         mouse_event_flags);
-    if (!ref)
-      return MenuRunner::MENU_DELETED;
-  }
-  return MenuRunner::NORMAL_EXIT;
-}
-
-bool MenuRunnerImpl::ShouldShowMnemonics(MenuButton* button) {
-  // Show mnemonics if the button has focus or alt is pressed.
-  bool show_mnemonics = button ? button->HasFocus() : false;
-#if defined(OS_WIN)
-  // This is only needed on Windows.
-  if (!show_mnemonics)
-    show_mnemonics = base::win::IsAltPressed();
-#endif
-  return show_mnemonics;
-}
-
-}  // namespace internal
-
-MenuRunner::MenuRunner(ui::MenuModel* menu_model)
-    : menu_model_adapter_(new MenuModelAdapter(menu_model)),
-      holder_(new internal::MenuRunnerImpl(menu_model_adapter_->CreateMenu())) {
-}
-
-MenuRunner::MenuRunner(MenuItemView* menu)
-    : holder_(new internal::MenuRunnerImpl(menu)) {
+MenuRunner::MenuRunner(MenuItemView* menu_view)
+    : menu_model_(NULL), menu_view_(menu_view), holder_(NULL) {
 }
 
 MenuRunner::~MenuRunner() {
-  holder_->Release();
+  if (holder_)
+    holder_->Release();
 }
 
 MenuItemView* MenuRunner::GetMenu() {
-  return holder_->menu();
+  return menu_view_;
 }
 
 MenuRunner::RunResult MenuRunner::RunMenuAt(Widget* parent,
                                             MenuButton* button,
                                             const gfx::Rect& bounds,
                                             MenuAnchorPosition anchor,
                                             ui::MenuSourceType source_type,
                                             int32 types) {
   if (runner_handler_.get()) {
     return runner_handler_->RunMenuAt(parent, button, bounds, anchor,
@@ skipping 17 matching lines @@
         break;
       case ui::MENU_SOURCE_TOUCH:
       case ui::MENU_SOURCE_TOUCH_EDIT_MENU:
         anchor = MENU_ANCHOR_BOTTOMCENTER;
         break;
       default:
         break;
     }
   }
 
+  if (!holder_)
+    holder_ = CreateImpl(types);
   return holder_->RunMenuAt(parent, button, bounds, anchor, types);
 }
 
 bool MenuRunner::IsRunning() const {
-  return holder_->running();
+  return holder_ && holder_->running();
 }
 
 void MenuRunner::Cancel() {
-  holder_->Cancel();
+  if (holder_)
+    holder_->Cancel();
 }
 
 base::TimeDelta MenuRunner::closing_event_time() const {
-  return holder_->closing_event_time();
+  return holder_ ? holder_->closing_event_time() : base::TimeDelta();
 }
 
 void MenuRunner::SetRunnerHandler(
     scoped_ptr<MenuRunnerHandler> runner_handler) {
   runner_handler_ = runner_handler.Pass();
 }
 
+internal::MenuRunnerImplInterface* MenuRunner::CreateImpl(int32 types) {
+#if defined(OS_MACOSX)
+  if (types & CONTEXT_MENU) {
+    DCHECK(!menu_view_);
+    return CreateNativeImpl();
+  }
+#endif
+
+  if (!menu_view_) {
+    DCHECK(menu_model_);
+    menu_model_adapter_.reset(new MenuModelAdapter(menu_model_));
+    menu_view_ = menu_model_adapter_->CreateMenu();
+  }
+  return new internal::MenuRunnerImpl(menu_view_);
+}
+
+#if !defined(OS_MACOSX)
+internal::MenuRunnerImplInterface* MenuRunner::CreateNativeImpl() {
+  NOTIMPLEMENTED();
+  return NULL;
+}
+#endif
+
 }  // namespace views