NeoMutt  2025-12-11-435-g4ac674
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
menu.c
Go to the documentation of this file.
1
23
29
30#include "config.h"
31#include <stdbool.h>
32#include <stdio.h>
33#include "private.h"
34#include "mutt/lib.h"
35#include "gui/lib.h"
36#include "lib.h"
37#include "color/lib.h"
38#include "expando/lib.h" // IWYU pragma: keep
39#include "key/lib.h"
40#include "type.h"
41
42struct ConfigSubset;
43
46
50static const struct AttrColor *default_color(struct Menu *menu, int line)
51{
53}
54
58static int generic_search(struct Menu *menu, regex_t *rx, int line)
59{
60 struct Buffer *buf = buf_pool_get();
61
62 menu->make_entry(menu, line, -1, buf);
63 int rc = regexec(rx, buf->data, 0, NULL, 0);
64 buf_pool_release(&buf);
65
66 return rc;
67}
68
72void menu_cleanup(void)
73{
74 for (int i = 0; i < MENU_MAX; i++)
76}
77
81void menu_init(void)
82{
83 for (int i = 0; i < MENU_MAX; i++)
84 SearchBuffers[i] = NULL;
85}
86
92{
93 struct MuttWindow *win = window_get_focus();
94
95 // This should only happen before the first window is created
96 if (!win)
97 return MENU_INDEX;
98
99 if ((win->type == WT_CUSTOM) && (win->parent->type == WT_PAGER))
100 return MENU_PAGER;
101
102 if (win->type != WT_MENU)
103 return MENU_GENERIC;
104
105 struct Menu *menu = win->wdata;
106 if (!menu)
107 return MENU_GENERIC;
108
109 return menu->md->id;
110}
111
116void menu_free(struct Menu **ptr)
117{
118 if (!ptr || !*ptr)
119 return;
120
121 struct Menu *menu = *ptr;
122
123 notify_free(&menu->notify);
124
125 if (menu->mdata_free && menu->mdata)
126 menu->mdata_free(menu, &menu->mdata); // Custom function to free private data
127
128 FREE(ptr);
129}
130
138struct Menu *menu_new(const struct MenuDefinition *md, struct MuttWindow *win,
139 struct ConfigSubset *sub)
140{
141 struct Menu *menu = MUTT_MEM_CALLOC(1, struct Menu);
142
143 menu->md = md;
144 menu->redraw = MENU_REDRAW_FULL;
145 menu->color = default_color;
146 menu->search = generic_search;
147 menu->notify = notify_new();
148 menu->win = win;
149 menu->page_len = win->state.rows;
150 menu->sub = sub;
151 menu->show_indicator = true;
152
154 menu_add_observers(menu);
155
156 return menu;
157}
158
164int menu_get_index(struct Menu *menu)
165{
166 if (!menu)
167 return -1;
168
169 return menu->current;
170}
171
178MenuRedrawFlags menu_set_index(struct Menu *menu, int index)
179{
180 return menu_move_selection(menu, index);
181}
182
189{
190 if (!menu)
191 return;
192
193 menu->redraw |= redraw;
194 menu->win->actions |= WA_RECALC;
195}
Color and attribute parsing.
struct AttrColor * simple_color_get(enum ColorId cid)
Get the colour of an object by its ID.
Definition simple.c:95
@ MT_COLOR_NORMAL
Plain text.
Definition color.h:53
Parse Expando string.
static const struct AttrColor * default_color(struct Menu *menu, int line)
Get the default colour for a line of the menu - Implements Menu::color() -.
Definition menu.c:50
static int generic_search(struct Menu *menu, regex_t *rx, int line)
Search a menu for a item matching a regex - Implements Menu::search() -.
Definition menu.c:58
Convenience wrapper for the gui headers.
Manage keymappings.
#define FREE(x)
Free memory and set the pointer to NULL.
Definition memory.h:68
#define MUTT_MEM_CALLOC(n, type)
Definition memory.h:52
char * SearchBuffers[]
Previous search string, one for each MenuType.
Definition menu.c:45
GUI present the user with a selectable list.
#define MENU_REDRAW_FULL
Redraw everything.
Definition lib.h:60
uint8_t MenuRedrawFlags
Flags, e.g. MENU_REDRAW_INDEX.
Definition lib.h:55
MenuRedrawFlags menu_move_selection(struct Menu *menu, int index)
Move the selection, keeping within between [0, menu->max].
Definition move.c:236
enum MenuType menu_get_current_type(void)
Get the type of the current Window.
Definition menu.c:91
void menu_init(void)
Initialise all the Menus.
Definition menu.c:81
void menu_cleanup(void)
Free the saved Menu searches.
Definition menu.c:72
void menu_queue_redraw(struct Menu *menu, MenuRedrawFlags redraw)
Queue a request for a redraw.
Definition menu.c:188
int menu_get_index(struct Menu *menu)
Get the current selection in the Menu.
Definition menu.c:164
struct Menu * menu_new(const struct MenuDefinition *md, struct MuttWindow *win, struct ConfigSubset *sub)
Create a new Menu.
Definition menu.c:138
void menu_free(struct Menu **ptr)
Free a Menu.
Definition menu.c:116
MenuRedrawFlags menu_set_index(struct Menu *menu, int index)
Set the current selection in the Menu.
Definition menu.c:178
void menu_add_observers(struct Menu *menu)
Add the notification observers.
Definition observer.c:134
Private Menu functions.
Convenience wrapper for the library headers.
struct Notify * notify_new(void)
Create a new notifications handler.
Definition notify.c:62
void notify_set_parent(struct Notify *notify, struct Notify *parent)
Set the parent notification handler.
Definition notify.c:95
void notify_free(struct Notify **ptr)
Free a notification handler.
Definition notify.c:75
struct MuttWindow * window_get_focus(void)
Get the currently focused Window.
#define WA_RECALC
Recalculate the contents of the Window.
@ WT_CUSTOM
Window with a custom drawing function.
Definition mutt_window.h:94
@ WT_PAGER
A panel containing the Pager Window.
Definition mutt_window.h:99
@ WT_MENU
An Window containing a Menu.
Definition mutt_window.h:97
struct Buffer * buf_pool_get(void)
Get a Buffer from the pool.
Definition pool.c:91
void buf_pool_release(struct Buffer **ptr)
Return a Buffer to the pool.
Definition pool.c:111
A curses colour and its attributes.
Definition attr.h:65
String manipulation buffer.
Definition buffer.h:36
char * data
Pointer to data.
Definition buffer.h:37
A set of inherited config items.
Definition subset.h:46
Functions for a Dialog or Window.
Definition menu.h:80
int id
Menu ID, e.g. MENU_ALIAS.
Definition menu.h:81
Definition lib.h:80
struct MuttWindow * win
Window holding the Menu.
Definition lib.h:88
int current
Current entry.
Definition lib.h:81
const struct AttrColor *(* color)(struct Menu *menu, int line)
Definition lib.h:145
MenuRedrawFlags redraw
When to redraw the screen.
Definition lib.h:83
void(* mdata_free)(struct Menu *menu, void **ptr)
Definition lib.h:163
bool show_indicator
Show the Indicator colour.
Definition lib.h:87
int(* search)(struct Menu *menu, regex_t *rx, int line)
Definition lib.h:121
const struct MenuDefinition * md
Menu definition for keymap entries.
Definition lib.h:84
int(* make_entry)(struct Menu *menu, int line, int max_cols, struct Buffer *buf)
Definition lib.h:108
struct ConfigSubset * sub
Inherited config items.
Definition lib.h:89
struct Notify * notify
Notifications.
Definition lib.h:147
void * mdata
Private data.
Definition lib.h:149
int page_len
Number of entries per screen.
Definition lib.h:85
struct WindowState state
Current state of the Window.
void * wdata
Private data.
struct Notify * notify
Notifications: NotifyWindow, EventWindow.
struct MuttWindow * parent
Parent Window.
WindowActionFlags actions
Actions to be performed, e.g. WA_RECALC.
enum WindowType type
Window type, e.g. WT_SIDEBAR.
short rows
Number of rows, can be MUTT_WIN_SIZE_UNLIMITED.
Definition mutt_window.h:61
Menu types.
MenuType
Types of GUI selections.
Definition type.h:33
@ MENU_INDEX
Index panel (list of emails)
Definition type.h:44
@ MENU_GENERIC
Generic selection list.
Definition type.h:43
@ MENU_PAGER
Pager pager (email viewer)
Definition type.h:45
@ MENU_MAX
Definition type.h:51