blob: 253de6fd38cf9c13dc112cc576f01dac5fddcfe8 [file] [log] [blame]
// 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.
#include <stddef.h>
#include <memory>
#include <vector>
#include "base/gtest_prod_util.h"
#include "base/macros.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 {
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. The search controller can specify any number of groups, each with a
// different number of results and priority boost.
class APP_LIST_EXPORT Mixer {
explicit Mixer(AppListModel::SearchResults* ui_results);
// Adds a new mixer group. A "soft" maximum of |max_results| results will be
// chosen from this group (if 0, will allow unlimited results from this
// group). If there aren't enough results from all groups, more than
// |max_results| may be chosen from this group. Each result in the group will
// have its score multiplied by |multiplier|. Returns the group's group_id.
size_t AddGroup(size_t max_results, double multiplier);
// Associates a provider with a mixer group.
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,
size_t num_max_results);
FRIEND_TEST_ALL_PREFIXES(test::MixerTest, Publish);
// Used for sorting and mixing results.
struct APP_LIST_EXPORT 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::vector<std::unique_ptr<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 entries from |results| with duplicate IDs. When two or more results
// have the same ID, the earliest one in the |results| list is kept.
// NOTE: This is not necessarily the one with the highest *score*, as
// |results| may not have been sorted yet.
static void RemoveDuplicates(SortedResults* results);
void FetchResults(bool is_voice_query, const KnownResults& known_results);
AppListModel::SearchResults* ui_results_; // Not owned.
Groups groups_;
} // namespace app_list