1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
|
// Copyright 2018 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef COMPONENTS_OMNIBOX_BROWSER_ACTIONS_OMNIBOX_PEDAL_PROVIDER_H_
#define COMPONENTS_OMNIBOX_BROWSER_ACTIONS_OMNIBOX_PEDAL_PROVIDER_H_
#include <unordered_map>
#include "base/gtest_prod_util.h"
#include "base/memory/raw_ref.h"
#include "base/memory/scoped_refptr.h"
#include "base/strings/utf_offset_string_conversions.h"
#include "base/values.h"
#include "components/omnibox/browser/actions/omnibox_pedal.h"
#include "components/omnibox/browser/autocomplete_provider.h"
class OmniboxPedal;
class AutocompleteInput;
class AutocompleteProviderClient;
// Note: This is not an autocomplete provider; it doesn't produce suggestions
// but rather "annotates" suggestions by attaching pedals to matches from other
// providers (search in particular).
class OmniboxPedalProvider {
public:
OmniboxPedalProvider(
AutocompleteProviderClient& client,
std::unordered_map<OmniboxPedalId, scoped_refptr<OmniboxPedal>> pedals);
~OmniboxPedalProvider();
OmniboxPedalProvider(const OmniboxPedalProvider&) = delete;
OmniboxPedalProvider& operator=(const OmniboxPedalProvider&) = delete;
// Returns the Pedal found to match given |match_text| or else nullptr if
// none match. Triggering readiness is irrelevant.
OmniboxPedal* FindPedalMatch(const std::u16string& match_text);
// Returns the Pedal triggered by given |match_text| or nullptr if none
// trigger. The |input| is used to determine suitability for current context.
OmniboxPedal* FindReadyPedalMatch(const AutocompleteInput& input,
const std::u16string& match_text);
// Estimates memory usage for this and all contained Pedals.
size_t EstimateMemoryUsage() const;
protected:
// Befriending this test base class prevents duplication of a long exhaustive
// unit test (specifically the TestLiteralConceptExpressions method).
friend class OmniboxPedalImplementationsTest;
FRIEND_TEST_ALL_PREFIXES(OmniboxPedalProviderTest, QueriesTriggerPedals);
FRIEND_TEST_ALL_PREFIXES(OmniboxPedalImplementationsTest,
ProviderFiltersPedalUpdateChrome);
FRIEND_TEST_ALL_PREFIXES(
OmniboxPedalImplementationsWithoutTranslationConsoleTest,
ProviderFiltersPedalUpdateChrome);
FRIEND_TEST_ALL_PREFIXES(OmniboxPedalImplementationsTest,
UnorderedSynonymExpressionsAreConceptMatches);
FRIEND_TEST_ALL_PREFIXES(
OmniboxPedalImplementationsWithoutTranslationConsoleTest,
UnorderedSynonymExpressionsAreConceptMatches);
// Generate a token sequence for text using internal dictionary & delimiters.
// Outputs empty sequence if any delimited part of text is not in dictionary.
// Note, the ignore_group is applied to eliminate stop words from output.
void Tokenize(OmniboxPedal::TokenSequence& out_tokens,
const std::u16string& text) const;
// An open variant of Tokenize that expands the token dictionary as needed.
void TokenizeAndExpandDictionary(OmniboxPedal::TokenSequence& out_tokens,
const std::u16string& token_sequence_string);
// Loads all pedals groups, building the dictionary as needed from
// translation strings.
void LoadPedalConcepts();
// Load a synonym group from a localization sourced string with comma
// separated synonyms.
OmniboxPedal::SynonymGroup LoadSynonymGroupString(
bool required,
bool match_once,
std::u16string synonyms_csv);
const raw_ref<AutocompleteProviderClient> client_;
// Contains mapping from well-known identifier to Pedal implementation.
// Note: since the set is small, we use one map here for simplicity; but if
// someday there are lots of Pedals, it may make sense to switch this to a
// vector and index by id separately. The lookup is needed rarely but
// iterating over the whole collection happens very frequently, so we should
// really optimize for iteration (vector), not lookup (map).
std::unordered_map<OmniboxPedalId, scoped_refptr<OmniboxPedal>> pedals_;
// Common words that may be used when typing to trigger Pedals. All instances
// of these words are removed from match text when looking for triggers.
// Therefore no Pedal should have a trigger or synonym group that includes
// any of these words (as a whole word; substrings are fine).
OmniboxPedal::SynonymGroup ignore_group_;
// Map from string token to unique int token identifier.
std::unordered_map<std::u16string, int> dictionary_;
// This contains all token delimiter characters. It may be empty, in which
// case no delimiting takes place (input is treated as raw token sequence).
std::u16string tokenize_characters_;
// This holds the tokens currently being matched against.
OmniboxPedal::TokenSequence match_tokens_;
};
#endif // COMPONENTS_OMNIBOX_BROWSER_ACTIONS_OMNIBOX_PEDAL_PROVIDER_H_
|
