NeoMutt  2025-12-11-435-g4ac674
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
functions.c
Go to the documentation of this file.
1
22
28
29#include "config.h"
30#include <stddef.h>
31#include "mutt/lib.h"
32#include "core/lib.h"
33#include "gui/lib.h"
34#include "functions.h"
35#include "key/lib.h"
36#include "menu/lib.h"
37
41static int op_generic_select_entry(struct HistoryData *hd, const struct KeyEvent *event)
42{
43 const int index = menu_get_index(hd->menu);
44
45 const char **pentry = ARRAY_GET(hd->matches, index);
46 if (pentry)
47 buf_strcpy(hd->buf, *pentry);
48
49 hd->done = true;
50 hd->selection = true;
51 return FR_SUCCESS;
52}
53
57static int op_quit(struct HistoryData *hd, const struct KeyEvent *event)
58{
59 hd->done = true;
60 hd->selection = false;
61 return FR_SUCCESS;
62}
63
64// -----------------------------------------------------------------------------
65
69static const struct HistoryFunction HistoryFunctions[] = {
70 // clang-format off
71 { OP_GENERIC_SELECT_ENTRY, op_generic_select_entry },
72 { OP_QUIT, op_quit },
73 { OP_EXIT, op_quit },
74 { 0, NULL },
75 // clang-format on
76};
77
81int history_function_dispatcher(struct MuttWindow *win, const struct KeyEvent *event)
82{
83 // The Dispatcher may be called on any Window in the Dialog
84 struct MuttWindow *dlg = dialog_find(win);
85 if (!event || !dlg || !dlg->wdata)
86 return FR_ERROR;
87
88 const int op = event->op;
89 struct Menu *menu = dlg->wdata;
90 struct HistoryData *hd = menu->mdata;
91 if (!hd)
92 return FR_ERROR;
93
94 int rc = FR_UNKNOWN;
95 for (size_t i = 0; HistoryFunctions[i].op != OP_NULL; i++)
96 {
97 const struct HistoryFunction *fn = &HistoryFunctions[i];
98 if (fn->op == op)
99 {
100 rc = fn->function(hd, event);
101 break;
102 }
103 }
104
105 if (rc == FR_UNKNOWN) // Not our function
106 return rc;
107
108 const char *result = dispatcher_get_retval_name(rc);
109 mutt_debug(LL_DEBUG1, "Handled %s (%d) -> %s\n", opcodes_get_name(op), op, NONULL(result));
110
111 return rc;
112}
#define ARRAY_GET(head, idx)
Return the element at index.
Definition array.h:109
size_t buf_strcpy(struct Buffer *buf, const char *s)
Copy a string into a Buffer.
Definition buffer.c:395
Convenience wrapper for the core headers.
struct MuttWindow * dialog_find(struct MuttWindow *win)
Find the parent Dialog of a Window.
Definition dialog.c:89
const char * dispatcher_get_retval_name(int rv)
Get the name of a return value.
Definition dispatcher.c:54
@ FR_SUCCESS
Valid function - successfully performed.
Definition dispatcher.h:40
@ FR_UNKNOWN
Unknown function.
Definition dispatcher.h:34
@ FR_ERROR
Valid function - error occurred.
Definition dispatcher.h:39
static int op_generic_select_entry(struct AliasMenuData *mdata, const struct KeyEvent *event)
select the current entry - Implements alias_function_t -
Definition functions.c:248
int history_function_dispatcher(struct MuttWindow *win, const struct KeyEvent *event)
Perform a History function - Implements function_dispatcher_t -.
Definition functions.c:81
static int op_quit(struct HistoryData *hd, const struct KeyEvent *event)
Quit this menu - Implements history_function_t -.
Definition functions.c:57
#define mutt_debug(LEVEL,...)
Definition logging2.h:91
Convenience wrapper for the gui headers.
static const struct HistoryFunction HistoryFunctions[]
All the NeoMutt functions that the History supports.
Definition functions.c:69
History functions.
Manage keymappings.
@ LL_DEBUG1
Log at debug level 1.
Definition logging2.h:45
GUI present the user with a selectable list.
int menu_get_index(struct Menu *menu)
Get the current selection in the Menu.
Definition menu.c:164
Convenience wrapper for the library headers.
const char * opcodes_get_name(int op)
Get the name of an opcode.
Definition opcodes.c:48
#define NONULL(x)
Definition string2.h:44
Data to pass to the History Functions.
Definition functions.h:35
struct Menu * menu
History Menu.
Definition functions.h:39
struct Buffer * buf
Buffer for the results.
Definition functions.h:38
struct StringArray * matches
History entries.
Definition functions.h:40
bool done
Should we close the Dialog?
Definition functions.h:36
bool selection
Was a selection made?
Definition functions.h:37
A NeoMutt function.
Definition functions.h:62
history_function_t function
Function to call.
Definition functions.h:64
int op
Op code, e.g. OP_GENERIC_SELECT_ENTRY.
Definition functions.h:63
An event such as a keypress.
Definition get.h:50
Definition lib.h:80
void * mdata
Private data.
Definition lib.h:149
void * wdata
Private data.