dump.c File Reference

Dump key bindings. More...

#include "config.h"
#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
#include "mutt/lib.h"
#include "config/lib.h"
#include "core/lib.h"
#include "gui/lib.h"
#include "key/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 bool	dump_bind (struct Buffer *buf, enum MenuType menu, const char *name)
	Dumps all the binds maps of a menu into a buffer.
static void	dump_all_binds (struct Buffer *buf)
	Dumps all the binds inside every menu.
static bool	dump_macro (struct Buffer *buf, enum MenuType menu, const char *name)
	Dumps all the macros maps of a menu into a buffer.
static void	dump_all_macros (struct Buffer *buf)
	Dumps all the macros inside every menu.
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() -.

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

dump_bind()

static bool dump_bind ( struct Buffer *  buf, enum MenuType  menu, const char *  name  )

static

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

Parameters

buf	Output buffer
menu	Menu to dump
name	Menu name

Return values

true	Menu is empty
false	Menu is not empty

Definition at line 51 of file dump.c.

{
  bool empty = true;
  struct Keymap *map = NULL;
 
  struct Buffer *key_binding = buf_pool_get();
 
  STAILQ_FOREACH(map, &Keymaps[menu], entries)
  {
    if (map->op == OP_MACRO)
      continue;
 
    const char *fn_name = NULL;
 
    buf_reset(key_binding);
    km_expand_key(map, key_binding);
    if (map->op == OP_NULL)
    {
      buf_add_printf(buf, "bind %s %s noop\n", name, buf_string(key_binding));
      continue;
    }
 
    /* The pager and editor menus don't use the generic map,
     * however for other menus try generic first. */
    if ((menu != MENU_PAGER) && (menu != MENU_EDITOR) && (menu != MENU_GENERIC))
    {
      fn_name = mutt_get_func(OpGeneric, map->op);
    }
 
    /* if it's one of the menus above or generic doesn't find
     * the function, try with its own menu. */
    if (!fn_name)
    {
      const struct MenuFuncOp *funcs = km_get_table(menu);
      if (!funcs)
        continue;
 
      fn_name = mutt_get_func(funcs, map->op);
    }
 
    buf_add_printf(buf, "bind %s %s %s\n", name, buf_string(key_binding), fn_name);
    empty = false;
  }
 
  buf_pool_release(&key_binding);
  return empty;
}

Here is the call graph for this function:

Here is the caller graph for this function:

dump_all_binds()

static void dump_all_binds ( struct Buffer *  buf )

static

Dumps all the binds inside every menu.

Parameters

buf	Output buffer

Definition at line 103 of file dump.c.

{
  for (enum MenuType i = 1; i < MENU_MAX; i++)
  {
    const bool empty = dump_bind(buf, i, mutt_map_get_name(i, MenuNames));
 
    /* Add a new line for readability between menus. */
    if (!empty && (i < (MENU_MAX - 1)))
      buf_addch(buf, '\n');
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

dump_macro()

static bool dump_macro ( struct Buffer *  buf, enum MenuType  menu, const char *  name  )

static

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

Parameters

buf	Output buffer
menu	Menu to dump
name	Menu name

Return values

true	Menu is empty
false	Menu is not empty

Definition at line 123 of file dump.c.

{
  bool empty = true;
  struct Keymap *map = NULL;
 
  struct Buffer *key_binding = buf_pool_get();
 
  STAILQ_FOREACH(map, &Keymaps[menu], entries)
  {
    if (map->op != OP_MACRO)
      continue;
 
    buf_reset(key_binding);
    km_expand_key(map, key_binding);
 
    struct Buffer *tmp = buf_pool_get();
    escape_string(tmp, map->macro);
 
    if (map->desc)
    {
      buf_add_printf(buf, "macro %s %s \"%s\" \"%s\"\n", name,
                     buf_string(key_binding), buf_string(tmp), map->desc);
    }
    else
    {
      buf_add_printf(buf, "macro %s %s \"%s\"\n", name, buf_string(key_binding),
                     buf_string(tmp));
    }
 
    buf_pool_release(&tmp);
    empty = false;
  }
 
  buf_pool_release(&key_binding);
  return empty;
}

Here is the call graph for this function:

Here is the caller graph for this function:

dump_all_macros()

static void dump_all_macros ( struct Buffer *  buf )

static

Dumps all the macros inside every menu.

Parameters

buf	Output buffer

Definition at line 164 of file dump.c.

{
  for (enum MenuType i = 1; i < MENU_MAX; i++)
  {
    const bool empty = dump_macro(buf, i, mutt_map_get_name(i, MenuNames));
 
    /* Add a new line for legibility between menus. */
    if (!empty && (i < (MENU_MAX - 1)))
      buf_addch(buf, '\n');
  }
}

Here is the call graph for this function:

Here is the caller graph for this function: