dump.c File Reference

Dump key bindings. More...

#include "config.h"
#include <limits.h>
#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
#include <string.h>
#include <wchar.h>
#include "mutt/lib.h"
#include "core/lib.h"
#include "gui/lib.h"
#include "lib.h"
#include "menu/lib.h"
#include "pager/lib.h"
#include "parse/lib.h"

Include dependency graph for dump.c:

Go to the source code of this file.

Functions
static int	print_bind (enum MenuType menu, FILE *fp)
	Display the bindings for one menu.
static void	colon_bind (enum MenuType menu, FILE *fp)
	Dump the key bindings.
static int	print_macro (enum MenuType menu, FILE *fp)
	Display the macros for one menu.
static void	colon_macro (enum MenuType menu, FILE *fp)
	Dump the macros.
enum CommandResult	dump_bind_macro (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
	Parse 'bind' and 'macro' commands - Implements Command::parse() -.
int	binding_sort (const void *a, const void *b, void *sdata)
	Compare two BindingInfo by their keybinding - Implements sort_t -.
void	escape_macro (const char *macro, struct Buffer *buf)
	Escape any special characters in a macro.
static const char *	help_lookup_function (int op, enum MenuType menu)
	Find a keybinding for an operation.
void	gather_menu (enum MenuType menu, struct BindingInfoArray *bia_bind, struct BindingInfoArray *bia_macro)
	Gather info about one menu.
int	measure_column (struct BindingInfoArray *bia, int col)
	Measure one column of a table.

Detailed Description

Dump key bindings.

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

Function Documentation

print_bind()

static int print_bind ( enum MenuType menu, FILE * fp )

static

Display the bindings for one menu.

Parameters

menu	Menu type
fp	File to write to

Return values

num	Number of bindings

Definition at line 51 of file dump.c.

{
  struct BindingInfoArray bia_bind = ARRAY_HEAD_INITIALIZER;
 
  gather_menu(menu, &bia_bind, NULL);
  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 = mutt_map_get_name(menu, MenuNames);
 
  struct BindingInfo *bi = NULL;
  ARRAY_FOREACH(bi, &bia_bind)
  {
    //XXX use description?
    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]);
  }
 
  return count;
}

Here is the call graph for this function:

Here is the caller graph for this function:

colon_bind()

static void colon_bind ( enum MenuType menu, FILE * fp )

static

Dump the key bindings.

Parameters

menu	Menu type
fp	File to write to

Definition at line 88 of file dump.c.

{
  if (menu == MENU_MAX)
  {
    for (enum MenuType i = 1; i < MENU_MAX; i++)
    {
      if (print_bind(i, fp) > 0)
        fprintf(fp, "\n");
    }
  }
  else
  {
    print_bind(menu, fp);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

print_macro()

static int print_macro ( enum MenuType menu, FILE * fp )

static

Display the macros for one menu.

Parameters

menu	Menu type
fp	File to write to

Return values

num	Number of macros

Definition at line 110 of file dump.c.

{
  struct BindingInfoArray bia_macro = ARRAY_HEAD_INITIALIZER;
 
  gather_menu(menu, NULL, &bia_macro);
  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 = mutt_map_get_name(menu, MenuNames);
 
  struct BindingInfo *bi = NULL;
  ARRAY_FOREACH(bi, &bia_macro)
  {
    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;
}

Here is the call graph for this function:

Here is the caller graph for this function:

colon_macro()

static void colon_macro ( enum MenuType menu, FILE * fp )

static

Dump the macros.

Parameters

menu	Menu type
fp	File to write to

Definition at line 154 of file dump.c.

{
  if (menu == MENU_MAX)
  {
    for (enum MenuType i = 1; i < MENU_MAX; i++)
    {
      if (print_macro(i, fp) > 0)
      {
        //XXX need to elide last blank line
        fprintf(fp, "\n");
      }
    }
  }
  else
  {
    print_macro(menu, fp);
  }
}

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 282 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:

help_lookup_function()

static const char * help_lookup_function ( int op, enum MenuType menu )

static

Find a keybinding for an operation.

Parameters

op	Operation, e.g. OP_DELETE
menu	Current Menu, e.g. MENU_PAGER

Return values

str	Key binding
NULL	No key binding found

Definition at line 336 of file dump.c.

{
  if ((menu != MENU_PAGER) && (menu != MENU_EDITOR) && (menu != MENU_GENERIC))
  {
    /* first look in the generic map for the function */
    const char *fn_name = mutt_get_func(OpGeneric, op);
    if (fn_name)
      return fn_name;
  }
 
  const struct MenuFuncOp *funcs = km_get_table(menu);
 
  return mutt_get_func(funcs, op);
}

Here is the call graph for this function:

Here is the caller graph for this function:

gather_menu()

void gather_menu	(	enum MenuType	menu,
		struct BindingInfoArray *	bia_bind,
		struct BindingInfoArray *	bia_macro )

Gather info about one menu.

Parameters

menu	Menu type
bia_bind	Array for bind results (may be NULL)
bia_macro	Array for macro results (may be NULL)

Definition at line 357 of file dump.c.

{
  struct Buffer *key_binding = buf_pool_get();
  struct Buffer *macro = buf_pool_get();
 
  struct Keymap *map = NULL;
  STAILQ_FOREACH(map, &Keymaps[menu], entries)
  {
    struct BindingInfo bi = { 0 };
 
    buf_reset(key_binding);
    km_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(map->op, menu);
      bi.a[2] = _(opcodes_get_description(map->op));
      ARRAY_ADD(bia_bind, bi);
    }
  }
 
  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:

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 413 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: