Add AppLauncherId wrapper for items shown in shelf

chrome/browser/ui/ash/chrome_launcher_prefs.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.
 
 #ifndef CHROME_BROWSER_UI_ASH_CHROME_LAUNCHER_PREFS_H_
 #define CHROME_BROWSER_UI_ASH_CHROME_LAUNCHER_PREFS_H_
 
 #include <memory>
 #include <string>
 #include <vector>
@@ skipping 33 matching lines @@
 
 // Values used for prefs::kShelfAutoHideBehavior.
 extern const char kShelfAutoHideBehaviorAlways[];
 extern const char kShelfAutoHideBehaviorNever[];
 
 // Values used for prefs::kShelfAlignment.
 extern const char kShelfAlignmentBottom[];
 extern const char kShelfAlignmentLeft[];
 extern const char kShelfAlignmentRight[];
 
+// A unique chrome launcher id used to identify a shelf item. This class is a
+// wrapper for the chrome launcher identifier. |app_launcher_id_| includes the
+// |app_id| and the |launch_id|. The |app_id| is the application id associated
+// with a set of windows. The |launch_id| is an id that can be passed to an app
+// when launched in order to support multiple shelf items per app. This id is
+// used together with the |app_id| to uniquely identify each shelf item that
+// has the same |app_id|.

[James Cook, 2016/10/04 16:08:37]

Nice docs, btw.

+class AppLauncherId {
+ public:
+  explicit AppLauncherId(const std::string& app_id);
+  // This constructor is currently unused, but will be used in a follow-up CL.

[msw, 2016/10/04 17:09:24]

This would better as a code review comment, not a comment in the code itself.

[Andra Paraschiv, 2016/10/05 11:21:58]

Done.

+  AppLauncherId(const std::string& app_id, const std::string& launch_id);
+  AppLauncherId(const AppLauncherId& app_launcher_id) = default;

[James Cook, 2016/10/04 16:08:37]

super nit: Put copy constructor and operator= together, after constructors and
destructors:

Foo()
~Foo()

Foo(const Foo& foo) = default
Foo& operator=(const Foo& foo) = default

like base/weak_reference.h

optional: You may want move-construction as well (Foo&&)

[Andra Paraschiv, 2016/10/05 11:21:58]

Done.

+  ~AppLauncherId();
+
+  const std::string& GetAsString() const { return app_launcher_id_; }
+
+  AppLauncherId& operator=(const AppLauncherId& other) = default;
+
+  bool operator==(const AppLauncherId& other) const;
+
+  bool operator!=(const AppLauncherId& other) const;
+
+  bool operator<(const AppLauncherId& other) const;
+
+  bool operator<=(const AppLauncherId& other) const;
+
+  bool operator>(const AppLauncherId& other) const;
+
+  bool operator>=(const AppLauncherId& other) const;
+
+ private:
+  // A unique chrome launcher id for a shelf item.
+  std::string app_launcher_id_;
+};
+
 void RegisterChromeLauncherUserPrefs(
     user_prefs::PrefRegistrySyncable* registry);
 
-base::DictionaryValue* CreateAppDict(const std::string& app_id);
+base::DictionaryValue* CreateAppDict(const AppLauncherId& app_launcher_id);
 
 // Get or set the shelf auto hide behavior preference for a particular display.
 ShelfAutoHideBehavior GetShelfAutoHideBehaviorPref(PrefService* prefs,
                                                    int64_t display_id);
 void SetShelfAutoHideBehaviorPref(PrefService* prefs,
                                   int64_t display_id,
                                   ShelfAutoHideBehavior behavior);
 
 // Get or set the shelf alignment preference for a particular display.
 ShelfAlignment GetShelfAlignmentPref(PrefService* prefs, int64_t display_id);
 void SetShelfAlignmentPref(PrefService* prefs,
                            int64_t display_id,
                            ShelfAlignment alignment);
 
 // Get the list of pinned apps from preferences.
-std::vector<std::string> GetPinnedAppsFromPrefs(
+std::vector<AppLauncherId> GetPinnedAppsFromPrefs(
     const PrefService* prefs,
     LauncherControllerHelper* helper);
 
 // Removes information about pin position from sync model for the app.
-void RemovePinPosition(Profile* profile, const std::string& app_id);
+void RemovePinPosition(Profile* profile, const AppLauncherId& app_launcher_id);
 
-// Updates information about pin position in sync model for the app |app_id|.
-// |app_id_before| optionally specifies an app that exists right before the
-// target app. |app_ids_after| optionally specifies sorted by position apps that
-// exist right after the target app.
+// Updates information about pin position in sync model for the app
+// |app_launcher_id|. |app_launcher_id_before| optionally specifies an app that
+// exists right before the target app. |app_launcher_ids_after| optionally
+// specifies sorted by position apps that exist right after the target app.
 void SetPinPosition(Profile* profile,
-                    const std::string& app_id,
-                    const std::string& app_id_before,
-                    const std::vector<std::string>& app_ids_after);
+                    const AppLauncherId& app_launcher_id,
+                    const AppLauncherId& app_launcher_id_before,
+                    const std::vector<AppLauncherId>& app_launcher_ids_after);
 
 // Used to propagate remote preferences to local during the first run.
 class ChromeLauncherPrefsObserver
     : public syncable_prefs::PrefServiceSyncableObserver {
  public:
   // Creates and returns an instance of ChromeLauncherPrefsObserver if the
   // profile prefs do not contain all the necessary local settings for the
   // shelf. If the local settings are present, returns null.
   static std::unique_ptr<ChromeLauncherPrefsObserver> CreateIfNecessary(
       Profile* profile);
@@ skipping 10 matching lines @@
   // Profile prefs. Not owned.
   syncable_prefs::PrefServiceSyncable* prefs_;
 
   DISALLOW_COPY_AND_ASSIGN(ChromeLauncherPrefsObserver);
 };
 
 }  // namespace launcher
 }  // namespace ash
 
 #endif  // CHROME_BROWSER_UI_ASH_CHROME_LAUNCHER_PREFS_H_