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
|
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef mozilla_OverflowChangedTracker_h
#define mozilla_OverflowChangedTracker_h
#include "nsIFrame.h"
#include "nsContainerFrame.h"
#include "mozilla/SplayTree.h"
namespace mozilla {
/**
* Helper class that collects a list of frames that need
* UpdateOverflow() called on them, and coalesces them
* to avoid walking up the same ancestor tree multiple times.
*/
class OverflowChangedTracker
{
public:
enum ChangeKind {
/**
* The frame was explicitly added as a result of
* nsChangeHint_UpdatePostTransformOverflow and hence may have had a style
* change that changes its geometry relative to parent, without reflowing.
*/
TRANSFORM_CHANGED,
/**
* The overflow areas of children have changed
* and we need to call UpdateOverflow on the frame.
*/
CHILDREN_CHANGED,
};
OverflowChangedTracker() :
mSubtreeRoot(nullptr)
{}
~OverflowChangedTracker()
{
NS_ASSERTION(mEntryList.empty(), "Need to flush before destroying!");
}
/**
* Add a frame that has had a style change, and needs its
* overflow updated.
*
* If there are pre-transform overflow areas stored for this
* frame, then we will call FinishAndStoreOverflow with those
* areas instead of UpdateOverflow().
*
* If the overflow area changes, then UpdateOverflow will also
* be called on the parent.
*/
void AddFrame(nsIFrame* aFrame, ChangeKind aChangeKind) {
uint32_t depth = aFrame->GetDepthInFrameTree();
Entry *entry = nullptr;
if (!mEntryList.empty()) {
entry = mEntryList.find(Entry(aFrame, depth));
}
if (entry == nullptr) {
// Add new entry.
mEntryList.insert(new Entry(aFrame, depth, aChangeKind));
} else {
// Update the existing entry if the new value is stronger.
entry->mChangeKind = std::max(entry->mChangeKind, aChangeKind);
}
}
/**
* Remove a frame.
*/
void RemoveFrame(nsIFrame* aFrame) {
if (mEntryList.empty()) {
return;
}
uint32_t depth = aFrame->GetDepthInFrameTree();
if (mEntryList.find(Entry(aFrame, depth))) {
delete mEntryList.remove(Entry(aFrame, depth));
}
}
/**
* Set the subtree root to limit overflow updates. This must be set if and
* only if currently reflowing aSubtreeRoot, to ensure overflow changes will
* still propagate correctly.
*/
void SetSubtreeRoot(const nsIFrame* aSubtreeRoot) {
mSubtreeRoot = aSubtreeRoot;
}
/**
* Update the overflow of all added frames, and clear the entry list.
*
* Start from those deepest in the frame tree and works upwards. This stops
* us from processing the same frame twice.
*/
void Flush() {
while (!mEntryList.empty()) {
Entry *entry = mEntryList.removeMin();
nsIFrame *frame = entry->mFrame;
bool overflowChanged = false;
if (entry->mChangeKind == CHILDREN_CHANGED) {
// Need to union the overflow areas of the children.
// Only update the parent if the overflow changes.
overflowChanged = frame->UpdateOverflow();
} else {
// Take a faster path that doesn't require unioning the overflow areas
// of our children.
NS_ASSERTION(frame->GetProperty(
nsIFrame::DebugInitialOverflowPropertyApplied()),
"InitialOverflowProperty must be set first.");
nsOverflowAreas* overflow =
frame->GetProperty(nsIFrame::InitialOverflowProperty());
if (overflow) {
// FinishAndStoreOverflow will change the overflow areas passed in,
// so make a copy.
nsOverflowAreas overflowCopy = *overflow;
frame->FinishAndStoreOverflow(overflowCopy, frame->GetSize());
} else {
nsRect bounds(nsPoint(0, 0), frame->GetSize());
nsOverflowAreas boundsOverflow;
boundsOverflow.SetAllTo(bounds);
frame->FinishAndStoreOverflow(boundsOverflow, bounds.Size());
}
// We can't tell if the overflow changed, so be conservative
overflowChanged = true;
}
// If the frame style changed (e.g. positioning offsets)
// then we need to update the parent with the overflow areas of its
// children.
if (overflowChanged) {
nsIFrame *parent = frame->GetParent();
while (parent &&
parent != mSubtreeRoot &&
parent->Combines3DTransformWithAncestors()) {
// Passing frames in between the frame and the establisher of
// 3D rendering context.
parent = parent->GetParent();
MOZ_ASSERT(parent, "Root frame should never return true for Combines3DTransformWithAncestors");
}
if (parent && parent != mSubtreeRoot) {
Entry* parentEntry = mEntryList.find(Entry(parent, entry->mDepth - 1));
if (parentEntry) {
parentEntry->mChangeKind = std::max(parentEntry->mChangeKind, CHILDREN_CHANGED);
} else {
mEntryList.insert(new Entry(parent, entry->mDepth - 1, CHILDREN_CHANGED));
}
}
}
delete entry;
}
}
private:
struct Entry : SplayTreeNode<Entry>
{
Entry(nsIFrame* aFrame, uint32_t aDepth, ChangeKind aChangeKind = CHILDREN_CHANGED)
: mFrame(aFrame)
, mDepth(aDepth)
, mChangeKind(aChangeKind)
{}
bool operator==(const Entry& aOther) const
{
return mFrame == aOther.mFrame;
}
/**
* Sort by *reverse* depth in the tree, and break ties with
* the frame pointer.
*/
bool operator<(const Entry& aOther) const
{
if (mDepth == aOther.mDepth) {
return mFrame < aOther.mFrame;
}
return mDepth > aOther.mDepth; /* reverse, want "min" to be deepest */
}
static int compare(const Entry& aOne, const Entry& aTwo)
{
if (aOne == aTwo) {
return 0;
} else if (aOne < aTwo) {
return -1;
} else {
return 1;
}
}
nsIFrame* mFrame;
/* Depth in the frame tree */
uint32_t mDepth;
ChangeKind mChangeKind;
};
/* A list of frames to process, sorted by their depth in the frame tree */
SplayTree<Entry, Entry> mEntryList;
/* Don't update overflow of this frame or its ancestors. */
const nsIFrame* mSubtreeRoot;
};
} // namespace mozilla
#endif
|
