module.c File Reference

Definition of the Alias Module. More...

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

Include dependency graph for module.c:

Go to the source code of this file.

Functions
static bool	alias_init (struct NeoMutt *n)
	Initialise a Module - Implements Module::init()
static bool	alias_config_define_variables (struct NeoMutt *n, struct ConfigSet *cs)
	Define the Config Variables - Implements Module::config_define_variables()
static bool	alias_commands_register (struct NeoMutt *n, struct CommandArray *ca)
	Register NeoMutt Commands - Implements Module::commands_register()
static bool	alias_cleanup (struct NeoMutt *n, void *data)
	Clean up a Module - Implements Module::cleanup()

Variables
struct ConfigDef	AliasVars []
	Config definitions for the alias library.
const struct Command	AliasCommands []
	Alias Commands.
const struct Module	ModuleAlias
	Module for the Alias library.

Detailed Description

Definition of the Alias 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

alias_init()

static bool alias_init ( struct NeoMutt * n )

static

Initialise a Module - Implements Module::init()

Definition at line 47 of file module.c.

{
  struct AliasModuleData *mod_data = MUTT_MEM_CALLOC(1, struct AliasModuleData);
  neomutt_set_module_data(n, MODULE_ID_ALIAS, mod_data);
 
  mod_data->notify = notify_new();
  notify_set_parent(mod_data->notify, n->notify);
 
  STAILQ_INIT(&mod_data->alternates);
  STAILQ_INIT(&mod_data->unalternates);
 
  mod_data->alternates_notify = notify_new();
  notify_set_parent(mod_data->alternates_notify, n->notify);
 
  ARRAY_INIT(&mod_data->aliases);
  mod_data->reverse_aliases = alias_reverse_init();
 
  mod_data->groups = groups_new();
 
  mod_data->auto_subscribe_cache = NULL;
  STAILQ_INIT(&mod_data->mail);
  STAILQ_INIT(&mod_data->subscribed);
  STAILQ_INIT(&mod_data->unmail);
  STAILQ_INIT(&mod_data->unsubscribed);
 
  return true;
}

Here is the call graph for this function:

alias_config_define_variables()

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

static

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

Definition at line 78 of file module.c.

{
  return cs_register_variables(cs, AliasVars);
}

Here is the call graph for this function:

alias_commands_register()

static bool alias_commands_register ( struct NeoMutt * n, struct CommandArray * ca )

static

Register NeoMutt Commands - Implements Module::commands_register()

Definition at line 86 of file module.c.

{
  return commands_register(ca, AliasCommands);
}

Here is the call graph for this function:

alias_cleanup()

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

static

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

Definition at line 94 of file module.c.

{
  struct AliasModuleData *mod_data = data;
 
  notify_free(&mod_data->notify);
  notify_free(&mod_data->alternates_notify);
 
  mutt_regexlist_free(&mod_data->alternates);
  mutt_regexlist_free(&mod_data->unalternates);
 
  struct Alias **ap = NULL;
  ARRAY_FOREACH(ap, &mod_data->aliases)
  {
    alias_reverse_delete(mod_data->reverse_aliases, *ap);
  }
  aliaslist_clear(&mod_data->aliases);
 
  alias_reverse_cleanup(&mod_data->reverse_aliases);
 
  groups_free(&mod_data->groups);
 
  mutt_hash_free(&mod_data->auto_subscribe_cache);
  mutt_regexlist_free(&mod_data->mail);
  mutt_regexlist_free(&mod_data->subscribed);
  mutt_regexlist_free(&mod_data->unmail);
  mutt_regexlist_free(&mod_data->unsubscribed);
 
  FREE(&mod_data);
  return true;
}

Here is the call graph for this function:

Variable Documentation

AliasVars

struct ConfigDef AliasVars[]

extern

Config definitions for the alias library.

Definition at line 112 of file config.c.

                               {
  // clang-format off
  { "alias_file", DT_PATH|D_PATH_FILE, IP "~/.neomuttrc", 0, NULL,
    "Save new aliases to this file"
  },
  { "alias_format", DT_EXPANDO|D_NOT_EMPTY, IP "%3i %f%t %-15a %-56A | %C%> %Y", IP &AliasFormatDef, NULL,
    "printf-like format string for the alias menu"
  },
  { "alias_sort", DT_SORT|D_SORT_REVERSE, ALIAS_SORT_ALIAS, IP AliasSortMethods, NULL,
    "Sort method for the alias menu"
  },
  { "query_command", DT_STRING|D_STRING_COMMAND, 0, 0, NULL,
    "External command to query and external address book"
  },
  { "query_format", DT_EXPANDO|D_NOT_EMPTY, IP "%3i %t %-25N %-25E | %C%> %Y", IP &QueryFormatDef, NULL,
    "printf-like format string for the query menu (address book)"
  },
 
  { "sort_alias", DT_SYNONYM, IP "alias_sort", IP "2024-11-19" },
 
  { NULL },
  // clang-format on
};

AliasCommands

const struct Command AliasCommands[]

extern

Alias Commands.

Definition at line 361 of file commands.c.

                                       {
  // clang-format off
  { "alias", CMD_ALIAS, parse_alias,
        N_("Define an alias (name to email address)"),
        N_("alias [ -group <name> ... ] <key> <address> [,...] [ # <comments> ]"),
        "configuration.html#alias" },
  { "alternates", CMD_ALTERNATES, parse_alternates,
        N_("Define a list of alternate email addresses for the user"),
        N_("alternates [ -group <name> ... ] <regex> [ <regex> ... ]"),
        "configuration.html#alternates" },
  { "group", CMD_GROUP, parse_group,
        N_("Add addresses to an address group"),
        N_("group [ -group <name> ... ] { -rx <regex> ... | -addr <address> ... }"),
        "configuration.html#addrgroup" },
  { "lists", CMD_LISTS, parse_lists,
        N_("Add address to the list of mailing lists"),
        N_("lists [ -group <name> ... ] <regex> [ ... ]"),
        "configuration.html#lists" },
  { "subscribe", CMD_SUBSCRIBE, parse_subscribe,
        N_("Add address to the list of subscribed mailing lists"),
        N_("subscribe [ -group <name> ... ] <regex> [ ... ]"),
        "configuration.html#lists" },
  { "unalias", CMD_UNALIAS, parse_unalias,
        N_("Remove an alias definition"),
        N_("unalias { * | <key> ... }"),
        "configuration.html#alias" },
  { "unalternates", CMD_UNALTERNATES, parse_unalternates,
        N_("Remove addresses from `alternates` list"),
        N_("unalternates { * | <regex> ... }"),
        "configuration.html#alternates" },
  { "ungroup", CMD_UNGROUP, parse_group,
        N_("Remove addresses from an address `group`"),
        N_("ungroup [ -group <name> ... ] { * | -rx <regex> ... | -addr <address> ... }"),
        "configuration.html#addrgroup" },
  { "unlists", CMD_UNLISTS, parse_unlists,
        N_("Remove address from the list of mailing lists"),
        N_("unlists { * | <regex> ... }"),
        "configuration.html#lists" },
  { "unsubscribe", CMD_UNSUBSCRIBE, parse_unsubscribe,
        N_("Remove address from the list of subscribed mailing lists"),
        N_("unsubscribe { * | <regex> ... }"),
        "configuration.html#lists" },
 
  { NULL, CMD_NONE, NULL, NULL, NULL, NULL, CF_NONE },
  // clang-format on
};

ModuleAlias

const struct Module ModuleAlias

Initial value:

= {
  MODULE_ID_ALIAS,
  "alias",
  alias_init,
  NULL, 
  alias_config_define_variables,
  alias_commands_register,
  NULL, 
  NULL, 
  alias_cleanup,
}

Module for the Alias library.

Definition at line 128 of file module.c.

                                  {
  MODULE_ID_ALIAS,
  "alias",
  alias_init,
  NULL, // config_define_types
  alias_config_define_variables,
  alias_commands_register,
  NULL, // gui_init
  NULL, // gui_cleanup
  alias_cleanup,
};