mirror of
https://github.com/SerenityOS/serenity.git
synced 2025-01-23 09:51:57 -05:00
LibWeb: Add DocumentTimeline IDL object
This commit is contained in:
parent
521f8bd5f2
commit
734076946b
6 changed files with 138 additions and 0 deletions
80
Userland/Libraries/LibWeb/Animations/DocumentTimeline.cpp
Normal file
80
Userland/Libraries/LibWeb/Animations/DocumentTimeline.cpp
Normal file
|
@ -0,0 +1,80 @@
|
||||||
|
/*
|
||||||
|
* Copyright (c) 2023, Matthew Olsson <mattco@serenityos.org>.
|
||||||
|
*
|
||||||
|
* SPDX-License-Identifier: BSD-2-Clause
|
||||||
|
*/
|
||||||
|
|
||||||
|
#include <LibJS/Heap/Heap.h>
|
||||||
|
#include <LibJS/Runtime/Realm.h>
|
||||||
|
#include <LibWeb/Animations/DocumentTimeline.h>
|
||||||
|
#include <LibWeb/DOM/Document.h>
|
||||||
|
#include <LibWeb/HTML/Window.h>
|
||||||
|
#include <LibWeb/WebIDL/ExceptionOr.h>
|
||||||
|
|
||||||
|
namespace Web::Animations {
|
||||||
|
|
||||||
|
JS::NonnullGCPtr<DocumentTimeline> DocumentTimeline::create(JS::Realm& realm, DOM::Document& document, HighResolutionTime::DOMHighResTimeStamp origin_time)
|
||||||
|
{
|
||||||
|
return realm.heap().allocate<DocumentTimeline>(realm, realm, document, origin_time);
|
||||||
|
}
|
||||||
|
|
||||||
|
// https://www.w3.org/TR/web-animations-1/#dom-documenttimeline-documenttimeline
|
||||||
|
WebIDL::ExceptionOr<JS::NonnullGCPtr<DocumentTimeline>> DocumentTimeline::construct_impl(JS::Realm& realm, DocumentTimelineOptions options)
|
||||||
|
{
|
||||||
|
// Creates a new DocumentTimeline. The Document with which the timeline is associated is the Document associated
|
||||||
|
// with the Window that is the current global object.
|
||||||
|
auto& window = verify_cast<HTML::Window>(realm.global_object());
|
||||||
|
return create(realm, window.associated_document(), options.origin_time);
|
||||||
|
}
|
||||||
|
|
||||||
|
// https://www.w3.org/TR/web-animations-1/#ref-for-timeline-time-to-origin-relative-time
|
||||||
|
Optional<double> DocumentTimeline::convert_a_timeline_time_to_an_original_relative_time(Optional<double> timeline_time)
|
||||||
|
{
|
||||||
|
// To convert a timeline time, timeline time, to an origin-relative time for a document timeline, timeline, return
|
||||||
|
// the sum of the timeline time and timeline’s origin time. If timeline is inactive, return an unresolved time
|
||||||
|
// value.
|
||||||
|
if (is_inactive() || !timeline_time.has_value())
|
||||||
|
return {};
|
||||||
|
return timeline_time.value() + m_origin_time;
|
||||||
|
}
|
||||||
|
|
||||||
|
// https://www.w3.org/TR/web-animations-1/#origin-time
|
||||||
|
WebIDL::ExceptionOr<void> DocumentTimeline::set_current_time(Optional<double> current_time)
|
||||||
|
{
|
||||||
|
// A document timeline is a type of timeline that is associated with a document and whose current time is calculated
|
||||||
|
// as a fixed offset from the now timestamp provided each time the update animations and send events procedure is
|
||||||
|
// run. This fixed offset is referred to as the document timeline’s origin time.
|
||||||
|
if (!current_time.has_value())
|
||||||
|
TRY(Base::set_current_time({}));
|
||||||
|
else
|
||||||
|
TRY(Base::set_current_time(current_time.value() - m_origin_time));
|
||||||
|
|
||||||
|
// After a document timeline becomes active, it is monotonically increasing.
|
||||||
|
if (!is_inactive())
|
||||||
|
VERIFY(is_monotonically_increasing());
|
||||||
|
|
||||||
|
return {};
|
||||||
|
}
|
||||||
|
|
||||||
|
// https://www.w3.org/TR/web-animations-1/#document-timelines
|
||||||
|
bool DocumentTimeline::is_inactive() const
|
||||||
|
{
|
||||||
|
// A document timeline that is associated with a Document which is not an active document is also considered to be
|
||||||
|
// inactive.
|
||||||
|
return Base::is_inactive() || !associated_document()->is_active();
|
||||||
|
}
|
||||||
|
|
||||||
|
DocumentTimeline::DocumentTimeline(JS::Realm& realm, DOM::Document& document, HighResolutionTime::DOMHighResTimeStamp origin_time)
|
||||||
|
: AnimationTimeline(realm)
|
||||||
|
, m_origin_time(origin_time)
|
||||||
|
{
|
||||||
|
set_associated_document(document);
|
||||||
|
}
|
||||||
|
|
||||||
|
void DocumentTimeline::initialize(JS::Realm& realm)
|
||||||
|
{
|
||||||
|
Base::initialize(realm);
|
||||||
|
set_prototype(&Bindings::ensure_web_prototype<Bindings::DocumentTimelinePrototype>(realm, "DocumentTimeline"));
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
42
Userland/Libraries/LibWeb/Animations/DocumentTimeline.h
Normal file
42
Userland/Libraries/LibWeb/Animations/DocumentTimeline.h
Normal file
|
@ -0,0 +1,42 @@
|
||||||
|
/*
|
||||||
|
* Copyright (c) 2023, Matthew Olsson <mattco@serenityos.org>.
|
||||||
|
*
|
||||||
|
* SPDX-License-Identifier: BSD-2-Clause
|
||||||
|
*/
|
||||||
|
|
||||||
|
#pragma once
|
||||||
|
|
||||||
|
#include <LibWeb/Animations/AnimationTimeline.h>
|
||||||
|
#include <LibWeb/HighResolutionTime/DOMHighResTimeStamp.h>
|
||||||
|
#include <LibWeb/WebIDL/ExceptionOr.h>
|
||||||
|
|
||||||
|
namespace Web::Animations {
|
||||||
|
|
||||||
|
// https://www.w3.org/TR/web-animations-1/#dictdef-documenttimelineoptions
|
||||||
|
struct DocumentTimelineOptions {
|
||||||
|
HighResolutionTime::DOMHighResTimeStamp origin_time { 0.0 };
|
||||||
|
};
|
||||||
|
|
||||||
|
// https://www.w3.org/TR/web-animations-1/#the-documenttimeline-interface
|
||||||
|
class DocumentTimeline : public AnimationTimeline {
|
||||||
|
WEB_PLATFORM_OBJECT(DocumentTimeline, AnimationTimeline);
|
||||||
|
|
||||||
|
public:
|
||||||
|
static JS::NonnullGCPtr<DocumentTimeline> create(JS::Realm&, DOM::Document&, HighResolutionTime::DOMHighResTimeStamp origin_time);
|
||||||
|
static WebIDL::ExceptionOr<JS::NonnullGCPtr<DocumentTimeline>> construct_impl(JS::Realm&, DocumentTimelineOptions options = {});
|
||||||
|
|
||||||
|
virtual WebIDL::ExceptionOr<void> set_current_time(Optional<double> current_time) override;
|
||||||
|
virtual bool is_inactive() const override;
|
||||||
|
|
||||||
|
virtual Optional<double> convert_a_timeline_time_to_an_original_relative_time(Optional<double>) override;
|
||||||
|
virtual bool can_convert_a_timeline_time_to_an_original_relative_time() const override { return true; }
|
||||||
|
|
||||||
|
private:
|
||||||
|
DocumentTimeline(JS::Realm&, DOM::Document&, HighResolutionTime::DOMHighResTimeStamp origin_time);
|
||||||
|
|
||||||
|
virtual void initialize(JS::Realm&) override;
|
||||||
|
|
||||||
|
HighResolutionTime::DOMHighResTimeStamp m_origin_time;
|
||||||
|
};
|
||||||
|
|
||||||
|
}
|
13
Userland/Libraries/LibWeb/Animations/DocumentTimeline.idl
Normal file
13
Userland/Libraries/LibWeb/Animations/DocumentTimeline.idl
Normal file
|
@ -0,0 +1,13 @@
|
||||||
|
#import <Animations/AnimationTimeline.idl>
|
||||||
|
#import <HighResolutionTime/DOMHighResTimeStamp.idl>
|
||||||
|
|
||||||
|
// https://www.w3.org/TR/web-animations-1/#dictdef-documenttimelineoptions
|
||||||
|
dictionary DocumentTimelineOptions {
|
||||||
|
DOMHighResTimeStamp originTime = 0;
|
||||||
|
};
|
||||||
|
|
||||||
|
// https://www.w3.org/TR/web-animations-1/#documenttimeline
|
||||||
|
[Exposed=Window]
|
||||||
|
interface DocumentTimeline : AnimationTimeline {
|
||||||
|
constructor(optional DocumentTimelineOptions options = {});
|
||||||
|
};
|
|
@ -3,6 +3,7 @@ include(accelerated_graphics)
|
||||||
|
|
||||||
set(SOURCES
|
set(SOURCES
|
||||||
Animations/AnimationTimeline.cpp
|
Animations/AnimationTimeline.cpp
|
||||||
|
Animations/DocumentTimeline.cpp
|
||||||
ARIA/AriaData.cpp
|
ARIA/AriaData.cpp
|
||||||
ARIA/ARIAMixin.cpp
|
ARIA/ARIAMixin.cpp
|
||||||
ARIA/Roles.cpp
|
ARIA/Roles.cpp
|
||||||
|
|
|
@ -28,6 +28,7 @@ class RecordingPainter;
|
||||||
|
|
||||||
namespace Web::Animations {
|
namespace Web::Animations {
|
||||||
class AnimationTimeline;
|
class AnimationTimeline;
|
||||||
|
class DocumentTimeline;
|
||||||
}
|
}
|
||||||
|
|
||||||
namespace Web::ARIA {
|
namespace Web::ARIA {
|
||||||
|
|
|
@ -2,6 +2,7 @@
|
||||||
# It is defined here so that there is no need to go to the Meta directory when adding new idl files
|
# It is defined here so that there is no need to go to the Meta directory when adding new idl files
|
||||||
|
|
||||||
libweb_js_bindings(Animations/AnimationTimeline)
|
libweb_js_bindings(Animations/AnimationTimeline)
|
||||||
|
libweb_js_bindings(Animations/DocumentTimeline)
|
||||||
libweb_js_bindings(Crypto/Crypto)
|
libweb_js_bindings(Crypto/Crypto)
|
||||||
libweb_js_bindings(Crypto/SubtleCrypto)
|
libweb_js_bindings(Crypto/SubtleCrypto)
|
||||||
libweb_js_bindings(CSS/CSSConditionRule)
|
libweb_js_bindings(CSS/CSSConditionRule)
|
||||||
|
|
Loading…
Add table
Reference in a new issue