module.c File Reference

Definition of the Address Module. More...

#include "config.h"
#include <stdbool.h>
#include <stddef.h>
#include "mutt/lib.h"
#include "config/lib.h"
#include "core/lib.h"
#include "module_data.h"

Include dependency graph for module.c:

Go to the source code of this file.

Functions
static bool	address_init (struct NeoMutt *n)
	Initialise a Module - Implements Module::init()
static bool	address_config_define_types (struct NeoMutt *n, struct ConfigSet *cs)
	Set up Config Types - Implements Module::config_define_types()
static bool	address_config_define_variables (struct NeoMutt *n, struct ConfigSet *cs)
	Define the Config Variables - Implements Module::config_define_variables()
static bool	address_cleanup (struct NeoMutt *n, void *data)
	Clean up a Module - Implements Module::cleanup()

Variables
const struct ConfigSetType	CstAddress
	Config type representing an Email Address.
struct ConfigDef	AddressVarsIdn []
	IDN Config definitions.
const struct Module	ModuleAddress
	Module for the Address library.

Detailed Description

Definition of the Address Module.

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

Function Documentation

address_init()

static bool address_init ( struct NeoMutt * n )

static

Initialise a Module - Implements Module::init()

Definition at line 45 of file module.c.

{
  struct AddressModuleData *mod_data = MUTT_MEM_CALLOC(1, struct AddressModuleData);
  neomutt_set_module_data(n, MODULE_ID_ADDRESS, mod_data);
 
  mod_data->notify = notify_new();
  notify_set_parent(mod_data->notify, n->notify);
 
  return true;
}

Here is the call graph for this function:

address_config_define_types()

static bool address_config_define_types ( struct NeoMutt * n, struct ConfigSet * cs )

static

Set up Config Types - Implements Module::config_define_types()

Definition at line 59 of file module.c.

{
  return cs_register_type(cs, &CstAddress);
}

Here is the call graph for this function:

address_config_define_variables()

static bool address_config_define_variables ( struct NeoMutt * n, struct ConfigSet * cs )

static

Define the Config Variables - Implements Module::config_define_variables()

Definition at line 67 of file module.c.

{
  bool rc = true;
 
#if defined(HAVE_LIBIDN)
  rc &= cs_register_variables(cs, AddressVarsIdn);
#endif
 
  return rc;
}

Here is the call graph for this function:

address_cleanup()

static bool address_cleanup ( struct NeoMutt * n, void * data )

static

Clean up a Module - Implements Module::cleanup()

Definition at line 81 of file module.c.

{
  struct AddressModuleData *mod_data = data;
 
  notify_free(&mod_data->notify);
 
  FREE(&mod_data);
  return true;
}

Here is the call graph for this function:

Variable Documentation

CstAddress

const struct ConfigSetType CstAddress

extern

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,
};

AddressVarsIdn

struct ConfigDef AddressVarsIdn[]

extern

IDN Config definitions.

Definition at line 30 of file config.c.

                                    {
  // clang-format off
  { "idn_decode", DT_BOOL, true, 0, NULL,
    "(idn) Decode international domain names"
  },
  { "idn_encode", DT_BOOL, true, 0, NULL,
    "(idn) Encode international domain names"
  },
  { NULL },
  // clang-format on
};

ModuleAddress

const struct Module ModuleAddress

Initial value:

= {
  MODULE_ID_ADDRESS,
  "address",
  address_init,
  address_config_define_types,
  address_config_define_variables,
  NULL, 
  NULL, 
  NULL, 
  address_cleanup,
}

Module for the Address library.

Definition at line 94 of file module.c.

                                    {
  MODULE_ID_ADDRESS,
  "address",
  address_init,
  address_config_define_types,
  address_config_define_variables,
  NULL, // commands_register
  NULL, // gui_init
  NULL, // gui_cleanup
  address_cleanup,
};