Refactor PanelManager to create PanelStrip.

chrome/browser/ui/panels/panel_manager.h

 // Copyright (c) 2011 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.
 
 #ifndef CHROME_BROWSER_UI_PANELS_PANEL_MANAGER_H_
 #define CHROME_BROWSER_UI_PANELS_PANEL_MANAGER_H_
 #pragma once
 
 #include <vector>
 #include "base/basictypes.h"
 #include "base/lazy_instance.h"
 #include "base/memory/scoped_ptr.h"
-#include "base/memory/weak_ptr.h"
 #include "chrome/browser/ui/panels/auto_hiding_desktop_bar.h"
 #include "chrome/browser/ui/panels/panel.h"
-#include "chrome/browser/ui/panels/panel_mouse_watcher_observer.h"
 #include "ui/gfx/rect.h"
 
+#ifdef UNIT_TEST
+#include "chrome/browser/ui/panels/panel_strip.h"
+#include "chrome/browser/ui/panels/panel_mouse_watcher.h"

[jianli, 2011/11/30 19:27:01]

Why do we need these 2 includes for UNIT_TEST? It seems panel_strip.h is needed
to access some PanelStrip methods in this file? Can you either change the tests
to use these PanelStrip methods directly or move these PanelManager method
declarations out of UNIT_TEST guard and move the implementation to .cc file?

[jennb, 2011/11/30 19:55:12]

Aren't we using UNIT_TEST guard and inline in .h was to keep the code from
existing in regular builds? Existing tests should not know that panel strips
exist. Each of the occurrences below violate abstractions, but I am putting off
that cleanup to a separate patch.

+#endif

[Dmitry Titov, 2011/11/30 20:38:45]

having UNIT_TEST around whole #include can significantly change the compiled
code. It is scary. Could we just drop UNIT_TEST here? Or add TODO that it's
temporary and you will clean it up later?

+
 class Browser;
-class Panel;
 class PanelMouseWatcher;
+class PanelStrip;
 
 // This class manages a set of panels.
-// Note that the ref count is needed by using PostTask in the implementation.
-class PanelManager : public PanelMouseWatcherObserver,
-                     public AutoHidingDesktopBar::Observer {
+class PanelManager : public AutoHidingDesktopBar::Observer {
  public:
   typedef std::vector<Panel*> Panels;
 
   // Returns a single instance.
   static PanelManager* GetInstance();
 
   // Called when the display is changed, i.e. work area is updated.
   void OnDisplayChanged();
 
   // Creates a panel and returns it. The panel might be queued for display
   // later.
   Panel* CreatePanel(Browser* browser);
 
   void Remove(Panel* panel);
   void RemoveAll();
 
+  // Asynchronous confirmation of panel having been removed.
+  void OnPanelRemoved(Panel* panel);
+
   // Drags the given panel.
   void StartDragging(Panel* panel);
   void Drag(int delta_x);
   void EndDragging(bool cancelled);
 
   // Invoked when a panel's expansion state changes.
   void OnPanelExpansionStateChanged(Panel::ExpansionState old_state,
                                     Panel::ExpansionState new_state);
 
   // Invoked when the preferred window size of the given panel might need to
@@ skipping 12 matching lines @@
   // hide bottom bar is present, we want to move the minimized panel to the
   // bottom of the screen, not the bottom of the work area.
   int GetBottomPositionForExpansionState(
       Panel::ExpansionState expansion_state) const;
 
   // Returns the next browser window which could be either panel window or
   // tabbed window, to switch to if the given panel is going to be deactivated.
   // Returns NULL if such window cannot be found.
   BrowserWindow* GetNextBrowserWindowToActivate(Panel* panel) const;
 
-  int num_panels() const { return panels_.size(); }
+  int num_panels() const;
   bool is_dragging_panel() const;
-  const Panels& panels() const { return panels_; }
-
-  int GetMaxPanelWidth() const;
-  int GetMaxPanelHeight() const;
   int StartingRightPosition() const;
-
-  // Moves a panel to the panel strip. The panel does not currently
-  // belong in any other strip. This may cause other panels to be
-  // bumped out of the panel strip.
-  void MoveToPanelStrip(Panel* panel);
+  const Panels& panels() const;
 
   // Moves a panel to the overflow strip. The panel does not currently
   // belong in any other strip.
   // |is_new| is true if the panel was just created.
   void MoveToOverflowStrip(Panel* panel, bool is_new);
 
-  // Overridden from PanelMouseWatcherObserver:
-  virtual void OnMouseMove(const gfx::Point& mouse_position) OVERRIDE;
+  AutoHidingDesktopBar* auto_hiding_desktop_bar() const {
+    return auto_hiding_desktop_bar_;
+  }
+
+  PanelMouseWatcher* mouse_watcher() const {
+    return panel_mouse_watcher_.get();
+  }
+
+  PanelStrip* panel_strip() const {
+    return panel_strip_.get();
+  }
 
 #ifdef UNIT_TEST
-  static int horizontal_spacing() { return kPanelsHorizontalSpacing; }
+  static int horizontal_spacing() { return PanelStrip::horizontal_spacing(); }
 
   const gfx::Rect& work_area() const {
     return work_area_;
   }
 
   void set_auto_hiding_desktop_bar(
       AutoHidingDesktopBar* auto_hiding_desktop_bar) {
     auto_hiding_desktop_bar_ = auto_hiding_desktop_bar;
   }
 
+  void set_mouse_watcher(PanelMouseWatcher* watcher) {
+    panel_mouse_watcher_.reset(watcher);
+  }
+
   void enable_auto_sizing(bool enabled) {
     auto_sizing_enabled_ = enabled;
   }
 
   void SetWorkAreaForTesting(const gfx::Rect& work_area) {
     SetWorkArea(work_area);
   }
 
   void remove_delays_for_testing() {
-    remove_delays_for_testing_ = true;
+    panel_strip_->remove_delays_for_testing();
   }
 
   int minimized_panel_count() {
-    return minimized_panel_count_;
-  }
-
-  // Tests should disable mouse watching if mouse movements will be simulated.
-  void disable_mouse_watching() {
-    mouse_watching_disabled_ = true;
+    return panel_strip_->minimized_panel_count();
   }
 #endif
 
  private:
   friend struct base::DefaultLazyInstanceTraits<PanelManager>;
-  FRIEND_TEST_ALL_PREFIXES(PanelBrowserTest, SizeClamping);
-
-  enum TitlebarAction {
-    NO_ACTION,
-    BRING_UP,
-    BRING_DOWN
-  };
 
   PanelManager();
   virtual ~PanelManager();
 
   // Overridden from AutoHidingDesktopBar::Observer:
   virtual void OnAutoHidingDesktopBarThicknessChanged() OVERRIDE;
   virtual void OnAutoHidingDesktopBarVisibilityChanged(
       AutoHidingDesktopBar::Alignment alignment,
       AutoHidingDesktopBar::Visibility visibility) OVERRIDE;
 
   // Applies the new work area. This is called by OnDisplayChanged and the test
   // code.
   void SetWorkArea(const gfx::Rect& work_area);
 
   // Adjusts the work area to exclude the influence of auto-hiding desktop bars.
   void AdjustWorkAreaForAutoHidingDesktopBars();
 
-  // Keep track of the minimized panels to control mouse watching.
-  void IncrementMinimizedPanels();
-  void DecrementMinimizedPanels();
+  // Positions the various groupings of panels.
+  void Layout();
 
-  // Handles all the panels that're delayed to be removed.
-  void DelayedRemove();
-
-  // Does the remove. Called from Remove and DelayedRemove.
-  void DoRemove(Panel* panel);
-
-  // Rearranges the positions of the panels starting from the given iterator.
-  // This is called when the display space has been changed, i.e. working
-  // area being changed or a panel being closed.
-  void Rearrange(Panels::iterator iter_to_start, int rightmost_position);
-
-  // Help functions to drag the given panel.
-  void DragLeft();
-  void DragRight();
-
-  // Does the real job of bringing up or down the titlebars.
-  void DoBringUpOrDownTitlebars(bool bring_up);
-  // The callback for a delyed task, checks if it still need to perform
-  // the delayed action.
-  void DelayedBringUpOrDownTitlebarsCheck();
-
-  int GetRightMostAvailablePosition() const;
-
-  Panels panels_;
-
-  // Stores the panels that are pending to remove. We want to delay the removal
-  // when we're in the process of the dragging.
-  Panels panels_pending_to_remove_;
+  scoped_ptr<PanelStrip> panel_strip_;
 
   // Use a mouse watcher to know when to bring up titlebars to "peek" at
   // minimized panels. Mouse movement is only tracked when there is a minimized
   // panel.
   scoped_ptr<PanelMouseWatcher> panel_mouse_watcher_;
-  int minimized_panel_count_;
-  bool are_titlebars_up_;
 
   // The maximum work area avaialble. This area does not include the area taken
   // by the always-visible (non-auto-hiding) desktop bars.
   gfx::Rect work_area_;
 
   // The useable work area for computing the panel bounds. This area excludes
   // the potential area that could be taken by the auto-hiding desktop
   // bars (we only consider those bars that are aligned to bottom, left, and
   // right of the screen edges) when they become fully visible.
   gfx::Rect adjusted_work_area_;
 
-  // Panel to drag.
-  size_t dragging_panel_index_;
-
-  // Original x coordinate of the panel to drag. This is used to get back to
-  // the original position when we cancel the dragging.
-  int dragging_panel_original_x_;
-
-  // Bounds of the panel to drag. It is first set to the original bounds when
-  // the dragging happens. Then it is updated to the position that will be set
-  // to when the dragging ends.
-  gfx::Rect dragging_panel_bounds_;
-
   scoped_refptr<AutoHidingDesktopBar> auto_hiding_desktop_bar_;
 
-  // Delayed transitions support. Sometimes transitions between minimized and
-  // title-only states are delayed, for better usability with Taskbars/Docks.
-  TitlebarAction delayed_titlebar_action_;
-  bool remove_delays_for_testing_;
-  // Owned by MessageLoop after posting.
-  base::WeakPtrFactory<PanelManager> titlebar_action_factory_;
-
   // Whether or not bounds will be updated when the preferred content size is
   // changed. The testing code could set this flag to false so that other tests
   // will not be affected.
   bool auto_sizing_enabled_;
 
-  bool mouse_watching_disabled_;  // For tests to simulate mouse movements.
-
-  static const int kPanelsHorizontalSpacing = 4;
-
-  // Absolute minimum width and height for panels, including non-client area.
-  // Should only be big enough to accomodate a close button on the reasonably
-  // recognisable titlebar.
-  static const int kPanelMinWidth;
-  static const int kPanelMinHeight;
-
   DISALLOW_COPY_AND_ASSIGN(PanelManager);
 };
 
 #endif  // CHROME_BROWSER_UI_PANELS_PANEL_MANAGER_H_