Refactor of BrowserDistribution.

chrome/installer/util/browser_distribution.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.
 //
 // This file defines a class that contains various method related to branding.
 // It provides only default implementations of these methods. Usually to add
 // specific branding, we will need to extend this class with a custom
 // implementation.
 
 #include "chrome/installer/util/browser_distribution.h"
@@ skipping 48 matching lines @@
   static BrowserDistribution::Type type =
       (MasterPreferences::ForCurrentProcess().install_chrome_frame() ||
        IsChromeFrameModule()) ?
           BrowserDistribution::CHROME_FRAME :
           BrowserDistribution::CHROME_BROWSER;
   return type;
 }
 
 }  // end namespace
 
+const char* BrowserDistribution::kDefaultAlternateChromeShortcutName =

[gab, 2013/07/05 14:23:37]

Actually, this probably belongs more at the bottom of
chrome/installer/util/util_constants.cc

And please use char[] instead of char*.

---------------------

Actually, another comment below makes the need for one of these hardcoded string
go away, so that you can inline this back where it belongs in
browser_distribution.cc without even needing a global constant :).

[grt (UTC plus 2), 2013/07/05 17:27:37]

comment on comment: my gut tells me that static initializers should come before
the ctors at the top of the implementation, not at the end of the file.

+    "The Internet";
+
 BrowserDistribution::BrowserDistribution()
     : type_(CHROME_BROWSER) {
 }
 
 BrowserDistribution::BrowserDistribution(Type type)
     : type_(type) {
 }
 
 template<class DistributionClass>
 BrowserDistribution* BrowserDistribution::GetOrCreateBrowserDistribution(
@@ skipping 68 matching lines @@
 }
 
 string16 BrowserDistribution::GetAppGuid() {
   return L"";
 }
 
 string16 BrowserDistribution::GetBaseAppName() {
   return L"Chromium";
 }
 
-string16 BrowserDistribution::GetAppShortCutName() {
-  return GetBaseAppName();
+string16 BrowserDistribution::GetDisplayName() {
+  return GetShortcutName(SHORTCUT_CHROME);
 }
 
-string16 BrowserDistribution::GetAlternateApplicationName() {
-  return L"The Internet";
+string16 BrowserDistribution::GetShortcutName(ShortcutType shortcut_type) {
+  switch (shortcut_type) {

[grt (UTC plus 2), 2013/07/05 17:27:37]

for all functions like this, make the NOTREACHED case do something sensible.
it's better to return some wrong value in a release build than to return a
nonsensical value. my suggestion here is:
  switch (shortcut_type) {
    case SHORTCUT_ALTERNATE_CHROME:
      // TODO(calamity): Change IDS_OEM_MAIN_SHORTCUT_NAME in
      // chromium_strings.grd to "The Internet" (so that it doesn't collide with
      // the value in google_chrome_strings.grd) then change this to
      // installer::GetLocalizedString(IDS_OEM_MAIN_SHORTCUT_NAME_BASE)
      return L"The Internet";
    case SHORTCUT_APP_LAUNCHER:
      return installer::GetLocalizedString(IDS_APP_LIST_SHORTCUT_NAME_BASE);
    default:
      DCHECK_EQ(shortcut_type, SHORTCUT_CHROME);
      return GetBaseAppName();
  }

you'll also need to add IDS_APP_LIST_SHORTCUT_NAME to kStringIds in
chrome/installer/util/prebuild/create_string_rc.py.

[calamity, 2013/07/16 04:05:17]

Done. Any reason to use DCHECK_EQ instead of NOTREACHED()?

[grt (UTC plus 2), 2013/07/16 19:38:44]

DCHECK_EQ will show the value that shouldn't have happened in the log. Also, I'm
not sure how you'd structure the code to use NOTREACHED without having any
duplicate code. I suppose you could have case SHORTCUT_CHROME: break; default:
NOTREACHED(); break; } return GetBaseAppName(), but I find my suggested
structure more concise and clear.

+    case SHORTCUT_CHROME:
+      return GetBaseAppName();
+    case SHORTCUT_ALTERNATE_CHROME:
+      return L"The Internet";
+    case SHORTCUT_APP_LAUNCHER:
+      return L"Chromium App Launcher";
+    default:
+      NOTREACHED();
+      return string16();
+  }
+}
+
+string16 BrowserDistribution::GetStartMenuShortcutSubfolder(
+    Subfolder subfolder_type) {
+  switch (subfolder_type) {

[grt (UTC plus 2), 2013/07/05 17:27:37]

as above:
  DCHECK_EQ(subfolder_type, SUBFOLDER_CHROME);
  return GetShortcutName(SHORTCUT_CHROME);

[calamity, 2013/07/16 04:05:17]

Done.

+    case SUBFOLDER_CHROME:
+      return GetShortcutName(SHORTCUT_CHROME);
+    default:
+      NOTREACHED();
+      return string16();
+  }
 }
 
 string16 BrowserDistribution::GetBaseAppId() {
   return L"Chromium";
 }
 
 string16 BrowserDistribution::GetInstallSubDir() {
   return L"Chromium";
 }
 
@@ skipping 48 matching lines @@
 }
 
 bool BrowserDistribution::CanSetAsDefault() {
   return true;
 }
 
 bool BrowserDistribution::CanCreateDesktopShortcuts() {
   return true;
 }
 
 string16 BrowserDistribution::GetIconFilename() {

[grt (UTC plus 2), 2013/07/05 17:27:37]

move this up so that it immediately precedes GetStartMenuShortcutSubfolder

[calamity, 2013/07/16 04:05:17]

Done.

   return string16();

[grt (UTC plus 2), 2013/07/05 17:27:37]

how do icons work for Chromium builds?

[calamity, 2013/07/16 04:05:17]

I'm not sure. Does anybody else know?

[grt (UTC plus 2), 2013/07/16 19:38:44]

I just installed Chromium r211796, and the uninstall link in the Programs and
Features control panel is missing its icon because of this. I wonder how long
it's been broken. Please change this to return installer::kChromeExe and add
issue 161985 to the list of those fixed by this CL.

[grt (UTC plus 2), 2013/07/18 17:43:43]

ping

 }
 
-int BrowserDistribution::GetIconIndex() {
-  // Assuming that main icon appears first alphabetically in the resource file
-  // for GetIconFilename().
-  return 0;
+int BrowserDistribution::GetIconIndex(ShortcutType shortcut_type) {

[grt (UTC plus 2), 2013/07/05 17:27:37]

move this up so that it immediately follows GetShortcutName

[calamity, 2013/07/16 04:05:17]

Done.

+  switch (shortcut_type) {

[grt (UTC plus 2), 2013/07/05 17:27:37]

as elsewhere:
  if (shortcut_type == SHORTCUT_APP_LAUNCHER)
    return kAppLauncherIconIndex;  (1, defined in the unnamed namespace)
  DCHECK(shortcut_type == SHORTCUT_CHROME ||
         shortcut_type == SHORTCUT_ALTERNATE_CHROME) << shortcut_type;
  return 0;

Also, please make kAppLauncherIconIndex a file-local constant in the unnamed
namespace and put a comment next to it along the lines of
// The Chromium App Launcher icon is index 1; see chrome_exe.rc.

[calamity, 2013/07/16 04:05:17]

Done.

+    case SHORTCUT_CHROME:
+    case SHORTCUT_ALTERNATE_CHROME:
+      // Assuming that main icon appears first alphabetically in the resource
+      // file for GetIconFilename().
+      return 0;
+    case SHORTCUT_APP_LAUNCHER:
+      return 1;
+    default:
+      NOTREACHED();
+      return 0;
+  }
 }
 
 bool BrowserDistribution::GetChromeChannel(string16* channel) {
   return false;
 }
 
 bool BrowserDistribution::GetCommandExecuteImplClsid(
     string16* handler_class_uuid) {
   if (handler_class_uuid)
     *handler_class_uuid = kCommandExecuteImplUuid;
   return true;
 }
 
 bool BrowserDistribution::AppHostIsSupported() {
   return false;
 }
 
 void BrowserDistribution::UpdateInstallStatus(bool system_install,
     installer::ArchiveType archive_type,
     installer::InstallStatus install_status) {
 }
 
 bool BrowserDistribution::ShouldSetExperimentLabels() {
   return false;
 }
 
 bool BrowserDistribution::HasUserExperiments() {
   return false;
 }