subset.h File Reference

#include <stdint.h>

Include dependency graph for subset.h:

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

Go to the source code of this file.

Data Structures
struct	ConfigSubset
	A set of inherited config items. More...
struct	EventConfig
	A config-change event. More...

Enumerations
enum	ConfigScope { SET_SCOPE_NEOMUTT, SET_SCOPE_ACCOUNT, SET_SCOPE_MAILBOX }
	Who does this Config belong to? More...
enum	NotifyConfig { NT_CONFIG_SET = 1, NT_CONFIG_RESET, NT_CONFIG_INITIAL_SET }
	Config notification types. More...

Functions
struct ConfigSubset *	cs_subset_new (const char *name, struct ConfigSubset *sub_parent, struct Notify *not_parent)
	Create a new Config Subset. More...
void	cs_subset_free (struct ConfigSubset **ptr)
	Free a Config Subset. More...
struct HashElem *	cs_subset_create_inheritance (const struct ConfigSubset *sub, const char *name)
	Create a Subset config item (inherited) More...
struct HashElem *	cs_subset_lookup (const struct ConfigSubset *sub, const char *name)
	Find an inherited config item. More...
void	cs_subset_notify_observers (const struct ConfigSubset *sub, struct HashElem *he, enum NotifyConfig ev)
	Notify all observers of an event. More...
intptr_t	cs_subset_he_native_get (const struct ConfigSubset *sub, struct HashElem *he, struct Buffer *err)
	Natively get the value of a HashElem config item. More...
int	cs_subset_he_native_set (const struct ConfigSubset *sub, struct HashElem *he, intptr_t value, struct Buffer *err)
	Natively set the value of a HashElem config item. More...
int	cs_subset_he_reset (const struct ConfigSubset *sub, struct HashElem *he, struct Buffer *err)
	Reset a config item to its initial value. More...
int	cs_subset_he_string_get (const struct ConfigSubset *sub, struct HashElem *he, struct Buffer *result)
	Get a config item as a string. More...
int	cs_subset_he_string_minus_equals (const struct ConfigSubset *sub, struct HashElem *he, const char *value, struct Buffer *err)
	Remove from a config item by string. More...
int	cs_subset_he_string_plus_equals (const struct ConfigSubset *sub, struct HashElem *he, const char *value, struct Buffer *err)
	Add to a config item by string. More...
int	cs_subset_he_string_set (const struct ConfigSubset *sub, struct HashElem *he, const char *value, struct Buffer *err)
	Set a config item by string. More...
intptr_t	cs_subset_str_native_get (const struct ConfigSubset *sub, const char *name, struct Buffer *err)
	Natively get the value of a string config item. More...
int	cs_subset_str_native_set (const struct ConfigSubset *sub, const char *name, intptr_t value, struct Buffer *err)
	Natively set the value of a string config item. More...
int	cs_subset_str_reset (const struct ConfigSubset *sub, const char *name, struct Buffer *err)
	Reset a config item to its initial value. More...
int	cs_subset_str_string_get (const struct ConfigSubset *sub, const char *name, struct Buffer *result)
	Get a config item as a string. More...
int	cs_subset_str_string_minus_equals (const struct ConfigSubset *sub, const char *name, const char *value, struct Buffer *err)
	Remove from a config item by string. More...
int	cs_subset_str_string_plus_equals (const struct ConfigSubset *sub, const char *name, const char *value, struct Buffer *err)
	Add to a config item by string. More...
int	cs_subset_str_string_set (const struct ConfigSubset *sub, const char *name, const char *value, struct Buffer *err)
	Set a config item by string. More...
int	elem_list_sort (const void *a, const void *b)
	Sort two HashElem pointers to config. More...
struct HashElem **	get_elem_list (struct ConfigSet *cs)
	Create a sorted list of all config items. More...

Detailed Description

Subset 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 subset.h.

Enumeration Type Documentation

ConfigScope

enum ConfigScope

Who does this Config belong to?

Enumerator
SET_SCOPE_NEOMUTT	This Config is NeoMutt-specific (global)
SET_SCOPE_ACCOUNT	This Config is Account-specific.
SET_SCOPE_MAILBOX	This Config is Mailbox-specific.

Definition at line 36 of file subset.h.

{
  SET_SCOPE_NEOMUTT, 
  SET_SCOPE_ACCOUNT, 
  SET_SCOPE_MAILBOX, 
};

NotifyConfig

enum NotifyConfig

Config notification types.

Observers of NT_CONFIG will be passed an EventConfig.

Enumerator
NT_CONFIG_SET	Config item has been set.
NT_CONFIG_RESET	Config item has been reset to initial, or parent, value.
NT_CONFIG_INITIAL_SET	Config item's initial value has been set.

Definition at line 60 of file subset.h.

{
  NT_CONFIG_SET = 1,     
  NT_CONFIG_RESET,       
  NT_CONFIG_INITIAL_SET, 
};

Function Documentation

cs_subset_new()

struct ConfigSubset* cs_subset_new	(	const char *	name,
		struct ConfigSubset *	sub_parent,
		struct Notify *	not_parent
	)

Create a new Config Subset.

Parameters

name	Name for this Subset
sub_parent	Parent Subset
not_parent	Parent Notification

Return values

ptr	New Subset

Note

The name will be combined with the parents' names

Definition at line 133 of file subset.c.

{
  struct ConfigSubset *sub = mutt_mem_calloc(1, sizeof(*sub));
 
  if (sub_parent)
  {
    sub->parent = sub_parent;
    sub->cs = sub_parent->cs;
  }
 
  if (name)
  {
    char scope[256];
 
    if (sub_parent && sub_parent->name)
      snprintf(scope, sizeof(scope), "%s:%s", sub_parent->name, name);
    else
      mutt_str_copy(scope, name, sizeof(scope));
 
    sub->name = mutt_str_dup(scope);
  }
 
  sub->notify = notify_new();
  notify_set_parent(sub->notify, not_parent);
 
  return sub;
}

Here is the call graph for this function:

Here is the caller graph for this function:

cs_subset_free()

void cs_subset_free

(

struct ConfigSubset **

ptr

)

Free a Config Subset.

Parameters

ptr	Subset to free

Note

Config items matching this Subset will be freed

Definition at line 93 of file subset.c.

{
  if (!ptr || !*ptr)
    return;
 
  struct ConfigSubset *sub = *ptr;
 
  if (sub->cs && sub->name)
  {
    char scope[256];
    snprintf(scope, sizeof(scope), "%s:", sub->name);
 
    // We don't know if any config items have been set,
    // so search for anything with a matching scope.
    struct HashElem **list = get_elem_list(sub->cs);
    for (size_t i = 0; list[i]; i++)
    {
      const char *item = list[i]->key.strkey;
      if (mutt_str_startswith(item, scope) != 0)
      {
        cs_uninherit_variable(sub->cs, item);
      }
    }
    FREE(&list);
  }
 
  notify_free(&sub->notify);
  FREE(&sub->name);
  FREE(ptr);
}

Here is the call graph for this function:

Here is the caller graph for this function:

cs_subset_create_inheritance()

struct HashElem* cs_subset_create_inheritance	(	const struct ConfigSubset *	sub,
		const char *	name
	)

Create a Subset config item (inherited)

Parameters

sub	Config Subset
name	Name of config item

Return values

ptr	HashElem of the config item
NULL	Error

Definition at line 189 of file subset.c.

{
  if (!sub)
    return NULL;
 
  struct HashElem *he = cs_subset_lookup(sub, name);
  if (he)
    return he;
 
  if (sub->parent)
  {
    // Create parent before creating name
    he = cs_subset_create_inheritance(sub->parent, name);
  }
 
  if (!he)
    return NULL;
 
  char scope[256];
  snprintf(scope, sizeof(scope), "%s:%s", sub->name, name);
  return cs_inherit_variable(sub->cs, he, scope);
}

Here is the call graph for this function:

Here is the caller graph for this function:

cs_subset_lookup()

struct HashElem* cs_subset_lookup	(	const struct ConfigSubset *	sub,
		const char *	name
	)

Find an inherited config item.

Parameters

sub	Subset to search
name	Name of Config item to find

Return values

ptr	HashElem of the config item

Definition at line 168 of file subset.c.

{
  if (!sub || !name)
    return NULL;
 
  char scope[256];
  if (sub->name)
    snprintf(scope, sizeof(scope), "%s:%s", sub->name, name);
  else
    mutt_str_copy(scope, name, sizeof(scope));
 
  return cs_get_elem(sub->cs, scope);
}

Here is the call graph for this function:

Here is the caller graph for this function:

cs_subset_notify_observers()

void cs_subset_notify_observers	(	const struct ConfigSubset *	sub,
		struct HashElem *	he,
		enum NotifyConfig	ev
	)

Notify all observers of an event.

Parameters

sub	Config Subset
he	HashElem representing config item
ev	Type of event

Definition at line 218 of file subset.c.

{
  if (!sub || !he)
    return;
 
  struct HashElem *he_base = cs_get_base(he);
  struct EventConfig ec = { sub, he_base->key.strkey, he };
  notify_send(sub->notify, NT_CONFIG, ev, &ec);
}

Here is the call graph for this function:

Here is the caller graph for this function:

cs_subset_he_native_get()

intptr_t cs_subset_he_native_get	(	const struct ConfigSubset *	sub,
		struct HashElem *	he,
		struct Buffer *	err
	)

Natively get the value of a HashElem config item.

Parameters

sub	Config Subset
he	HashElem representing config item
err	Buffer for error messages

Return values

intptr_t	Native pointer/value
INT_MIN	Error

Definition at line 237 of file subset.c.

{
  if (!sub)
    return INT_MIN;
 
  return cs_he_native_get(sub->cs, he, err);
}

Here is the call graph for this function:

Here is the caller graph for this function:

cs_subset_he_native_set()

int cs_subset_he_native_set	(	const struct ConfigSubset *	sub,
		struct HashElem *	he,
		intptr_t	value,
		struct Buffer *	err
	)

Natively set the value of a HashElem config item.

Parameters

sub	Config Subset
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 270 of file subset.c.

{
  if (!sub)
    return CSR_ERR_CODE;
 
  int rc = cs_he_native_set(sub->cs, he, value, err);
 
  if ((CSR_RESULT(rc) == CSR_SUCCESS) && !(rc & CSR_SUC_NO_CHANGE))
    cs_subset_notify_observers(sub, he, NT_CONFIG_SET);
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

cs_subset_he_reset()

int cs_subset_he_reset	(	const struct ConfigSubset *	sub,
		struct HashElem *	he,
		struct Buffer *	err
	)

Reset a config item to its initial value.

Parameters

sub	Config Subset
he	HashElem representing config item
err	Buffer for error messages

Return values

num	Result, e.g. CSR_SUCCESS

Definition at line 307 of file subset.c.

{
  if (!sub)
    return CSR_ERR_CODE;
 
  int rc = cs_he_reset(sub->cs, he, err);
 
  if ((CSR_RESULT(rc) == CSR_SUCCESS) && !(rc & CSR_SUC_NO_CHANGE))
    cs_subset_notify_observers(sub, he, NT_CONFIG_RESET);
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

cs_subset_he_string_get()

int cs_subset_he_string_get	(	const struct ConfigSubset *	sub,
		struct HashElem *	he,
		struct Buffer *	result
	)

Get a config item as a string.

Parameters

sub	Config Subset
he	HashElem representing config item
result	Buffer for results or error messages

Return values

num	Result, e.g. CSR_SUCCESS

Definition at line 341 of file subset.c.

{
  if (!sub)
    return CSR_ERR_CODE;
 
  return cs_he_string_get(sub->cs, he, result);
}

Here is the call graph for this function:

Here is the caller graph for this function:

cs_subset_he_string_minus_equals()

int cs_subset_he_string_minus_equals	(	const struct ConfigSubset *	sub,
		struct HashElem *	he,
		const char *	value,
		struct Buffer *	err
	)

Remove from a config item by string.

Parameters

sub	Config Subset
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 449 of file subset.c.

{
  if (!sub)
    return CSR_ERR_CODE;
 
  int rc = cs_he_string_minus_equals(sub->cs, he, value, err);
 
  if ((CSR_RESULT(rc) == CSR_SUCCESS) && !(rc & CSR_SUC_NO_CHANGE))
    cs_subset_notify_observers(sub, he, NT_CONFIG_SET);
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

cs_subset_he_string_plus_equals()

int cs_subset_he_string_plus_equals	(	const struct ConfigSubset *	sub,
		struct HashElem *	he,
		const char *	value,
		struct Buffer *	err
	)

Add to a config item by string.

Parameters

sub	Config Subset
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 411 of file subset.c.

{
  if (!sub)
    return CSR_ERR_CODE;
 
  int rc = cs_he_string_plus_equals(sub->cs, he, value, err);
 
  if ((CSR_RESULT(rc) == CSR_SUCCESS) && !(rc & CSR_SUC_NO_CHANGE))
    cs_subset_notify_observers(sub, he, NT_CONFIG_SET);
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

cs_subset_he_string_set()

int cs_subset_he_string_set	(	const struct ConfigSubset *	sub,
		struct HashElem *	he,
		const char *	value,
		struct Buffer *	err
	)

Set a config item by string.

Parameters

sub	Config Subset
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 373 of file subset.c.

{
  if (!sub)
    return CSR_ERR_CODE;
 
  int rc = cs_he_string_set(sub->cs, he, value, err);
 
  if ((CSR_RESULT(rc) == CSR_SUCCESS) && !(rc & CSR_SUC_NO_CHANGE))
    cs_subset_notify_observers(sub, he, NT_CONFIG_SET);
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

cs_subset_str_native_get()

intptr_t cs_subset_str_native_get	(	const struct ConfigSubset *	sub,
		const char *	name,
		struct Buffer *	err
	)

Natively get the value of a string config item.

Parameters

sub	Config Subset
name	Name of config item
err	Buffer for error messages

Return values

intptr_t	Native pointer/value
INT_MIN	Error

Definition at line 254 of file subset.c.

{
  struct HashElem *he = cs_subset_create_inheritance(sub, name);
 
  return cs_subset_he_native_get(sub, he, err);
}

Here is the call graph for this function:

cs_subset_str_native_set()

int cs_subset_str_native_set	(	const struct ConfigSubset *	sub,
		const char *	name,
		intptr_t	value,
		struct Buffer *	err
	)

Natively set the value of a string config item.

Parameters

sub	Config Subset
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 292 of file subset.c.

{
  struct HashElem *he = cs_subset_create_inheritance(sub, name);
 
  return cs_subset_he_native_set(sub, he, value, err);
}

Here is the call graph for this function:

Here is the caller graph for this function:

cs_subset_str_reset()

int cs_subset_str_reset	(	const struct ConfigSubset *	sub,
		const char *	name,
		struct Buffer *	err
	)

Reset a config item to its initial value.

Parameters

sub	Config Subset
name	Name of config item
err	Buffer for error messages

Return values

num	Result, e.g. CSR_SUCCESS

Definition at line 327 of file subset.c.

{
  struct HashElem *he = cs_subset_create_inheritance(sub, name);
 
  return cs_subset_he_reset(sub, he, err);
}

Here is the call graph for this function:

cs_subset_str_string_get()

int cs_subset_str_string_get	(	const struct ConfigSubset *	sub,
		const char *	name,
		struct Buffer *	result
	)

Get a config item as a string.

Parameters

sub	Config Subset
name	Name of config item
result	Buffer for results or error messages

Return values

num	Result, e.g. CSR_SUCCESS

Definition at line 357 of file subset.c.

{
  struct HashElem *he = cs_subset_create_inheritance(sub, name);
 
  return cs_subset_he_string_get(sub, he, result);
}

Here is the call graph for this function:

Here is the caller graph for this function:

cs_subset_str_string_minus_equals()

int cs_subset_str_string_minus_equals	(	const struct ConfigSubset *	sub,
		const char *	name,
		const char *	value,
		struct Buffer *	err
	)

Remove from a config item by string.

Parameters

sub	Config Subset
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 471 of file subset.c.

{
  struct HashElem *he = cs_subset_create_inheritance(sub, name);
 
  return cs_subset_he_string_minus_equals(sub, he, value, err);
}

Here is the call graph for this function:

cs_subset_str_string_plus_equals()

int cs_subset_str_string_plus_equals	(	const struct ConfigSubset *	sub,
		const char *	name,
		const char *	value,
		struct Buffer *	err
	)

Add to a config item by string.

Parameters

sub	Config Subset
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 433 of file subset.c.

{
  struct HashElem *he = cs_subset_create_inheritance(sub, name);
 
  return cs_subset_he_string_plus_equals(sub, he, value, err);
}

Here is the call graph for this function:

cs_subset_str_string_set()

int cs_subset_str_string_set	(	const struct ConfigSubset *	sub,
		const char *	name,
		const char *	value,
		struct Buffer *	err
	)

Set a config item by string.

Parameters

sub	Config Subset
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 395 of file subset.c.

{
  struct HashElem *he = cs_subset_create_inheritance(sub, name);
 
  return cs_subset_he_string_set(sub, he, value, err);
}

Here is the call graph for this function:

Here is the caller graph for this function:

elem_list_sort()

int elem_list_sort	(	const void *	a,
		const void *	b
	)

Sort two HashElem pointers to config.

Parameters

a	First HashElem
b	Second HashElem

Return values

-1	a precedes b
0	a and b are identical
1	b precedes a

Definition at line 48 of file subset.c.

{
  if (!a || !b)
    return 0;
 
  const struct HashElem *hea = *(struct HashElem const *const *) a;
  const struct HashElem *heb = *(struct HashElem const *const *) b;
 
  return mutt_istr_cmp(hea->key.strkey, heb->key.strkey);
}

Here is the call graph for this function:

Here is the caller graph for this function:

get_elem_list()

struct HashElem** get_elem_list

(

struct ConfigSet *

cs

)

Create a sorted list of all config items.

Parameters

cs	ConfigSet to read

Return values

ptr	Null-terminated array of HashElem

Definition at line 64 of file subset.c.

{
  if (!cs)
    return NULL;
 
  struct HashElem **list = mutt_mem_calloc(1024, sizeof(struct HashElem *));
  size_t index = 0;
 
  struct HashWalkState walk = { 0 };
  struct HashElem *he = NULL;
 
  while ((he = mutt_hash_walk(cs->hash, &walk)))
  {
    list[index++] = he;
    if (index == 1022)
      break; /* LCOV_EXCL_LINE */
  }
 
  qsort(list, index, sizeof(struct HashElem *), elem_list_sort);
 
  return list;
}

Here is the call graph for this function:

Here is the caller graph for this function: