set.h File Reference

A collection of config items. More...

#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
#include "mutt/lib.h"
#include "types.h"

Include dependency graph for set.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	ConfigDef
struct	ConfigSetType
struct	ConfigSet
	Container for lots of config items. More...

Macros
#define	CSR_SUCCESS   0
	Action completed successfully.
#define	CSR_ERR_CODE   1
	Problem with the code.
#define	CSR_ERR_UNKNOWN   2
	Unrecognised config item.
#define	CSR_ERR_INVALID   3
	Value hasn't been set.
#define	CSR_SUC_INHERITED   (1 << 4)
	Value is inherited.
#define	CSR_SUC_EMPTY   (1 << 5)
	Value is empty/unset.
#define	CSR_SUC_WARNING   (1 << 6)
	Notify the user of a warning.
#define	CSR_SUC_NO_CHANGE   (1 << 7)
	The value hasn't changed.
#define	CSR_INV_TYPE   (1 << 4)
	Value is not valid for the type.
#define	CSR_INV_VALIDATOR   (1 << 5)
	Value was rejected by the validator.
#define	CSV_INV_NOT_IMPL   (1 << 6)
	Operation not permitted for the type.
#define	CSR_RESULT_MASK   0x0F
	Mask to extract the result code from CSR_* flags.
#define	CSR_RESULT(x)
	Extract the result code from CSR_* flags.
#define	IP   (intptr_t)

Functions
struct ConfigSet *	cs_new (size_t size)
	Create a new Config Set.
void	cs_free (struct ConfigSet **ptr)
	Free a Config Set.
struct HashElem *	cs_get_base (struct HashElem *he)
	Find the root Config Item.
struct HashElem *	cs_get_elem (const struct ConfigSet *cs, const char *name)
	Get the HashElem representing a config item.
const struct ConfigSetType *	cs_get_type_def (const struct ConfigSet *cs, unsigned int type)
	Get the definition for a type.
bool	cs_register_type (struct ConfigSet *cs, const struct ConfigSetType *cst)
	Register a type of config item.
struct HashElem *	cs_register_variable (const struct ConfigSet *cs, struct ConfigDef *cdef, struct Buffer *err)
	Register one config item.
bool	cs_register_variables (const struct ConfigSet *cs, struct ConfigDef vars[])
	Register a set of config items.
struct HashElem *	cs_create_variable (const struct ConfigSet *cs, struct ConfigDef *cdef, struct Buffer *err)
	Create and register one config item.
struct HashElem *	cs_inherit_variable (const struct ConfigSet *cs, struct HashElem *he_parent, const char *name)
	Create in inherited config item.
void	cs_uninherit_variable (const struct ConfigSet *cs, const char *name)
	Remove an inherited config item.
bool	cs_he_has_been_set (const struct ConfigSet *cs, struct HashElem *he)
	Is the config value different to its initial value?
int	cs_he_initial_get (const struct ConfigSet *cs, struct HashElem *he, struct Buffer *result)
	Get the initial, or parent, value of a config item.
int	cs_he_initial_set (const struct ConfigSet *cs, struct HashElem *he, const char *value, struct Buffer *err)
	Set the initial value of a config item.
intptr_t	cs_he_native_get (const struct ConfigSet *cs, struct HashElem *he, struct Buffer *err)
	Natively get the value of a HashElem config item.
int	cs_he_native_set (const struct ConfigSet *cs, struct HashElem *he, intptr_t value, struct Buffer *err)
	Natively set the value of a HashElem config item.
int	cs_he_reset (const struct ConfigSet *cs, struct HashElem *he, struct Buffer *err)
	Reset a config item to its initial value.
int	cs_he_string_get (const struct ConfigSet *cs, struct HashElem *he, struct Buffer *result)
	Get a config item as a string.
int	cs_he_string_minus_equals (const struct ConfigSet *cs, struct HashElem *he, const char *value, struct Buffer *err)
	Remove from a config item by string.
int	cs_he_string_plus_equals (const struct ConfigSet *cs, struct HashElem *he, const char *value, struct Buffer *err)
	Add to a config item by string.
int	cs_he_string_set (const struct ConfigSet *cs, struct HashElem *he, const char *value, struct Buffer *err)
	Set a config item by string.
int	cs_he_delete (const struct ConfigSet *cs, struct HashElem *he, struct Buffer *err)
	Delete config item from a config set.
bool	cs_str_has_been_set (const struct ConfigSet *cs, const char *name)
	Is the config value different to its initial value?
int	cs_str_initial_get (const struct ConfigSet *cs, const char *name, struct Buffer *result)
	Get the initial, or parent, value of a config item.
int	cs_str_native_set (const struct ConfigSet *cs, const char *name, intptr_t value, struct Buffer *err)
	Natively set the value of a string config item.
int	cs_str_reset (const struct ConfigSet *cs, const char *name, struct Buffer *err)
	Reset a config item to its initial value.
int	cs_str_string_set (const struct ConfigSet *cs, const char *name, const char *value, struct Buffer *err)
	Set a config item by string.
static bool	startup_only (const struct ConfigDef *cdef, struct Buffer *err)
	Validator function for D_ON_STARTUP.

Variables
bool	StartupComplete
	When the config has been read.

Detailed Description

A collection of config items.

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 set.h.

Macro Definition Documentation

CSR_SUCCESS

#define CSR_SUCCESS   0

Action completed successfully.

Definition at line 33 of file set.h.

CSR_ERR_CODE

#define CSR_ERR_CODE   1

Problem with the code.

Definition at line 34 of file set.h.

CSR_ERR_UNKNOWN

#define CSR_ERR_UNKNOWN   2

Unrecognised config item.

Definition at line 35 of file set.h.

CSR_ERR_INVALID

#define CSR_ERR_INVALID   3

Value hasn't been set.

Definition at line 36 of file set.h.

CSR_SUC_INHERITED

#define CSR_SUC_INHERITED   (1 << 4)

Value is inherited.

Definition at line 39 of file set.h.

CSR_SUC_EMPTY

#define CSR_SUC_EMPTY   (1 << 5)

Value is empty/unset.

Definition at line 40 of file set.h.

CSR_SUC_WARNING

#define CSR_SUC_WARNING   (1 << 6)

Notify the user of a warning.

Definition at line 41 of file set.h.

CSR_SUC_NO_CHANGE

#define CSR_SUC_NO_CHANGE   (1 << 7)

The value hasn't changed.

Definition at line 42 of file set.h.

CSR_INV_TYPE

#define CSR_INV_TYPE   (1 << 4)

Value is not valid for the type.

Definition at line 45 of file set.h.

CSR_INV_VALIDATOR

#define CSR_INV_VALIDATOR   (1 << 5)

Value was rejected by the validator.

Definition at line 46 of file set.h.

CSV_INV_NOT_IMPL

#define CSV_INV_NOT_IMPL   (1 << 6)

Operation not permitted for the type.

Definition at line 47 of file set.h.

CSR_RESULT_MASK

#define CSR_RESULT_MASK   0x0F

Mask to extract the result code from CSR_* flags.

Definition at line 50 of file set.h.

CSR_RESULT

#define CSR_RESULT

(

x

)

Value:

((x) & CSR_RESULT_MASK)

Extract the result code from CSR_* flags.

Definition at line 52 of file set.h.

IP

#define IP   (intptr_t)

Definition at line 54 of file set.h.

Function Documentation

cs_new()

struct ConfigSet * cs_new

(

size_t

size

)

Create a new Config Set.

Parameters

size	Number of expected config items

Return values

ptr	New ConfigSet object

Definition at line 128 of file set.c.

{
  struct ConfigSet *cs = MUTT_MEM_CALLOC(1, struct ConfigSet);
 
  cs->hash = mutt_hash_new(size, MUTT_HASH_NO_FLAGS);
  mutt_hash_set_destructor(cs->hash, cs_hashelem_free, (intptr_t) cs);
 
  return cs;
}

Here is the call graph for this function:

Here is the caller graph for this function:

cs_free()

void cs_free

(

struct ConfigSet **

ptr

)

Free a Config Set.

Parameters

[out]

ptr

Config items

Definition at line 142 of file set.c.

{
  if (!ptr || !*ptr)
    return;
 
  struct ConfigSet *cs = *ptr;
 
  mutt_hash_free(&cs->hash);
  FREE(ptr);
}

Here is the call graph for this function:

Here is the caller graph for this function:

cs_get_base()

struct HashElem * cs_get_base

(

struct HashElem *

he

)

Find the root Config Item.

Parameters

he	Config Item to examine

Return values

ptr	Root Config Item

Given an inherited HashElem, find the HashElem representing the original Config Item.

Definition at line 161 of file set.c.

{
  if (!(he->type & D_INTERNAL_INHERITED))
    return he;
 
  struct Inheritance *i = he->data;
  return cs_get_base(i->parent);
}

Here is the call graph for this function:

Here is the caller graph for this function:

cs_get_elem()

struct HashElem * cs_get_elem	(	const struct ConfigSet *	cs,
		const char *	name )

Get the HashElem representing a config item.

Parameters

cs	Config items
name	Name of config item

Return values

ptr	HashElem representing the config item

Definition at line 176 of file set.c.

{
  if (!cs || !name)
    return NULL;
 
  struct HashElem *he = mutt_hash_find_elem(cs->hash, name);
  if (!he)
    return NULL;
 
  if (CONFIG_TYPE(he->type) != DT_SYNONYM)
    return he;
 
  const struct ConfigDef *cdef = he->data;
 
  return (struct HashElem *) cdef->var;
}

Here is the call graph for this function:

Here is the caller graph for this function:

cs_get_type_def()

const struct ConfigSetType * cs_get_type_def	(	const struct ConfigSet *	cs,
		unsigned int	type )

Get the definition for a type.

Parameters

cs	Config items
type	Type to lookup, e.g. DT_NUMBER

Return values

ptr	ConfigSetType representing the type

Definition at line 199 of file set.c.

{
  if (!cs)
    return NULL;
 
  type = CONFIG_TYPE(type);
  if (type >= countof(cs->types))
    return NULL; // LCOV_EXCL_LINE
 
  if (!cs->types[type].name)
    return NULL;
 
  return &cs->types[type];
}

Here is the caller graph for this function:

cs_register_type()

bool cs_register_type	(	struct ConfigSet *	cs,
		const struct ConfigSetType *	cst )

Register a type of config item.

Parameters

cs	Config items
cst	Structure defining the type

Return values

true	Type was registered successfully

Definition at line 220 of file set.c.

{
  if (!cs || !cst)
    return false;
 
  if (!cst->name || !cst->string_set || !cst->string_get || !cst->reset ||
      !cst->native_set || !cst->native_get)
  {
    return false;
  }
 
  if (cst->type >= countof(cs->types))
    return false;
 
  if (cs->types[cst->type].name)
    return false; /* already registered */
 
  cs->types[cst->type] = *cst;
  return true;
}

Here is the caller graph for this function:

cs_register_variable()

struct HashElem * cs_register_variable	(	const struct ConfigSet *	cs,
		struct ConfigDef *	cdef,
		struct Buffer *	err )

Register one config item.

Parameters

cs	Config items
cdef	Variable definition
err	Buffer for error messages

Return values

ptr	New HashElem representing the config item

Similar to cs_create_variable() but assumes that cdef lives indefinitely.

Definition at line 250 of file set.c.

{
  if (!cs || !cdef)
    return NULL; /* LCOV_EXCL_LINE */
 
  if (CONFIG_TYPE(cdef->type) == DT_SYNONYM)
    return create_synonym(cs, cdef, err);
 
  const struct ConfigSetType *cst = cs_get_type_def(cs, cdef->type);
  if (!cst)
  {
    buf_printf(err, _("Option %s has an invalid type %d"), cdef->name, cdef->type);
    return NULL;
  }
 
  struct HashElem *he = mutt_hash_typed_insert(cs->hash, cdef->name, cdef->type, cdef);
  if (!he)
    return NULL; /* LCOV_EXCL_LINE */
 
  // Temporarily disable the validator
  // (trust that the hard-coded initial values are sane)
  int (*validator)(const struct ConfigDef *cdef, intptr_t value,
                   struct Buffer *err) = cdef->validator;
  cdef->validator = NULL;
 
  if (cst->reset)
    cst->reset(&cdef->var, cdef, err);
 
  cdef->validator = validator;
 
  return he;
}

Here is the call graph for this function:

Here is the caller graph for this function:

cs_register_variables()

bool cs_register_variables	(	const struct ConfigSet *	cs,
		struct ConfigDef	vars[] )

Register a set of config items.

Parameters

cs	Config items
vars	Variable definition

Return values

true	All variables were registered successfully

Definition at line 290 of file set.c.

{
  if (!cs || !vars)
    return false;
 
  struct Buffer *err = buf_pool_get();
 
  bool rc = true;
 
  for (size_t i = 0; vars[i].name; i++)
  {
    if (!cs_register_variable(cs, &vars[i], err))
    {
      mutt_debug(LL_DEBUG1, "%s\n", buf_string(err));
      rc = false;
    }
  }
 
  buf_pool_release(&err);
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

cs_create_variable()

struct HashElem * cs_create_variable	(	const struct ConfigSet *	cs,
		struct ConfigDef *	cdef,
		struct Buffer *	err )

Create and register one config item.

Parameters

cs	Config items
cdef	Variable definition
err	Buffer for error messages

Return values

ptr	New HashElem representing the config item

Similar to cs_register_variable() but copies the ConfigDef first. Allowing the caller to free it and its parts afterwards.

This function does not know anything about how the internal representation of the type must be handled. Thus, the fields 'initial', 'data', 'var' must be copyable. If they need allocation, then the caller must set them after the variable is created, e.g. with cs_he_initial_set(), cs_he_native_set.

Definition at line 327 of file set.c.

{
  struct ConfigDef *cdef_copy = MUTT_MEM_CALLOC(1, struct ConfigDef);
  cdef_copy->name = mutt_str_dup(cdef->name);
  cdef_copy->type = cdef->type | D_INTERNAL_FREE_CONFIGDEF;
  cdef_copy->initial = cdef->initial;
  cdef_copy->data = cdef->data;
  cdef_copy->validator = cdef->validator;
  cdef_copy->docs = mutt_str_dup(cdef->name);
  cdef_copy->var = cdef->var;
 
  struct HashElem *he = cs_register_variable(cs, cdef_copy, err);
  if (!he)
  {
    FREE(&cdef_copy->name);
    FREE(&cdef_copy->docs);
    FREE(&cdef_copy);
  }
  return he;
}

Here is the call graph for this function:

Here is the caller graph for this function:

cs_inherit_variable()

struct HashElem * cs_inherit_variable	(	const struct ConfigSet *	cs,
		struct HashElem *	he_parent,
		const char *	name )

Create in inherited config item.

Parameters

cs	Config items
he_parent	HashElem of parent config item
name	Name of account-specific config item

Return values

ptr	New HashElem representing the inherited config item

Definition at line 356 of file set.c.

{
  if (!cs || !he_parent)
    return NULL;
 
  /* MyVars cannot be inherited, as they might get deleted */
  if (CONFIG_TYPE(he_parent->type) == DT_MYVAR)
    return NULL;
 
  struct Inheritance *i = MUTT_MEM_CALLOC(1, struct Inheritance);
  i->parent = he_parent;
  i->name = mutt_str_dup(name);
 
  struct HashElem *he = mutt_hash_typed_insert(cs->hash, i->name, D_INTERNAL_INHERITED, i);
  if (!he)
  {
    FREE(&i->name);
    FREE(&i);
  }
 
  return he;
}

Here is the call graph for this function:

Here is the caller graph for this function:

cs_uninherit_variable()

void cs_uninherit_variable	(	const struct ConfigSet *	cs,
		const char *	name )

Remove an inherited config item.

Parameters

cs	Config items
name	Name of config item to remove

Definition at line 385 of file set.c.

{
  if (!cs || !name)
    return;
 
  mutt_hash_delete(cs->hash, name, NULL);
}

Here is the call graph for this function:

Here is the caller graph for this function:

cs_he_has_been_set()

bool cs_he_has_been_set	(	const struct ConfigSet *	cs,
		struct HashElem *	he )

Is the config value different to its initial value?

Parameters

cs	Config items
he	HashElem representing config item

Return values

true	Config has been set
false	Config has not been set

Definition at line 469 of file set.c.

{
  if (!cs || !he)
    return false;
 
  const struct ConfigSetType *cst = cs_get_type_def(cs, he->type);
  if (!cst)
    return false; // LCOV_EXCL_LINE
 
  if (!cst->has_been_set) // Probably a my_var
    return true;
 
  struct ConfigDef *cdef = he->data;
  void *var = &cdef->var;
 
  return cst->has_been_set(var, cdef);
}

Here is the call graph for this function:

Here is the caller graph for this function:

cs_he_initial_get()

int cs_he_initial_get	(	const struct ConfigSet *	cs,
		struct HashElem *	he,
		struct Buffer *	result )

Get the initial, or parent, value of a config item.

Parameters

cs	Config items
he	HashElem representing config item
result	Buffer for results or error messages

Return values

num	Result, e.g. CSR_SUCCESS

If a config item is inherited from another, then this will get the parent's value. Otherwise, it will get the config item's initial value.

Definition at line 558 of file set.c.

{
  if (!cs || !he || !result)
    return CSR_ERR_CODE;
 
  const struct ConfigDef *cdef = NULL;
  const struct ConfigSetType *cst = NULL;
 
  if (he->type & D_INTERNAL_INHERITED)
  {
    struct HashElem *he_base = cs_get_base(he);
    cdef = he_base->data;
    cst = cs_get_type_def(cs, he_base->type);
  }
  else
  {
    cdef = he->data;
    cst = cs_get_type_def(cs, he->type);
  }
 
  if (!cst)
    return CSR_ERR_CODE; // LCOV_EXCL_LINE
 
  return cst->string_get(NULL, cdef, result);
}

Here is the call graph for this function:

Here is the caller graph for this function:

cs_he_initial_set()

int cs_he_initial_set	(	const struct ConfigSet *	cs,
		struct HashElem *	he,
		const char *	value,
		struct Buffer *	err )

Set the initial value of a config item.

Parameters

cs	Config items
he	HashElem representing config item
value	Value to set
err	Buffer for error messages

Return values

num	Result, e.g. CSR_SUCCESS

Definition at line 514 of file set.c.

{
  if (!cs || !he)
    return CSR_ERR_CODE;
 
  struct ConfigDef *cdef = NULL;
 
  if (he->type & D_INTERNAL_INHERITED)
  {
    struct HashElem *he_base = cs_get_base(he);
    cdef = he_base->data;
    mutt_debug(LL_DEBUG1, "Variable '%s' is inherited type\n", cdef->name);
    return CSR_ERR_CODE;
  }
 
  cdef = he->data;
  if (!cdef)
    return CSR_ERR_CODE; // LCOV_EXCL_LINE
 
  const struct ConfigSetType *cst = cs_get_type_def(cs, he->type);
  if (!cst)
  {
    mutt_debug(LL_DEBUG1, "Variable '%s' has an invalid type %d\n", cdef->name, he->type);
    return CSR_ERR_CODE;
  }
 
  int rc = cst->string_set(NULL, cdef, value, err);
  if (CSR_RESULT(rc) != CSR_SUCCESS)
    return rc;
 
  return CSR_SUCCESS;
}

Here is the call graph for this function:

Here is the caller graph for this function:

cs_he_native_get()

intptr_t cs_he_native_get	(	const struct ConfigSet *	cs,
		struct HashElem *	he,
		struct Buffer *	err )

Natively get the value of a HashElem config item.

Parameters

cs	Config items
he	HashElem representing config item
err	Buffer for results or error messages

Return values

intptr_t	Native pointer/value
INT_MIN	Error

Definition at line 842 of file set.c.

{
  if (!cs || !he)
    return INT_MIN;
 
  struct ConfigDef *cdef = NULL;
  const struct ConfigSetType *cst = NULL;
  void *var = NULL;
 
  if (he->type & D_INTERNAL_INHERITED)
  {
    struct Inheritance *i = he->data;
 
    // inherited, value not set
    if (CONFIG_TYPE(he->type) == 0)
      return cs_he_native_get(cs, i->parent, err);
 
    // inherited, value set
    struct HashElem *he_base = cs_get_base(he);
    cdef = he_base->data;
    cst = cs_get_type_def(cs, he_base->type);
    var = &i->var;
  }
  else
  {
    // not inherited
    cdef = he->data;
    cst = cs_get_type_def(cs, he->type);
    var = &cdef->var;
  }
 
  if (!var || !cdef)
    return INT_MIN; // LCOV_EXCL_LINE
 
  if (!cst)
  {
    buf_printf(err, _("Option %s has an invalid type %d"), cdef->name, he->type);
    return INT_MIN;
  }
 
  return cst->native_get(var, cdef, err);
}

Here is the call graph for this function:

Here is the caller graph for this function:

cs_he_native_set()

int cs_he_native_set	(	const struct ConfigSet *	cs,
		struct HashElem *	he,
		intptr_t	value,
		struct Buffer *	err )

Natively set the value of a HashElem config item.

Parameters

cs	Config items
he	HashElem representing config item
value	Native pointer/value to set
err	Buffer for error messages

Return values

num	Result, e.g. CSR_SUCCESS

Definition at line 737 of file set.c.

{
  if (!cs || !he)
    return CSR_ERR_CODE;
 
  struct ConfigDef *cdef = NULL;
  const struct ConfigSetType *cst = NULL;
  void *var = NULL;
 
  if (he->type & D_INTERNAL_INHERITED)
  {
    struct Inheritance *i = he->data;
    struct HashElem *he_base = cs_get_base(he);
    cdef = he_base->data;
    cst = cs_get_type_def(cs, he_base->type);
    var = &i->var;
  }
  else
  {
    cdef = he->data;
    cst = cs_get_type_def(cs, he->type);
    var = &cdef->var;
  }
 
  if (!cst)
  {
    mutt_debug(LL_DEBUG1, "Variable '%s' has an invalid type %d\n", cdef->name, he->type);
    return CSR_ERR_CODE;
  }
 
  if (!var || !cdef)
    return CSR_ERR_CODE; // LCOV_EXCL_LINE
 
  int rc = cst->native_set(var, cdef, value, err);
  if (CSR_RESULT(rc) != CSR_SUCCESS)
    return rc;
 
  if (he->type & D_INTERNAL_INHERITED)
    he->type = cdef->type | D_INTERNAL_INHERITED;
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

cs_he_reset()

int cs_he_reset	(	const struct ConfigSet *	cs,
		struct HashElem *	he,
		struct Buffer *	err )

Reset a config item to its initial value.

Parameters

cs	Config items
he	HashElem representing config item
err	Buffer for error messages

Return values

num	Result, e.g. CSR_SUCCESS

Definition at line 400 of file set.c.

{
  if (!cs || !he)
    return CSR_ERR_CODE;
 
  /* An inherited var that's already pointing to its parent.
   * Return 'success', but don't send a notification. */
  if ((he->type & D_INTERNAL_INHERITED) && (CONFIG_TYPE(he->type) == 0))
    return CSR_SUCCESS;
 
  int rc = CSR_SUCCESS;
 
  if (he->type & D_INTERNAL_INHERITED)
  {
    struct Inheritance *i = he->data;
    struct HashElem *he_base = cs_get_base(he);
    struct ConfigDef *cdef = he_base->data;
    if (!cdef)
      return CSR_ERR_CODE; // LCOV_EXCL_LINE
 
    const struct ConfigSetType *cst = cs_get_type_def(cs, he_base->type);
    if (cst && cst->destroy)
      cst->destroy((void **) &i->var, cdef);
 
    he->type = D_INTERNAL_INHERITED;
  }
  else
  {
    struct ConfigDef *cdef = he->data;
    if (!cdef)
      return CSR_ERR_CODE; // LCOV_EXCL_LINE
 
    const struct ConfigSetType *cst = cs_get_type_def(cs, he->type);
    if (cst)
      rc = cst->reset(&cdef->var, cdef, err);
  }
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

cs_he_string_get()

int cs_he_string_get	(	const struct ConfigSet *	cs,
		struct HashElem *	he,
		struct Buffer *	result )

Get a config item as a string.

Parameters

cs	Config items
he	HashElem representing config item
result	Buffer for results or error messages

Return values

num	Result, e.g. CSR_SUCCESS

Definition at line 692 of file set.c.

{
  if (!cs || !he || !result)
    return CSR_ERR_CODE;
 
  struct ConfigDef *cdef = NULL;
  const struct ConfigSetType *cst = NULL;
  void *var = NULL;
 
  if (he->type & D_INTERNAL_INHERITED)
  {
    struct Inheritance *i = he->data;
 
    // inherited, value not set
    if (CONFIG_TYPE(he->type) == 0)
      return cs_he_string_get(cs, i->parent, result);
 
    // inherited, value set
    struct HashElem *he_base = cs_get_base(he);
    cdef = he_base->data;
    cst = cs_get_type_def(cs, he_base->type);
    var = &i->var;
  }
  else
  {
    // not inherited
    cdef = he->data;
    cst = cs_get_type_def(cs, he->type);
    var = &cdef->var;
  }
 
  if (!cdef || !cst)
    return CSR_ERR_CODE; // LCOV_EXCL_LINE
 
  return cst->string_get(var, cdef, result);
}

Here is the call graph for this function:

Here is the caller graph for this function:

cs_he_string_minus_equals()

int cs_he_string_minus_equals	(	const struct ConfigSet *	cs,
		struct HashElem *	he,
		const char *	value,
		struct Buffer *	err )

Remove from a config item by string.

Parameters

cs	Config items
he	HashElem representing config item
value	Value to set
err	Buffer for error messages

Return values

num	Result, e.g. CSR_SUCCESS

Definition at line 952 of file set.c.

{
  if (!cs || !he)
    return CSR_ERR_CODE;
 
  struct ConfigDef *cdef = NULL;
  const struct ConfigSetType *cst = NULL;
  void *var = NULL;
 
  if (he->type & D_INTERNAL_INHERITED)
  {
    struct Inheritance *i = he->data;
    struct HashElem *he_base = cs_get_base(he);
    cdef = he_base->data;
    cst = cs_get_type_def(cs, he_base->type);
    var = &i->var;
  }
  else
  {
    cdef = he->data;
    cst = cs_get_type_def(cs, he->type);
    var = &cdef->var;
  }
 
  if (!var || !cdef)
    return INT_MIN; // LCOV_EXCL_LINE
 
  if (!cst)
  {
    mutt_debug(LL_DEBUG1, "Variable '%s' has an invalid type %d\n", cdef->name, he->type);
    return CSR_ERR_CODE;
  }
 
  if (!cst->string_minus_equals)
  {
    // L10N: e.g. Type 'boolean' doesn't support operation '+='
    buf_printf(err, _("Type '%s' doesn't support operation '%s'"), cst->name, "-=");
    return CSR_ERR_INVALID | CSV_INV_NOT_IMPL;
  }
 
  int rc = cst->string_minus_equals(var, cdef, value, err);
  if (CSR_RESULT(rc) != CSR_SUCCESS)
    return rc;
 
  if (he->type & D_INTERNAL_INHERITED)
    he->type = cdef->type | D_INTERNAL_INHERITED;
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

cs_he_string_plus_equals()

int cs_he_string_plus_equals	(	const struct ConfigSet *	cs,
		struct HashElem *	he,
		const char *	value,
		struct Buffer *	err )

Add to a config item by string.

Parameters

cs	Config items
he	HashElem representing config item
value	Value to set
err	Buffer for error messages

Return values

num	Result, e.g. CSR_SUCCESS

Definition at line 893 of file set.c.

{
  if (!cs || !he)
    return CSR_ERR_CODE;
 
  struct ConfigDef *cdef = NULL;
  const struct ConfigSetType *cst = NULL;
  void *var = NULL;
 
  if (he->type & D_INTERNAL_INHERITED)
  {
    struct Inheritance *i = he->data;
    struct HashElem *he_base = cs_get_base(he);
    cdef = he_base->data;
    cst = cs_get_type_def(cs, he_base->type);
    var = &i->var;
  }
  else
  {
    cdef = he->data;
    cst = cs_get_type_def(cs, he->type);
    var = &cdef->var;
  }
 
  if (!var || !cdef)
    return INT_MIN; // LCOV_EXCL_LINE
 
  if (!cst)
  {
    mutt_debug(LL_DEBUG1, "Variable '%s' has an invalid type %d\n", cdef->name, he->type);
    return CSR_ERR_CODE;
  }
 
  if (!cst->string_plus_equals)
  {
    // L10N: e.g. Type 'boolean' doesn't support operation '+='
    buf_printf(err, _("Type '%s' doesn't support operation '%s'"), cst->name, "+=");
    return CSR_ERR_INVALID | CSV_INV_NOT_IMPL;
  }
 
  int rc = cst->string_plus_equals(var, cdef, value, err);
  if (CSR_RESULT(rc) != CSR_SUCCESS)
    return rc;
 
  if (he->type & D_INTERNAL_INHERITED)
    he->type = cdef->type | D_INTERNAL_INHERITED;
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

cs_he_string_set()

int cs_he_string_set	(	const struct ConfigSet *	cs,
		struct HashElem *	he,
		const char *	value,
		struct Buffer *	err )

Set a config item by string.

Parameters

cs	Config items
he	HashElem representing config item
value	Value to set
err	Buffer for error messages

Return values

num	Result, e.g. CSR_SUCCESS

Definition at line 617 of file set.c.

{
  if (!cs || !he)
    return CSR_ERR_CODE;
 
  struct ConfigDef *cdef = NULL;
  const struct ConfigSetType *cst = NULL;
  void *var = NULL;
 
  if (he->type & D_INTERNAL_INHERITED)
  {
    struct Inheritance *i = he->data;
    struct HashElem *he_base = cs_get_base(he);
    cdef = he_base->data;
    cst = cs_get_type_def(cs, he_base->type);
    var = &i->var;
  }
  else
  {
    cdef = he->data;
    cst = cs_get_type_def(cs, he->type);
    var = &cdef->var;
  }
 
  if (!cdef)
    return CSR_ERR_CODE; // LCOV_EXCL_LINE
 
  if (!cst)
  {
    mutt_debug(LL_DEBUG1, "Variable '%s' has an invalid type %d\n", cdef->name, he->type);
    return CSR_ERR_CODE;
  }
 
  int rc = cst->string_set(var, cdef, value, err);
  if (CSR_RESULT(rc) != CSR_SUCCESS)
    return rc;
 
  if (he->type & D_INTERNAL_INHERITED)
    he->type = cdef->type | D_INTERNAL_INHERITED;
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

cs_he_delete()

int cs_he_delete	(	const struct ConfigSet *	cs,
		struct HashElem *	he,
		struct Buffer *	err )

Delete config item from a config set.

Parameters

cs	Config items
he	HashElem representing config item
err	Buffer for error messages

Return values

num	Result, e.g. CSR_SUCCESS

Definition at line 1010 of file set.c.

{
  if (!cs || !he)
    return CSR_ERR_CODE;
 
  mutt_hash_delete(cs->hash, he->key.strkey, he->data);
  return CSR_SUCCESS;
}

Here is the call graph for this function:

Here is the caller graph for this function:

cs_str_has_been_set()

bool cs_str_has_been_set	(	const struct ConfigSet *	cs,
		const char *	name )

Is the config value different to its initial value?

Parameters

cs	Config items
name	Name of config item

Return values

true	Config has been set
false	Config has not been set

Definition at line 494 of file set.c.

{
  if (!cs || !name)
    return false;
 
  struct HashElem *he = cs_get_elem(cs, name);
  if (!he)
    return false;
 
  return cs_he_has_been_set(cs, he);
}

Here is the call graph for this function:

cs_str_initial_get()

int cs_str_initial_get	(	const struct ConfigSet *	cs,
		const char *	name,
		struct Buffer *	result )

Get the initial, or parent, value of a config item.

Parameters

cs	Config items
name	Name of config item
result	Buffer for results or error messages

Return values

num	Result, e.g. CSR_SUCCESS

If a config item is inherited from another, then this will get the parent's value. Otherwise, it will get the config item's initial value.

Definition at line 594 of file set.c.

{
  if (!cs || !name)
    return CSR_ERR_CODE;
 
  struct HashElem *he = cs_get_elem(cs, name);
  if (!he)
  {
    buf_printf(result, _("Unknown option %s"), name);
    return CSR_ERR_UNKNOWN;
  }
 
  return cs_he_initial_get(cs, he, result);
}

Here is the call graph for this function:

Here is the caller graph for this function:

cs_str_native_set()

int cs_str_native_set	(	const struct ConfigSet *	cs,
		const char *	name,
		intptr_t	value,
		struct Buffer *	err )

Natively set the value of a string config item.

Parameters

cs	Config items
name	Name of config item
value	Native pointer/value to set
err	Buffer for error messages

Return values

num	Result, e.g. CSR_SUCCESS

Definition at line 789 of file set.c.

{
  if (!cs || !name)
    return CSR_ERR_CODE;
 
  struct HashElem *he = cs_get_elem(cs, name);
  if (!he)
  {
    buf_printf(err, _("Unknown option %s"), name);
    return CSR_ERR_UNKNOWN;
  }
 
  struct ConfigDef *cdef = NULL;
  const struct ConfigSetType *cst = NULL;
  void *var = NULL;
 
  if (he->type & D_INTERNAL_INHERITED)
  {
    struct Inheritance *i = he->data;
    struct HashElem *he_base = cs_get_base(he);
    cdef = he_base->data;
    cst = cs_get_type_def(cs, he_base->type);
    var = &i->var;
  }
  else
  {
    cdef = he->data;
    cst = cs_get_type_def(cs, he->type);
    var = &cdef->var;
  }
 
  if (!cst || !var || !cdef)
    return CSR_ERR_CODE; /* LCOV_EXCL_LINE */
 
  int rc = cst->native_set(var, cdef, value, err);
  if (CSR_RESULT(rc) != CSR_SUCCESS)
    return rc;
 
  if (he->type & D_INTERNAL_INHERITED)
    he->type = cdef->type | D_INTERNAL_INHERITED;
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

cs_str_reset()

int cs_str_reset	(	const struct ConfigSet *	cs,
		const char *	name,
		struct Buffer *	err )

Reset a config item to its initial value.

Parameters

cs	Config items
name	Name of config item
err	Buffer for error messages

Return values

num	Result, e.g. CSR_SUCCESS

Definition at line 447 of file set.c.

{
  if (!cs || !name)
    return CSR_ERR_CODE;
 
  struct HashElem *he = cs_get_elem(cs, name);
  if (!he)
  {
    buf_printf(err, _("Unknown option %s"), name);
    return CSR_ERR_UNKNOWN;
  }
 
  return cs_he_reset(cs, he, err);
}

Here is the call graph for this function:

Here is the caller graph for this function:

cs_str_string_set()

int cs_str_string_set	(	const struct ConfigSet *	cs,
		const char *	name,
		const char *	value,
		struct Buffer *	err )

Set a config item by string.

Parameters

cs	Config items
name	Name of config item
value	Value to set
err	Buffer for error messages

Return values

num	Result, e.g. CSR_SUCCESS

Definition at line 669 of file set.c.

{
  if (!cs || !name)
    return CSR_ERR_CODE;
 
  struct HashElem *he = cs_get_elem(cs, name);
  if (!he)
  {
    buf_printf(err, _("Unknown option %s"), name);
    return CSR_ERR_UNKNOWN;
  }
 
  return cs_he_string_set(cs, he, value, err);
}

Here is the call graph for this function:

Here is the caller graph for this function:

startup_only()

static bool startup_only ( const struct ConfigDef * cdef, struct Buffer * err )

inlinestatic

Validator function for D_ON_STARTUP.

Parameters

cdef	Variable definition
err	Buffer for error messages

Return values

true	Variable may only be set at startup

Definition at line 295 of file set.h.

{
  if ((cdef->type & D_ON_STARTUP) && StartupComplete)
  {
    buf_printf(err, _("Option %s may only be set at startup"), cdef->name);
    return true;
  }
 
  return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

StartupComplete

bool StartupComplete

extern

When the config has been read.

Definition at line 12 of file address.c.