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

Collaboration diagram for Slic3r::PluginDescriptor:

Public Member Functions
bool	is_cloud_plugin () const
std::string	cloud_uuid () const
bool	has_local_package () const
bool	is_metadata_valid () const
bool	is_invalid_package () const
std::string	normalized_error () const
bool	has_error () const
PluginUpdateStatus	get_update_status () const
bool	has_update_available () const
bool	is_unauthorized () const
std::string	latest_available_version () const
void	set_metadata_valid (bool is_valid)
void	set_unauthorized (bool unauthorized)
void	clear_error ()
void	set_error (std::string message)

Public Attributes
std::string	plugin_key
std::string	name
std::string	description
std::string	author
std::string	version
std::string	latest_version
std::string	installed_version
std::vector< std::string >	display_types
std::string	plugin_root
std::string	entry_path
std::string	entry_package
std::vector< std::string >	dependencies
std::vector< PluginChangelog >	changelog
std::string	error
std::optional< CloudPluginState >	cloud
bool	metadata_valid = false
bool	install_state_valid = false
bool	enabled = false
std::string	sharing_token
std::string	thumbnail_url

Detailed Description

Member Function Documentation

◆ clear_error()

void Slic3r::PluginDescriptor::clear_error ( )

inline

145{ error.clear(); }

Slic3r::PluginDescriptor::error

std::string error

Definition PluginDescriptor.hpp:68

References error.

Referenced by Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::as_cloud_only_descriptor(), Slic3r::PluginManager::clear_cloud_plugin_metadata(), Slic3r::PluginManager::clear_plugin_error(), Slic3r::PluginManager::download_and_install_cloud_plugin(), Slic3r::PluginManager::fetch_plugins_from_cloud(), Slic3r::plugin_loader::install_plugin(), Slic3r::PluginManager::keep_installed_plugin_as_local(), Slic3r::plugin_loader::load(), Slic3r::anonymous_namespace{PluginFsUtils.cpp}::scan_plugin_directory(), and Slic3r::PluginManager::update_cloud_metadata().

Here is the caller graph for this function:

◆ cloud_uuid()

std::string Slic3r::PluginDescriptor::cloud_uuid ( ) const

inline

83{ return cloud.has_value() ? cloud->uuid : std::string{}; }

Slic3r::PluginDescriptor::cloud

std::optional< CloudPluginState > cloud

Definition PluginDescriptor.hpp:69

References cloud.

Referenced by Slic3r::anonymous_namespace{PluginFsUtils.cpp}::apply_install_metadata(), Slic3r::anonymous_namespace{PluginFsUtils.cpp}::assign_discovered_plugin_key(), Slic3r::CloudPluginService::download_cloud_plugin(), Slic3r::CloudPluginService::fetch_plugin_changelog(), Slic3r::PluginManager::fetch_plugins_from_cloud(), Slic3r::plugin_hooks::anonymous_namespace{PluginHooks.cpp}::install_capability_resolver(), Slic3r::plugin_loader::install_plugin(), Slic3r::anonymous_namespace{NetworkAgentFactory.cpp}::plugin_printer_agent_full_ref(), Slic3r::CloudPluginService::request_cloud_unsubscribe(), and Slic3r::PluginAuditDetail::seed_install_metadata().

Here is the caller graph for this function:

◆ get_update_status()

PluginUpdateStatus Slic3r::PluginDescriptor::get_update_status ( ) const

inline

    {
        if (!cloud.has_value())
            return PluginUpdateStatus::Normal;
        if (cloud->orphaned)
            return PluginUpdateStatus::Normal;
        if (cloud->unauthorized)
            return PluginUpdateStatus::Unauthorized;
        if (cloud->update_available)
            return PluginUpdateStatus::UpdateAvailable;
        return PluginUpdateStatus::Normal;
    }

References cloud, Slic3r::Normal, Slic3r::Unauthorized, and Slic3r::UpdateAvailable.

Referenced by Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::build_plugin_dialog_item(), has_update_available(), and is_unauthorized().

Here is the caller graph for this function:

◆ has_error()

bool Slic3r::PluginDescriptor::has_error ( ) const

inline

105{ return !normalized_error().empty(); }

Slic3r::PluginDescriptor::normalized_error

std::string normalized_error() const

Definition PluginDescriptor.hpp:95

References normalized_error().

Referenced by Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::build_plugin_dialog_item(), Slic3r::plugin_loader::load(), Slic3r::GUI::PluginsDialog::resolve_pending_activation(), and set_metadata_valid().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ has_local_package()

bool Slic3r::PluginDescriptor::has_local_package ( ) const

inline

84{ return !is_cloud_plugin() || cloud->installed || !plugin_root.empty() || !entry_path.empty(); }

Slic3r::PluginDescriptor::entry_path

std::string entry_path

Definition PluginDescriptor.hpp:63

Slic3r::PluginDescriptor::is_cloud_plugin

bool is_cloud_plugin() const

Definition PluginDescriptor.hpp:82

Slic3r::PluginDescriptor::plugin_root

std::string plugin_root

Definition PluginDescriptor.hpp:62

References cloud, entry_path, is_cloud_plugin(), and plugin_root.

Referenced by Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::build_plugin_dialog_item(), Slic3r::PluginManager::finalize_cloud_plugin_removal(), is_invalid_package(), Slic3r::refresh_missing_plugins(), Slic3r::GUI::PluginsDialog::reinstall_cloud_plugin(), Slic3r::resolve_inactive_plugins(), Slic3r::PluginManager::subscribe_and_install_cloud_plugin(), Slic3r::GUI::PluginsDialog::toggle_plugin(), Slic3r::PluginManager::update_cloud_metadata(), and Slic3r::PluginManager::update_cloud_plugin().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ has_update_available()

bool Slic3r::PluginDescriptor::has_update_available ( ) const

inline

120{ return get_update_status() == PluginUpdateStatus::UpdateAvailable; }

Slic3r::PluginDescriptor::get_update_status

PluginUpdateStatus get_update_status() const

Definition PluginDescriptor.hpp:107

References get_update_status(), and Slic3r::UpdateAvailable.

Here is the call graph for this function:

◆ is_cloud_plugin()

bool Slic3r::PluginDescriptor::is_cloud_plugin ( ) const

inline

82{ return cloud.has_value(); }

References cloud.

Here is the caller graph for this function:

◆ is_invalid_package()

bool Slic3r::PluginDescriptor::is_invalid_package ( ) const

inline

93{ return !metadata_valid && has_local_package(); }

Slic3r::PluginDescriptor::metadata_valid

bool metadata_valid

Definition PluginDescriptor.hpp:70

Slic3r::PluginDescriptor::has_local_package

bool has_local_package() const

Definition PluginDescriptor.hpp:84

References has_local_package(), and metadata_valid.

Referenced by Slic3r::GUI::PluginsDialog::get_descriptor(), Slic3r::PluginManager::load_plugin(), and Slic3r::PluginManager::try_get_valid_plugin_descriptor().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ is_metadata_valid()

bool Slic3r::PluginDescriptor::is_metadata_valid ( ) const

inline

85{ return metadata_valid; }

References metadata_valid.

Referenced by Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::build_plugin_dialog_item(), Slic3r::PluginManager::clear_plugin_error(), Slic3r::plugin_loader::load(), and Slic3r::PluginManager::update_cloud_metadata().

Here is the caller graph for this function:

◆ is_unauthorized()

bool Slic3r::PluginDescriptor::is_unauthorized ( ) const

inline

121{ return get_update_status() == PluginUpdateStatus::Unauthorized; }

References get_update_status(), and Slic3r::Unauthorized.

Referenced by Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::build_plugin_dialog_item().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ latest_available_version()

std::string Slic3r::PluginDescriptor::latest_available_version ( ) const

inline

    {
        if (!latest_version.empty())
            return latest_version;
        return version;
    }

References latest_version, and version.

Referenced by Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::build_plugin_dialog_item(), and Slic3r::PluginManager::update_cloud_plugin().

Here is the caller graph for this function:

◆ normalized_error()

std::string Slic3r::PluginDescriptor::normalized_error ( ) const

inline

    {
        auto begin = std::find_if_not(error.begin(), error.end(), [](unsigned char ch) { return std::isspace(ch) != 0; });
        if (begin == error.end())
            return {};
 
        auto end = std::find_if_not(error.rbegin(), error.rend(), [](unsigned char ch) { return std::isspace(ch) != 0; }).base();
        return std::string(begin, end);
    }

References error.

Referenced by Slic3r::GUI::anonymous_namespace{PluginsDialog.cpp}::build_plugin_dialog_item(), Slic3r::PluginManager::clear_cloud_plugin_metadata(), Slic3r::PluginManager::fetch_plugins_from_cloud(), has_error(), Slic3r::plugin_loader::load(), Slic3r::PluginManager::load_plugin(), and Slic3r::PluginManager::update_cloud_metadata().

Here is the caller graph for this function:

◆ set_error()

void Slic3r::PluginDescriptor::set_error ( std::string message )

inline

146{ error = std::move(message); }

References error.

Referenced by Slic3r::anonymous_namespace{PluginFsUtils.cpp}::scan_plugin_directory(), and Slic3r::PluginManager::set_plugin_error().

Here is the caller graph for this function:

◆ set_metadata_valid()

void Slic3r::PluginDescriptor::set_metadata_valid ( bool is_valid )

inline

    {
        metadata_valid = is_valid;
        if (!is_valid && !has_error())
            error = "Plugin metadata is invalid.";
    }

References error, has_error(), and metadata_valid.

Referenced by Slic3r::plugin_loader::install_plugin(), and Slic3r::anonymous_namespace{PluginFsUtils.cpp}::scan_plugin_directory().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ set_unauthorized()

void Slic3r::PluginDescriptor::set_unauthorized ( bool unauthorized )

inline

    {
        if (!cloud.has_value())
            return;
        cloud->unauthorized = unauthorized;
        if (unauthorized)
            cloud->update_available = false;
    }