ladybird/Userland/Libraries/LibWeb/HTML/Navigable.h
Aliaksandr Kalenik de2c016556 LibWeb: Implement "attempt to populate the history entry's document"
Implements:
https://html.spec.whatwg.org/multipage/browsing-the-web.html#attempt-to-populate-the-history-entry's-document

This is going to be a replacement for `FrameLoader::load()` after
switching to navigables.

Brief description of `populate_session_history_entry_document`:
- If navigation params have url with fetch scheme then DOM document
  will be populated by fetching url and parsing response. This
  is going to be a replacement for `FrameLoader::load(AK::URL&)`.
- If url in navigation params is abort:srcdoc then DOM document
  will be populated by parsing HTML text passed in document resource.
  This is going to be a replacement for `FrameLoader::load_html()`
2023-05-03 09:39:49 +02:00

112 lines
4.3 KiB
C++

/*
* Copyright (c) 2022, Andreas Kling <kling@serenityos.org>
* Copyright (c) 2023, Aliaksandr Kalenik <kalenik.aliaksandr@gmail.com>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#pragma once
#include <LibJS/Heap/Cell.h>
#include <LibWeb/Forward.h>
#include <LibWeb/HTML/HistoryHandlingBehavior.h>
#include <LibWeb/HTML/POSTResource.h>
#include <LibWeb/HTML/SourceSnapshotParams.h>
namespace Web::HTML {
// https://html.spec.whatwg.org/multipage/document-sequences.html#navigable
class Navigable : public JS::Cell {
JS_CELL(Navigable, JS::Cell);
public:
virtual ~Navigable() override;
ErrorOr<void> initialize_navigable(JS::NonnullGCPtr<DocumentState> document_state, JS::GCPtr<Navigable> parent);
String const& id() const { return m_id; };
JS::GCPtr<Navigable> parent() const { return m_parent; };
bool is_closing() const { return m_closing; };
void set_closing(bool value) { m_closing = value; };
bool is_delaying_load_events() const { return m_delaying_load_events; };
void set_delaying_load_events(bool value) { m_delaying_load_events = value; };
JS::GCPtr<SessionHistoryEntry> active_session_history_entry() const { return m_active_session_history_entry; };
JS::GCPtr<SessionHistoryEntry> current_session_history_entry() const { return m_current_session_history_entry; };
Vector<JS::NonnullGCPtr<SessionHistoryEntry>>& get_session_history_entries() const;
JS::GCPtr<DOM::Document> active_document();
JS::GCPtr<BrowsingContext> active_browsing_context();
JS::GCPtr<WindowProxy> active_window_proxy();
JS::GCPtr<Window> active_window();
JS::GCPtr<SessionHistoryEntry> get_the_target_history_entry(int target_step) const;
String target_name() const;
JS::GCPtr<NavigableContainer> container() const;
void set_container(JS::GCPtr<NavigableContainer>);
JS::GCPtr<TraversableNavigable> traversable_navigable() const;
JS::GCPtr<TraversableNavigable> top_level_traversable();
static JS::GCPtr<Navigable> navigable_with_active_document(JS::NonnullGCPtr<DOM::Document>);
enum class Traversal {
Tag
};
Variant<Empty, Traversal, String> ongoing_navigation() const { return m_ongoing_navigation; }
WebIDL::ExceptionOr<void> populate_session_history_entry_document(JS::GCPtr<SessionHistoryEntry>, Optional<NavigationParams>, Optional<String> navigation_id, SourceSnapshotParams const&, Function<void()>);
WebIDL::ExceptionOr<void> navigate(
AK::URL const&,
JS::NonnullGCPtr<DOM::Document> source_document,
Variant<Empty, String, POSTResource> document_resource = Empty {},
JS::GCPtr<Fetch::Infrastructure::Response> = nullptr,
bool exceptions_enabled = false,
HistoryHandlingBehavior = HistoryHandlingBehavior::Push,
String csp_navigation_type = String::from_utf8_short_string("other"sv),
ReferrerPolicy::ReferrerPolicy = ReferrerPolicy::ReferrerPolicy::EmptyString);
WebIDL::ExceptionOr<void> navigate_to_a_fragment(AK::URL const&, HistoryHandlingBehavior, String navigation_id);
WebIDL::ExceptionOr<void> navigate_to_a_javascript_url(AK::URL const&, HistoryHandlingBehavior, Origin const& initiator_origin, String csp_navigation_type);
protected:
Navigable();
virtual void visit_edges(Cell::Visitor&) override;
// https://html.spec.whatwg.org/multipage/browsing-the-web.html#ongoing-navigation
Variant<Empty, Traversal, String> m_ongoing_navigation;
private:
// https://html.spec.whatwg.org/multipage/document-sequences.html#nav-id
String m_id;
// https://html.spec.whatwg.org/multipage/document-sequences.html#nav-parent
JS::GCPtr<Navigable> m_parent;
// https://html.spec.whatwg.org/multipage/document-sequences.html#nav-current-history-entry
JS::GCPtr<SessionHistoryEntry> m_current_session_history_entry;
// https://html.spec.whatwg.org/multipage/document-sequences.html#nav-active-history-entry
JS::GCPtr<SessionHistoryEntry> m_active_session_history_entry;
// https://html.spec.whatwg.org/multipage/document-sequences.html#is-closing
bool m_closing { false };
// https://html.spec.whatwg.org/multipage/document-sequences.html#delaying-load-events-mode
bool m_delaying_load_events { false };
// Implied link between navigable and its container.
JS::GCPtr<NavigableContainer> m_container;
};
}