config_type.c File Reference

Config type representing an email address. More...

#include "config.h"
#include <limits.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include "mutt/lib.h"
#include "config/lib.h"
#include "config_type.h"
#include "address.h"

Include dependency graph for config_type.c:

Go to the source code of this file.

Functions
struct Address *	address_new (const char *addr)
	Create an Address from a string.
static void	address_destroy (void *var, const struct ConfigDef *cdef)
	Destroy an Address object - Implements ConfigSetType::destroy() -.
static int	address_string_set (void *var, struct ConfigDef *cdef, const char *value, struct Buffer *err)
	Set an Address by string - Implements ConfigSetType::string_set() -.
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 struct Address *	address_dup (struct Address *addr)
	Create a copy of an Address object.
static int	address_native_set (void *var, const struct ConfigDef *cdef, intptr_t value, struct Buffer *err)
	Set an Address config item by Address object - Implements ConfigSetType::native_set() -.
static intptr_t	address_native_get (void *var, const struct ConfigDef *cdef, struct Buffer *err)
	Get an Address object from an Address config item - Implements ConfigSetType::native_get() -.
static bool	address_has_been_set (void *var, const struct ConfigDef *cdef)
	Is the config value different to its initial value?
static int	address_reset (void *var, const struct ConfigDef *cdef, struct Buffer *err)
	Reset an Address to its initial value - Implements ConfigSetType::reset() -.
const struct Address *	cs_subset_address (const struct ConfigSubset *sub, const char *name)
	Get an Address config item by name.

Variables
const struct ConfigSetType	CstAddress
	Config type representing an Email Address.

Detailed Description

Config type representing an email address.

Authors

• Richard Russon
• Pietro Cerutti
• Dennis Schön

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 config_type.c.

Function Documentation

address_new()

struct Address * address_new

(

const char *

addr

)

Create an Address from a string.

Parameters

addr	Email address to parse

Return values

ptr	New Address object

Definition at line 52 of file config_type.c.

{
  struct Address *a = MUTT_MEM_CALLOC(1, struct Address);
  a->mailbox = buf_new(addr);
  return a;
}

Here is the call graph for this function:

Here is the caller graph for this function:

address_dup()

static struct Address * address_dup ( struct Address * addr )

static

Create a copy of an Address object.

Parameters

addr	Address to duplicate

Return values

ptr	New Address object

Definition at line 163 of file config_type.c.

{
  if (!addr)
    return NULL; /* LCOV_EXCL_LINE */
 
  struct Address *a = MUTT_MEM_CALLOC(1, struct Address);
  a->personal = buf_dup(addr->personal);
  a->mailbox = buf_dup(addr->mailbox);
  return a;
}

Here is the call graph for this function:

Here is the caller graph for this function:

cs_subset_address()

const struct Address * cs_subset_address	(	const struct ConfigSubset *	sub,
		const char *	name )

Get an Address config item by name.

Parameters

sub	Config Subset
name	Name of config item

Return values

ptr	Address
NULL	Empty address

Definition at line 286 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_ADDRESS);
#endif
 
  intptr_t value = cs_subset_he_native_get(sub, he, NULL);
  ASSERT(value != INT_MIN);
 
  return (const struct Address *) value;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

CstAddress

const struct ConfigSetType CstAddress

Initial value:

= {
  DT_ADDRESS,
  "address",
  address_string_set,
  address_string_get,
  address_native_set,
  address_native_get,
  NULL, 
  NULL, 
  address_has_been_set,
  address_reset,
  address_destroy,
}

Config type representing an Email Address.

Definition at line 265 of file config_type.c.

                                        {
  DT_ADDRESS,
  "address",
  address_string_set,
  address_string_get,
  address_native_set,
  address_native_get,
  NULL, // string_plus_equals
  NULL, // string_minus_equals
  address_has_been_set,
  address_reset,
  address_destroy,
};