keymap.c File Reference

Dump keybindings. More...

#include "config.h"
#include <stdbool.h>
#include <stdio.h>
#include "mutt/lib.h"
#include "config/lib.h"
#include "core/lib.h"
#include "gui/lib.h"
#include "lib.h"
#include "key/lib.h"
#include "key/module_data.h"

Include dependency graph for keymap.c:

Go to the source code of this file.

Data Structures
struct	SubMenuId

Functions
	ARRAY_HEAD (SubMenuIdArray, struct SubMenuId)
void	log_bind (const struct MenuDefinition *md, const char *keystr, struct Keymap *km)
	Log a key binding.
void	log_macro (const char *keystr, struct Keymap *km)
	Dumps all the macros maps of a menu into a buffer.
void	dump_submenu_functions (const struct SubMenu *sm, bool brief)
	Dump submenu functions.
void	dump_submenu_bindings (const struct MenuDefinition *md, const struct SubMenu *sm, bool brief)
	Dump submenu bindings.
void	dump_submenus (bool brief, struct SubMenuIdArray *smia)
	Dump all submenus.
void	dump_menus (struct SubMenuIdArray *smia)
	Dump all menus.
void	dump_menu_funcs (bool brief)
	Dump all menu functions.
void	dump_menu_binds (bool brief)
	Dump all menu bindings.

Detailed Description

Dump keybindings.

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 keymap.c.

Function Documentation

ARRAY_HEAD()

ARRAY_HEAD	(	SubMenuIdArray	,
		struct SubMenuId	)

log_bind()

void log_bind	(	const struct MenuDefinition *	md,
		const char *	keystr,
		struct Keymap *	km )

Log a key binding.

Parameters

md	Menu definition
keystr	Key string
km	Key mapping

Definition at line 53 of file keymap.c.

{
  const char *fn_name = NULL;
 
  struct SubMenu **smp = NULL;
  ARRAY_FOREACH(smp, &md->submenus)
  {
    fn_name = help_lookup_function(md, km->op);
    if (fn_name)
      break;
  }
 
  mutt_debug(LL_DEBUG1, "    bind %-8s <%s>\n", keystr, fn_name);
  mutt_debug(LL_DEBUG1, "        op = %d (%s)\n", km->op, opcodes_get_name(km->op));
  mutt_debug(LL_DEBUG1, "        eq = %d\n", km->eq);
 
  struct Buffer *keys = buf_pool_get();
  for (int i = 0; i < km->len; i++)
  {
    buf_add_printf(keys, "%d ", km->keys[i]);
  }
  mutt_debug(LL_DEBUG1, "        keys: %s\n", buf_string(keys));
  buf_pool_release(&keys);
}

Here is the call graph for this function:

Here is the caller graph for this function:

log_macro()

void log_macro	(	const char *	keystr,
		struct Keymap *	km )

Dumps all the macros maps of a menu into a buffer.

Parameters

keystr	Bound string
km	Keybinding

Definition at line 83 of file keymap.c.

{
  struct Buffer *esc_macro = buf_pool_get();
  escape_string(esc_macro, km->macro);
 
  mutt_debug(LL_DEBUG1, "    macro %-8s \"%s\"\n", keystr, buf_string(esc_macro));
  if (km->desc)
    mutt_debug(LL_DEBUG1, "        %s\n", km->desc);
 
  buf_pool_release(&esc_macro);
 
  mutt_debug(LL_DEBUG1, "        op = %d\n", km->op);
  mutt_debug(LL_DEBUG1, "        eq = %d\n", km->eq);
  struct Buffer *keys = buf_pool_get();
  for (int i = 0; i < km->len; i++)
  {
    buf_add_printf(keys, "%d ", km->keys[i]);
  }
  mutt_debug(LL_DEBUG1, "        keys: %s\n", buf_string(keys));
  buf_pool_release(&keys);
}

Here is the call graph for this function:

Here is the caller graph for this function:

dump_submenu_functions()

void dump_submenu_functions	(	const struct SubMenu *	sm,
		bool	brief )

Dump submenu functions.

Parameters

sm	Submenu to dump
brief	True for brief output

Definition at line 110 of file keymap.c.

{
  for (int i = 0; sm->functions[i].name; i++)
  {
    if (brief && (i > 2))
    {
      mutt_debug(LL_DEBUG1, "    ...\n");
      break;
    }
 
    const struct MenuFuncOp *mfo = &sm->functions[i];
    mutt_debug(LL_DEBUG1, "    \"%s\" -> %s (%d)\n", mfo->name,
               opcodes_get_name(mfo->op), mfo->op);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

dump_submenu_bindings()

void dump_submenu_bindings	(	const struct MenuDefinition *	md,
		const struct SubMenu *	sm,
		bool	brief )

Dump submenu bindings.

Parameters

md	Menu definition
sm	Submenu to dump
brief	True for brief output

Definition at line 132 of file keymap.c.

{
  if (STAILQ_EMPTY(&sm->keymaps))
  {
    mutt_debug(LL_DEBUG1, "    [NONE]\n");
    return;
  }
 
  struct Buffer *binding = buf_pool_get();
  struct Buffer *esc_key = buf_pool_get();
 
  int count = 0;
  struct Keymap *km = NULL;
  STAILQ_FOREACH(km, &sm->keymaps, entries)
  {
    if (brief && (count++ > 2))
    {
      mutt_debug(LL_DEBUG1, "    ...\n");
      break;
    }
 
    buf_reset(binding);
    keymap_expand_key(km, binding);
 
    buf_reset(esc_key);
    escape_string(esc_key, buf_string(binding));
 
    if (km->op == OP_MACRO)
      log_macro(buf_string(esc_key), km);
    else
      log_bind(md, buf_string(esc_key), km);
  }
 
  buf_pool_release(&binding);
  buf_pool_release(&esc_key);
}

Here is the call graph for this function:

Here is the caller graph for this function:

dump_submenus()

void dump_submenus	(	bool	brief,
		struct SubMenuIdArray *	smia )

Dump all submenus.

Parameters

brief	True for brief output
smia	Submenu ID array to populate

Definition at line 174 of file keymap.c.

{
  struct KeyModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_KEY);
  struct SubMenu *sm = NULL;
  ARRAY_FOREACH(sm, &mod_data->sub_menus)
  {
    struct SubMenuId smi = { ARRAY_FOREACH_IDX_sm, sm };
    ARRAY_ADD(smia, smi);
 
    int i = 0;
    for (; sm->functions[i].name; i++)
      ; // Do nothing
 
    if (sm->parent)
      mutt_debug(LL_DEBUG1, "SubMenu ID %d (%d functions) -- %s:\n",
                 ARRAY_FOREACH_IDX_sm, i, sm->parent->name);
    else
      mutt_debug(LL_DEBUG1, "SubMenu ID %d (%d functions):\n", ARRAY_FOREACH_IDX_sm, i);
 
    dump_submenu_functions(sm, brief);
    mutt_debug(LL_DEBUG1, "\n");
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

dump_menus()

void dump_menus

(

struct SubMenuIdArray *

smia

)

Dump all menus.

Parameters

smia	Submenu ID array

Definition at line 202 of file keymap.c.

{
  struct KeyModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_KEY);
  struct Buffer *buf = buf_pool_get();
 
  mutt_debug(LL_DEBUG1, "Menus:\n");
  struct MenuDefinition **mdp = NULL;
  ARRAY_FOREACH(mdp, &mod_data->menu_defs)
  {
    struct MenuDefinition *md = *mdp;
 
    buf_printf(buf, "    \"%s\" - %s (%d) - SubMenu IDs: ", md->name,
               name_menu_type(md->id), md->id);
 
    struct SubMenu **smp = NULL;
    ARRAY_FOREACH(smp, &md->submenus)
    {
      struct SubMenuId *smi = NULL;
      struct SubMenu *sm = *smp;
      int id = -1;
 
      ARRAY_FOREACH(smi, smia)
      {
        if (smi->sm == sm)
        {
          id = smi->id;
          break;
        }
      }
 
      const char *name = sm->parent ? sm->parent->name : "UNKNOWN";
      buf_add_printf(buf, "%s (%d)", name, id);
 
      if (ARRAY_FOREACH_IDX_smp < (ARRAY_SIZE(&md->submenus) - 1))
      {
        buf_add_printf(buf, ", ");
      }
    }
    mutt_debug(LL_DEBUG1, "%s\n", buf_string(buf));
  }
 
  buf_pool_release(&buf);
}

Here is the call graph for this function:

Here is the caller graph for this function:

dump_menu_funcs()

void dump_menu_funcs

(

bool

brief

)

Dump all menu functions.

Parameters

brief

True for brief output

Definition at line 250 of file keymap.c.

{
  struct SubMenuIdArray smia = ARRAY_HEAD_INITIALIZER;
 
  dump_submenus(brief, &smia);
  dump_menus(&smia);
 
  ARRAY_FREE(&smia);
}

Here is the call graph for this function:

dump_menu_binds()

void dump_menu_binds

(

bool

brief

)

Dump all menu bindings.

Parameters

brief

True for brief output

Definition at line 264 of file keymap.c.

{
  struct KeyModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_KEY);
  struct MenuDefinition **mdp = NULL;
  ARRAY_FOREACH(mdp, &mod_data->menu_defs)
  {
    struct MenuDefinition *md = *mdp;
 
    struct SubMenu *sm = *ARRAY_FIRST(&md->submenus);
 
    int count = 0;
    struct Keymap *km = NULL;
    STAILQ_FOREACH(km, &sm->keymaps, entries)
    {
      count++;
    }
 
    mutt_debug(LL_DEBUG1, "Menu %s (%s/%d) - (%d bindings):\n", md->name,
               name_menu_type(md->id), md->id, count);
    dump_submenu_bindings(md, sm, brief);
    mutt_debug(LL_DEBUG1, "\n");
  }
}

Here is the call graph for this function: