LibWeb: Add the Animation IDL object

2025-07-25 18:27:35 +00:00 · 2023-11-06 15:17:19 +00:00 · 2023-11-06 15:17:19 +00:00 · 1ca46afa2f
commit 1ca46afa2f
parent 0df06ce273
6 changed files with 270 additions and 0 deletions
--- a/Userland/Libraries/LibWeb/Animations/Animation.cpp
+++ b/Userland/Libraries/LibWeb/Animations/Animation.cpp
@ -0,0 +1,138 @@
+/*
+ * Copyright (c) 2023, Matthew Olsson <mattco@serenityos.org>.
+ *
+ * SPDX-License-Identifier: BSD-2-Clause
+ */
+
+#include <LibWeb/Animations/Animation.h>
+#include <LibWeb/Animations/AnimationEffect.h>
+#include <LibWeb/Animations/DocumentTimeline.h>
+#include <LibWeb/Bindings/Intrinsics.h>
+#include <LibWeb/DOM/Document.h>
+#include <LibWeb/HTML/Window.h>
+#include <LibWeb/WebIDL/ExceptionOr.h>
+#include <LibWeb/WebIDL/Promise.h>
+
+namespace Web::Animations {
+
+// https://www.w3.org/TR/web-animations-1/#dom-animation-animation
+JS::NonnullGCPtr<Animation> Animation::create(JS::Realm& realm, JS::GCPtr<AnimationEffect> effect, JS::GCPtr<AnimationTimeline> timeline)
+{
+    // 1. Let animation be a new Animation object.
+    auto animation = realm.heap().allocate<Animation>(realm, realm);
+
+    // 2. Run the procedure to set the timeline of an animation on animation passing timeline as the new timeline or, if
+    //    a timeline argument is missing, passing the default document timeline of the Document associated with the
+    //    Window that is the current global object.
+    if (!timeline) {
+        auto& window = verify_cast<HTML::Window>(HTML::current_global_object());
+        timeline = window.associated_document().timeline();
+    }
+    animation->set_timeline(timeline);
+
+    // 3. Run the procedure to set the associated effect of an animation on animation passing source as the new effect.
+    animation->set_effect(effect);
+
+    return animation;
+}
+
+WebIDL::ExceptionOr<JS::NonnullGCPtr<Animation>> Animation::construct_impl(JS::Realm& realm, JS::GCPtr<AnimationEffect> effect, JS::GCPtr<AnimationTimeline> timeline)
+{
+    return create(realm, effect, timeline);
+}
+
+// https://www.w3.org/TR/web-animations-1/#animation-set-the-associated-effect-of-an-animation
+void Animation::set_effect(JS::GCPtr<AnimationEffect> new_effect)
+{
+    // FIXME: Implement
+    (void)new_effect;
+}
+
+// https://www.w3.org/TR/web-animations-1/#animation-set-the-timeline-of-an-animation
+void Animation::set_timeline(JS::GCPtr<AnimationTimeline> new_timeline)
+{
+    // FIXME: Implement
+    (void)new_timeline;
+}
+
+// https://www.w3.org/TR/web-animations-1/#dom-animation-starttime
+// https://www.w3.org/TR/web-animations-1/#set-the-start-time
+void Animation::set_start_time(Optional<double> const& new_start_time)
+{
+    // FIXME: Implement
+    (void)new_start_time;
+}
+
+// https://www.w3.org/TR/web-animations-1/#animation-current-time
+Optional<double> Animation::current_time() const
+{
+    // FIXME: Implement
+    return {};
+}
+
+// https://www.w3.org/TR/web-animations-1/#animation-set-the-current-time
+WebIDL::ExceptionOr<void> Animation::set_current_time(Optional<double> const& seek_time)
+{
+    // FIXME: Implement
+    (void)seek_time;
+    return {};
+}
+
+// https://www.w3.org/TR/web-animations-1/#dom-animation-playbackrate
+// https://www.w3.org/TR/web-animations-1/#set-the-playback-rate
+WebIDL::ExceptionOr<void> Animation::set_playback_rate(double new_playback_rate)
+{
+    // FIXME: Implement
+    (void)new_playback_rate;
+    return {};
+}
+
+// https://www.w3.org/TR/web-animations-1/#animation-play-state
+Bindings::AnimationPlayState Animation::play_state() const
+{
+    // FIXME: Implement
+    return Bindings::AnimationPlayState::Idle;
+}
+
+JS::NonnullGCPtr<WebIDL::Promise> Animation::current_ready_promise() const
+{
+    if (!m_current_ready_promise) {
+        // The current ready promise is initially a resolved Promise created using the procedure to create a new
+        // resolved Promise with the animation itself as its value and created in the relevant Realm of the animation.
+        m_current_ready_promise = WebIDL::create_resolved_promise(realm(), this);
+    }
+
+    return *m_current_ready_promise;
+}
+
+JS::NonnullGCPtr<WebIDL::Promise> Animation::current_finished_promise() const
+{
+    if (!m_current_finished_promise) {
+        // The current finished promise is initially a pending Promise object.
+        m_current_finished_promise = WebIDL::create_promise(realm());
+    }
+
+    return *m_current_finished_promise;
+}
+
+Animation::Animation(JS::Realm& realm)
+    : DOM::EventTarget(realm)
+{
+}
+
+void Animation::initialize(JS::Realm& realm)
+{
+    Base::initialize(realm);
+    set_prototype(&Bindings::ensure_web_prototype<Bindings::AnimationPrototype>(realm, "Animation"));
+}
+
+void Animation::visit_edges(Cell::Visitor& visitor)
+{
+    Base::visit_edges(visitor);
+    visitor.visit(m_effect);
+    visitor.visit(m_timeline);
+    visitor.visit(m_current_ready_promise);
+    visitor.visit(m_current_finished_promise);
+}
+
+}