dump.c

Go to the documentation of this file.

 
#include "config.h"
#include <limits.h>
#include <stdbool.h>
#include <stdio.h>
#include <string.h>
#include <wchar.h>
#include "mutt/lib.h"
#include "config/lib.h"
#include "core/lib.h"
#include "gui/lib.h"
#include "dump.h"
#include "pager/lib.h"
#include "get.h"
#include "keymap.h"
#include "menu.h"
#include "module_data.h"

void escape_macro(const char *macro, struct Buffer *buf)
{
  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, '?');
    }
  }
}

const char *help_lookup_function(const struct MenuDefinition *md, int op)
{
  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";
}

void gather_menu(const struct MenuDefinition *md, struct BindingInfoArray *bia_bind,
                 struct BindingInfoArray *bia_macro, bool one_submenu)
{
  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);
}

int binding_sort(const void *a, const void *b, void *sdata)
{
  const struct BindingInfo *x = (const struct BindingInfo *) a;
  const struct BindingInfo *y = (const struct BindingInfo *) b;
 
  // Sort by SubMenu
  if (x->order != y->order)
    return mutt_numeric_cmp(x->order, y->order);
 
  // Sort by Keybinding
  int rc = mutt_str_cmp(x->a[0], y->a[0]);
  if (rc != 0)
    return rc;
 
  // No binding, sort by function instead
  return mutt_str_cmp(x->a[1], y->a[1]);
}

int measure_column(struct BindingInfoArray *bia, int col)
{
  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;
}

int print_bind(const struct MenuDefinition *md, FILE *fp)
{
  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;
}

void colon_bind(const struct MenuDefinition *md, FILE *fp)
{
  struct KeyModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_KEY);
  if (md)
  {
    print_bind(md, fp);
  }
  else
  {
    struct MenuDefinition **mdp = NULL;
    ARRAY_FOREACH(mdp, &mod_data->menu_defs)
    {
      if (print_bind((*mdp), fp) > 0)
      {
        fprintf(fp, "\n");
      }
    }
  }
}

int print_macro(const struct MenuDefinition *md, FILE *fp)
{
  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;
}

void colon_macro(const struct MenuDefinition *md, FILE *fp)
{
  struct KeyModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_KEY);
  if (md)
  {
    print_macro(md, fp);
  }
  else
  {
    struct MenuDefinition **mdp = NULL;
    ARRAY_FOREACH(mdp, &mod_data->menu_defs)
    {
      if (print_macro((*mdp), fp) > 0)
      {
        fprintf(fp, "\n");
      }
    }
  }
}

void dump_bind_macro(const struct Command *cmd, const struct MenuDefinition *md,
                     struct Buffer *buf, struct Buffer *err)
{
  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);
}

int gather_unbound(const struct MenuDefinition *md, struct BindingInfoArray *bia_unbound)
{
  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);
}

struct StringArray km_get_func_array(const struct MenuDefinition *md)
{
  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;
}