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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
|
// Copyright 2015 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_CLIPBOARD_PROVIDER_H_
#define COMPONENTS_OMNIBOX_BROWSER_CLIPBOARD_PROVIDER_H_
#include "base/gtest_prod_util.h"
#include "base/memory/raw_ptr.h"
#include "components/omnibox/browser/autocomplete_enums.h"
#include "components/omnibox/browser/autocomplete_provider.h"
#include "ui/gfx/image/image.h"
class AutocompleteProviderClient;
class AutocompleteProviderListener;
class ClipboardRecentContent;
enum class ClipboardContentType;
// Autocomplete provider offering content based on the clipboard's content.
class ClipboardProvider : public AutocompleteProvider {
public:
ClipboardProvider(AutocompleteProviderClient* client,
AutocompleteProviderListener* listener,
ClipboardRecentContent* clipboard_content);
ClipboardProvider(const ClipboardProvider&) = delete;
ClipboardProvider& operator=(const ClipboardProvider&) = delete;
// Returns a new AutocompleteMatch clipboard match that will navigate to the
// given copied url. Used to construct a match later when the URL is not
// available at match creation time (e.g. iOS 14).
AutocompleteMatch NewClipboardURLMatch(const GURL& url);
// Returns a new AutocompleteMatch clipboard match that will search for the
// given copied text. Used to construct a match later when the text is not
// available at match creation time (e.g. iOS 14).
std::optional<AutocompleteMatch> NewClipboardTextMatch(
const std::u16string& text);
using ClipboardImageMatchCallback =
base::OnceCallback<void(std::optional<AutocompleteMatch>)>;
// Returns a new AutocompleteMatch clipboard match that will search for the
// given copied image. Used to construct a match later when the image is not
// available at match creation time (e.g. iOS 14).
void NewClipboardImageMatch(std::optional<gfx::Image> optional_image,
ClipboardImageMatchCallback callback);
using ClipboardMatchCallback = base::OnceCallback<void()>;
// Update clipboard match |match| with the current clipboard content.
void UpdateClipboardMatchWithContent(AutocompleteMatch* match,
ClipboardMatchCallback callback);
// AutocompleteProvider implementation.
void Start(const AutocompleteInput& input, bool minimal_changes) override;
void Stop(AutocompleteStopReason stop_reason) override;
void DeleteMatch(const AutocompleteMatch& match) override;
void AddProviderInfo(ProvidersInfo* provider_info) const override;
private:
FRIEND_TEST_ALL_PREFIXES(ClipboardProviderTest, MatchesImage);
FRIEND_TEST_ALL_PREFIXES(ClipboardProviderTest, CreateURLMatchWithContent);
FRIEND_TEST_ALL_PREFIXES(ClipboardProviderTest, SuppressAfterFirstUsed);
FRIEND_TEST_ALL_PREFIXES(ClipboardProviderTest, CreateTextMatchWithContent);
FRIEND_TEST_ALL_PREFIXES(ClipboardProviderTest, CreateImageMatchWithContent);
~ClipboardProvider() override;
// Handle the match created from one of the match creation methods and do
// extra tracking and match adding.
void AddCreatedMatchWithTracking(
const AutocompleteInput& input,
AutocompleteMatch match,
const base::TimeDelta clipboard_contents_age);
// Uses asynchronous clipboard APIs to check which content types have
// clipboard data without actually accessing the data. If any do, then one
// clipboard match is created. Calls back to |OnReceiveClipboardContent| with
// the result.
void CheckClipboardContent(const AutocompleteInput& input);
// Called when the clipboard data is returned from the asynchronous call.
void OnReceiveClipboardContent(const AutocompleteInput& input,
base::TimeDelta clipboard_contents_age,
std::set<ClipboardContentType> matched_types);
// Checks whether the current template url supports text searches.
bool TemplateURLSupportsTextSearch();
// Checks whether the current template url supports image searches.
bool TemplateURLSupportsImageSearch();
// Returns a URL match with no URL. This can be used if the clipboard content
// is inaccessible at match creation time (e.g. iOS 14).
AutocompleteMatch NewBlankURLMatch();
// Returns a text match with no text. This can be used if the clipboard
// content is inaccessible at match creation time (e.g. iOS 14).
AutocompleteMatch NewBlankTextMatch();
// Returns a image match with no attached image. This can be used if the
// clipboard content is inaccessible at match creation time (e.g. iOS 14).
AutocompleteMatch NewBlankImageMatch();
// Resize and encode the image data into bytes. This can take some time if the
// image is large, so this should happen on a background thread.
static scoped_refptr<base::RefCountedMemory> EncodeClipboardImage(
gfx::ImageSkia image);
// Construct the actual image match once the image has been encoded into
// bytes. This should be called back on the main thread.
void ConstructImageMatchCallback(
ClipboardImageMatchCallback callback,
scoped_refptr<base::RefCountedMemory> image_bytes);
// TODO(crbug.com/40176141): OmniboxViewIOS should use following functions
// instead their own implementations.
// Called when url data is received from clipboard for creating match with
// content.
void OnReceiveURLForMatchWithContent(ClipboardMatchCallback callback,
AutocompleteMatch* match,
std::optional<GURL> optional_gurl);
// Called when text data is received from clipboard for creating match with
// content.
void OnReceiveTextForMatchWithContent(
ClipboardMatchCallback callback,
AutocompleteMatch* match,
std::optional<std::u16string> optional_text);
// Called when image data is received from clipboard for creating match with
// content.
void OnReceiveImageForMatchWithContent(
ClipboardMatchCallback callback,
AutocompleteMatch* match,
std::optional<gfx::Image> optional_image);
// Called when image match is received from clipboard for creating match with
// content.
void OnReceiveImageMatchForMatchWithContent(
ClipboardMatchCallback callback,
AutocompleteMatch* match,
std::optional<AutocompleteMatch> optional_match);
// Updated clipboard |match| with |url|.
void UpdateClipboardURLContent(const GURL& url, AutocompleteMatch* match);
// Updated clipboard |match| with |text|.
bool UpdateClipboardTextContent(const std::u16string& text,
AutocompleteMatch* match);
// Update the timestamp of the most recently used clipboard suggestion to the
// timestamp provided by the ui::Clipboard instance.
void UpdateMostRecentlyUsedClipboardSuggestionTimestamp();
raw_ptr<AutocompleteProviderClient> client_;
raw_ptr<ClipboardRecentContent> clipboard_content_;
// The current URL suggested and the number of times it has been offered.
// Used for recording metrics.
GURL current_url_suggested_;
size_t current_url_suggested_times_;
// Used to cancel image construction callbacks if autocomplete Stop() is
// called.
base::WeakPtrFactory<ClipboardProvider> callback_weak_ptr_factory_{this};
};
#endif // COMPONENTS_OMNIBOX_BROWSER_CLIPBOARD_PROVIDER_H_
|
