LibWeb: Add NavigationCurrentEntryChangeEvent, fired when navigating

This event will be fired by Navigation when changing the current
NavigationHistoryEntry.

Meta/Lagom/Tools/CodeGenerators/LibWeb/BindingsGenerator/IDLGenerators.cpp

@@ -44,6 +44,7 @@ static bool is_platform_object(Type const& type)
         "Module"sv,
         "MutationRecord"sv,
         "NamedNodeMap"sv,
+        "NavigationHistoryEntry"sv,
         "Node"sv,
         "Path2D"sv,
         "PerformanceEntry"sv,

Meta/gn/secondary/Userland/Libraries/LibWeb/HTML/BUILD.gn

@@ -123,6 +123,7 @@ source_set("HTML") {
     "MimeTypeArray.cpp",
     "Navigable.cpp",
     "NavigableContainer.cpp",
+    "NavigationCurrentEntryChangeEvent.cpp",
     "NavigationHistoryEntry.cpp",
     "Navigator.cpp",
     "NavigatorID.cpp",

Meta/gn/secondary/Userland/Libraries/LibWeb/idl_files.gni

@@ -182,6 +182,7 @@ standard_idl_files = [
   "//Userland/Libraries/LibWeb/HTML/MessagePort.idl",
   "//Userland/Libraries/LibWeb/HTML/MimeType.idl",
   "//Userland/Libraries/LibWeb/HTML/MimeTypeArray.idl",
+  "//Userland/Libraries/LibWeb/HTML/NavigationCurrentEntryChangeEvent.idl",
   "//Userland/Libraries/LibWeb/HTML/NavigationHistoryEntry.idl",
   "//Userland/Libraries/LibWeb/HTML/Navigator.idl",
   "//Userland/Libraries/LibWeb/HTML/PageTransitionEvent.idl",

Userland/Libraries/LibWeb/CMakeLists.txt

@@ -350,6 +350,7 @@ set(SOURCES
     HTML/MimeTypeArray.cpp
     HTML/Navigable.cpp
     HTML/NavigableContainer.cpp
+    HTML/NavigationCurrentEntryChangeEvent.cpp
     HTML/NavigationHistoryEntry.cpp
     HTML/Navigator.cpp
     HTML/NavigatorID.cpp

Userland/Libraries/LibWeb/Forward.h

@@ -414,6 +414,7 @@ class MimeType;
 class MimeTypeArray;
 class Navigable;
 class NavigableContainer;
+class NavigationCurrentEntryChangeEvent;
 class NavigationHistoryEntry;
 class Navigator;
 struct NavigationParams;

Userland/Libraries/LibWeb/HTML/EventNames.h

@@ -34,6 +34,7 @@ namespace Web::HTML::EventNames {
     __ENUMERATE_HTML_EVENT(contextmenu)              \
     __ENUMERATE_HTML_EVENT(copy)                     \
     __ENUMERATE_HTML_EVENT(cuechange)                \
+    __ENUMERATE_HTML_EVENT(currententrychange)       \
     __ENUMERATE_HTML_EVENT(dispose)                  \
     __ENUMERATE_HTML_EVENT(cut)                      \
     __ENUMERATE_HTML_EVENT(DOMContentLoaded)         \

Userland/Libraries/LibWeb/HTML/NavigationCurrentEntryChangeEvent.cpp

@@ -0,0 +1,42 @@
+/*
+ * Copyright (c) 2023, Andrew Kaster <akaster@serenityos.org>
+ *
+ * SPDX-License-Identifier: BSD-2-Clause
+ */
+
+#include <LibJS/Heap/Heap.h>
+#include <LibJS/Runtime/Realm.h>
+#include <LibWeb/Bindings/Intrinsics.h>
+#include <LibWeb/Bindings/NavigationCurrentEntryChangeEventPrototype.h>
+#include <LibWeb/HTML/NavigationCurrentEntryChangeEvent.h>
+#include <LibWeb/HTML/NavigationHistoryEntry.h>
+
+namespace Web::HTML {
+
+JS::NonnullGCPtr<NavigationCurrentEntryChangeEvent> NavigationCurrentEntryChangeEvent::construct_impl(JS::Realm& realm, FlyString const& event_name, NavigationCurrentEntryChangeEventInit const& event_init)
+{
+    return realm.heap().allocate<NavigationCurrentEntryChangeEvent>(realm, realm, event_name, event_init);
+}
+
+NavigationCurrentEntryChangeEvent::NavigationCurrentEntryChangeEvent(JS::Realm& realm, FlyString const& event_name, NavigationCurrentEntryChangeEventInit const& event_init)
+    : DOM::Event(realm, event_name, event_init)
+    , m_navigation_type(event_init.navigation_type)
+    , m_from(*event_init.from)
+{
+}
+
+NavigationCurrentEntryChangeEvent::~NavigationCurrentEntryChangeEvent() = default;
+
+void NavigationCurrentEntryChangeEvent::initialize(JS::Realm& realm)
+{
+    Base::initialize(realm);
+    set_prototype(&Bindings::ensure_web_prototype<Bindings::NavigationCurrentEntryChangeEventPrototype>(realm, "NavigationCurrentEntryChangeEvent"));
+}
+
+void NavigationCurrentEntryChangeEvent::visit_edges(JS::Cell::Visitor& visitor)
+{
+    Base::visit_edges(visitor);
+    visitor.visit(m_from);
+}
+
+}

Userland/Libraries/LibWeb/HTML/NavigationCurrentEntryChangeEvent.h

@@ -0,0 +1,40 @@
+/*
+ * Copyright (c) 2023, Andrew Kaster <akaster@serenityos.org>
+ *
+ * SPDX-License-Identifier: BSD-2-Clause
+ */
+
+#pragma once
+
+#include <LibWeb/DOM/Event.h>
+#include <LibWeb/HTML/NavigationType.h>
+
+namespace Web::HTML {
+
+struct NavigationCurrentEntryChangeEventInit : public DOM::EventInit {
+    Optional<Bindings::NavigationType> navigation_type = {};
+    JS::GCPtr<NavigationHistoryEntry> from;
+};
+
+class NavigationCurrentEntryChangeEvent final : public DOM::Event {
+    WEB_PLATFORM_OBJECT(NavigationCurrentEntryChangeEvent, DOM::Event);
+
+public:
+    [[nodiscard]] static JS::NonnullGCPtr<NavigationCurrentEntryChangeEvent> construct_impl(JS::Realm&, FlyString const& event_name, NavigationCurrentEntryChangeEventInit const&);
+
+    virtual ~NavigationCurrentEntryChangeEvent() override;
+
+    Optional<Bindings::NavigationType> const& navigation_type() const { return m_navigation_type; }
+    JS::NonnullGCPtr<NavigationHistoryEntry> from() const { return m_from; }
+
+private:
+    NavigationCurrentEntryChangeEvent(JS::Realm&, FlyString const& event_name, NavigationCurrentEntryChangeEventInit const& event_init);
+
+    virtual void initialize(JS::Realm&) override;
+    virtual void visit_edges(Cell::Visitor&) override;
+
+    Optional<Bindings::NavigationType> m_navigation_type;
+    JS::NonnullGCPtr<NavigationHistoryEntry> m_from;
+};
+
+}

Userland/Libraries/LibWeb/HTML/NavigationCurrentEntryChangeEvent.idl

@@ -0,0 +1,18 @@
+#import <DOM/Event.idl>
+#import <HTML/NavigationHistoryEntry.idl>
+#import <HTML/NavigationType.idl>
+
+// https://html.spec.whatwg.org/multipage/nav-history-apis.html#the-navigationcurrententrychangeevent-interface
+[Exposed=Window, UseNewAKString]
+interface NavigationCurrentEntryChangeEvent : Event {
+  constructor(DOMString type, NavigationCurrentEntryChangeEventInit eventInitDict);
+
+  readonly attribute NavigationType? navigationType;
+  readonly attribute NavigationHistoryEntry from;
+};
+
+dictionary NavigationCurrentEntryChangeEventInit : EventInit {
+  // FIXME: Set default value of null when IDL generator supports it
+  NavigationType? navigationType;
+  required NavigationHistoryEntry from;
+};

Userland/Libraries/LibWeb/idl_files.cmake

@@ -168,6 +168,7 @@ libweb_js_bindings(HTML/MessageEvent)
 libweb_js_bindings(HTML/MessagePort)
 libweb_js_bindings(HTML/MimeType)
 libweb_js_bindings(HTML/MimeTypeArray)
+libweb_js_bindings(HTML/NavigationCurrentEntryChangeEvent)
 libweb_js_bindings(HTML/NavigationHistoryEntry)
 libweb_js_bindings(HTML/Navigator)
 libweb_js_bindings(HTML/PageTransitionEvent)