Refactor of BrowserDistribution.

chrome/installer/util/browser_distribution.h

 // 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 declares a class that contains various method related to branding.
 
 #ifndef CHROME_INSTALLER_UTIL_BROWSER_DISTRIBUTION_H_
 #define CHROME_INSTALLER_UTIL_BROWSER_DISTRIBUTION_H_
 
 #include <string>
@@ skipping 11 matching lines @@
 class BrowserDistribution {
  public:
   enum Type {
     CHROME_BROWSER,
     CHROME_FRAME,
     CHROME_BINARIES,
     CHROME_APP_HOST,
     NUM_TYPES
   };
 
+  enum ShortcutEnum {

[grt (UTC plus 2), 2013/06/28 04:35:21]

i don't think the suffix "Enum" is idiomatic. please remove it. name the type
for what it represents, not what it is (i.e., you wouldn't change
BrowserDistribution to BrowserDistributionClass).

[calamity, 2013/07/05 09:00:29]

I think this name was suggested offhand in another review. Fixed.

+    SHORTCUT_CHROME,
+    SHORTCUT_ALTERNATE_CHROME,
+    SHORTCUT_APP_LAUNCHER
+  };
+
+  enum SubfolderEnum {
+    SUBFOLDER_CHROME,
+    // TODO(calamity): add SUBFOLDER_APPS when refactoring chrome app dir code.
+  };
+
   virtual ~BrowserDistribution() {}
 
   static BrowserDistribution* GetDistribution();
 
   static BrowserDistribution* GetSpecificDistribution(Type type);
 
   Type GetType() const { return type_; }
 
   virtual void DoPostUninstallOperations(const Version& version,
                                          const base::FilePath& local_data_path,
                                          const string16& distribution_data);
 
   // Returns the GUID to be used when registering for Active Setup.
   virtual string16 GetActiveSetupGuid();
 
   virtual string16 GetAppGuid();
 
   // Returns the unsuffixed application name of this program.
   // This is the base of the name registered with Default Programs on Windows.
   // IMPORTANT: This should only be called by the installer which needs to make
   // decisions on the suffixing of the upcoming install, not by external callers
   // at run-time.
   virtual string16 GetBaseAppName();
 
-  // Returns the localized name of the program.
-  virtual string16 GetAppShortCutName();
+  // Returns the display name of this distribution.
+  virtual string16 GetDisplayName();
 
-  virtual string16 GetAlternateApplicationName();
+  virtual string16 GetShortcutName(ShortcutEnum shortcut_enum);

[gab, 2013/06/27 11:49:43]

Add a comment to this method too, e.g.:

// Returns the name of the shortcut identified by |shortcut_enum| for this
// distribution.

[grt (UTC plus 2), 2013/06/28 04:35:21]

please remove _enum here and elsewhere

[calamity, 2013/07/05 09:00:29]

Done.

+  // Returns the index of the icon for the product, inside the file specified by
+  // GetIconFilename().

[gab, 2013/06/27 11:49:43]

Mention what is |shortcut_enum| in this comment (ref. comment proposition
above).

[calamity, 2013/07/05 09:00:29]

Done.

+  virtual int GetIconIndex(ShortcutEnum shortcut_enum);
+  // Returns the executable filename (not path) that contains the product icon.
+  virtual string16 GetIconFilename();
+
+  // Returns the name of the subfolder in the Start Menu that this distribution
+  // should create shortcuts in.

[gab, 2013/06/27 11:49:43]

Mention what is |subfolder_enum| in this comment.

[calamity, 2013/07/05 09:00:29]

Done.

+  virtual string16 GetStartMenuShortcutSubfolder(SubfolderEnum subfolder_enum);
 
   // Returns the unsuffixed appid of this program.
   // The AppUserModelId is a property of Windows programs.
   // IMPORTANT: This should only be called by ShellUtil::GetAppId as the appid
   // should be suffixed in all scenarios.
   virtual string16 GetBaseAppId();
 
   virtual string16 GetInstallSubDir();
 
   virtual string16 GetPublisherName();
@@ skipping 19 matching lines @@
   virtual string16 GetUninstallLinkName();
 
   virtual string16 GetUninstallRegPath();
 
   virtual string16 GetVersionKey();
 
   virtual bool CanSetAsDefault();
 
   virtual bool CanCreateDesktopShortcuts();
 
-  // Returns the executable filename (not path) that contains the product icon.
-  virtual string16 GetIconFilename();
-
-  // Returns the index of the icon for the product, inside the file specified by
-  // GetIconFilename().
-  virtual int GetIconIndex();
-
   virtual bool GetChromeChannel(string16* channel);
 
   // Returns true if this distribution includes a DelegateExecute verb handler,
   // and provides the CommandExecuteImpl class UUID if |handler_class_uuid| is
   // non-NULL.
   virtual bool GetCommandExecuteImplClsid(string16* handler_class_uuid);
 
   // Returns true if this distribution uses app_host.exe to run platform apps.
   virtual bool AppHostIsSupported();
 
@@ skipping 16 matching lines @@
 
   const Type type_;
 
  private:
   BrowserDistribution();
 
   DISALLOW_COPY_AND_ASSIGN(BrowserDistribution);
 };
 
 #endif  // CHROME_INSTALLER_UTIL_BROWSER_DISTRIBUTION_H_