Use a ui::MenuModel in views::Combobox

ui/views/controls/combobox/combobox_unittest.cc

 // Copyright 2013 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/combobox/combobox.h"
 
 #include <set>
 
 #include "base/basictypes.h"
 #include "base/strings/utf_string_conversions.h"
 #include "ui/base/ime/input_method.h"
 #include "ui/base/ime/text_input_client.h"
 #include "ui/base/models/combobox_model.h"
+#include "ui/base/models/menu_model.h"
 #include "ui/events/event.h"
 #include "ui/events/event_constants.h"
 #include "ui/events/event_utils.h"
 #include "ui/events/keycodes/keyboard_codes.h"
 #include "ui/views/controls/combobox/combobox_listener.h"
 #include "ui/views/controls/menu/menu_runner.h"
 #include "ui/views/controls/menu/menu_runner_handler.h"
 #include "ui/views/test/menu_runner_test_api.h"
 #include "ui/views/test/views_test_base.h"
 #include "ui/views/widget/widget.h"
 
 using base::ASCIIToUTF16;
 
 namespace views {
+namespace test {
+
+class ComboboxTestApi {
+ public:
+  explicit ComboboxTestApi(Combobox* combobox) : combobox_(combobox) {}
+
+  void PerformActionAt(int index) { menu_model()->ActivatedAt(index); }
+  void InstallTestMenuRunner(int* menu_show_count);
+
+  gfx::Size content_size() { return combobox_->content_size_; }
+  ui::MenuModel* menu_model() { return combobox_->menu_model_adapter_.get(); }
+
+ private:
+  Combobox* combobox_;
+
+  DISALLOW_COPY_AND_ASSIGN(ComboboxTestApi);
+};
+
+}  // namespace test
+
+using test::ComboboxTestApi;
 
 namespace {
 
 // An dummy implementation of MenuRunnerHandler to check if the dropdown menu is
 // shown or not.
 class TestMenuRunnerHandler : public MenuRunnerHandler {
  public:
-  TestMenuRunnerHandler() : executed_(false) {}
-
-  bool executed() const { return executed_; }
-
+  explicit TestMenuRunnerHandler(int* show_counter)
+      : show_counter_(show_counter) {}
   MenuRunner::RunResult RunMenuAt(Widget* parent,
                                   MenuButton* button,
                                   const gfx::Rect& bounds,
                                   MenuAnchorPosition anchor,
                                   ui::MenuSourceType source_type,
                                   int32 types) override {
-    executed_ = true;
+    *show_counter_ += 1;
     return MenuRunner::NORMAL_EXIT;
   }
 
  private:
-  bool executed_;
+  int* show_counter_;
 
   DISALLOW_COPY_AND_ASSIGN(TestMenuRunnerHandler);
 };
 
 // A wrapper of Combobox to intercept the result of OnKeyPressed() and
 // OnKeyReleased() methods.
 class TestCombobox : public Combobox {
  public:
   explicit TestCombobox(ui::ComboboxModel* model)
       : Combobox(model),
@@ skipping 25 matching lines @@
 
   DISALLOW_COPY_AND_ASSIGN(TestCombobox);
 };
 
 // A concrete class is needed to test the combobox.
 class TestComboboxModel : public ui::ComboboxModel {
  public:
   TestComboboxModel() {}
   ~TestComboboxModel() override {}
 
-  static const int kItemCount = 10;
+  enum { kItemCount = 10 };
 
   // ui::ComboboxModel:
-  int GetItemCount() const override { return kItemCount; }
+  int GetItemCount() const override { return item_count_; }
   base::string16 GetItemAt(int index) override {
     if (IsItemSeparatorAt(index)) {
       NOTREACHED();
       return ASCIIToUTF16("SEPARATOR");
     }
     return ASCIIToUTF16(index % 2 == 0 ? "PEANUT BUTTER" : "JELLY");
   }
   bool IsItemSeparatorAt(int index) override {
     return separators_.find(index) != separators_.end();
   }
 
   int GetDefaultIndex() const override {
     // Return the first index that is not a separator.
     for (int index = 0; index < kItemCount; ++index) {
       if (separators_.find(index) == separators_.end())
         return index;
     }
     NOTREACHED();
     return 0;
   }
 
   void SetSeparators(const std::set<int>& separators) {
     separators_ = separators;
   }
 
+  void set_item_count(int item_count) { item_count_ = item_count; }
+
  private:
   std::set<int> separators_;
+  int item_count_ = kItemCount;
 
   DISALLOW_COPY_AND_ASSIGN(TestComboboxModel);
 };
 
 // A combobox model which refers to a vector.
 class VectorComboboxModel : public ui::ComboboxModel {
  public:
   explicit VectorComboboxModel(std::vector<std::string>* values)
       : values_(values) {}
   ~VectorComboboxModel() override {}
 
+  void set_default_index(int default_index) { default_index_ = default_index; }
+
   // ui::ComboboxModel:
   int GetItemCount() const override { return (int)values_->size(); }
   base::string16 GetItemAt(int index) override {
     return ASCIIToUTF16(values_->at(index));
   }
   bool IsItemSeparatorAt(int index) override { return false; }
+  int GetDefaultIndex() const override { return default_index_; }
 
  private:
   std::vector<std::string>* values_;
+  int default_index_ = 0;
+
+  DISALLOW_COPY_AND_ASSIGN(VectorComboboxModel);
 };
 
 class EvilListener : public ComboboxListener {
  public:
   EvilListener() : deleted_(false) {}
   ~EvilListener() override{};
 
   // ComboboxListener:
   void OnPerformAction(Combobox* combobox) override {
     delete combobox;
@@ skipping 33 matching lines @@
  private:
   int perform_action_index_;
   int actions_performed_;
 
  private:
   DISALLOW_COPY_AND_ASSIGN(TestComboboxListener);
 };
 
 }  // namespace
 
+void ComboboxTestApi::InstallTestMenuRunner(int* menu_show_count) {
+  combobox_->menu_runner_.reset(
+      new MenuRunner(menu_model(), MenuRunner::COMBOBOX));
+  test::MenuRunnerTestAPI test_api(combobox_->menu_runner_.get());
+  test_api.SetMenuRunnerHandler(
+      make_scoped_ptr(new TestMenuRunnerHandler(menu_show_count)));
+}
+
 class ComboboxTest : public ViewsTestBase {
  public:
   ComboboxTest() : widget_(NULL), combobox_(NULL) {}
 
   void TearDown() override {
     if (widget_)
       widget_->Close();
     ViewsTestBase::TearDown();
   }
 
   void InitCombobox(const std::set<int>* separators) {
     model_.reset(new TestComboboxModel());
 
     if (separators)
       model_->SetSeparators(*separators);
 
     ASSERT_FALSE(combobox_);
     combobox_ = new TestCombobox(model_.get());
+    test_api_.reset(new ComboboxTestApi(combobox_));
     combobox_->set_id(1);
 
     widget_ = new Widget;
     Widget::InitParams params = CreateParams(Widget::InitParams::TYPE_POPUP);
     params.bounds = gfx::Rect(200, 200, 200, 200);
     widget_->Init(params);
     View* container = new View();
     widget_->SetContentsView(container);
     container->AddChildView(combobox_);
 
@@ skipping 27 matching lines @@
         ui::ET_MOUSE_RELEASED, point, point, ui::EventTimeForNow(),
         ui::EF_LEFT_MOUSE_BUTTON, ui::EF_LEFT_MOUSE_BUTTON);
     widget_->OnMouseEvent(&released_event);
   }
 
   // We need widget to populate wrapper class.
   Widget* widget_;
 
   // |combobox_| will be allocated InitCombobox() and then owned by |widget_|.
   TestCombobox* combobox_;
+  scoped_ptr<ComboboxTestApi> test_api_;
 
   // Combobox does not take ownership of the model, hence it needs to be scoped.
   scoped_ptr<TestComboboxModel> model_;
+
+ private:
+  DISALLOW_COPY_AND_ASSIGN(ComboboxTest);
 };
 
 TEST_F(ComboboxTest, KeyTest) {
   InitCombobox(NULL);
   SendKeyEvent(ui::VKEY_END);
   EXPECT_EQ(combobox_->selected_index() + 1, model_->GetItemCount());
   SendKeyEvent(ui::VKEY_HOME);
   EXPECT_EQ(combobox_->selected_index(), 0);
   SendKeyEvent(ui::VKEY_DOWN);
   SendKeyEvent(ui::VKEY_DOWN);
@@ skipping 200 matching lines @@
   EXPECT_EQ(0, combobox_->selected_index());
 }
 
 TEST_F(ComboboxTest, ListenerHandlesDelete) {
   TestComboboxModel model;
 
   // |combobox| will be deleted on change.
   TestCombobox* combobox = new TestCombobox(&model);
   scoped_ptr<EvilListener> evil_listener(new EvilListener());
   combobox->set_listener(evil_listener.get());
-  ASSERT_NO_FATAL_FAILURE(combobox->ExecuteCommand(2));
+  ASSERT_NO_FATAL_FAILURE(ComboboxTestApi(combobox).PerformActionAt(2));
   EXPECT_TRUE(evil_listener->deleted());
 
   // With STYLE_ACTION
   // |combobox| will be deleted on change.
   combobox = new TestCombobox(&model);
   evil_listener.reset(new EvilListener());
   combobox->set_listener(evil_listener.get());
   combobox->SetStyle(Combobox::STYLE_ACTION);
-  ASSERT_NO_FATAL_FAILURE(combobox->ExecuteCommand(2));
+  ASSERT_NO_FATAL_FAILURE(ComboboxTestApi(combobox).PerformActionAt(2));
   EXPECT_TRUE(evil_listener->deleted());
 }
 
 TEST_F(ComboboxTest, Click) {
   InitCombobox(NULL);
 
   TestComboboxListener listener;
   combobox_->set_listener(&listener);
 
   combobox_->Layout();
+  int menu_show_count = 0;
+  test_api_->InstallTestMenuRunner(&menu_show_count);
 
   // Click the left side. The menu is shown.
-  TestMenuRunnerHandler* test_menu_runner_handler = new TestMenuRunnerHandler();
-  scoped_ptr<MenuRunnerHandler> menu_runner_handler(test_menu_runner_handler);
-  test::MenuRunnerTestAPI test_api(
-      combobox_->dropdown_list_menu_runner_.get());
-  test_api.SetMenuRunnerHandler(menu_runner_handler.Pass());
+  EXPECT_EQ(0, menu_show_count);
   PerformClick(gfx::Point(combobox_->x() + 1,
                           combobox_->y() + combobox_->height() / 2));
   EXPECT_FALSE(listener.on_perform_action_called());
-  EXPECT_TRUE(test_menu_runner_handler->executed());
+  EXPECT_EQ(1, menu_show_count);
 }
 
 TEST_F(ComboboxTest, ClickButDisabled) {
   InitCombobox(NULL);
 
   TestComboboxListener listener;
   combobox_->set_listener(&listener);
 
   combobox_->Layout();
   combobox_->SetEnabled(false);
 
   // Click the left side, but nothing happens since the combobox is disabled.
-  TestMenuRunnerHandler* test_menu_runner_handler = new TestMenuRunnerHandler();
-  scoped_ptr<MenuRunnerHandler> menu_runner_handler(test_menu_runner_handler);
-  test::MenuRunnerTestAPI test_api(
-      combobox_->dropdown_list_menu_runner_.get());
-  test_api.SetMenuRunnerHandler(menu_runner_handler.Pass());
+  int menu_show_count = 0;
+  test_api_->InstallTestMenuRunner(&menu_show_count);
   PerformClick(gfx::Point(combobox_->x() + 1,
                           combobox_->y() + combobox_->height() / 2));
   EXPECT_FALSE(listener.on_perform_action_called());
-  EXPECT_FALSE(test_menu_runner_handler->executed());
+  EXPECT_EQ(0, menu_show_count);
 }
 
 TEST_F(ComboboxTest, NotifyOnClickWithReturnKey) {
   InitCombobox(NULL);
 
   TestComboboxListener listener;
   combobox_->set_listener(&listener);
 
   // With STYLE_NORMAL, the click event is ignored.
   SendKeyEvent(ui::VKEY_RETURN);
@@ skipping 30 matching lines @@
 TEST_F(ComboboxTest, NotifyOnClickWithMouse) {
   InitCombobox(NULL);
 
   TestComboboxListener listener;
   combobox_->set_listener(&listener);
 
   combobox_->SetStyle(Combobox::STYLE_ACTION);
   combobox_->Layout();
 
   // Click the right side (arrow button). The menu is shown.
-  TestMenuRunnerHandler* test_menu_runner_handler = new TestMenuRunnerHandler();
-  scoped_ptr<MenuRunnerHandler> menu_runner_handler(test_menu_runner_handler);
-  scoped_ptr<test::MenuRunnerTestAPI> test_api(
-      new test::MenuRunnerTestAPI(combobox_->dropdown_list_menu_runner_.get()));
-  test_api->SetMenuRunnerHandler(menu_runner_handler.Pass());
-
+  int menu_show_count = 0;
+  test_api_->InstallTestMenuRunner(&menu_show_count);
+  EXPECT_EQ(0, menu_show_count);
   PerformClick(gfx::Point(combobox_->x() + combobox_->width() - 1,
                           combobox_->y() + combobox_->height() / 2));
   EXPECT_FALSE(listener.on_perform_action_called());
-  EXPECT_TRUE(test_menu_runner_handler->executed());
+  EXPECT_EQ(1, menu_show_count);
 
   // Click the left side (text button). The click event is notified.
-  test_menu_runner_handler = new TestMenuRunnerHandler();
-  menu_runner_handler.reset(test_menu_runner_handler);
-  test_api.reset(
-      new test::MenuRunnerTestAPI(combobox_->dropdown_list_menu_runner_.get()));
-  test_api->SetMenuRunnerHandler(menu_runner_handler.Pass());
+  test_api_->InstallTestMenuRunner(&menu_show_count);
   PerformClick(gfx::Point(combobox_->x() + 1,
                           combobox_->y() + combobox_->height() / 2));
   EXPECT_TRUE(listener.on_perform_action_called());
-  EXPECT_FALSE(test_menu_runner_handler->executed());
+  EXPECT_EQ(1, menu_show_count);  // Unchanged.
   EXPECT_EQ(0, listener.perform_action_index());
 }
 
 TEST_F(ComboboxTest, ConsumingPressKeyEvents) {
   InitCombobox(NULL);
 
   EXPECT_FALSE(combobox_->OnKeyPressed(
       ui::KeyEvent(ui::ET_KEY_PRESSED, ui::VKEY_RETURN, ui::EF_NONE)));
   EXPECT_FALSE(combobox_->OnKeyPressed(
       ui::KeyEvent(ui::ET_KEY_PRESSED, ui::VKEY_SPACE, ui::EF_NONE)));
 
   // When the combobox's style is STYLE_ACTION, pressing events of a space key
   // or an enter key will be consumed.
   combobox_->SetStyle(Combobox::STYLE_ACTION);
   EXPECT_TRUE(combobox_->OnKeyPressed(
       ui::KeyEvent(ui::ET_KEY_PRESSED, ui::VKEY_RETURN, ui::EF_NONE)));
   EXPECT_TRUE(combobox_->OnKeyPressed(
       ui::KeyEvent(ui::ET_KEY_PRESSED, ui::VKEY_SPACE, ui::EF_NONE)));
 }
 
 TEST_F(ComboboxTest, ContentWidth) {
   std::vector<std::string> values;
   VectorComboboxModel model(&values);
   TestCombobox combobox(&model);
+  ComboboxTestApi test_api(&combobox);
 
   std::string long_item = "this is the long item";
   std::string short_item = "s";
 
   values.resize(1);
   values[0] = long_item;
   combobox.ModelChanged();
 
-  const int long_item_width = combobox.content_size_.width();
+  const int long_item_width = test_api.content_size().width();
 
   values[0] = short_item;
   combobox.ModelChanged();
 
-  const int short_item_width = combobox.content_size_.width();
+  const int short_item_width = test_api.content_size().width();
 
   values.resize(2);
   values[0] = short_item;
   values[1] = long_item;
   combobox.ModelChanged();
 
   // When the style is STYLE_NORMAL, the width will fit with the longest item.
   combobox.SetStyle(Combobox::STYLE_NORMAL);
-  EXPECT_EQ(long_item_width, combobox.content_size_.width());
+  EXPECT_EQ(long_item_width, test_api.content_size().width());
 
-  // When the style is STYLE_ACTION, the width will fit with the first items'
+  // When the style is STYLE_ACTION, the width will fit with the selected item's
   // width.
   combobox.SetStyle(Combobox::STYLE_ACTION);
-  EXPECT_EQ(short_item_width, combobox.content_size_.width());
+  EXPECT_EQ(short_item_width, test_api.content_size().width());
+}
+
+// Test that model updates preserve the selected index, so long as it is in
+// range.
+TEST_F(ComboboxTest, ModelChanged) {
+  InitCombobox(nullptr);
+
+  EXPECT_EQ(0, combobox_->GetSelectedRow());
+  EXPECT_EQ(10, combobox_->GetRowCount());
+
+  combobox_->SetSelectedIndex(4);
+  EXPECT_EQ(4, combobox_->GetSelectedRow());
+
+  model_->set_item_count(5);
+  combobox_->ModelChanged();
+  EXPECT_EQ(5, combobox_->GetRowCount());
+  EXPECT_EQ(4, combobox_->GetSelectedRow());  // Unchanged.
+
+  model_->set_item_count(4);
+  combobox_->ModelChanged();
+  EXPECT_EQ(4, combobox_->GetRowCount());
+  EXPECT_EQ(0, combobox_->GetSelectedRow());  // Resets.
+
+  // Restore a non-zero selection.
+  combobox_->SetSelectedIndex(2);
+  EXPECT_EQ(2, combobox_->GetSelectedRow());
+
+  // Make the selected index a separator.
+  std::set<int> separators;
+  separators.insert(2);
+  model_->SetSeparators(separators);
+  combobox_->ModelChanged();
+  EXPECT_EQ(4, combobox_->GetRowCount());
+  EXPECT_EQ(0, combobox_->GetSelectedRow());  // Resets.
+
+  // Restore a non-zero selection.
+  combobox_->SetSelectedIndex(1);
+  EXPECT_EQ(1, combobox_->GetSelectedRow());
+
+  // Test an empty model.
+  model_->set_item_count(0);
+  combobox_->ModelChanged();
+  EXPECT_EQ(0, combobox_->GetRowCount());
+  EXPECT_EQ(0, combobox_->GetSelectedRow());  // Resets.
 }
 
 TEST_F(ComboboxTest, TypingPrefixNotifiesListener) {
   InitCombobox(NULL);
 
   TestComboboxListener listener;
   combobox_->set_listener(&listener);
   ui::TextInputClient* input_client =
       widget_->GetInputMethod()->GetTextInputClient();
 
@@ skipping 12 matching lines @@
   combobox_->OnBlur();
   combobox_->RequestFocus();
 
   // Type the first character of "PEANUT BUTTER", which should change the
   // selected index and perform an action.
   input_client->InsertChar('P', ui::EF_NONE);
   EXPECT_EQ(2, listener.actions_performed());
   EXPECT_EQ(2, listener.perform_action_index());
 }
 
+// Test properties on the Combobox menu model.
+TEST_F(ComboboxTest, MenuModel) {
+  const int kSeparatorIndex = 3;
+  std::set<int> separators;
+  separators.insert(kSeparatorIndex);
+  InitCombobox(&separators);
+
+  ui::MenuModel* menu_model = test_api_->menu_model();
+
+  EXPECT_EQ(TestComboboxModel::kItemCount, menu_model->GetItemCount());
+  EXPECT_EQ(ui::MenuModel::TYPE_SEPARATOR,
+            menu_model->GetTypeAt(kSeparatorIndex));
+
+#if defined(OS_MACOSX)
+  // Comboboxes on Mac should have checkmarks, with the selected item checked,
+  EXPECT_EQ(ui::MenuModel::TYPE_CHECK, menu_model->GetTypeAt(0));
+  EXPECT_EQ(ui::MenuModel::TYPE_CHECK, menu_model->GetTypeAt(1));
+  EXPECT_TRUE(menu_model->IsItemCheckedAt(0));
+  EXPECT_FALSE(menu_model->IsItemCheckedAt(1));
+
+  combobox_->SetSelectedIndex(1);
+  EXPECT_FALSE(menu_model->IsItemCheckedAt(0));
+  EXPECT_TRUE(menu_model->IsItemCheckedAt(1));
+#else
+  EXPECT_EQ(ui::MenuModel::TYPE_COMMAND, menu_model->GetTypeAt(0));
+  EXPECT_EQ(ui::MenuModel::TYPE_COMMAND, menu_model->GetTypeAt(1));
+#endif
+
+  EXPECT_EQ(ASCIIToUTF16("PEANUT BUTTER"), menu_model->GetLabelAt(0));
+  EXPECT_EQ(ASCIIToUTF16("JELLY"), menu_model->GetLabelAt(1));
+
+  // Check that with STYLE_ACTION, the first item (only) is not shown.
+  EXPECT_TRUE(menu_model->IsVisibleAt(0));
+  combobox_->SetStyle(Combobox::STYLE_ACTION);
+  EXPECT_FALSE(menu_model->IsVisibleAt(0));
+  EXPECT_TRUE(menu_model->IsVisibleAt(1));
+}
+
 }  // namespace views