cached_plugin_descriptors.h

Go to the documentation of this file.

// clang-format off
// SPDX-FileCopyrightText: © 2020-2021, 2024 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
// clang-format on
 
#ifndef __PLUGINS_CACHED_PLUGIN_DESCRIPTORS_H__
#define __PLUGINS_CACHED_PLUGIN_DESCRIPTORS_H__
 
#include "plugins/plugin_descriptor.h"
#include "utils/yaml.h"
 
#define CACHED_PLUGIN_DESCRIPTORS_SCHEMA_VERSION 4
 
typedef struct CachedPluginDescriptors
{
  int schema_version;
 
  PluginDescriptor * descriptors[90000];
  int                num_descriptors;
 
  PluginDescriptor * blacklisted[90000];
  int                num_blacklisted;
} CachedPluginDescriptors;
 
static const cyaml_schema_field_t cached_plugin_descriptors_fields_schema[] = {
  YAML_FIELD_INT (CachedPluginDescriptors, schema_version),
  YAML_FIELD_FIXED_SIZE_PTR_ARRAY_VAR_COUNT (
    CachedPluginDescriptors,
    descriptors,
    plugin_descriptor_schema),
  YAML_FIELD_FIXED_SIZE_PTR_ARRAY_VAR_COUNT (
    CachedPluginDescriptors,
    blacklisted,
    plugin_descriptor_schema),
 
  CYAML_FIELD_END
};
 
static const cyaml_schema_value_t cached_plugin_descriptors_schema = {
  YAML_VALUE_PTR (
    CachedPluginDescriptors,
    cached_plugin_descriptors_fields_schema),
};
 
CachedPluginDescriptors *
cached_plugin_descriptors_new (void);
 
void
cached_plugin_descriptors_serialize_to_file (CachedPluginDescriptors * self);
 
bool
cached_plugin_descriptors_is_blacklisted (
  CachedPluginDescriptors * self,
  const char *              sha1);
 
NONNULL_ARGS (1)
unsigned int cached_plugin_descriptors_find (
  CachedPluginDescriptors * self,
  GPtrArray *               arr,
  const PluginDescriptor *  descr,
  const char *              sha1,
  bool                      check_valid,
  bool                      check_blacklisted);
 
PluginDescriptor **
cached_plugin_descriptors_get (
  CachedPluginDescriptors * self,
  const char *              abs_path);
 
void
cached_plugin_descriptors_blacklist (
  CachedPluginDescriptors * self,
  const char *              sha1,
  bool                      _serialize);
 
void
cached_plugin_descriptors_replace (
  CachedPluginDescriptors * self,
  const PluginDescriptor *  _new_descr,
  bool                      _serialize);
 
void
cached_plugin_descriptors_add (
  CachedPluginDescriptors * self,
  const PluginDescriptor *  descr,
  int                       _serialize);
 
void
cached_plugin_descriptors_clear (CachedPluginDescriptors * self);
 
void
cached_plugin_descriptors_free (CachedPluginDescriptors * self);
 
#endif