dump.h File Reference

Dump key bindings. More...

#include <stdbool.h>
#include <stdio.h>
#include "mutt/lib.h"

Include dependency graph for dump.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	BindingInfo
	Info about one keybinding. More...

Functions
	ARRAY_HEAD (BindingInfoArray, struct BindingInfo)
int	binding_sort (const void *a, const void *b, void *sdata)
	Compare two BindingInfo by their keybinding - Implements sort_t -.
void	colon_bind (const struct MenuDefinition *md, FILE *fp)
	Dump the key bindings.
void	colon_macro (const struct MenuDefinition *md, FILE *fp)
	Dump the macros.
void	dump_bind_macro (const struct Command *cmd, const struct MenuDefinition *md, struct Buffer *buf, struct Buffer *err)
	Dump a Menu's binds or macros to the Pager.
void	escape_macro (const char *macro, struct Buffer *buf)
	Escape any special characters in a macro.
void	gather_menu (const struct MenuDefinition *md, struct BindingInfoArray *bia_bind, struct BindingInfoArray *bia_macro, bool one_submenu)
	Gather info about one menu.
int	gather_unbound (const struct MenuDefinition *md, struct BindingInfoArray *bia_unbound)
	Gather info about unbound functions for one menu.
const char *	help_lookup_function (const struct MenuDefinition *md, int op)
	Find a keybinding for an operation.
struct StringArray	km_get_func_array (const struct MenuDefinition *md)
	Get array of function names for a Menu.
int	measure_column (struct BindingInfoArray *bia, int col)
	Measure one column of a table.
int	print_bind (const struct MenuDefinition *md, FILE *fp)
	Display the bindings for one menu.
int	print_macro (const struct MenuDefinition *md, FILE *fp)
	Display the macros for one menu.

Detailed Description

Dump key bindings.

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 dump.h.

Function Documentation

ARRAY_HEAD()

ARRAY_HEAD	(	BindingInfoArray	,
		struct BindingInfo	)

Here is the call graph for this function:

colon_bind()

void colon_bind	(	const struct MenuDefinition *	md,
		FILE *	fp )

Dump the key bindings.

Parameters

md	Menu Definition, NULL for all Menus
fp	File to write to

Definition at line 289 of file dump.c.

{
  if (md)
  {
    print_bind(md, fp);
  }
  else
  {
    struct MenuDefinition **mdp = NULL;
    ARRAY_FOREACH(mdp, &MenuDefs)
    {
      if (print_bind((*mdp), fp) > 0)
      {
        fprintf(fp, "\n");
      }
    }
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

colon_macro()

void colon_macro	(	const struct MenuDefinition *	md,
		FILE *	fp )

Dump the macros.

Parameters

md	Menu Definition, NULL for all Menus
fp	File to write to

Definition at line 361 of file dump.c.

{
  if (md)
  {
    print_macro(md, fp);
  }
  else
  {
    struct MenuDefinition **mdp = NULL;
    ARRAY_FOREACH(mdp, &MenuDefs)
    {
      if (print_macro((*mdp), fp) > 0)
      {
        fprintf(fp, "\n");
      }
    }
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

dump_bind_macro()

void dump_bind_macro	(	const struct Command *	cmd,
		const struct MenuDefinition *	md,
		struct Buffer *	buf,
		struct Buffer *	err )

Dump a Menu's binds or macros to the Pager.

Parameters

cmd	Command
md	Menu Definition, NULL for all Menus
buf	Menu name, e.g. "index"
err	Buffer for errors

Definition at line 387 of file dump.c.

{
  bool dump_all = (md == NULL);
 
  struct Buffer *tempfile = buf_pool_get();
  buf_mktemp(tempfile);
  FILE *fp = mutt_file_fopen(buf_string(tempfile), "w");
  if (!fp)
  {
    // L10N: '%s' is the file name of the temporary file
    buf_printf(err, _("Could not create temporary file %s"), buf_string(tempfile));
    goto done;
  }
 
  if (cmd->id == CMD_BIND)
    colon_bind(md, fp);
  else
    colon_macro(md, fp);
 
  if (ftello(fp) == 0)
  {
    // L10N: '%s' is the name of the menu, e.g. 'index' or 'pager',
    //       it might also be 'all' when all menus are affected.
    buf_printf(err, (cmd->id == CMD_BIND) ? _("%s: no binds for this menu") : _("%s: no macros for this menu"),
               dump_all ? "all" : buf_string(buf));
    goto done;
  }
  mutt_file_fclose(&fp);
 
  struct PagerData pdata = { 0 };
  struct PagerView pview = { &pdata };
 
  pdata.fname = buf_string(tempfile);
 
  pview.banner = cmd->name;
  pview.flags = MUTT_PAGER_NO_FLAGS;
  pview.mode = PAGER_MODE_OTHER;
 
  mutt_do_pager(&pview, NULL);
 
done:
  mutt_file_fclose(&fp);
  buf_pool_release(&tempfile);
}

Here is the call graph for this function:

Here is the caller graph for this function:

escape_macro()

void escape_macro	(	const char *	macro,
		struct Buffer *	buf )

Escape any special characters in a macro.

Parameters

[in]	macro	Macro string
[out]	buf	Buffer for the result

Replace characters, such as <Enter> with the literal "\n"

Definition at line 54 of file dump.c.

{
  wchar_t wc = 0;
  size_t k;
  size_t len = mutt_str_len(macro);
  mbstate_t mbstate1 = { 0 };
  mbstate_t mbstate2 = { 0 };
 
  for (; (len > 0) && (k = mbrtowc(&wc, macro, MB_LEN_MAX, &mbstate1)); macro += k, len -= k)
  {
    if ((k == ICONV_ILLEGAL_SEQ) || (k == ICONV_BUF_TOO_SMALL))
    {
      if (k == ICONV_ILLEGAL_SEQ)
        memset(&mbstate1, 0, sizeof(mbstate1));
      k = (k == ICONV_ILLEGAL_SEQ) ? 1 : len;
      wc = ReplacementChar;
    }
 
    const int w = wcwidth(wc);
    if (IsWPrint(wc) && (w >= 0))
    {
      char tmp[MB_LEN_MAX * 2] = { 0 };
      if (wcrtomb(tmp, wc, &mbstate2) != ICONV_ILLEGAL_SEQ)
      {
        buf_addstr(buf, tmp);
      }
    }
    else if ((wc < 0x20) || (wc == 0x7f))
    {
      if (wc == '\033') // Escape
        buf_addstr(buf, "\\e");
      else if (wc == '\n')
        buf_addstr(buf, "\\n");
      else if (wc == '\r')
        buf_addstr(buf, "\\r");
      else if (wc == '\t')
        buf_addstr(buf, "\\t");
      else
        buf_add_printf(buf, "^%c", (char) ((wc + '@') & 0x7f));
    }
    else
    {
      buf_addch(buf, '?');
    }
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

gather_menu()

void gather_menu	(	const struct MenuDefinition *	md,
		struct BindingInfoArray *	bia_bind,
		struct BindingInfoArray *	bia_macro,
		bool	one_submenu )

Gather info about one menu.

Parameters

[in]	md	Menu Definition
[out]	bia_bind	Array for bind results (may be NULL)
[out]	bia_macro	Array for macro results (may be NULL)
[in]	one_submenu	Only parse the first SubMenu

Definition at line 134 of file dump.c.

{
  struct Buffer *key_binding = buf_pool_get();
  struct Buffer *macro = buf_pool_get();
 
  struct SubMenu **smp = NULL;
 
  ARRAY_FOREACH(smp, &md->submenus)
  {
    struct SubMenu *sm = *smp;
    const char *name = sm->parent->name;
 
    struct BindingInfo bi_label = { ARRAY_FOREACH_IDX_smp, { NULL, NULL, name } };
 
    if (bia_bind)
      ARRAY_ADD(bia_bind, bi_label);
    if (bia_macro)
      ARRAY_ADD(bia_macro, bi_label);
 
    struct Keymap *map = NULL;
    STAILQ_FOREACH(map, &sm->keymaps, entries)
    {
      struct BindingInfo bi = { ARRAY_FOREACH_IDX_smp, { NULL, NULL, NULL } };
 
      buf_reset(key_binding);
      keymap_expand_key(map, key_binding);
 
      if (map->op == OP_MACRO)
      {
        if (!bia_macro || (map->op == OP_NULL))
          continue;
 
        buf_reset(macro);
        escape_macro(map->macro, macro);
        bi.a[0] = buf_strdup(key_binding);
        bi.a[1] = buf_strdup(macro);
        bi.a[2] = map->desc;
        ARRAY_ADD(bia_macro, bi);
      }
      else
      {
        if (!bia_bind)
          continue;
 
        if (map->op == OP_NULL)
        {
          bi.a[0] = buf_strdup(key_binding);
          bi.a[1] = "noop";
          ARRAY_ADD(bia_bind, bi);
          continue;
        }
 
        bi.a[0] = buf_strdup(key_binding);
        bi.a[1] = help_lookup_function(md, map->op);
        bi.a[2] = _(opcodes_get_description(map->op));
        ARRAY_ADD(bia_bind, bi);
      }
    }
 
    if (one_submenu)
      break;
  }
 
  buf_pool_release(&key_binding);
  buf_pool_release(&macro);
}

Here is the call graph for this function:

Here is the caller graph for this function:

gather_unbound()

int gather_unbound	(	const struct MenuDefinition *	md,
		struct BindingInfoArray *	bia_unbound )

Gather info about unbound functions for one menu.

Parameters

[in]	md	Menu Definition
[out]	bia_unbound	Unbound functions

Return values

num	Number of unbound functions

Definition at line 439 of file dump.c.

{
  if (!bia_unbound)
    return 0;
 
  struct SubMenu **smp = NULL;
 
  ARRAY_FOREACH(smp, &md->submenus)
  {
    struct SubMenu *sm = *smp;
 
    for (int i = 0; sm->functions[i].name; i++)
    {
      const struct MenuFuncOp *mfo = &sm->functions[i];
 
      if (mfo->flags & MFF_DEPRECATED)
        continue;
 
      if (is_bound(md, mfo->op))
        continue;
 
      struct BindingInfo bi = { 0 };
      bi.a[0] = NULL;
      bi.a[1] = mfo->name;
      bi.a[2] = _(opcodes_get_description(mfo->op));
      ARRAY_ADD(bia_unbound, bi);
    }
  }
 
  return ARRAY_SIZE(bia_unbound);
}

Here is the call graph for this function:

Here is the caller graph for this function:

help_lookup_function()

const char * help_lookup_function	(	const struct MenuDefinition *	md,
		int	op )

Find a keybinding for an operation.

Parameters

md	Menu Definition
op	Operation, e.g. OP_DELETE

Return values

str	Key binding
NULL	No key binding found

Definition at line 108 of file dump.c.

{
  struct SubMenu **smp = NULL;
 
  ARRAY_FOREACH(smp, &md->submenus)
  {
    struct SubMenu *sm = *smp;
 
    for (int i = 0; sm->functions[i].name; i++)
    {
      const struct MenuFuncOp *mfo = &sm->functions[i];
      if (mfo->op == op)
        return mfo->name;
    }
  }
 
  return "UNKNOWN";
}

Here is the caller graph for this function:

km_get_func_array()

struct StringArray km_get_func_array

(

const struct MenuDefinition *

md

)

Get array of function names for a Menu.

Parameters

md	Menu Definition

Definition at line 475 of file dump.c.

{
  struct StringArray fna = ARRAY_HEAD_INITIALIZER;
 
  struct SubMenu **smp = NULL;
  ARRAY_FOREACH(smp, &md->submenus)
  {
    struct SubMenu *sm = *smp;
 
    for (int i = 0; sm->functions[i].name; i++)
    {
      ARRAY_ADD(&fna, sm->functions[i].name);
    }
  }
 
  return fna;
}

Here is the call graph for this function:

Here is the caller graph for this function:

measure_column()

int measure_column	(	struct BindingInfoArray *	bia,
		int	col )

Measure one column of a table.

Parameters

bia	Array of binding info
col	Column to measure

Return values

num	Width of widest column

Definition at line 229 of file dump.c.

{
  int max_width = 0;
 
  struct BindingInfo *bi = NULL;
  ARRAY_FOREACH(bi, bia)
  {
    const int col_width = mutt_strwidth(bi->a[col]);
    max_width = MAX(max_width, col_width);
  }
 
  return max_width;
}

Here is the call graph for this function:

Here is the caller graph for this function:

print_bind()

int print_bind	(	const struct MenuDefinition *	md,
		FILE *	fp )

Display the bindings for one menu.

Parameters

md	Menu Definition
fp	File to write to

Return values

num	Number of bindings

Definition at line 249 of file dump.c.

{
  struct BindingInfoArray bia_bind = ARRAY_HEAD_INITIALIZER;
 
  gather_menu(md, &bia_bind, NULL, true);
  if (ARRAY_EMPTY(&bia_bind))
    return 0;
 
  ARRAY_SORT(&bia_bind, binding_sort, NULL);
  const int wb0 = measure_column(&bia_bind, 0);
  const int wb1 = measure_column(&bia_bind, 1);
 
  const char *menu_name = md->name;
 
  struct BindingInfo *bi = NULL;
  ARRAY_FOREACH(bi, &bia_bind)
  {
    if (!bi->a[0])
      continue;
 
    fprintf(fp, "bind %s %*s  %*s  # %s\n", menu_name, -wb0, bi->a[0], -wb1,
            bi->a[1], bi->a[2]);
  }
 
  const int count = ARRAY_SIZE(&bia_bind);
  ARRAY_FOREACH(bi, &bia_bind)
  {
    // we only need to free the keybinding
    FREE(&bi->a[0]);
  }
 
  ARRAY_FREE(&bia_bind);
  return count - 1;
}

Here is the call graph for this function:

Here is the caller graph for this function:

print_macro()

int print_macro	(	const struct MenuDefinition *	md,
		FILE *	fp )

Display the macros for one menu.

Parameters

md	Menu Definition
fp	File to write to

Return values

num	Number of macros

Definition at line 314 of file dump.c.

{
  struct BindingInfoArray bia_macro = ARRAY_HEAD_INITIALIZER;
 
  gather_menu(md, NULL, &bia_macro, true);
  if (ARRAY_EMPTY(&bia_macro))
    return 0;
 
  ARRAY_SORT(&bia_macro, binding_sort, NULL);
  const int wm0 = measure_column(&bia_macro, 0);
 
  const char *menu_name = md->name;
 
  struct BindingInfo *bi = NULL;
  ARRAY_FOREACH(bi, &bia_macro)
  {
    if (!bi->a[0])
      continue;
 
    if (bi->a[2]) // description
    {
      fprintf(fp, "macro %s %*s  \"%s\"  \"%s\"\n", menu_name, -wm0, bi->a[0],
              bi->a[1], bi->a[2]);
    }
    else
    {
      fprintf(fp, "macro %s %*s  \"%s\"\n", menu_name, -wm0, bi->a[0], bi->a[1]);
    }
  }
 
  const int count = ARRAY_SIZE(&bia_macro);
  ARRAY_FOREACH(bi, &bia_macro)
  {
    // free the keybinding and the macro text
    FREE(&bi->a[0]);
    FREE(&bi->a[1]);
  }
 
  ARRAY_FREE(&bia_macro);
  return count - 1;
}

Here is the call graph for this function:

Here is the caller graph for this function: