config.c File Reference

Config used by libhcache. More...

#include "config.h"
#include <stddef.h>
#include <stdbool.h>
#include "mutt/lib.h"
#include "config/lib.h"
#include "lib.h"
#include "compress/lib.h"
#include "store/lib.h"
#include "init.h"

Include dependency graph for config.c:

Go to the source code of this file.

Functions
int	hcache_validator (const struct ConfigSet *cs, const struct ConfigDef *cdef, intptr_t value, struct Buffer *err)
	Validate the "header_cache_backend" config variable - Implements ConfigDef::validator() More...
int	compress_method_validator (const struct ConfigSet *cs, const struct ConfigDef *cdef, intptr_t value, struct Buffer *err)
	Validate the "header_cache_compress_method" config variable - Implements ConfigDef::validator() More...
int	compress_level_validator (const struct ConfigSet *cs, const struct ConfigDef *cdef, intptr_t value, struct Buffer *err)
	Validate the "header_cache_compress_level" config variable - Implements ConfigDef::validator() More...
bool	config_init_hcache (struct ConfigSet *cs)
	Register hcache config variables - Implements module_init_config_t. More...

Variables
char *	C_HeaderCache
	Config: (hcache) Directory/file for the header cache database. More...
char *	C_HeaderCacheBackend
	Config: (hcache) Header cache backend to use. More...
short	C_HeaderCacheCompressLevel
	Config: (hcache) Level of compression for method. More...
char *	C_HeaderCacheCompressMethod
	Config: (hcache) Enable generic hcache database compression. More...
bool	C_HeaderCacheCompress = false
long	C_HeaderCachePagesize = 0
struct ConfigDef	HcacheVars []

Detailed Description

Config used by libhcache.

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 config.c.

Function Documentation

hcache_validator()

int hcache_validator	(	const struct ConfigSet *	cs,
		const struct ConfigDef *	cdef,
		intptr_t	value,
		struct Buffer *	err
	)

Validate the "header_cache_backend" config variable - Implements ConfigDef::validator()

Definition at line 56 of file config.c.

{
  if (value == 0)
    return CSR_SUCCESS;

  const char *str = (const char *) value;

  if (store_is_valid_backend(str))
    return CSR_SUCCESS;

  mutt_buffer_printf(err, _("Invalid value for option %s: %s"), cdef->name, str);
  return CSR_ERR_INVALID;
}

Here is the call graph for this function:

compress_method_validator()

int compress_method_validator	(	const struct ConfigSet *	cs,
		const struct ConfigDef *	cdef,
		intptr_t	value,
		struct Buffer *	err
	)

Validate the "header_cache_compress_method" config variable - Implements ConfigDef::validator()

Definition at line 75 of file config.c.

{
  if (value == 0)
    return CSR_SUCCESS;

  const char *str = (const char *) value;

  if (compress_get_ops(str))
    return CSR_SUCCESS;

  mutt_buffer_printf(err, _("Invalid value for option %s: %s"), cdef->name, str);
  return CSR_ERR_INVALID;
}

Here is the call graph for this function:

compress_level_validator()

int compress_level_validator	(	const struct ConfigSet *	cs,
		const struct ConfigDef *	cdef,
		intptr_t	value,
		struct Buffer *	err
	)

Validate the "header_cache_compress_level" config variable - Implements ConfigDef::validator()

Definition at line 93 of file config.c.

{
  if (!C_HeaderCacheCompressMethod)
  {
    mutt_buffer_printf(err, _("Set option %s before setting %s"),
                       "header_cache_compress_method", cdef->name);
    return CSR_ERR_INVALID;
  }

  const struct ComprOps *cops = compress_get_ops(C_HeaderCacheCompressMethod);
  if (!cops)
  {
    mutt_buffer_printf(err, _("Invalid value for option %s: %s"),
                       "header_cache_compress_method", C_HeaderCacheCompressMethod);
    return CSR_ERR_INVALID;
  }

  if ((value < cops->min_level) || (value > cops->max_level))
  {
    // L10N: This applies to the "$header_cache_compress_level" config variable.
    //       It shows the minimum and maximum values, e.g. 'between 1 and 22'
    mutt_buffer_printf(err, _("Option %s must be between %d and %d inclusive"),
                       cdef->name, cops->min_level, cops->max_level);
    return CSR_ERR_INVALID;
  }

  return CSR_SUCCESS;
}

Here is the call graph for this function:

config_init_hcache()

bool config_init_hcache

(

struct ConfigSet *

cs

)

Register hcache config variables - Implements module_init_config_t.

Definition at line 153 of file config.c.

{
  return cs_register_variables(cs, HcacheVars, 0);
}

Here is the call graph for this function:

Variable Documentation

C_HeaderCache

char* C_HeaderCache

Config: (hcache) Directory/file for the header cache database.

Definition at line 40 of file config.c.

C_HeaderCacheBackend

char* C_HeaderCacheBackend

Config: (hcache) Header cache backend to use.

Definition at line 41 of file config.c.

C_HeaderCacheCompressLevel

short C_HeaderCacheCompressLevel

Config: (hcache) Level of compression for method.

Definition at line 43 of file config.c.

C_HeaderCacheCompressMethod

char* C_HeaderCacheCompressMethod

Config: (hcache) Enable generic hcache database compression.

Definition at line 44 of file config.c.

C_HeaderCacheCompress

bool C_HeaderCacheCompress = false

Definition at line 48 of file config.c.

C_HeaderCachePagesize

long C_HeaderCachePagesize = 0

Definition at line 50 of file config.c.

HcacheVars

struct ConfigDef HcacheVars[]

Initial value:

= {
  
  { "header_cache", DT_PATH, &C_HeaderCache, 0, 0, NULL,
    "(hcache) Directory/file for the header cache database"
  },
  { "header_cache_backend", DT_STRING, &C_HeaderCacheBackend, 0, 0, hcache_validator,
    "(hcache) Header cache backend to use"
  },

  { "header_cache_compress_level", DT_NUMBER|DT_NOT_NEGATIVE, &C_HeaderCacheCompressLevel, 1, 0, compress_level_validator,
    "(hcache) Level of compression for method"
  },
  { "header_cache_compress_method", DT_STRING, &C_HeaderCacheCompressMethod, 0, 0, compress_method_validator,
    "(hcache) Enable generic hcache database compression"
  },


  { "header_cache_compress", DT_DEPRECATED|DT_BOOL, &C_HeaderCacheCompress, false, 0, NULL, NULL },


  { "header_cache_pagesize", DT_DEPRECATED|DT_LONG, &C_HeaderCachePagesize, 0, 0, NULL, NULL },

  { NULL, 0, NULL, 0, 0, NULL, NULL },
  
}

Definition at line 124 of file config.c.