/* * Copyright (c) 2019-2020, Sergey Bugaev * Copyright (c) 2021, Andreas Kling * Copyright (c) 2021, Sam Atkins * Copyright (c) 2022, the SerenityOS developers. * * SPDX-License-Identifier: BSD-2-Clause */ #include "MainWidget.h" #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include namespace Help { MainWidget::MainWidget() { load_from_gml(help_window_gml); m_toolbar = find_descendant_of_type_named("toolbar"); m_tab_widget = find_descendant_of_type_named("tab_widget"); m_search_container = find_descendant_of_type_named("search_container"); m_search_box = find_descendant_of_type_named("search_box"); m_search_box->on_change = [this] { m_filter_model->set_filter_term(m_search_box->text()); }; m_search_box->on_down_pressed = [this] { m_search_view->move_cursor(GUI::AbstractView::CursorMovement::Down, GUI::AbstractView::SelectionUpdate::Set); }; m_search_box->on_up_pressed = [this] { m_search_view->move_cursor(GUI::AbstractView::CursorMovement::Up, GUI::AbstractView::SelectionUpdate::Set); }; m_search_view = find_descendant_of_type_named("search_view"); m_search_view->set_should_hide_unnecessary_scrollbars(true); m_search_view->on_selection_change = [this] { auto const& index = m_search_view->selection().first(); if (!index.is_valid()) return; auto* view_model = m_search_view->model(); if (!view_model) { m_web_view->load_empty_document(); return; } auto& search_model = *static_cast(view_model); auto const& mapped_index = search_model.map(index); String path = m_manual_model->page_path(mapped_index); if (path.is_null()) { m_web_view->load_empty_document(); return; } m_browse_view->selection().clear(); m_browse_view->selection().add(mapped_index); m_history.push(path); open_page(path); }; m_browse_view = find_descendant_of_type_named("browse_view"); m_browse_view->on_selection_change = [this] { String path = m_manual_model->page_path(m_browse_view->selection().first()); if (path.is_null()) return; m_history.push(path); open_page(path); }; m_browse_view->on_toggle = [this](GUI::ModelIndex const& index, bool open) { m_manual_model->update_section_node_on_toggle(index, open); }; m_web_view = find_descendant_of_type_named("web_view"); m_web_view->on_link_click = [this](auto& url, auto&, unsigned) { if (url.scheme() == "file") { auto path = url.path(); if (!path.starts_with("/usr/share/man/"sv)) { open_external(url); return; } auto browse_view_index = m_manual_model->index_from_path(path); if (browse_view_index.has_value()) { dbgln("Found path _{}_ in m_manual_model at index {}", path, browse_view_index.value()); m_browse_view->selection().set(browse_view_index.value()); return; } m_history.push(path); open_page(path); } else if (url.scheme() == "help") { if (url.host() == "man") { if (url.paths().size() != 2) { dbgln("Bad help page URL '{}'", url); return; } auto const section = url.paths()[0]; auto const page = url.paths()[1]; auto const path = String::formatted("/usr/share/man/man{}/{}.md", section, page); m_history.push(path); open_url(URL::create_with_file_scheme(path, url.fragment())); } else { dbgln("Bad help operation '{}' in URL '{}'", url.host(), url); } } else { open_external(url); } }; m_web_view->on_context_menu_request = [this](auto& screen_position) { m_copy_action->set_enabled(!m_web_view->selected_text().is_empty()); m_context_menu->popup(screen_position); }; m_web_view->on_link_hover = [this](URL const& url) { if (url.is_valid()) m_statusbar->set_text(url.to_string()); else m_statusbar->set_text({}); }; m_go_back_action = GUI::CommonActions::make_go_back_action([this](auto&) { m_history.go_back(); open_page(m_history.current()); }); m_go_forward_action = GUI::CommonActions::make_go_forward_action([this](auto&) { m_history.go_forward(); open_page(m_history.current()); }); m_go_back_action->set_enabled(false); m_go_forward_action->set_enabled(false); m_go_home_action = GUI::CommonActions::make_go_home_action([this](auto&) { String path = "/usr/share/man/man7/Help-index.md"; m_history.push(path); open_page(path); }); m_copy_action = GUI::CommonActions::make_copy_action([this](auto&) { auto selected_text = m_web_view->selected_text(); if (!selected_text.is_empty()) GUI::Clipboard::the().set_plain_text(selected_text); }); m_select_all_action = GUI::CommonActions::make_select_all_action([this](auto&) { m_web_view->select_all(); }); m_statusbar = find_descendant_of_type_named("statusbar"); GUI::Application::the()->on_action_enter = [this](GUI::Action const& action) { m_statusbar->set_override_text(action.status_tip()); }; GUI::Application::the()->on_action_leave = [this](GUI::Action const&) { m_statusbar->set_override_text({}); }; } void MainWidget::set_start_page(StringView start_page, u32 section) { bool set_start_page = false; if (!start_page.is_null()) { if (section != 0) { // > Help [section] [name] String path = String::formatted("/usr/share/man/man{}/{}.md", section, start_page); m_history.push(path); open_page(path); set_start_page = true; } else if (URL url = URL::create_with_url_or_path(start_page); url.is_valid() && url.path().ends_with(".md"sv)) { // > Help [/path/to/documentation/file.md] m_history.push(url.path()); open_page(url.path()); set_start_page = true; } else { // > Help [query] // First, see if we can find the page by name char const* sections[] = { "1", "2", "3", "4", "5", "6", "7", "8" }; for (auto s : sections) { String path = String::formatted("/usr/share/man/man{}/{}.md", s, start_page); if (Core::File::exists(path)) { m_history.push(path); open_page(path); set_start_page = true; break; } } // No match, so treat the input as a search query if (!set_start_page) { m_tab_widget->set_active_widget(m_search_container); m_search_box->set_focus(true); m_search_box->set_text(start_page); m_search_box->select_all(); m_filter_model->set_filter_term(m_search_box->text()); } } } if (!set_start_page) m_go_home_action->activate(); } ErrorOr MainWidget::initialize_fallibles(GUI::Window& window) { (void)TRY(m_toolbar->try_add_action(*m_go_back_action)); (void)TRY(m_toolbar->try_add_action(*m_go_forward_action)); (void)TRY(m_toolbar->try_add_action(*m_go_home_action)); auto file_menu = TRY(window.try_add_menu("&File")); TRY(file_menu->try_add_action(GUI::CommonActions::make_quit_action([](auto&) { GUI::Application::the()->quit(); }))); auto go_menu = TRY(window.try_add_menu("&Go")); TRY(go_menu->try_add_action(*m_go_back_action)); TRY(go_menu->try_add_action(*m_go_forward_action)); TRY(go_menu->try_add_action(*m_go_home_action)); auto help_menu = TRY(window.try_add_menu("&Help")); TRY(help_menu->try_add_action(GUI::Action::create("&Contents", { Key_F1 }, TRY(Gfx::Bitmap::try_load_from_file("/res/icons/16x16/filetype-unknown.png"sv)), [&](auto&) { String path = "/usr/share/man/man1/Help.md"; open_page(path); }))); TRY(help_menu->try_add_action(GUI::CommonActions::make_about_action("Help", TRY(GUI::Icon::try_create_default_icon("app-help"sv)), &window))); m_context_menu = TRY(GUI::Menu::try_create()); TRY(m_context_menu->try_add_action(*m_go_back_action)); TRY(m_context_menu->try_add_action(*m_go_forward_action)); TRY(m_context_menu->try_add_action(*m_go_home_action)); TRY(m_context_menu->try_add_separator()); TRY(m_context_menu->try_add_action(*m_copy_action)); TRY(m_context_menu->try_add_action(*m_select_all_action)); m_manual_model = TRY(ManualModel::create()); m_browse_view->set_model(*m_manual_model); m_filter_model = TRY(GUI::FilteringProxyModel::create(*m_manual_model)); m_search_view->set_model(*m_filter_model); m_filter_model->set_filter_term(""sv); return {}; } void MainWidget::open_url(URL const& url) { m_go_back_action->set_enabled(m_history.can_go_back()); m_go_forward_action->set_enabled(m_history.can_go_forward()); if (url.scheme() == "file") { m_web_view->load(url); m_web_view->scroll_to_top(); GUI::Application::the()->deferred_invoke([&, path = url.path()] { auto browse_view_index = m_manual_model->index_from_path(path); if (browse_view_index.has_value()) { m_browse_view->expand_tree(browse_view_index.value().parent()); String page_and_section = m_manual_model->page_and_section(browse_view_index.value()); window()->set_title(String::formatted("{} - Help", page_and_section)); } else { window()->set_title("Help"); } }); } } void MainWidget::open_external(URL const& url) { if (!Desktop::Launcher::open(url)) GUI::MessageBox::show(window(), String::formatted("The link to '{}' could not be opened.", url), "Failed to open link"sv, GUI::MessageBox::Type::Error); } void MainWidget::open_page(String const& path) { m_go_back_action->set_enabled(m_history.can_go_back()); m_go_forward_action->set_enabled(m_history.can_go_forward()); if (path.is_null()) { window()->set_title("Help"); m_web_view->load_empty_document(); return; } open_url(URL::create_with_url_or_path(path)); } }