collection.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: © 2020-2021 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
 
#ifndef __PLUGINS_PLUGIN_COLLECTION_H__
#define __PLUGINS_PLUGIN_COLLECTION_H__
 
#include "plugins/plugin_descriptor.h"
#include "utils/yaml.h"
 
#define PLUGIN_COLLECTION_SCHEMA_VERSION 1
 
typedef struct PluginCollection
{
  int schema_version;
 
  char * name;
 
  char * description;
 
  PluginDescriptor ** descriptors;
  int                 num_descriptors;
  size_t              descriptors_size;
} PluginCollection;
 
static const cyaml_schema_field_t plugin_collection_fields_schema[] = {
  YAML_FIELD_INT (PluginCollection, schema_version),
  YAML_FIELD_STRING_PTR (PluginCollection, name),
  YAML_FIELD_STRING_PTR_OPTIONAL (PluginCollection, description),
  YAML_FIELD_DYN_PTR_ARRAY_VAR_COUNT (
    PluginCollection,
    descriptors,
    plugin_descriptor_schema),
 
  CYAML_FIELD_END
};
 
static const cyaml_schema_value_t plugin_collection_schema = {
  YAML_VALUE_PTR (PluginCollection, plugin_collection_fields_schema),
};
 
void
plugin_collection_init_loaded (PluginCollection * self);
 
PluginCollection *
plugin_collection_new (void);
 
PluginCollection *
plugin_collection_clone (const PluginCollection * self);
 
char *
plugin_collection_get_name (PluginCollection * self);
 
void
plugin_collection_set_name (PluginCollection * self, const char * name);
 
NONNULL bool
plugin_collection_contains_descriptor (
  PluginCollection *       self,
  const PluginDescriptor * descr,
  bool                     match_pointer);
 
void
plugin_collection_add_descriptor (
  PluginCollection *       self,
  const PluginDescriptor * descr);
 
void
plugin_collection_remove_descriptor (
  PluginCollection *       self,
  const PluginDescriptor * descr);
 
GMenuModel *
plugin_collection_generate_context_menu (const PluginCollection * self);
 
void
plugin_collection_clear (PluginCollection * self);
 
void
plugin_collection_free (PluginCollection * self);
 
#endif