ladybird/Userland/Libraries/LibWeb/HTML/SessionHistoryEntry.h

/*
 * 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 <LibJS/Heap/Cell.h>
#include <LibJS/Heap/GCPtr.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 final : public JS::Cell {
    JS_CELL(SessionHistoryEntry, JS::Cell);

    void visit_edges(Cell::Visitor&) override;

    // URL, a URL
    AK::URL url;

    // document, a Document or null
    // FIXME: this property is not present in the spec anymore and should be gone after introducing navigables
    JS::GCPtr<DOM::Document> document;

    // https://html.spec.whatwg.org/multipage/browsing-the-web.html#she-document-state
    JS::GCPtr<HTML::DocumentState> document_state;

    // https://html.spec.whatwg.org/multipage/browsing-the-web.html#she-serialized-state
    // serialized state, which is serialized state, initially StructuredSerializeForStorage(null).
    Optional<DeprecatedString> serialized_state;

    // https://html.spec.whatwg.org/multipage/browsing-the-web.html#she-scroll-restoration-mode
    // scroll restoration mode, a scroll restoration mode, initially "auto"
    ScrollRestorationMode scroll_restoration_mode { ScrollRestorationMode::Auto };

    // policy container, a policy container or null
    Optional<PolicyContainer> policy_container;

    // https://html.spec.whatwg.org/multipage/browsing-the-web.html#she-scroll-position
    // 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<DeprecatedString> browsing_context_name;

    // https://html.spec.whatwg.org/multipage/browsing-the-web.html#she-other
    // FIXME: persisted user state, which is implementation-defined, initially null
    // NOTE: This is where we could remember the state of form controls, for example.

    JS::GCPtr<BrowsingContext> original_source_browsing_context;
};

}