Update avatar button to MD (part 1)

chrome/browser/ui/views/frame/glass_browser_frame_view.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 "chrome/browser/ui/views/frame/glass_browser_frame_view.h"
 
 #include <dwmapi.h>
 #include <utility>
 
 #include "base/win/windows_version.h"
@@ skipping 31 matching lines @@
 namespace {
 // Thickness of the frame edge between the non-client area and the web content.
 const int kClientBorderThickness = 3;
 // Besides the frame border, there's empty space atop the window in restored
 // mode, to use to drag the window around.
 const int kNonClientRestoredExtraThickness = 11;
 // At the window corners the resize area is not actually bigger, but the 16
 // pixels at the end of the top and bottom edges trigger diagonal resizing.
 const int kResizeCornerWidth = 16;
 // How far the profile switcher button is from the left of the minimize button.
-const int kProfileSwitcherButtonOffset = 5;
+const int kProfileSwitcherButtonOffset = 1;
 // The content edge images have a shadow built into them.
 const int kContentEdgeShadowThickness = 2;
 // In restored mode, the New Tab button isn't at the same height as the caption
 // buttons, but the space will look cluttered if it actually slides under them,
 // so we stop it when the gap between the two is down to 5 px.
 const int kNewTabCaptionRestoredSpacing = 5;
 // In maximized mode, where the New Tab button and the caption buttons are at
 // similar vertical coordinates, we need to reserve a larger, 16 px gap to avoid
 // looking too cluttered.
 const int kNewTabCaptionMaximizedSpacing = 16;
-// Height of the profile switcher button. Same as the height of the Windows 7/8
-// caption buttons.
-// TODO(bsep): Windows 10 caption buttons look very different and we would like
-// the profile switcher button to match on that platform.
-const int kProfileSwitcherButtonHeight = 20;
 // There is a small one-pixel strip right above the caption buttons in which the
 // resize border "peeks" through.
 const int kCaptionButtonTopInset = 1;
 
 // Converts the |image| to a Windows icon and returns the corresponding HICON
 // handle. |image| is resized to desired |width| and |height| if needed.
 base::win::ScopedHICON CreateHICONFromSkBitmapSizedTo(
     const gfx::ImageSkia& image,
     int width,
     int height) {
@@ skipping 14 matching lines @@
                                              BrowserView* browser_view)
     : BrowserNonClientFrameView(frame, browser_view),
       window_icon_(nullptr),
       window_title_(nullptr),
       profile_switcher_(this),
       minimize_button_(nullptr),
       maximize_button_(nullptr),
       restore_button_(nullptr),
       close_button_(nullptr),
       throbber_running_(false),
-      throbber_frame_(0) {
+      throbber_frame_(0),
+      tab_strip_(nullptr) {
   // We initialize all fields despite some of them being unused in some modes,
   // since it's possible for modes to flip dynamically (e.g. if the user enables
   // a high-contrast theme). Throbber icons are only used when ShowSystemIcon()
   // is true. Everything else here is only used when
   // ShouldCustomDrawSystemTitlebar() is true.
 
   if (browser_view->ShouldShowWindowIcon()) {
     InitThrobberIcons();
 
     window_icon_ = new TabIconView(this, nullptr);
@@ skipping 12 matching lines @@
     AddChildView(window_title_);
   }
 
   minimize_button_ = CreateCaptionButton(VIEW_ID_MINIMIZE_BUTTON);
   maximize_button_ = CreateCaptionButton(VIEW_ID_MAXIMIZE_BUTTON);
   restore_button_ = CreateCaptionButton(VIEW_ID_RESTORE_BUTTON);
   close_button_ = CreateCaptionButton(VIEW_ID_CLOSE_BUTTON);
 }
 
 GlassBrowserFrameView::~GlassBrowserFrameView() {
+  if (tab_strip_) {
+    tab_strip_->RemoveObserver(this);
+    tab_strip_ = nullptr;

[Evan Stade, 2017/05/04 15:56:28]

not sure I understand why nulling this out is necessary. We don't usually null
out weak refs in destructors.

[Peter Kasting, 2017/05/06 02:23:08]

This; also, ScopedObserver (as Evan wisely suggests) would eliminate the need
for this code in the destructor anyway (and could replace the |tab_strip_|
member).

[emx, 2017/05/09 16:26:51]

OK, now using ScopedObserver, so the destructor is gone.

+  }
 }
 
 ///////////////////////////////////////////////////////////////////////////////
 // GlassBrowserFrameView, BrowserNonClientFrameView implementation:
 
 gfx::Rect GlassBrowserFrameView::GetBoundsForTabStrip(
     views::View* tabstrip) const {
   const int x = incognito_bounds_.right() + kAvatarIconPadding;
   int end_x = width() - ClientBorderThickness(false);
   if (!CaptionButtonsOnLeadingEdge()) {
     end_x = std::min(MinimizeButtonX(), end_x) -
             (IsMaximized() ? kNewTabCaptionMaximizedSpacing
                            : kNewTabCaptionRestoredSpacing);
 
     // The profile switcher button is optionally displayed to the left of the
     // minimize button.
-    if (profile_switcher_.view()) {
+    views::View* button_view = GetProfileSwitcherView();

[Peter Kasting, 2017/05/06 02:23:08]

Nit: |profile_switcher| seems like a better name. (2 places)

[emx, 2017/05/09 16:26:51]

Done.

+    if (button_view) {
       const int old_end_x = end_x;
-      end_x -= profile_switcher_.view()->width() + kProfileSwitcherButtonOffset;
+      end_x -= button_view->width() + kProfileSwitcherButtonOffset;
 
       // In non-maximized mode, allow the new tab button to slide completely
       // under the profile switcher button.
+      // Note that the button should be "cozy" then, even if it's an MD button.

[Peter Kasting, 2017/05/06 02:23:08]

What does "cozy" mean, and why would it being or not being "an MD button"
matter?  This feels like a comment written by/for someone with lots of context
of avatar button mocks, which is probably not what a reader of this code would
have.

[emx, 2017/05/09 16:26:51]

Removed the line.

       if (!IsMaximized()) {
         end_x = std::min(end_x + GetLayoutSize(NEW_TAB_BUTTON).width() +
                              kNewTabCaptionRestoredSpacing,
                          old_end_x);
       }
     }
   }
   return gfx::Rect(x, TopAreaHeight(false), std::max(0, end_x - x),
                    tabstrip->GetPreferredSize().height());
 }
@@ skipping 43 matching lines @@
     min_size.set_width(std::max(min_tabstrip_area_width, min_size.width()));
   }
 
   return min_size;
 }
 
 views::View* GlassBrowserFrameView::GetProfileSwitcherView() const {
   return profile_switcher_.view();
 }
 
+void GlassBrowserFrameView::OnBrowserViewInitViewsComplete() {
+  DCHECK(browser_view()->tabstrip());

[Peter Kasting, 2017/05/06 02:23:08]

Are you sure you always get a tabstrip?  What about, say, popup windows?
(popuptest.com)

[emx, 2017/05/09 16:26:51]

I got a tabstrip even in a pop-up on that page, but to be safe I've changed the
DCHECK to an if anyway.

+  DCHECK(!tab_strip_);
+  tab_strip_ = browser_view()->tabstrip();

[Evan Stade, 2017/05/04 15:56:28]

why do you need this instead of just referencing browser_view()->tabstrip()? You
also might find ScopedObserver to be useful.

[emx, 2017/05/09 16:26:51]

Done.

+  tab_strip_->AddObserver(this);
+}
+
 ///////////////////////////////////////////////////////////////////////////////
 // GlassBrowserFrameView, views::NonClientFrameView implementation:
 
 gfx::Rect GlassBrowserFrameView::GetBoundsForClientView() const {
   return client_view_bounds_;
 }
 
 gfx::Rect GlassBrowserFrameView::GetWindowBoundsForClientBounds(
     const gfx::Rect& client_bounds) const {
   HWND hwnd = views::HWNDForWidget(frame());
@@ skipping 33 matching lines @@
     return HTNOWHERE;
 
   // If the point isn't within our bounds, then it's in the native portion of
   // the frame so again Windows can figure it out.
   if (!bounds().Contains(point))
     return HTNOWHERE;
 
   // See if the point is within the incognito icon or the profile switcher menu.
   if ((profile_indicator_icon() &&
        profile_indicator_icon()->GetMirroredBounds().Contains(point)) ||
-      (profile_switcher_.view() &&
-       profile_switcher_.view()->GetMirroredBounds().Contains(point)))
+      (GetProfileSwitcherView() &&

[Peter Kasting, 2017/05/06 02:23:08]

Nit: I'm not a huge fan of changes like this in this file, because they now call
an expensive (by its name) function repeatedly, which we'd normally stuff in a
temp.

I'd just leave these like they were before, unless you envision the
functionality of GetProfileSwitcherView() becoming more complicated -- in which
case we might want to refactor this code (and similar elsewhere) to use temps to
avoid repeated calls. (many places)

[emx, 2017/05/09 16:26:51]

Reverted.

+       GetProfileSwitcherView()->GetMirroredBounds().Contains(point)))
     return HTCLIENT;
 
   int frame_component = frame()->client_view()->NonClientHitTest(point);
 
   // See if we're in the sysmenu region.  We still have to check the tabstrip
   // first so that clicks in a tab don't get treated as sysmenu clicks.
   int client_border_thickness = ClientBorderThickness(false);
   gfx::Rect sys_menu_region(
       client_border_thickness,
       display::win::ScreenWin::GetSystemMetricsInDIP(SM_CYSIZEFRAME),
@@ skipping 114 matching lines @@
     // must be called prior to LayoutProfileSwitcher().
     LayoutCaptionButtons();
     LayoutTitleBar();
   }
   if (browser_view()->IsRegularOrGuestSession())
     LayoutProfileSwitcher();
   LayoutIncognitoIcon();
   LayoutClientView();
 }
 
+void GlassBrowserFrameView::ChildPreferredSizeChanged(views::View* child) {
+  if (child == GetProfileSwitcherView()) {
+    // Need to layout the root view here, too, as the avatar button may change
+    // between the text and the icon when a profile is added or removed, which
+    // may in turn cause it to change between "tall" and "cozy" if it's right
+    // near the end of the tabstrip. LayoutProfileSwitcher() is not enough
+    // here - it does not re-draw the line below the tabstrip properly when a
+    // profile is added or removed and the avatar button changes between tall
+    // and cozy as a result.

[Peter Kasting, 2017/05/06 02:23:08]

This comment helps, but I'm still a bit confused by usage of words like "tall"
and "cozy", and by being uncertain about what happens to the tabstrip as the
avatar button changes shape here.  Is the core issue that the tabstrip bounds
can change?  If so, I would say that more directly.

[emx, 2017/05/09 16:26:51]

No, in this case the tabstrip bounds don't change, but the width of the button
changes, causing it to overlap the tabstrip. I've updated the comment to
hopefully make this clear.

+    frame()->GetRootView()->Layout();

[Peter Kasting, 2017/05/06 02:23:08]

Do we really need to layout the root view?  If the issue is that the tabstrip
needs relayout, isn't just asking the avatar button and the tabstrip to layout
enough?  If the problem is the portion of the toolbar top stroke drawn by the
frame view not repainting, are we missing a SchedulePaint()?

[emx, 2017/05/09 16:26:51]

I don't know enough to answer that. What I can say is that calling
  LayoutProfileSwitcher();
  browser_view()->tabstrip()->Layout();
is not enough, but calling
  frame()->GetRootView()->Layout();
is enough.

[Peter Kasting, 2017/05/09 17:40:28]

Then while I don't want to burden you, I think you need to dig more deeply to
understand why the first doesn't work and the second does, so you can do the
most efficient thing possible here and explain clearly to readers why anything
less doesn't suffice.  Also ensure that just adding SchedulePaint() after the
layout calls doesn't help.

[emx, 2017/05/10 17:38:48]

I tried adding SchedulePaint(); and that's still not enough.

While you say you don't WANT to burden me, trying to figure this out certainly
would. It could take me a long time to understand how Chrome views are painted
and I'm likely to need someone's help. At this point I don't even know where to
begin troubleshooting this. I'm generally all for understanding how things work,
rather than just doing something that seems to work by magic, but given the size
and complexity of the code base, there are plenty of cases where I simply follow
the pattern I find elsewhere in the code (in this case -
BrowserNonClientFrameViewAsh::ChildPreferredSizeChanged). I don't think it's
realistic to block this CL on every single thing I don't understand.

Do you really think that there is a performance issue here, considering that
this code only gets called when a user adds or removes a profile? I don't notice
any performance issue in my testing, either (delay or anything "blinking",
etc.), even in the debug build.

[Peter Kasting, 2017/05/11 01:03:42]

OK.  Let's leave it doing a Layout on the root view as you have it, with a TODO
for estade to dig deeper.

[emx, 2017/05/11 12:56:10]

Done.

[Evan Stade, 2017/05/11 14:29:09]

I'm not the right one to dig deeper on this Windows only code.

[Peter Kasting, 2017/05/11 15:04:34]

OK, for now have bsep own this.

+  }
+}
+
 ///////////////////////////////////////////////////////////////////////////////
 // GlassBrowserFrameView, protected:
 
 // BrowserNonClientFrameView:
 void GlassBrowserFrameView::UpdateProfileIcons() {
   if (browser_view()->IsRegularOrGuestSession())
     profile_switcher_.Update(AvatarButtonStyle::NATIVE);
   else
     UpdateProfileIndicatorIcon();
 }
 
 ///////////////////////////////////////////////////////////////////////////////
 // GlassBrowserFrameView, private:
 
 // views::NonClientFrameView:
 bool GlassBrowserFrameView::DoesIntersectRect(const views::View* target,
                                               const gfx::Rect& rect) const {
   if (ShouldCustomDrawSystemTitlebar())
     return BrowserNonClientFrameView::DoesIntersectRect(target, rect);
 
   // TODO(bsep): This override has "dead zones" where you can't click on the
   // custom titlebar buttons. It's not clear why it's necessary at all.
   // Investigate tearing this out.
   CHECK_EQ(target, this);
   bool hit_incognito_icon =
       profile_indicator_icon() &&
       profile_indicator_icon()->GetMirroredBounds().Intersects(rect);
   bool hit_profile_switcher_button =
-      profile_switcher_.view() &&
-      profile_switcher_.view()->GetMirroredBounds().Intersects(rect);
+      GetProfileSwitcherView() &&
+      GetProfileSwitcherView()->GetMirroredBounds().Intersects(rect);
   return hit_incognito_icon || hit_profile_switcher_button ||
          !frame()->client_view()->bounds().Intersects(rect);
 }
 
 int GlassBrowserFrameView::ClientBorderThickness(bool restored) const {
   // The frame ends abruptly at the 1 pixel window border drawn by Windows 10.
   if (!browser_view()->HasClientEdge())
     return 0;
 
   if ((IsMaximized() || frame()->IsFullscreen()) && !restored)
@@ skipping 259 matching lines @@
                                                 gfx::Canvas* canvas) const {
   gfx::Rect side(x - kClientEdgeThickness, y, kClientEdgeThickness,
                  bottom + kClientEdgeThickness - y);
   canvas->FillRect(side, color);
   canvas->FillRect(gfx::Rect(x, bottom, right - x, kClientEdgeThickness),
                    color);
   side.set_x(right);
   canvas->FillRect(side, color);
 }
 
+void GlassBrowserFrameView::TabStripMaxXChanged(TabStrip* tab_strip) {
+  // May switch between cozy and tall MD avatar button here.

[Peter Kasting, 2017/05/06 02:23:08]

Nit: Avoid referring to "MD" in code ever, since it can mean many different
things.  Also, once again, terms like "cozy" are context-free here.  Just saying
"The profile switcher button's height depends on the position of the new tab
button." would be clear and unambiguous.

[emx, 2017/05/09 16:26:51]

Done.

+  DCHECK_EQ(tab_strip, tab_strip_);

[Peter Kasting, 2017/05/06 02:23:08]

Nit: I'd remove this DCHECK and the similar ones below, as it doesn't seem like
they verify something any maintainer would ever question or violate.

[emx, 2017/05/09 16:26:51]

Done.

+  LayoutProfileSwitcher();
+}
+
+void GlassBrowserFrameView::TabStripRemovedTabAt(TabStrip* tab_strip,
+                                                 int index) {
+  // May switch between cozy and tall button here, too. TabStripMaxXChanged
+  // is not enough when a tab other than the last tab is closed.

[Peter Kasting, 2017/05/06 02:23:08]

Hrm.  This seems like it means that closing the last tab will snap the button
larger, but then when the mouse moves away and the strip animates back to the
right, the button will snap smaller again.

I wonder if instead the button should stay the size it is until the tabstrip
begins to resize, and at that point, if it's going to get bigger, it should do
so.  This also suggests that any time the button changes size, the size change
should be animated.  That may be beyond the scope of this CL, but consider it as
part of the interaction design here.

[emx, 2017/05/09 16:26:51]

Acknowledged.

+  DCHECK_EQ(tab_strip, tab_strip_);
+  LayoutProfileSwitcher();
+}
+
+void GlassBrowserFrameView::TabStripDeleted(TabStrip* tab_strip) {

[Peter Kasting, 2017/05/06 02:23:08]

Does this happen before frame destruction?

[emx, 2017/05/09 16:26:51]

I've never seen this method called at all, but I copied it from
BrowserNonClientFrameViewMus::TabStripDeleted (along with the rest of the
TabStripObserver-related code).

[Peter Kasting, 2017/05/09 17:40:28]

Hmm.  I think you should ask the author/OWNERs of that code what's going on and
whether this is truly necessary.  I'm willing to believe it is, but I don't want
to cargo-cult copy and paste.

[emx, 2017/05/10 17:38:48]

OK, I've asked him (it was sky@) and he said that it's not necessary and a
DCHECK in TabStripDeleted should be enough.

[emx, 2017/05/11 12:56:10]

I've replaced the contents with a NOTREACHED().

+  DCHECK_EQ(tab_strip, tab_strip_);
+  DCHECK(tab_strip_);
+  tab_strip_->RemoveObserver(this);
+  tab_strip_ = nullptr;
+}
+
 void GlassBrowserFrameView::LayoutProfileSwitcher() {
   DCHECK(browser_view()->IsRegularOrGuestSession());
-  if (!profile_switcher_.view())
+
+  View* button_view = GetProfileSwitcherView();
+  if (!button_view)
     return;
 
-  gfx::Size label_size = profile_switcher_.view()->GetPreferredSize();
+  gfx::Size button_size = button_view->GetPreferredSize();
+  int button_width = button_size.width();
+  int button_height = button_size.height();
 
   int button_x;
   if (CaptionButtonsOnLeadingEdge()) {
     button_x = width() - frame()->GetMinimizeButtonOffset() +
                kProfileSwitcherButtonOffset;
   } else {
-    button_x =
-        MinimizeButtonX() - kProfileSwitcherButtonOffset - label_size.width();
+    button_x = MinimizeButtonX() - kProfileSwitcherButtonOffset - button_width;
   }
 
   int button_y = WindowTopY();
   if (IsMaximized()) {
     // In maximized mode the caption buttons appear only 19 pixels high, but
     // their contents are aligned as if they were 20 pixels high and extended
     // 1 pixel off the top of the screen. We position the profile switcher
     // button the same way to match.
     button_y -= 1;
   }
-  profile_switcher_.view()->SetBounds(button_x, button_y, label_size.width(),
-                                      kProfileSwitcherButtonHeight);
+
+  // Does the button need to slide over the tabstrip? If so, use its minimum
+  // height. In RTL the new tab button is on the left, so it can never slide

[Peter Kasting, 2017/05/06 02:23:08]

Nit: First two sentences could just be "Shrink the button height when it's atop
part of the tabstrip."

[emx, 2017/05/09 16:26:51]

Done.

+  // under the avatar button (which is still on the right).

[Peter Kasting, 2017/05/06 02:23:08]

Nit: You might want to note that caption buttons being on the right in RTL is
bug 560619.

You might also want to consider placing the profile switcher on the left in RTL,
away from the caption buttons.  The fact that they're on the right is
nonstandard Windows behavior and a bug in Chrome; we don't need to perpetuate it
with our custom buttons.

[emx, 2017/05/09 16:26:51]

I've added a comment about that bug, which already mentions that the avatar
button "probably" should be on the left in RTL. That's a can of worms I really
don't want to open in this CL.

[Peter Kasting, 2017/05/09 17:40:28]

Oh?  What's particularly daunting about it?  It seems like a pretty small change
that I'd think would make the code simpler overall.  I didn't expect any worms
to ooze out.

[emx, 2017/05/10 17:38:48]

For one, I'm not sure that there is agreement on where the button should be in
RTL. I don't even know who makes that decision. So just to confirm the
requirement can take a while. Then there is implementing the change. Maybe it's
simple for you, but I haven't looked into how to change the position of the
button, since it has very little to do with this CL. Then there is testing it -
even if it looks OK at first glance, there may be edge cases where it breaks. If
it does break, and it's part of this CL, then this entire CL may get reverted
when it didn't need to be.

[Peter Kasting, 2017/05/11 01:03:42]

Yes, your objections are fair.  If this were to be done, it would make much more
sense to do as a separate CL.

+  if (tab_strip_ && !base::i18n::IsRTL() && tab_strip_->max_x() >= button_x)
+    button_height = button_view->GetMinimumSize().height();
+
+  button_view->SetBounds(button_x, button_y, button_width, button_height);
 }
 
 void GlassBrowserFrameView::LayoutIncognitoIcon() {
   const gfx::Size size(GetIncognitoAvatarIcon().size());
   int x = ClientBorderThickness(false);
   // In RTL, the icon needs to start after the caption buttons.
   if (CaptionButtonsOnLeadingEdge()) {
     x = width() - frame()->GetMinimizeButtonOffset() +
-        (profile_switcher_.view() ? (profile_switcher_.view()->width() +
+        (GetProfileSwitcherView() ? (GetProfileSwitcherView()->width() +
                                      kProfileSwitcherButtonOffset)
                                   : 0);
   }
   const int bottom = GetTopInset(false) + browser_view()->GetTabStripHeight() -
                      kAvatarIconPadding;
   incognito_bounds_.SetRect(
       x + (profile_indicator_icon() ? kAvatarIconPadding : 0),
       bottom - size.height(), profile_indicator_icon() ? size.width() : 0,
       size.height());
   if (profile_indicator_icon())
@@ skipping 152 matching lines @@
   static bool initialized = false;
   if (!initialized) {
     for (int i = 0; i < kThrobberIconCount; ++i) {
       throbber_icons_[i] =
           ui::LoadThemeIconFromResourcesDataDLL(IDI_THROBBER_01 + i);
       DCHECK(throbber_icons_[i]);
     }
     initialized = true;
   }
 }