NeoMutt  2025-12-11-276-g10b23b
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
window.c
Go to the documentation of this file.
1
22
28
29#include "config.h"
30#include <stdbool.h>
31#include <string.h>
32#include <wchar.h>
33#include "mutt/lib.h"
34#include "core/lib.h"
35#include "gui/lib.h"
36#include "color/lib.h"
37#include "complete/lib.h"
38#include "history/lib.h"
39#include "key/lib.h"
40#include "menu/lib.h"
41#include "functions.h"
42#include "muttlib.h"
43#include "state.h"
44#include "wdata.h"
45
47static const struct Mapping EditorHelp[] = {
48 // clang-format off
49 { N_("Help"), OP_HELP },
50 { N_("Complete"), OP_EDITOR_COMPLETE },
51 { N_("Hist Up"), OP_EDITOR_HISTORY_UP },
52 { N_("Hist Down"), OP_EDITOR_HISTORY_DOWN },
53 { N_("Hist Search"), OP_EDITOR_HISTORY_SEARCH },
54 { N_("Begin Line"), OP_EDITOR_BOL },
55 { N_("End Line"), OP_EDITOR_EOL },
56 { N_("Kill Line"), OP_EDITOR_KILL_LINE },
57 { N_("Kill Word"), OP_EDITOR_KILL_WORD },
58 { NULL, 0 },
59 // clang-format on
60};
61
69static int my_addwch(struct MuttWindow *win, wchar_t wc)
70{
71 int n = wcwidth(wc);
72 if (IsWPrint(wc) && (n > 0))
73 return mutt_addwch(win, wc);
74 if (!(wc & ~0x7f))
75 return mutt_window_printf(win, "^%c", ((int) wc + 0x40) & 0x7f);
76 if (!(wc & ~0xffff))
77 return mutt_window_printf(win, "\\u%04x", (int) wc);
78 return mutt_window_printf(win, "\\u%08x", (int) wc);
79}
80
87bool self_insert(struct EnterWindowData *wdata, int ch)
88{
89 if (!wdata)
90 return true;
91
92 wdata->tabs = 0;
93 wchar_t wc = 0;
94
95 /* quietly ignore all other function keys */
96 if (ch & ~0xff)
97 return false;
98
99 /* gather the bytes into a wide character */
100 {
101 char c = ch;
102 size_t k = mbrtowc(&wc, &c, 1, wdata->mbstate);
103 if (k == ICONV_BUF_TOO_SMALL)
104 {
105 return false;
106 }
107 else if ((k != 0) && (k != 1))
108 {
109 memset(wdata->mbstate, 0, sizeof(*wdata->mbstate));
110 return false;
111 }
112 }
113
114 if (wdata->first && (wdata->flags & MUTT_COMP_CLEAR))
115 {
116 wdata->first = false;
117 if (IsWPrint(wc)) /* why? */
118 {
119 wdata->state->curpos = 0;
120 wdata->state->lastchar = 0;
121 }
122 }
123
124 if ((wc == '\r') || (wc == '\n'))
125 {
126 /* Convert from wide characters */
127 buf_mb_wcstombs(wdata->buffer, wdata->state->wbuf, wdata->state->lastchar);
128 if (!wdata->pass)
129 mutt_hist_add(wdata->hclass, buf_string(wdata->buffer), true);
130
131 if (wdata->cdata)
132 {
133 struct FileCompletionData *cdata = wdata->cdata;
134 if (cdata->multiple)
135 {
136 char **tfiles = NULL;
137 *cdata->numfiles = 1;
138 tfiles = MUTT_MEM_CALLOC(*cdata->numfiles, char *);
139 expand_path(wdata->buffer, false);
140 tfiles[0] = buf_strdup(wdata->buffer);
141 *cdata->files = tfiles;
142 }
143 }
144 return true;
145 }
146 else if (wc && ((wc < ' ') || IsWPrint(wc))) /* why? */
147 {
148 if (wdata->state->lastchar >= wdata->state->wbuflen)
149 {
150 wdata->state->wbuflen = wdata->state->lastchar + 20;
151 MUTT_MEM_REALLOC(&wdata->state->wbuf, wdata->state->wbuflen, wchar_t);
152 }
153 memmove(wdata->state->wbuf + wdata->state->curpos + 1,
154 wdata->state->wbuf + wdata->state->curpos,
155 (wdata->state->lastchar - wdata->state->curpos) * sizeof(wchar_t));
156 wdata->state->wbuf[wdata->state->curpos++] = wc;
157 wdata->state->lastchar++;
158 }
159 else
160 {
162 mutt_beep(false);
163 }
164
165 return false;
166}
167
173static int enter_recalc(struct MuttWindow *win)
174{
176 mutt_debug(LL_DEBUG5, "recalc done, request WA_REPAINT\n");
177
178 return 0;
179}
180
184static int enter_repaint(struct MuttWindow *win)
185{
187 return 0;
188
189 struct EnterWindowData *wdata = win->wdata;
190
191 mutt_window_clearline(win, 0);
193 mutt_window_addstr(win, wdata->prompt);
195
196 int prompt_length = 0;
197 mutt_window_get_coords(win, NULL, &prompt_length);
198
199 int width = win->state.cols - prompt_length - 1;
200
201 if (!wdata->pass)
202 {
203 if (wdata->redraw == ENTER_REDRAW_INIT)
204 {
205 /* Go to end of line */
206 wdata->state->curpos = wdata->state->lastchar;
208 wdata->state->wbuf, wdata->state->lastchar,
209 mutt_mb_wcswidth(wdata->state->wbuf, wdata->state->lastchar) - width + 1);
210 }
211 if ((wdata->state->curpos < wdata->state->begin) ||
212 (mutt_mb_wcswidth(wdata->state->wbuf + wdata->state->begin,
213 wdata->state->curpos - wdata->state->begin) >= width))
214 {
216 wdata->state->wbuf, wdata->state->lastchar,
217 mutt_mb_wcswidth(wdata->state->wbuf, wdata->state->curpos) - (width / 2));
218 }
219 mutt_window_move(win, 0, prompt_length);
220 int w = 0;
221 for (size_t i = wdata->state->begin; i < wdata->state->lastchar; i++)
222 {
223 w += mutt_mb_wcwidth(wdata->state->wbuf[i]);
224 if (w > width)
225 break;
226 my_addwch(win, wdata->state->wbuf[i]);
227 }
229 mutt_window_move(win, 0,
230 prompt_length +
231 mutt_mb_wcswidth(wdata->state->wbuf + wdata->state->begin,
232 wdata->state->curpos - wdata->state->begin));
233 }
234
235 mutt_window_get_coords(win, &wdata->row, &wdata->col);
236 mutt_debug(LL_DEBUG5, "repaint done\n");
237
238 return 0;
239}
240
244static bool enter_recursor(struct MuttWindow *win)
245{
246 struct EnterWindowData *wdata = win->wdata;
247 mutt_window_move(win, wdata->row, wdata->col);
249 return true;
250}
251
271int mw_get_field(const char *prompt, struct Buffer *buf, CompletionFlags complete,
272 enum HistoryClass hclass, const struct CompleteOps *comp_api, void *cdata)
273{
276
278 if (complete & MUTT_COMP_UNBUFFERED)
279 flags = GETCH_IGNORE_MACRO;
280
281 int rc = 0;
282
283 struct EnterState *es = enter_state_new();
284
285 win->help_data = EditorHelp;
286 win->help_menu = MENU_EDITOR;
287
289 struct MuttWindow *old_focus = window_set_focus(win);
290
291 mbstate_t mbstate = { 0 };
292 // clang-format off
293 struct EnterWindowData wdata = { buf, complete, es, hclass, comp_api, cdata, prompt, ENTER_REDRAW_NONE, (complete & MUTT_COMP_PASS), true, NULL, 0, &mbstate, 0, false, NULL, 0, 0 };
294 // clang-format on
295
296 win->wdata = &wdata;
297 win->wdata_free = NULL; // No need, we hold the data
298 win->recalc = enter_recalc;
299 win->repaint = enter_repaint;
301
302 window_redraw(win);
303
304 if (es->wbuf[0] == L'\0')
305 {
306 /* Initialise wbuf from buf */
307 wdata.state->wbuflen = 0;
308 wdata.state->lastchar = mutt_mb_mbstowcs(&wdata.state->wbuf, &wdata.state->wbuflen,
309 0, buf_string(wdata.buffer));
311 }
312 else
313 {
315 wdata.first = false;
316 }
317
318 do
319 {
320 memset(&mbstate, 0, sizeof(mbstate));
321
322 do
323 {
324 if (wdata.redraw != ENTER_REDRAW_NONE)
325 win->actions |= WA_REPAINT;
326
327 window_redraw(NULL);
328 struct KeyEvent event = km_dokey(MENU_EDITOR, flags);
329 if ((event.op == OP_TIMEOUT) || (event.op == OP_REPAINT))
330 {
331 continue;
332 }
333
334 if (event.op == OP_ABORT)
335 {
336 rc = -1;
337 goto bye;
338 }
339
340 if (event.op == OP_NULL)
341 {
342 if (complete & MUTT_COMP_PASS)
343 mutt_debug(LL_DEBUG5, "Got char *\n");
344 else
345 mutt_debug(LL_DEBUG5, "Got char %c (0x%02x)\n", event.ch, event.ch);
346
347 if (self_insert(&wdata, event.ch))
348 {
349 rc = 0;
350 goto bye;
351 }
352 win->actions |= WA_REPAINT;
353 continue;
354 }
355 else
356 {
357 mutt_debug(LL_DEBUG1, "Got op %s (%d)\n", opcodes_get_name(event.op),
358 event.op);
359 }
360
361 wdata.first = false;
362 if ((event.op != OP_EDITOR_COMPLETE) && (event.op != OP_EDITOR_COMPLETE_QUERY))
363 wdata.tabs = 0;
365 int rc_disp = enter_function_dispatcher(win, &event);
366 switch (rc_disp)
367 {
368 case FR_NO_ACTION:
369 {
370 if (self_insert(&wdata, event.ch))
371 {
372 rc = 0;
373 goto bye;
374 }
375 break;
376 }
377 case FR_CONTINUE: // repaint
378 rc = 1;
379 goto bye;
380
381 case FR_SUCCESS:
382 rc = 0;
383 break;
384
385 case FR_UNKNOWN:
386 case FR_ERROR:
387 default:
388 mutt_beep(false);
389 }
390 } while (!wdata.done);
391
392 bye:
394 FREE(&wdata.tempbuf);
395 } while (rc == 1);
396
397 completion_data_free(&wdata.cd);
399 window_set_focus(old_focus);
400 mutt_window_free(&win);
401
402 if (rc == 0)
403 buf_fix_dptr(buf);
404 else
405 buf_reset(buf);
406
407 enter_state_free(&es);
408
409 return rc;
410}
void buf_reset(struct Buffer *buf)
Reset an existing Buffer.
Definition buffer.c:76
void buf_fix_dptr(struct Buffer *buf)
Move the dptr to end of the Buffer.
Definition buffer.c:182
char * buf_strdup(const struct Buffer *buf)
Copy a Buffer's string.
Definition buffer.c:571
static const char * buf_string(const struct Buffer *buf)
Convert a buffer to a const char * "string".
Definition buffer.h:96
Color and attribute parsing.
@ MT_COLOR_NORMAL
Plain text.
Definition color.h:53
@ MT_COLOR_PROMPT
Question/user input.
Definition color.h:56
Auto-completion.
Convenience wrapper for the core headers.
int mutt_addwch(struct MuttWindow *win, wchar_t wc)
Addwch would be provided by an up-to-date curses library.
Definition curs_lib.c:319
void mutt_beep(bool force)
Irritate the user.
Definition curs_lib.c:68
void completion_data_free(struct CompletionData **ptr)
Free the Completion Data.
Definition data.c:53
@ 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
@ FR_CONTINUE
Remain in the Dialog.
Definition dispatcher.h:35
@ FR_NO_ACTION
Valid function - no action performed.
Definition dispatcher.h:38
Editor functions.
struct EnterState * enter_state_new(void)
Create a new EnterState.
Definition state.c:74
void enter_state_free(struct EnterState **ptr)
Free an EnterState.
Definition state.c:38
Struct to store the cursor position when entering text.
Enter Window Data.
uint8_t CompletionFlags
Flags for mw_get_field(), e.g. MUTT_COMP_NO_FLAGS.
Definition wdata.h:41
#define MUTT_COMP_PASS
Password mode (no echo)
Definition wdata.h:44
#define MUTT_COMP_UNBUFFERED
Ignore macro buffer.
Definition wdata.h:45
@ ENTER_REDRAW_NONE
Nothing to redraw.
Definition wdata.h:36
@ ENTER_REDRAW_LINE
Redraw entire line.
Definition wdata.h:38
@ ENTER_REDRAW_INIT
Go to end of line and redraw.
Definition wdata.h:37
#define MUTT_COMP_CLEAR
Clear input if printable character is pressed.
Definition wdata.h:43
static const struct Mapping EditorHelp[]
Help Bar for the Command Line Editor.
Definition window.c:47
static int my_addwch(struct MuttWindow *win, wchar_t wc)
Display one wide character on screen.
Definition window.c:69
bool self_insert(struct EnterWindowData *wdata, int ch)
Insert a normal character.
Definition window.c:87
struct KeyEvent km_dokey(enum MenuType mtype, GetChFlags flags)
Determine what a keypress should do.
Definition get.c:431
void mutt_flushinp(void)
Empty all the keyboard buffers.
Definition get.c:65
uint8_t GetChFlags
Flags for mutt_getch(), e.g. GETCH_NO_FLAGS.
Definition get.h:33
#define GETCH_IGNORE_MACRO
Don't use MacroEvents.
Definition get.h:35
#define GETCH_NO_FLAGS
No flags are set.
Definition get.h:34
int enter_function_dispatcher(struct MuttWindow *win, const struct KeyEvent *event)
Perform an Enter function - Implements function_dispatcher_t -.
Definition functions.c:492
int mw_get_field(const char *prompt, struct Buffer *buf, CompletionFlags complete, enum HistoryClass hclass, const struct CompleteOps *comp_api, void *cdata)
Ask the user for a string -.
Definition window.c:271
#define mutt_debug(LEVEL,...)
Definition logging2.h:91
static int enter_recalc(struct MuttWindow *win)
Recalculate the Window data - Implements MuttWindow::recalc() -.
Definition window.c:173
static bool enter_recursor(struct MuttWindow *win)
Recursor the Window - Implements MuttWindow::recursor() -.
Definition window.c:244
static int enter_repaint(struct MuttWindow *win)
Repaint the Window - Implements MuttWindow::repaint() -.
Definition window.c:184
Convenience wrapper for the gui headers.
Read/write command history from/to a file.
HistoryClass
Type to differentiate different histories.
Definition lib.h:54
void mutt_hist_add(enum HistoryClass hclass, const char *str, bool save)
Add a string to a history.
Definition history.c:482
void mutt_hist_reset_state(enum HistoryClass hclass)
Move the 'current' position to the end of the History.
Definition history.c:578
Manage keymappings.
@ LL_DEBUG5
Log at debug level 5.
Definition logging2.h:49
@ LL_DEBUG1
Log at debug level 1.
Definition logging2.h:45
size_t mutt_mb_width_ceiling(const wchar_t *s, size_t n, int w1)
Keep the end of the string on-screen.
Definition mbyte.c:238
size_t mutt_mb_mbstowcs(wchar_t **pwbuf, size_t *pwbuflen, size_t i, const char *buf)
Convert a string from multibyte to wide characters.
Definition mbyte.c:292
int mutt_mb_wcswidth(const wchar_t *s, size_t n)
Measure the screen width of a string.
Definition mbyte.c:217
void buf_mb_wcstombs(struct Buffer *dest, const wchar_t *wstr, size_t wlen)
Convert a string from wide to multibyte characters.
Definition mbyte.c:257
int mutt_mb_wcwidth(wchar_t wc)
Measure the screen width of a character.
Definition mbyte.c:199
#define IsWPrint(wc)
Definition mbyte.h:40
#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
#define MUTT_MEM_REALLOC(pptr, n, type)
Definition memory.h:55
GUI present the user with a selectable list.
void msgcont_push_window(struct MuttWindow *win)
Add a window to the Container Stack.
Definition msgcont.c:100
struct MuttWindow * msgcont_pop_window(void)
Remove the last Window from the Container Stack.
Definition msgcont.c:57
#define ICONV_BUF_TOO_SMALL
Error value for iconv() - Buffer too small.
Definition charset.h:116
Convenience wrapper for the library headers.
#define N_(a)
Definition message.h:32
const struct AttrColor * mutt_curses_set_normal_backed_color_by_id(enum ColorId cid)
Set the colour and attributes by the Colour ID.
Definition mutt_curses.c:63
enum MuttCursorState mutt_curses_set_cursor(enum MuttCursorState state)
Set the cursor state.
Definition mutt_curses.c:94
const struct AttrColor * mutt_curses_set_color_by_id(enum ColorId cid)
Set the colour and attributes by the Colour ID.
Definition mutt_curses.c:79
@ MUTT_CURSOR_VISIBLE
Display a normal cursor.
Definition mutt_curses.h:66
bool mutt_window_is_visible(struct MuttWindow *win)
Is the Window visible?
void window_redraw(struct MuttWindow *win)
Reflow, recalc and repaint a tree of Windows.
void mutt_window_free(struct MuttWindow **ptr)
Free a Window and its children.
int mutt_window_printf(struct MuttWindow *win, const char *fmt,...)
Write a formatted string to a Window.
struct MuttWindow * mutt_window_new(enum WindowType type, enum MuttWindowOrientation orient, enum MuttWindowSize size, int cols, int rows)
Create a new Window.
struct MuttWindow * window_set_focus(struct MuttWindow *win)
Set the Window focus.
int mutt_window_move(struct MuttWindow *win, int row, int col)
Move the cursor in a Window.
void mutt_window_get_coords(struct MuttWindow *win, int *row, int *col)
Get the cursor position in the Window.
void mutt_window_clearline(struct MuttWindow *win, int row)
Clear a row of a Window.
int mutt_window_addstr(struct MuttWindow *win, const char *str)
Write a string to a Window.
void mutt_window_clrtoeol(struct MuttWindow *win)
Clear to the end of the line.
@ WT_CUSTOM
Window with a custom drawing function.
Definition mutt_window.h:94
@ MUTT_WIN_ORIENT_VERTICAL
Window uses all available vertical space.
Definition mutt_window.h:38
#define WA_REPAINT
Redraw the contents of the Window.
#define MUTT_WIN_SIZE_UNLIMITED
Use as much space as possible.
Definition mutt_window.h:52
@ MUTT_WIN_SIZE_FIXED
Window has a fixed size.
Definition mutt_window.h:47
void expand_path(struct Buffer *buf, bool regex)
Create the canonical path.
Definition muttlib.c:121
Some miscellaneous functions.
const char * opcodes_get_name(int op)
Get the name of an opcode.
Definition opcodes.c:48
#define OP_TIMEOUT
1 second with no events
Definition opcodes.h:35
#define OP_REPAINT
Repaint is needed.
Definition opcodes.h:34
#define OP_ABORT
$abort_key pressed (Ctrl-G)
Definition opcodes.h:36
String manipulation buffer.
Definition buffer.h:36
Keep our place when entering a string.
Definition state.h:32
size_t curpos
Position of the cursor.
Definition state.h:36
size_t wbuflen
Length of buffer.
Definition state.h:34
size_t begin
Position of the start.
Definition state.h:37
wchar_t * wbuf
Buffer for the string being entered.
Definition state.h:33
size_t lastchar
Position of the last character.
Definition state.h:35
Data to fill the Enter Window.
Definition wdata.h:51
bool pass
Password mode, conceal characters.
Definition wdata.h:63
int tabs
Number of times the user has hit tab.
Definition wdata.h:68
void * cdata
Auto-Completion private data.
Definition wdata.h:58
CompletionFlags flags
Flags, see CompletionFlags.
Definition wdata.h:54
int row
Cursor row.
Definition wdata.h:74
struct CompletionData * cd
Auto-completion state data.
Definition wdata.h:72
struct Buffer * buffer
struct Buffer for the result
Definition wdata.h:53
bool done
Is text-entry done?
Definition wdata.h:70
bool first
First time through, no input yet.
Definition wdata.h:64
int col
Cursor column.
Definition wdata.h:75
wchar_t * tempbuf
Buffer used by completion.
Definition wdata.h:65
const struct CompleteOps * comp_api
Auto-Completion API.
Definition wdata.h:57
const char * prompt
Prompt.
Definition wdata.h:61
struct EnterState * state
Current state of text entry.
Definition wdata.h:55
enum EnterRedrawFlags redraw
What needs redrawing? See EnterRedrawFlags.
Definition wdata.h:62
mbstate_t * mbstate
Multi-byte state.
Definition wdata.h:67
enum HistoryClass hclass
History to use, e.g. HC_NEO_COMMAND.
Definition wdata.h:56
Input for the file completion function.
Definition curs_lib.h:39
char *** files
List of files selected.
Definition curs_lib.h:42
struct MuttWindow * win
Current Focused Window.
Definition curs_lib.h:44
bool multiple
Allow multiple selections.
Definition curs_lib.h:40
int * numfiles
Number of files selected.
Definition curs_lib.h:43
An event such as a keypress.
Definition get.h:50
int op
Function opcode, e.g. OP_HELP.
Definition get.h:52
int ch
Raw key pressed.
Definition get.h:51
Mapping between user-readable string and a constant.
Definition mapping.h:33
const struct Mapping * help_data
Data for the Help Bar.
int(* repaint)(struct MuttWindow *win)
struct WindowState state
Current state of the Window.
void * wdata
Private data.
int(* recalc)(struct MuttWindow *win)
void(* wdata_free)(struct MuttWindow *win, void **ptr)
int help_menu
Menu for key bindings, e.g. MENU_PAGER.
WindowActionFlags actions
Actions to be performed, e.g. WA_RECALC.
bool(* recursor)(struct MuttWindow *win)
short cols
Number of columns, can be MUTT_WIN_SIZE_UNLIMITED.
Definition mutt_window.h:60
@ MENU_EDITOR
Text entry area.
Definition type.h:42