module.c File Reference

Definition of the Key Module. More...

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

Include dependency graph for module.c:

Go to the source code of this file.

Functions
static bool	key_init (struct NeoMutt *n)
	Initialise a Module - Implements Module::init()
static bool	key_commands_register (struct NeoMutt *n, struct CommandArray *ca)
	Register NeoMutt Commands - Implements Module::commands_register()
static bool	key_cleanup (struct NeoMutt *n, void *data)
	Clean up a Module - Implements Module::cleanup()
static bool	key_gui_init (struct NeoMutt *n)
	Initialise the GUI - Implements Module::gui_init()
static void	key_gui_cleanup (struct NeoMutt *n)
	Clean up the GUI - Implements Module::gui_cleanup()

Variables
const struct Command	KeyCommands []
	All the registered Menus - moved to KeyModuleData All the registered SubMenus - moved to KeyModuleData AbortKey - moved to KeyModuleData.
const struct Module	ModuleKey
	Module for the Key library.

Detailed Description

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

key_init()

static bool key_init ( struct NeoMutt * n )

static

Initialise a Module - Implements Module::init()

Definition at line 43 of file module.c.

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

Here is the call graph for this function:

key_commands_register()

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

static

Register NeoMutt Commands - Implements Module::commands_register()

Definition at line 59 of file module.c.

{
  return commands_register(ca, KeyCommands);
}

Here is the call graph for this function:

key_cleanup()

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

static

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

Definition at line 67 of file module.c.

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

Here is the call graph for this function:

key_gui_init()

static bool key_gui_init ( struct NeoMutt * n )

static

Initialise the GUI - Implements Module::gui_init()

Definition at line 80 of file module.c.

{
  struct KeyModuleData *mod_data = neomutt_get_module_data(n, MODULE_ID_KEY);
  km_set_abort_key(&mod_data->abort_key);
  return true;
}

Here is the call graph for this function:

key_gui_cleanup()

static void key_gui_cleanup ( struct NeoMutt * n )

static

Clean up the GUI - Implements Module::gui_cleanup()

Definition at line 90 of file module.c.

{
  struct KeyModuleData *mod_data = neomutt_get_module_data(n, MODULE_ID_KEY);
  km_cleanup(mod_data);
}

Here is the call graph for this function:

Variable Documentation

KeyCommands

const struct Command KeyCommands[]

extern

All the registered Menus - moved to KeyModuleData All the registered SubMenus - moved to KeyModuleData AbortKey - moved to KeyModuleData.

Key Binding Commands

Definition at line 48 of file init.c.

                                     {
  // clang-format off
  { "bind", CMD_BIND, parse_bind,
        N_("Bind a key to a function"),
        N_("bind <map>[,<map> ... ] <key> <function>"),
        "configuration.html#bind" },
  { "exec", CMD_EXEC, parse_exec,
        N_("Execute a function"),
        N_("exec <function> [ <function> ... ]"),
        "configuration.html#exec" },
  { "macro", CMD_MACRO, parse_macro,
        N_("Define a keyboard macro"),
        N_("macro <map>[,<map> ... ] <key> <sequence> [ <description> ]"),
        "configuration.html#macro" },
  { "push", CMD_PUSH, parse_push,
        N_("Push a string into NeoMutt's input queue (simulate typing)"),
        N_("push <string>"),
        "configuration.html#push" },
  { "unbind", CMD_UNBIND, parse_unbind,
        N_("Remove a key binding"),
        N_("unbind { * | <map>[,<map> ... ] } [ <key> ]"),
        "configuration.html#unbind" },
  { "unmacro", CMD_UNMACRO, parse_unbind,
        N_("Remove a keyboard `macro`"),
        N_("unmacro { * | <map>[,<map> ... ] } [ <key> ]"),
        "configuration.html#unmacro" },
 
  { NULL, CMD_NONE, NULL, NULL, NULL, NULL, CF_NONE },
  // clang-format on
};

ModuleKey

const struct Module ModuleKey

Initial value:

= {
  MODULE_ID_KEY,
  "key",
  key_init,
  NULL, 
  NULL, 
  key_commands_register,
  key_gui_init,
  key_gui_cleanup,
  key_cleanup,
}

Module for the Key library.

Definition at line 99 of file module.c.

                                {
  MODULE_ID_KEY,
  "key",
  key_init,
  NULL, // config_define_types
  NULL, // config_define_variables
  key_commands_register,
  key_gui_init,
  key_gui_cleanup,
  key_cleanup,
};