Slic3r::CapabilityConfigDocument Class Reference

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

Collaboration diagram for Slic3r::CapabilityConfigDocument:

Public Member Functions
std::optional< CapabilityConfigEntry >	find (const PluginCapabilityId &id) const
bool	contains (const PluginCapabilityId &id) const
bool	upsert (CapabilityConfigEntry entry)
bool	erase (const PluginCapabilityId &id)
bool	prune_unreferenced (const std::set< std::pair< PluginCapabilityType, std::string > > &referenced)
bool	empty () const
nlohmann::json	serialize_entries () const
nlohmann::json	root_json () const

Static Public Member Functions
static CapabilityConfigDocument	from_root_json (const nlohmann::json &root)
static CapabilityConfigDocument	from_entries (const nlohmann::json &entries)

Static Public Attributes
static constexpr const char *	KeyEntries = "config"

Private Attributes
std::map< PluginCapabilityId, nlohmann::json >	m_entries
std::vector< nlohmann::json >	m_opaque_entries

Detailed Description

Member Function Documentation

contains()

bool Slic3r::CapabilityConfigDocument::contains

(

const PluginCapabilityId &

id

)

const

{
    return find(id).has_value();
}

References find().

Here is the call graph for this function:

empty()

bool Slic3r::CapabilityConfigDocument::empty

(

)

const

{
    return m_entries.empty() && m_opaque_entries.empty();
}

References m_entries, and m_opaque_entries.

Referenced by Slic3r::serialize_plugin_overrides().

Here is the caller graph for this function:

erase()

bool Slic3r::CapabilityConfigDocument::erase

(

const PluginCapabilityId &

id

)

{
    bool erased = m_entries.erase(id) != 0;
    if (id.type != PluginCapabilityType::Unknown)
        erased = m_entries.erase({PluginCapabilityType::Unknown, id.name, id.plugin_key}) != 0 || erased;
    return erased;
}

References m_entries, and Slic3r::Unknown.

Referenced by Slic3r::PresetPluginConfigService::remove_preset_override().

Here is the caller graph for this function:

find()

std::optional< CapabilityConfigEntry > Slic3r::CapabilityConfigDocument::find

(

const PluginCapabilityId &

id

)

const

{
    const auto it = m_entries.find(id);
    if (it != m_entries.end())
        return decode_entry(it->first, it->second);
 
    // Legacy config.json entries have no capability type. Keep them addressable by the new
    // typed API until that capability is saved again.
    if (id.type != PluginCapabilityType::Unknown) {
        const auto legacy = m_entries.find({PluginCapabilityType::Unknown, id.name, id.plugin_key});
        if (legacy != m_entries.end())
            return decode_entry(id, legacy->second);
    }
    return std::nullopt;
}

References m_entries, and Slic3r::Unknown.

Referenced by contains(), from_root_json(), Slic3r::PresetPluginConfigService::get_effective_config(), and Slic3r::PresetPluginConfigService::set_preset_override().

Here is the caller graph for this function:

from_entries()

CapabilityConfigDocument Slic3r::CapabilityConfigDocument::from_entries ( const nlohmann::json & entries )

static

{
    CapabilityConfigDocument document;
    if (!entries.is_array())
        return document;
 
    for (const nlohmann::json& entry : entries) {
        PluginCapabilityId id;
        if (is_recognized_entry(entry, id) || (!id.plugin_key.empty() && !id.name.empty()))
            document.m_entries[id] = entry;
        else
            document.m_opaque_entries.push_back(entry);
    }
 
    return document;
}

References m_entries, and m_opaque_entries.

Referenced by from_root_json(), and Slic3r::parse_plugin_overrides().

Here is the caller graph for this function:

from_root_json()

CapabilityConfigDocument Slic3r::CapabilityConfigDocument::from_root_json ( const nlohmann::json & root )

static

{
    const auto entries = root.find(KeyEntries);
    return entries != root.end() ? from_entries(*entries) : CapabilityConfigDocument();
}

References find(), from_entries(), and KeyEntries.

Referenced by Slic3r::PluginConfig::load().

Here is the call graph for this function:

Here is the caller graph for this function:

prune_unreferenced()

bool Slic3r::CapabilityConfigDocument::prune_unreferenced

(

const std::set< std::pair< PluginCapabilityType, std::string > > &

referenced

)

{
    bool changed = false;
    for (auto it = m_entries.begin(); it != m_entries.end();) {
        if (referenced.count({it->first.type, it->first.name}) != 0) {
            ++it;
        } else {
            it      = m_entries.erase(it);
            changed = true;
        }
    }
    return changed;
}

References m_entries.

Referenced by Slic3r::prune_stale_plugin_overrides().

Here is the caller graph for this function:

root_json()

nlohmann::json Slic3r::CapabilityConfigDocument::root_json

(

)

const

{
    nlohmann::json root = nlohmann::json::object();
    root[KeyEntries] = serialize_entries();
    return root;
}

References KeyEntries, and serialize_entries().

Here is the call graph for this function:

serialize_entries()

nlohmann::json Slic3r::CapabilityConfigDocument::serialize_entries

(

)

const

{
    nlohmann::json result = nlohmann::json::array();
    for (const auto& item : m_entries)
        result.push_back(item.second);
    for (const nlohmann::json& entry : m_opaque_entries)
        result.push_back(entry);
    return result;
}

References m_entries, and m_opaque_entries.

Referenced by root_json(), and Slic3r::serialize_plugin_overrides().

Here is the caller graph for this function:

upsert()

bool Slic3r::CapabilityConfigDocument::upsert

(

CapabilityConfigEntry

entry

)

{
    if (entry.id.empty())
        return false;
 
    if (entry.id.type != PluginCapabilityType::Unknown)
        m_entries.erase({PluginCapabilityType::Unknown, entry.id.name, entry.id.plugin_key});
 
    nlohmann::json serialized = nlohmann::json::object();
    const auto existing       = m_entries.find(entry.id);
    if (existing != m_entries.end() && existing->second.is_object())
        serialized = existing->second;
 
    serialized[KEY_PLUGIN]     = entry.id.plugin_key;
    serialized[KEY_CAPABILITY] = entry.id.name;
    serialized[KEY_TYPE]       = plugin_capability_type_to_string(entry.id.type);
    serialized[KEY_VERSION]    = entry.plugin_version;
    serialized[KEY_CAP_CONFIG] = entry.config;
 
    m_entries[entry.id] = std::move(serialized);
    return true;
}

References Slic3r::CapabilityConfigEntry::config, Slic3r::PluginCapabilityId::empty(), Slic3r::CapabilityConfigEntry::id, m_entries, Slic3r::PluginCapabilityId::name, Slic3r::plugin_capability_type_to_string(), Slic3r::PluginCapabilityId::plugin_key, Slic3r::CapabilityConfigEntry::plugin_version, Slic3r::PluginCapabilityId::type, and Slic3r::Unknown.

Referenced by Slic3r::PresetPluginConfigService::set_preset_override().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

KeyEntries

const char* Slic3r::CapabilityConfigDocument::KeyEntries = "config"

staticconstexpr

Referenced by from_root_json(), Slic3r::PluginConfig::load(), and root_json().

m_entries

std::map<PluginCapabilityId, nlohmann::json> Slic3r::CapabilityConfigDocument::m_entries

private

Referenced by empty(), erase(), find(), from_entries(), prune_unreferenced(), serialize_entries(), and upsert().

m_opaque_entries

std::vector<nlohmann::json> Slic3r::CapabilityConfigDocument::m_opaque_entries

private

Referenced by empty(), from_entries(), and serialize_entries().

---

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

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