Alias functions. More...

#include "config.h"
#include <stdbool.h>
#include <stdio.h>
#include "mutt/lib.h"
#include "address/lib.h"
#include "config/lib.h"
#include "core/lib.h"
#include "gui/lib.h"
#include "functions.h"
#include "lib.h"
#include "editor/lib.h"
#include "history/lib.h"
#include "key/lib.h"
#include "menu/lib.h"
#include "pattern/lib.h"
#include "question/lib.h"
#include "alias.h"
#include "gui.h"
#include "module_data.h"
#include "sort.h"

Include dependency graph for functions.c:

Go to the source code of this file.

Functions
void	alias_init_keys (struct NeoMutt n, struct SubMenu sm_generic)
	Initialise the Alias Keybindings - Implements ::init_keys_api.

static int	op_create_alias (struct AliasFunctionData fdata, const struct KeyEvent event)
	create an alias from a message sender - Implements alias_function_t -

static int	alias_add_selection (struct AliasViewPtrArray avpa, struct AliasMenuData mdata, bool tagged, int count)
	Build a working set of AliasView pointers for an action.

static void	alias_apply_set_deleted (struct AliasViewPtrArray *avpa, bool deleted)
	Apply the deleted flag to a working set of AliasViews.

static int	op_delete (struct AliasFunctionData fdata, const struct KeyEvent event)
	delete the current entry - Implements alias_function_t -

static int	op_exit (struct AliasFunctionData fdata, const struct KeyEvent event)
	exit this menu - Implements alias_function_t -

static int	op_jump (struct AliasFunctionData fdata, const struct KeyEvent event)
	Jump to an index number - Implements alias_function_t -.

static int	alias_select_entries (struct AliasMenuData *mdata, int count)
	Select entries to return from the Alias Dialog.

static int	op_generic_select_entry (struct AliasFunctionData fdata, const struct KeyEvent event)
	select the current entry - Implements alias_function_t -

static int	op_mail (struct AliasFunctionData fdata, const struct KeyEvent event)
	mail the selected entries - Implements alias_function_t -

static int	op_main_limit (struct AliasFunctionData fdata, const struct KeyEvent event)
	show only messages matching a pattern - Implements alias_function_t -

static int	op_main_tag_pattern (struct AliasFunctionData fdata, const struct KeyEvent event)
	Tag messages matching a pattern - Implements alias_function_t -.

static int	op_main_untag_pattern (struct AliasFunctionData fdata, const struct KeyEvent event)
	Untag messages matching a pattern - Implements alias_function_t -.

static int	op_query (struct AliasFunctionData fdata, const struct KeyEvent event)
	query external program for addresses - Implements alias_function_t -

static int	op_search (struct AliasFunctionData fdata, const struct KeyEvent event)
	search for a regular expression - Implements alias_function_t -

static int	op_sort (struct AliasFunctionData fdata, const struct KeyEvent event)
	sort aliases - Implements alias_function_t -

int	alias_function_dispatcher (struct MuttWindow win, const struct KeyEvent event)
	Perform a Alias function - Implements function_dispatcher_t -.

Variables
static const struct MenuFuncOp	OpAlias []
	Functions for the Alias Menu.

const struct MenuFuncOp	OpQuery []
	Functions for the external Query Menu.

static const struct MenuOpSeq	AliasDefaultBindings []
	Key bindings for the Alias Menu.

static const struct MenuOpSeq	QueryDefaultBindings []
	Key bindings for the external Query Menu.

static const struct AliasFunction	AliasFunctions []
	All the NeoMutt functions that the Alias supports.

Detailed Description

Alias functions.

Authors

Richard Russon
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 functions.c.

Function Documentation

◆ alias_init_keys()

void alias_init_keys	(	struct NeoMutt *	n,
		struct SubMenu *	sm_generic )

Initialise the Alias Keybindings - Implements ::init_keys_api.

Definition at line 124 of file functions.c.

{
  struct AliasModuleData *mod_data = neomutt_get_module_data(n, MODULE_ID_ALIAS);
  ASSERT(mod_data);
 
  struct MenuDefinition *md = NULL;
  struct SubMenu *sm = NULL;
 
  sm = km_register_submenu(OpAlias);
  md = km_register_menu(MENU_ALIAS, "alias");
  km_menu_add_submenu(md, sm);
  km_menu_add_submenu(md, sm_generic);
  km_menu_add_bindings(md, AliasDefaultBindings);
 
  mod_data->menu_alias = md;
 
  sm = km_register_submenu(OpQuery);
  md = km_register_menu(MENU_QUERY, "query");
  km_menu_add_submenu(md, sm);
  km_menu_add_submenu(md, sm_generic);
  km_menu_add_bindings(md, QueryDefaultBindings);
 
  mod_data->menu_query = md;
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ alias_add_selection()

static int alias_add_selection	(	struct AliasViewPtrArray *	avpa,
		struct AliasMenuData *	mdata,
		bool	tagged,
		int	count )

static

Build a working set of AliasView pointers for an action.

Parameters

avpa	AliasView Array to populate
mdata	Alias Menu data
tagged	Use tagged AliasViews (tag-prefix)
count	Repeat-count (0 or 1 == just the current selection)

Return values

num	Number of AliasViews added

If tagged is true, the array is filled with the tagged AliasViews and count is ignored.

Otherwise the array is filled with the current selection and the next count - 1 visible AliasViews. Overruns are silently capped at the end of the visible list.

Definition at line 209 of file functions.c.

{
  if (!avpa || !mdata)
    return 0;
 
  if (tagged)
  {
    struct AliasView *avp = NULL;
    ARRAY_FOREACH(avp, &mdata->ava)
    {
      if (avp->is_tagged)
        ARRAY_ADD(avpa, avp);
    }
  }
  else
  {
    struct Menu *menu = mdata->menu;
    const int index = menu_get_index(menu);
    if ((index < 0) || (index >= menu->max))
      return 0;
 
    int n = (count > 1) ? count : 1;
    if ((index + n) > menu->max)
      n = menu->max - index;
 
    for (int i = 0; i < n; i++)
    {
      struct AliasView *av = ARRAY_GET(&mdata->ava, index + i);
      if (av)
        ARRAY_ADD(avpa, av);
    }
  }
 
  return ARRAY_SIZE(avpa);
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ alias_apply_set_deleted()

static void alias_apply_set_deleted	(	struct AliasViewPtrArray *	avpa,
		bool	deleted )

static

Apply the deleted flag to a working set of AliasViews.

Parameters

avpa	Working set of AliasView pointers
deleted	true to mark as deleted, false to undelete

Definition at line 251 of file functions.c.

{
  if (!avpa)
    return;
 
  struct AliasView **avpp = NULL;
  ARRAY_FOREACH(avpp, avpa)
  {
    if (*avpp)
      (*avpp)->is_deleted = deleted;
  }
}

Here is the caller graph for this function:

◆ alias_select_entries()

static int alias_select_entries	(	struct AliasMenuData *	mdata,
		int	count )

static

Select entries to return from the Alias Dialog.

Parameters

mdata	Alias Menu data
count	Repeat-count (0 or 1 == just the current selection)

Return values

enum	FunctionRetval

Note: AliasMenuData.is_tagged will show the user's selection

Definition at line 347 of file functions.c.

{
  struct Menu *menu = mdata->menu;
  if (menu->tag_prefix)
  {
    // Untag any non-visible aliases
    struct AliasView *avp = NULL;
    ARRAY_FOREACH(avp, &mdata->ava)
    {
      if (avp->is_tagged && !avp->is_visible)
        avp->is_tagged = false;
    }
  }
  else
  {
    struct AliasViewPtrArray avpa = ARRAY_HEAD_INITIALIZER;
    alias_add_selection(&avpa, mdata, false, count);
    if (ARRAY_EMPTY(&avpa))
    {
      ARRAY_FREE(&avpa);
      return FR_NO_ACTION;
    }
 
    // Untag all but the selected alias(es)
    struct AliasView *avp = NULL;
    ARRAY_FOREACH(avp, &mdata->ava)
    {
      avp->is_tagged = false;
    }
 
    struct AliasView **avpp = NULL;
    ARRAY_FOREACH(avpp, &avpa)
    {
      if (*avpp)
        (*avpp)->is_tagged = true;
    }
    ARRAY_FREE(&avpa);
  }
 
  return FR_CONTINUE;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

◆ OpAlias

const struct MenuFuncOp OpAlias[]

static

Initial value:

= { 
  { "delete-entry",                  OP_DELETE },
  { "exit",                          OP_EXIT },
  { "limit",                         OP_MAIN_LIMIT },
  { "mail",                          OP_MAIL },
  { "sort-alias",                    OP_SORT },
  { "sort-alias-reverse",            OP_SORT_REVERSE },
  { "tag-pattern",                   OP_MAIN_TAG_PATTERN },
  { "undelete-entry",                OP_UNDELETE },
  { "untag-pattern",                 OP_MAIN_UNTAG_PATTERN },
  { NULL, 0 },
}

Functions for the Alias Menu.

Definition at line 55 of file functions.c.

                                           { /* map: alias */
  { "delete-entry",                  OP_DELETE },
  { "exit",                          OP_EXIT },
  { "limit",                         OP_MAIN_LIMIT },
  { "mail",                          OP_MAIL },
  { "sort-alias",                    OP_SORT },
  { "sort-alias-reverse",            OP_SORT_REVERSE },
  { "tag-pattern",                   OP_MAIN_TAG_PATTERN },
  { "undelete-entry",                OP_UNDELETE },
  { "untag-pattern",                 OP_MAIN_UNTAG_PATTERN },
  { NULL, 0 },
};

◆ OpQuery

const struct MenuFuncOp OpQuery[]

Initial value:

= { 
  { "create-alias",                  OP_CREATE_ALIAS },
  { "exit",                          OP_EXIT },
  { "limit",                         OP_MAIN_LIMIT },
  { "mail",                          OP_MAIL },
  { "query",                         OP_QUERY },
  { "query-append",                  OP_QUERY_APPEND },
  { "sort",                          OP_SORT },
  { "sort-reverse",                  OP_SORT_REVERSE },
  { "tag-pattern",                   OP_MAIN_TAG_PATTERN },
  { "untag-pattern",                 OP_MAIN_UNTAG_PATTERN },
  { NULL, 0 },
}

Functions for the external Query Menu.

Definition at line 71 of file functions.c.

                                    { /* map: query */
  { "create-alias",                  OP_CREATE_ALIAS },
  { "exit",                          OP_EXIT },
  { "limit",                         OP_MAIN_LIMIT },
  { "mail",                          OP_MAIL },
  { "query",                         OP_QUERY },
  { "query-append",                  OP_QUERY_APPEND },
  { "sort",                          OP_SORT },
  { "sort-reverse",                  OP_SORT_REVERSE },
  { "tag-pattern",                   OP_MAIN_TAG_PATTERN },
  { "untag-pattern",                 OP_MAIN_UNTAG_PATTERN },
  { NULL, 0 },
};

◆ AliasDefaultBindings

const struct MenuOpSeq AliasDefaultBindings[]

static

Initial value:

= { 
  { OP_DELETE,                             "d" },
  { OP_EXIT,                               "q" },
  { OP_MAIL,                               "m" },
  { OP_MAIN_LIMIT,                         "l" },
  { OP_MAIN_TAG_PATTERN,                   "T" },
  { OP_MAIN_UNTAG_PATTERN,                 "\024" },           
  { OP_SORT,                               "o" },
  { OP_SORT_REVERSE,                       "O" },
  { OP_TAG,                                "<space>" },
  { OP_UNDELETE,                           "u" },
  { 0, NULL },
}

Key bindings for the Alias Menu.

Definition at line 88 of file functions.c.

                                                       { /* map: alias */
  { OP_DELETE,                             "d" },
  { OP_EXIT,                               "q" },
  { OP_MAIL,                               "m" },
  { OP_MAIN_LIMIT,                         "l" },
  { OP_MAIN_TAG_PATTERN,                   "T" },
  { OP_MAIN_UNTAG_PATTERN,                 "\024" },           // <Ctrl-T>
  { OP_SORT,                               "o" },
  { OP_SORT_REVERSE,                       "O" },
  { OP_TAG,                                "<space>" },
  { OP_UNDELETE,                           "u" },
  { 0, NULL },
};

◆ QueryDefaultBindings

const struct MenuOpSeq QueryDefaultBindings[]

static

Initial value:

= { 
  { OP_CREATE_ALIAS,                       "a" },
  { OP_EXIT,                               "q" },
  { OP_MAIL,                               "m" },
  { OP_MAIN_LIMIT,                         "l" },
  { OP_MAIN_TAG_PATTERN,                   "T" },
  { OP_MAIN_UNTAG_PATTERN,                 "\024" },           
  { OP_QUERY,                              "Q" },
  { OP_QUERY_APPEND,                       "A" },
  { OP_SORT,                               "o" },
  { OP_SORT_REVERSE,                       "O" },
  { OP_TAG,                                "<space>" },
  { 0, NULL },
}

Key bindings for the external Query Menu.

Definition at line 105 of file functions.c.

                                                       { /* map: query */
  { OP_CREATE_ALIAS,                       "a" },
  { OP_EXIT,                               "q" },
  { OP_MAIL,                               "m" },
  { OP_MAIN_LIMIT,                         "l" },
  { OP_MAIN_TAG_PATTERN,                   "T" },
  { OP_MAIN_UNTAG_PATTERN,                 "\024" },           // <Ctrl-T>
  { OP_QUERY,                              "Q" },
  { OP_QUERY_APPEND,                       "A" },
  { OP_SORT,                               "o" },
  { OP_SORT_REVERSE,                       "O" },
  { OP_TAG,                                "<space>" },
  { 0, NULL },
};

◆ AliasFunctions

const struct AliasFunction AliasFunctions[]

static

Initial value:

= {
  
  { OP_CREATE_ALIAS,           op_create_alias },
  { OP_DELETE,                 op_delete },
  { OP_EXIT,                   op_exit },
  { OP_GENERIC_SELECT_ENTRY,   op_generic_select_entry },
  { OP_MAIL,                   op_mail },
  { OP_MAIN_LIMIT,             op_main_limit },
  { OP_MAIN_TAG_PATTERN,       op_main_tag_pattern },
  { OP_MAIN_UNTAG_PATTERN,     op_main_untag_pattern },
  { OP_QUERY,                  op_query },
  { OP_QUERY_APPEND,           op_query },
  { OP_SEARCH,                 op_search },
  { OP_SEARCH_NEXT,            op_search },
  { OP_SEARCH_OPPOSITE,        op_search },
  { OP_SEARCH_REVERSE,         op_search },
  { OP_SORT,                   op_sort },
  { OP_SORT_REVERSE,           op_sort },
  { OP_UNDELETE,               op_delete },
  { 0, NULL },
  
}

All the NeoMutt functions that the Alias supports.

Definition at line 614 of file functions.c.

                                                     {
  // clang-format off
  { OP_CREATE_ALIAS,           op_create_alias },
  { OP_DELETE,                 op_delete },
  { OP_EXIT,                   op_exit },
  { OP_GENERIC_SELECT_ENTRY,   op_generic_select_entry },
  { OP_MAIL,                   op_mail },
  { OP_MAIN_LIMIT,             op_main_limit },
  { OP_MAIN_TAG_PATTERN,       op_main_tag_pattern },
  { OP_MAIN_UNTAG_PATTERN,     op_main_untag_pattern },
  { OP_QUERY,                  op_query },
  { OP_QUERY_APPEND,           op_query },
  { OP_SEARCH,                 op_search },
  { OP_SEARCH_NEXT,            op_search },
  { OP_SEARCH_OPPOSITE,        op_search },
  { OP_SEARCH_REVERSE,         op_search },
  { OP_SORT,                   op_sort },
  { OP_SORT_REVERSE,           op_sort },
  { OP_UNDELETE,               op_delete },
  { 0, NULL },
  // clang-format on
};

Functions

Variables

Detailed Description

Function Documentation

◆ alias_init_keys()

◆ alias_add_selection()

◆ alias_apply_set_deleted()

◆ alias_select_entries()

Variable Documentation

◆ OpAlias

◆ OpQuery

◆ AliasDefaultBindings

◆ QueryDefaultBindings

◆ AliasFunctions