Inheritance diagram for Slic3r::GUI::anonymous_namespace{ActionRegistry.cpp}::PluginScriptAction:

Collaboration diagram for Slic3r::GUI::anonymous_namespace{ActionRegistry.cpp}::PluginScriptAction:

Public Member Functions
	PluginScriptAction (std::string plugin_key_in, std::string capability_in, std::string source_name)
AppActionRunResult	run (const std::string &) const override
const std::string &	id () const
const std::string &	title () const
const std::string &	source_key () const
const std::string &	source_name () const

Static Public Member Functions
static std::string	id_for (const std::string &plugin_key, const std::string &capability)
static std::string	compose_id (std::string_view prefix, std::string_view title, std::string_view source_key)

Public Attributes
std::string	plugin_key
std::string	capability
bool	favourite = false
int	count = 0
long long	last = 0
AppActionKind	kind = AppActionKind::Plugin
std::string	group
std::string	input
std::string	icon
ConfigOptionMode	required_mode = comSimple
std::string	tooltip
std::string	full_label
std::string	title_en
std::string	group_en
std::string	source_en
std::string	full_label_en
std::string	help_url

Static Public Attributes
static constexpr const char *	kIdPrefix = "plugin_script_action"

Private Attributes
std::string	m_id
std::string	m_title
std::string	m_source_key
std::string	m_source_name

Detailed Description

Constructor & Destructor Documentation

◆ PluginScriptAction()

Slic3r::GUI::anonymous_namespace{ActionRegistry.cpp}::PluginScriptAction::PluginScriptAction	(	std::string	plugin_key_in,
		std::string	capability_in,
		std::string	source_name )

inline

        : AppAction(kIdPrefix,
                    capability_in.empty() ? plugin_key_in : capability_in, // title
                    plugin_key_in,                                         // source_key
                    std::move(source_name))
        , plugin_key(std::move(plugin_key_in))
        , capability(std::move(capability_in))
    {}

References Slic3r::GUI::AppAction::AppAction(), capability, Slic3r::empty(), kIdPrefix, plugin_key, and Slic3r::GUI::AppAction::source_name().

Here is the call graph for this function:

Member Function Documentation

◆ compose_id()

std::string Slic3r::GUI::AppAction::compose_id	(	std::string_view	prefix,
		std::string_view	title,
		std::string_view	source_key )

inlinestaticinherited

    {
        std::string out;
        out.reserve(prefix.size() + title.size() + source_key.size() + 2);
        out.append(prefix).append(1, ':').append(title).append(1, ':').append(source_key);
        return out;
    }

References source_key(), and title().

Referenced by AppAction(), Slic3r::GUI::anonymous_namespace{NativeCommands.cpp}::CommandAction::CommandAction(), Slic3r::GUI::anonymous_namespace{ActionRegistry.cpp}::PlateAction::id_for(), Slic3r::GUI::anonymous_namespace{ActionRegistry.cpp}::PluginPageAction::id_for(), Slic3r::GUI::anonymous_namespace{ActionRegistry.cpp}::PluginScriptAction::id_for(), and Slic3r::GUI::anonymous_namespace{ActionRegistry.cpp}::RecentProjectAction::id_for().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ id()

const std::string & Slic3r::GUI::AppAction::id ( ) const

inlineinherited

52{ return m_id; }

Slic3r::GUI::AppAction::m_id

std::string m_id

Definition ActionRegistry.hpp:126

References m_id.

Referenced by AppAction(), Slic3r::GUI::action_json(), and Slic3r::GUI::ActionRegistry::seed_state().

Here is the caller graph for this function:

◆ id_for()

std::string Slic3r::GUI::anonymous_namespace{ActionRegistry.cpp}::PluginScriptAction::id_for	(	const std::string &	plugin_key,
		const std::string &	capability )

inlinestatic

156 { return AppAction::compose_id(kIdPrefix, capability.empty() ? plugin_key : capability, plugin_key); }

Slic3r::GUI::AppAction::compose_id

static std::string compose_id(std::string_view prefix, std::string_view title, std::string_view source_key)

Definition ActionRegistry.hpp:60

References capability, Slic3r::GUI::AppAction::compose_id(), kIdPrefix, and plugin_key.

Here is the call graph for this function:

◆ run()

AppActionRunResult Slic3r::GUI::anonymous_namespace{ActionRegistry.cpp}::PluginScriptAction::run ( const std::string & ) const

inlineoverridevirtual

Implements Slic3r::GUI::AppAction.

    {
        struct Outcome
        {
            bool               async     = false;
            bool               completed = false;
            AppActionRunResult result;
        };
        auto outcome = std::make_shared<Outcome>();
 
        auto on_done = [outcome](const ScriptCompletion& completion) {
            outcome->result    = script_outcome_to_action_result(completion);
            outcome->completed = true;
            if (outcome->async)
                notify_script_outcome(completion);
        };
 
        const PluginManager::ScriptLaunchResult launch = PluginManager::instance().launch_script_capability(plugin_key, capability, on_done);
        if (launch.launched_async) {
            // The completion is delivered on this (GUI) thread once the (sync or async) invocation
            // finishes, so marking `async` here cannot race with on_done. The speed dial has already
            // shown a result by then; the final outcome arrives as a notification (a cancellation is
            // silent).
            outcome->async = true;
            if (outcome->completed)
                return outcome->result;
            return {AppActionRunResult::Level::Info, _L("Script plugin started.")};
        }
 
        // The launch failed inline; on_done produced the (error) result.
        on_done(launch.outcome);
        return outcome->result;
    }