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 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256
|
// Copyright 2017 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_INPUT_RENDER_WIDGET_TARGETER_H_
#define COMPONENTS_INPUT_RENDER_WIDGET_TARGETER_H_
#include <stdint.h>
#include <optional>
#include <queue>
#include "base/component_export.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/weak_ptr.h"
#include "base/time/time.h"
#include "base/timer/timer.h"
#include "components/input/render_widget_host_view_input.h"
#include "components/viz/common/surfaces/frame_sink_id.h"
#include "ui/events/blink/web_input_event_traits.h"
#include "ui/gfx/geometry/point_f.h"
#include "ui/latency/latency_info.h"
namespace blink {
class WebInputEvent;
} // namespace blink
namespace gfx {
class PointF;
}
namespace input {
class RenderWidgetHostViewInput;
struct COMPONENT_EXPORT(INPUT) RenderWidgetTargetResult {
RenderWidgetTargetResult();
RenderWidgetTargetResult(const RenderWidgetTargetResult&);
RenderWidgetTargetResult(RenderWidgetHostViewInput* view,
bool should_query_view,
std::optional<gfx::PointF> location);
~RenderWidgetTargetResult();
raw_ptr<RenderWidgetHostViewInput, DanglingUntriaged> view = nullptr;
bool should_query_view = false;
std::optional<gfx::PointF> target_location = std::nullopt;
};
class RenderWidgetTargeter {
public:
using RenderWidgetHostAtPointCallback =
base::OnceCallback<void(base::WeakPtr<RenderWidgetHostViewInput>,
std::optional<gfx::PointF>)>;
class Delegate {
public:
virtual ~Delegate() = default;
virtual RenderWidgetTargetResult FindTargetSynchronouslyAtPoint(
RenderWidgetHostViewInput* root_view,
const gfx::PointF& location) = 0;
virtual RenderWidgetTargetResult FindTargetSynchronously(
RenderWidgetHostViewInput* root_view,
const blink::WebInputEvent& event) = 0;
// |event| must be non-null, and is in |root_view|'s coordinate space.
virtual void DispatchEventToTarget(
RenderWidgetHostViewInput* root_view,
RenderWidgetHostViewInput* target,
blink::WebInputEvent* event,
const ui::LatencyInfo& latency,
const std::optional<gfx::PointF>& target_location) = 0;
virtual void SetEventsBeingFlushed(bool events_being_flushed) = 0;
virtual RenderWidgetHostViewInput* FindViewFromFrameSinkId(
const viz::FrameSinkId& frame_sink_id) const = 0;
// Returns true if a further asynchronous query should be sent to the
// candidate RenderWidgetHostView.
virtual bool ShouldContinueHitTesting(
RenderWidgetHostViewInput* target_view) const = 0;
};
enum class HitTestResultsMatch {
kDoNotMatch = 0,
kMatch = 1,
kHitTestResultChanged = 2,
kHitTestDataOutdated = 3,
kMaxValue = kHitTestDataOutdated,
};
// The delegate must outlive this targeter.
explicit RenderWidgetTargeter(Delegate* delegate);
RenderWidgetTargeter(const RenderWidgetTargeter&) = delete;
RenderWidgetTargeter& operator=(const RenderWidgetTargeter&) = delete;
~RenderWidgetTargeter();
// Finds the appropriate target inside |root_view| for |event|, and dispatches
// it through the delegate. |event| is in the coord-space of |root_view|.
void FindTargetAndDispatch(RenderWidgetHostViewInput* root_view,
const blink::WebInputEvent& event,
const ui::LatencyInfo& latency);
// Finds the appropriate target inside |root_view| for |point|, and passes the
// target along with the transformed coordinates of the point with respect to
// the target's coordinates.
void FindTargetAndCallback(RenderWidgetHostViewInput* root_view,
const gfx::PointF& point,
RenderWidgetHostAtPointCallback callback);
void ViewWillBeDestroyed(RenderWidgetHostViewInput* view);
bool HasEventsPendingDispatch() const;
void set_async_hit_test_timeout_delay_for_testing(
const base::TimeDelta& delay) {
async_hit_test_timeout_delay_ = delay;
}
size_t num_requests_in_queue_for_testing() { return requests_.size(); }
bool is_request_in_flight_for_testing() {
return request_in_flight_.has_value();
}
void SetIsAutoScrollInProgress(bool autoscroll_in_progress);
bool is_auto_scroll_in_progress() const { return is_autoscroll_in_progress_; }
private:
class TargetingRequest {
public:
TargetingRequest(base::WeakPtr<RenderWidgetHostViewInput>,
const blink::WebInputEvent&,
const ui::LatencyInfo&);
TargetingRequest(base::WeakPtr<RenderWidgetHostViewInput>,
const gfx::PointF&,
RenderWidgetHostAtPointCallback);
TargetingRequest(TargetingRequest&& request);
TargetingRequest& operator=(TargetingRequest&& other);
TargetingRequest(const TargetingRequest&) = delete;
TargetingRequest& operator=(const TargetingRequest&) = delete;
~TargetingRequest();
void RunCallback(RenderWidgetHostViewInput* target,
std::optional<gfx::PointF> point);
bool MergeEventIfPossible(const blink::WebInputEvent& event);
bool IsWebInputEventRequest() const;
blink::WebInputEvent* GetEvent();
RenderWidgetHostViewInput* GetRootView() const;
gfx::PointF GetLocation() const;
const ui::LatencyInfo& GetLatency() const;
private:
base::WeakPtr<RenderWidgetHostViewInput> root_view;
RenderWidgetHostAtPointCallback callback;
// |location| is in the coordinate space of |root_view| which is
// either set directly when event is null or calculated from the event.
gfx::PointF location;
// |event| if set is in the coordinate space of |root_view|.
ui::WebScopedInputEvent event;
ui::LatencyInfo latency;
};
void ResolveTargetingRequest(TargetingRequest);
// Attempts to target and dispatch all events in the queue. It stops if it has
// to query a client, or if the queue becomes empty.
void FlushEventQueue();
// Queries |target| to find the correct target for |request|.
// |target_location| is the location in |target|'s coordinate space.
// |last_request_target| and |last_target_location| provide a fallback target
// in the case that the query times out. These should be null values when
// querying the root view, and the target's immediate parent view otherwise.
void QueryClient(RenderWidgetHostViewInput* target,
const gfx::PointF& target_location,
RenderWidgetHostViewInput* last_request_target,
const gfx::PointF& last_target_location,
TargetingRequest request);
// |target_location|, if
// set, is the location in |target|'s coordinate space.
// |target| is the current target that will be queried using its
// InputTargetClient interface.
// |frame_sink_id| is returned from the InputTargetClient to indicate where
// the event should be routed, and |transformed_location| is the point in
// that new target's coordinate space.
void FoundFrameSinkId(base::WeakPtr<RenderWidgetHostViewInput> target,
uint32_t request_id,
const gfx::PointF& target_location,
const viz::FrameSinkId& frame_sink_id,
const gfx::PointF& transformed_location);
// |target_location|, if
// set, is the location in |target|'s coordinate space.
void FoundTarget(RenderWidgetHostViewInput* target,
const std::optional<gfx::PointF>& target_location,
TargetingRequest* request);
// Callback when the hit testing timer fires, to resume event processing
// without further waiting for a response to the last targeting request.
void AsyncHitTestTimedOut(
base::WeakPtr<RenderWidgetHostViewInput> current_request_target,
const gfx::PointF& current_target_location,
base::WeakPtr<RenderWidgetHostViewInput> last_request_target,
const gfx::PointF& last_target_location);
void OnInputTargetDisconnect(
base::WeakPtr<RenderWidgetHostViewInput> target,
const gfx::PointF& location);
HitTestResultsMatch GetHitTestResultsMatchBucket(
RenderWidgetHostViewInput* target,
TargetingRequest* request) const;
base::TimeDelta async_hit_test_timeout_delay() {
return async_hit_test_timeout_delay_;
}
std::optional<TargetingRequest> request_in_flight_;
uint32_t last_request_id_ = 0;
std::queue<TargetingRequest> requests_;
std::unordered_set<raw_ptr<RenderWidgetHostViewInput, CtnExperimental>>
unresponsive_views_;
// Target to send events to if autoscroll is in progress
RenderWidgetTargetResult middle_click_result_;
// True when the user middle click's mouse for autoscroll
bool is_autoscroll_in_progress_ = false;
// This value limits how long to wait for a response from the renderer
// process before giving up and resuming event processing.
base::TimeDelta async_hit_test_timeout_delay_;
base::OneShotTimer async_hit_test_timeout_;
uint64_t trace_id_;
const raw_ptr<Delegate, DanglingUntriaged> delegate_;
base::WeakPtrFactory<RenderWidgetTargeter> weak_ptr_factory_{this};
};
} // namespace input
#endif // COMPONENTS_INPUT_RENDER_WIDGET_TARGETER_H_
|