menu.h File Reference

Maniplate Menus and SubMenus. More...

#include <stdbool.h>
#include "mutt/lib.h"
#include "core/lib.h"
#include "menu/lib.h"
#include "get.h"
#include "keymap.h"

Include dependency graph for menu.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	MenuFuncOp
	Mapping between a function and an operation. More...
struct	MenuOpSeq
	Mapping between an operation and a key sequence. More...

Functions
bool	is_bound (const struct KeymapList *km_list, int op)
	Does a function have a keybinding?
struct Keymap *	km_find_func (enum MenuType mtype, int func)
	Find a function's mapping in a Menu.
int	km_get_op (const struct MenuFuncOp *funcs, const char *start, size_t len)
	Get the function by its name.

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.h.

Function Documentation

is_bound()

bool is_bound	(	const struct KeymapList *	km_list,
		int	op )

Does a function have a keybinding?

Parameters

km_list	Keymap to examine
op	Operation, e.g. OP_DELETE

Return values

true	A key is bound to that operation

Definition at line 82 of file menu.c.

{
  if (!km_list)
    return false;
 
  struct Keymap *map = NULL;
  STAILQ_FOREACH(map, km_list, entries)
  {
    if (map->op == op)
      return true;
  }
 
  return false;
}

Here is the caller graph for this function:

km_find_func()

struct Keymap * km_find_func	(	enum MenuType	mtype,
		int	func )

Find a function's mapping in a Menu.

Parameters

mtype	Menu type, e.g. MENU_PAGER
func	Function, e.g. OP_DELETE

Return values

ptr	Keymap for the function

Definition at line 45 of file menu.c.

{
  struct Keymap *np = NULL;
  STAILQ_FOREACH(np, &Keymaps[mtype], entries)
  {
    if (np->op == func)
      break;
  }
  return np;
}

Here is the caller graph for this function:

km_get_op()

int km_get_op	(	const struct MenuFuncOp *	funcs,
		const char *	start,
		size_t	len )

Get the function by its name.

Parameters

funcs	Functions table
start	Name of function to find
len	Length of string to match

Return values

num	Operation, e.g. OP_DELETE

Definition at line 63 of file menu.c.

{
  for (int i = 0; funcs[i].name; i++)
  {
    if (mutt_istrn_equal(start, funcs[i].name, len) && (mutt_str_len(funcs[i].name) == len))
    {
      return funcs[i].op;
    }
  }
 
  return OP_NULL;
}