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 "sort.h"

Include dependency graph for functions.c:

Go to the source code of this file.

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

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

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

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

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

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

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

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

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

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

static int	op_sort (struct AliasMenuData mdata, 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
struct MenuDefinition *	MdAlias = NULL
	Alias Menu Definition.

struct MenuDefinition *	MdQuery = NULL
	Query Menu Definition.

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 SubMenu * sm_generic )

Initialise the Alias Keybindings - Implements ::init_keys_api.

Definition at line 128 of file functions.c.

{
  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);
 
  MdAlias = 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);
 
  MdQuery = md;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

◆ MdAlias

struct MenuDefinition* MdAlias = NULL

Alias Menu Definition.

Definition at line 51 of file functions.c.

◆ MdQuery

struct MenuDefinition* MdQuery = NULL

Query Menu Definition.

Definition at line 53 of file functions.c.

◆ 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 59 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 75 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 92 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 109 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_generic_select_entry },
  { 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 475 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_generic_select_entry },
  { 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()

Variable Documentation

◆ MdAlias

◆ MdQuery

◆ OpAlias

◆ OpQuery

◆ AliasDefaultBindings

◆ QueryDefaultBindings

◆ AliasFunctions