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
|
// Copyright 2015 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.
#ifndef THIRD_PARTY_BLINK_RENDERER_CORE_LAYOUT_SCROLL_ANCHOR_H_
#define THIRD_PARTY_BLINK_RENDERER_CORE_LAYOUT_SCROLL_ANCHOR_H_
#include "third_party/blink/renderer/core/core_export.h"
#include "third_party/blink/renderer/platform/geometry/layout_point.h"
#include "third_party/blink/renderer/platform/heap/handle.h"
#include "third_party/blink/renderer/platform/wtf/text/wtf_string.h"
namespace blink {
class LayoutObject;
class ScrollableArea;
static const int kMaxSerializedSelectorLength = 500;
struct SerializedAnchor {
SerializedAnchor() : simhash(0) {}
SerializedAnchor(const String& s, const LayoutPoint& p)
: selector(s), relative_offset(p), simhash(0) {}
SerializedAnchor(const String& s, const LayoutPoint& p, uint64_t hash)
: selector(s), relative_offset(p), simhash(hash) {}
bool IsValid() const { return !selector.IsEmpty(); }
// Used to locate an element previously used as a scroll anchor.
const String selector;
// Used to restore the previous offset of the element within its scroller.
const LayoutPoint relative_offset;
// Used to compare the similarity of a prospective anchor's contents to the
// contents at the time the previous anchor was saved.
const uint64_t simhash;
};
// Scrolls to compensate for layout movements (bit.ly/scroll-anchoring).
class CORE_EXPORT ScrollAnchor final {
DISALLOW_NEW();
public:
ScrollAnchor();
explicit ScrollAnchor(ScrollableArea*);
~ScrollAnchor();
// The scroller that is scrolled to componsate for layout movements. Note
// that the scroller can only be initialized once.
void SetScroller(ScrollableArea*);
// Returns true if the underlying scroller is set.
bool HasScroller() const { return scroller_; }
// The LayoutObject we are currently anchored to. Lazily computed during
// notifyBeforeLayout() and cached until the next call to clear().
LayoutObject* AnchorObject() const { return anchor_object_; }
// Called when the scroller attached to this anchor is being destroyed.
void Dispose();
// Indicates that this ScrollAnchor, and all ancestor ScrollAnchors, should
// compute new anchor nodes on their next notifyBeforeLayout().
void Clear();
// Indicates that this ScrollAnchor should compute a new anchor node on the
// next call to notifyBeforeLayout().
void ClearSelf();
// Records the anchor's location in relation to the scroller. Should be
// called when the scroller is about to be laid out.
void NotifyBeforeLayout();
// Scrolls to compensate for any change in the anchor's relative location.
// Should be called at the end of the animation frame.
void Adjust();
enum class Corner {
kTopLeft = 0,
kTopRight,
};
// Which corner of the anchor object we are currently anchored to.
// Only meaningful if anchorObject() is non-null.
Corner GetCorner() const { return corner_; }
// This enum must remain in sync with the corresponding enum in enums.xml.
enum RestorationStatus {
kSuccess = 0,
kFailedNoMatches,
kFailedNoValidMatches,
kFailedBadSelector,
kStatusCount // Special value used to count the number of enum values; not
// to be used as an actual status. Add new values above.
};
// Attempt to restore |serialized_anchor| by scrolling to the element
// identified by its selector, adjusting by its relative_offset.
bool RestoreAnchor(const SerializedAnchor&);
// Get the serialized representation of the current anchor_object_.
// If there is not currently an anchor_object_, this will attempt to find one.
// Repeated calls will re-use the previously calculated selector until the
// anchor_object it corresponds to is cleared.
const SerializedAnchor GetSerializedAnchor();
// Checks if we hold any references to the specified object.
bool RefersTo(const LayoutObject*) const;
// Notifies us that an object will be removed from the layout tree.
void NotifyRemoved(LayoutObject*);
void Trace(Visitor* visitor) { visitor->Trace(scroller_); }
private:
void FindAnchor();
// Returns true if searching should stop. Stores result in m_anchorObject.
bool FindAnchorRecursive(LayoutObject*);
bool ComputeScrollAnchorDisablingStyleChanged();
enum WalkStatus { kSkip = 0, kConstrain, kContinue, kReturn };
struct ExamineResult {
ExamineResult(WalkStatus s)
: status(s), viable(false), corner(Corner::kTopLeft) {}
ExamineResult(WalkStatus s, Corner c)
: status(s), viable(true), corner(c) {}
WalkStatus status;
bool viable;
Corner corner;
};
ExamineResult Examine(const LayoutObject*) const;
IntSize ComputeAdjustment() const;
// The scroller to be adjusted by this ScrollAnchor. This is also the scroller
// that owns us, unless it is the RootFrameViewport in which case we are owned
// by the layout viewport.
Member<ScrollableArea> scroller_;
// The LayoutObject we should anchor to.
LayoutObject* anchor_object_;
// Which corner of m_anchorObject's bounding box to anchor to.
Corner corner_;
// Location of m_layoutObject relative to scroller at time of
// notifyBeforeLayout().
LayoutPoint saved_relative_offset_;
// Previously calculated css selector that uniquely locates the current
// anchor_object_. Cleared when the anchor_object_ is cleared.
String saved_selector_;
// We suppress scroll anchoring after a style change on the anchor node or
// one of its ancestors, if that change might have caused the node to move.
// This bit tracks whether we have had a scroll-anchor-disabling style
// change since the last layout. It is recomputed in notifyBeforeLayout(),
// and used to suppress adjustment in adjust(). See http://bit.ly/sanaclap.
bool scroll_anchor_disabling_style_changed_;
// True iff an adjustment check has been queued with the FrameView but not yet
// performed.
bool queued_;
};
} // namespace blink
#endif // THIRD_PARTY_BLINK_RENDERER_CORE_LAYOUT_SCROLL_ANCHOR_H_
|
