From c4a0b7057b08b72d4d16b41bc6bf074aa2d264e7 Mon Sep 17 00:00:00 2001
From: Andreas Kling <kling@serenityos.org>
Date: Mon, 1 Aug 2022 16:34:56 +0200
Subject: [PATCH] LibWeb: Add basic skeleton of HTML "session history" to
 BrowsingContext

---
 .../Libraries/LibWeb/HTML/BrowsingContext.h   |  9 +++-
 .../LibWeb/HTML/SessionHistoryEntry.h         | 53 +++++++++++++++++++
 2 files changed, 61 insertions(+), 1 deletion(-)
 create mode 100644 Userland/Libraries/LibWeb/HTML/SessionHistoryEntry.h

diff --git a/Userland/Libraries/LibWeb/HTML/BrowsingContext.h b/Userland/Libraries/LibWeb/HTML/BrowsingContext.h
index 564d246218..7ae35ee318 100644
--- a/Userland/Libraries/LibWeb/HTML/BrowsingContext.h
+++ b/Userland/Libraries/LibWeb/HTML/BrowsingContext.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018-2021, Andreas Kling <kling@serenityos.org>
+ * Copyright (c) 2018-2022, Andreas Kling <kling@serenityos.org>
  *
  * SPDX-License-Identifier: BSD-2-Clause
  */
@@ -16,6 +16,7 @@
 #include <LibGfx/Size.h>
 #include <LibWeb/DOM/Position.h>
 #include <LibWeb/HTML/BrowsingContextContainer.h>
+#include <LibWeb/HTML/SessionHistoryEntry.h>
 #include <LibWeb/Loader/FrameLoader.h>
 #include <LibWeb/Page/EventHandler.h>
 #include <LibWeb/TreeNode.h>
@@ -112,6 +113,9 @@ public:
     String const& name() const { return m_name; }
     void set_name(String const& name) { m_name = name; }
 
+    Vector<SessionHistoryEntry>& session_history() { return m_session_history; }
+    Vector<SessionHistoryEntry> const& session_history() const { return m_session_history; }
+
 private:
     explicit BrowsingContext(Page&, HTML::BrowsingContextContainer*);
 
@@ -122,6 +126,9 @@ private:
     FrameLoader m_loader;
     Web::EventHandler m_event_handler;
 
+    // https://html.spec.whatwg.org/multipage/history.html#session-history
+    Vector<SessionHistoryEntry> m_session_history;
+
     WeakPtr<HTML::BrowsingContextContainer> m_container;
     RefPtr<DOM::Document> m_active_document;
     Gfx::IntSize m_size;
diff --git a/Userland/Libraries/LibWeb/HTML/SessionHistoryEntry.h b/Userland/Libraries/LibWeb/HTML/SessionHistoryEntry.h
new file mode 100644
index 0000000000..a43b5db176
--- /dev/null
+++ b/Userland/Libraries/LibWeb/HTML/SessionHistoryEntry.h
@@ -0,0 +1,53 @@
+/*
+ * Copyright (c) 2022, Andreas Kling <kling@serenityos.org>
+ *
+ * SPDX-License-Identifier: BSD-2-Clause
+ */
+
+#pragma once
+
+#include <AK/URL.h>
+#include <AK/WeakPtr.h>
+#include <LibWeb/Forward.h>
+#include <LibWeb/HTML/PolicyContainers.h>
+
+namespace Web::HTML {
+
+// https://html.spec.whatwg.org/multipage/history.html#scroll-restoration-mode
+enum class ScrollRestorationMode {
+    // https://html.spec.whatwg.org/multipage/history.html#dom-scrollrestoration-auto
+    // The user agent is responsible for restoring the scroll position upon navigation.
+    Auto,
+
+    // https://html.spec.whatwg.org/multipage/history.html#dom-scrollrestoration-manual
+    // The page is responsible for restoring the scroll position and the user agent does not attempt to do so automatically.
+    Manual,
+};
+
+// https://html.spec.whatwg.org/multipage/history.html#session-history-entry
+struct SessionHistoryEntry {
+    // URL, a URL
+    AK::URL url;
+
+    // document, a Document or null
+    WeakPtr<DOM::Document> document;
+
+    // serialized state, which is serialized state or null, initially null
+    Optional<String> serialized_state;
+
+    // policy container, a policy container or null
+    Optional<PolicyContainer> policy_container;
+
+    // scroll restoration mode, a scroll restoration mode, initially "auto"
+    ScrollRestorationMode scroll_restoration_mode { ScrollRestorationMode::Auto };
+
+    // FIXME: scroll position data, which is scroll position data for the document's restorable scrollable regions
+
+    // browsing context name, a browsing context name or null, initially null
+    Optional<String> browsing_context_name;
+
+    // FIXME: persisted user state, which is implementation-defined, initially null
+    // NOTE: This is where we could remember the state of form controls, for example.
+};
+
+}