Slic3r::PluginPage Class Reference

#include </home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/plugin/host/PluginPages.hpp>

Inheritance diagram for Slic3r::PluginPage:

Collaboration diagram for Slic3r::PluginPage:

Public Member Functions
	PluginPage (wxWindow *parent, std::shared_ptr< PagesPluginCapability > capability)
	~PluginPage () override
	PluginPage ()=delete
void	detach_capability ()
void	push_message (const std::string &message)

Protected Member Functions
std::optional< std::string >	page_html () override
bool	on_page_message (const std::string &kind, const nlohmann::json &data) override
wxWebView *	browser () const
void	post_to_page (const std::string &json)

Private Member Functions
void	on_new_window (wxWebViewEvent &event)
void	on_load_event (wxWebViewEvent &event)
void	on_navigated (wxWebViewEvent &event)
void	on_script_message (wxWebViewEvent &event)
void	on_webview_recreated (wxCommandEvent &event)
void	apply_theme ()
void	load_page_html ()

Private Attributes
std::shared_ptr< PagesPluginCapability >	m_cap
std::shared_ptr< std::atomic< PluginPage * > >	m_lifetime
wxWebView *	m_browser {nullptr}
bool	m_content_loaded {false}
bool	m_own_page_load {false}
bool	m_content_navigated {false}

Detailed Description

Constructor & Destructor Documentation

PluginPage() [1/2]

Slic3r::PluginPage::PluginPage	(	wxWindow *	parent,
		std::shared_ptr< PagesPluginCapability >	capability )

    : GUI::WebPanel(parent, PLUGIN_PAGE_BRIDGE_JS)
    , m_cap(std::move(capability))
    , m_lifetime(std::make_shared<std::atomic<PluginPage*>>(this))
{
    browser()->Bind(wxEVT_WEBVIEW_NEWWINDOW, &PluginPage::on_new_window, this);
 
    const std::shared_ptr<std::atomic<PluginPage*>> lifetime = m_lifetime;
    m_cap->set_message_sender([lifetime](const std::string& message) {
        if (wxTheApp == nullptr)
            return;
 
        GUI::wxGetApp().CallAfter([lifetime, message] {
            if (PluginPage* page = lifetime->load(std::memory_order_acquire))
                page->push_message(message);
        });
    });
 
}

References PluginPage(), Slic3r::GUI::WebPanel::WebPanel(), Slic3r::GUI::WebPanel::browser(), m_cap, m_lifetime, and on_new_window().

Referenced by PluginPage().

Here is the call graph for this function:

Here is the caller graph for this function:

~PluginPage()

Slic3r::PluginPage::~PluginPage ( )

override

{
    detach_capability();
    if (m_lifetime)
        m_lifetime->store(nullptr, std::memory_order_release);
}

References detach_capability(), and m_lifetime.

Here is the call graph for this function:

PluginPage() [2/2]

Slic3r::PluginPage::PluginPage ( )

delete

Member Function Documentation

apply_theme()

void Slic3r::GUI::WebPanel::apply_theme ( )

privateinherited

{
    WebView::RunScript(m_browser, wxString::FromUTF8(WebViewHostDialog::theme_apply_script()));
}

References m_browser, WebView::RunScript(), and Slic3r::GUI::WebViewHostDialog::theme_apply_script().

Referenced by on_load_event(), and on_webview_recreated().

Here is the call graph for this function:

Here is the caller graph for this function:

browser()

wxWebView * Slic3r::GUI::WebPanel::browser ( ) const

inlineprotectedinherited

{ return m_browser; }

References m_browser.

Referenced by Slic3r::GUI::DockPanel::DockPanel(), Slic3r::PluginPage::PluginPage(), and Slic3r::PluginPage::on_new_window().

Here is the caller graph for this function:

detach_capability()

void Slic3r::PluginPage::detach_capability

(

)

{
    if (m_lifetime)
        m_lifetime->store(nullptr, std::memory_order_release);
    if (m_cap)
        m_cap->clear_message_sender();
    m_cap.reset();
}

References m_cap, and m_lifetime.

Referenced by ~PluginPage(), and page_html().

Here is the caller graph for this function:

load_page_html()

void Slic3r::GUI::WebPanel::load_page_html ( )

privateinherited

{
    if (const std::optional<std::string> html = page_html()) {
        m_own_page_load = true;
        m_browser->SetPage(wxString::FromUTF8(*html), web_hosting::content_base_url());
    }
}

References Slic3r::GUI::web_hosting::content_base_url(), m_browser, m_own_page_load, and page_html().

Referenced by on_load_event().

Here is the call graph for this function:

Here is the caller graph for this function:

on_load_event()

void Slic3r::GUI::WebPanel::on_load_event ( wxWebViewEvent & event )

privateinherited

{
    const bool loaded = event.GetEventType() == wxEVT_WEBVIEW_LOADED;
    if (!m_content_loaded) {
        // The first bootstrap load (or its error) triggers the swap to the plugin HTML.
        m_content_loaded = true;
        load_page_html();
    } else if (!web_hosting::is_content_url(event.GetURL())) {
        // Not our document (a linked page, a substituted error page), or any document on Edge, which ignores
        // the base URL and restores SetPage content on a reload itself; either way it takes the app theme.
        if (loaded)
            apply_theme();
    } else if (m_own_page_load) {
        m_own_page_load = false;
        // The document-start theme script is fixed at creation, so re-apply the app theme.
        if (loaded)
            apply_theme();
    } else if (loaded && m_content_navigated) {
        // WebKit reloads the SetPage base URL, so a committed load of it that we did not start is a
        // reload. A failed navigation is reported against the page that stayed but never commits.
        load_page_html();
    }
    if (loaded)
        m_content_navigated = false;
    event.Skip();
}

References apply_theme(), Slic3r::GUI::web_hosting::is_content_url(), load_page_html(), m_content_loaded, m_content_navigated, and m_own_page_load.

Referenced by WebPanel().

Here is the call graph for this function:

Here is the caller graph for this function:

on_navigated()

void Slic3r::GUI::WebPanel::on_navigated ( wxWebViewEvent & event )

privateinherited

{
    m_content_navigated = web_hosting::is_content_url(event.GetURL());
    event.Skip();
}

References Slic3r::GUI::web_hosting::is_content_url(), and m_content_navigated.

Referenced by WebPanel().

Here is the call graph for this function:

Here is the caller graph for this function:

on_new_window()

void Slic3r::PluginPage::on_new_window ( wxWebViewEvent & event )

private

{
    const wxString url = event.GetURL();
    if (!url.empty())
        browser()->LoadURL(url);
    event.Veto();
}

References Slic3r::GUI::WebPanel::browser().

Referenced by PluginPage().

Here is the call graph for this function:

Here is the caller graph for this function:

on_page_message()

bool Slic3r::PluginPage::on_page_message ( const std::string & kind, const nlohmann::json & data )

overrideprotectedvirtual

Implements Slic3r::GUI::WebPanel.

{
    if (kind != "message")
        return false;
    if (!m_cap)
        return true;
 
    try {
        m_cap->on_message(data.dump(-1, ' ', false, nlohmann::json::error_handler_t::replace));
    } catch (const std::exception& error) {
        BOOST_LOG_TRIVIAL(error) << "Plugin page message handler failed for '" << m_cap->name() << "': " << error.what();
    } catch (...) {
        BOOST_LOG_TRIVIAL(error) << "Plugin page message handler failed for '" << m_cap->name() << "'";
    }
    return true;
}

References m_cap.

on_script_message()

void Slic3r::GUI::WebPanel::on_script_message ( wxWebViewEvent & event )

privateinherited

{
    const nlohmann::json payload = nlohmann::json::parse(event.GetString().utf8_string(), nullptr, false);
    if (!payload.is_object() || payload.value("channel", std::string()) != "orca")
        return;
 
    const std::string kind = payload.value("kind", std::string());
    if (!on_page_message(kind, payload.contains("data") ? payload["data"] : nlohmann::json()))
        BOOST_LOG_TRIVIAL(warning) << "WebPanel ignored a window.orca '" << kind << "' call; this host does not support it";
}

References on_page_message().

Referenced by WebPanel().

Here is the call graph for this function:

Here is the caller graph for this function:

on_webview_recreated()

void Slic3r::GUI::WebPanel::on_webview_recreated ( wxCommandEvent & event )

privateinherited

{
    SetBackgroundColour(wxGetApp().get_window_default_clr());
    m_browser->SetBackgroundColour(GetBackgroundColour());
    Refresh();
    // Handled without Skip(), so WebView::RecreateAll() does not reload the plugin page.
    apply_theme();
}

References apply_theme(), and m_browser.

Referenced by WebPanel().

Here is the call graph for this function:

Here is the caller graph for this function:

page_html()

std::optional< std::string > Slic3r::PluginPage::page_html ( )

overrideprotectedvirtual

Implements Slic3r::GUI::WebPanel.

{
    if (m_cap == nullptr)
        return std::nullopt;
 
    try {
        return m_cap->get_ui();
    } catch (const std::exception& error) {
        BOOST_LOG_TRIVIAL(error) << "Failed to load plugin page '" << m_cap->name() << "': " << error.what();
    } catch (...) {
        BOOST_LOG_TRIVIAL(error) << "Failed to load plugin page '" << m_cap->name() << "'";
    }
    detach_capability();
    return std::nullopt;
}

References detach_capability(), and m_cap.

Here is the call graph for this function:

post_to_page()

void Slic3r::GUI::WebPanel::post_to_page ( const std::string & json )

protectedinherited

{
    WebView::RunScript(m_browser, wxString::Format(
        "(function dispatch(payload, attempts) {\n"
        "  if (typeof window.__orcaDispatch === 'function') { window.__orcaDispatch(payload); return; }\n"
        "  if (attempts < 100) window.setTimeout(function() { dispatch(payload, attempts + 1); }, 25);\n"
        "})({data: %s}, 0);",
        wxString::FromUTF8(json)));
}

References m_browser, and WebView::RunScript().

Referenced by Slic3r::GUI::DockPanel::push_message(), and Slic3r::PluginPage::push_message().

Here is the call graph for this function:

Here is the caller graph for this function:

push_message()

void Slic3r::PluginPage::push_message

(

const std::string &

message

)

{
    // PagesPluginCapability::post_message() already dumps JSON, so accept it as-is; only a
    // non-JSON payload needs wrapping as a string literal.
    post_to_page(nlohmann::json::accept(message)
                     ? message
                     : nlohmann::json(message).dump(-1, ' ', false, nlohmann::json::error_handler_t::replace));
}

References Slic3r::GUI::WebPanel::post_to_page().

Here is the call graph for this function:

Member Data Documentation

m_browser

wxWebView* Slic3r::GUI::WebPanel::m_browser {nullptr}

privateinherited

{nullptr};

Referenced by WebPanel(), apply_theme(), browser(), load_page_html(), on_webview_recreated(), and post_to_page().

m_cap

std::shared_ptr<PagesPluginCapability> Slic3r::PluginPage::m_cap

private

Referenced by PluginPage(), detach_capability(), on_page_message(), and page_html().

m_content_loaded

bool Slic3r::GUI::WebPanel::m_content_loaded {false}

privateinherited

{false};

Referenced by on_load_event().

m_content_navigated

bool Slic3r::GUI::WebPanel::m_content_navigated {false}

privateinherited

{false}; // a navigation to the base URL has committed

Referenced by on_load_event(), and on_navigated().

m_lifetime

std::shared_ptr<std::atomic<PluginPage*> > Slic3r::PluginPage::m_lifetime

private

Referenced by PluginPage(), ~PluginPage(), and detach_capability().

m_own_page_load

bool Slic3r::GUI::WebPanel::m_own_page_load {false}

privateinherited

{false};   // a SetPage of the plugin HTML is in flight

Referenced by load_page_html(), and on_load_event().

---

The documentation for this class was generated from the following files:

• /home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/plugin/host/PluginPages.hpp
• /home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/plugin/host/PluginPages.cpp