functions.c File Reference

Definitions of user functions. More...

#include "config.h"
#include <stddef.h>
#include "mutt/lib.h"
#include "core/lib.h"
#include "key/lib.h"
#include "menu/lib.h"
#include "module_data.h"
#include "opcodes.h"

Include dependency graph for functions.c:

Go to the source code of this file.

Functions
struct SubMenu *	generic_init_keys (struct NeoMutt *n)
	Initialise the Generic Keybindings.
struct MenuDefinition *	gui_get_generic_menu_definition (void)
	Get the Generic Menu Definition.
struct MenuDefinition *	gui_get_dialog_menu_definition (void)
	Get the Dialog Menu Definition.

Variables
static const struct MenuFuncOp	OpDialog []
	Functions for Simple Dialogs.
static const struct MenuFuncOp	OpGeneric []
	Functions for the Generic Menu.
static const struct MenuOpSeq	DialogDefaultBindings []
	Key bindings for Simple Dialogs.
static const struct MenuOpSeq	GenericDefaultBindings []
	Key bindings for the Generic Menu.

Detailed Description

Definitions of user functions.

Authors

• Richard Russon
• Pietro Cerutti

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

generic_init_keys()

struct SubMenu * generic_init_keys

(

struct NeoMutt *

n

)

Initialise the Generic Keybindings.

Definition at line 168 of file functions.c.

{
  struct GuiModuleData *mod_data = neomutt_get_module_data(n, MODULE_ID_GUI);
  ASSERT(mod_data);
 
  struct MenuDefinition *md = NULL;
  struct SubMenu *sm = NULL;
  struct SubMenu *sm_generic = NULL;
 
  sm_generic = km_register_submenu(OpGeneric);
  md = km_register_menu(MENU_GENERIC, "generic");
  km_menu_add_submenu(md, sm_generic);
  km_menu_add_bindings(md, GenericDefaultBindings);
 
  mod_data->md_generic = md;
  mod_data->sm_generic = sm_generic;
 
  sm = km_register_submenu(OpDialog);
  md = km_register_menu(MENU_DIALOG, "dialog");
  km_menu_add_submenu(md, sm);
  km_menu_add_submenu(md, sm_generic);
  km_menu_add_bindings(md, DialogDefaultBindings);
 
  mod_data->md_dialog = md;
  mod_data->sm_dialog = sm;
 
  return sm_generic;
}

Here is the call graph for this function:

Here is the caller graph for this function:

gui_get_generic_menu_definition()

struct MenuDefinition * gui_get_generic_menu_definition

(

void

)

Get the Generic Menu Definition.

Return values

ptr	Generic Menu Definition

Definition at line 201 of file functions.c.

{
  struct GuiModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_GUI);
  ASSERT(mod_data);
 
  return mod_data->md_generic;
}

Here is the call graph for this function:

gui_get_dialog_menu_definition()

struct MenuDefinition * gui_get_dialog_menu_definition

(

void

)

Get the Dialog Menu Definition.

Return values

ptr	Dialog Menu Definition

Definition at line 213 of file functions.c.

{
  struct GuiModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_GUI);
  ASSERT(mod_data);
 
  return mod_data->md_dialog;
}

Here is the call graph for this function:

Variable Documentation

OpDialog

const struct MenuFuncOp OpDialog[]

static

Initial value:

= {
  { "quit",                          OP_QUIT },
  { "exit",                          OP_EXIT },
  { NULL, 0 },
}

Functions for Simple Dialogs.

Definition at line 56 of file functions.c.

                                            {
  { "quit",                          OP_QUIT },
  { "exit",                          OP_EXIT },
  { NULL, 0 },
};

OpGeneric

const struct MenuFuncOp OpGeneric[]

static

Functions for the Generic Menu.

Definition at line 65 of file functions.c.

                                             { /* map: generic */
  /*
  ** <para>
  ** The <emphasis>generic</emphasis> menu is not a real menu, but specifies common functions
  ** (such as movement) available in all menus except for <emphasis>pager</emphasis> and
  ** <emphasis>editor</emphasis>.  Changing settings for this menu will affect the default
  ** bindings for all menus (except as noted).
  ** </para>
  */
  { "bottom-page",                   OP_BOTTOM_PAGE },
  { "check-stats",                   OP_CHECK_STATS },
  { "current-bottom",                OP_CURRENT_BOTTOM },
  { "current-middle",                OP_CURRENT_MIDDLE },
  { "current-top",                   OP_CURRENT_TOP },
  { "end-cond",                      OP_END_COND },
  { "enter-command",                 OP_ENTER_COMMAND },
  { "exit",                          OP_EXIT },
  { "first-entry",                   OP_FIRST_ENTRY },
  { "half-down",                     OP_HALF_DOWN },
  { "half-up",                       OP_HALF_UP },
  { "help",                          OP_HELP },
  { "jump",                          OP_JUMP },
  { "last-entry",                    OP_LAST_ENTRY },
  { "middle-page",                   OP_MIDDLE_PAGE },
  { "next-entry",                    OP_NEXT_ENTRY },
  { "next-line",                     OP_NEXT_LINE },
  { "next-page",                     OP_NEXT_PAGE },
  { "previous-entry",                OP_PREV_ENTRY },
  { "previous-line",                 OP_PREV_LINE },
  { "previous-page",                 OP_PREV_PAGE },
  { "redraw-screen",                 OP_REDRAW },
  { "search",                        OP_SEARCH },
  { "search-next",                   OP_SEARCH_NEXT },
  { "search-opposite",               OP_SEARCH_OPPOSITE },
  { "search-reverse",                OP_SEARCH_REVERSE },
  { "select-entry",                  OP_GENERIC_SELECT_ENTRY },
  { "shell-escape",                  OP_SHELL_ESCAPE },
  { "show-log-messages",             OP_SHOW_LOG_MESSAGES },
  { "show-version",                  OP_VERSION },
  { "tag-entry",                     OP_TAG },
  { "tag-prefix",                    OP_TAG_PREFIX },
  { "tag-prefix-cond",               OP_TAG_PREFIX_COND },
  { "top-page",                      OP_TOP_PAGE },
  { "what-key",                      OP_WHAT_KEY },
  // Deprecated
  { "error-history",                 OP_SHOW_LOG_MESSAGES, MFF_DEPRECATED },
  { "refresh",                       OP_REDRAW,            MFF_DEPRECATED },
  { NULL, 0 },
};

DialogDefaultBindings

const struct MenuOpSeq DialogDefaultBindings[]

static

Initial value:

= {
  { OP_QUIT,                               "q" },
  { 0, NULL },
}

Key bindings for Simple Dialogs.

Definition at line 118 of file functions.c.

                                                        {
  { OP_QUIT,                               "q" },
  { 0, NULL },
};

GenericDefaultBindings

const struct MenuOpSeq GenericDefaultBindings[]

static

Key bindings for the Generic Menu.

Definition at line 126 of file functions.c.

                                                         { /* map: generic */
  { OP_BOTTOM_PAGE,                        "L" },
  { OP_ENTER_COMMAND,                      ":" },
  { OP_FIRST_ENTRY,                        "<home>" },
  { OP_FIRST_ENTRY,                        "=" },
  { OP_GENERIC_SELECT_ENTRY,               "<keypadenter>" },
  { OP_GENERIC_SELECT_ENTRY,               "\n" },             // <Enter>
  { OP_GENERIC_SELECT_ENTRY,               "\r" },             // <Return>
  { OP_HALF_DOWN,                          "]" },
  { OP_HALF_UP,                            "[" },
  { OP_HELP,                               "?" },
  { OP_LAST_ENTRY,                         "*" },
  { OP_LAST_ENTRY,                         "<end>" },
  { OP_MIDDLE_PAGE,                        "M" },
  { OP_NEXT_ENTRY,                         "<down>" },
  { OP_NEXT_ENTRY,                         "j" },
  { OP_NEXT_LINE,                          ">" },
  { OP_NEXT_PAGE,                          "<pagedown>" },
  { OP_NEXT_PAGE,                          "<right>" },
  { OP_NEXT_PAGE,                          "z" },
  { OP_PREV_ENTRY,                         "<up>" },
  { OP_PREV_ENTRY,                         "k" },
  { OP_PREV_LINE,                          "<" },
  { OP_PREV_PAGE,                          "<left>" },
  { OP_PREV_PAGE,                          "<pageup>" },
  { OP_PREV_PAGE,                          "Z" },
  { OP_REDRAW,                             "\014" },           // <Ctrl-L>
  { OP_SEARCH,                             "/" },
  { OP_SEARCH_NEXT,                        "n" },
  { OP_SEARCH_REVERSE,                     "\033/" },          // <Alt-/>
  { OP_SHELL_ESCAPE,                       "!" },
  { OP_TAG,                                "t" },
  { OP_TAG_PREFIX,                         ";" },
  { OP_TOP_PAGE,                           "H" },
  { OP_VERSION,                            "V" },
  { 0, NULL },
};