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
|
// Copyright 2025 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "chrome/renderer/actor/scroll_tool.h"
#include <optional>
#include "base/notimplemented.h"
#include "base/strings/to_string.h"
#include "base/time/time.h"
#include "chrome/common/actor/action_result.h"
#include "chrome/common/actor/actor_constants.h"
#include "chrome/common/actor/actor_logging.h"
#include "chrome/renderer/actor/tool_utils.h"
#include "content/public/renderer/render_frame.h"
#include "third_party/abseil-cpp/absl/strings/str_format.h"
#include "third_party/blink/public/web/web_element.h"
#include "third_party/blink/public/web/web_frame_widget.h"
#include "third_party/blink/public/web/web_local_frame.h"
#include "third_party/blink/public/web/web_node.h"
#include "ui/events/base_event_utils.h"
#include "ui/gfx/geometry/point_f.h"
#include "ui/gfx/geometry/vector2d_f.h"
namespace actor {
using ::blink::WebElement;
using ::blink::WebLocalFrame;
using ::blink::WebNode;
namespace {
// The default maximum duration for a scroll animation is 700ms.
constexpr base::TimeDelta kSmoothScrollDelay = base::Milliseconds(700);
} // namespace
ScrollTool::ScrollTool(content::RenderFrame& frame,
Journal::TaskId task_id,
Journal& journal,
mojom::ScrollActionPtr action)
: ToolBase(frame, task_id, journal), action_(std::move(action)) {}
ScrollTool::~ScrollTool() = default;
mojom::ActionResultPtr ScrollTool::Execute() {
ValidatedResult validated_result = Validate();
if (!validated_result.has_value()) {
return std::move(validated_result.error());
}
WebElement scrolling_element = validated_result->scroller;
gfx::Vector2dF offset_physical = validated_result->scroll_by_offset;
float physical_to_css = 1 / scrolling_element.GetEffectiveZoom();
gfx::Vector2dF offset_css =
gfx::ScaleVector2d(offset_physical, physical_to_css, physical_to_css);
gfx::Vector2dF start_offset_css = scrolling_element.GetScrollOffset();
bool did_scroll =
scrolling_element.SetScrollOffset(start_offset_css + offset_css);
targeting_smooth_scroller_ = scrolling_element.HasScrollBehaviorSmooth();
return did_scroll
? MakeOkResult()
: MakeResult(mojom::ActionResultCode::kScrollOffsetDidNotChange);
}
std::string ScrollTool::DebugString() const {
return absl::StrFormat("ScrollTool[%s;direction(%s);distance(%f)]",
ToDebugString(action_->target),
base::ToString(action_->direction), action_->distance);
}
base::TimeDelta ScrollTool::MinimumObservationDelay() const {
return targeting_smooth_scroller_ ? kSmoothScrollDelay
: ToolBase::MinimumObservationDelay();
}
ScrollTool::ValidatedResult ScrollTool::Validate() const {
WebLocalFrame* web_frame = frame_->GetWebFrame();
CHECK(web_frame);
CHECK(web_frame->FrameWidget());
// The scroll distance should always be positive.
if (action_->distance <= 0.0) {
return base::unexpected(MakeResult(
mojom::ActionResultCode::kArgumentsInvalid, "Negative Distance"));
}
if (action_->target->is_coordinate()) {
NOTIMPLEMENTED() << "Coordinate-based target not yet supported.";
return base::unexpected(MakeErrorResult());
}
WebElement scrolling_element;
int32_t dom_node_id = action_->target->get_dom_node_id();
if (dom_node_id == kRootElementDomNodeId) {
scrolling_element = web_frame->GetDocument().ScrollingElement();
if (scrolling_element.IsNull()) {
return base::unexpected(
MakeResult(mojom::ActionResultCode::kScrollNoScrollingElement));
}
} else {
scrolling_element =
GetNodeFromId(frame_.get(), dom_node_id).DynamicTo<WebElement>();
if (scrolling_element.IsNull()) {
return base::unexpected(
MakeResult(mojom::ActionResultCode::kInvalidDomNodeId));
}
}
gfx::Vector2dF offset_physical;
switch (action_->direction) {
case mojom::ScrollAction::ScrollDirection::kLeft: {
offset_physical.set_x(-action_->distance);
break;
}
case mojom::ScrollAction::ScrollDirection::kRight: {
offset_physical.set_x(action_->distance);
break;
}
case mojom::ScrollAction::ScrollDirection::kUp: {
offset_physical.set_y(-action_->distance);
break;
}
case mojom::ScrollAction::ScrollDirection::kDown: {
offset_physical.set_y(action_->distance);
break;
}
}
if ((offset_physical.x() && !scrolling_element.IsUserScrollableX()) ||
(offset_physical.y() && !scrolling_element.IsUserScrollableY())) {
return base::unexpected(
MakeResult(mojom::ActionResultCode::kScrollTargetNotUserScrollable,
absl::StrFormat("ScrollingElement [%s]",
base::ToString(scrolling_element))));
}
return ScrollerAndDistance{scrolling_element, offset_physical};
}
} // namespace actor
|