1153734 - Rename Animation to KeyframeEffect (and merge in AnimationEffect)

Status: RESOLVED FIXED

(Core :: DOM: Core & HTML, defect)

Comment 1

[Brian Birtles (:birtles)]

Attachment: part 1 - Remove AnimationEffect

Comment 2

[Brian Birtles (:birtles)]

Attachment: part 2 - Rename Animation to KeyframeEffectReadonly

Comment 3

[Brian Birtles (:birtles)]

Just WIP at the moment. Still need:

  Part 3 - Add AnimationEffectReadonly as an abstract interface for KeyframeEffectReadonly
  Part 4 - Rename 'source' member of AnimationPlayer to 'effect'

Comment 4

[Brian Birtles (:birtles)]

Attachment: part 1 - Remove AnimationEffect

Most of this is fairly obvious. However, the addition of 'override' to
ElementPropertyTransition::Name() is not strictly necessary. It was simply added
because while making these changes I accidentally dropped the 'virtual' keyword
from the method in the superclass and the compiler didn't complain. Adding this
will hopefully make it harder to create the same bug in the future.

Comment 5

[Brian Birtles (:birtles)]

Attachment: part 2 - Rename Animation to KeyframeEffectReadonly

We define KeyframeEffectReadonly in KeyframeEffect.cpp since Web Animations also
defines KeyframeEffect and when we come to implement that I expect we'll define
it in the same class, maybe even using the same object.

This patch also adds a few missing includes in places where
KeyframeEffectReadonly is used so that we're not just cargo-culting it in.

Comment 6

[Brian Birtles (:birtles)]

Attachment: part 3 - Rename AnimationPlayer.source to AnimationPlayer.effect

There are still some other references to "source" in AnimationPlayer such as
HasInPlayerSource and UpdateSourceContent. These are renamed in a subsequent
patch (that doesn't require DOM peer review).

Comment 7

[Brian Birtles (:birtles)]

Attachment: part 4 - Rename other uses of 'source' and 'source content'

This patch also tightens up a one or two references to 'target effect' replacing
them with just 'effect'. This is because 'target effect' is longer and easily
confused with 'target element'. 'effect' should be sufficient. 'target element'
is a term from the Web Animations specification and in that context, simply
referring to the 'effect' would sound a little odd.

Comment 8

[Brian Birtles (:birtles)]

Attachment: part 5 - Add AnimationEffectReadonly as a superinterface of KeyframeEffectReadonly

This patch also replaces some tabs with spaces in KeyframeEffect.h because I was
in the area.

REVIEW: Please let me know if there's a more lightweight way of doing this.
Simply in order order to add this superinterface which does nothing I seem to
have to drop the native refcounting, inherit from nsISupports.

I ran into the same problem when adding AnimationTimeline as a superinterface of
DocumentTimeline.

Comment 9

[Brian Birtles (:birtles)]

https://treeherder.mozilla.org/#/jobs?repo=try&revision=7a89538eba2d

Comment 10

[Olli Pettay [:smaug][[e-mail]]]

Comment on attachment 8592105 [details] [diff] [review]
part 1 - Remove AnimationEffect

>+  void GetName(nsString& aRetVal) const {
{ goes to its own line


>+  // Alternative to GetName that returns a reference to the member for
>+  // more efficient internal usage.
>+  virtual const nsString& Name() const {
ditto

Comment 11

[Olli Pettay [:smaug][[e-mail]]]

Comment on attachment 8592114 [details] [diff] [review]
part 2 - Rename Animation to KeyframeEffectReadonly

https://developer.mozilla.org/en-US/docs/Mozilla/WebIDL_bindings#HeaderFile
works too, and might be nicer than to add anything to Bindings.conf

Comment 12

[Brian Birtles (:birtles)]

https://hg.mozilla.org/integration/mozilla-inbound/rev/cfcda525dbd3
https://hg.mozilla.org/integration/mozilla-inbound/rev/1e58cc9b9f92
https://hg.mozilla.org/integration/mozilla-inbound/rev/d1b6e873a6bc
https://hg.mozilla.org/integration/mozilla-inbound/rev/a4694e8ae6dd
https://hg.mozilla.org/integration/mozilla-inbound/rev/787fc1b170e3

Comment 13

[Carsten Book [:Tomcat]]

https://hg.mozilla.org/mozilla-central/rev/cfcda525dbd3
https://hg.mozilla.org/mozilla-central/rev/1e58cc9b9f92
https://hg.mozilla.org/mozilla-central/rev/d1b6e873a6bc
https://hg.mozilla.org/mozilla-central/rev/a4694e8ae6dd
https://hg.mozilla.org/mozilla-central/rev/787fc1b170e3