icommands.c File Reference

Information commands. More...

#include "config.h"
#include <limits.h>
#include <stdbool.h>
#include <stdio.h>
#include "mutt/lib.h"
#include "config/lib.h"
#include "core/lib.h"
#include "mutt.h"
#include "icommands.h"
#include "menu/lib.h"
#include "pager/lib.h"
#include "functions.h"
#include "init.h"
#include "keymap.h"
#include "muttlib.h"
#include "opcodes.h"
#include "version.h"

Include dependency graph for icommands.c:

Go to the source code of this file.

Functions
static enum CommandResult	icmd_bind (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
	Parse 'bind' and 'macro' commands - Implements ICommand::parse() More...
static enum CommandResult	icmd_set (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
	Parse 'set' command to display config - Implements ICommand::parse() More...
static enum CommandResult	icmd_version (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
	Parse 'version' command - Implements ICommand::parse() More...
enum CommandResult	mutt_parse_icommand (char *line, struct Buffer *err)
	Parse an informational command. More...
static void	dump_bind (struct Buffer *buf, struct Mapping *menu, struct Keymap *map)
	Dump a bind map to a buffer. More...
static void	dump_macro (struct Buffer *buf, struct Mapping *menu, struct Keymap *map)
	Dump a macro map to a buffer. More...
static bool	dump_menu (struct Buffer *buf, struct Mapping *menu, bool bind)
	Dumps all the binds or macros maps of a menu into a buffer. More...
static void	dump_all_menus (struct Buffer *buf, bool bind)
	Dumps all the binds or macros inside every menu. More...

Variables
static const struct ICommand	ICommandList []
	All available informational commands. More...

Detailed Description

Information commands.

Authors

• Christopher John Czettel
• Richard Russon
• Victor Fernandes

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

Function Documentation

icmd_bind()

static enum CommandResult icmd_bind ( struct Buffer *  buf, struct Buffer *  s, intptr_t  data, struct Buffer *  err  )

static

Parse 'bind' and 'macro' commands - Implements ICommand::parse()

Definition at line 231 of file icommands.c.

{
  FILE *fp_out = NULL;
  char tempfile[PATH_MAX];
  bool dump_all = false, bind = (data == 0);

  if (!MoreArgs(s))
    dump_all = true;
  else
    mutt_extract_token(buf, s, MUTT_TOKEN_NO_FLAGS);

  if (MoreArgs(s))
  {
    /* More arguments potentially means the user is using the
     * ::command_t :bind command thus we delegate the task. */
    return MUTT_CMD_ERROR;
  }

  struct Buffer filebuf = mutt_buffer_make(4096);
  if (dump_all || mutt_istr_equal(buf->data, "all"))
  {
    dump_all_menus(&filebuf, bind);
  }
  else
  {
    const int menu_index = mutt_map_get_value(buf->data, MenuNames);
    if (menu_index == -1)
    {
      // L10N: '%s' is the (misspelled) name of the menu, e.g. 'index' or 'pager'
      mutt_buffer_printf(err, _("%s: no such menu"), buf->data);
      mutt_buffer_dealloc(&filebuf);
      return MUTT_CMD_ERROR;
    }

    struct Mapping menu = { buf->data, menu_index };
    dump_menu(&filebuf, &menu, bind);
  }

  if (mutt_buffer_is_empty(&filebuf))
  {
    // L10N: '%s' is the name of the menu, e.g. 'index' or 'pager',
    //       it might also be 'all' when all menus are affected.
    mutt_buffer_printf(err, bind ? _("%s: no binds for this menu") : _("%s: no macros for this menu"),
                       dump_all ? "all" : buf->data);
    mutt_buffer_dealloc(&filebuf);
    return MUTT_CMD_ERROR;
  }

  mutt_mktemp(tempfile, sizeof(tempfile));
  fp_out = mutt_file_fopen(tempfile, "w");
  if (!fp_out)
  {
    // L10N: '%s' is the file name of the temporary file
    mutt_buffer_printf(err, _("Could not create temporary file %s"), tempfile);
    mutt_buffer_dealloc(&filebuf);
    return MUTT_CMD_ERROR;
  }
  fputs(filebuf.data, fp_out);

  mutt_file_fclose(&fp_out);
  mutt_buffer_dealloc(&filebuf);

  struct PagerData pdata = { 0 };
  struct PagerView pview = { &pdata };

  pdata.fname = tempfile;

  pview.banner = (bind) ? "bind" : "macro";
  pview.flags = MUTT_PAGER_NO_FLAGS;
  pview.mode = PAGER_MODE_OTHER;

  if (mutt_do_pager(&pview, NULL) == -1)
  {
    // L10N: '%s' is the file name of the temporary file
    mutt_buffer_printf(err, _("Could not create temporary file %s"), tempfile);
    return MUTT_CMD_ERROR;
  }

  return MUTT_CMD_SUCCESS;
}

Here is the call graph for this function:

icmd_set()

static enum CommandResult icmd_set ( struct Buffer *  buf, struct Buffer *  s, intptr_t  data, struct Buffer *  err  )

static

Parse 'set' command to display config - Implements ICommand::parse()

Definition at line 316 of file icommands.c.

{
  const bool set = mutt_str_equal(s->data, "set");
  const bool set_all = mutt_str_equal(s->data, "set all");

  if (!set && !set_all)
    return MUTT_CMD_ERROR;

  char tempfile[PATH_MAX];
  mutt_mktemp(tempfile, sizeof(tempfile));

  FILE *fp_out = mutt_file_fopen(tempfile, "w");
  if (!fp_out)
  {
    // L10N: '%s' is the file name of the temporary file
    mutt_buffer_printf(err, _("Could not create temporary file %s"), tempfile);
    return MUTT_CMD_ERROR;
  }

  if (set_all)
    dump_config(NeoMutt->sub->cs, CS_DUMP_NO_FLAGS, fp_out);
  else
    dump_config(NeoMutt->sub->cs, CS_DUMP_ONLY_CHANGED, fp_out);

  mutt_file_fclose(&fp_out);

  struct PagerData pdata = { 0 };
  struct PagerView pview = { &pdata };

  pdata.fname = tempfile;

  pview.banner = "set";
  pview.flags = MUTT_PAGER_NO_FLAGS;
  pview.mode = PAGER_MODE_OTHER;

  mutt_do_pager(&pview, NULL);

  return MUTT_CMD_SUCCESS;
}

Here is the call graph for this function:

icmd_version()

static enum CommandResult icmd_version ( struct Buffer *  buf, struct Buffer *  s, intptr_t  data, struct Buffer *  err  )

static

Parse 'version' command - Implements ICommand::parse()

Definition at line 360 of file icommands.c.

{
  char tempfile[PATH_MAX];
  mutt_mktemp(tempfile, sizeof(tempfile));

  FILE *fp_out = mutt_file_fopen(tempfile, "w");
  if (!fp_out)
  {
    // L10N: '%s' is the file name of the temporary file
    mutt_buffer_printf(err, _("Could not create temporary file %s"), tempfile);
    return MUTT_CMD_ERROR;
  }

  print_version(fp_out);
  mutt_file_fclose(&fp_out);

  struct PagerData pdata = { 0 };
  struct PagerView pview = { &pdata };

  pdata.fname = tempfile;

  pview.banner = "version";
  pview.flags = MUTT_PAGER_NO_FLAGS;
  pview.mode = PAGER_MODE_OTHER;

  if (mutt_do_pager(&pview, NULL) == -1)
  {
    // L10N: '%s' is the file name of the temporary file
    mutt_buffer_printf(err, _("Could not create temporary file %s"), tempfile);
    return MUTT_CMD_ERROR;
  }

  return MUTT_CMD_SUCCESS;
}

Here is the call graph for this function:

mutt_parse_icommand()

enum CommandResult mutt_parse_icommand	(	char *	line,
		struct Buffer *	err
	)

Parse an informational command.

Parameters

line	Command to execute
err	Buffer for error messages

Return values

MUTT_CMD_SUCCESS	Success
MUTT_CMD_WARNING	Warning with message: command failed
MUTT_CMD_ERROR	Error (no message): command not found Error with message: command failed

Definition at line 78 of file icommands.c.

{
  if (!line || (*line == '\0') || !err)
    return MUTT_CMD_ERROR;

  enum CommandResult rc = MUTT_CMD_ERROR;

  struct Buffer *token = mutt_buffer_pool_get();
  struct Buffer expn = mutt_buffer_make(0);
  mutt_buffer_addstr(&expn, line);
  mutt_buffer_seek(&expn, 0);

  mutt_buffer_reset(err);

  SKIPWS(expn.dptr);
  mutt_extract_token(token, &expn, MUTT_TOKEN_NO_FLAGS);
  for (size_t i = 0; ICommandList[i].name; i++)
  {
    if (!mutt_str_equal(token->data, ICommandList[i].name))
      continue;

    rc = ICommandList[i].parse(token, &expn, ICommandList[i].data, err);
    if (rc != 0)
      goto finish;

    break; /* Continue with next command */
  }

finish:
  mutt_buffer_pool_release(&token);
  mutt_buffer_dealloc(&expn);
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

dump_bind()

static void dump_bind ( struct Buffer *  buf, struct Mapping *  menu, struct Keymap *  map  )

static

Dump a bind map to a buffer.

Parameters

buf	Output buffer
menu	Map menu
map	Bind keymap

Definition at line 118 of file icommands.c.

{
  char key_binding[32];
  const char *fn_name = NULL;

  km_expand_key(key_binding, sizeof(key_binding), map);
  if (map->op == OP_NULL)
  {
    mutt_buffer_add_printf(buf, "bind %s %s noop\n", menu->name, key_binding);
    return;
  }

  /* The pager and editor menus don't use the generic map,
   * however for other menus try generic first. */
  if ((menu->value != MENU_PAGER) && (menu->value != MENU_EDITOR) && (menu->value != 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 Binding *bindings = km_get_table(menu->value);
    if (!bindings)
      return;

    fn_name = mutt_get_func(bindings, map->op);
  }

  mutt_buffer_add_printf(buf, "bind %s %s %s\n", menu->name, key_binding, fn_name);
}

Here is the call graph for this function:

Here is the caller graph for this function:

dump_macro()

static void dump_macro ( struct Buffer *  buf, struct Mapping *  menu, struct Keymap *  map  )

static

Dump a macro map to a buffer.

Parameters

buf	Output buffer
menu	Map menu
map	Macro keymap

Definition at line 157 of file icommands.c.

{
  char key_binding[MAX_SEQ];
  km_expand_key(key_binding, MAX_SEQ, map);

  struct Buffer tmp = mutt_buffer_make(0);
  escape_string(&tmp, map->macro);

  if (map->desc)
  {
    mutt_buffer_add_printf(buf, "macro %s %s \"%s\" \"%s\"\n", menu->name,
                           key_binding, tmp.data, map->desc);
  }
  else
  {
    mutt_buffer_add_printf(buf, "macro %s %s \"%s\"\n", menu->name, key_binding, tmp.data);
  }

  mutt_buffer_dealloc(&tmp);
}

Here is the call graph for this function:

Here is the caller graph for this function:

dump_menu()

static bool dump_menu ( struct Buffer *  buf, struct Mapping *  menu, bool  bind  )

static

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

Parameters

buf	Output buffer
menu	Menu to dump
bind	If true it's :bind, else :macro

Return values

true	Menu is empty
false	Menu is not empty

Definition at line 186 of file icommands.c.

{
  bool empty = true;
  struct Keymap *map = NULL;

  STAILQ_FOREACH(map, &Keymaps[menu->value], entries)
  {
    if (bind && (map->op != OP_MACRO))
    {
      empty = false;
      dump_bind(buf, menu, map);
    }
    else if (!bind && (map->op == OP_MACRO))
    {
      empty = false;
      dump_macro(buf, menu, map);
    }
  }

  return empty;
}

Here is the call graph for this function:

Here is the caller graph for this function:

dump_all_menus()

static void dump_all_menus ( struct Buffer *  buf, bool  bind  )

static

Dumps all the binds or macros inside every menu.

Parameters

buf	Output buffer
bind	If true it's :bind, else :macro

Definition at line 213 of file icommands.c.

{
  for (int i = 0; i < MENU_MAX; i++)
  {
    const char *menu_name = mutt_map_get_name(i, MenuNames);
    struct Mapping menu = { menu_name, i };

    const bool empty = dump_menu(buf, &menu, bind);

    /* Add a new line for readability between menus. */
    if (!empty && (i < (MENU_MAX - 1)))
      mutt_buffer_addch(buf, '\n');
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

ICommandList

const struct ICommand ICommandList[]

static

Initial value:

= {
  { "bind",     icmd_bind,     0 },
  { "macro",    icmd_bind,     1 },
  { "set",      icmd_set,      0 },
  { "version",  icmd_version,  0 },
  { NULL,       NULL,          0 },
}

All available informational commands.

Note

These commands take precedence over conventional NeoMutt rc-lines

Definition at line 59 of file icommands.c.