helpers.h File Reference

Helper functions to get/set config values. More...

#include <stdbool.h>
#include "quad.h"

Include dependency graph for helpers.h:

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

Go to the source code of this file.

Functions
bool	cs_subset_bool (const struct ConfigSubset *sub, const char *name)
	Get a boolean config item by name.
unsigned char	cs_subset_enum (const struct ConfigSubset *sub, const char *name)
	Get a enumeration config item by name.
long	cs_subset_long (const struct ConfigSubset *sub, const char *name)
	Get a long config item by name.
struct MbTable *	cs_subset_mbtable (const struct ConfigSubset *sub, const char *name)
	Get a Multibyte table config item by name.
short	cs_subset_number (const struct ConfigSubset *sub, const char *name)
	Get a number config item by name.
const char *	cs_subset_path (const struct ConfigSubset *sub, const char *name)
	Get a path config item by name.
enum QuadOption	cs_subset_quad (const struct ConfigSubset *sub, const char *name)
	Get a quad-value config item by name.
const struct Regex *	cs_subset_regex (const struct ConfigSubset *sub, const char *name)
	Get a regex config item by name.
const struct Slist *	cs_subset_slist (const struct ConfigSubset *sub, const char *name)
	Get a string-list config item by name.
short	cs_subset_sort (const struct ConfigSubset *sub, const char *name)
	Get a sort config item by name.
const char *	cs_subset_string (const struct ConfigSubset *sub, const char *name)
	Get a string config item by name.
const struct Expando *	cs_subset_expando (const struct ConfigSubset *sub, const char *name)
	Get an Expando config item by name.
bool	config_he_set_initial (struct ConfigSet *cs, struct HashElem *he, const char *value)
	Set the initial value of a Config Option.
bool	config_str_set_initial (struct ConfigSet *cs, const char *name, const char *value)
	Set the initial value of a Config Option.

Detailed Description

Helper functions to get/set config values.

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

Function Documentation

cs_subset_bool()

bool cs_subset_bool	(	const struct ConfigSubset *	sub,
		const char *	name )

Get a boolean config item by name.

Parameters

sub	Config Subset
name	Name of config item

Return values

bool	Boolean value

Definition at line 47 of file helpers.c.

{
  ASSERT(sub && name);
 
  struct HashElem *he = cs_subset_create_inheritance(sub, name);
  ASSERT(he);
 
#ifndef NDEBUG
  struct HashElem *he_base = cs_get_base(he);
  ASSERT(CONFIG_TYPE(he_base->type) == DT_BOOL);
#endif
 
  intptr_t value = cs_subset_he_native_get(sub, he, NULL);
  ASSERT(value != INT_MIN);
 
  return (bool) value;
}

Here is the call graph for this function:

cs_subset_enum()

unsigned char cs_subset_enum	(	const struct ConfigSubset *	sub,
		const char *	name )

Get a enumeration config item by name.

Parameters

sub	Config Subset
name	Name of config item

Return values

num	Enumeration

Definition at line 71 of file helpers.c.

{
  ASSERT(sub && name);
 
  struct HashElem *he = cs_subset_create_inheritance(sub, name);
  ASSERT(he);
 
#ifndef NDEBUG
  struct HashElem *he_base = cs_get_base(he);
  ASSERT(CONFIG_TYPE(he_base->type) == DT_ENUM);
#endif
 
  intptr_t value = cs_subset_he_native_get(sub, he, NULL);
  ASSERT(value != INT_MIN);
 
  return (unsigned char) value;
}

Here is the call graph for this function:

Here is the caller graph for this function:

cs_subset_long()

long cs_subset_long	(	const struct ConfigSubset *	sub,
		const char *	name )

Get a long config item by name.

Parameters

sub	Config Subset
name	Name of config item

Return values

num	Long value

Definition at line 95 of file helpers.c.

{
  ASSERT(sub && name);
 
  struct HashElem *he = cs_subset_create_inheritance(sub, name);
  ASSERT(he);
 
#ifndef NDEBUG
  struct HashElem *he_base = cs_get_base(he);
  ASSERT(CONFIG_TYPE(he_base->type) == DT_LONG);
#endif
 
  intptr_t value = cs_subset_he_native_get(sub, he, NULL);
  ASSERT(value != INT_MIN);
 
  return (long) value;
}

Here is the call graph for this function:

Here is the caller graph for this function:

cs_subset_mbtable()

struct MbTable * cs_subset_mbtable	(	const struct ConfigSubset *	sub,
		const char *	name )

Get a Multibyte table config item by name.

Parameters

sub	Config Subset
name	Name of config item

Return values

ptr	Multibyte table

Definition at line 119 of file helpers.c.

{
  ASSERT(sub && name);
 
  struct HashElem *he = cs_subset_create_inheritance(sub, name);
  ASSERT(he);
 
#ifndef NDEBUG
  struct HashElem *he_base = cs_get_base(he);
  ASSERT(CONFIG_TYPE(he_base->type) == DT_MBTABLE);
#endif
 
  intptr_t value = cs_subset_he_native_get(sub, he, NULL);
  ASSERT(value != INT_MIN);
 
  return (struct MbTable *) value;
}

Here is the call graph for this function:

Here is the caller graph for this function:

cs_subset_number()

short cs_subset_number	(	const struct ConfigSubset *	sub,
		const char *	name )

Get a number config item by name.

Parameters

sub	Config Subset
name	Name of config item

Return values

num

Number

Definition at line 143 of file helpers.c.

{
  ASSERT(sub && name);
 
  struct HashElem *he = cs_subset_create_inheritance(sub, name);
  ASSERT(he);
 
#ifndef NDEBUG
  struct HashElem *he_base = cs_get_base(he);
  ASSERT(CONFIG_TYPE(he_base->type) == DT_NUMBER);
#endif
 
  intptr_t value = cs_subset_he_native_get(sub, he, NULL);
  ASSERT(value != INT_MIN);
 
  return (short) value;
}

Here is the call graph for this function:

cs_subset_path()

const char * cs_subset_path	(	const struct ConfigSubset *	sub,
		const char *	name )

Get a path config item by name.

Parameters

sub	Config Subset
name	Name of config item

Return values

ptr	Path
NULL	Empty path

Definition at line 168 of file helpers.c.

{
  ASSERT(sub && name);
 
  struct HashElem *he = cs_subset_create_inheritance(sub, name);
  ASSERT(he);
 
#ifndef NDEBUG
  struct HashElem *he_base = cs_get_base(he);
  ASSERT(CONFIG_TYPE(he_base->type) == DT_PATH);
#endif
 
  intptr_t value = cs_subset_he_native_get(sub, he, NULL);
  ASSERT(value != INT_MIN);
 
  return (const char *) value;
}

Here is the call graph for this function:

cs_subset_quad()

enum QuadOption cs_subset_quad	(	const struct ConfigSubset *	sub,
		const char *	name )

Get a quad-value config item by name.

Parameters

sub	Config Subset
name	Name of config item

Return values

num	Quad-value

Definition at line 192 of file helpers.c.

{
  ASSERT(sub && name);
 
  struct HashElem *he = cs_subset_create_inheritance(sub, name);
  ASSERT(he);
 
#ifndef NDEBUG
  struct HashElem *he_base = cs_get_base(he);
  ASSERT(CONFIG_TYPE(he_base->type) == DT_QUAD);
#endif
 
  intptr_t value = cs_subset_he_native_get(sub, he, NULL);
  ASSERT(value != INT_MIN);
 
  return (enum QuadOption) value;
}

Here is the call graph for this function:

Here is the caller graph for this function:

cs_subset_regex()

const struct Regex * cs_subset_regex	(	const struct ConfigSubset *	sub,
		const char *	name )

Get a regex config item by name.

Parameters

sub	Config Subset
name	Name of config item

Return values

ptr	Regex
NULL	Empty regex

Definition at line 217 of file helpers.c.

{
  ASSERT(sub && name);
 
  struct HashElem *he = cs_subset_create_inheritance(sub, name);
  ASSERT(he);
 
#ifndef NDEBUG
  struct HashElem *he_base = cs_get_base(he);
  ASSERT(CONFIG_TYPE(he_base->type) == DT_REGEX);
#endif
 
  intptr_t value = cs_subset_he_native_get(sub, he, NULL);
  ASSERT(value != INT_MIN);
 
  return (const struct Regex *) value;
}

Here is the call graph for this function:

Here is the caller graph for this function:

cs_subset_slist()

const struct Slist * cs_subset_slist	(	const struct ConfigSubset *	sub,
		const char *	name )

Get a string-list config item by name.

Parameters

sub	Config Subset
name	Name of config item

Return values

ptr	String list
NULL	Empty string list

Definition at line 242 of file helpers.c.

{
  ASSERT(sub && name);
 
  struct HashElem *he = cs_subset_create_inheritance(sub, name);
  ASSERT(he);
 
#ifndef NDEBUG
  struct HashElem *he_base = cs_get_base(he);
  ASSERT(CONFIG_TYPE(he_base->type) == DT_SLIST);
#endif
 
  intptr_t value = cs_subset_he_native_get(sub, he, NULL);
  ASSERT(value != INT_MIN);
 
  return (const struct Slist *) value;
}

Here is the call graph for this function:

Here is the caller graph for this function:

cs_subset_sort()

short cs_subset_sort	(	const struct ConfigSubset *	sub,
		const char *	name )

Get a sort config item by name.

Parameters

sub	Config Subset
name	Name of config item

Return values

num

Sort

Definition at line 266 of file helpers.c.

{
  ASSERT(sub && name);
 
  struct HashElem *he = cs_subset_create_inheritance(sub, name);
  ASSERT(he);
 
#ifndef NDEBUG
  struct HashElem *he_base = cs_get_base(he);
  ASSERT(CONFIG_TYPE(he_base->type) == DT_SORT);
#endif
 
  intptr_t value = cs_subset_he_native_get(sub, he, NULL);
  ASSERT(value != INT_MIN);
 
  return (short) value;
}

Here is the call graph for this function:

Here is the caller graph for this function:

cs_subset_string()

const char * cs_subset_string	(	const struct ConfigSubset *	sub,
		const char *	name )

Get a string config item by name.

Parameters

sub	Config Subset
name	Name of config item

Return values

ptr	String
NULL	Empty string

Definition at line 291 of file helpers.c.

{
  ASSERT(sub && name);
 
  struct HashElem *he = cs_subset_create_inheritance(sub, name);
  ASSERT(he);
 
#ifndef NDEBUG
  struct HashElem *he_base = cs_get_base(he);
  ASSERT(CONFIG_TYPE(he_base->type) == DT_STRING);
#endif
 
  intptr_t value = cs_subset_he_native_get(sub, he, NULL);
  ASSERT(value != INT_MIN);
 
  return (const char *) value;
}

Here is the call graph for this function:

cs_subset_expando()

const struct Expando * cs_subset_expando	(	const struct ConfigSubset *	sub,
		const char *	name )

Get an Expando config item by name.

Parameters

sub	Config Subset
name	Name of config item

Return values

ptr	Expando
NULL	Empty Expando

Definition at line 361 of file config_type.c.

{
  ASSERT(sub && name);
 
  struct HashElem *he = cs_subset_create_inheritance(sub, name);
  ASSERT(he);
 
#ifndef NDEBUG
  struct HashElem *he_base = cs_get_base(he);
  ASSERT(CONFIG_TYPE(he_base->type) == DT_EXPANDO);
#endif
 
  intptr_t value = cs_subset_he_native_get(sub, he, NULL);
  ASSERT(value != INT_MIN);
 
  return (const struct Expando *) value;
}

Here is the call graph for this function:

config_he_set_initial()

bool config_he_set_initial	(	struct ConfigSet *	cs,
		struct HashElem *	he,
		const char *	value )

Set the initial value of a Config Option.

Definition at line 312 of file helpers.c.

{
  if (!cs || !he)
    return false;
 
  struct Buffer *err = buf_pool_get();
 
  int rc = cs_he_initial_set(cs, he, value, err);
  if (!buf_is_empty(err))
    mutt_error("%s", buf_string(err)); // LCOV_EXCL_LINE
 
  buf_pool_release(&err);
  cs_he_reset(cs, he, NULL);
 
  return (CSR_RESULT(rc) == CSR_SUCCESS);
}

Here is the call graph for this function:

Here is the caller graph for this function:

config_str_set_initial()

bool config_str_set_initial	(	struct ConfigSet *	cs,
		const char *	name,
		const char *	value )

Set the initial value of a Config Option.

Definition at line 332 of file helpers.c.

{
  if (!cs || !name)
    return false;
 
  struct HashElem *he = cs_get_elem(cs, name);
  if (!he)
  {
    mutt_error(_("Unknown option %s"), name);
    return false;
  }
 
  return config_he_set_initial(cs, he, value);
}

Here is the call graph for this function:

Here is the caller graph for this function: