content_registry.hpp

Go to the documentation of this file.

#pragma once

 
#include <pulp/state/content_capability_manifest.hpp>
#include <pulp/state/content_install_limits.hpp>
#include <pulp/state/preset_manager.hpp>
 
#include <filesystem>
#include <optional>
#include <string>
#include <string_view>
#include <vector>
 
namespace pulp::state {

struct ContentPackInfo {
    std::string id;
    std::string name;
    std::string version;
    std::filesystem::path root;
    std::vector<std::string> kinds;
    std::vector<std::string> capabilities;
    std::vector<std::filesystem::path> presets;
    std::vector<std::filesystem::path> themes;
    std::vector<std::filesystem::path> samples;
    std::vector<std::filesystem::path> sample_banks;
    std::vector<std::filesystem::path> wavetables;
};
 
enum class ContentReloadPolicy { hot_reload, manual_rescan, restart_required };
 
struct ContentInstallPolicy {
    std::string kind;
    ContentReloadPolicy policy = ContentReloadPolicy::restart_required;
};
 
struct ContentInstallPreview {
    bool ok = false;
    ContentPackInfo pack;
    ContentCapabilityManifest plugin;
    std::filesystem::path source;
    std::filesystem::path install_root;
    std::vector<ContentInstallPolicy> policies;
    std::vector<std::string> issues;
};
 
struct ContentInstallResult {
    bool ok = false;
    ContentInstallPreview preview;
    std::vector<std::string> issues;
};

class ContentRegistry {
  public:
    explicit ContentRegistry(std::filesystem::path data_root = platform_data_root());
 
    static std::filesystem::path platform_data_root();
    static std::filesystem::path content_root_for_data_root(const std::filesystem::path& data_root);
 
    const std::filesystem::path& data_root() const {
        return data_root_;
    }
    std::filesystem::path content_root() const;

    std::vector<ContentPackInfo> packs_for_plugin(const std::string& plugin_id) const;

    std::vector<ContentPackInfo> packs_for_plugin(const ContentCapabilityManifest& manifest) const;

    std::vector<PresetInfo> presets_for_plugin(const ContentCapabilityManifest& manifest) const;
 
  private:
    std::filesystem::path data_root_;
};

ContentPresetSource content_registry_preset_source();

ContentInstallPreview preview_content_pack_install(
    const std::filesystem::path& input, const ContentCapabilityManifest& plugin,
    const std::filesystem::path& data_root = ContentRegistry::platform_data_root(),
    const ContentInstallLimits& limits = {});

ContentInstallResult
install_content_pack(const std::filesystem::path& input, const ContentCapabilityManifest& plugin,
                     const std::filesystem::path& data_root = ContentRegistry::platform_data_root(),
                     bool approved = false, const ContentInstallLimits& limits = {});
 
const char* to_string(ContentReloadPolicy policy);
 
} // namespace pulp::state