From ebe704a03da0c08b379097debf919ec5a641bf56 Mon Sep 17 00:00:00 2001 From: Timothy Flynn Date: Wed, 13 Oct 2021 14:20:50 -0400 Subject: [PATCH] LibWeb: Stub out a basic IntersectionObserver interface Note there are a couple of type differences between the spec and the IDL file added in this commit. For example, we will need to support a type of Variant to handle spec types such as "(double or sequence)". But for now, this allows web pages to construct an IntersectionObserver with any valid type. --- .../LibWeb/WrapperGenerator.cpp | 21 ++++++++- .../LibWeb/Bindings/WindowObjectHelper.h | 3 ++ Userland/Libraries/LibWeb/CMakeLists.txt | 4 +- Userland/Libraries/LibWeb/Forward.h | 5 +++ .../IntersectionObserver.cpp | 43 +++++++++++++++++++ .../IntersectionObserver.h | 35 +++++++++++++++ .../IntersectionObserver.idl | 22 ++++++++++ 7 files changed, 131 insertions(+), 2 deletions(-) create mode 100644 Userland/Libraries/LibWeb/IntersectionObserver/IntersectionObserver.cpp create mode 100644 Userland/Libraries/LibWeb/IntersectionObserver/IntersectionObserver.h create mode 100644 Userland/Libraries/LibWeb/IntersectionObserver/IntersectionObserver.idl diff --git a/Meta/Lagom/Tools/CodeGenerators/LibWeb/WrapperGenerator.cpp b/Meta/Lagom/Tools/CodeGenerators/LibWeb/WrapperGenerator.cpp index 2bcff977b7..4922267f78 100644 --- a/Meta/Lagom/Tools/CodeGenerators/LibWeb/WrapperGenerator.cpp +++ b/Meta/Lagom/Tools/CodeGenerators/LibWeb/WrapperGenerator.cpp @@ -750,7 +750,7 @@ int main(int argc, char** argv) auto interface = IDL::parse_interface(path, data, import_base_path); - if (namespace_.is_one_of("Crypto", "CSS", "DOM", "HTML", "UIEvents", "Geometry", "HighResolutionTime", "NavigationTiming", "RequestIdleCallback", "ResizeObserver", "SVG", "Selection", "XHR", "URL")) { + if (namespace_.is_one_of("Crypto", "CSS", "DOM", "HTML", "UIEvents", "Geometry", "HighResolutionTime", "IntersectionObserver", "NavigationTiming", "RequestIdleCallback", "ResizeObserver", "SVG", "Selection", "XHR", "URL")) { StringBuilder builder; builder.append(namespace_); builder.append("::"); @@ -1421,6 +1421,8 @@ static void generate_header(IDL::Interface const& interface) # include #elif __has_include() # include +#elif __has_include() +# include #elif __has_include() # include #elif __has_include() @@ -1589,6 +1591,7 @@ void generate_implementation(IDL::Interface const& interface) #include #include #include +#include #include #include @@ -1597,6 +1600,7 @@ using namespace Web::CSS; using namespace Web::DOM; using namespace Web::Geometry; using namespace Web::HTML; +using namespace Web::IntersectionObserver; using namespace Web::RequestIdleCallback; using namespace Web::ResizeObserver; using namespace Web::Selection; @@ -2493,6 +2497,7 @@ void generate_constructor_implementation(IDL::Interface const& interface) #include #include #include +#include #include #include #if __has_include() @@ -2509,6 +2514,8 @@ void generate_constructor_implementation(IDL::Interface const& interface) # include #elif __has_include() # include +#elif __has_include() +# include #elif __has_include() # include #elif __has_include() @@ -2530,6 +2537,7 @@ using namespace Web::CSS; using namespace Web::DOM; using namespace Web::Geometry; using namespace Web::HTML; +using namespace Web::IntersectionObserver; using namespace Web::RequestIdleCallback; using namespace Web::ResizeObserver; using namespace Web::Selection; @@ -2822,6 +2830,8 @@ void generate_prototype_implementation(IDL::Interface const& interface) # include #elif __has_include() # include +#elif __has_include() +# include #elif __has_include() # include #elif __has_include() @@ -2854,6 +2864,8 @@ void generate_prototype_implementation(IDL::Interface const& interface) # include #elif __has_include() # include +#elif __has_include() +# include #elif __has_include() # include #elif __has_include() @@ -2879,6 +2891,7 @@ using namespace Web::CSS; using namespace Web::DOM; using namespace Web::Geometry; using namespace Web::HTML; +using namespace Web::IntersectionObserver; using namespace Web::NavigationTiming; using namespace Web::RequestIdleCallback; using namespace Web::ResizeObserver; @@ -3298,6 +3311,8 @@ static void generate_iterator_header(IDL::Interface const& interface) # include #elif __has_include() # include +#elif __has_include() +# include #elif __has_include() # include #elif __has_include() @@ -3371,6 +3386,7 @@ using namespace Web::CSS; using namespace Web::DOM; using namespace Web::Geometry; using namespace Web::HTML; +using namespace Web::IntersectionObserver; using namespace Web::RequestIdleCallback; using namespace Web::ResizeObserver; using namespace Web::Selection; @@ -3483,6 +3499,8 @@ void generate_iterator_prototype_implementation(IDL::Interface const& interface) # include #elif __has_include() # include +#elif __has_include() +# include #elif __has_include() # include #elif __has_include() @@ -3504,6 +3522,7 @@ using namespace Web::CSS; using namespace Web::DOM; using namespace Web::Geometry; using namespace Web::HTML; +using namespace Web::IntersectionObserver; using namespace Web::NavigationTiming; using namespace Web::RequestIdleCallback; using namespace Web::ResizeObserver; diff --git a/Userland/Libraries/LibWeb/Bindings/WindowObjectHelper.h b/Userland/Libraries/LibWeb/Bindings/WindowObjectHelper.h index 49239fb903..7988bc1966 100644 --- a/Userland/Libraries/LibWeb/Bindings/WindowObjectHelper.h +++ b/Userland/Libraries/LibWeb/Bindings/WindowObjectHelper.h @@ -207,6 +207,8 @@ #include #include #include +#include +#include #include #include #include @@ -386,6 +388,7 @@ ADD_WINDOW_OBJECT_INTERFACE(HTMLUnknownElement) \ ADD_WINDOW_OBJECT_INTERFACE(HTMLVideoElement) \ ADD_WINDOW_OBJECT_INTERFACE(ImageData) \ + ADD_WINDOW_OBJECT_INTERFACE(IntersectionObserver) \ ADD_WINDOW_OBJECT_INTERFACE(MediaQueryList) \ ADD_WINDOW_OBJECT_INTERFACE(MediaQueryListEvent) \ ADD_WINDOW_OBJECT_INTERFACE(MessageChannel) \ diff --git a/Userland/Libraries/LibWeb/CMakeLists.txt b/Userland/Libraries/LibWeb/CMakeLists.txt index 7bd0d6b7d3..d3188546b6 100644 --- a/Userland/Libraries/LibWeb/CMakeLists.txt +++ b/Userland/Libraries/LibWeb/CMakeLists.txt @@ -188,7 +188,8 @@ set(SOURCES HTML/WebSocket.cpp HighResolutionTime/Performance.cpp InProcessWebView.cpp - Layout/BlockContainer.cpp + IntersectionObserver/IntersectionObserver.cpp + Layout/BlockContainer.cpp Layout/BlockFormattingContext.cpp Layout/Box.cpp Layout/BoxModelMetrics.cpp @@ -472,6 +473,7 @@ libweb_js_wrapper(HTML/PromiseRejectionEvent) libweb_js_wrapper(HTML/SubmitEvent) libweb_js_wrapper(HTML/WebSocket) libweb_js_wrapper(HighResolutionTime/Performance) +libweb_js_wrapper(IntersectionObserver/IntersectionObserver) libweb_js_wrapper(NavigationTiming/PerformanceTiming) libweb_js_wrapper(RequestIdleCallback/IdleDeadline) libweb_js_wrapper(ResizeObserver/ResizeObserver) diff --git a/Userland/Libraries/LibWeb/Forward.h b/Userland/Libraries/LibWeb/Forward.h index c545a04e2e..39764e2dad 100644 --- a/Userland/Libraries/LibWeb/Forward.h +++ b/Userland/Libraries/LibWeb/Forward.h @@ -204,6 +204,10 @@ namespace Web::HighResolutionTime { class Performance; } +namespace Web::IntersectionObserver { +class IntersectionObserver; +} + namespace Web::NavigationTiming { class PerformanceTiming; } @@ -386,6 +390,7 @@ class HTMLUnknownElementWrapper; class HTMLVideoElementWrapper; class IdleDeadlineWrapper; class ImageDataWrapper; +class IntersectionObserverWrapper; class KeyboardEventWrapper; class LocationObject; class MediaQueryListWrapper; diff --git a/Userland/Libraries/LibWeb/IntersectionObserver/IntersectionObserver.cpp b/Userland/Libraries/LibWeb/IntersectionObserver/IntersectionObserver.cpp new file mode 100644 index 0000000000..adbc7e1336 --- /dev/null +++ b/Userland/Libraries/LibWeb/IntersectionObserver/IntersectionObserver.cpp @@ -0,0 +1,43 @@ +/* + * Copyright (c) 2021, Tim Flynn + * + * SPDX-License-Identifier: BSD-2-Clause + */ + +#include +#include + +namespace Web::IntersectionObserver { + +// https://w3c.github.io/IntersectionObserver/#dom-intersectionobserver-intersectionobserver +NonnullRefPtr IntersectionObserver::create_with_global_object(JS::GlobalObject& global_object, JS::Value callback, IntersectionObserverInit const& options) +{ + // FIXME: Implement + (void)global_object; + (void)callback; + (void)options; + + return adopt_ref(*new IntersectionObserver); +} + +// https://w3c.github.io/IntersectionObserver/#dom-intersectionobserver-observe +void IntersectionObserver::observe(DOM::Element& target) +{ + // FIXME: Implement + (void)target; +} + +// https://w3c.github.io/IntersectionObserver/#dom-intersectionobserver-unobserve +void IntersectionObserver::unobserve(DOM::Element& target) +{ + // FIXME: Implement + (void)target; +} + +// https://w3c.github.io/IntersectionObserver/#dom-intersectionobserver-disconnect +void IntersectionObserver::disconnect() +{ + // FIXME: Implement +} + +} diff --git a/Userland/Libraries/LibWeb/IntersectionObserver/IntersectionObserver.h b/Userland/Libraries/LibWeb/IntersectionObserver/IntersectionObserver.h new file mode 100644 index 0000000000..43c4bff783 --- /dev/null +++ b/Userland/Libraries/LibWeb/IntersectionObserver/IntersectionObserver.h @@ -0,0 +1,35 @@ +/* + * Copyright (c) 2021, Tim Flynn + * + * SPDX-License-Identifier: BSD-2-Clause + */ + +#pragma once + +#include +#include +#include + +namespace Web::IntersectionObserver { + +struct IntersectionObserverInit { + DOM::Node* root { nullptr }; + String root_margin { "0px"sv }; + JS::Value threshold { 0 }; +}; + +// https://w3c.github.io/IntersectionObserver/#intersection-observer-interface +class IntersectionObserver + : public RefCounted + , public Bindings::Wrappable { +public: + using WrapperType = Bindings::IntersectionObserverWrapper; + + static NonnullRefPtr create_with_global_object(JS::GlobalObject&, JS::Value callback, IntersectionObserverInit const& options = {}); + + void observe(DOM::Element& target); + void unobserve(DOM::Element& target); + void disconnect(); +}; + +} diff --git a/Userland/Libraries/LibWeb/IntersectionObserver/IntersectionObserver.idl b/Userland/Libraries/LibWeb/IntersectionObserver/IntersectionObserver.idl new file mode 100644 index 0000000000..651a9fce17 --- /dev/null +++ b/Userland/Libraries/LibWeb/IntersectionObserver/IntersectionObserver.idl @@ -0,0 +1,22 @@ +[Exposed=(Window)] +interface IntersectionObserver { + // FIXME: Should be: IntersectionObserverCallback + constructor(any callback, optional IntersectionObserverInit options = {}); + + undefined observe(Element target); + undefined unobserve(Element target); + undefined disconnect(); + + // FIXME: + // sequence takeRecords(); +}; + +dictionary IntersectionObserverInit { + // FIXME: Should be: (Element or Document)? + Node? root = null; + + DOMString rootMargin = "0px"; + + // FIXME: Should be: (double or sequence) + any threshold = 0; +};