Send Navigation notifications to clients.

mash/browser/browser.cc

 // Copyright 2016 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 "mash/browser/browser.h"
 
 #include "base/macros.h"
+#include "base/memory/ptr_util.h"
 #include "base/memory/weak_ptr.h"
 #include "base/message_loop/message_loop.h"
 #include "base/strings/string16.h"
 #include "base/strings/string_util.h"
 #include "base/strings/utf_string_conversions.h"
+#include "base/threading/thread_task_runner_handle.h"
 #include "base/timer/timer.h"
 #include "components/mus/public/cpp/window.h"
 #include "components/mus/public/cpp/window_tree_client.h"
 #include "mash/browser/debug_view.h"
 #include "mash/public/interfaces/launchable.mojom.h"
 #include "mojo/public/c/system/main.h"
 #include "services/navigation/public/interfaces/view.mojom.h"
 #include "services/shell/public/cpp/application_runner.h"
 #include "services/shell/public/cpp/connector.h"
 #include "services/shell/public/cpp/shell_client.h"
 #include "services/tracing/public/cpp/tracing_impl.h"
 #include "ui/aura/mus/mus_util.h"
+#include "ui/base/models/menu_model.h"
 #include "ui/gfx/canvas.h"
 #include "ui/gfx/paint_throbber.h"
 #include "ui/gfx/text_constants.h"
 #include "ui/native_theme/native_theme.h"
 #include "ui/views/background.h"
 #include "ui/views/controls/button/label_button.h"
+#include "ui/views/controls/menu/menu_model_adapter.h"
+#include "ui/views/controls/menu/menu_runner.h"
 #include "ui/views/controls/textfield/textfield.h"
 #include "ui/views/controls/textfield/textfield_controller.h"
 #include "ui/views/mus/aura_init.h"
 #include "ui/views/mus/window_manager_connection.h"
 #include "ui/views/widget/widget_delegate.h"
 #include "url/gurl.h"
 
 namespace mash {
 namespace browser {
 
 void EnableButton(views::CustomButton* button, bool enabled) {
   button->SetState(enabled ? views::Button::STATE_NORMAL
                            : views::Button::STATE_DISABLED);
 }
 
+struct NavEntry {
+  NavEntry(const base::string16& title, int offset)
+      : title(title), offset(offset) {}
+  ~NavEntry() {}
+
+  base::string16 title;
+  int offset;

[sky, 2016/06/08 21:31:21]

What is offset? At least document it.

+};
+
+class NavMenuModel : public ui::MenuModel {
+ public:
+  class Delegate {
+   public:
+    virtual void NavigateToOffset(int offset) = 0;
+  };
+
+  NavMenuModel(const std::vector<NavEntry>& entries, Delegate* delegate)
+      : entries_(entries), navigation_delegate_(delegate) {}
+  ~NavMenuModel() override {}
+
+ private:
+  bool HasIcons() const override { return false; }
+  int GetItemCount() const override {
+    return static_cast<int>(entries_.size());
+  }
+  ui::MenuModel::ItemType GetTypeAt(int index) const override {
+    return ui::MenuModel::TYPE_COMMAND;
+  }
+  ui::MenuSeparatorType GetSeparatorTypeAt(int index) const override {
+    return ui::NORMAL_SEPARATOR;
+  }
+  int GetCommandIdAt(int index) const override {
+    return index;
+  }
+  base::string16 GetLabelAt(int index) const override {
+    return entries_[index].title;
+  }
+  base::string16 GetSublabelAt(int index) const override {
+    return base::string16();
+  }
+  base::string16 GetMinorTextAt(int index) const override {
+    return base::string16();
+  }
+  bool IsItemDynamicAt(int index) const override { return false; }
+  bool GetAcceleratorAt(int index,
+                        ui::Accelerator* accelerator) const override {
+    return false;
+  }
+  bool IsItemCheckedAt(int index) const override { return false; }
+  int GetGroupIdAt(int index) const override { return -1; }
+  bool GetIconAt(int index, gfx::Image* icon) override { return false; }
+  ui::ButtonMenuItemModel* GetButtonMenuItemAt(int index) const override {
+    return nullptr;
+  }
+  bool IsEnabledAt(int index) const override { return true; }
+  bool IsVisibleAt(int index) const override { return true; }
+  ui::MenuModel* GetSubmenuModelAt(int index) const override { return nullptr; }
+  void HighlightChangedTo(int index) override {}
+  void ActivatedAt(int index) override {
+    ActivatedAt(index, 0);
+  }
+  void ActivatedAt(int index, int event_flags) override {
+    navigation_delegate_->NavigateToOffset(entries_[index].offset);
+  }
+  void SetMenuModelDelegate(ui::MenuModelDelegate* delegate) override {
+    delegate_ = delegate;
+  }
+  ui::MenuModelDelegate* GetMenuModelDelegate() const override {
+    return delegate_;
+  }
+
+  int multiplier_;

[sky, 2016/06/08 21:31:20]

remove as not used.

+  ui::MenuModelDelegate* delegate_ = nullptr;
+  Delegate* navigation_delegate_;
+  std::vector<NavEntry> entries_;
+  int cursor_;

[sky, 2016/06/08 21:31:20]

Not used?

+
+  DISALLOW_COPY_AND_ASSIGN(NavMenuModel);
+};
+
+class NavButton : public views::LabelButton {
+ public:
+  enum class Type {
+    BACK,
+    FORWARD
+  };
+
+  class ModelProvider {
+   public:
+    virtual std::unique_ptr<ui::MenuModel> CreateMenuModel(Type type) = 0;
+  };
+
+  NavButton(Type type,
+            ModelProvider* model_provider,
+            views::ButtonListener* listener,
+            const base::string16& label)
+      : views::LabelButton(listener, label),
+        type_(type),
+        model_provider_(model_provider),
+        show_menu_factory_(this) {}
+  ~NavButton() override {}
+
+ private:
+  bool OnMousePressed(const ui::MouseEvent& event) override {

[sky, 2016/06/08 21:31:21]

Prefix with // views::LabelButton: (or something similar)

+    if (IsTriggerableEvent(event) && enabled() &&
+        HitTestPoint(event.location())) {
+      y_pos_on_lbuttondown_ = event.y();
+      base::ThreadTaskRunnerHandle::Get()->PostDelayedTask(
+          FROM_HERE,
+          base::Bind(&NavButton::ShowMenu, show_menu_factory_.GetWeakPtr(),
+                     ui::GetMenuSourceTypeForEvent(event)),
+          base::TimeDelta::FromMilliseconds(500));
+    }
+    return LabelButton::OnMousePressed(event);
+  }
+  bool OnMouseDragged(const ui::MouseEvent& event) override {
+    bool result = LabelButton::OnMouseDragged(event);
+    if (show_menu_factory_.HasWeakPtrs()) {
+      if (event.y() > y_pos_on_lbuttondown_ + GetHorizontalDragThreshold()) {
+        show_menu_factory_.InvalidateWeakPtrs();
+        ShowMenu(ui::GetMenuSourceTypeForEvent(event));
+      }
+    }
+    return result;
+  }
+  void OnMouseReleased(const ui::MouseEvent& event) override {
+    if (IsTriggerableEvent(event))
+      show_menu_factory_.InvalidateWeakPtrs();
+    LabelButton::OnMouseReleased(event);
+  }
+

[sky, 2016/06/08 21:31:21]

nit: remove extra whitespace.

+
+  void ShowMenu(ui::MenuSourceType source_type) {
+    gfx::Rect local = GetLocalBounds();
+    gfx::Point menu_position(local.origin());
+    menu_position.Offset(0, local.height() - 1);
+    View::ConvertPointToScreen(this, &menu_position);
+
+    model_ = std::move(model_provider_->CreateMenuModel(type_));
+    menu_model_adapter_.reset(new views::MenuModelAdapter(
+        model_.get(),
+        base::Bind(&NavButton::OnMenuClosed, base::Unretained(this))));
+    menu_model_adapter_->set_triggerable_event_flags(triggerable_event_flags());
+    menu_runner_.reset(new views::MenuRunner(
+        menu_model_adapter_->CreateMenu(),
+        views::MenuRunner::HAS_MNEMONICS | views::MenuRunner::ASYNC));
+    ignore_result(menu_runner_->RunMenuAt(
+        GetWidget(), nullptr, gfx::Rect(menu_position, gfx::Size(0, 0)),
+        views::MENU_ANCHOR_TOPLEFT, source_type));
+  }
+
+  void OnMenuClosed() {
+    SetMouseHandler(nullptr);
+    model_.reset();
+    menu_runner_.reset();
+    menu_model_adapter_.reset();
+  }
+
+  Type type_;
+  ModelProvider* model_provider_;
+  int y_pos_on_lbuttondown_ = 0;
+  std::unique_ptr<ui::MenuModel> model_;
+  std::unique_ptr<views::MenuModelAdapter> menu_model_adapter_;
+  std::unique_ptr<views::MenuRunner> menu_runner_;
+  base::WeakPtrFactory<NavButton> show_menu_factory_;
+
+  DISALLOW_COPY_AND_ASSIGN(NavButton);
+};
+
 class ProgressBar : public views::View {
  public:
   ProgressBar() {}
   ~ProgressBar() override {}
 
   void SetProgress(double progress) {
     progress_ = progress;
     SchedulePaint();
   }
 
@@ skipping 52 matching lines @@
   base::TimeTicks start_time_;
   base::Timer timer_;
   base::WeakPtrFactory<Throbber> weak_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(Throbber);
 };
 
 class UI : public views::WidgetDelegateView,
            public views::ButtonListener,
            public views::TextfieldController,
-           public navigation::mojom::ViewClient {
+           public navigation::mojom::ViewClient,
+           public NavButton::ModelProvider,
+           public NavMenuModel::Delegate {
  public:
   enum class Type { WINDOW, POPUP };
 
   UI(Browser* browser,
      Type type,
      navigation::mojom::ViewPtr view,
      navigation::mojom::ViewClientRequest request)
       : browser_(browser),
         type_(type),
-        back_button_(new views::LabelButton(this, base::ASCIIToUTF16("Back"))),
-        forward_button_(
-            new views::LabelButton(this, base::ASCIIToUTF16("Forward"))),
+        back_button_(new NavButton(NavButton::Type::BACK, this, this,
+                                   base::ASCIIToUTF16("Back"))),
+        forward_button_(new NavButton(NavButton::Type::FORWARD, this, this,
+                                      base::ASCIIToUTF16("Forward"))),
         reload_button_(
             new views::LabelButton(this, base::ASCIIToUTF16("Reload"))),
         prompt_(new views::Textfield),
         debug_button_(
             new views::LabelButton(this, base::ASCIIToUTF16("DV"))),
         throbber_(new Throbber),
         progress_bar_(new ProgressBar),
         debug_view_(new DebugView),
         view_(std::move(view)),
         view_client_binding_(this, std::move(request)) {
@@ skipping 173 matching lines @@
                    const gfx::Rect& initial_rect,
                    bool user_gesture) override {
     views::Widget* window = views::Widget::CreateWindowWithContextAndBounds(
         new UI(browser_, is_popup ? UI::Type::POPUP : UI::Type::WINDOW,
                std::move(view), std::move(request)),
         nullptr, initial_rect);
     window->Show();
     browser_->AddWindow(window);
   }
   void Close() override { GetWidget()->Close(); }
+  void NavigationPending(navigation::mojom::NavigationEntryPtr entry) override {
+    pending_nav_ = std::move(entry);
+  }
+  void NavigationCommitted(
+      navigation::mojom::NavigationCommittedDetailsPtr details,
+      int current_index) override {
+    switch (details->type) {
+      case navigation::mojom::NavigationType::NEW_PAGE: {
+        if (navigation_list_.size() > 1) {
+          auto it = navigation_list_.begin() + (cursor_ + 1);
+          if (it < navigation_list_.end())
+            navigation_list_.erase(++it, navigation_list_.end());
+        }
+        navigation_list_.push_back(std::move(pending_nav_));

[sky, 2016/06/08 21:31:20]

Don't you want to add at current_index?

[Ben Goodger (Google), 2016/06/08 21:55:03]

At this point we should have trimmed the navigation_list_ to size ==
current_index. Perhaps worth DCHECKing that fact.

+        cursor_ = current_index;
+        break;
+      }
+      case navigation::mojom::NavigationType::EXISTING_PAGE:
+        cursor_ = current_index;

[sky, 2016/06/08 21:31:20]

How come you don't replace the entry at current_index here?

[Ben Goodger (Google), 2016/06/08 21:55:04]

That appears to lose data. Sometimes the pending entry doesn't have e.g. title
data.

+        break;
+    }
+  }
+  void NavigationEntryChanged(navigation::mojom::NavigationEntryPtr entry,
+                              int entry_index) override {
+    navigation_list_[entry_index] = std::move(entry);
+  }
+  void NavigationListPruned(bool from_front, int count) override {
+    DCHECK(count < static_cast<int>(navigation_list_.size()));
+    if (from_front) {

[sky, 2016/06/08 21:31:20]

Did you mean to have !from_front here as the first branch removes from the end?

[Ben Goodger (Google), 2016/06/08 21:55:04]

For navigations, the list reversed. The "front" of the controller I think are
the items at the back of the vector.

+      auto it = navigation_list_.end() - count;
+      navigation_list_.erase(it, navigation_list_.end());
+    } else {
+      auto it = navigation_list_.begin() + count;
+      navigation_list_.erase(navigation_list_.begin(), it);
+    }
+  }
+
+  // NavButton::ModelProvider:
+  std::unique_ptr<ui::MenuModel> CreateMenuModel(
+      NavButton::Type type) override {
+    std::vector<NavEntry> entries;
+    if (type == NavButton::Type::BACK) {
+      for (int i = cursor_ - 1, offset = -1; i >= 0; --i, --offset) {
+        std::string title = navigation_list_[i]->title;
+        entries.push_back(NavEntry(base::UTF8ToUTF16(title), offset));
+      }
+    } else {
+      for (int i = cursor_ + 1, offset = 1; i < navigation_list_.size();
+           ++i, ++offset) {
+        std::string title = navigation_list_[i]->title;
+        entries.push_back(NavEntry(base::UTF8ToUTF16(title), offset));
+      }
+    }
+    return base::WrapUnique(new NavMenuModel(entries, this));
+  }
+
+  // NavMenuModel::Delegate:
+  void NavigateToOffset(int offset) override {
+    view_->NavigateToOffset(offset);

[sky, 2016/06/08 21:31:20]

What happens if navigation_list_ changed while the menu was displayed?

[Ben Goodger (Google), 2016/06/08 21:55:03]

These are great questions for an implementation of this feature significantly
less cheesy than this. I think once I have a client lib & develop a BFList for
it, we can figure all this out & have unit tests.

+  }
 
   void ToggleDebugView() {
     showing_debug_view_ = !showing_debug_view_;
     Layout();
   }
 
   Browser* browser_;
 
   Type type_;
 
   views::LabelButton* back_button_;
   views::LabelButton* forward_button_;
   views::LabelButton* reload_button_;
   views::Textfield* prompt_;
   views::LabelButton* debug_button_;
   Throbber* throbber_;
   ProgressBar* progress_bar_;
 
   mus::Window* content_area_ = nullptr;
 
   DebugView* debug_view_;
 
   navigation::mojom::ViewPtr view_;
   mojo::Binding<navigation::mojom::ViewClient> view_client_binding_;
 
   bool is_loading_ = false;
   base::string16 current_title_;
   GURL current_url_;
 
+  navigation::mojom::NavigationEntryPtr pending_nav_;
+  std::vector<navigation::mojom::NavigationEntryPtr> navigation_list_;
+  int cursor_ = 0;

[sky, 2016/06/08 21:31:20]

Document what this is. I would be inclined to name it more clearly, e.g.
current_navigation_entry_offset_ or something.

+
   bool showing_debug_view_ = false;
 
   DISALLOW_COPY_AND_ASSIGN(UI);
 };
 
 Browser::Browser() {}
 Browser::~Browser() {}
 
 void Browser::AddWindow(views::Widget* window) {
   windows_.push_back(window);
@@ skipping 47 matching lines @@
   AddWindow(window);
 }
 
 void Browser::Create(shell::Connection* connection,
                      mojom::LaunchableRequest request) {
   bindings_.AddBinding(this, std::move(request));
 }
 
 }  // namespace browser
 }  // namespace mash