menu.h File Reference

Maniplate Menus and SubMenus. More...

#include <stdbool.h>
#include "mutt/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...
struct	MenuFunctionOp
	Mapping between a function and an operation. More...
struct	SubMenu
	Collection of related functions. More...
struct	MenuDefinition
	Functions for a Dialog or Window. More...

Macros
#define	MAX_SEQ   8
	Maximum length of a key binding sequence used for buffer in km_bind.

Typedefs
typedef void(*	init_keys_t) (struct SubMenu *sm_generic)

Functions
	ARRAY_HEAD (MenuFunctionOpArray, struct MenuFunctionOp)
	ARRAY_HEAD (SubMenuArray, struct SubMenu)
	ARRAY_HEAD (SubMenuPArray, struct SubMenu *)
	ARRAY_HEAD (MenuDefinitionArray, struct MenuDefinition *)
bool	is_bound (const struct MenuDefinition *md, int op)
	Does a function have a keybinding?
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.

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.

Macro Definition Documentation

MAX_SEQ

#define MAX_SEQ   8

Maximum length of a key binding sequence used for buffer in km_bind.

Definition at line 32 of file menu.h.

Typedef Documentation

init_keys_t

typedef void(* init_keys_t) (struct SubMenu *sm_generic)

Definition at line 95 of file menu.h.

Function Documentation

ARRAY_HEAD() [1/4]

ARRAY_HEAD	(	MenuFunctionOpArray	,
		struct MenuFunctionOp	)

ARRAY_HEAD() [2/4]

ARRAY_HEAD	(	SubMenuArray	,
		struct SubMenu	)

ARRAY_HEAD() [3/4]

ARRAY_HEAD	(	SubMenuPArray	,
		struct SubMenu *	)

ARRAY_HEAD() [4/4]

ARRAY_HEAD	(	MenuDefinitionArray	,
		struct MenuDefinition *	)

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 287 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:

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 157 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 184 of file menu.c.

{
  struct MenuDefinition **mdp = NULL;
  ARRAY_FOREACH(mdp, &MenuDefs)
  {
    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 213 of file menu.c.

{
  struct MenuDefinition **mdp = NULL;
  ARRAY_FOREACH(mdp, &MenuDefs)
  {
    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 245 of file menu.c.

{
  struct MenuDefinition **mdp = NULL;
  ARRAY_FOREACH(mdp, &MenuDefs)
  {
    struct MenuDefinition *md = *mdp;
 
    if (md->id == menu)
      return md;
  }
 
  return NULL;
}

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 264 of file menu.c.

{
  if (!name)
    return NULL;
 
  struct MenuDefinition **mdp = NULL;
  ARRAY_FOREACH(mdp, &MenuDefs)
  {
    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: