ladybird/Userland/Applications/Spreadsheet/HelpWindow.cpp

/*
 * Copyright (c) 2020-2022, the SerenityOS developers.
 *
 * SPDX-License-Identifier: BSD-2-Clause
 */

#include "HelpWindow.h"
#include "SpreadsheetWidget.h"
#include <AK/LexicalPath.h>
#include <AK/QuickSort.h>
#include <LibGUI/BoxLayout.h>
#include <LibGUI/Frame.h>
#include <LibGUI/ListView.h>
#include <LibGUI/MessageBox.h>
#include <LibGUI/Model.h>
#include <LibGUI/Splitter.h>
#include <LibMarkdown/Document.h>
#include <LibWeb/Layout/Node.h>
#include <LibWebView/OutOfProcessWebView.h>

namespace Spreadsheet {

class HelpListModel final : public GUI::Model {
public:
    static NonnullRefPtr<HelpListModel> create() { return adopt_ref(*new HelpListModel); }

    virtual ~HelpListModel() override = default;

    virtual int row_count(const GUI::ModelIndex& = GUI::ModelIndex()) const override { return m_keys.size(); }
    virtual int column_count(const GUI::ModelIndex& = GUI::ModelIndex()) const override { return 1; }

    virtual GUI::Variant data(const GUI::ModelIndex& index, GUI::ModelRole role = GUI::ModelRole::Display) const override
    {
        if (role == GUI::ModelRole::Display) {
            return key(index);
        }

        return {};
    }

    DeprecatedString key(const GUI::ModelIndex& index) const { return m_keys[index.row()]; }

    void set_from(JsonObject const& object)
    {
        m_keys.clear();
        object.for_each_member([this](auto& name, auto&) {
            m_keys.append(name);
        });
        AK::quick_sort(m_keys);
        invalidate();
    }

private:
    HelpListModel()
    {
    }

    Vector<DeprecatedString> m_keys;
};

RefPtr<HelpWindow> HelpWindow::s_the { nullptr };

HelpWindow::HelpWindow(GUI::Window* parent)
    : GUI::Window(parent)
{
    resize(530, 365);
    set_title("Spreadsheet Functions Help");
    set_icon(Gfx::Bitmap::load_from_file("/res/icons/16x16/app-help.png"sv).release_value_but_fixme_should_propagate_errors());

    auto widget = set_main_widget<GUI::Widget>().release_value_but_fixme_should_propagate_errors();
    widget->set_layout<GUI::VerticalBoxLayout>();
    widget->set_fill_with_background_color(true);

    auto& splitter = widget->add<GUI::HorizontalSplitter>();
    auto& left_frame = splitter.add<GUI::Frame>();
    left_frame.set_layout<GUI::VerticalBoxLayout>();
    // FIXME: Get rid of the magic number, dynamically calculate initial size based on left frame contents
    left_frame.set_preferred_width(100);
    m_listview = left_frame.add<GUI::ListView>();
    m_listview->set_activates_on_selection(true);
    m_listview->set_model(HelpListModel::create());

    m_webview = splitter.add<WebView::OutOfProcessWebView>();
    m_webview->on_link_click = [this](auto& url, auto&, auto&&) {
        VERIFY(url.scheme() == "spreadsheet");
        if (url.host().template has<String>() && url.host().template get<String>() == "example"sv) {
            auto example_path = url.serialize_path();
            auto entry = LexicalPath::basename(example_path);
            auto doc_option = m_docs.get_object(entry);
            if (!doc_option.has_value()) {
                GUI::MessageBox::show_error(this, DeprecatedString::formatted("No documentation entry found for '{}'", example_path));
                return;
            }
            auto& doc = doc_option.value();
            auto name = url.fragment();

            auto maybe_example_data = doc.get_object("example_data"sv);
            if (!maybe_example_data.has_value()) {
                GUI::MessageBox::show_error(this, DeprecatedString::formatted("No example data found for '{}'", example_path));
                return;
            }
            auto& example_data = maybe_example_data.value();

            if (!example_data.has_object(name)) {
                GUI::MessageBox::show_error(this, DeprecatedString::formatted("Example '{}' not found for '{}'", name, example_path));
                return;
            }
            auto& value = example_data.get_object(name).value();

            auto window = GUI::Window::construct(this);
            window->resize(size());
            window->set_icon(icon());
            window->set_title(DeprecatedString::formatted("Spreadsheet Help - Example {} for {}", name, entry));
            window->on_close = [window = window.ptr()] { window->remove_from_parent(); };

            auto widget = window->set_main_widget<SpreadsheetWidget>(window, Vector<NonnullRefPtr<Sheet>> {}, false).release_value_but_fixme_should_propagate_errors();
            auto sheet = Sheet::from_json(value, widget->workbook());
            if (!sheet) {
                GUI::MessageBox::show_error(this, DeprecatedString::formatted("Corrupted example '{}' in '{}'", name, example_path));
                return;
            }

            widget->add_sheet(sheet.release_nonnull());
            window->show();
        } else if (url.host() == String::from_utf8_short_string("doc"sv)) {
            auto entry = LexicalPath::basename(url.serialize_path());
            m_webview->load(URL::create_with_data("text/html"sv, render(entry)));
        } else {
            dbgln("Invalid spreadsheet action domain '{}'", url.serialized_host().release_value_but_fixme_should_propagate_errors());
        }
    };

    m_listview->on_activation = [this](auto& index) {
        if (!m_webview)
            return;

        auto key = static_cast<HelpListModel*>(m_listview->model())->key(index);
        m_webview->load(URL::create_with_data("text/html"sv, render(key)));
    };
}

DeprecatedString HelpWindow::render(StringView key)
{
    VERIFY(m_docs.has_object(key));
    auto& doc = m_docs.get_object(key).value();

    auto name = doc.get_deprecated_string("name"sv).value_or({});
    auto argc = doc.get_u32("argc"sv).value_or(0);
    VERIFY(doc.has_array("argnames"sv));
    auto& argnames = doc.get_array("argnames"sv).value();

    auto docstring = doc.get_deprecated_string("doc"sv).value_or({});

    StringBuilder markdown_builder;

    markdown_builder.append("# NAME\n`"sv);
    markdown_builder.append(name);
    markdown_builder.append("`\n\n"sv);

    markdown_builder.append("# ARGUMENTS\n"sv);
    if (argc > 0)
        markdown_builder.appendff("{} required argument(s):\n", argc);
    else
        markdown_builder.append("No required arguments.\n"sv);

    for (size_t i = 0; i < argc; ++i)
        markdown_builder.appendff("- `{}`\n", argnames.at(i).to_deprecated_string());

    if (argc > 0)
        markdown_builder.append("\n"sv);

    if ((size_t)argnames.size() > argc) {
        auto opt_count = argnames.size() - argc;
        markdown_builder.appendff("{} optional argument(s):\n", opt_count);
        for (size_t i = argc; i < (size_t)argnames.size(); ++i)
            markdown_builder.appendff("- `{}`\n", argnames.at(i).to_deprecated_string());
        markdown_builder.append("\n"sv);
    }

    markdown_builder.append("# DESCRIPTION\n"sv);
    markdown_builder.append(docstring);
    markdown_builder.append("\n\n"sv);

    if (doc.has("examples"sv)) {
        auto examples = doc.get_object("examples"sv);
        VERIFY(examples.has_value());
        markdown_builder.append("# EXAMPLES\n"sv);
        examples->for_each_member([&](auto& text, auto& description_value) {
            dbgln("```js\n{}\n```\n\n- {}\n", text, description_value.to_deprecated_string());
            markdown_builder.appendff("```js\n{}\n```\n\n- {}\n", text, description_value.to_deprecated_string());
        });
    }

    auto document = Markdown::Document::parse(markdown_builder.string_view());
    return document->render_to_html();
}

void HelpWindow::set_docs(JsonObject&& docs)
{
    m_docs = move(docs);
    static_cast<HelpListModel*>(m_listview->model())->set_from(m_docs);
    m_listview->update();
}
}