menu.c File Reference

Maniplate Menus and SubMenus. More...

#include "config.h"
#include <string.h>
#include "mutt/lib.h"
#include "core/lib.h"
#include "gui/lib.h"
#include "menu.h"
#include "get.h"
#include "keymap.h"
#include "module_data.h"

Include dependency graph for menu.c:

Go to the source code of this file.

Functions
enum CommandResult	km_bind (struct MenuDefinition *md, const char *key_str, int op, char *macro, char *desc, struct Buffer *err)
	Set up a key binding.
struct Keymap *	km_find_func (const struct MenuDefinition *md, int func)
	Find a function's mapping in a Menu.
int	km_get_op (const char *func)
	Get the OpCode for a Function.
int	km_get_op_menu (int mtype, const char *func)
	Get the OpCode for a Function from a Menu.
struct MenuDefinition *	menu_find (int menu)
	Find a Menu Definition by Menu type.
struct MenuDefinition *	menu_find_by_name (const char *name)
	Find a Menu Definition by its name.
bool	is_bound (const struct MenuDefinition *md, int op)
	Does a function have a keybinding?

Detailed Description

Maniplate Menus and SubMenus.

Authors

• Richard Russon

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

Function Documentation

km_bind()

enum CommandResult km_bind	(	struct MenuDefinition *	md,
		const char *	key_str,
		int	op,
		char *	macro,
		char *	desc,
		struct Buffer *	err )

Set up a key binding.

Parameters

md	Menu Definition
key_str	Key string
op	Operation, e.g. OP_DELETE
macro	Macro string
desc	Description of macro (OPTIONAL)
err	Buffer for error message

Return values

CommandResult

Result e.g. MUTT_CMD_SUCCESS

Insert a key sequence into the specified map. The map is sorted by ASCII value (lowest to highest)

Definition at line 52 of file menu.c.

{
  if (!md || ARRAY_EMPTY(&md->submenus))
    return MUTT_CMD_ERROR;
 
  enum CommandResult rc = MUTT_CMD_SUCCESS;
  struct Keymap *last = NULL;
  struct Keymap *np = NULL;
  struct Keymap *compare = NULL;
  keycode_t buf[KEY_SEQ_MAX_LEN] = { 0 };
  size_t pos = 0;
  size_t lastpos = 0;
 
  struct SubMenu *sm = *ARRAY_FIRST(&md->submenus);
  struct KeymapList *kml = &sm->keymaps;
 
  size_t len = parse_keys(key_str, buf, KEY_SEQ_MAX_LEN);
 
  struct Keymap *map = keymap_alloc(len, buf);
  map->op = op;
  map->macro = mutt_str_dup(macro);
  map->desc = mutt_str_dup(desc);
 
  /* find position to place new keymap */
  STAILQ_FOREACH(np, kml, entries)
  {
    compare = keymap_compare(map, np, &pos);
 
    if (compare == map) /* map's keycode is bigger */
    {
      last = np;
      lastpos = pos;
      if (pos > np->eq)
        pos = np->eq;
    }
    else if (compare == np) /* np's keycode is bigger, found insert location */
    {
      map->eq = pos;
      break;
    }
    else /* equal keycodes */
    {
      if (np->len < len)
      {
        // Prefix-compatible binding, continue looking for insertion point.
        last = np;
        lastpos = np->len;
        if (pos > np->eq)
          pos = np->eq;
        continue;
      }
      else if (np->len > len)
      {
        // Prefix-compatible binding, insert before the longer sequence.
        map->eq = len;
        break;
      }
 
      // Exact same key sequence: replace existing mapping.
      map->eq = np->eq;
      STAILQ_REMOVE(kml, np, Keymap, entries);
      keymap_free(&np);
      break;
    }
  }
 
  if (last) /* if queue has at least one entry */
  {
    if (STAILQ_NEXT(last, entries))
      STAILQ_INSERT_AFTER(kml, last, map, entries);
    else /* last entry in the queue */
      STAILQ_INSERT_TAIL(kml, map, entries);
    last->eq = lastpos;
  }
  else /* queue is empty, so insert from head */
  {
    STAILQ_INSERT_HEAD(kml, map, entries);
  }
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

km_find_func()

struct Keymap * km_find_func	(	const struct MenuDefinition *	md,
		int	func )

Find a function's mapping in a Menu.

Parameters

md	Menu Definition
func	Function, e.g. OP_DELETE

Return values

ptr	Keymap for the function

Definition at line 141 of file menu.c.

{
  if (!md)
    return NULL;
 
  struct SubMenu **smp = NULL;
 
  ARRAY_FOREACH(smp, &md->submenus)
  {
    struct SubMenu *sm = *smp;
 
    struct Keymap *map = NULL;
    STAILQ_FOREACH(map, &sm->keymaps, entries)
    {
      if (map->op == func)
        return map;
    }
  }
 
  return NULL;
}

Here is the caller graph for this function:

km_get_op()

int km_get_op

(

const char *

func

)

Get the OpCode for a Function.

Parameters

func	Function name, e.g. "exit"

Return values

num	OpCode, e.g. OP_EXIT

Definition at line 168 of file menu.c.

{
  struct KeyModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_KEY);
  struct MenuDefinition **mdp = NULL;
  ARRAY_FOREACH(mdp, &mod_data->menu_defs)
  {
    struct MenuDefinition *md = *mdp;
    struct SubMenu **smp = NULL;
 
    ARRAY_FOREACH(smp, &md->submenus)
    {
      struct SubMenu *sm = *smp;
 
      for (int i = 0; sm->functions[i].name; i++)
      {
        if (mutt_str_equal(sm->functions[i].name, func))
          return sm->functions[i].op;
      }
    }
  }
 
  return OP_NULL;
}

Here is the call graph for this function:

Here is the caller graph for this function:

km_get_op_menu()

int km_get_op_menu	(	int	mtype,
		const char *	func )

Get the OpCode for a Function from a Menu.

Parameters

mtype	Menu Type, e.g. MENU_INDEX
func	Function name, e.g. "exit"

Return values

num	OpCode, e.g. OP_EXIT

Definition at line 198 of file menu.c.

{
  struct KeyModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_KEY);
  struct MenuDefinition **mdp = NULL;
  ARRAY_FOREACH(mdp, &mod_data->menu_defs)
  {
    struct MenuDefinition *md = *mdp;
 
    if (md->id != mtype)
      continue;
 
    struct SubMenu **smp = NULL;
 
    ARRAY_FOREACH(smp, &md->submenus)
    {
      struct SubMenu *sm = *smp;
 
      for (int i = 0; sm->functions[i].name; i++)
      {
        if (mutt_str_equal(sm->functions[i].name, func))
          return sm->functions[i].op;
      }
    }
  }
 
  return OP_NULL;
}

Here is the call graph for this function:

Here is the caller graph for this function:

menu_find()

struct MenuDefinition * menu_find

(

int

menu

)

Find a Menu Definition by Menu type.

Parameters

menu	Menu Type, e.g. MENU_INDEX

Return values

ptr	Menu Definition

Definition at line 231 of file menu.c.

{
  struct KeyModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_KEY);
  struct MenuDefinition **mdp = NULL;
  ARRAY_FOREACH(mdp, &mod_data->menu_defs)
  {
    struct MenuDefinition *md = *mdp;
 
    if (md->id == menu)
      return md;
  }
 
  return NULL;
}

Here is the call graph for this function:

Here is the caller graph for this function:

menu_find_by_name()

struct MenuDefinition * menu_find_by_name

(

const char *

name

)

Find a Menu Definition by its name.

Parameters

name	Menu name, e.g. "index"

Return values

ptr	Menu Definition

Definition at line 251 of file menu.c.

{
  if (!name)
    return NULL;
 
  struct KeyModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_KEY);
  struct MenuDefinition **mdp = NULL;
  ARRAY_FOREACH(mdp, &mod_data->menu_defs)
  {
    struct MenuDefinition *md = *mdp;
 
    if (mutt_str_equal(md->name, name))
      return md;
  }
 
  return NULL;
}

Here is the call graph for this function:

Here is the caller graph for this function:

is_bound()

bool is_bound	(	const struct MenuDefinition *	md,
		int	op )

Does a function have a keybinding?

Parameters

md	Menu Definition
op	Operation, e.g. OP_DELETE

Return values

true	A key is bound to that operation

Definition at line 275 of file menu.c.

{
  struct SubMenu **smp = NULL;
 
  ARRAY_FOREACH(smp, &md->submenus)
  {
    struct SubMenu *sm = *smp;
 
    struct Keymap *map = NULL;
    STAILQ_FOREACH(map, &sm->keymaps, entries)
    {
      if (map->op == op)
        return true;
    }
  }
 
  return false;
}

Here is the caller graph for this function: