module.c File Reference

Definition of the Hcache Module. More...

#include "config.h"
#include <stdbool.h>
#include <stddef.h>
#include "mutt/lib.h"
#include "config/lib.h"
#include "core/lib.h"
#include "module_data.h"

Include dependency graph for module.c:

Go to the source code of this file.

Functions
static bool	hcache_init (struct NeoMutt *n)
	Initialise a Module - Implements Module::init()
static bool	hcache_config_define_variables (struct NeoMutt *n, struct ConfigSet *cs)
	Define the Config Variables - Implements Module::config_define_variables()
static bool	hcache_cleanup (struct NeoMutt *n, void *data)
	Clean up a Module - Implements Module::cleanup()

Variables
struct ConfigDef	HcacheVars []
	Config definitions for the Header Cache.
struct ConfigDef	HcacheVarsComp []
	Config definitions for the Header Cache Compression.
const struct Module	ModuleHcache
	Module for the Hcache library.

Detailed Description

Definition of the Hcache Module.

Authors

• Richard Russon

Copyright

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Definition in file module.c.

Function Documentation

hcache_init()

static bool hcache_init ( struct NeoMutt * n )

static

Initialise a Module - Implements Module::init()

Definition at line 43 of file module.c.

{
  struct HcacheModuleData *mod_data = MUTT_MEM_CALLOC(1, struct HcacheModuleData);
  neomutt_set_module_data(n, MODULE_ID_HCACHE, mod_data);
 
  mod_data->notify = notify_new();
  notify_set_parent(mod_data->notify, n->notify);
 
  return true;
}

Here is the call graph for this function:

hcache_config_define_variables()

static bool hcache_config_define_variables ( struct NeoMutt * n, struct ConfigSet * cs )

static

Define the Config Variables - Implements Module::config_define_variables()

Definition at line 57 of file module.c.

{
  bool rc = true;
 
  rc &= cs_register_variables(cs, HcacheVars);
 
#if defined(USE_HCACHE_COMPRESSION)
  rc &= cs_register_variables(cs, HcacheVarsComp);
#endif
 
  return rc;
}

Here is the call graph for this function:

hcache_cleanup()

static bool hcache_cleanup ( struct NeoMutt * n, void * data )

static

Clean up a Module - Implements Module::cleanup()

Definition at line 73 of file module.c.

{
  struct HcacheModuleData *mod_data = data;
 
  notify_free(&mod_data->notify);
 
  FREE(&mod_data);
  return true;
}

Here is the call graph for this function:

Variable Documentation

HcacheVars

struct ConfigDef HcacheVars[]

extern

Config definitions for the Header Cache.

Definition at line 169 of file config.c.

                                {
  // clang-format off
  { "header_cache", DT_PATH, 0, 0, hcache_validator,
    "(hcache) Directory/file for the header cache database"
  },
  { "header_cache_backend", DT_STRING, 0, 0, hcache_backend_validator,
    "(hcache) Header cache backend to use"
  },
  { NULL },
  // clang-format on
};

HcacheVarsComp

struct ConfigDef HcacheVarsComp[]

extern

Config definitions for the Header Cache Compression.

Definition at line 185 of file config.c.

                                    {
  // clang-format off
  // These two are not in alphabetical order because `level`s validator depends on `method`
  { "header_cache_compress_method", DT_STRING, 0, 0, compress_method_validator,
    "(hcache) Enable generic hcache database compression"
  },
  { "header_cache_compress_level", DT_NUMBER|D_INTEGER_NOT_NEGATIVE, 1, 0, compress_level_validator,
    "(hcache) Level of compression for method"
  },
  { NULL },
  // clang-format on
};

ModuleHcache

const struct Module ModuleHcache

Initial value:

= {
  MODULE_ID_HCACHE,
  "hcache",
  hcache_init,
  NULL, 
  hcache_config_define_variables,
  NULL, 
  NULL, 
  NULL, 
  hcache_cleanup,
}

Module for the Hcache library.

Definition at line 86 of file module.c.

                                   {
  MODULE_ID_HCACHE,
  "hcache",
  hcache_init,
  NULL, // config_define_types
  hcache_config_define_variables,
  NULL, // commands_register
  NULL, // gui_init
  NULL, // gui_cleanup
  hcache_cleanup,
};