Stowage/ladybird
2
0
Fork 0
mirror of https://github.com/LadybirdBrowser/ladybird.git synced 2026-04-19 02:10:26 +00:00
Code Issues Projects Releases Packages Wiki Activity
ladybird/Libraries/LibWebView/Application.h
Timothy Flynn 1b6c4c1db8 LibWebView: Add context menu items to interact with the bookmarks bar 
This adds hooks to add, edit, and delete bookmarks and folders.
2026-04-01 04:57:28 +02:00

351 lines
17 KiB
C++
Raw Blame History

/*
* Copyright (c) 2024, Andrew Kaster <akaster@serenityos.org>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#pragma once
#include <AK/ByteString.h>
#include <AK/Function.h>
#include <AK/LexicalPath.h>
#include <AK/Optional.h>
#include <LibCore/EventLoop.h>
#include <LibCore/Forward.h>
#include <LibDatabase/Forward.h>
#include <LibDevTools/DevToolsDelegate.h>
#include <LibDevTools/Forward.h>
#include <LibIPC/Forward.h>
#include <LibImageDecoderClient/Client.h>
#include <LibMain/Main.h>
#include <LibRequests/Forward.h>
#include <LibURL/URL.h>
#include <LibWeb/CSS/PreferredColorScheme.h>
#include <LibWeb/CSS/PreferredContrast.h>
#include <LibWeb/CSS/PreferredMotion.h>
#include <LibWeb/Clipboard/SystemClipboard.h>
#include <LibWeb/HTML/ActivateTab.h>
#include <LibWebView/BookmarkStore.h>
#include <LibWebView/FileDownloader.h>
#include <LibWebView/Forward.h>
#include <LibWebView/Options.h>
#include <LibWebView/Process.h>
#include <LibWebView/ProcessManager.h>
#include <LibWebView/Settings.h>
#include <LibWebView/StorageJar.h>
#if defined(AK_OS_MACOS)
# include <LibIPC/TransportBootstrapMach.h>
#endif
namespace WebView {
struct ApplicationSettingsObserver;
struct ApplicationBookmarkStoreObserver;
class WEBVIEW_API Application : public DevTools::DevToolsDelegate {
AK_MAKE_NONCOPYABLE(Application);
public:
virtual ~Application();
ErrorOr<int> execute();
static Application& the() { return *s_the; }
static Settings& settings() { return the().m_settings; }
static BrowserOptions const& browser_options() { return the().m_browser_options; }
static RequestServerOptions const& request_server_options() { return the().m_request_server_options; }
static WebContentOptions& web_content_options() { return the().m_web_content_options; }
static Requests::RequestClient& request_server_client() { return *the().m_request_server_client; }
static ImageDecoderClient::Client& image_decoder_client() { return *the().m_image_decoder_client; }
static BookmarkStore& bookmark_store() { return the().m_bookmark_store; }
void update_bookmark_action_for_current_web_view();
void bookmarks_changed(Badge<ApplicationBookmarkStoreObserver>);
void show_bookmarks_bar_changed(Badge<ApplicationSettingsObserver>);
static CookieJar& cookie_jar() { return *the().m_cookie_jar; }
static StorageJar& storage_jar() { return *the().m_storage_jar; }
static ProcessManager& process_manager() { return *the().m_process_manager; }
#if defined(AK_OS_MACOS)
static IPC::TransportBootstrapMachServer& transport_bootstrap_server() { return the().m_transport_bootstrap_server; }
void set_browser_process_transport_handler(Function<void(NonnullOwnPtr<IPC::Transport>)> handler);
#endif
ErrorOr<NonnullRefPtr<WebContentClient>> launch_web_content_process(ViewImplementation&);
virtual Optional<ViewImplementation&> active_web_view() const { return {}; }
virtual Optional<ViewImplementation&> open_blank_new_tab(Web::HTML::ActivateTab) const { return {}; }
void open_url_in_new_tab(URL::URL const&, Web::HTML::ActivateTab) const;
void add_child_process(Process&&);
// FIXME: Should these methods be part of Application, instead of deferring to ProcessManager?
#if defined(AK_OS_MACH)
void set_process_mach_port(pid_t, Core::MachPort&&);
#endif
Optional<Process&> find_process(pid_t);
virtual bool should_capture_web_content_output() const { return false; }
ErrorOr<LexicalPath> path_for_downloaded_file(StringView file) const;
virtual void display_download_confirmation_dialog(StringView download_name, LexicalPath const& path) const;
virtual void display_error_dialog(StringView error_message) const;
// FIXME: We should implement UI-agnostic platform APIs to interact with the system clipboard.
virtual Utf16String clipboard_text() const;
virtual Vector<Web::Clipboard::SystemClipboardRepresentation> clipboard_entries() const;
virtual void insert_clipboard_entry(Web::Clipboard::SystemClipboardRepresentation);
struct BrowsingDataSizes {
u64 cache_size_since_requested_time { 0 };
u64 total_cache_size { 0 };
u64 site_data_size_since_requested_time { 0 };
u64 total_site_data_size { 0 };
};
NonnullRefPtr<Core::Promise<BrowsingDataSizes>> estimate_browsing_data_size_accessed_since(UnixDateTime since);
struct ClearBrowsingDataOptions {
enum class Delete {
No,
Yes,
};
UnixDateTime since { UnixDateTime::earliest() };
Delete delete_cached_files { Delete::No };
Delete delete_site_data { Delete::No };
};
void clear_browsing_data(ClearBrowsingDataOptions const&);
Action& reload_action() { return *m_reload_action; }
Action& copy_selection_action() { return *m_copy_selection_action; }
Action& paste_action() { return *m_paste_action; }
Action& select_all_action() { return *m_select_all_action; }
Action& open_about_page_action() { return *m_open_about_page_action; }
Action& open_settings_page_action() { return *m_open_settings_page_action; }
Menu& zoom_menu() { return *m_zoom_menu; }
Action& reset_zoom_action() { return *m_reset_zoom_action; }
Menu& color_scheme_menu() { return *m_color_scheme_menu; }
Menu& contrast_menu() { return *m_contrast_menu; }
Menu& motion_menu() { return *m_motion_menu; }
Menu& bookmarks_menu() { return *m_bookmarks_menu; }
Menu& bookmarks_bar_context_menu() { return *m_bookmarks_bar_context_menu; }
Menu& bookmark_context_menu() { return *m_bookmark_context_menu; }
Menu& bookmark_folder_context_menu() { return *m_bookmark_folder_context_menu; }
Menu& inspect_menu() { return *m_inspect_menu; }
Action& view_source_action() { return *m_view_source_action; }
Menu& debug_menu() { return *m_debug_menu; }
FileDownloader& file_downloader() { return m_file_downloader; }
void apply_view_options(Badge<ViewImplementation>, ViewImplementation&);
ErrorOr<void> toggle_devtools_enabled();
void refresh_tab_list();
Optional<Core::TimeZoneWatcher&> time_zone_watcher();
protected:
explicit Application(Optional<ByteString> ladybird_binary_path = {});
ErrorOr<void> initialize(Main::Arguments const&);
virtual void process_did_exit(Process&&);
virtual void create_platform_arguments(Core::ArgsParser&) { }
virtual void create_platform_options(BrowserOptions&, RequestServerOptions&, WebContentOptions&) { }
virtual NonnullOwnPtr<Core::EventLoop> create_platform_event_loop();
virtual Optional<ByteString> ask_user_for_download_path([[maybe_unused]] StringView file) const { return {}; }
virtual void rebuild_bookmarks_menu() const { }
virtual void update_bookmarks_bar_display([[maybe_unused]] bool show_bookmarks_bar) const { }
struct BookmarkID {
String id;
Optional<String> target_folder_id;
};
virtual Optional<BookmarkID> bookmark_item_id_for_context_menu() const { return {}; }
using BookmarkPromise = Core::Promise<BookmarkItem::Bookmark>;
virtual NonnullRefPtr<BookmarkPromise> display_add_bookmark_dialog() const;
virtual NonnullRefPtr<BookmarkPromise> display_edit_bookmark_dialog([[maybe_unused]] BookmarkItem::Bookmark const& current_bookmark) const;
using BookmarkFolderPromise = Core::Promise<BookmarkItem::Folder>;
virtual NonnullRefPtr<BookmarkFolderPromise> display_add_bookmark_folder_dialog() const;
virtual NonnullRefPtr<BookmarkFolderPromise> display_edit_bookmark_folder_dialog([[maybe_unused]] BookmarkItem::Folder const& current_folder) const;
virtual void on_devtools_enabled() const;
virtual void on_devtools_disabled() const;
Main::Arguments& arguments() { return m_arguments; }
private:
ErrorOr<void> launch_services();
void launch_spare_web_content_process();
ErrorOr<void> launch_request_server();
ErrorOr<void> launch_image_decoder_server();
ErrorOr<void> launch_devtools_server();
void initialize_actions();
void update_bookmarks_bar_action();
struct MenuData {
Menu& menu;
ReadonlySpan<BookmarkItem> items;
Optional<String const&> target_folder_id;
};
void create_bookmark_menu_items(Optional<MenuData> = {});
virtual Vector<DevTools::TabDescription> tab_list() const override;
virtual Vector<DevTools::CSSProperty> css_property_list() const override;
virtual void inspect_tab(DevTools::TabDescription const&, OnTabInspectionComplete) const override;
virtual void inspect_accessibility_tree(DevTools::TabDescription const&, OnAccessibilityTreeInspectionComplete) const override;
virtual void listen_for_dom_properties(DevTools::TabDescription const&, OnDOMNodePropertiesReceived) const override;
virtual void stop_listening_for_dom_properties(DevTools::TabDescription const&) const override;
virtual void inspect_dom_node(DevTools::TabDescription const&, DOMNodeProperties::Type, Web::UniqueNodeID, Optional<Web::CSS::PseudoElement>) const override;
virtual void clear_inspected_dom_node(DevTools::TabDescription const&) const override;
virtual void highlight_dom_node(DevTools::TabDescription const&, Web::UniqueNodeID, Optional<Web::CSS::PseudoElement>) const override;
virtual void clear_highlighted_dom_node(DevTools::TabDescription const&) const override;
virtual void listen_for_dom_mutations(DevTools::TabDescription const&, OnDOMMutationReceived) const override;
virtual void stop_listening_for_dom_mutations(DevTools::TabDescription const&) const override;
virtual void get_dom_node_inner_html(DevTools::TabDescription const&, Web::UniqueNodeID, OnDOMNodeHTMLReceived) const override;
virtual void get_dom_node_outer_html(DevTools::TabDescription const&, Web::UniqueNodeID, OnDOMNodeHTMLReceived) const override;
virtual void set_dom_node_outer_html(DevTools::TabDescription const&, Web::UniqueNodeID, String const&, OnDOMNodeEditComplete) const override;
virtual void set_dom_node_text(DevTools::TabDescription const&, Web::UniqueNodeID, String const&, OnDOMNodeEditComplete) const override;
virtual void set_dom_node_tag(DevTools::TabDescription const&, Web::UniqueNodeID, String const&, OnDOMNodeEditComplete) const override;
virtual void add_dom_node_attributes(DevTools::TabDescription const&, Web::UniqueNodeID, ReadonlySpan<Attribute>, OnDOMNodeEditComplete) const override;
virtual void replace_dom_node_attribute(DevTools::TabDescription const&, Web::UniqueNodeID, String const&, ReadonlySpan<Attribute>, OnDOMNodeEditComplete) const override;
virtual void create_child_element(DevTools::TabDescription const&, Web::UniqueNodeID, OnDOMNodeEditComplete) const override;
virtual void insert_dom_node_before(DevTools::TabDescription const&, Web::UniqueNodeID, Web::UniqueNodeID, Optional<Web::UniqueNodeID>, OnDOMNodeEditComplete) const override;
virtual void clone_dom_node(DevTools::TabDescription const&, Web::UniqueNodeID, OnDOMNodeEditComplete) const override;
virtual void remove_dom_node(DevTools::TabDescription const&, Web::UniqueNodeID, OnDOMNodeEditComplete) const override;
virtual void retrieve_style_sheets(DevTools::TabDescription const&, OnStyleSheetsReceived) const override;
virtual void retrieve_style_sheet_source(DevTools::TabDescription const&, Web::CSS::StyleSheetIdentifier const&) const override;
virtual void listen_for_style_sheet_sources(DevTools::TabDescription const&, OnStyleSheetSourceReceived) const override;
virtual void stop_listening_for_style_sheet_sources(DevTools::TabDescription const&) const override;
virtual void evaluate_javascript(DevTools::TabDescription const&, String const&, OnScriptEvaluationComplete) const override;
virtual void listen_for_console_messages(DevTools::TabDescription const&, OnConsoleMessage) const override;
virtual void stop_listening_for_console_messages(DevTools::TabDescription const&) const override;
virtual void listen_for_network_events(DevTools::TabDescription const&, OnNetworkRequestStarted, OnNetworkResponseHeadersReceived, OnNetworkResponseBodyReceived, OnNetworkRequestFinished) const override;
virtual void stop_listening_for_network_events(DevTools::TabDescription const&) const override;
virtual void listen_for_navigation_events(DevTools::TabDescription const&, OnNavigationStarted, OnNavigationFinished) const override;
virtual void stop_listening_for_navigation_events(DevTools::TabDescription const&) const override;
virtual void did_connect_devtools_client(DevTools::TabDescription const&) const override;
virtual void did_disconnect_devtools_client(DevTools::TabDescription const&) const override;
static Application* s_the;
Settings m_settings;
OwnPtr<ApplicationSettingsObserver> m_settings_observer;
BookmarkStore m_bookmark_store;
OwnPtr<ApplicationBookmarkStoreObserver> m_bookmark_store_observer;
Main::Arguments m_arguments;
BrowserOptions m_browser_options;
RequestServerOptions m_request_server_options;
WebContentOptions m_web_content_options;
RefPtr<Requests::RequestClient> m_request_server_client;
RefPtr<ImageDecoderClient::Client> m_image_decoder_client;
RefPtr<WebContentClient> m_spare_web_content_process;
bool m_has_queued_task_to_launch_spare_web_content_process { false };
RefPtr<Database::Database> m_database;
OwnPtr<CookieJar> m_cookie_jar;
OwnPtr<StorageJar> m_storage_jar;
OwnPtr<Core::TimeZoneWatcher> m_time_zone_watcher;
OwnPtr<Core::EventLoop> m_event_loop;
OwnPtr<ProcessManager> m_process_manager;
RefPtr<Action> m_reload_action;
RefPtr<Action> m_copy_selection_action;
RefPtr<Action> m_paste_action;
RefPtr<Action> m_select_all_action;
RefPtr<Action> m_open_about_page_action;
RefPtr<Action> m_open_settings_page_action;
RefPtr<Menu> m_zoom_menu;
RefPtr<Action> m_reset_zoom_action;
RefPtr<Menu> m_color_scheme_menu;
Web::CSS::PreferredColorScheme m_color_scheme { Web::CSS::PreferredColorScheme::Auto };
RefPtr<Menu> m_contrast_menu;
Web::CSS::PreferredContrast m_contrast { Web::CSS::PreferredContrast::Auto };
RefPtr<Menu> m_motion_menu;
Web::CSS::PreferredMotion m_motion { Web::CSS::PreferredMotion::Auto };
RefPtr<Menu> m_bookmarks_menu;
RefPtr<Action> m_toggle_bookmark_action;
RefPtr<Action> m_toggle_bookmark_bar_action;
size_t m_bookmarks_menu_static_size { 0 };
RefPtr<Menu> m_bookmarks_bar_context_menu;
RefPtr<Menu> m_bookmark_context_menu;
RefPtr<Menu> m_bookmark_folder_context_menu;
RefPtr<Menu> m_inspect_menu;
RefPtr<Action> m_view_source_action;
RefPtr<Action> m_toggle_devtools_action;
RefPtr<Menu> m_debug_menu;
RefPtr<Action> m_show_line_box_borders_action;
RefPtr<Action> m_enable_scripting_action;
RefPtr<Action> m_enable_content_filtering_action;
RefPtr<Action> m_block_pop_ups_action;
StringView m_user_agent_string;
StringView m_navigator_compatibility_mode;
Optional<Web::Clipboard::SystemClipboardRepresentation> m_clipboard;
FileDownloader m_file_downloader;
#if defined(AK_OS_MACOS)
OwnPtr<IPC::MachBootstrapListener> m_mach_port_server;
IPC::TransportBootstrapMachServer m_transport_bootstrap_server;
Function<void(NonnullOwnPtr<IPC::Transport>)> m_on_browser_process_transport;
#endif
OwnPtr<DevTools::DevToolsServer> m_devtools;
mutable HashMap<u64, u64> m_navigation_listener_ids;
};
}
#define WEB_VIEW_APPLICATION(ApplicationType) \
public: \
template<typename... ApplicationArguments> \
static ErrorOr<NonnullOwnPtr<ApplicationType>> create(Main::Arguments const& arguments, ApplicationArguments&&... application_arguments) \
{ \
auto app = adopt_own(*new ApplicationType { forward<ApplicationArguments>(application_arguments)... }); \
TRY(app->initialize(arguments)); \
return app; \
} \
\
static ApplicationType& the() \
{ \
return static_cast<ApplicationType&>(WebView::Application::the()); \
} \
\
private:
Reference in a new issue View git blame Copy permalink