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
|
/*
* Copyright (C) 2011 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef THIRD_PARTY_BLINK_RENDERER_CORE_PAGE_SCROLLING_SCROLLING_COORDINATOR_H_
#define THIRD_PARTY_BLINK_RENDERER_CORE_PAGE_SCROLLING_SCROLLING_COORDINATOR_H_
#include <memory>
#include "base/macros.h"
#include "base/memory/weak_ptr.h"
#include "third_party/blink/renderer/core/core_export.h"
#include "third_party/blink/renderer/core/scroll/scroll_types.h"
#include "third_party/blink/renderer/platform/graphics/compositing/paint_artifact_compositor.h"
#include "third_party/blink/renderer/platform/graphics/compositor_element_id.h"
#include "third_party/blink/renderer/platform/heap/handle.h"
namespace cc {
class AnimationHost;
class ScrollbarLayerBase;
} // namespace cc
namespace blink {
class CompositorAnimationTimeline;
class LocalFrame;
class LocalFrameView;
class Page;
class PaintLayerScrollableArea;
class ScrollableArea;
using MainThreadScrollingReasons = uint32_t;
using ScrollbarId = uint64_t;
// ScrollingCoordinator is a page-level object that mediates interactions
// between Blink and the compositor's scroll-related APIs on the composited
// layer representing the scrollbar.
//
// It's responsible for propagating scroll offsets, main-thread scrolling
// reasons, touch action regions, and non-fast-scrollable regions into the
// compositor, as well as creating and managing scrollbar layers.
class CORE_EXPORT ScrollingCoordinator final
: public GarbageCollected<ScrollingCoordinator>,
public CompositorScrollCallbacks {
public:
explicit ScrollingCoordinator(Page*);
~ScrollingCoordinator() override;
void Trace(blink::Visitor*);
// The LocalFrameView argument is optional, nullptr causes the the scrolling
// animation host and timeline to be owned by the ScrollingCoordinator. When
// not null, the host and timeline are attached to the specified
// LocalFrameView. A LocalFrameView only needs to own them when it is the view
// for an OOPIF.
void AnimationHostInitialized(cc::AnimationHost&, LocalFrameView*);
void WillCloseAnimationHost(LocalFrameView*);
void WillBeDestroyed();
// Return whether this scrolling coordinator handles scrolling for the given
// frame view.
bool CoordinatesScrollingForFrameView(LocalFrameView*) const;
// Called when any frame has done its layout or compositing has changed.
void NotifyGeometryChanged(LocalFrameView*);
// Update non-fast scrollable regions, touch event target rects, main thread
// scrolling reasons, and whether the visual viewport is user scrollable.
// TODO(pdr): Refactor this out of ScrollingCoordinator.
void UpdateAfterPaint(LocalFrameView*);
// Should be called whenever the slow repaint objects counter changes between
// zero and one.
void FrameViewHasBackgroundAttachmentFixedObjectsDidChange(LocalFrameView*);
// Should be called whenever the set of fixed objects changes.
void FrameViewFixedObjectsDidChange(LocalFrameView*);
// Should be called whenever the root layer for the given frame view changes.
void FrameViewRootLayerDidChange(LocalFrameView*);
scoped_refptr<cc::ScrollbarLayerBase> CreateSolidColorScrollbarLayer(
ScrollbarOrientation,
int thumb_thickness,
int track_start,
bool is_left_side_vertical_scrollbar,
cc::ElementId);
void WillDestroyScrollableArea(ScrollableArea*);
// Updates scroll offset, if the appropriate composited layers exist,
// and if successful, returns true. Otherwise returns false.
bool UpdateCompositedScrollOffset(ScrollableArea* scrollable_area);
// Updates composited layers after changes to scrollable area properties
// like content and container sizes, scrollbar existence, scrollability, etc.
// Scroll offset changes are updated by UpdateCompositedScrollOffset.
// TODO(pdr): Factor the container bounds change out of this function. The
// compositor tracks scroll container bounds on the scroll layer whereas
// blink uses a separate layer. To ensure the compositor scroll layer has the
// updated scroll container bounds, this needs to be called when the scrolling
// contents layer is resized.
void ScrollableAreaScrollLayerDidChange(PaintLayerScrollableArea*);
void ScrollableAreaScrollbarLayerDidChange(PaintLayerScrollableArea*,
ScrollbarOrientation);
// LocalFrame* must be a local root if non-null.
void TouchEventTargetRectsDidChange(LocalFrame*);
void UpdateNonFastScrollableRegions(LocalFrame*);
void UpdateTouchEventTargetRectsIfNeeded(LocalFrame*);
cc::AnimationHost* GetCompositorAnimationHost() { return animation_host_; }
CompositorAnimationTimeline* GetCompositorAnimationTimeline() {
return programmatic_scroll_animator_timeline_.get();
}
// Traverses the frame tree to find the scrollable area using the element id.
// This function only checks the local frames. This function does not check
// the VisualViewport element id.
ScrollableArea* ScrollableAreaWithElementIdInAllLocalFrames(
const CompositorElementId&);
// ScrollCallbacks implementation
void DidScroll(CompositorElementId,
const gfx::ScrollOffset&,
const base::Optional<cc::TargetSnapAreaElementIds>&) override;
void DidChangeScrollbarsHidden(CompositorElementId, bool hidden) override;
base::WeakPtr<ScrollingCoordinator> GetWeakPtr() {
return weak_ptr_factory_.GetWeakPtr();
}
// For testing purposes only. This ScrollingCoordinator is reused between
// web tests, and must be reset for the results to be valid.
void Reset(LocalFrame*);
protected:
bool IsForMainFrame(ScrollableArea*) const;
Member<Page> page_;
// Dirty flags used to identify what really needs to be computed after
// compositing is updated.
bool touch_event_target_rects_are_dirty_;
bool should_scroll_on_main_thread_dirty_;
private:
void AddScrollbarLayer(ScrollableArea*,
ScrollbarOrientation,
scoped_refptr<cc::ScrollbarLayerBase>);
cc::ScrollbarLayerBase* GetScrollbarLayer(ScrollableArea*,
ScrollbarOrientation);
void RemoveScrollbarLayer(ScrollableArea*, ScrollbarOrientation);
bool FrameScrollerIsDirty(LocalFrameView*) const;
cc::AnimationHost* animation_host_ = nullptr;
std::unique_ptr<CompositorAnimationTimeline>
programmatic_scroll_animator_timeline_;
using ScrollbarMap = HeapHashMap<Member<ScrollableArea>,
scoped_refptr<cc::ScrollbarLayerBase>>;
ScrollbarMap horizontal_scrollbars_;
ScrollbarMap vertical_scrollbars_;
base::WeakPtrFactory<ScrollingCoordinator> weak_ptr_factory_{this};
DISALLOW_COPY_AND_ASSIGN(ScrollingCoordinator);
};
} // namespace blink
#endif // THIRD_PARTY_BLINK_RENDERER_CORE_PAGE_SCROLLING_SCROLLING_COORDINATOR_H_
|
