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 "core/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() -.

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 47 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 84 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 106 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 150 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: