ToolbarView MaterialDesign in ThemeProvider

chrome/browser/themes/theme_properties.cc

 // Copyright (c) 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 "chrome/browser/themes/theme_properties.h"
 
 #include "base/memory/scoped_ptr.h"
 #include "base/strings/string_split.h"
 #include "base/strings/string_util.h"
 #include "chrome/browser/themes/browser_theme_pack.h"
 #include "grit/theme_resources.h"
+#include "ui/base/resource/material_design/material_design_controller.h"
 #include "ui/resources/grit/ui_resources.h"
 
 namespace {
 
 // ----------------------------------------------------------------------------
 // Defaults for properties which are stored in the browser theme pack. If you
 // change these defaults, you must increment the version number in
 // browser_theme_pack.h
 
 // Default colors.
@@ skipping 67 matching lines @@
 #if defined(OS_MACOSX)
 const SkColor kDefaultColorToolbarButtonStroke = SkColorSetARGB(75, 81, 81, 81);
 const SkColor kDefaultColorToolbarButtonStrokeInactive =
     SkColorSetARGB(75, 99, 99, 99);
 const SkColor kDefaultColorToolbarBezel = SkColorSetRGB(204, 204, 204);
 const SkColor kDefaultColorToolbarStroke = SkColorSetRGB(103, 103, 103);
 const SkColor kDefaultColorToolbarStrokeInactive = SkColorSetRGB(163, 163, 163);
 #endif
 
 // ----------------------------------------------------------------------------
+// Defaults for layout properties, which are not stored in the browser theme

[Peter Kasting, 2015/07/03 20:13:08]

Nit: No comma

[jonross, 2015/07/06 18:36:20]

Done.

+// pack.
+
+// The edge graphics have some built-in spacing/shadowing, so we have to adjust
+// our spacing to make it match.
+const int kToolbarViewLeftEdgeSpacing = 3;
+const int kToolbarViewRightEdgeSpacing = 2;
+
+// Ash doesn't use a rounded content area and its top edge has an extra shadow.
+const int kToolbarViewContentShadowHeightAsh = 2;
+
+// Non-ash uses a rounded content area with no shadow in the assets.
+const int kToolbarViewContentShadowHeight = 0;
+
+#if defined(ENABLE_TOPCHROME_MD)
+const int kToolbarViewLeftEdgeSpacingMD = 4;

[Peter Kasting, 2015/07/03 20:13:08]

This file can be simpler and easier to maintain.

Instead of defining separate named constants for these, then writing separate
property getter functions with dupes of the switch statements, make a set of
constant arrays, each three elements long.  The elements are the constants for
the three modes, in the same order as MaterialDesignController::Mode.  Then you
can implement GetDefaultDisplayProperty() with a single switch statement a la:

  // The order of the constants in all following lines is:
  // MATERIAL, MATERIAL_HYBRID, NON_MATERIAL
  const int kToolbarViewLeftEdgeSpacing[] = { 4, 8, 3 };
  ...
  // The cast in the next line is not needed if Mode becomes a standard
  // enum instead of an enum class.
  int mode = static_cast<int>(ui::MaterialDesignController::GetMode());
  switch (id) {
    case ThemeProperties::PROPERTY_TOOLBAR_VIEW_LEFT_EDGE_SPACING:
      return kToolbarViewLeftEdgeSpacing[mode];
    ...

You will want to avoid protecting any of this code with ENABLE_TOPCHROME_MD,
since doing that is not necessary to get the functionality right (GetMode() will
be callable and do the right thing regardless), trying to add this #define will
just make the declaration and definition of the above more complicated, and in
general we should strive to avoid #ifdefs wherever possible.

P.S. Why is NON_MATERIAL enum value 2 instead of 0?  It would likely make not
only this code but similar code in other places easier to read quickly if the
"default, non-experimental" value was the first one in the enum.

[jonross, 2015/07/06 18:36:20]

Great idea!

I've switched this around to use the array. The switch case has been returned to
GetDefaultDisplayProperty, and the methods I added below have been removed.

I've updated MaterialDesignController's enum to have NON_MATERIAL be 0 to be
consistent with it as the default value.

+const int kToolbarViewLeftEdgeSpacingMDHybrid = 8;
+
+const int kToolbarViewRightEdgeSpacingMD = 4;
+const int kToolbarViewRightEdgeSpacingMDHybrid = 8;
+
+const int kToolbarViewContentShadowHeightAshMD = 0;
+const int kToolbarViewContentShadowHeightAshMDHybrid = 0;
+
+const int kToolbarViewContentShadowHeightMD = 0;
+const int kToolbarViewContentShadowHeightMDHybrid = 0;
+#endif
+
+// ----------------------------------------------------------------------------
 
 // Strings used in alignment properties.
 const char kAlignmentCenter[] = "center";
 const char kAlignmentTop[] = "top";
 const char kAlignmentBottom[] = "bottom";
 const char kAlignmentLeft[] = "left";
 const char kAlignmentRight[] = "right";
 
 // Strings used in background tiling repetition properties.
 const char kTilingNoRepeat[] = "no-repeat";
@@ skipping 19 matching lines @@
   IDR_BROWSER_ACTIONS_OVERFLOW_P,
   IDR_TOOLS, IDR_TOOLS_H, IDR_TOOLS_P,
   IDR_MENU_DROPARROW,
   IDR_TOOLBAR_BEZEL_HOVER, IDR_TOOLBAR_BEZEL_PRESSED, IDR_TOOLS_BAR,
 };
 
 SkColor TintForUnderline(SkColor input) {
   return SkColorSetA(input, SkColorGetA(input) / 3);
 }
 
+int GetDefaultDisplayPropertyInternal(int id) {

[Peter Kasting, 2015/07/03 20:13:08]

I'm not sure why the word "internal" is used here as these constants aren't more
or less internal than the other ones, nor is the concept of material design
"external".

I would use "NonMaterial" or the like.  That's also consistent with the enum
names in material_design_controller.h.

[jonross, 2015/07/06 18:36:20]

These methods have been removed.

+  switch (id) {
+    case ThemeProperties::NTP_BACKGROUND_ALIGNMENT:
+      return kDefaultDisplayPropertyNTPAlignment;
+    case ThemeProperties::NTP_BACKGROUND_TILING:
+      return kDefaultDisplayPropertyNTPTiling;
+    case ThemeProperties::NTP_LOGO_ALTERNATE:
+      return kDefaultDisplayPropertyNTPAlternateLogo;
+    case ThemeProperties::PROPERTY_TOOLBAR_VIEW_LEFT_EDGE_SPACING:
+      return kToolbarViewLeftEdgeSpacing;
+    case ThemeProperties::PROPERTY_TOOLBAR_VIEW_RIGHT_EDGE_SPACING:
+      return kToolbarViewRightEdgeSpacing;
+    case ThemeProperties::PROPERTY_TOOLBAR_VIEW_CONTENT_SHADOW_HEIGHT_ASH:
+      return kToolbarViewContentShadowHeightAsh;
+    case ThemeProperties::PROPERTY_TOOLBAR_VIEW_CONTENT_SHADOW_HEIGHT:
+      return kToolbarViewContentShadowHeight;
+  }
+
+  return -1;
+}
+
+#if defined(ENABLE_TOPCHROME_MD)
+int GetMaterialDefaultDisplayProperty(int id) {
+  switch (id) {
+    case ThemeProperties::PROPERTY_TOOLBAR_VIEW_LEFT_EDGE_SPACING:
+      return kToolbarViewLeftEdgeSpacingMD;
+    case ThemeProperties::PROPERTY_TOOLBAR_VIEW_RIGHT_EDGE_SPACING:
+      return kToolbarViewRightEdgeSpacingMD;
+    case ThemeProperties::PROPERTY_TOOLBAR_VIEW_CONTENT_SHADOW_HEIGHT_ASH:
+      return kToolbarViewContentShadowHeightAshMD;
+    case ThemeProperties::PROPERTY_TOOLBAR_VIEW_CONTENT_SHADOW_HEIGHT:
+      return kToolbarViewContentShadowHeightMD;
+    default:
+      return GetDefaultDisplayPropertyInternal(id);
+  }
+
+  return -1;
+}
+
+int GetMaterialHybridDefaultDisplayProperty(int id) {
+  switch (id) {
+    case ThemeProperties::PROPERTY_TOOLBAR_VIEW_LEFT_EDGE_SPACING:
+      return kToolbarViewLeftEdgeSpacingMDHybrid;
+    case ThemeProperties::PROPERTY_TOOLBAR_VIEW_RIGHT_EDGE_SPACING:
+      return kToolbarViewRightEdgeSpacingMDHybrid;
+    case ThemeProperties::PROPERTY_TOOLBAR_VIEW_CONTENT_SHADOW_HEIGHT_ASH:
+      return kToolbarViewContentShadowHeightAshMDHybrid;
+    case ThemeProperties::PROPERTY_TOOLBAR_VIEW_CONTENT_SHADOW_HEIGHT:
+      return kToolbarViewContentShadowHeightMDHybrid;
+    default:
+      return GetMaterialDefaultDisplayProperty(id);
+  }
+  return -1;
+}
+#endif
+
 }  // namespace
 
 // static
 int ThemeProperties::StringToAlignment(const std::string& alignment) {
   std::vector<std::string> split;
   base::SplitStringAlongWhitespace(alignment, &split);
 
   int alignment_mask = 0;
   for (std::vector<std::string>::iterator component(split.begin());
        component != split.end(); ++component) {
@@ skipping 144 matching lines @@
       return kDefaultColorToolbarStrokeInactive;
 #endif
     default:
       // Return a debugging red color.
       return SK_ColorRED;
   }
 }
 
 // static
 int ThemeProperties::GetDefaultDisplayProperty(int id) {
-  switch (id) {
-    case NTP_BACKGROUND_ALIGNMENT:
-      return kDefaultDisplayPropertyNTPAlignment;
-    case NTP_BACKGROUND_TILING:
-      return kDefaultDisplayPropertyNTPTiling;
-    case NTP_LOGO_ALTERNATE:
-      return kDefaultDisplayPropertyNTPAlternateLogo;
+#if defined(ENABLE_TOPCHROME_MD)
+  switch (ui::MaterialDesignController::GetMode()) {
+    case (ui::MaterialDesignController::Mode::MATERIAL):
+      return GetMaterialDefaultDisplayProperty(id);
+    case (ui::MaterialDesignController::Mode::MATERIAL_HYBRID):
+      return GetMaterialHybridDefaultDisplayProperty(id);
+    case (ui::MaterialDesignController::Mode::NON_MATERIAL):
+      return GetDefaultDisplayPropertyInternal(id);
   }
-
-  return -1;
+#endif
+  return GetDefaultDisplayPropertyInternal(id);
 }