Reset a config item to its initial value. More...

Collaboration diagram for reset():

Functions
static int	address_reset (const struct ConfigSet cs, void var, const struct ConfigDef cdef, struct Buffer err)
	Reset an Address to its initial value - Implements ConfigSetType::reset() -.

static int	bool_reset (const struct ConfigSet cs, void var, const struct ConfigDef cdef, struct Buffer err)
	Reset a Bool to its initial value - Implements ConfigSetType::reset() -.

static int	enum_reset (const struct ConfigSet cs, void var, const struct ConfigDef cdef, struct Buffer err)
	Reset an Enumeration to its initial value - Implements ConfigSetType::reset() -.

static int	long_reset (const struct ConfigSet cs, void var, const struct ConfigDef cdef, struct Buffer err)
	Reset a Long to its initial value - Implements ConfigSetType::reset() -.

static int	mbtable_reset (const struct ConfigSet cs, void var, const struct ConfigDef cdef, struct Buffer err)
	Reset an MbTable to its initial value - Implements ConfigSetType::reset() -.

static int	myvar_reset (const struct ConfigSet cs, void var, const struct ConfigDef cdef, struct Buffer err)
	Reset a MyVar to its initial value - Implements ConfigSetType::reset() -.

static int	number_reset (const struct ConfigSet cs, void var, const struct ConfigDef cdef, struct Buffer err)
	Reset a Number to its initial value - Implements ConfigSetType::reset() -.

static int	path_reset (const struct ConfigSet cs, void var, const struct ConfigDef cdef, struct Buffer err)
	Reset a Path to its initial value - Implements ConfigSetType::reset() -.

static int	quad_reset (const struct ConfigSet cs, void var, const struct ConfigDef cdef, struct Buffer err)
	Reset a Quad-option to its initial value - Implements ConfigSetType::reset() -.

static int	regex_reset (const struct ConfigSet cs, void var, const struct ConfigDef cdef, struct Buffer err)
	Reset a Regex to its initial value - Implements ConfigSetType::reset() -.

static int	slist_reset (const struct ConfigSet cs, void var, const struct ConfigDef cdef, struct Buffer err)
	Reset a Slist to its initial value - Implements ConfigSetType::reset() -.

static int	sort_reset (const struct ConfigSet cs, void var, const struct ConfigDef cdef, struct Buffer err)
	Reset a Sort to its initial value - Implements ConfigSetType::reset() -.

static int	string_reset (const struct ConfigSet cs, void var, const struct ConfigDef cdef, struct Buffer err)
	Reset a String to its initial value - Implements ConfigSetType::reset() -.

static int	expando_reset (const struct ConfigSet cs, void var, const struct ConfigDef cdef, struct Buffer err)
	Reset an Expando to its initial value - Implements ConfigSetType::reset() -.

Detailed Description

Reset a config item to its initial value.

Parameters

cs	Config items
var	Variable to reset
cdef	Variable definition
err	Buffer for error messages (may be NULL)

Return values

num	Result, e.g. CSR_SUCCESS

Precondition: cs is not NULL; var is not NULL; cdef is not NULL

Function Documentation

◆ address_reset()

static int address_reset	(	const struct ConfigSet *	cs,
		void *	var,
		const struct ConfigDef *	cdef,
		struct Buffer *	err
	)

static

Reset an Address to its initial value - Implements ConfigSetType::reset() -.

Definition at line 219 of file config_type.c.

{
  struct Address *a = NULL;
  const char *initial = (const char *) cdef->initial;
 
  if (initial)
    a = address_new(initial);
 
  int rc = CSR_SUCCESS;
 
  if (cdef->validator)
  {
    rc = cdef->validator(cs, cdef, (intptr_t) a, err);
 
    if (CSR_RESULT(rc) != CSR_SUCCESS)
    {
      address_destroy(cs, &a, cdef);
      return rc | CSR_INV_VALIDATOR;
    }
  }
 
  if (!a)
    rc |= CSR_SUC_EMPTY;
 
  address_destroy(cs, var, cdef);
 
  *(struct Address **) var = a;
  return rc;
}

Here is the call graph for this function:

◆ bool_reset()

static int bool_reset	(	const struct ConfigSet *	cs,
		void *	var,
		const struct ConfigDef *	cdef,
		struct Buffer *	err
	)

static

Reset a Bool to its initial value - Implements ConfigSetType::reset() -.

Definition at line 168 of file bool.c.

{
  if (cdef->initial == (*(bool *) var))
    return CSR_SUCCESS | CSR_SUC_NO_CHANGE;
 
  if (startup_only(cdef, err))
    return CSR_ERR_INVALID | CSR_INV_VALIDATOR;
 
  if (cdef->validator)
  {
    int rc = cdef->validator(cs, cdef, cdef->initial, err);
 
    if (CSR_RESULT(rc) != CSR_SUCCESS)
      return rc | CSR_INV_VALIDATOR;
  }
 
  *(bool *) var = cdef->initial;
  return CSR_SUCCESS;
}

Here is the call graph for this function:

◆ enum_reset()

static int enum_reset	(	const struct ConfigSet *	cs,
		void *	var,
		const struct ConfigDef *	cdef,
		struct Buffer *	err
	)

static

Reset an Enumeration to its initial value - Implements ConfigSetType::reset() -.

Definition at line 172 of file enum.c.

{
  if (!cs || !var || !cdef)
    return CSR_ERR_CODE; /* LCOV_EXCL_LINE */
 
  if (cdef->initial == (*(unsigned char *) var))
    return CSR_SUCCESS | CSR_SUC_NO_CHANGE;
 
  if (startup_only(cdef, err))
    return CSR_ERR_INVALID | CSR_INV_VALIDATOR;
 
  if (cdef->validator)
  {
    int rc = cdef->validator(cs, cdef, cdef->initial, err);
 
    if (CSR_RESULT(rc) != CSR_SUCCESS)
      return rc | CSR_INV_VALIDATOR;
  }
 
  *(unsigned char *) var = cdef->initial;
  return CSR_SUCCESS;
}

Here is the call graph for this function:

◆ long_reset()

static int long_reset	(	const struct ConfigSet *	cs,
		void *	var,
		const struct ConfigDef *	cdef,
		struct Buffer *	err
	)

static

Reset a Long to its initial value - Implements ConfigSetType::reset() -.

Definition at line 230 of file long.c.

{
  if (cdef->initial == (*(long *) var))
    return CSR_SUCCESS | CSR_SUC_NO_CHANGE;
 
  if (startup_only(cdef, err))
    return CSR_ERR_INVALID | CSR_INV_VALIDATOR;
 
  if (cdef->validator)
  {
    int rc = cdef->validator(cs, cdef, cdef->initial, err);
 
    if (CSR_RESULT(rc) != CSR_SUCCESS)
      return rc | CSR_INV_VALIDATOR;
  }
 
  *(long *) var = cdef->initial;
  return CSR_SUCCESS;
}

Here is the call graph for this function:

◆ mbtable_reset()

static int mbtable_reset	(	const struct ConfigSet *	cs,
		void *	var,
		const struct ConfigDef *	cdef,
		struct Buffer *	err
	)

static

Reset an MbTable to its initial value - Implements ConfigSetType::reset() -.

Definition at line 262 of file mbtable.c.

{
  struct MbTable *table = NULL;
  const char *initial = (const char *) cdef->initial;
 
  struct MbTable *curtable = *(struct MbTable **) var;
  const char *curval = curtable ? curtable->orig_str : NULL;
 
  int rc = CSR_SUCCESS;
  if (!curtable)
    rc |= CSR_SUC_EMPTY;
 
  if (mutt_str_equal(initial, curval))
    return rc | CSR_SUC_NO_CHANGE;
 
  if (startup_only(cdef, err))
    return CSR_ERR_INVALID | CSR_INV_VALIDATOR;
 
  if (initial)
    table = mbtable_parse(initial);
 
  if (cdef->validator)
  {
    rc = cdef->validator(cs, cdef, (intptr_t) table, err);
 
    if (CSR_RESULT(rc) != CSR_SUCCESS)
    {
      mbtable_destroy(cs, &table, cdef);
      return rc | CSR_INV_VALIDATOR;
    }
  }
 
  if (!table)
    rc |= CSR_SUC_EMPTY;
 
  mbtable_destroy(cs, var, cdef);
 
  *(struct MbTable **) var = table;
  return rc;
}

Here is the call graph for this function:

◆ myvar_reset()

static int myvar_reset	(	const struct ConfigSet *	cs,
		void *	var,
		const struct ConfigDef *	cdef,
		struct Buffer *	err
	)

static

Reset a MyVar to its initial value - Implements ConfigSetType::reset() -.

Definition at line 180 of file myvar.c.

{
  int rc = CSR_SUCCESS;
 
  const char *str = mutt_str_dup((const char *) cdef->initial);
  if (!str)
    rc |= CSR_SUC_EMPTY;
 
  if (mutt_str_equal(str, (*(char **) var)))
  {
    FREE(&str);
    return rc | CSR_SUC_NO_CHANGE;
  }
 
  myvar_destroy(cs, var, cdef);
 
  if (!str)
    rc |= CSR_SUC_EMPTY;
 
  *(const char **) var = str;
  return rc;
}

Here is the call graph for this function:

◆ number_reset()

static int number_reset	(	const struct ConfigSet *	cs,
		void *	var,
		const struct ConfigDef *	cdef,
		struct Buffer *	err
	)

static

Reset a Number to its initial value - Implements ConfigSetType::reset() -.

Definition at line 251 of file number.c.

{
  if (cdef->initial == (*(short *) var))
    return CSR_SUCCESS | CSR_SUC_NO_CHANGE;
 
  if (cdef->validator)
  {
    int rc = cdef->validator(cs, cdef, cdef->initial, err);
 
    if (CSR_RESULT(rc) != CSR_SUCCESS)
      return rc | CSR_INV_VALIDATOR;
  }
 
  if (startup_only(cdef, err))
    return CSR_ERR_INVALID | CSR_INV_VALIDATOR;
 
  *(short *) var = cdef->initial;
  return CSR_SUCCESS;
}

Here is the call graph for this function:

◆ path_reset()

static int path_reset	(	const struct ConfigSet *	cs,
		void *	var,
		const struct ConfigDef *	cdef,
		struct Buffer *	err
	)

static

Reset a Path to its initial value - Implements ConfigSetType::reset() -.

Definition at line 220 of file path.c.

{
  int rc = CSR_SUCCESS;
 
  const char *str = path_tidy((const char *) cdef->initial, cdef->type & D_PATH_DIR);
  if (!str)
    rc |= CSR_SUC_EMPTY;
 
  if (mutt_str_equal(str, (*(char **) var)))
  {
    FREE(&str);
    return rc | CSR_SUC_NO_CHANGE;
  }
 
  if (startup_only(cdef, err))
  {
    FREE(&str);
    return CSR_ERR_INVALID | CSR_INV_VALIDATOR;
  }
 
  if (cdef->validator)
  {
    rc = cdef->validator(cs, cdef, cdef->initial, err);
 
    if (CSR_RESULT(rc) != CSR_SUCCESS)
    {
      FREE(&str);
      return rc | CSR_INV_VALIDATOR;
    }
  }
 
  path_destroy(cs, var, cdef);
 
  if (!str)
    rc |= CSR_SUC_EMPTY;
 
  *(const char **) var = str;
  return rc;
}

Here is the call graph for this function:

◆ quad_reset()

static int quad_reset	(	const struct ConfigSet *	cs,
		void *	var,
		const struct ConfigDef *	cdef,
		struct Buffer *	err
	)

static

Reset a Quad-option to its initial value - Implements ConfigSetType::reset() -.

Definition at line 173 of file quad.c.

{
  if (cdef->initial == (*(char *) var))
    return CSR_SUCCESS | CSR_SUC_NO_CHANGE;
 
  if (startup_only(cdef, err))
    return CSR_ERR_INVALID | CSR_INV_VALIDATOR;
 
  if (cdef->validator)
  {
    int rc = cdef->validator(cs, cdef, cdef->initial, err);
 
    if (CSR_RESULT(rc) != CSR_SUCCESS)
      return rc | CSR_INV_VALIDATOR;
  }
 
  *(char *) var = cdef->initial;
  return CSR_SUCCESS;
}

Here is the call graph for this function:

◆ regex_reset()

static int regex_reset	(	const struct ConfigSet *	cs,
		void *	var,
		const struct ConfigDef *	cdef,
		struct Buffer *	err
	)

static

Reset a Regex to its initial value - Implements ConfigSetType::reset() -.

Definition at line 286 of file regex.c.

{
  struct Regex *r = NULL;
  const char *initial = (const char *) cdef->initial;
 
  struct Regex *currx = *(struct Regex **) var;
  const char *curval = currx ? currx->pattern : NULL;
 
  int rc = CSR_SUCCESS;
  if (!currx)
    rc |= CSR_SUC_EMPTY;
 
  if (mutt_str_equal(initial, curval))
    return rc | CSR_SUC_NO_CHANGE;
 
  if (startup_only(cdef, err))
    return CSR_ERR_INVALID | CSR_INV_VALIDATOR;
 
  if (initial)
  {
    r = regex_new(initial, cdef->type, err);
    if (!r)
      return CSR_ERR_CODE;
  }
 
  if (cdef->validator)
  {
    rc = cdef->validator(cs, cdef, (intptr_t) r, err);
 
    if (CSR_RESULT(rc) != CSR_SUCCESS)
    {
      regex_destroy(cs, &r, cdef);
      return rc | CSR_INV_VALIDATOR;
    }
  }
 
  if (!r)
    rc |= CSR_SUC_EMPTY;
 
  regex_destroy(cs, var, cdef);
 
  *(struct Regex **) var = r;
  return rc;
}

Here is the call graph for this function:

◆ slist_reset()

static int slist_reset	(	const struct ConfigSet *	cs,
		void *	var,
		const struct ConfigDef *	cdef,
		struct Buffer *	err
	)

static

Reset a Slist to its initial value - Implements ConfigSetType::reset() -.

Definition at line 298 of file slist.c.

{
  if (!cs || !var || !cdef)
    return CSR_ERR_CODE; /* LCOV_EXCL_LINE */
 
  struct Slist *list = NULL;
  const char *initial = (const char *) cdef->initial;
 
  if (initial)
    list = slist_parse(initial, cdef->type);
 
  if (slist_equal(list, *(struct Slist **) var))
  {
    slist_free(&list);
    return CSR_SUCCESS | CSR_SUC_NO_CHANGE;
  }
 
  if (startup_only(cdef, err))
  {
    slist_free(&list);
    return CSR_ERR_INVALID | CSR_INV_VALIDATOR;
  }
 
  int rc = CSR_SUCCESS;
 
  if (cdef->validator)
  {
    rc = cdef->validator(cs, cdef, (intptr_t) list, err);
 
    if (CSR_RESULT(rc) != CSR_SUCCESS)
    {
      slist_destroy(cs, &list, cdef);
      return rc | CSR_INV_VALIDATOR;
    }
  }
 
  if (!list)
    rc |= CSR_SUC_EMPTY;
 
  slist_destroy(cs, var, cdef);
 
  *(struct Slist **) var = list;
  return rc;
}

Here is the call graph for this function:

◆ sort_reset()

static int sort_reset	(	const struct ConfigSet *	cs,
		void *	var,
		const struct ConfigDef *	cdef,
		struct Buffer *	err
	)

static

Reset a Sort to its initial value - Implements ConfigSetType::reset() -.

Definition at line 199 of file sort.c.

{
  if (cdef->initial == (*(short *) var))
    return CSR_SUCCESS | CSR_SUC_NO_CHANGE;
 
  if (startup_only(cdef, err))
    return CSR_ERR_INVALID | CSR_INV_VALIDATOR;
 
  if (cdef->validator)
  {
    int rc = cdef->validator(cs, cdef, cdef->initial, err);
 
    if (CSR_RESULT(rc) != CSR_SUCCESS)
      return rc | CSR_INV_VALIDATOR;
  }
 
  *(short *) var = cdef->initial;
  return CSR_SUCCESS;
}

Here is the call graph for this function:

◆ string_reset()

static int string_reset	(	const struct ConfigSet *	cs,
		void *	var,
		const struct ConfigDef *	cdef,
		struct Buffer *	err
	)

static

Reset a String to its initial value - Implements ConfigSetType::reset() -.

Definition at line 231 of file string.c.

{
  int rc = CSR_SUCCESS;
 
  const char *str = mutt_str_dup((const char *) cdef->initial);
  if (!str)
    rc |= CSR_SUC_EMPTY;
 
  if (mutt_str_equal(str, (*(char **) var)))
  {
    FREE(&str);
    return rc | CSR_SUC_NO_CHANGE;
  }
 
  if (startup_only(cdef, err))
  {
    FREE(&str);
    return CSR_ERR_INVALID | CSR_INV_VALIDATOR;
  }
 
  if (cdef->validator)
  {
    rc = cdef->validator(cs, cdef, cdef->initial, err);
 
    if (CSR_RESULT(rc) != CSR_SUCCESS)
    {
      FREE(&str);
      return rc | CSR_INV_VALIDATOR;
    }
  }
 
  string_destroy(cs, var, cdef);
 
  if (!str)
    rc |= CSR_SUC_EMPTY;
 
  *(const char **) var = str;
  return rc;
}

Here is the call graph for this function:

◆ expando_reset()

static int expando_reset	(	const struct ConfigSet *	cs,
		void *	var,
		const struct ConfigDef *	cdef,
		struct Buffer *	err
	)

static

Reset an Expando to its initial value - Implements ConfigSetType::reset() -.

Definition at line 285 of file config_type.c.

{
  if (!cs || !var || !cdef)
    return CSR_ERR_CODE; /* LCOV_EXCL_LINE */
 
  struct Expando *exp = NULL;
  const char *initial = (const char *) cdef->initial;
 
  if (initial)
  {
    const struct ExpandoDefinition *defs = (const struct ExpandoDefinition *)
                                               cdef->data;
    exp = expando_parse(initial, defs, err);
  }
 
  if (expando_equal(exp, *(struct Expando **) var))
  {
    expando_free(&exp);
    return CSR_SUCCESS | CSR_SUC_NO_CHANGE;
  }
 
  if (startup_only(cdef, err))
  {
    expando_free(&exp);
    return CSR_ERR_INVALID | CSR_INV_VALIDATOR;
  }
 
  int rc = CSR_SUCCESS;
 
  if (cdef->validator)
  {
    rc = cdef->validator(cs, cdef, (intptr_t) exp, err);
 
    if (CSR_RESULT(rc) != CSR_SUCCESS)
    {
      expando_destroy(cs, &exp, cdef);
      return rc | CSR_INV_VALIDATOR;
    }
  }
 
  if (!exp)
    rc |= CSR_SUC_EMPTY;
 
  expando_destroy(cs, var, cdef);
 
  *(struct Expando **) var = exp;
  return rc;
}

Here is the call graph for this function:

Functions

Detailed Description

Function Documentation

◆ address_reset()

◆ bool_reset()

◆ enum_reset()

◆ long_reset()

◆ mbtable_reset()

◆ myvar_reset()

◆ number_reset()

◆ path_reset()

◆ quad_reset()

◆ regex_reset()

◆ slist_reset()

◆ sort_reset()

◆ string_reset()

◆ expando_reset()