68be2c1c712963bf9a846ae4c313d34645c5d007
[WebKit-https.git] / Source / WebCore / animation / KeyframeEffectReadOnly.cpp
1 /*
2  * Copyright (C) 2017 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "config.h"
27 #include "KeyframeEffectReadOnly.h"
28
29 #include "Animation.h"
30 #include "AnimationEffectTimingReadOnly.h"
31 #include "CSSComputedStyleDeclaration.h"
32 #include "CSSPropertyAnimation.h"
33 #include "CSSPropertyNames.h"
34 #include "CSSStyleDeclaration.h"
35 #include "CSSTimingFunctionValue.h"
36 #include "Element.h"
37 #include "FontCascade.h"
38 #include "JSCompositeOperation.h"
39 #include "JSKeyframeEffectReadOnly.h"
40 #include "RenderBoxModelObject.h"
41 #include "RenderElement.h"
42 #include "RenderStyle.h"
43 #include "StyleResolver.h"
44 #include "TimingFunction.h"
45 #include "WillChangeData.h"
46 #include <wtf/UUID.h>
47
48 namespace WebCore {
49 using namespace JSC;
50
51 static inline void invalidateElement(Element* element)
52 {
53     if (!element)
54         return;
55
56     element->invalidateStyleAndLayerComposition();
57     element->document().updateStyleIfNeeded();
58 }
59
60 static inline String CSSPropertyIDToIDLAttributeName(CSSPropertyID cssPropertyId)
61 {
62     // https://drafts.csswg.org/web-animations-1/#animation-property-name-to-idl-attribute-name
63     // 1. If property follows the <custom-property-name> production, return property.
64     // FIXME: We don't handle custom properties yet.
65
66     // 2. If property refers to the CSS float property, return the string "cssFloat".
67     if (cssPropertyId == CSSPropertyFloat)
68         return "cssFloat";
69
70     // 3. If property refers to the CSS offset property, return the string "cssOffset".
71     // FIXME: we don't support the CSS "offset" property
72
73     // 4. Otherwise, return the result of applying the CSS property to IDL attribute algorithm [CSSOM] to property.
74     return getJSPropertyName(cssPropertyId);
75 }
76
77 static inline CSSPropertyID IDLAttributeNameToAnimationPropertyName(const String& idlAttributeName)
78 {
79     // https://drafts.csswg.org/web-animations-1/#idl-attribute-name-to-animation-property-name
80     // 1. If attribute conforms to the <custom-property-name> production, return attribute.
81     // FIXME: We don't handle custom properties yet.
82
83     // 2. If attribute is the string "cssFloat", then return an animation property representing the CSS float property.
84     if (idlAttributeName == "cssFloat")
85         return CSSPropertyFloat;
86
87     // 3. If attribute is the string "cssOffset", then return an animation property representing the CSS offset property.
88     // FIXME: We don't support the CSS "offset" property.
89
90     // 4. Otherwise, return the result of applying the IDL attribute to CSS property algorithm [CSSOM] to attribute.
91     auto cssPropertyId = CSSStyleDeclaration::getCSSPropertyIDFromJavaScriptPropertyName(idlAttributeName);
92
93     // We need to check that converting the property back to IDL form yields the same result such that a property passed
94     // in non-IDL form is rejected, for instance "font-size".
95     if (idlAttributeName != CSSPropertyIDToIDLAttributeName(cssPropertyId))
96         return CSSPropertyInvalid;
97
98     return cssPropertyId;
99 }
100
101 static inline void computeMissingKeyframeOffsets(Vector<KeyframeEffectReadOnly::ParsedKeyframe>& keyframes)
102 {
103     // https://drafts.csswg.org/web-animations-1/#compute-missing-keyframe-offsets
104
105     if (keyframes.isEmpty())
106         return;
107
108     // 1. For each keyframe, in keyframes, let the computed keyframe offset of the keyframe be equal to its keyframe offset value.
109     // In our implementation, we only set non-null values to avoid making computedOffset std::optional<double>. Instead, we'll know
110     // that a keyframe hasn't had a computed offset by checking if it has a null offset and a 0 computedOffset, since the first
111     // keyframe will already have a 0 computedOffset.
112     for (auto& keyframe : keyframes)
113         keyframe.computedOffset = keyframe.offset.value_or(0);
114
115     // 2. If keyframes contains more than one keyframe and the computed keyframe offset of the first keyframe in keyframes is null,
116     //    set the computed keyframe offset of the first keyframe to 0.
117     if (keyframes.size() > 1 && !keyframes[0].offset)
118         keyframes[0].computedOffset = 0;
119
120     // 3. If the computed keyframe offset of the last keyframe in keyframes is null, set its computed keyframe offset to 1.
121     if (!keyframes.last().offset)
122         keyframes.last().computedOffset = 1;
123
124     // 4. For each pair of keyframes A and B where:
125     //    - A appears before B in keyframes, and
126     //    - A and B have a computed keyframe offset that is not null, and
127     //    - all keyframes between A and B have a null computed keyframe offset,
128     //    calculate the computed keyframe offset of each keyframe between A and B as follows:
129     //    1. Let offsetk be the computed keyframe offset of a keyframe k.
130     //    2. Let n be the number of keyframes between and including A and B minus 1.
131     //    3. Let index refer to the position of keyframe in the sequence of keyframes between A and B such that the first keyframe after A has an index of 1.
132     //    4. Set the computed keyframe offset of keyframe to offsetA + (offsetB − offsetA) × index / n.
133     size_t indexOfLastKeyframeWithNonNullOffset = 0;
134     for (size_t i = 1; i < keyframes.size(); ++i) {
135         auto& keyframe = keyframes[i];
136         if (!keyframe.computedOffset)
137             continue;
138         if (indexOfLastKeyframeWithNonNullOffset == i - 1)
139             continue;
140
141         double lastNonNullOffset = keyframes[indexOfLastKeyframeWithNonNullOffset].computedOffset;
142         double offsetDelta = keyframe.computedOffset - lastNonNullOffset;
143         double offsetIncrement = offsetDelta / (i - indexOfLastKeyframeWithNonNullOffset);
144         size_t indexOfFirstKeyframeWithNullOffset = indexOfLastKeyframeWithNonNullOffset + 1;
145         for (size_t j = indexOfFirstKeyframeWithNullOffset; j < i; ++j)
146             keyframes[j].computedOffset = lastNonNullOffset + (j - indexOfLastKeyframeWithNonNullOffset) * offsetIncrement;
147
148         indexOfLastKeyframeWithNonNullOffset = i;
149     }
150 }
151
152 static inline ExceptionOr<void> processIterableKeyframes(ExecState& state, Strong<JSObject>&& keyframesInput, JSValue method, Vector<KeyframeEffectReadOnly::ParsedKeyframe>& parsedKeyframes)
153 {
154     VM& vm = state.vm();
155     auto scope = DECLARE_THROW_SCOPE(vm);
156
157     // 1. Let iter be GetIterator(object, method).
158     forEachInIterable(state, keyframesInput.get(), method, [&parsedKeyframes](VM& vm, ExecState& state, JSValue nextValue) -> ExceptionOr<void> {
159         if (!nextValue || !nextValue.isObject())
160             return Exception { TypeError };
161
162         auto scope = DECLARE_THROW_SCOPE(vm);
163
164         JSObject* keyframe = nextValue.toObject(&state);
165         PropertyNameArray ownPropertyNames(&vm, PropertyNameMode::Strings, PrivateSymbolMode::Exclude);
166         JSObject::getOwnPropertyNames(keyframe, &state, ownPropertyNames, EnumerationMode());
167         size_t numberOfProperties = ownPropertyNames.size();
168
169         KeyframeEffectReadOnly::ParsedKeyframe keyframeOutput;
170
171         String easing("linear");
172         std::optional<double> offset;
173         std::optional<CompositeOperation> composite;
174
175         for (size_t j = 0; j < numberOfProperties; ++j) {
176             auto ownPropertyName = ownPropertyNames[j];
177             if (ownPropertyName == "easing")
178                 easing = convert<IDLDOMString>(state, keyframe->get(&state, ownPropertyName));
179             else if (ownPropertyName == "offset")
180                 offset = convert<IDLNullable<IDLDouble>>(state, keyframe->get(&state, ownPropertyName));
181             else if (ownPropertyName == "composite")
182                 composite = convert<IDLNullable<IDLEnumeration<CompositeOperation>>>(state, keyframe->get(&state, ownPropertyName));
183             else {
184                 auto cssPropertyId = IDLAttributeNameToAnimationPropertyName(ownPropertyName.string());
185                 if (CSSPropertyAnimation::isPropertyAnimatable(cssPropertyId)) {
186                     auto stringValue = convert<IDLDOMString>(state, keyframe->get(&state, ownPropertyName));
187                     if (keyframeOutput.style->setProperty(cssPropertyId, stringValue))
188                         keyframeOutput.unparsedStyle.set(cssPropertyId, stringValue);
189                 }
190             }
191             RETURN_IF_EXCEPTION(scope, Exception { TypeError });
192         }
193
194         keyframeOutput.easing = easing;
195         keyframeOutput.offset = offset;
196         keyframeOutput.composite = composite;
197
198         parsedKeyframes.append(WTFMove(keyframeOutput));
199
200         return { };
201     });
202     RETURN_IF_EXCEPTION(scope, Exception { TypeError });
203
204     return { };
205 }
206
207 static inline ExceptionOr<KeyframeEffectReadOnly::KeyframeLikeObject> processKeyframeLikeObject(ExecState& state, Strong<JSObject>&& keyframesInput)
208 {
209     // https://drafts.csswg.org/web-animations-1/#process-a-keyframe-like-object
210
211     VM& vm = state.vm();
212     auto scope = DECLARE_THROW_SCOPE(vm);
213
214     // 1. Run the procedure to convert an ECMAScript value to a dictionary type [WEBIDL] with keyframe input as the ECMAScript value as follows:
215     // 
216     //    dictionary BasePropertyIndexedKeyframe {
217     //        (double? or sequence<double?>)                       offset = [];
218     //        (DOMString or sequence<DOMString>)                   easing = [];
219     //        (CompositeOperation? or sequence<CompositeOperation?>) composite = [];
220     //    };
221     //
222     //    Store the result of this procedure as keyframe output.
223     auto baseProperties = convert<IDLDictionary<KeyframeEffectReadOnly::BasePropertyIndexedKeyframe>>(state, keyframesInput.get());
224     RETURN_IF_EXCEPTION(scope, Exception { TypeError });
225
226     KeyframeEffectReadOnly::KeyframeLikeObject keyframeOuput;
227     keyframeOuput.baseProperties = baseProperties;
228
229     // 2. Build up a list of animatable properties as follows:
230     //
231     //    1. Let animatable properties be a list of property names (including shorthand properties that have longhand sub-properties
232     //       that are animatable) that can be animated by the implementation.
233     //    2. Convert each property name in animatable properties to the equivalent IDL attribute by applying the animation property
234     //       name to IDL attribute name algorithm.
235
236     // 3. Let input properties be the result of calling the EnumerableOwnNames operation with keyframe input as the object.
237     PropertyNameArray inputProperties(&vm, PropertyNameMode::Strings, PrivateSymbolMode::Exclude);
238     JSObject::getOwnPropertyNames(keyframesInput.get(), &state, inputProperties, EnumerationMode());
239
240     // 4. Make up a new list animation properties that consists of all of the properties that are in both input properties and animatable
241     //    properties, or which are in input properties and conform to the <custom-property-name> production.
242
243     // 5. Sort animation properties in ascending order by the Unicode codepoints that define each property name.
244     //    We only actually perform this after step 6.
245
246     // 6. For each property name in animation properties,
247     size_t numberOfProperties = inputProperties.size();
248     for (size_t i = 0; i < numberOfProperties; ++i) {
249         auto cssPropertyID = IDLAttributeNameToAnimationPropertyName(inputProperties[i].string());
250         if (!CSSPropertyAnimation::isPropertyAnimatable(cssPropertyID))
251             continue;
252
253         // 1. Let raw value be the result of calling the [[Get]] internal method on keyframe input, with property name as the property
254         //    key and keyframe input as the receiver.
255         auto rawValue = keyframesInput->get(&state, inputProperties[i]);
256
257         // 2. Check the completion record of raw value.
258         RETURN_IF_EXCEPTION(scope, Exception { TypeError });
259
260         // 3. Convert raw value to a DOMString or sequence of DOMStrings property values as follows:
261         Vector<String> propertyValues;
262         // Let property values be the result of converting raw value to IDL type (DOMString or sequence<DOMString>)
263         // using the procedures defined for converting an ECMAScript value to an IDL value [WEBIDL].
264         // If property values is a single DOMString, replace property values with a sequence of DOMStrings with the original value of property
265         // Values as the only element.
266         if (rawValue.isString())
267             propertyValues = { rawValue.toWTFString(&state) };
268         else
269             propertyValues = convert<IDLSequence<IDLDOMString>>(state, rawValue);
270         RETURN_IF_EXCEPTION(scope, Exception { TypeError });
271
272         // 4. Calculate the normalized property name as the result of applying the IDL attribute name to animation property name algorithm to property name.
273         // 5. Add a property to to keyframe output with normalized property name as the property name, and property values as the property value.
274         keyframeOuput.propertiesAndValues.append({ cssPropertyID, propertyValues });
275     }
276
277     // Now we can perform step 5.
278     std::sort(keyframeOuput.propertiesAndValues.begin(), keyframeOuput.propertiesAndValues.end(), [](auto& lhs, auto& rhs) {
279         return getPropertyNameString(lhs.property).utf8() < getPropertyNameString(rhs.property).utf8();
280     });
281
282     // 7. Return keyframe output.
283     return { WTFMove(keyframeOuput) };
284 }
285
286 static inline ExceptionOr<void> processPropertyIndexedKeyframes(ExecState& state, Strong<JSObject>&& keyframesInput, Vector<KeyframeEffectReadOnly::ParsedKeyframe>& parsedKeyframes, Vector<String>& unusedEasings)
287 {
288     // 1. Let property-indexed keyframe be the result of running the procedure to process a keyframe-like object passing object as the keyframe input.
289     auto processKeyframeLikeObjectResult = processKeyframeLikeObject(state, WTFMove(keyframesInput));
290     if (processKeyframeLikeObjectResult.hasException())
291         return processKeyframeLikeObjectResult.releaseException();
292     auto propertyIndexedKeyframe = processKeyframeLikeObjectResult.returnValue();
293
294     // 2. For each member, m, in property-indexed keyframe, perform the following steps:
295     for (auto& m : propertyIndexedKeyframe.propertiesAndValues) {
296         // 1. Let property name be the key for m.
297         auto propertyName = m.property;
298         // 2. If property name is “composite”, or “easing”, or “offset”, skip the remaining steps in this loop and continue from the next member in property-indexed
299         //    keyframe after m.
300         //    We skip this test since we split those properties and the actual CSS properties that we're currently iterating over.
301         // 3. Let property values be the value for m.
302         auto propertyValues = m.values;
303         // 4. Let property keyframes be an empty sequence of keyframes.
304         Vector<KeyframeEffectReadOnly::ParsedKeyframe> propertyKeyframes;
305         // 5. For each value, v, in property values perform the following steps:
306         for (auto& v : propertyValues) {
307             // 1. Let k be a new keyframe with a null keyframe offset.
308             KeyframeEffectReadOnly::ParsedKeyframe k;
309             // 2. Add the property-value pair, property name → v, to k.
310             if (k.style->setProperty(propertyName, v))
311                 k.unparsedStyle.set(propertyName, v);
312             // 3. Append k to property keyframes.
313             propertyKeyframes.append(WTFMove(k));
314         }
315         // 6. Apply the procedure to compute missing keyframe offsets to property keyframes.
316         computeMissingKeyframeOffsets(propertyKeyframes);
317
318         // 7. Add keyframes in property keyframes to processed keyframes.
319         for (auto& keyframe : propertyKeyframes)
320             parsedKeyframes.append(WTFMove(keyframe));
321     }
322
323     // 3. Sort processed keyframes by the computed keyframe offset of each keyframe in increasing order.
324     std::sort(parsedKeyframes.begin(), parsedKeyframes.end(), [](auto& lhs, auto& rhs) {
325         return lhs.computedOffset < rhs.computedOffset;
326     });
327
328     // 4. Merge adjacent keyframes in processed keyframes when they have equal computed keyframe offsets.
329     size_t i = 1;
330     while (i < parsedKeyframes.size()) {
331         auto& keyframe = parsedKeyframes[i];
332         auto& previousKeyframe = parsedKeyframes[i - 1];
333         // If the offsets of this keyframe and the previous keyframe are different,
334         // this means that the two keyframes should not be merged and we can move
335         // on to the next keyframe.
336         if (keyframe.computedOffset != previousKeyframe.computedOffset) {
337             i++;
338             continue;
339         }
340         // Otherwise, both this keyframe and the previous keyframe should be merged.
341         // Unprocessed keyframes in parsedKeyframes at this stage have at most a single
342         // property in cssPropertiesAndValues, so just set this on the previous keyframe.
343         // In case an invalid or null value was originally provided, then the property
344         // was not set and the property count is 0, in which case there is nothing to merge.
345         if (keyframe.style->propertyCount()) {
346             auto property = keyframe.style->propertyAt(0);
347             previousKeyframe.style->setProperty(property.id(), property.value());
348             previousKeyframe.unparsedStyle.set(property.id(), keyframe.unparsedStyle.get(property.id()));
349         }
350         // Since we've processed this keyframe, we can remove it and keep i the same
351         // so that we process the next keyframe in the next loop iteration.
352         parsedKeyframes.remove(i);
353     }
354
355     // 5. Let offsets be a sequence of nullable double values assigned based on the type of the “offset” member of the property-indexed keyframe as follows:
356     //    - sequence<double?>, the value of “offset” as-is.
357     //    - double?, a sequence of length one with the value of “offset” as its single item, i.e. « offset »,
358     Vector<std::optional<double>> offsets;
359     if (WTF::holds_alternative<Vector<std::optional<double>>>(propertyIndexedKeyframe.baseProperties.offset))
360         offsets = WTF::get<Vector<std::optional<double>>>(propertyIndexedKeyframe.baseProperties.offset);
361     else if (WTF::holds_alternative<double>(propertyIndexedKeyframe.baseProperties.offset))
362         offsets.append(WTF::get<double>(propertyIndexedKeyframe.baseProperties.offset));
363     else if (WTF::holds_alternative<std::nullptr_t>(propertyIndexedKeyframe.baseProperties.offset))
364         offsets.append(std::nullopt);
365
366     // 6. Assign each value in offsets to the keyframe offset of the keyframe with corresponding position in property keyframes until the end of either sequence is reached.
367     for (size_t i = 0; i < offsets.size() && i < parsedKeyframes.size(); ++i)
368         parsedKeyframes[i].offset = offsets[i];
369
370     // 7. Let easings be a sequence of DOMString values assigned based on the type of the “easing” member of the property-indexed keyframe as follows:
371     //    - sequence<DOMString>, the value of “easing” as-is.
372     //    - DOMString, a sequence of length one with the value of “easing” as its single item, i.e. « easing »,
373     Vector<String> easings;
374     if (WTF::holds_alternative<Vector<String>>(propertyIndexedKeyframe.baseProperties.easing))
375         easings = WTF::get<Vector<String>>(propertyIndexedKeyframe.baseProperties.easing);
376     else if (WTF::holds_alternative<String>(propertyIndexedKeyframe.baseProperties.easing))
377         easings.append(WTF::get<String>(propertyIndexedKeyframe.baseProperties.easing));
378
379     // 8. If easings is an empty sequence, let it be a sequence of length one containing the single value “linear”, i.e. « "linear" ».
380     if (easings.isEmpty())
381         easings.append("linear");
382
383     // 9. If easings has fewer items than property keyframes, repeat the elements in easings successively starting from the beginning of the list until easings has as many
384     //    items as property keyframes.
385     if (easings.size() < parsedKeyframes.size()) {
386         size_t initialNumberOfEasings = easings.size();
387         for (i = initialNumberOfEasings + 1; i <= parsedKeyframes.size(); ++i)
388             easings.append(easings[i % initialNumberOfEasings]);
389     }
390
391     // 10. If easings has more items than property keyframes, store the excess items as unused easings.
392     while (easings.size() > parsedKeyframes.size())
393         unusedEasings.append(easings.takeLast());
394
395     // 11. Assign each value in easings to a property named “easing” on the keyframe with the corresponding position in property keyframes until the end of property keyframes
396     //     is reached.
397     for (size_t i = 0; i < parsedKeyframes.size(); ++i)
398         parsedKeyframes[i].easing = easings[i];
399
400     // 12. If the “composite” member of the property-indexed keyframe is not an empty sequence:
401     Vector<std::optional<CompositeOperation>> compositeModes;
402     if (WTF::holds_alternative<Vector<std::optional<CompositeOperation>>>(propertyIndexedKeyframe.baseProperties.composite))
403         compositeModes = WTF::get<Vector<std::optional<CompositeOperation>>>(propertyIndexedKeyframe.baseProperties.composite);
404     else if (WTF::holds_alternative<CompositeOperation>(propertyIndexedKeyframe.baseProperties.composite))
405         compositeModes.append(WTF::get<CompositeOperation>(propertyIndexedKeyframe.baseProperties.composite));
406     else if (WTF::holds_alternative<std::nullptr_t>(propertyIndexedKeyframe.baseProperties.composite))
407         compositeModes.append(std::nullopt);
408     if (!compositeModes.isEmpty()) {
409         // 1. Let composite modes be a sequence of composite operations assigned from the “composite” member of property-indexed keyframe. If that member is a single composite
410         //    operation, let composite modes be a sequence of length one, with the value of the “composite” as its single item.
411         // 2. As with easings, if composite modes has fewer items than property keyframes, repeat the elements in composite modes successively starting from the beginning of
412         //    the list until composite modes has as many items as property keyframes.
413         if (compositeModes.size() < parsedKeyframes.size()) {
414             size_t initialNumberOfCompositeModes = compositeModes.size();
415             for (i = initialNumberOfCompositeModes + 1; i <= parsedKeyframes.size(); ++i)
416                 compositeModes.append(compositeModes[i % initialNumberOfCompositeModes]);
417         }
418         // 3. Assign each value in composite modes to the keyframe-specific composite operation on the keyframe with the corresponding position in property keyframes until
419         //    the end of property keyframes is reached.
420         for (size_t i = 0; i < compositeModes.size() && i < parsedKeyframes.size(); ++i)
421             parsedKeyframes[i].composite = compositeModes[i];
422     }
423
424     return { };
425 }
426
427 ExceptionOr<Ref<KeyframeEffectReadOnly>> KeyframeEffectReadOnly::create(ExecState& state, Element* target, Strong<JSObject>&& keyframes, std::optional<Variant<double, KeyframeEffectOptions>>&& options)
428 {
429     auto keyframeEffect = adoptRef(*new KeyframeEffectReadOnly(KeyframeEffectReadOnlyClass, AnimationEffectTimingReadOnly::create(), target));
430
431     auto setPropertiesResult = keyframeEffect->timing()->setProperties(WTFMove(options));
432     if (setPropertiesResult.hasException())
433         return setPropertiesResult.releaseException();
434
435     auto processKeyframesResult = keyframeEffect->processKeyframes(state, WTFMove(keyframes));
436     if (processKeyframesResult.hasException())
437         return processKeyframesResult.releaseException();
438
439     return WTFMove(keyframeEffect);
440 }
441
442 ExceptionOr<Ref<KeyframeEffectReadOnly>> KeyframeEffectReadOnly::create(JSC::ExecState&, Ref<KeyframeEffectReadOnly>&& source)
443 {
444     auto keyframeEffect = adoptRef(*new KeyframeEffectReadOnly(KeyframeEffectReadOnlyClass, AnimationEffectTimingReadOnly::create(), nullptr));
445     keyframeEffect->copyPropertiesFromSource(WTFMove(source));
446     return WTFMove(keyframeEffect);
447 }
448
449 KeyframeEffectReadOnly::KeyframeEffectReadOnly(ClassType classType, Ref<AnimationEffectTimingReadOnly>&& timing, Element* target)
450     : AnimationEffectReadOnly(classType, WTFMove(timing))
451     , m_target(target)
452     , m_blendingKeyframes(emptyString())
453 {
454 }
455
456 void KeyframeEffectReadOnly::copyPropertiesFromSource(Ref<KeyframeEffectReadOnly>&& source)
457 {
458     m_target = source->m_target;
459     m_compositeOperation = source->m_compositeOperation;
460     m_iterationCompositeOperation = source->m_iterationCompositeOperation;
461
462     Vector<ParsedKeyframe> parsedKeyframes;
463     for (auto& sourceParsedKeyframe : source->m_parsedKeyframes) {
464         ParsedKeyframe parsedKeyframe;
465         parsedKeyframe.easing = sourceParsedKeyframe.easing;
466         parsedKeyframe.offset = sourceParsedKeyframe.offset;
467         parsedKeyframe.composite = sourceParsedKeyframe.composite;
468         parsedKeyframe.unparsedStyle = sourceParsedKeyframe.unparsedStyle;
469         parsedKeyframe.computedOffset = sourceParsedKeyframe.computedOffset;
470         parsedKeyframe.timingFunction = sourceParsedKeyframe.timingFunction;
471         parsedKeyframe.style = sourceParsedKeyframe.style->mutableCopy();
472         parsedKeyframes.append(WTFMove(parsedKeyframe));
473     }
474     m_parsedKeyframes = WTFMove(parsedKeyframes);
475
476     timing()->copyPropertiesFromSource(source->timing());
477
478     KeyframeList keyframeList("keyframe-effect-" + createCanonicalUUIDString());
479     for (auto& keyframe : source->m_blendingKeyframes.keyframes()) {
480         KeyframeValue keyframeValue(keyframe.key(), RenderStyle::clonePtr(*keyframe.style()));
481         for (auto propertyId : keyframe.properties())
482             keyframeValue.addProperty(propertyId);
483         keyframeList.insert(WTFMove(keyframeValue));
484     }
485     m_blendingKeyframes = WTFMove(keyframeList);
486 }
487
488 Vector<Strong<JSObject>> KeyframeEffectReadOnly::getKeyframes(ExecState& state)
489 {
490     // https://drafts.csswg.org/web-animations-1/#dom-keyframeeffectreadonly-getkeyframes
491
492     auto lock = JSLockHolder { &state };
493
494     // Since keyframes are represented by a partially open-ended dictionary type that is not currently able to be expressed with WebIDL,
495     // the procedure used to prepare the result of this method is defined in prose below:
496     //
497     // 1. Let result be an empty sequence of objects.
498     Vector<Strong<JSObject>> result;
499
500     // 2. Let keyframes be the result of applying the procedure to compute missing keyframe offsets to the keyframes for this keyframe effect.
501
502     // 3. For each keyframe in keyframes perform the following steps:
503     for (auto& parsedKeyframe : m_parsedKeyframes) {
504         // 1. Initialize a dictionary object, output keyframe, using the following definition:
505         //
506         // dictionary BaseComputedKeyframe {
507         //      double?             offset = null;
508         //      double              computedOffset;
509         //      DOMString           easing = "linear";
510         //      CompositeOperation? composite = null;
511         // };
512
513         // 2. Set offset, computedOffset, easing, composite members of output keyframe to the respective values keyframe offset, computed keyframe
514         // offset, keyframe-specific timing function and keyframe-specific composite operation of keyframe.
515         BaseComputedKeyframe computedKeyframe;
516         computedKeyframe.offset = parsedKeyframe.offset;
517         computedKeyframe.computedOffset = parsedKeyframe.computedOffset;
518         computedKeyframe.easing = parsedKeyframe.timingFunction->cssText();
519         computedKeyframe.composite = parsedKeyframe.composite;
520
521         auto outputKeyframe = convertDictionaryToJS(state, *jsCast<JSDOMGlobalObject*>(state.lexicalGlobalObject()), computedKeyframe);
522
523         // 3. For each animation property-value pair specified on keyframe, declaration, perform the following steps:
524         for (auto it = parsedKeyframe.unparsedStyle.begin(), end = parsedKeyframe.unparsedStyle.end(); it != end; ++it) {
525             // 1. Let property name be the result of applying the animation property name to IDL attribute name algorithm to the property name of declaration.
526             auto propertyName = CSSPropertyIDToIDLAttributeName(it->key);
527             // 2. Let IDL value be the result of serializing the property value of declaration by passing declaration to the algorithm to serialize a CSS value.
528             // 3. Let value be the result of converting IDL value to an ECMAScript String value.
529             auto value = toJS<IDLDOMString>(state, it->value);
530             // 4. Call the [[DefineOwnProperty]] internal method on output keyframe with property name property name,
531             //    Property Descriptor { [[Writable]]: true, [[Enumerable]]: true, [[Configurable]]: true, [[Value]]: value } and Boolean flag false.
532             JSObject::defineOwnProperty(outputKeyframe, &state, AtomicString(propertyName).impl(), PropertyDescriptor(value, 0), false);
533         }
534
535         // 4. Append output keyframe to result.
536         result.append(JSC::Strong<JSC::JSObject> { state.vm(), outputKeyframe });
537     }
538
539     // 4. Return result.
540     return result;
541 }
542
543 ExceptionOr<void> KeyframeEffectReadOnly::processKeyframes(ExecState& state, Strong<JSObject>&& keyframesInput)
544 {
545     // 1. If object is null, return an empty sequence of keyframes.
546     if (!keyframesInput.get())
547         return { };
548
549     VM& vm = state.vm();
550     auto scope = DECLARE_THROW_SCOPE(vm);
551
552     // 2. Let processed keyframes be an empty sequence of keyframes.
553     Vector<ParsedKeyframe> parsedKeyframes;
554
555     // 3. Let method be the result of GetMethod(object, @@iterator).
556     auto method = keyframesInput.get()->get(&state, vm.propertyNames->iteratorSymbol);
557
558     // 4. Check the completion record of method.
559     RETURN_IF_EXCEPTION(scope, Exception { TypeError });
560
561     // 5. Perform the steps corresponding to the first matching condition from below,
562     Vector<String> unusedEasings;
563     if (!method.isUndefined())
564         processIterableKeyframes(state, WTFMove(keyframesInput), WTFMove(method), parsedKeyframes);
565     else
566         processPropertyIndexedKeyframes(state, WTFMove(keyframesInput), parsedKeyframes, unusedEasings);
567
568     // 6. If processed keyframes is not loosely sorted by offset, throw a TypeError and abort these steps.
569     // 7. If there exist any keyframe in processed keyframes whose keyframe offset is non-null and less than
570     //    zero or greater than one, throw a TypeError and abort these steps.
571     double lastNonNullOffset = -1;
572     for (auto& keyframe : parsedKeyframes) {
573         if (!keyframe.offset)
574             continue;
575         auto offset = keyframe.offset.value();
576         if (offset <= lastNonNullOffset || offset < 0 || offset > 1)
577             return Exception { TypeError };
578         lastNonNullOffset = offset;
579     }
580
581     // We take a slight detour from the spec text and compute the missing keyframe offsets right away
582     // since they can be computed up-front.
583     computeMissingKeyframeOffsets(parsedKeyframes);
584
585     // 8. For each frame in processed keyframes, perform the following steps:
586     for (auto& keyframe : parsedKeyframes) {
587         // Let the timing function of frame be the result of parsing the “easing” property on frame using the CSS syntax
588         // defined for the easing property of the AnimationEffectTimingReadOnly interface.
589         // If parsing the “easing” property fails, throw a TypeError and abort this procedure.
590         auto timingFunctionResult = TimingFunction::createFromCSSText(keyframe.easing);
591         if (timingFunctionResult.hasException())
592             return timingFunctionResult.releaseException();
593         keyframe.timingFunction = timingFunctionResult.returnValue();
594     }
595
596     // 9. Parse each of the values in unused easings using the CSS syntax defined for easing property of the
597     //    AnimationEffectTimingReadOnly interface, and if any of the values fail to parse, throw a TypeError
598     //    and abort this procedure.
599     for (auto& easing : unusedEasings) {
600         auto timingFunctionResult = TimingFunction::createFromCSSText(easing);
601         if (timingFunctionResult.hasException())
602             return timingFunctionResult.releaseException();
603     }
604
605     m_parsedKeyframes = WTFMove(parsedKeyframes);
606
607     updateBlendingKeyframes();
608
609     return { };
610 }
611
612 void KeyframeEffectReadOnly::updateBlendingKeyframes()
613 {
614     if (!m_target)
615         return;
616
617     KeyframeList keyframeList("keyframe-effect-" + createCanonicalUUIDString());
618     StyleResolver& styleResolver = m_target->styleResolver();
619
620     for (auto& keyframe : m_parsedKeyframes) {
621         KeyframeValue keyframeValue(keyframe.computedOffset, nullptr);
622         auto renderStyle = RenderStyle::createPtr();
623         // We need to call update() on the FontCascade or we'll hit an ASSERT when parsing font-related properties.
624         renderStyle->fontCascade().update(nullptr);
625
626         auto& styleProperties = keyframe.style;
627         for (unsigned i = 0; i < styleProperties->propertyCount(); ++i) {
628             auto cssPropertyId = styleProperties->propertyAt(i).id();
629             keyframeValue.addProperty(cssPropertyId);
630             keyframeList.addProperty(cssPropertyId);
631             styleResolver.applyPropertyToStyle(cssPropertyId, styleProperties->propertyAt(i).value(), WTFMove(renderStyle));
632             renderStyle = styleResolver.state().takeStyle();
633         }
634
635         keyframeValue.setStyle(RenderStyle::clonePtr(*renderStyle));
636         keyframeList.insert(WTFMove(keyframeValue));
637     }
638
639     m_blendingKeyframes = WTFMove(keyframeList);
640
641     computeStackingContextImpact();
642 }
643
644 void KeyframeEffectReadOnly::computeStackingContextImpact()
645 {
646     m_triggersStackingContext = false;
647     for (auto cssPropertyId : m_blendingKeyframes.properties()) {
648         if (WillChangeData::propertyCreatesStackingContext(cssPropertyId)) {
649             m_triggersStackingContext = true;
650             break;
651         }
652     }
653 }
654
655 void KeyframeEffectReadOnly::setTarget(RefPtr<Element>&& newTarget)
656 {
657     if (m_target == newTarget)
658         return;
659
660     auto previousTarget = std::exchange(m_target, WTFMove(newTarget));
661
662     if (auto* effectAnimation = animation())
663         effectAnimation->effectTargetDidChange(previousTarget.get(), m_target.get());
664
665     updateBlendingKeyframes();
666
667     // We need to invalidate the effect now that the target has changed
668     // to ensure the effect's styles are applied to the new target right away.
669     invalidate();
670
671     // Likewise, we need to invalidate styles on the previous target so that
672     // any animated styles are removed immediately.
673     invalidateElement(previousTarget.get());
674 }
675
676 void KeyframeEffectReadOnly::apply(RenderStyle& targetStyle)
677 {
678     if (!m_target)
679         return;
680
681     auto progress = iterationProgress();
682     if (!progress)
683         return;
684
685     if (m_startedAccelerated && progress.value() >= 1) {
686         m_startedAccelerated = false;
687         animation()->acceleratedRunningStateDidChange();
688     }
689
690     bool needsToStartAccelerated = false;
691
692     if (!m_started && !m_startedAccelerated) {
693         needsToStartAccelerated = shouldRunAccelerated();
694         m_startedAccelerated = needsToStartAccelerated;
695         if (needsToStartAccelerated)
696             animation()->acceleratedRunningStateDidChange();
697     }
698     m_started = true;
699
700     if (!needsToStartAccelerated && !m_startedAccelerated)
701         setAnimatedPropertiesInStyle(targetStyle, progress.value());
702
703     // https://w3c.github.io/web-animations/#side-effects-section
704     // For every property targeted by at least one animation effect that is current or in effect, the user agent
705     // must act as if the will-change property ([css-will-change-1]) on the target element includes the property.
706     if (m_triggersStackingContext && targetStyle.hasAutoZIndex())
707         targetStyle.setZIndex(0);
708 }
709
710 void KeyframeEffectReadOnly::invalidate()
711 {
712     invalidateElement(m_target.get());
713 }
714
715 bool KeyframeEffectReadOnly::shouldRunAccelerated()
716 {
717     for (auto cssPropertyId : m_blendingKeyframes.properties()) {
718         if (!CSSPropertyAnimation::animationOfPropertyIsAccelerated(cssPropertyId))
719             return false;
720     }
721     return true;
722 }
723
724 void KeyframeEffectReadOnly::getAnimatedStyle(std::unique_ptr<RenderStyle>& animatedStyle)
725 {
726     if (!animation())
727         return;
728
729     if (!m_blendingKeyframes.size())
730         return;
731
732     auto progress = iterationProgress();
733     if (!progress)
734         return;
735
736     if (!animatedStyle)
737         animatedStyle = RenderStyle::clonePtr(renderer()->style());
738
739     setAnimatedPropertiesInStyle(*animatedStyle.get(), progress.value());
740 }
741
742 void KeyframeEffectReadOnly::setAnimatedPropertiesInStyle(RenderStyle& targetStyle, double iterationProgress)
743 {
744     // 4.4.3. The effect value of a keyframe effect
745     // https://drafts.csswg.org/web-animations-1/#the-effect-value-of-a-keyframe-animation-effect
746     //
747     // The effect value of a single property referenced by a keyframe effect as one of its target properties,
748     // for a given iteration progress, current iteration and underlying value is calculated as follows.
749
750     for (auto cssPropertyId : m_blendingKeyframes.properties()) {
751         // 1. If iteration progress is unresolved abort this procedure.
752         // 2. Let target property be the longhand property for which the effect value is to be calculated.
753         // 3. If animation type of the target property is not animatable abort this procedure since the effect cannot be applied.
754         // 4. Define the neutral value for composition as a value which, when combined with an underlying value using the add composite operation,
755         //    produces the underlying value.
756
757         // 5. Let property-specific keyframes be the result of getting the set of computed keyframes for this keyframe effect.
758         // 6. Remove any keyframes from property-specific keyframes that do not have a property value for target property.
759         unsigned numberOfKeyframesWithZeroOffset = 0;
760         unsigned numberOfKeyframesWithOneOffset = 0;
761         Vector<std::optional<size_t>> propertySpecificKeyframes;
762         for (size_t i = 0; i < m_blendingKeyframes.size(); ++i) {
763             auto& keyframe = m_blendingKeyframes[i];
764             if (!keyframe.containsProperty(cssPropertyId))
765                 continue;
766             auto offset = keyframe.key();
767             if (!offset)
768                 numberOfKeyframesWithZeroOffset++;
769             if (offset == 1)
770                 numberOfKeyframesWithOneOffset++;
771             propertySpecificKeyframes.append(i);
772         }
773
774         // 7. If property-specific keyframes is empty, return underlying value.
775         if (propertySpecificKeyframes.isEmpty())
776             continue;
777
778         // 8. If there is no keyframe in property-specific keyframes with a computed keyframe offset of 0, create a new keyframe with a computed keyframe
779         //    offset of 0, a property value set to the neutral value for composition, and a composite operation of add, and prepend it to the beginning of
780         //    property-specific keyframes.
781         if (!numberOfKeyframesWithZeroOffset) {
782             propertySpecificKeyframes.insert(0, std::nullopt);
783             numberOfKeyframesWithZeroOffset = 1;
784         }
785
786         // 9. Similarly, if there is no keyframe in property-specific keyframes with a computed keyframe offset of 1, create a new keyframe with a computed
787         //    keyframe offset of 1, a property value set to the neutral value for composition, and a composite operation of add, and append it to the end of
788         //    property-specific keyframes.
789         if (!numberOfKeyframesWithOneOffset) {
790             propertySpecificKeyframes.append(std::nullopt);
791             numberOfKeyframesWithOneOffset = 1;
792         }
793
794         // 10. Let interval endpoints be an empty sequence of keyframes.
795         Vector<std::optional<size_t>> intervalEndpoints;
796
797         // 11. Populate interval endpoints by following the steps from the first matching condition from below:
798         if (iterationProgress < 0 && numberOfKeyframesWithZeroOffset > 1) {
799             // If iteration progress < 0 and there is more than one keyframe in property-specific keyframes with a computed keyframe offset of 0,
800             // Add the first keyframe in property-specific keyframes to interval endpoints.
801             intervalEndpoints.append(propertySpecificKeyframes.first());
802         } else if (iterationProgress >= 1 && numberOfKeyframesWithOneOffset > 1) {
803             // If iteration progress ≥ 1 and there is more than one keyframe in property-specific keyframes with a computed keyframe offset of 1,
804             // Add the last keyframe in property-specific keyframes to interval endpoints.
805             intervalEndpoints.append(propertySpecificKeyframes.last());
806         } else {
807             // Otherwise,
808             // 1. Append to interval endpoints the last keyframe in property-specific keyframes whose computed keyframe offset is less than or equal
809             //    to iteration progress and less than 1. If there is no such keyframe (because, for example, the iteration progress is negative),
810             //    add the last keyframe whose computed keyframe offset is 0.
811             // 2. Append to interval endpoints the next keyframe in property-specific keyframes after the one added in the previous step.
812             size_t indexOfLastKeyframeWithZeroOffset = 0;
813             int indexOfFirstKeyframeToAddToIntervalEndpoints = -1;
814             for (size_t i = 0; i < propertySpecificKeyframes.size(); ++i) {
815                 auto keyframeIndex = propertySpecificKeyframes[i];
816                 auto offset = [&] () -> double {
817                     if (!keyframeIndex)
818                         return i ? 1 : 0;
819                     return m_blendingKeyframes[keyframeIndex.value()].key();
820                 }();
821                 if (!offset)
822                     indexOfLastKeyframeWithZeroOffset = i;
823                 if (offset <= iterationProgress && offset < 1)
824                     indexOfFirstKeyframeToAddToIntervalEndpoints = i;
825                 else
826                     break;
827             }
828
829             if (indexOfFirstKeyframeToAddToIntervalEndpoints >= 0) {
830                 intervalEndpoints.append(propertySpecificKeyframes[indexOfFirstKeyframeToAddToIntervalEndpoints]);
831                 intervalEndpoints.append(propertySpecificKeyframes[indexOfFirstKeyframeToAddToIntervalEndpoints + 1]);
832             } else {
833                 ASSERT(indexOfLastKeyframeWithZeroOffset < propertySpecificKeyframes.size() - 1);
834                 intervalEndpoints.append(propertySpecificKeyframes[indexOfLastKeyframeWithZeroOffset]);
835                 intervalEndpoints.append(propertySpecificKeyframes[indexOfLastKeyframeWithZeroOffset + 1]);
836             }
837         }
838
839         // 12. For each keyframe in interval endpoints…
840         // FIXME: we don't support this step yet since we don't deal with any composite operation other than "replace".
841
842         // 13. If there is only one keyframe in interval endpoints return the property value of target property on that keyframe.
843         if (intervalEndpoints.size() == 1) {
844             auto keyframeIndex = intervalEndpoints[0];
845             auto keyframeStyle = !keyframeIndex ? &targetStyle : m_blendingKeyframes[keyframeIndex.value()].style();
846             CSSPropertyAnimation::blendProperties(this, cssPropertyId, &targetStyle, keyframeStyle, keyframeStyle, 0);
847             continue;
848         }
849
850         // 14. Let start offset be the computed keyframe offset of the first keyframe in interval endpoints.
851         auto startKeyframeIndex = intervalEndpoints.first();
852         auto startOffset = !startKeyframeIndex ? 0 : m_blendingKeyframes[startKeyframeIndex.value()].key();
853
854         // 15. Let end offset be the computed keyframe offset of last keyframe in interval endpoints.
855         auto endKeyframeIndex = intervalEndpoints.last();
856         auto endOffset = !endKeyframeIndex ? 1 : m_blendingKeyframes[endKeyframeIndex.value()].key();
857
858         // 16. Let interval distance be the result of evaluating (iteration progress - start offset) / (end offset - start offset).
859         auto intervalDistance = (iterationProgress - startOffset) / (endOffset - startOffset);
860
861         // 17. Let transformed distance be the result of evaluating the timing function associated with the first keyframe in interval endpoints
862         //     passing interval distance as the input progress.
863         auto transformedDistance = intervalDistance;
864         if (startKeyframeIndex) {
865             if (auto iterationDuration = timing()->iterationDuration()) {
866                 auto rangeDuration = (endOffset - startOffset) * iterationDuration.seconds();
867                 transformedDistance = m_parsedKeyframes[startKeyframeIndex.value()].timingFunction->transformTime(intervalDistance, rangeDuration);
868             }
869         }
870
871         // 18. Return the result of applying the interpolation procedure defined by the animation type of the target property, to the values of the target
872         //     property specified on the two keyframes in interval endpoints taking the first such value as Vstart and the second as Vend and using transformed
873         //     distance as the interpolation parameter p.
874         auto startStyle = !startKeyframeIndex ? &targetStyle : m_blendingKeyframes[startKeyframeIndex.value()].style();
875         auto endStyle = !endKeyframeIndex ? &targetStyle : m_blendingKeyframes[endKeyframeIndex.value()].style();
876         CSSPropertyAnimation::blendProperties(this, cssPropertyId, &targetStyle, startStyle, endStyle, transformedDistance);
877     }
878 }
879
880 void KeyframeEffectReadOnly::startOrStopAccelerated()
881 {
882     auto* renderer = this->renderer();
883     if (!renderer || !renderer->isComposited())
884         return;
885
886     auto* compositedRenderer = downcast<RenderBoxModelObject>(renderer);
887     if (m_startedAccelerated) {
888         auto animation = Animation::create();
889         animation->setDuration(timing()->iterationDuration().seconds());
890         compositedRenderer->startAnimation(0, animation.ptr(), m_blendingKeyframes);
891     } else {
892         compositedRenderer->animationFinished(m_blendingKeyframes.animationName());
893         if (!m_target->document().renderTreeBeingDestroyed())
894             m_target->invalidateStyleAndLayerComposition();
895     }
896 }
897
898 RenderElement* KeyframeEffectReadOnly::renderer() const
899 {
900     return m_target ? m_target->renderer() : nullptr;
901 }
902
903 const RenderStyle& KeyframeEffectReadOnly::currentStyle() const
904 {
905     if (auto* renderer = this->renderer())
906         return renderer->style();
907     return RenderStyle::defaultStyle();
908 }
909
910 } // namespace WebCore