cros: Implement default app ordering.

chrome/browser/extensions/extension_sorting.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_EXTENSIONS_EXTENSION_SORTING_H_
 #define CHROME_BROWSER_EXTENSIONS_EXTENSION_SORTING_H_
 
 #include <map>
 #include <string>
 
@@ skipping 19 matching lines @@
   // |extension_ids|.
   void Initialize(
       const extensions::ExtensionPrefs::ExtensionIds& extension_ids);
 
   // Resolves any conflicts the might be created as a result of syncing that
   // results in two icons having the same page and app launch ordinal. After
   // this is called it is guaranteed that there are no collisions of NTP icons.
   void FixNTPOrdinalCollisions();
 
   // This ensures that the extension has valid ordinals, and if it doesn't then
-  // properly initialize them.
-  void EnsureValidOrdinals(const std::string& extension_id);
+  // properly initialize them. |suggested_page| will be used if it is valid and
+  // the extension has no valid user-set page ordinal.
+  void EnsureValidOrdinals(const std::string& extension_id,
+                           const syncer::StringOrdinal& suggested_page);
 
   // Updates the app launcher value for the moved extension so that it is now
   // located after the given predecessor and before the successor.
   // Empty strings are used to indicate no successor or predecessor.
   void OnExtensionMoved(const std::string& moved_extension_id,
                         const std::string& predecessor_extension_id,
                         const std::string& successor_extension_id);
 
   // Get the application launch ordinal for an app with |extension_id|. This
   // determines the order in which the app appears on the page it's on in the
@@ skipping 42 matching lines @@
   // O(# of apps) worst-case.
   int PageStringOrdinalAsInteger(
       const syncer::StringOrdinal& page_ordinal) const;
 
   // Converts the page index integer to its StringOrdinal equivalent. This takes
   // O(# of apps) worst-case.
   syncer::StringOrdinal PageIntegerAsStringOrdinal(size_t page_index);
 
  private:
   // Unit tests.
+  friend class ExtensionSortingDefaultOrdinalsBase;
   friend class ExtensionSortingGetMinOrMaxAppLaunchOrdinalsOnPage;
   friend class ExtensionSortingInitializeWithNoApps;
   friend class ExtensionSortingPageOrdinalMapping;
 
   // An enum used by GetMinOrMaxAppLaunchOrdinalsOnPage to specify which
   // value should be returned.
   enum AppLaunchOrdinalReturn {MIN_ORDINAL, MAX_ORDINAL};
 
+  // Maps an app id to its ordinals.
+  struct AppOrdinals {
+    AppOrdinals();
+    ~AppOrdinals();
+
+    syncer::StringOrdinal page_ordinal;
+    syncer::StringOrdinal app_launch_ordinal;
+  };
+  typedef std::map<std::string, AppOrdinals> AppOrdinalsMap;
+
   // This function returns the lowest ordinal on |page_ordinal| if
   // |return_value| == AppLaunchOrdinalReturn::MIN_ORDINAL, otherwise it returns
   // the largest ordinal on |page_ordinal|. If there are no apps on the page
   // then an invalid StringOrdinal is returned. It is an error to call this
   // function with an invalid |page_ordinal|.
   syncer::StringOrdinal GetMinOrMaxAppLaunchOrdinalsOnPage(
       const syncer::StringOrdinal& page_ordinal,
       AppLaunchOrdinalReturn return_type) const;
 
   // Initialize the |page_ordinal_map_| with the page ordinals used by the
@@ skipping 20 matching lines @@
   // is not matching map, nothing happens. This works with valid and invalid
   // StringOrdinals.
   void RemoveOrdinalMapping(const std::string& extension_id,
                             const syncer::StringOrdinal& page_ordinal,
                             const syncer::StringOrdinal& app_launch_ordinal);
 
   // Syncs the extension if needed. It is an error to call this if the
   // extension is not an application.
   void SyncIfNeeded(const std::string& extension_id);
 
+  // Creates the default ordinals.
+  void CreateDefaultOrdinals();
+
+  // Gets the default ordinals for |extension_id|. Returns false if no default
+  // ordinals for |extension_id| is defined. Otherwise, returns true and
+  // ordinals is updated with corresponding ordinals.
+  bool GetDefaultOrdinals(const std::string& extension_id,
+                          syncer::StringOrdinal* page_ordinal,
+                          syncer::StringOrdinal* app_launch_ordinal) const;
+
+  // Returns |app_launch_ordinal| if it has no collision in the page specified
+  // by |page_ordinal|. Otherwise, returns an ordinal after |app_launch_ordinal|
+  // that has no conflict.
+  syncer::StringOrdinal ResolveCollision(
+      const syncer::StringOrdinal& page_ordinal,
+      const syncer::StringOrdinal& app_launch_ordinal) const;
+
   ExtensionScopedPrefs* extension_scoped_prefs_;  // Weak, owns this instance.
   PrefService* pref_service_;  // Weak.
   ExtensionServiceInterface* extension_service_;  // Weak.
 
   // A map of all the StringOrdinal page ordinals mapping to the collections of
   // app launch ordinals that exist on that page. This is used for mapping
   // StringOrdinals to their Integer equivalent as well as quick lookup of the
   // any collision of on the NTP (icons with the same page and same app launch
   // ordinals). The possiblity of collisions means that a multimap must be used
   // (although the collisions must all be resolved once all the syncing is
   // done).
   // The StringOrdinal is the app launch ordinal and the string is the extension
   // id.
   typedef std::multimap<
       syncer::StringOrdinal, std::string,
     syncer::StringOrdinal::LessThanFn> AppLaunchOrdinalMap;
   // The StringOrdinal is the page ordinal and the AppLaunchOrdinalMap is the
   // contents of that page.
   typedef std::map<
       syncer::StringOrdinal, AppLaunchOrdinalMap,
     syncer::StringOrdinal::LessThanFn> PageOrdinalMap;
   PageOrdinalMap ntp_ordinal_map_;
 
+  // Defines the default ordinals.
+  AppOrdinalsMap default_ordinals_;
+
   DISALLOW_COPY_AND_ASSIGN(ExtensionSorting);
 };
 
 #endif  // CHROME_BROWSER_EXTENSIONS_EXTENSION_SORTING_H_