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 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975
|
// Copyright 2016 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 "third_party/blink/renderer/core/input/scroll_manager.h"
#include <memory>
#include "third_party/blink/renderer/core/dom/dom_node_ids.h"
#include "third_party/blink/renderer/core/dom/node_computed_style.h"
#include "third_party/blink/renderer/core/events/gesture_event.h"
#include "third_party/blink/renderer/core/frame/browser_controls.h"
#include "third_party/blink/renderer/core/frame/local_dom_window.h"
#include "third_party/blink/renderer/core/frame/local_frame_view.h"
#include "third_party/blink/renderer/core/html/html_frame_owner_element.h"
#include "third_party/blink/renderer/core/input/event_handler.h"
#include "third_party/blink/renderer/core/input/event_handling_util.h"
#include "third_party/blink/renderer/core/layout/layout_block.h"
#include "third_party/blink/renderer/core/layout/layout_embedded_content.h"
#include "third_party/blink/renderer/core/layout/layout_view.h"
#include "third_party/blink/renderer/core/page/autoscroll_controller.h"
#include "third_party/blink/renderer/core/page/chrome_client.h"
#include "third_party/blink/renderer/core/page/page.h"
#include "third_party/blink/renderer/core/page/scrolling/overscroll_controller.h"
#include "third_party/blink/renderer/core/page/scrolling/root_scroller_controller.h"
#include "third_party/blink/renderer/core/page/scrolling/root_scroller_util.h"
#include "third_party/blink/renderer/core/page/scrolling/scroll_state.h"
#include "third_party/blink/renderer/core/page/scrolling/snap_coordinator.h"
#include "third_party/blink/renderer/core/paint/paint_layer.h"
#include "third_party/blink/renderer/core/paint/paint_layer_scrollable_area.h"
#include "third_party/blink/renderer/core/scroll/scroll_customization.h"
#include "third_party/blink/renderer/platform/histogram.h"
#include "third_party/blink/renderer/platform/instrumentation/tracing/trace_event.h"
namespace blink {
namespace {
SnapFlingController::GestureScrollType ToGestureScrollType(
WebInputEvent::Type web_event_type) {
switch (web_event_type) {
case WebInputEvent::kGestureScrollBegin:
return SnapFlingController::GestureScrollType::kBegin;
case WebInputEvent::kGestureScrollUpdate:
return SnapFlingController::GestureScrollType::kUpdate;
case WebInputEvent::kGestureScrollEnd:
return SnapFlingController::GestureScrollType::kEnd;
default:
NOTREACHED();
return SnapFlingController::GestureScrollType::kBegin;
}
}
SnapFlingController::GestureScrollUpdateInfo GetGestureScrollUpdateInfo(
const WebGestureEvent& event) {
return {.delta = gfx::Vector2dF(-event.data.scroll_update.delta_x,
-event.data.scroll_update.delta_y),
.is_in_inertial_phase = event.data.scroll_update.inertial_phase ==
WebGestureEvent::kMomentumPhase,
.event_time = event.TimeStamp()};
}
ScrollableArea* ScrollableAreaForSnapping(LayoutBox* layout_box) {
if (!layout_box)
return nullptr;
return layout_box->IsLayoutView()
? layout_box->GetFrameView()->GetScrollableArea()
: layout_box->GetScrollableArea();
}
} // namespace
ScrollManager::ScrollManager(LocalFrame& frame) : frame_(frame) {
if (RuntimeEnabledFeatures::CSSScrollSnapPointsEnabled())
snap_fling_controller_ = std::make_unique<cc::SnapFlingController>(this);
Clear();
}
void ScrollManager::Clear() {
last_gesture_scroll_over_embedded_content_view_ = false;
scrollbar_handling_scroll_gesture_ = nullptr;
resize_scrollable_area_ = nullptr;
offset_from_resize_corner_ = LayoutSize();
ClearGestureScrollState();
}
void ScrollManager::Trace(blink::Visitor* visitor) {
visitor->Trace(frame_);
visitor->Trace(scroll_gesture_handling_node_);
visitor->Trace(previous_gesture_scrolled_element_);
visitor->Trace(scrollbar_handling_scroll_gesture_);
visitor->Trace(resize_scrollable_area_);
}
void ScrollManager::ClearGestureScrollState() {
scroll_gesture_handling_node_ = nullptr;
previous_gesture_scrolled_element_ = nullptr;
delta_consumed_for_scroll_sequence_ = false;
did_scroll_x_for_scroll_gesture_ = false;
did_scroll_y_for_scroll_gesture_ = false;
current_scroll_chain_.clear();
if (Page* page = frame_->GetPage()) {
bool reset_x = true;
bool reset_y = true;
page->GetOverscrollController().ResetAccumulated(reset_x, reset_y);
}
}
void ScrollManager::StopAutoscroll() {
if (AutoscrollController* controller = GetAutoscrollController())
controller->StopAutoscroll();
}
void ScrollManager::StopMiddleClickAutoscroll() {
if (AutoscrollController* controller = GetAutoscrollController())
controller->StopMiddleClickAutoscroll(frame_);
}
bool ScrollManager::MiddleClickAutoscrollInProgress() const {
return GetAutoscrollController() &&
GetAutoscrollController()->MiddleClickAutoscrollInProgress();
}
AutoscrollController* ScrollManager::GetAutoscrollController() const {
if (Page* page = frame_->GetPage())
return &page->GetAutoscrollController();
return nullptr;
}
static bool CanPropagate(const ScrollState& scroll_state,
const Element& element) {
ScrollableArea* scrollable_area = element.GetLayoutBox()->GetScrollableArea();
if (!scrollable_area)
return true;
if (!scrollable_area->UserInputScrollable(kHorizontalScrollbar) &&
!scrollable_area->UserInputScrollable(kVerticalScrollbar))
return true;
return (scroll_state.deltaXHint() == 0 ||
element.GetComputedStyle()->OverscrollBehaviorX() ==
EOverscrollBehavior::kAuto) &&
(scroll_state.deltaYHint() == 0 ||
element.GetComputedStyle()->OverscrollBehaviorY() ==
EOverscrollBehavior::kAuto);
}
void ScrollManager::RecomputeScrollChain(const Node& start_node,
const ScrollState& scroll_state,
std::deque<int>& scroll_chain) {
DCHECK(!scroll_chain.size());
scroll_chain.clear();
DCHECK(start_node.GetLayoutObject());
LayoutBox* cur_box = start_node.GetLayoutObject()->EnclosingBox();
Element* document_element = frame_->GetDocument()->documentElement();
// Scrolling propagates along the containing block chain and ends at the
// RootScroller element. The RootScroller element will have a custom
// applyScroll callback that scrolls the frame or element.
while (cur_box) {
Node* cur_node = cur_box->GetNode();
Element* cur_element = nullptr;
// FIXME: this should reject more elements, as part of crbug.com/410974.
if (cur_node && cur_node->IsElementNode()) {
cur_element = ToElement(cur_node);
} else if (cur_node && cur_node->IsDocumentNode()) {
// In normal circumastances, the documentElement will be the root
// scroller but the documentElement itself isn't a containing block,
// that'll be the document node rather than the element.
cur_element = document_element;
}
if (cur_element) {
if (CanScroll(scroll_state, *cur_element))
scroll_chain.push_front(DOMNodeIds::IdForNode(cur_element));
if (IsViewportScrollingElement(*cur_element) ||
cur_element == document_element)
break;
if (!CanPropagate(scroll_state, *cur_element)) {
// We should add the first node with non-auto overscroll-behavior to
// the scroll chain regardlessly, as it's the only node we can latch to.
if (scroll_chain.empty() ||
scroll_chain.front() != (int)DOMNodeIds::IdForNode(cur_element)) {
scroll_chain.push_front(DOMNodeIds::IdForNode(cur_element));
}
break;
}
}
cur_box = cur_box->ContainingBlock();
}
}
bool ScrollManager::CanScroll(const ScrollState& scroll_state,
const Element& current_element) {
ScrollableArea* scrollable_area = nullptr;
if (IsViewportScrollingElement(current_element) ||
current_element == *(frame_->GetDocument()->documentElement())) {
if (!current_element.GetLayoutObject())
return false;
if (frame_->IsMainFrame())
return true;
// For subframes, the viewport is added to the scroll chain only if it can
// actually consume some delta hints. The main frame always gets added
// since it produces overscroll effects.
scrollable_area =
frame_->View() ? frame_->View()->GetScrollableArea() : nullptr;
}
if (!scrollable_area && current_element.GetLayoutBox())
scrollable_area = current_element.GetLayoutBox()->GetScrollableArea();
if (!scrollable_area)
return false;
double delta_x = scroll_state.isBeginning() ? scroll_state.deltaXHint()
: scroll_state.deltaX();
double delta_y = scroll_state.isBeginning() ? scroll_state.deltaYHint()
: scroll_state.deltaY();
if (!delta_x && !delta_y)
return true;
if (!scrollable_area->UserInputScrollable(kHorizontalScrollbar))
delta_x = 0;
if (!scrollable_area->UserInputScrollable(kVerticalScrollbar))
delta_y = 0;
ScrollOffset current_offset = scrollable_area->GetScrollOffset();
ScrollOffset target_offset = current_offset + ScrollOffset(delta_x, delta_y);
ScrollOffset clamped_offset =
scrollable_area->ClampScrollOffset(target_offset);
return clamped_offset != current_offset;
}
bool ScrollManager::LogicalScroll(ScrollDirection direction,
ScrollGranularity granularity,
Node* start_node,
Node* mouse_press_node) {
Node* node = start_node;
if (!node)
node = frame_->GetDocument()->FocusedElement();
if (!node)
node = mouse_press_node;
if ((!node || !node->GetLayoutObject()) && frame_->View() &&
frame_->View()->GetLayoutView())
node = frame_->View()->GetLayoutView()->GetNode();
if (!node)
return false;
Document& document = node->GetDocument();
document.UpdateStyleAndLayoutIgnorePendingStylesheets();
std::deque<int> scroll_chain;
std::unique_ptr<ScrollStateData> scroll_state_data =
std::make_unique<ScrollStateData>();
ScrollState* scroll_state = ScrollState::Create(std::move(scroll_state_data));
RecomputeScrollChain(*node, *scroll_state, scroll_chain);
while (!scroll_chain.empty()) {
Node* node = DOMNodeIds::NodeForId(scroll_chain.back());
scroll_chain.pop_back();
DCHECK(node);
LayoutBox* box = ToLayoutBox(node->GetLayoutObject());
DCHECK(box);
ScrollDirectionPhysical physical_direction =
ToPhysicalDirection(direction, box->IsHorizontalWritingMode(),
box->Style()->IsFlippedBlocksWritingMode());
ScrollableArea* scrollable_area = nullptr;
// The global root scroller must be scrolled by the RootFrameViewport.
if (RootScrollerUtil::IsGlobal(*box)) {
LocalFrame& main_frame = frame_->LocalFrameRoot();
// The local root must be the main frame if we have the global root
// scroller since it can't yet be set on OOPIFs.
DCHECK(main_frame.IsMainFrame());
scrollable_area = main_frame.View()->GetScrollableArea();
} else if (node == document.documentElement()) {
scrollable_area = document.GetLayoutView()->GetScrollableArea();
} else {
scrollable_area = box->GetScrollableArea();
}
DCHECK(scrollable_area);
ScrollResult result = scrollable_area->UserScroll(
granularity, ToScrollDelta(physical_direction, 1));
if (result.DidScroll())
return true;
}
return false;
}
// TODO(bokan): This should be merged with logicalScroll assuming
// defaultSpaceEventHandler's chaining scroll can be done crossing frames.
bool ScrollManager::BubblingScroll(ScrollDirection direction,
ScrollGranularity granularity,
Node* starting_node,
Node* mouse_press_node) {
// The layout needs to be up to date to determine if we can scroll. We may be
// here because of an onLoad event, in which case the final layout hasn't been
// performed yet.
frame_->GetDocument()->UpdateStyleAndLayoutIgnorePendingStylesheets();
// FIXME: enable scroll customization in this case. See crbug.com/410974.
if (LogicalScroll(direction, granularity, starting_node, mouse_press_node))
return true;
Frame* parent_frame = frame_->Tree().Parent();
if (!parent_frame)
return false;
return parent_frame->BubbleLogicalScrollFromChildFrame(direction, granularity,
frame_);
}
void ScrollManager::CustomizedScroll(ScrollState& scroll_state) {
TRACE_EVENT0("input", "ScrollManager::CustomizedScroll");
if (scroll_state.FullyConsumed())
return;
if (scroll_state.deltaX() || scroll_state.deltaY())
frame_->GetDocument()->UpdateStyleAndLayoutIgnorePendingStylesheets();
DCHECK(!current_scroll_chain_.empty());
scroll_state.SetScrollChain(current_scroll_chain_);
scroll_state.distributeToScrollChainDescendant();
}
void ScrollManager::ComputeScrollRelatedMetrics(
uint32_t* non_composited_main_thread_scrolling_reasons) {
// When scrolling on the main thread, the scrollableArea may or may not be
// composited. Either way, we have recorded either the reasons stored in
// its layer or the reason NonFastScrollableRegion from the compositor
// side. Here we record scrolls that occurred on main thread due to a
// non-composited scroller.
if (!scroll_gesture_handling_node_->GetLayoutObject())
return;
for (auto* cur_box =
scroll_gesture_handling_node_->GetLayoutObject()->EnclosingBox();
cur_box; cur_box = cur_box->ContainingBlock()) {
PaintLayerScrollableArea* scrollable_area = cur_box->GetScrollableArea();
if (!scrollable_area || !scrollable_area->ScrollsOverflow())
continue;
DCHECK(!scrollable_area->UsesCompositedScrolling() ||
!scrollable_area->GetNonCompositedMainThreadScrollingReasons());
*non_composited_main_thread_scrolling_reasons |=
scrollable_area->GetNonCompositedMainThreadScrollingReasons();
}
}
void ScrollManager::RecordScrollRelatedMetrics(const WebGestureDevice device) {
if (device != kWebGestureDeviceTouchpad &&
device != kWebGestureDeviceTouchscreen) {
return;
}
uint32_t non_composited_main_thread_scrolling_reasons = 0;
ComputeScrollRelatedMetrics(&non_composited_main_thread_scrolling_reasons);
if (non_composited_main_thread_scrolling_reasons) {
DCHECK(MainThreadScrollingReason::HasNonCompositedScrollReasons(
non_composited_main_thread_scrolling_reasons));
uint32_t main_thread_scrolling_reason_enum_max =
MainThreadScrollingReason::kMainThreadScrollingReasonCount + 1;
for (uint32_t i = MainThreadScrollingReason::kNonCompositedReasonsFirst;
i <= MainThreadScrollingReason::kNonCompositedReasonsLast; ++i) {
unsigned val = 1 << i;
if (non_composited_main_thread_scrolling_reasons & val) {
if (device == kWebGestureDeviceTouchscreen) {
DEFINE_STATIC_LOCAL(EnumerationHistogram, touch_histogram,
("Renderer4.MainThreadGestureScrollReason",
main_thread_scrolling_reason_enum_max));
touch_histogram.Count(i + 1);
} else {
DEFINE_STATIC_LOCAL(EnumerationHistogram, wheel_histogram,
("Renderer4.MainThreadWheelScrollReason",
main_thread_scrolling_reason_enum_max));
wheel_histogram.Count(i + 1);
}
}
}
}
}
WebInputEventResult ScrollManager::HandleGestureScrollBegin(
const WebGestureEvent& gesture_event) {
TRACE_EVENT0("input", "ScrollManager::handleGestureScrollBegin");
Document* document = frame_->GetDocument();
if (!document->GetLayoutView())
return WebInputEventResult::kNotHandled;
// If there's no layoutObject on the node, send the event to the nearest
// ancestor with a layoutObject. Needed for <option> and <optgroup> elements
// so we can touch scroll <select>s
while (scroll_gesture_handling_node_ &&
!scroll_gesture_handling_node_->GetLayoutObject())
scroll_gesture_handling_node_ =
scroll_gesture_handling_node_->ParentOrShadowHostNode();
if (!scroll_gesture_handling_node_)
scroll_gesture_handling_node_ = frame_->GetDocument()->documentElement();
if (!scroll_gesture_handling_node_ ||
!scroll_gesture_handling_node_->GetLayoutObject()) {
TRACE_EVENT_INSTANT0("input", "Dropping: No LayoutObject",
TRACE_EVENT_SCOPE_THREAD);
return WebInputEventResult::kNotHandled;
}
WebInputEventResult child_result = PassScrollGestureEvent(
gesture_event, scroll_gesture_handling_node_->GetLayoutObject());
RecordScrollRelatedMetrics(gesture_event.SourceDevice());
current_scroll_chain_.clear();
std::unique_ptr<ScrollStateData> scroll_state_data =
std::make_unique<ScrollStateData>();
IntPoint position = FlooredIntPoint(gesture_event.PositionInRootFrame());
scroll_state_data->position_x = position.X();
scroll_state_data->position_y = position.Y();
scroll_state_data->delta_x_hint = -gesture_event.DeltaXInRootFrame();
scroll_state_data->delta_y_hint = -gesture_event.DeltaYInRootFrame();
scroll_state_data->is_beginning = true;
scroll_state_data->from_user_input = true;
scroll_state_data->is_direct_manipulation =
gesture_event.SourceDevice() == kWebGestureDeviceTouchscreen;
scroll_state_data->delta_consumed_for_scroll_sequence =
delta_consumed_for_scroll_sequence_;
ScrollState* scroll_state = ScrollState::Create(std::move(scroll_state_data));
RecomputeScrollChain(*scroll_gesture_handling_node_.Get(), *scroll_state,
current_scroll_chain_);
TRACE_EVENT_INSTANT1("input", "Computed Scroll Chain",
TRACE_EVENT_SCOPE_THREAD, "length",
current_scroll_chain_.size());
if (current_scroll_chain_.empty()) {
// If a child has a non-empty scroll chain, we need to consider that instead
// of simply returning WebInputEventResult::kNotHandled.
return child_result;
}
NotifyScrollPhaseBeginForCustomizedScroll(*scroll_state);
CustomizedScroll(*scroll_state);
if (gesture_event.SourceDevice() == kWebGestureDeviceTouchscreen)
UseCounter::Count(frame_->GetDocument(), WebFeature::kScrollByTouch);
else
UseCounter::Count(frame_->GetDocument(), WebFeature::kScrollByWheel);
return WebInputEventResult::kHandledSystem;
}
WebInputEventResult ScrollManager::HandleGestureScrollUpdate(
const WebGestureEvent& gesture_event) {
TRACE_EVENT0("input", "ScrollManager::handleGestureScrollUpdate");
DCHECK_EQ(gesture_event.GetType(), WebInputEvent::kGestureScrollUpdate);
Node* node = scroll_gesture_handling_node_.Get();
if (!node || !node->GetLayoutObject()) {
TRACE_EVENT_INSTANT0("input", "Lost scroll_gesture_handling_node",
TRACE_EVENT_SCOPE_THREAD);
if (previous_gesture_scrolled_element_) {
// When the scroll_gesture_handling_node_ gets deleted in the middle of
// scrolling call HandleGestureScrollEvent to start scrolling a new node
// if possible.
ClearGestureScrollState();
WebGestureEvent scroll_begin =
SynthesizeGestureScrollBegin(gesture_event);
HandleGestureScrollEvent(scroll_begin);
node = scroll_gesture_handling_node_.Get();
if (!node || !node->GetLayoutObject()) {
TRACE_EVENT_INSTANT0("input", "Failed to find new node",
TRACE_EVENT_SCOPE_THREAD);
return WebInputEventResult::kNotHandled;
}
} else {
TRACE_EVENT_INSTANT0("input", "No previously scrolled node",
TRACE_EVENT_SCOPE_THREAD);
return WebInputEventResult::kNotHandled;
}
}
if (snap_fling_controller_) {
if (snap_fling_controller_->HandleGestureScrollUpdate(
GetGestureScrollUpdateInfo(gesture_event))) {
return WebInputEventResult::kHandledSystem;
}
}
// Negate the deltas since the gesture event stores finger movement and
// scrolling occurs in the direction opposite the finger's movement
// direction. e.g. Finger moving up has negative event delta but causes the
// page to scroll down causing positive scroll delta.
FloatSize delta(-gesture_event.DeltaXInRootFrame(),
-gesture_event.DeltaYInRootFrame());
FloatSize velocity(-gesture_event.VelocityX(), -gesture_event.VelocityY());
FloatPoint position(gesture_event.PositionInRootFrame());
if (delta.IsZero())
return WebInputEventResult::kNotHandled;
LayoutObject* layout_object = node->GetLayoutObject();
// Try to send the event to the correct view.
WebInputEventResult result =
PassScrollGestureEvent(gesture_event, layout_object);
if (result != WebInputEventResult::kNotHandled) {
// FIXME: we should allow simultaneous scrolling of nested
// iframes along perpendicular axes. See crbug.com/466991.
delta_consumed_for_scroll_sequence_ = true;
return result;
}
if (current_scroll_chain_.empty()) {
TRACE_EVENT_INSTANT0("input", "Empty Scroll Chain",
TRACE_EVENT_SCOPE_THREAD);
return WebInputEventResult::kNotHandled;
}
std::unique_ptr<ScrollStateData> scroll_state_data =
std::make_unique<ScrollStateData>();
scroll_state_data->delta_x = delta.Width();
scroll_state_data->delta_y = delta.Height();
scroll_state_data->delta_granularity = static_cast<double>(
ToPlatformScrollGranularity(gesture_event.DeltaUnits()));
scroll_state_data->velocity_x = velocity.Width();
scroll_state_data->velocity_y = velocity.Height();
scroll_state_data->position_x = position.X();
scroll_state_data->position_y = position.Y();
scroll_state_data->is_in_inertial_phase =
gesture_event.InertialPhase() == WebGestureEvent::kMomentumPhase;
scroll_state_data->is_direct_manipulation =
gesture_event.SourceDevice() == kWebGestureDeviceTouchscreen;
scroll_state_data->from_user_input = true;
scroll_state_data->delta_consumed_for_scroll_sequence =
delta_consumed_for_scroll_sequence_;
ScrollState* scroll_state = ScrollState::Create(std::move(scroll_state_data));
if (previous_gesture_scrolled_element_) {
// The ScrollState needs to know what the current
// native scrolling element is, so that for an
// inertial scroll that shouldn't propagate, only the
// currently scrolling element responds.
scroll_state->SetCurrentNativeScrollingElement(
previous_gesture_scrolled_element_);
}
CustomizedScroll(*scroll_state);
previous_gesture_scrolled_element_ =
scroll_state->CurrentNativeScrollingElement();
delta_consumed_for_scroll_sequence_ =
scroll_state->DeltaConsumedForScrollSequence();
bool did_scroll_x = scroll_state->deltaX() != delta.Width();
bool did_scroll_y = scroll_state->deltaY() != delta.Height();
did_scroll_x_for_scroll_gesture_ |= did_scroll_x;
did_scroll_y_for_scroll_gesture_ |= did_scroll_y;
if ((!previous_gesture_scrolled_element_ ||
!IsViewportScrollingElement(*previous_gesture_scrolled_element_)) &&
GetPage())
GetPage()->GetOverscrollController().ResetAccumulated(did_scroll_x,
did_scroll_y);
if (did_scroll_x || did_scroll_y)
return WebInputEventResult::kHandledSystem;
return WebInputEventResult::kNotHandled;
}
WebInputEventResult ScrollManager::HandleGestureScrollEnd(
const WebGestureEvent& gesture_event) {
TRACE_EVENT0("input", "ScrollManager::handleGestureScrollEnd");
Node* node = scroll_gesture_handling_node_;
if (node && node->GetLayoutObject()) {
PassScrollGestureEvent(gesture_event, node->GetLayoutObject());
if (current_scroll_chain_.empty()) {
ClearGestureScrollState();
return WebInputEventResult::kNotHandled;
}
std::unique_ptr<ScrollStateData> scroll_state_data =
std::make_unique<ScrollStateData>();
scroll_state_data->is_ending = true;
scroll_state_data->is_in_inertial_phase =
gesture_event.InertialPhase() == WebGestureEvent::kMomentumPhase;
scroll_state_data->from_user_input = true;
scroll_state_data->is_direct_manipulation =
gesture_event.SourceDevice() == kWebGestureDeviceTouchscreen;
scroll_state_data->delta_consumed_for_scroll_sequence =
delta_consumed_for_scroll_sequence_;
ScrollState* scroll_state =
ScrollState::Create(std::move(scroll_state_data));
CustomizedScroll(*scroll_state);
SnapAtGestureScrollEnd();
NotifyScrollPhaseEndForCustomizedScroll();
}
ClearGestureScrollState();
return WebInputEventResult::kNotHandled;
}
LayoutBox* ScrollManager::LayoutBoxForSnapping() const {
if (!previous_gesture_scrolled_element_)
return nullptr;
Element* document_element = frame_->GetDocument()->documentElement();
return previous_gesture_scrolled_element_ == document_element
? frame_->GetDocument()->GetLayoutView()
: previous_gesture_scrolled_element_->GetLayoutBox();
}
void ScrollManager::SnapAtGestureScrollEnd() {
if (!previous_gesture_scrolled_element_ ||
(!did_scroll_x_for_scroll_gesture_ && !did_scroll_y_for_scroll_gesture_))
return;
SnapCoordinator* snap_coordinator =
frame_->GetDocument()->GetSnapCoordinator();
LayoutBox* layout_box = LayoutBoxForSnapping();
if (!snap_coordinator || !layout_box)
return;
snap_coordinator->PerformSnapping(*layout_box,
did_scroll_x_for_scroll_gesture_,
did_scroll_y_for_scroll_gesture_);
}
bool ScrollManager::GetSnapFlingInfo(const gfx::Vector2dF& natural_displacement,
gfx::Vector2dF* out_initial_offset,
gfx::Vector2dF* out_target_offset) const {
if (!previous_gesture_scrolled_element_)
return false;
SnapCoordinator* snap_coordinator =
frame_->GetDocument()->GetSnapCoordinator();
LayoutBox* layout_box = LayoutBoxForSnapping();
if (!snap_coordinator || !layout_box || !layout_box->GetScrollableArea())
return false;
return snap_coordinator->GetSnapFlingInfo(
*layout_box, natural_displacement, out_initial_offset, out_target_offset);
}
gfx::Vector2dF ScrollManager::ScrollByForSnapFling(
const gfx::Vector2dF& delta) {
ScrollableArea* scrollable_area =
ScrollableAreaForSnapping(LayoutBoxForSnapping());
if (!scrollable_area)
return gfx::Vector2dF();
std::unique_ptr<ScrollStateData> scroll_state_data =
std::make_unique<ScrollStateData>();
// TODO(sunyunjia): Plumb the velocity of the snap curve as well.
scroll_state_data->delta_x = delta.x();
scroll_state_data->delta_y = delta.y();
scroll_state_data->is_in_inertial_phase = true;
scroll_state_data->from_user_input = true;
scroll_state_data->delta_granularity =
static_cast<double>(ScrollGranularity::kScrollByPrecisePixel);
scroll_state_data->delta_consumed_for_scroll_sequence =
delta_consumed_for_scroll_sequence_;
ScrollState* scroll_state = ScrollState::Create(std::move(scroll_state_data));
scroll_state->SetCurrentNativeScrollingElement(
previous_gesture_scrolled_element_);
CustomizedScroll(*scroll_state);
FloatPoint end_position = scrollable_area->ScrollPosition();
return gfx::Vector2dF(end_position.X(), end_position.Y());
}
void ScrollManager::ScrollEndForSnapFling() {
if (current_scroll_chain_.empty()) {
NotifyScrollPhaseEndForCustomizedScroll();
ClearGestureScrollState();
return;
}
std::unique_ptr<ScrollStateData> scroll_state_data =
std::make_unique<ScrollStateData>();
scroll_state_data->is_ending = true;
scroll_state_data->is_in_inertial_phase = true;
scroll_state_data->from_user_input = true;
scroll_state_data->delta_consumed_for_scroll_sequence =
delta_consumed_for_scroll_sequence_;
ScrollState* scroll_state = ScrollState::Create(std::move(scroll_state_data));
CustomizedScroll(*scroll_state);
NotifyScrollPhaseEndForCustomizedScroll();
ClearGestureScrollState();
}
void ScrollManager::RequestAnimationForSnapFling() {
if (Page* page = frame_->GetPage())
page->GetChromeClient().ScheduleAnimation(frame_->View());
}
void ScrollManager::AnimateSnapFling(base::TimeTicks monotonic_time) {
DCHECK(snap_fling_controller_);
snap_fling_controller_->Animate(monotonic_time);
}
Page* ScrollManager::GetPage() const {
return frame_->GetPage();
}
WebInputEventResult ScrollManager::PassScrollGestureEvent(
const WebGestureEvent& gesture_event,
LayoutObject* layout_object) {
DCHECK(gesture_event.IsScrollEvent());
if (!last_gesture_scroll_over_embedded_content_view_ || !layout_object ||
!layout_object->IsLayoutEmbeddedContent())
return WebInputEventResult::kNotHandled;
FrameView* frame_view =
ToLayoutEmbeddedContent(layout_object)->ChildFrameView();
if (!frame_view || !frame_view->IsLocalFrameView())
return WebInputEventResult::kNotHandled;
return ToLocalFrameView(frame_view)
->GetFrame()
.GetEventHandler()
.HandleGestureScrollEvent(gesture_event);
}
bool ScrollManager::IsViewportScrollingElement(const Element& element) const {
// The root scroller is the one Element on the page designated to perform
// "viewport actions" like browser controls movement and overscroll glow.
if (!frame_->GetDocument())
return false;
return frame_->GetDocument()->GetRootScrollerController().ScrollsViewport(
element);
}
WebInputEventResult ScrollManager::HandleGestureScrollEvent(
const WebGestureEvent& gesture_event) {
if (!frame_->View())
return WebInputEventResult::kNotHandled;
TRACE_EVENT0("input", "ScrollManager::handleGestureScrollEvent");
Node* event_target = nullptr;
Scrollbar* scrollbar = nullptr;
if (gesture_event.GetType() != WebInputEvent::kGestureScrollBegin) {
scrollbar = scrollbar_handling_scroll_gesture_.Get();
event_target = scroll_gesture_handling_node_.Get();
}
if (!event_target) {
Document* document = frame_->GetDocument();
if (!document->GetLayoutView())
return WebInputEventResult::kNotHandled;
TRACE_EVENT_INSTANT0("input", "Retargeting Scroll",
TRACE_EVENT_SCOPE_THREAD);
LocalFrameView* view = frame_->View();
LayoutPoint view_point = view->ConvertFromRootFrame(
FlooredIntPoint(gesture_event.PositionInRootFrame()));
HitTestRequest request(HitTestRequest::kReadOnly);
HitTestLocation location(view_point);
HitTestResult result(request, location);
document->GetLayoutView()->HitTest(location, result);
event_target = result.InnerNode();
last_gesture_scroll_over_embedded_content_view_ =
result.IsOverEmbeddedContentView();
scroll_gesture_handling_node_ = event_target;
previous_gesture_scrolled_element_ = nullptr;
delta_consumed_for_scroll_sequence_ = false;
did_scroll_x_for_scroll_gesture_ = false;
did_scroll_y_for_scroll_gesture_ = false;
if (!scrollbar)
scrollbar = result.GetScrollbar();
}
if (scrollbar) {
bool should_update_capture = false;
if (scrollbar->GestureEvent(gesture_event, &should_update_capture)) {
if (should_update_capture)
scrollbar_handling_scroll_gesture_ = scrollbar;
return WebInputEventResult::kHandledSuppressed;
}
scrollbar_handling_scroll_gesture_ = nullptr;
}
if (event_target) {
if (HandleScrollGestureOnResizer(event_target, gesture_event))
return WebInputEventResult::kHandledSuppressed;
GestureEvent* gesture_dom_event = GestureEvent::Create(
event_target->GetDocument().domWindow(), gesture_event);
if (gesture_dom_event) {
DispatchEventResult gesture_dom_event_result =
event_target->DispatchEvent(*gesture_dom_event);
if (gesture_dom_event_result != DispatchEventResult::kNotCanceled) {
DCHECK(gesture_dom_event_result !=
DispatchEventResult::kCanceledByEventHandler);
return EventHandlingUtil::ToWebInputEventResult(
gesture_dom_event_result);
}
}
}
if (snap_fling_controller_) {
if (gesture_event.IsGestureScroll() &&
(snap_fling_controller_->FilterEventForSnap(
ToGestureScrollType(gesture_event.GetType())))) {
return WebInputEventResult::kNotHandled;
}
}
switch (gesture_event.GetType()) {
case WebInputEvent::kGestureScrollBegin:
return HandleGestureScrollBegin(gesture_event);
case WebInputEvent::kGestureScrollUpdate:
return HandleGestureScrollUpdate(gesture_event);
case WebInputEvent::kGestureScrollEnd:
return HandleGestureScrollEnd(gesture_event);
case WebInputEvent::kGestureFlingStart:
case WebInputEvent::kGestureFlingCancel:
return WebInputEventResult::kNotHandled;
default:
NOTREACHED();
return WebInputEventResult::kNotHandled;
}
}
bool ScrollManager::IsScrollbarHandlingGestures() const {
return scrollbar_handling_scroll_gesture_.Get();
}
bool ScrollManager::HandleScrollGestureOnResizer(
Node* event_target,
const WebGestureEvent& gesture_event) {
if (gesture_event.SourceDevice() != kWebGestureDeviceTouchscreen)
return false;
if (gesture_event.GetType() == WebInputEvent::kGestureScrollBegin) {
PaintLayer* layer = event_target->GetLayoutObject()
? event_target->GetLayoutObject()->EnclosingLayer()
: nullptr;
IntPoint p = frame_->View()->ConvertFromRootFrame(
FlooredIntPoint(gesture_event.PositionInRootFrame()));
if (layer && layer->GetScrollableArea() &&
layer->GetScrollableArea()->IsPointInResizeControl(p,
kResizerForTouch)) {
resize_scrollable_area_ = layer->GetScrollableArea();
resize_scrollable_area_->SetInResizeMode(true);
offset_from_resize_corner_ =
LayoutSize(resize_scrollable_area_->OffsetFromResizeCorner(p));
return true;
}
} else if (gesture_event.GetType() == WebInputEvent::kGestureScrollUpdate) {
if (resize_scrollable_area_ && resize_scrollable_area_->InResizeMode()) {
IntPoint pos = RoundedIntPoint(gesture_event.PositionInRootFrame());
pos.Move(gesture_event.DeltaXInRootFrame(),
gesture_event.DeltaYInRootFrame());
resize_scrollable_area_->Resize(pos, offset_from_resize_corner_);
return true;
}
} else if (gesture_event.GetType() == WebInputEvent::kGestureScrollEnd) {
if (resize_scrollable_area_ && resize_scrollable_area_->InResizeMode()) {
resize_scrollable_area_->SetInResizeMode(false);
resize_scrollable_area_ = nullptr;
return false;
}
}
return false;
}
bool ScrollManager::InResizeMode() const {
return resize_scrollable_area_ && resize_scrollable_area_->InResizeMode();
}
void ScrollManager::Resize(const WebMouseEvent& evt) {
if (evt.GetType() == WebInputEvent::kMouseMove) {
if (!frame_->GetEventHandler().MousePressed())
return;
resize_scrollable_area_->Resize(FlooredIntPoint(evt.PositionInRootFrame()),
offset_from_resize_corner_);
}
}
void ScrollManager::ClearResizeScrollableArea(bool should_not_be_null) {
if (should_not_be_null)
DCHECK(resize_scrollable_area_);
if (resize_scrollable_area_)
resize_scrollable_area_->SetInResizeMode(false);
resize_scrollable_area_ = nullptr;
}
void ScrollManager::SetResizeScrollableArea(PaintLayer* layer, IntPoint p) {
resize_scrollable_area_ = layer->GetScrollableArea();
resize_scrollable_area_->SetInResizeMode(true);
offset_from_resize_corner_ =
LayoutSize(resize_scrollable_area_->OffsetFromResizeCorner(p));
}
bool ScrollManager::CanHandleGestureEvent(
const GestureEventWithHitTestResults& targeted_event) {
Scrollbar* scrollbar = targeted_event.GetHitTestResult().GetScrollbar();
if (scrollbar) {
bool should_update_capture = false;
if (scrollbar->GestureEvent(targeted_event.Event(),
&should_update_capture)) {
if (should_update_capture)
scrollbar_handling_scroll_gesture_ = scrollbar;
return true;
}
}
return false;
}
WebGestureEvent ScrollManager::SynthesizeGestureScrollBegin(
const WebGestureEvent& update_event) {
DCHECK_EQ(update_event.GetType(), WebInputEvent::kGestureScrollUpdate);
WebGestureEvent scroll_begin(update_event);
scroll_begin.SetType(WebInputEvent::kGestureScrollBegin);
scroll_begin.data.scroll_begin.delta_x_hint =
update_event.data.scroll_update.delta_x;
scroll_begin.data.scroll_begin.delta_y_hint =
update_event.data.scroll_update.delta_y;
scroll_begin.data.scroll_begin.delta_hint_units =
update_event.data.scroll_update.delta_units;
return scroll_begin;
}
void ScrollManager::NotifyScrollPhaseBeginForCustomizedScroll(
const ScrollState& scroll_state) {
ScrollCustomization::ScrollDirection direction =
ScrollCustomization::GetScrollDirectionFromDeltas(
scroll_state.deltaXHint(), scroll_state.deltaYHint());
for (auto id : current_scroll_chain_) {
Node* node = DOMNodeIds::NodeForId(id);
if (node && node->IsElementNode())
ToElement(node)->WillBeginCustomizedScrollPhase(direction);
}
}
void ScrollManager::NotifyScrollPhaseEndForCustomizedScroll() {
for (auto id : current_scroll_chain_) {
Node* node = DOMNodeIds::NodeForId(id);
if (node && node->IsElementNode())
ToElement(node)->DidEndCustomizedScrollPhase();
}
}
} // namespace blink
|