string_get()

Get a config item as a string. More...

Collaboration diagram for string_get():

Functions
static int	address_string_get (void *var, const struct ConfigDef *cdef, struct Buffer *result)
	Get an Address as a string - Implements ConfigSetType::string_get() -.
static int	bool_string_get (void *var, const struct ConfigDef *cdef, struct Buffer *result)
	Get a Bool as a string - Implements ConfigSetType::string_get() -.
static int	enum_string_get (void *var, const struct ConfigDef *cdef, struct Buffer *result)
	Get an Enumeration as a string - Implements ConfigSetType::string_get() -.
static int	long_string_get (void *var, const struct ConfigDef *cdef, struct Buffer *result)
	Get a Long as a string - Implements ConfigSetType::string_get() -.
static int	mbtable_string_get (void *var, const struct ConfigDef *cdef, struct Buffer *result)
	Get a MbTable as a string - Implements ConfigSetType::string_get() -.
static int	myvar_string_get (void *var, const struct ConfigDef *cdef, struct Buffer *result)
	Get a MyVar as a string - Implements ConfigSetType::string_get() -.
static int	number_string_get (void *var, const struct ConfigDef *cdef, struct Buffer *result)
	Get a Number as a string - Implements ConfigSetType::string_get() -.
static int	path_string_get (void *var, const struct ConfigDef *cdef, struct Buffer *result)
	Get a Path as a string - Implements ConfigSetType::string_get() -.
static int	quad_string_get (void *var, const struct ConfigDef *cdef, struct Buffer *result)
	Get a Quad-option as a string - Implements ConfigSetType::string_get() -.
static int	regex_string_get (void *var, const struct ConfigDef *cdef, struct Buffer *result)
	Get a Regex as a string - Implements ConfigSetType::string_get() -.
static int	slist_string_get (void *var, const struct ConfigDef *cdef, struct Buffer *result)
	Get a Slist as a string - Implements ConfigSetType::string_get() -.
static int	sort_string_get (void *var, const struct ConfigDef *cdef, struct Buffer *result)
	Get a Sort as a string - Implements ConfigSetType::string_get() -.
static int	string_string_get (void *var, const struct ConfigDef *cdef, struct Buffer *result)
	Get a String as a string - Implements ConfigSetType::string_get() -.
static int	expando_string_get (void *var, const struct ConfigDef *cdef, struct Buffer *result)
	Get an Expando as a string - Implements ConfigSetType::string_get() -.

Detailed Description

Get a config item as a string.

Parameters

var	Variable to get (may be NULL)
cdef	Variable definition
result	Buffer for results or error messages

Return values

num	Result, e.g. CSR_SUCCESS

If var is NULL, then the config item's initial value will be returned.

Precondition

cdef is not NULL

result is not NULL

Function Documentation

address_string_get()

static int address_string_get ( void * var, const struct ConfigDef * cdef, struct Buffer * result )

static

Get an Address as a string - Implements ConfigSetType::string_get() -.

Definition at line 137 of file config_type.c.

{
  if (var)
  {
    struct Address *a = *(struct Address **) var;
    if (a)
    {
      mutt_addr_write(result, a, false);
    }
  }
  else
  {
    buf_addstr(result, (char *) cdef->initial);
  }
 
  if (buf_is_empty(result))
    return CSR_SUCCESS | CSR_SUC_EMPTY; /* empty string */
 
  return CSR_SUCCESS;
}

Here is the call graph for this function:

bool_string_get()

static int bool_string_get ( void * var, const struct ConfigDef * cdef, struct Buffer * result )

static

Get a Bool as a string - Implements ConfigSetType::string_get() -.

Definition at line 109 of file bool.c.

{
  int index;
 
  if (var)
    index = *(bool *) var;
  else
    index = (int) cdef->initial;
 
  if (index > 1)
    return CSR_ERR_INVALID | CSR_INV_TYPE; /* LCOV_EXCL_LINE */
 
  buf_addstr(result, BoolValues[index]);
  return CSR_SUCCESS;
}

Here is the call graph for this function:

enum_string_get()

static int enum_string_get ( void * var, const struct ConfigDef * cdef, struct Buffer * result )

static

Get an Enumeration as a string - Implements ConfigSetType::string_get() -.

Definition at line 91 of file enum.c.

{
  unsigned int value;
 
  if (var)
    value = *(unsigned char *) var;
  else
    value = (int) cdef->initial;
 
  struct EnumDef *ed = (struct EnumDef *) cdef->data;
  if (!ed || !ed->lookup)
    return CSR_ERR_CODE;
 
  const char *name = mutt_map_get_name(value, ed->lookup);
  if (!name)
  {
    mutt_debug(LL_DEBUG1, "Variable has an invalid value: %d\n", value);
    return CSR_ERR_INVALID | CSR_INV_TYPE;
  }
 
  buf_addstr(result, name);
  return CSR_SUCCESS;
}

Here is the call graph for this function:

long_string_get()

static int long_string_get ( void * var, const struct ConfigDef * cdef, struct Buffer * result )

static

Get a Long as a string - Implements ConfigSetType::string_get() -.

Definition at line 97 of file long.c.

{
  int value;
 
  if (var)
    value = *(long *) var;
  else
    value = (int) cdef->initial;
 
  buf_printf(result, "%d", value);
  return CSR_SUCCESS;
}

Here is the call graph for this function:

mbtable_string_get()

static int mbtable_string_get ( void * var, const struct ConfigDef * cdef, struct Buffer * result )

static

Get a MbTable as a string - Implements ConfigSetType::string_get() -.

Definition at line 177 of file mbtable.c.

{
  const char *str = NULL;
 
  if (var)
  {
    struct MbTable *table = *(struct MbTable **) var;
    if (!table || !table->orig_str)
      return CSR_SUCCESS | CSR_SUC_EMPTY; /* empty string */
    str = table->orig_str;
  }
  else
  {
    str = (char *) cdef->initial;
  }
 
  buf_addstr(result, str);
  return CSR_SUCCESS;
}

Here is the call graph for this function:

myvar_string_get()

static int myvar_string_get ( void * var, const struct ConfigDef * cdef, struct Buffer * result )

static

Get a MyVar as a string - Implements ConfigSetType::string_get() -.

Definition at line 94 of file myvar.c.

{
  const char *str = NULL;
 
  if (var)
    str = *(const char **) var;
  else
    str = (char *) cdef->initial;
 
  if (!str)
    return CSR_SUCCESS | CSR_SUC_EMPTY; /* empty myvar */
 
  buf_addstr(result, str);
  return CSR_SUCCESS;
}

Here is the call graph for this function:

number_string_get()

static int number_string_get ( void * var, const struct ConfigDef * cdef, struct Buffer * result )

static

Get a Number as a string - Implements ConfigSetType::string_get() -.

Definition at line 130 of file number.c.

{
  int value;
 
  if (var)
    value = native_get(var);
  else
    value = (int) cdef->initial;
 
  buf_printf(result, "%d", value);
  return CSR_SUCCESS;
}

Here is the call graph for this function:

path_string_get()

static int path_string_get ( void * var, const struct ConfigDef * cdef, struct Buffer * result )

static

Get a Path as a string - Implements ConfigSetType::string_get() -.

Definition at line 143 of file path.c.

{
  const char *str = NULL;
 
  if (var)
    str = *(const char **) var;
  else
    str = (char *) cdef->initial;
 
  if (!str)
    return CSR_SUCCESS | CSR_SUC_EMPTY; /* empty path */
 
  buf_addstr(result, str);
  return CSR_SUCCESS;
}

Here is the call graph for this function:

quad_string_get()

static int quad_string_get ( void * var, const struct ConfigDef * cdef, struct Buffer * result )

static

Get a Quad-option as a string - Implements ConfigSetType::string_get() -.

Definition at line 112 of file quad.c.

{
  unsigned int value;
 
  if (var)
    value = *(char *) var;
  else
    value = (int) cdef->initial;
 
  if (value >= (countof(QuadValues) - 1))
  {
    mutt_debug(LL_DEBUG1, "Variable has an invalid value: %d\n", value); /* LCOV_EXCL_LINE */
    return CSR_ERR_INVALID | CSR_INV_TYPE; /* LCOV_EXCL_LINE */
  }
 
  buf_addstr(result, QuadValues[value]);
  return CSR_SUCCESS;
}

Here is the call graph for this function:

regex_string_get()

static int regex_string_get ( void * var, const struct ConfigDef * cdef, struct Buffer * result )

static

Get a Regex as a string - Implements ConfigSetType::string_get() -.

Definition at line 202 of file regex.c.

{
  const char *str = NULL;
 
  if (var)
  {
    struct Regex *r = *(struct Regex **) var;
    if (r)
      str = r->pattern;
  }
  else
  {
    str = (char *) cdef->initial;
  }
 
  if (!str)
    return CSR_SUCCESS | CSR_SUC_EMPTY; /* empty string */
 
  buf_addstr(result, str);
  return CSR_SUCCESS;
}

Here is the call graph for this function:

slist_string_get()

static int slist_string_get ( void * var, const struct ConfigDef * cdef, struct Buffer * result )

static

Get a Slist as a string - Implements ConfigSetType::string_get() -.

Definition at line 119 of file slist.c.

{
  if (var)
  {
    struct Slist *list = *(struct Slist **) var;
    if (!list)
      return CSR_SUCCESS | CSR_SUC_EMPTY; /* empty string */
 
    slist_to_buffer(list, result);
  }
  else
  {
    buf_addstr(result, (char *) cdef->initial);
  }
 
  int rc = CSR_SUCCESS;
  if (buf_is_empty(result))
    rc |= CSR_SUC_EMPTY;
 
  return rc;
}

Here is the call graph for this function:

sort_string_get()

static int sort_string_get ( void * var, const struct ConfigDef * cdef, struct Buffer * result )

static

Get a Sort as a string - Implements ConfigSetType::string_get() -.

Definition at line 123 of file sort.c.

{
  int sort;
 
  if (var)
    sort = *(short *) var;
  else
    sort = (int) cdef->initial;
 
  if (sort & SORT_REVERSE)
    buf_addstr(result, PREFIX_REVERSE);
  if (sort & SORT_LAST)
    buf_addstr(result, PREFIX_LAST);
 
  sort &= SORT_MASK;
 
  const char *str = NULL;
 
  str = mutt_map_get_name(sort, (struct Mapping *) cdef->data);
 
  if (!str)
  {
    mutt_debug(LL_DEBUG1, "Variable has an invalid value: %d/%d\n", cdef->type, sort);
    return CSR_ERR_INVALID | CSR_INV_TYPE;
  }
 
  buf_addstr(result, str);
  return CSR_SUCCESS;
}

Here is the call graph for this function:

string_string_get()

static int string_string_get ( void * var, const struct ConfigDef * cdef, struct Buffer * result )

static

Get a String as a string - Implements ConfigSetType::string_get() -.

Definition at line 114 of file string.c.

{
  const char *str = NULL;
 
  if (var)
    str = *(const char **) var;
  else
    str = (char *) cdef->initial;
 
  if (!str)
    return CSR_SUCCESS | CSR_SUC_EMPTY; /* empty string */
 
  buf_addstr(result, str);
  return CSR_SUCCESS;
}

Here is the call graph for this function:

expando_string_get()

static int expando_string_get ( void * var, const struct ConfigDef * cdef, struct Buffer * result )

static

Get an Expando as a string - Implements ConfigSetType::string_get() -.

Definition at line 135 of file config_type.c.

{
  const char *str = NULL;
 
  if (var)
  {
    struct Expando *exp = *(struct Expando **) var;
    if (exp)
      str = exp->string;
  }
  else
  {
    str = (char *) cdef->initial;
  }
 
  if (!str)
    return CSR_SUCCESS | CSR_SUC_EMPTY; /* empty string */
 
  buf_addstr(result, str);
  return CSR_SUCCESS;
}

Here is the call graph for this function: