NeoMutt  2024-03-23-147-g885fbc
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
msgwin.h File Reference

Message Window. More...

#include <stdbool.h>
#include "color/lib.h"
+ Include dependency graph for msgwin.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

void msgwin_clear_text (struct MuttWindow *win)
 Clear the text in the Message Window.
 
struct MuttWindowmsgwin_new (bool interactive)
 Create the Message Window.
 
void msgwin_add_text (struct MuttWindow *win, const char *text, const struct AttrColor *ac_color)
 Add text to the Message Window.
 
void msgwin_add_text_n (struct MuttWindow *win, const char *text, int bytes, const struct AttrColor *ac_color)
 Add some text to the Message Window.
 
const char * msgwin_get_text (struct MuttWindow *win)
 Get the text from the Message Window.
 
struct MuttWindowmsgwin_get_window (void)
 Get the Message Window pointer.
 
void msgwin_set_rows (struct MuttWindow *win, short rows)
 Resize the Message Window.
 
void msgwin_set_text (struct MuttWindow *win, const char *text, enum ColorId color)
 Set the text for the Message Window.
 

Detailed Description

Message Window.

Authors
  • Richard Russon

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

Function Documentation

◆ msgwin_clear_text()

void msgwin_clear_text ( struct MuttWindow win)

Clear the text in the Message Window.

Parameters
winMessage Window

Definition at line 519 of file msgwin.c.

520{
522}
@ MT_COLOR_NORMAL
Plain text.
Definition: color.h:59
void msgwin_set_text(struct MuttWindow *win, const char *text, enum ColorId color)
Set the text for the Message Window.
Definition: msgwin.c:484
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ msgwin_new()

struct MuttWindow * msgwin_new ( bool  interactive)

Create the Message Window.

Return values
ptrNew Window

Definition at line 371 of file msgwin.c.

372{
375
376 struct MsgWinWindowData *wdata = msgwin_wdata_new();
377
378 win->wdata = wdata;
380 win->recalc = msgwin_recalc;
381 win->repaint = msgwin_repaint;
382
383 if (interactive)
385
386 // Copy the container's dimensions
388
390
391 return win;
392}
static int msgwin_window_observer(struct NotifyCallback *nc)
Notification that a Window has changed - Implements observer_t -.
Definition: msgwin.c:327
static int msgwin_recalc(struct MuttWindow *win)
Recalculate the display of the Message Window - Implements MuttWindow::recalc() -.
Definition: msgwin.c:161
static bool msgwin_recursor(struct MuttWindow *win)
Recursor the Message Window - Implements MuttWindow::recursor() -.
Definition: msgwin.c:283
static int msgwin_repaint(struct MuttWindow *win)
Redraw the Message Window - Implements MuttWindow::repaint() -.
Definition: msgwin.c:251
void msgwin_wdata_free(struct MuttWindow *win, void **ptr)
Free the private data - Implements MuttWindow::wdata_free() -.
Definition: msgwin_wdata.c:37
struct MuttWindow * MessageContainer
Window acting as a stack for the message windows.
Definition: msgcont.c:40
struct MsgWinWindowData * msgwin_wdata_new(void)
Create new private data for the Message Window.
Definition: msgwin_wdata.c:60
bool notify_observer_add(struct Notify *notify, enum NotifyType type, observer_t callback, void *global_data)
Add an observer to an object.
Definition: notify.c:191
struct MuttWindow * mutt_window_new(enum WindowType type, enum MuttWindowOrientation orient, enum MuttWindowSize size, int cols, int rows)
Create a new Window.
Definition: mutt_window.c:182
@ WT_MESSAGE
Window for messages/errors.
Definition: mutt_window.h:99
@ MUTT_WIN_ORIENT_VERTICAL
Window uses all available vertical space.
Definition: mutt_window.h:38
#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
@ NT_WINDOW
MuttWindow has changed, NotifyWindow, EventWindow.
Definition: notify_type.h:57
Message Window private Window data.
Definition: msgwin_wdata.h:66
int(* repaint)(struct MuttWindow *win)
Definition: mutt_window.h:187
struct WindowState state
Current state of the Window.
Definition: mutt_window.h:127
void * wdata
Private data.
Definition: mutt_window.h:145
struct Notify * notify
Notifications: NotifyWindow, EventWindow.
Definition: mutt_window.h:138
int(* recalc)(struct MuttWindow *win)
Definition: mutt_window.h:173
void(* wdata_free)(struct MuttWindow *win, void **ptr)
Definition: mutt_window.h:159
bool(* recursor)(struct MuttWindow *win)
Definition: mutt_window.h:205
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ msgwin_add_text()

void msgwin_add_text ( struct MuttWindow win,
const char *  text,
const struct AttrColor ac_color 
)

Add text to the Message Window.

Parameters
winMessage Window
textText to add
ac_colorColour for text

Definition at line 419 of file msgwin.c.

420{
421 if (!win)
422 win = msgcont_get_msgwin();
423 if (!win)
424 return;
425
426 struct MsgWinWindowData *wdata = win->wdata;
427
428 if (text)
429 {
430 buf_addstr(wdata->text, text);
431 measure(&wdata->chars, text, ac_color);
432 mutt_debug(LL_DEBUG5, "MW ADD: %zu, %s\n", buf_len(wdata->text),
433 buf_string(wdata->text));
434 }
435 else
436 {
437 int rows = msgwin_calc_rows(wdata, win->state.cols, buf_string(wdata->text));
438 msgwin_set_rows(win, rows);
439 win->actions |= WA_RECALC;
440 }
441}
size_t buf_len(const struct Buffer *buf)
Calculate the length of a Buffer.
Definition: buffer.c:490
size_t buf_addstr(struct Buffer *buf, const char *s)
Add a string to a Buffer.
Definition: buffer.c:225
static const char * buf_string(const struct Buffer *buf)
Convert a buffer to a const char * "string".
Definition: buffer.h:96
#define mutt_debug(LEVEL,...)
Definition: logging2.h:89
@ LL_DEBUG5
Log at debug level 5.
Definition: logging2.h:47
struct MuttWindow * msgcont_get_msgwin(void)
Get the Message Window.
Definition: msgcont.c:117
int msgwin_calc_rows(struct MsgWinWindowData *wdata, int cols, const char *str)
How many rows will a string need?
Definition: msgwin.c:178
void measure(struct MwCharArray *chars, const char *str, const struct AttrColor *ac_color)
Measure a string in bytes and cells.
Definition: msgwin.c:106
void msgwin_set_rows(struct MuttWindow *win, short rows)
Resize the Message Window.
Definition: msgwin.c:303
#define WA_RECALC
Recalculate the contents of the Window.
Definition: mutt_window.h:110
struct Buffer * text
Cached display string.
Definition: msgwin_wdata.h:67
struct MwCharArray chars
Text: Breakdown of bytes and widths.
Definition: msgwin_wdata.h:68
struct MwChunkArray rows[MSGWIN_MAX_ROWS]
String byte counts for each row.
Definition: msgwin_wdata.h:69
WindowActionFlags actions
Actions to be performed, e.g. WA_RECALC.
Definition: mutt_window.h:132
short cols
Number of columns, can be MUTT_WIN_SIZE_UNLIMITED.
Definition: mutt_window.h:60
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ msgwin_add_text_n()

void msgwin_add_text_n ( struct MuttWindow win,
const char *  text,
int  bytes,
const struct AttrColor ac_color 
)

Add some text to the Message Window.

Parameters
winMessage Window
textText to add
bytesNumber of bytes of text to add
ac_colorColour for text

Definition at line 450 of file msgwin.c.

452{
453 if (!win)
454 win = msgcont_get_msgwin();
455 if (!win)
456 return;
457
458 struct MsgWinWindowData *wdata = win->wdata;
459
460 if (text)
461 {
462 const char *dptr = wdata->text->dptr;
463 buf_addstr_n(wdata->text, text, bytes);
464 measure(&wdata->chars, dptr, ac_color);
465 mutt_debug(LL_DEBUG5, "MW ADD: %zu, %s\n", buf_len(wdata->text),
466 buf_string(wdata->text));
467 }
468 else
469 {
470 int rows = msgwin_calc_rows(wdata, win->state.cols, buf_string(wdata->text));
471 msgwin_set_rows(win, rows);
472 win->actions |= WA_RECALC;
473 }
474}
size_t buf_addstr_n(struct Buffer *buf, const char *s, size_t len)
Add a string to a Buffer, expanding it if necessary.
Definition: buffer.c:95
char * dptr
Current read/write position.
Definition: buffer.h:38
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ msgwin_get_text()

const char * msgwin_get_text ( struct MuttWindow win)

Get the text from the Message Window.

Parameters
winMessage Window
Return values
ptrWindow text
Note
Do not free the returned string

Definition at line 401 of file msgwin.c.

402{
403 if (!win)
404 win = msgcont_get_msgwin();
405 if (!win)
406 return NULL;
407
408 struct MsgWinWindowData *wdata = win->wdata;
409
410 return buf_string(wdata->text);
411}
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ msgwin_get_window()

struct MuttWindow * msgwin_get_window ( void  )

Get the Message Window pointer.

Return values
ptrMessage Window

Allow some users direct access to the Message Window.

Definition at line 530 of file msgwin.c.

531{
532 return msgcont_get_msgwin();
533}
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ msgwin_set_rows()

void msgwin_set_rows ( struct MuttWindow win,
short  rows 
)

Resize the Message Window.

Parameters
winMessage Window
rowsNumber of rows required

Resize the other Windows to allow a multi-line message to be displayed.

Note
rows will be clamped between 1 and 3 (MSGWIN_MAX_ROWS) inclusive

Definition at line 303 of file msgwin.c.

304{
305 if (!win)
306 win = msgcont_get_msgwin();
307 if (!win)
308 return;
309
310 rows = CLAMP(rows, 1, MSGWIN_MAX_ROWS);
311
312 if (rows != win->state.rows)
313 {
314 win->req_rows = rows;
315 mutt_window_reflow(NULL);
316 }
317}
#define CLAMP(val, lo, hi)
Definition: memory.h:33
#define MSGWIN_MAX_ROWS
Definition: msgwin_wdata.h:30
void mutt_window_reflow(struct MuttWindow *win)
Resize a Window and its children.
Definition: mutt_window.c:344
short req_rows
Number of rows required.
Definition: mutt_window.h:125
short rows
Number of rows, can be MUTT_WIN_SIZE_UNLIMITED.
Definition: mutt_window.h:61
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ msgwin_set_text()

void msgwin_set_text ( struct MuttWindow win,
const char *  text,
enum ColorId  color 
)

Set the text for the Message Window.

Parameters
winMessage Window
textText to set
colorColour for text
Note
The text string will be copied

Definition at line 484 of file msgwin.c.

485{
486 if (!win)
487 win = msgcont_get_msgwin();
488 if (!win)
489 return;
490
491 struct MsgWinWindowData *wdata = win->wdata;
492
493 if (mutt_str_equal(buf_string(wdata->text), text))
494 return;
495
496 buf_strcpy(wdata->text, text);
497 ARRAY_FREE(&wdata->chars);
498 if (wdata->text)
499 {
500 const struct AttrColor *ac_normal = simple_color_get(MT_COLOR_NORMAL);
501 const struct AttrColor *ac_color = simple_color_get(color);
502 const struct AttrColor *ac_merge = merged_color_overlay(ac_normal, ac_color);
503
504 measure(&wdata->chars, buf_string(wdata->text), ac_merge);
505 }
506
507 mutt_debug(LL_DEBUG5, "MW SET: %zu, %s\n", buf_len(wdata->text),
508 buf_string(wdata->text));
509
510 int rows = msgwin_calc_rows(wdata, win->state.cols, buf_string(wdata->text));
511 msgwin_set_rows(win, rows);
512 win->actions |= WA_RECALC;
513}
#define ARRAY_FREE(head)
Release all memory.
Definition: array.h:204
size_t buf_strcpy(struct Buffer *buf, const char *s)
Copy a string into a Buffer.
Definition: buffer.c:394
struct AttrColor * simple_color_get(enum ColorId cid)
Get the colour of an object by its ID.
Definition: simple.c:88
const struct AttrColor * merged_color_overlay(const struct AttrColor *base, const struct AttrColor *over)
Combine two colours.
Definition: merged.c:107
bool mutt_str_equal(const char *a, const char *b)
Compare two strings.
Definition: string.c:709
A curses colour and its attributes.
Definition: attr.h:66
+ Here is the call graph for this function:
+ Here is the caller graph for this function: