subset.h File Reference

Subset of Config Items. More...

#include <stdint.h>
#include "mutt/lib.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_DELETED }
	Config notification types. More...
enum	GetElemListFlags { GEL_ALL_CONFIG , GEL_CHANGED_CONFIG }
	Flags for get_elem_list() More...

Functions
struct ConfigSubset *	cs_subset_new (const char *name, struct ConfigSubset *sub_parent, struct Notify *not_parent)
	Create a new Config Subset.
void	cs_subset_free (struct ConfigSubset **ptr)
	Free a Config Subset.
struct HashElem *	cs_subset_create_inheritance (const struct ConfigSubset *sub, const char *name)
	Create a Subset config item (inherited)
struct HashElem *	cs_subset_lookup (const struct ConfigSubset *sub, const char *name)
	Find an inherited config item.
void	cs_subset_notify_observers (const struct ConfigSubset *sub, struct HashElem *he, enum NotifyConfig ev)
	Notify all observers of an event.
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.
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.
int	cs_subset_he_reset (const struct ConfigSubset *sub, struct HashElem *he, struct Buffer *err)
	Reset a config item to its initial value.
int	cs_subset_he_string_get (const struct ConfigSubset *sub, struct HashElem *he, struct Buffer *result)
	Get a config item as a string.
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.
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.
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.
int	cs_subset_he_delete (const struct ConfigSubset *sub, struct HashElem *he, struct Buffer *err)
	Delete config item from a config.
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.
int	cs_subset_str_string_get (const struct ConfigSubset *sub, const char *name, struct Buffer *result)
	Get a config item as a string.
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.
int	elem_list_sort (const void *a, const void *b, void *sdata)
	Compare two HashElem pointers to config - Implements sort_t -.
struct HashElemArray	get_elem_list (struct ConfigSet *cs, enum GetElemListFlags flags)
	Create a sorted list of all config items.

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 35 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_DELETED	Config item has been deleted.

Definition at line 59 of file subset.h.

{
  NT_CONFIG_SET = 1,     
  NT_CONFIG_RESET,       
  NT_CONFIG_DELETED,     
};

GetElemListFlags

enum GetElemListFlags

Flags for get_elem_list()

Enumerator
GEL_ALL_CONFIG	All the normal config (no synonyms or deprecated)
GEL_CHANGED_CONFIG	Only config that has been changed.

Definition at line 79 of file subset.h.

{
  GEL_ALL_CONFIG,        
  GEL_CHANGED_CONFIG,    
};

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 158 of file subset.c.

{
  struct ConfigSubset *sub = MUTT_MEM_CALLOC(1, struct ConfigSubset);
 
  if (sub_parent)
  {
    sub->parent = sub_parent;
    sub->cs = sub_parent->cs;
  }
 
  if (name)
  {
    char scope[256] = { 0 };
 
    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 112 of file subset.c.

{
  if (!ptr || !*ptr)
    return;
 
  struct ConfigSubset *sub = *ptr;
 
  struct EventConfig ev_c = { sub, NULL, NULL };
  mutt_debug(LL_NOTIFY, "NT_CONFIG_DELETED: ALL\n");
  notify_send(sub->notify, NT_CONFIG, NT_CONFIG_DELETED, &ev_c);
 
  if (sub->cs && sub->name)
  {
    char scope[256] = { 0 };
    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 HashElemArray hea = get_elem_list(sub->cs, GEL_ALL_CONFIG);
    struct HashElem **hep = NULL;
    ARRAY_FOREACH(hep, &hea)
    {
      struct HashElem *he = *hep;
      const char *item = he->key.strkey;
      if (mutt_str_startswith(item, scope) != 0)
      {
        cs_uninherit_variable(sub->cs, item);
      }
    }
    ARRAY_FREE(&hea);
  }
 
  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 214 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] = { 0 };
  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 193 of file subset.c.

{
  if (!sub || !name)
    return NULL;
 
  char scope[256] = { 0 };
  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 243 of file subset.c.

{
  if (!sub || !he)
    return;
 
  struct HashElem *he_base = cs_get_base(he);
  struct EventConfig ev_c = { sub, he_base->key.strkey, he };
  mutt_debug(LL_NOTIFY, "%s: %s\n",
             NONULL(mutt_map_get_name(ev, ConfigEventNames)), he_base->key.strkey);
  notify_send(sub->notify, NT_CONFIG, ev, &ev_c);
}

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 264 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 281 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 318 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 338 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 430 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 408 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 370 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_he_delete()

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

Delete config item from a config.

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 451 of file subset.c.

{
  if (!sub)
    return CSR_ERR_CODE;
 
  const char *name = mutt_str_dup(he->key.strkey);
  int rc = cs_he_delete(sub->cs, he, err);
 
  if (CSR_RESULT(rc) == CSR_SUCCESS)
  {
    struct EventConfig ev_c = { sub, name, NULL };
    mutt_debug(LL_NOTIFY, "NT_CONFIG_DELETED: %s\n", name);
    notify_send(sub->notify, NT_CONFIG, NT_CONFIG_DELETED, &ev_c);
  }
 
  FREE(&name);
  return rc;
}

Here is the call graph for this function:

Here is the caller 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 303 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_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 354 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_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 392 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:

get_elem_list()

struct HashElemArray get_elem_list	(	struct ConfigSet *	cs,
		enum GetElemListFlags	flags )

Create a sorted list of all config items.

Parameters

cs	ConfigSet to read
flags	Flags, e.g. GEL_ALL_CONFIG

Return values

ptr	Array of HashElem

Definition at line 81 of file subset.c.

{
  struct HashElemArray hea = ARRAY_HEAD_INITIALIZER;
 
  if (!cs)
    return hea;
 
  struct HashWalkState walk = { 0 };
  struct HashElem *he = NULL;
  while ((he = mutt_hash_walk(cs->hash, &walk)))
  {
    if ((CONFIG_TYPE(he->type) == DT_SYNONYM) || (he->type & D_INTERNAL_DEPRECATED))
      continue;
 
    if ((flags == GEL_CHANGED_CONFIG) && !cs_he_has_been_set(cs, he))
      continue;
 
    ARRAY_ADD(&hea, he);
  }
 
  ARRAY_SORT(&hea, elem_list_sort, NULL);
 
  return hea;
}

Here is the call graph for this function:

Here is the caller graph for this function: