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
|
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* 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/. */
#include "SMILCompositor.h"
#include "mozilla/dom/SVGSVGElement.h"
#include "nsComputedDOMStyle.h"
#include "nsCSSProps.h"
#include "nsHashKeys.h"
#include "SMILCSSProperty.h"
namespace mozilla {
// PLDHashEntryHdr methods
bool SMILCompositor::KeyEquals(KeyTypePointer aKey) const {
return aKey && aKey->Equals(mKey);
}
/*static*/
PLDHashNumber SMILCompositor::HashKey(KeyTypePointer aKey) {
// Combine the 3 values into one numeric value, which will be hashed.
// NOTE: We right-shift one of the pointers by 2 to get some randomness in
// its 2 lowest-order bits. (Those shifted-off bits will always be 0 since
// our pointers will be word-aligned.)
return (NS_PTR_TO_UINT32(aKey->mElement.get()) >> 2) +
NS_PTR_TO_UINT32(aKey->mAttributeName.get());
}
// Cycle-collection support
void SMILCompositor::Traverse(nsCycleCollectionTraversalCallback* aCallback) {
if (!mKey.mElement) return;
NS_CYCLE_COLLECTION_NOTE_EDGE_NAME(*aCallback, "Compositor mKey.mElement");
aCallback->NoteXPCOMChild(mKey.mElement);
}
// Other methods
void SMILCompositor::AddAnimationFunction(SMILAnimationFunction* aFunc) {
if (aFunc) {
mAnimationFunctions.AppendElement(aFunc);
}
}
void SMILCompositor::ComposeAttribute(bool& aMightHavePendingStyleUpdates) {
if (!mKey.mElement) return;
// If we might need to resolve base styles, grab a suitable ComputedStyle
// for initializing our SMILAttr with.
RefPtr<const ComputedStyle> baseComputedStyle;
if (MightNeedBaseStyle()) {
baseComputedStyle = nsComputedDOMStyle::GetUnanimatedComputedStyleNoFlush(
mKey.mElement, PseudoStyleType::NotPseudo);
}
// FIRST: Get the SMILAttr (to grab base value from, and to eventually
// give animated value to)
UniquePtr<SMILAttr> smilAttr = CreateSMILAttr(baseComputedStyle);
if (!smilAttr) {
// Target attribute not found (or, out of memory)
return;
}
if (mAnimationFunctions.IsEmpty()) {
// No active animation functions. (We can still have a SMILCompositor in
// that case if an animation function has *just* become inactive)
smilAttr->ClearAnimValue();
// Removing the animation effect may require a style update.
aMightHavePendingStyleUpdates = true;
return;
}
// SECOND: Sort the animationFunctions, to prepare for compositing.
SMILAnimationFunction::Comparator comparator;
mAnimationFunctions.Sort(comparator);
// THIRD: Step backwards through animation functions to find out
// which ones we actually care about.
uint32_t firstFuncToCompose = GetFirstFuncToAffectSandwich();
// FOURTH: Get & cache base value
SMILValue sandwichResultValue;
if (!mAnimationFunctions[firstFuncToCompose]->WillReplace()) {
sandwichResultValue = smilAttr->GetBaseValue();
}
UpdateCachedBaseValue(sandwichResultValue);
if (!mForceCompositing) {
return;
}
// FIFTH: Compose animation functions
aMightHavePendingStyleUpdates = true;
uint32_t length = mAnimationFunctions.Length();
for (uint32_t i = firstFuncToCompose; i < length; ++i) {
mAnimationFunctions[i]->ComposeResult(*smilAttr, sandwichResultValue);
}
if (sandwichResultValue.IsNull()) {
smilAttr->ClearAnimValue();
return;
}
// SIXTH: Set the animated value to the final composited result.
nsresult rv = smilAttr->SetAnimValue(sandwichResultValue);
if (NS_FAILED(rv)) {
NS_WARNING("SMILAttr::SetAnimValue failed");
}
}
void SMILCompositor::ClearAnimationEffects() {
if (!mKey.mElement || !mKey.mAttributeName) return;
UniquePtr<SMILAttr> smilAttr = CreateSMILAttr(nullptr);
if (!smilAttr) {
// Target attribute not found (or, out of memory)
return;
}
smilAttr->ClearAnimValue();
}
// Protected Helper Functions
// --------------------------
UniquePtr<SMILAttr> SMILCompositor::CreateSMILAttr(
const ComputedStyle* aBaseComputedStyle) {
nsCSSPropertyID propID = GetCSSPropertyToAnimate();
if (propID != eCSSProperty_UNKNOWN) {
return MakeUnique<SMILCSSProperty>(propID, mKey.mElement.get(),
aBaseComputedStyle);
}
return mKey.mElement->GetAnimatedAttr(mKey.mAttributeNamespaceID,
mKey.mAttributeName);
}
nsCSSPropertyID SMILCompositor::GetCSSPropertyToAnimate() const {
if (mKey.mAttributeNamespaceID != kNameSpaceID_None) {
return eCSSProperty_UNKNOWN;
}
nsCSSPropertyID propID =
nsCSSProps::LookupProperty(nsAtomCString(mKey.mAttributeName));
if (!SMILCSSProperty::IsPropertyAnimatable(propID)) {
return eCSSProperty_UNKNOWN;
}
// If we are animating the 'width' or 'height' of an outer SVG
// element we should animate it as a CSS property, but for other elements
// in SVG namespace (e.g. <rect>) we should animate it as a length attribute.
if ((mKey.mAttributeName == nsGkAtoms::width ||
mKey.mAttributeName == nsGkAtoms::height) &&
mKey.mElement->GetNameSpaceID() == kNameSpaceID_SVG) {
// Not an <svg> element.
if (!mKey.mElement->IsSVGElement(nsGkAtoms::svg)) {
return eCSSProperty_UNKNOWN;
}
// An inner <svg> element
if (static_cast<dom::SVGSVGElement const&>(*mKey.mElement).IsInner()) {
return eCSSProperty_UNKNOWN;
}
// Indeed an outer <svg> element, fall through.
}
return propID;
}
bool SMILCompositor::MightNeedBaseStyle() const {
if (GetCSSPropertyToAnimate() == eCSSProperty_UNKNOWN) {
return false;
}
// We should return true if at least one animation function might build on
// the base value.
for (const SMILAnimationFunction* func : mAnimationFunctions) {
if (!func->WillReplace()) {
return true;
}
}
return false;
}
uint32_t SMILCompositor::GetFirstFuncToAffectSandwich() {
// For performance reasons, we throttle most animations on elements in
// display:none subtrees. (We can't throttle animations that target the
// "display" property itself, though -- if we did, display:none elements
// could never be dynamically displayed via animations.)
// To determine whether we're in a display:none subtree, we will check the
// element's primary frame since element in display:none subtree doesn't have
// a primary frame. Before this process, we will construct frame when we
// append an element to subtree. So we will not need to worry about pending
// frame construction in this step.
bool canThrottle = mKey.mAttributeName != nsGkAtoms::display &&
!mKey.mElement->GetPrimaryFrame();
uint32_t i;
for (i = mAnimationFunctions.Length(); i > 0; --i) {
SMILAnimationFunction* curAnimFunc = mAnimationFunctions[i - 1];
// In the following, the lack of short-circuit behavior of |= means that we
// will ALWAYS run UpdateCachedTarget (even if mForceCompositing is true)
// but only call HasChanged and WasSkippedInPrevSample if necessary. This
// is important since we need UpdateCachedTarget to run in order to detect
// changes to the target in subsequent samples.
mForceCompositing |= curAnimFunc->UpdateCachedTarget(mKey) ||
(curAnimFunc->HasChanged() && !canThrottle) ||
curAnimFunc->WasSkippedInPrevSample();
if (curAnimFunc->WillReplace()) {
--i;
break;
}
}
// Mark remaining animation functions as having been skipped so if we later
// use them we'll know to force compositing.
// Note that we only really need to do this if something has changed
// (otherwise we would have set the flag on a previous sample) and if
// something has changed mForceCompositing will be true.
if (mForceCompositing) {
for (uint32_t j = i; j > 0; --j) {
mAnimationFunctions[j - 1]->SetWasSkipped();
}
}
return i;
}
void SMILCompositor::UpdateCachedBaseValue(const SMILValue& aBaseValue) {
if (mCachedBaseValue != aBaseValue) {
// Base value has changed since last sample.
mCachedBaseValue = aBaseValue;
mForceCompositing = true;
}
}
} // namespace mozilla
|
