plugin_collections.h

// SPDX-FileCopyrightText: © 2020-2021, 2023-2025 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
 
#pragma once
 
#include <vector>
 
#include "plugins/plugin_descriptor.h"

 
namespace zrythm::gui::old_dsp::plugins
{

class PluginCollection final
{
public:
  using PluginDescriptor = zrythm::plugins::PluginDescriptor;
 
  std::string get_name () const { return name_; }
 
  void set_name (std::string_view name) { name_ = name; }
 
  void clear () { descriptors_.clear (); }

  bool contains_descriptor (const PluginDescriptor &descr) const;

  void add_descriptor (const PluginDescriptor &descr);

  void remove_descriptor (const PluginDescriptor &descr);

  // Glib::RefPtr<Gio::MenuModel> generate_context_menu () const;
 
  friend void init_from (
    PluginCollection       &obj,
    const PluginCollection &other,
    utils::ObjectCloneType  clone_type);
 
private:
  static constexpr auto kNameKey = "name"sv;
  static constexpr auto kDescriptionKey = "description"sv;
  static constexpr auto kDescriptorsKey = "descriptors"sv;
  friend void           to_json (nlohmann::json &j, const PluginCollection &p)
  {
    j = nlohmann::json{
      { kNameKey,        p.name_        },
      { kDescriptionKey, p.description_ },
      { kDescriptorsKey, p.descriptors_ },
    };
  }
  friend void from_json (const nlohmann::json &j, PluginCollection &p)
  {
    j.at (kNameKey).get_to (p.name_);
    j.at (kDescriptionKey).get_to (p.description_);
    j.at (kDescriptorsKey).get_to (p.descriptors_);
  }
 
public:
  std::string name_;

  std::string description_;

  std::vector<std::unique_ptr<PluginDescriptor>> descriptors_;
};

class PluginCollections
{
public:
  static std::unique_ptr<PluginCollections> read_or_new ();

  void serialize_to_file () const;

  void serialize_to_file_no_throw () const
  {
    try
      {
        serialize_to_file ();
      }
    catch (const ZrythmException &e)
      {
        z_warning (e.what ());
      }
  }
 
  std::string get_document_type () const { return "Zrythm Plugin Collections"; }
  int         get_format_major_version () const { return 3; }
  int         get_format_minor_version () const { return 0; }

  void add (const PluginCollection &collection, bool serialize);

  const PluginCollection * find_from_name (std::string_view name) const;

  void remove (PluginCollection &collection, bool serialize);
 
private:
  static constexpr auto kCollectionsKey = "collections"sv;
  friend void           to_json (nlohmann::json &j, const PluginCollections &pc)
  {
    j[kCollectionsKey] = pc.collections_;
  }
  friend void from_json (const nlohmann::json &j, PluginCollections &pc)
  {
    j.at (kCollectionsKey).get_to (pc.collections_);
  }

  static void delete_file ();
 
  static fs::path get_file_path ();
 
public:
  std::vector<std::unique_ptr<PluginCollection>> collections_;
};
 
} // namespace zrythm::gui::old_dsp::plugins