set.c File Reference

A collection of config items. More...

#include "config.h"
#include <limits.h>
#include <stdio.h>
#include "mutt/lib.h"
#include "set.h"
#include "inheritance.h"
#include "types.h"

Include dependency graph for set.c:

Go to the source code of this file.

Functions
static void	destroy (int type, void *obj, intptr_t data)
	Callback function for the Hash Table - Implements hash_hdata_free_t. More...
static struct HashElem *	create_synonym (const struct ConfigSet *cs, struct ConfigDef *cdef, struct Buffer *err)
	Create an alternative name for a config item. More...
static struct HashElem *	reg_one_var (const struct ConfigSet *cs, struct ConfigDef *cdef, struct Buffer *err)
	Register one config item. More...
struct ConfigSet *	cs_new (size_t size)
	Create a new Config Set. More...
void	cs_free (struct ConfigSet **ptr)
	Free a Config Set. More...
struct HashElem *	cs_get_base (struct HashElem *he)
	Find the root Config Item. More...
struct HashElem *	cs_get_elem (const struct ConfigSet *cs, const char *name)
	Get the HashElem representing a config item. More...
const struct ConfigSetType *	cs_get_type_def (const struct ConfigSet *cs, unsigned int type)
	Get the definition for a type. More...
bool	cs_register_type (struct ConfigSet *cs, const struct ConfigSetType *cst)
	Register a type of config item. More...
bool	cs_register_variables (const struct ConfigSet *cs, struct ConfigDef vars[], int flags)
	Register a set of config items. More...
struct HashElem *	cs_inherit_variable (const struct ConfigSet *cs, struct HashElem *parent, const char *name)
	Create in inherited config item. More...
void	cs_uninherit_variable (const struct ConfigSet *cs, const char *name)
	Remove an inherited config item. More...
int	cs_he_reset (const struct ConfigSet *cs, struct HashElem *he, struct Buffer *err)
	Reset a config item to its initial value. More...
int	cs_str_reset (const struct ConfigSet *cs, const char *name, struct Buffer *err)
	Reset a config item to its initial value. More...
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. More...
int	cs_str_initial_set (const struct ConfigSet *cs, const char *name, const char *value, struct Buffer *err)
	Set the initial value of a config item. More...
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. More...
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. More...
int	cs_he_string_set (const struct ConfigSet *cs, struct HashElem *he, const char *value, struct Buffer *err)
	Set a config item by string. More...
int	cs_str_string_set (const struct ConfigSet *cs, const char *name, const char *value, struct Buffer *err)
	Set a config item by string. More...
int	cs_he_string_get (const struct ConfigSet *cs, struct HashElem *he, struct Buffer *result)
	Get a config item as a string. More...
int	cs_str_string_get (const struct ConfigSet *cs, const char *name, struct Buffer *result)
	Get a config item as a string. More...
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. More...
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. More...
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. More...
intptr_t	cs_str_native_get (const struct ConfigSet *cs, const char *name, struct Buffer *err)
	Natively get the value of a string config item. More...
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. More...
int	cs_str_string_plus_equals (const struct ConfigSet *cs, const char *name, const char *value, struct Buffer *err)
	Add to a config item by string. More...
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. More...
int	cs_str_string_minus_equals (const struct ConfigSet *cs, const char *name, const char *value, struct Buffer *err)
	Remove from a config item by string. More...

Variables
struct ConfigSetType	RegisteredTypes [18]

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

Function Documentation

destroy()

static void destroy ( int  type, void *  obj, intptr_t  data  )

static

Callback function for the Hash Table - Implements hash_hdata_free_t.

Parameters

type	Object type, e.g. DT_STRING
obj	Object to destroy
data	ConfigSet associated with the object

Definition at line 47 of file set.c.

{
  if (!obj || (data == 0))
    return; /* LCOV_EXCL_LINE */

  struct ConfigSet *cs = (struct ConfigSet *) data;

  const struct ConfigSetType *cst = NULL;

  if (type & DT_INHERITED)
  {
    struct Inheritance *i = obj;

    struct HashElem *he_base = cs_get_base(i->parent);
    struct ConfigDef *cdef = he_base->data;

    if (!cdef)
      return; // LCOV_EXCL_LINE

    cst = cs_get_type_def(cs, he_base->type);
    if (cst && cst->destroy)
      cst->destroy(cs, (void **) &i->var, cdef);

    FREE(&i->name);
    FREE(&i);
  }
  else
  {
    struct ConfigDef *cdef = obj;

    cst = cs_get_type_def(cs, type);
    if (cst && cst->destroy)
    {
      if (cdef->type & DT_NO_VARIABLE)
        cst->destroy(cs, &cdef->var, cdef);
      else if (cdef->var)
        cst->destroy(cs, cdef->var, cdef);
    }

    /* If we allocated the initial value, clean it up */
    if (cdef->type & DT_INITIAL_SET)
      FREE(&cdef->initial);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

create_synonym()

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

static

Create an alternative name for a config item.

Parameters

cs	Config items
cdef	Variable definition
err	Buffer for error messages

Return values

ptr	New HashElem representing the config item synonym

Definition at line 99 of file set.c.

{
  if (!cs || !cdef)
    return NULL; /* LCOV_EXCL_LINE */

  const char *name = (const char *) cdef->initial;
  struct HashElem *parent = cs_get_elem(cs, name);
  if (!parent)
  {
    mutt_buffer_printf(err, _("No such variable: %s"), name);
    return NULL;
  }

  struct HashElem *child =
      mutt_hash_typed_insert(cs->hash, cdef->name, cdef->type, (void *) cdef);
  if (!child)
    return NULL; /* LCOV_EXCL_LINE */

  cdef->var = parent;
  return child;
}

Here is the call graph for this function:

Here is the caller graph for this function:

reg_one_var()

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

static

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

Definition at line 129 of file set.c.

{
  if (!cs || !cdef)
    return NULL; /* LCOV_EXCL_LINE */

  if (DTYPE(cdef->type) == DT_SYNONYM)
    return create_synonym(cs, cdef, err);

  const struct ConfigSetType *cst = cs_get_type_def(cs, cdef->type);
  if (!cst)
  {
    mutt_buffer_printf(err, _("Variable '%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 */

  if (cst && cst->reset)
  {
    if (cdef->type & DT_NO_VARIABLE)
      cst->reset(cs, &cdef->var, cdef, err);
    else if (cdef->var)
      cst->reset(cs, cdef->var, cdef, err);
  }

  return he;
}

Here is the call graph for this function:

Here is the caller graph for this function:

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 166 of file set.c.

{
  struct ConfigSet *cs = mutt_mem_calloc(1, sizeof(*cs));

  cs->hash = mutt_hash_new(size, MUTT_HASH_NO_FLAGS);
  mutt_hash_set_destructor(cs->hash, destroy, (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 180 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 199 of file set.c.

{
  if (!(he->type & DT_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 214 of file set.c.

{
  if (!cs || !name)
    return NULL;

  struct HashElem *he = mutt_hash_find_elem(cs->hash, name);
  if (!he)
    return NULL;

  if (DTYPE(he->type) != DT_SYNONYM)
    return he;

  const struct ConfigDef *cdef = he->data;

  return 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 237 of file set.c.

{
  if (!cs)
    return NULL;

  type = DTYPE(type);
  if ((type < 1) || (type >= mutt_array_size(cs->types)))
    return NULL;

  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

bool	True, if type was registered successfully

Definition at line 258 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 >= mutt_array_size(cs->types))
    return false;

  if (cs->types[cst->type].name)
    return false; /* already registered */

  cs->types[cst->type] = *cst;
  return true;
}

cs_register_variables()

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

Register a set of config items.

Parameters

cs	Config items
vars	Variable definition
flags	Flags, e.g. DT_NO_VARIABLE

Return values

bool	True, if all variables were registered successfully

Definition at line 286 of file set.c.

{
  if (!cs || !vars)
    return false;

  struct Buffer err = mutt_buffer_make(0);

  bool rc = true;

  for (size_t i = 0; vars[i].name; i++)
  {
    vars[i].type |= flags;
    if (!reg_one_var(cs, &vars[i], &err))
    {
      mutt_debug(LL_DEBUG1, "%s\n", mutt_b2s(&err));
      rc = false;
    }
  }

  mutt_buffer_dealloc(&err);
  return rc;
}

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 *	parent,
		const char *	name
	)

Create in inherited config item.

Parameters

cs	Config items
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 316 of file set.c.

{
  if (!cs || !parent)
    return NULL;

  struct Inheritance *i = mutt_mem_calloc(1, sizeof(*i));
  i->parent = parent;
  i->name = mutt_str_dup(name);

  struct HashElem *he = mutt_hash_typed_insert(cs->hash, i->name, DT_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 341 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_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 356 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 & DT_INHERITED) && (DTYPE(he->type) == 0))
    return CSR_SUCCESS;

  int rc = CSR_SUCCESS;

  if (he->type & DT_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(cs, (void **) &i->var, cdef);

    he->type = DT_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)
    {
      if (cdef->type & DT_NO_VARIABLE)
        rc = cst->reset(cs, &cdef->var, cdef, err);
      else if (cdef->var)
        rc = cst->reset(cs, cdef->var, cdef, err);
    }
  }

  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 408 of file set.c.

{
  if (!cs || !name)
    return CSR_ERR_CODE;

  struct HashElem *he = cs_get_elem(cs, name);
  if (!he)
  {
    mutt_buffer_printf(err, _("Unknown variable '%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_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 431 of file set.c.

{
  if (!cs || !he)
    return CSR_ERR_CODE;

  struct ConfigDef *cdef = NULL;

  if (he->type & DT_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(cs, 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_str_initial_set()

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

Set the initial value of a config item.

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 473 of file set.c.

{
  if (!cs || !name)
    return CSR_ERR_CODE;

  struct HashElem *he = cs_get_elem(cs, name);
  if (!he)
  {
    mutt_buffer_printf(err, _("Unknown variable '%s'"), name);
    return CSR_ERR_UNKNOWN;
  }

  return cs_he_initial_set(cs, he, value, err);
}

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 499 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 & DT_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(cs, NULL, cdef, result);
}

Here is the call graph for this function:

Here is the caller 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 535 of file set.c.

{
  if (!cs || !name)
    return CSR_ERR_CODE;

  struct HashElem *he = cs_get_elem(cs, name);
  if (!he)
  {
    mutt_buffer_printf(result, _("Unknown variable '%s'"), name);
    return CSR_ERR_UNKNOWN;
  }

  return cs_he_initial_get(cs, he, result);
}

Here is the call 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 558 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 & DT_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);
    if (cdef->type & DT_NO_VARIABLE)
      var = &cdef->var;
    else
      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(cs, var, cdef, value, err);
  if (CSR_RESULT(rc) != CSR_SUCCESS)
    return rc;

  if (he->type & DT_INHERITED)
    he->type = cdef->type | DT_INHERITED;

  return rc;
}

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 613 of file set.c.

{
  if (!cs || !name)
    return CSR_ERR_CODE;

  struct HashElem *he = cs_get_elem(cs, name);
  if (!he)
  {
    mutt_buffer_printf(err, _("Unknown variable '%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:

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 636 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 & DT_INHERITED)
  {
    struct Inheritance *i = he->data;

    // inherited, value not set
    if (DTYPE(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);
    if (cdef->type & DT_NO_VARIABLE)
      var = &cdef->var;
    else
      var = cdef->var;
  }

  if (!cdef || !cst)
    return CSR_ERR_CODE; // LCOV_EXCL_LINE

  return cst->string_get(cs, var, cdef, result);
}

Here is the call graph for this function:

Here is the caller graph for this function:

cs_str_string_get()

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

Get a config item as a string.

Parameters

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

Return values

num	Result, e.g. CSR_SUCCESS

Definition at line 683 of file set.c.

{
  if (!cs || !name)
    return CSR_ERR_CODE;

  struct HashElem *he = cs_get_elem(cs, name);
  if (!he)
  {
    mutt_buffer_printf(result, _("Unknown variable '%s'"), name);
    return CSR_ERR_UNKNOWN;
  }

  return cs_he_string_get(cs, he, result);
}

Here is the call 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 706 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 & DT_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);
    if (cdef->type & DT_NO_VARIABLE)
      var = &cdef->var;
    else
      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(cs, var, cdef, value, err);
  if (CSR_RESULT(rc) != CSR_SUCCESS)
    return rc;

  if (he->type & DT_INHERITED)
    he->type = cdef->type | DT_INHERITED;

  return rc;
}

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 761 of file set.c.

{
  if (!cs || !name)
    return CSR_ERR_CODE;

  struct HashElem *he = cs_get_elem(cs, name);
  if (!he)
  {
    mutt_buffer_printf(err, _("Unknown variable '%s'"), name);
    return CSR_ERR_UNKNOWN;
  }

  struct ConfigDef *cdef = NULL;
  const struct ConfigSetType *cst = NULL;
  void *var = NULL;

  if (he->type & DT_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);
    if (cdef->type & DT_NO_VARIABLE)
      var = &cdef->var;
    else
      var = cdef->var;
  }

  if (!cst || !var || !cdef)
    return CSR_ERR_CODE; /* LCOV_EXCL_LINE */

  int rc = cst->native_set(cs, var, cdef, value, err);
  if (CSR_RESULT(rc) != CSR_SUCCESS)
    return rc;

  if (he->type & DT_INHERITED)
    he->type = cdef->type | DT_INHERITED;

  return rc;
}

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 817 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 & DT_INHERITED)
  {
    struct Inheritance *i = he->data;

    // inherited, value not set
    if (DTYPE(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);
    if (cdef->type & DT_NO_VARIABLE)
      var = &cdef->var;
    else
      var = cdef->var;
  }

  if (!var || !cdef)
    return INT_MIN; // LCOV_EXCL_LINE

  if (!cst)
  {
    mutt_buffer_printf(err, _("Variable '%s' has an invalid type %d"), cdef->name, he->type);
    return INT_MIN;
  }

  return cst->native_get(cs, var, cdef, err);
}

Here is the call graph for this function:

Here is the caller graph for this function:

cs_str_native_get()

intptr_t cs_str_native_get	(	const struct ConfigSet *	cs,
		const char *	name,
		struct Buffer *	err
	)

Natively get the value of a string config item.

Parameters

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

Return values

intptr_t	Native pointer/value
INT_MIN	Error

Definition at line 871 of file set.c.

{
  if (!cs || !name)
    return INT_MIN;

  struct HashElem *he = cs_get_elem(cs, name);
  return cs_he_native_get(cs, he, err);
}

Here is the call 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 888 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 & DT_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);
    if (cdef->type & DT_NO_VARIABLE)
      var = &cdef->var;
    else
      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 '+='
    mutt_buffer_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(cs, var, cdef, value, err);
  if (CSR_RESULT(rc) != CSR_SUCCESS)
    return rc;

  if (he->type & DT_INHERITED)
    he->type = cdef->type | DT_INHERITED;

  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

cs_str_string_plus_equals()

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

Add to 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 950 of file set.c.

{
  if (!cs || !name)
    return CSR_ERR_CODE;

  struct HashElem *he = cs_get_elem(cs, name);
  if (!he)
  {
    mutt_buffer_printf(err, _("Unknown variable '%s'"), name);
    return CSR_ERR_UNKNOWN;
  }

  return cs_he_string_plus_equals(cs, he, value, err);
}

Here is the call 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 974 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 & DT_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);
    if (cdef->type & DT_NO_VARIABLE)
      var = &cdef->var;
    else
      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 '+='
    mutt_buffer_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(cs, var, cdef, value, err);
  if (CSR_RESULT(rc) != CSR_SUCCESS)
    return rc;

  if (he->type & DT_INHERITED)
    he->type = cdef->type | DT_INHERITED;

  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

cs_str_string_minus_equals()

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

Remove from 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 1036 of file set.c.

{
  if (!cs || !name)
    return CSR_ERR_CODE;

  struct HashElem *he = cs_get_elem(cs, name);
  if (!he)
  {
    mutt_buffer_printf(err, _("Unknown variable '%s'"), name);
    return CSR_ERR_UNKNOWN;
  }

  return cs_he_string_minus_equals(cs, he, value, err);
}

Here is the call graph for this function:

Variable Documentation

RegisteredTypes

struct ConfigSetType RegisteredTypes[18]

Initial value:

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

Definition at line 37 of file set.c.