app_list: Refactor mixer groups to avoid hard-coded groups in Mixer.

ui/app_list/search/mixer.h

 // Copyright 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.
 
 #ifndef UI_APP_LIST_SEARCH_MIXER_H_
 #define UI_APP_LIST_SEARCH_MIXER_H_
 
-#include <map>
 #include <vector>
 
 #include "base/basictypes.h"
 #include "base/gtest_prod_util.h"
-#include "base/memory/linked_ptr.h"
+#include "base/memory/scoped_vector.h"
 #include "ui/app_list/app_list_export.h"
 #include "ui/app_list/app_list_model.h"
 #include "ui/app_list/search/history_types.h"
 
 namespace app_list {
 
 namespace test {
 FORWARD_DECLARE_TEST(MixerTest, Publish);
 }
 
 class SearchProvider;
 class SearchResult;
 
 // Mixer collects results from providers, sorts them and publishes them to the
 // SearchResults UI model. The targeted results have 6 slots to hold the
-// result. These slots could be viewed as having three groups: main group
-// (local apps and contacts), omnibox group and web store group. The
-// main group takes no more than 4 slots. The web store takes no more than 2
-// slots. The omnibox group takes all the remaining slots.
+// result. The search controller can specify any number of groups, each with a
+// different number of results and priority boost. The special group with ID
+// OMNIBOX_GROUP is expected to contain omnibox results, and will be treated
+// specially.
 class APP_LIST_EXPORT Mixer {
  public:
-  // The enum represents mixer groups. Each must have a Group added in Init().
-  enum GroupId {
-    MAIN_GROUP = 0,
-    OMNIBOX_GROUP = 1,
-    WEBSTORE_GROUP = 2,
-    PEOPLE_GROUP = 3,
-    SUGGESTIONS_GROUP = 4,
-  };
+  // The ID of the omnibox group. The group with this ID will be treated
+  // specially by the Mixer (it will be truncated such that it fills the
+  // remaining slots without overflowing, but with at least one result).
+  // TODO(mgiuca): Omnibox group should not be treated specially.
+  static const size_t OMNIBOX_GROUP;

[calamity, 2015/04/10 03:34:18]

Can we make an omnibox_group_ field that gets set by an AddOmniboxGroup method?

That would remove the need for DCHECKing against a runtime index we're deciding
on at compile time.

[Matt Giuca, 2015/04/10 03:49:19]

Done.

 
   explicit Mixer(AppListModel::SearchResults* ui_results);
   ~Mixer();
 
-  // Creates mixer groups.
-  void Init();
+  // Adds a new mixer group. A maximum of |max_results| results will be
+  // displayed from this group (if 0, will allow unlimited results from this
+  // group). Each result in the group will have its score boosted by |boost|.
+  // Returns the group's group_id.
+  size_t AddGroup(size_t max_results, double boost);
 
   // Associates a provider with a mixer group.
-  void AddProviderToGroup(GroupId group, SearchProvider* provider);
+  void AddProviderToGroup(size_t group_id, SearchProvider* provider);
 
   // Collects the results, sorts and publishes them.
   void MixAndPublish(bool is_voice_query, const KnownResults& known_results);
 
  private:
   FRIEND_TEST_ALL_PREFIXES(test::MixerTest, Publish);
 
   // Used for sorting and mixing results.
   struct APP_LIST_EXPORT SortData {
     SortData();
     SortData(SearchResult* result, double score);
 
     bool operator<(const SortData& other) const;
 
     SearchResult* result;  // Not owned.
     double score;
   };
   typedef std::vector<Mixer::SortData> SortedResults;
 
   class Group;
-  typedef std::map<GroupId, linked_ptr<Group>> Groups;
+  typedef ScopedVector<Group> Groups;
 
   // Publishes the given |new_results| to |ui_results|, deleting any existing
   // results that are not in |new_results|. Results that already exist in
   // |ui_results| are reused to avoid flickering caused by icon reload.
   static void Publish(const SortedResults& results,
                       AppListModel::SearchResults* ui_results);
 
   // Removes duplicates from |results|.
   static void RemoveDuplicates(SortedResults* results);
 
   void FetchResults(bool is_voice_query, const KnownResults& known_results);
 
   AppListModel::SearchResults* ui_results_;  // Not owned.
   Groups groups_;
 
   DISALLOW_COPY_AND_ASSIGN(Mixer);
 };
 
 }  // namespace app_list
 
 #endif  // UI_APP_LIST_SEARCH_MIXER_H_