Slic3r::VendorCacheFile Class Reference

#include </home/runner/work/OrcaSlicer/OrcaSlicer/src/libslic3r/PresetCacheFormat.hpp>

Static Public Member Functions
static bool	save (const std::string &path, const std::string &vendor_name, const std::string &vendor_version, const VendorCacheData &data)
static bool	load (const std::string &path, const std::string &expected_vendor_name, const Semver &expected_vendor_version, VendorCacheData &data)
static bool	load_vendor_profile (const std::string &path, const std::string &expected_vendor_name, const Semver &expected_vendor_version, VendorProfile &vendor)
static std::string	peek_version (const std::string &path, const std::string &expected_vendor_name)
static Semver	usable_version (const std::string &path, const std::string &expected_vendor_name)
static bool	carries_preset (const std::string &path, const std::string &vendor_name, Preset::Type type, const std::string &preset_name)

Detailed Description

Member Function Documentation

carries_preset()

bool Slic3r::VendorCacheFile::carries_preset ( const std::string & path, const std::string & vendor_name, Preset::Type type, const std::string & preset_name )

static

{
    std::string blob;
    if (! read_cache_blob(path, blob))
        return false;
    try {
        boost::iostreams::stream<boost::iostreams::array_source> body(blob.data(), blob.size());
        cereal::BinaryInputArchive ar(body);
        if (read_cache_stamps(ar, vendor_name).empty())
            return false;
        CacheDictionary dict;
        dict.load(ar);
        VendorMap vendors;
        ar(vendors);
        // Reused: every entry overwrites it, and only its name is ever looked at.
        CachedPreset entry;
        // Written in this order by save. The list that could carry the preset
        // is the last one worth reading.
        for (Preset::Type kind : { Preset::TYPE_PRINT, Preset::TYPE_FILAMENT, Preset::TYPE_PRINTER }) {
            uint32_t cnt = 0;
            ar(cnt);
            for (uint32_t i = 0; i < cnt; ++ i) {
                visit_entry(ar, entry, [&] { skip_config(ar, dict); });
                if (kind == type && entry.name == preset_name)
                    return true;
            }
            if (kind == type)
                return false;
        }
        return false;
    } catch (const std::exception& e) {
        BOOST_LOG_TRIVIAL(warning) << "VendorCacheFile: could not read preset names from " << path << ": " << e.what();
        return false;
    }
}

References Slic3r::empty(), Slic3r::CacheDictionary::load(), Slic3r::CachedPreset::name, Slic3r::skip_config(), Slic3r::Preset::TYPE_FILAMENT, Slic3r::Preset::TYPE_PRINT, and Slic3r::Preset::TYPE_PRINTER.

Referenced by Slic3r::PresetBundle::find_preset_vendor().

Here is the call graph for this function:

Here is the caller graph for this function:

load()

bool Slic3r::VendorCacheFile::load ( const std::string & path, const std::string & expected_vendor_name, const Semver & expected_vendor_version, VendorCacheData & data )

static

{
    return read_cache_up_to_presets(path, expected_vendor_name, expected_vendor_version, data.vendors,
        [&data](cereal::BinaryInputArchive& ar, const CacheDictionary& dict) {
            load_entries(ar, data.process_entries, dict);
            load_entries(ar, data.filament_entries, dict);
            load_entries(ar, data.machine_entries, dict);
            ar(data.parse_errors);
        });
}

References Slic3r::read_cache_up_to_presets(), and Slic3r::VendorCacheData::vendors.

Referenced by Slic3r::PresetBundle::load_vendor_cache(), and Slic3r::PresetBundle::read_vendor().

Here is the call graph for this function:

Here is the caller graph for this function:

load_vendor_profile()

bool Slic3r::VendorCacheFile::load_vendor_profile ( const std::string & path, const std::string & expected_vendor_name, const Semver & expected_vendor_version, VendorProfile & vendor )

static

{
    VendorMap vendors;
    if (! read_cache_up_to_presets(path, expected_vendor_name, expected_vendor_version, vendors,
                                   [](cereal::BinaryInputArchive&, const CacheDictionary&) {}))
        return false;
    vendor = std::move(vendors.find(expected_vendor_name)->second);
    return true;
}

References Slic3r::read_cache_up_to_presets().

Referenced by Slic3r::PresetBundle::read_vendor().

Here is the call graph for this function:

Here is the caller graph for this function:

peek_version()

std::string Slic3r::VendorCacheFile::peek_version ( const std::string & path, const std::string & expected_vendor_name )

static

{
    try {
        boost::nowide::ifstream ifs(path, std::ios::binary);
        CacheFileHeader fhdr;
        if (! ifs.read(reinterpret_cast<char*>(&fhdr), sizeof(fhdr)) || fhdr.magic != CACHE_MAGIC)
            return {};
        // Only the head of the body is read, and its CRC left unverified: the
        // stamps sit at the front, and this answers "what version is this?"
        // without paying for tens of megabytes. Callers that need to know the
        // file is whole use usable_version instead.
        std::string head(static_cast<size_t>(std::min<uint64_t>(fhdr.data_size, 1024)), '\0');
        if (! ifs.read(&head[0], static_cast<std::streamsize>(head.size())))
            return {};
        std::istringstream body(head, std::ios::binary);
        cereal::BinaryInputArchive ar(body);
        return read_cache_stamps(ar, expected_vendor_name);
    } catch (const std::exception&) {
        return {};
    }
}

Referenced by Slic3r::GUI::GuideFrame::BuildProfileDataFromVendors(), and Slic3r::installable_cache_version().

Here is the caller graph for this function:

save()

bool Slic3r::VendorCacheFile::save ( const std::string & path, const std::string & vendor_name, const std::string & vendor_version, const VendorCacheData & data )

static

{
    try {
        // Collected before anything is written: the dictionary sits ahead of the
        // entries so a reader resolves it once and then indexes.
        CacheDictionary dict;
        for (const std::vector<CachedPreset>* entries : { &data.process_entries, &data.filament_entries, &data.machine_entries })
            for (const CachedPreset& e : *entries)
                dict.collect(e.config_src);
 
        std::ostringstream body(std::ios::binary);
        {
            cereal::BinaryOutputArchive ar(body);
            ar(CACHE_VERSION);
            ar(vendor_name, vendor_version);
            dict.save(ar);
            ar(data.vendors);
            save_entries(ar, data.process_entries, dict);
            save_entries(ar, data.filament_entries, dict);
            save_entries(ar, data.machine_entries, dict);
            ar(data.parse_errors);
        }
        return write_cache_blob(path, body.str());
    } catch (const std::exception& e) {
        BOOST_LOG_TRIVIAL(warning) << "VendorCacheFile: failed to save vendor cache " << path << ": " << e.what();
        return false;
    }
}

References Slic3r::CacheDictionary::collect(), Slic3r::VendorCacheData::filament_entries, Slic3r::VendorCacheData::machine_entries, Slic3r::VendorCacheData::parse_errors, Slic3r::VendorCacheData::process_entries, Slic3r::CacheDictionary::save(), and Slic3r::VendorCacheData::vendors.

Referenced by Slic3r::PresetBundle::install_vendor_read().

Here is the call graph for this function:

Here is the caller graph for this function:

usable_version()

Semver Slic3r::VendorCacheFile::usable_version ( const std::string & path, const std::string & expected_vendor_name )

static

{
    std::string blob;
    if (! read_cache_blob(path, blob))
        return Semver::invalid();
    try {
        boost::iostreams::stream<boost::iostreams::array_source> body(blob.data(), blob.size());
        cereal::BinaryInputArchive ar(body);
        const auto ver = Semver::parse(read_cache_stamps(ar, expected_vendor_name));
        return ver ? *ver : Semver::invalid();
    } catch (const std::exception&) {
        return Semver::invalid();
    }
}

References Slic3r::Semver::invalid(), and Slic3r::Semver::parse().

Referenced by Slic3r::PresetUpdater::priv::get_config_updates(), Slic3r::install_vendor_bundles_from_resources(), Slic3r::installed_vendor_version(), and Slic3r::is_vendor_installed().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• /home/runner/work/OrcaSlicer/OrcaSlicer/src/libslic3r/PresetCacheFormat.hpp
• /home/runner/work/OrcaSlicer/OrcaSlicer/src/libslic3r/PresetCacheFormat.cpp