msgwin.c File Reference

Message Window. More...

#include "config.h"
#include <stdbool.h>
#include <string.h>
#include <wchar.h>
#include "mutt/lib.h"
#include "core/lib.h"
#include "msgwin.h"
#include "color/lib.h"
#include "module_data.h"
#include "msgcont.h"
#include "msgwin_wdata.h"
#include "mutt_curses.h"
#include "mutt_window.h"

Include dependency graph for msgwin.c:

Go to the source code of this file.

Functions
void	measure (struct MwCharArray *chars, const char *str, const struct AttrColor *ac_color)
	Measure a string in bytes and cells.
static int	msgwin_recalc (struct MuttWindow *win)
	Recalculate the display of the Message Window - Implements MuttWindow::recalc() -.
int	msgwin_calc_rows (struct MsgWinWindowData *wdata, int cols, const char *str)
	How many rows will a string need?
static int	msgwin_repaint (struct MuttWindow *win)
	Redraw the Message Window - Implements MuttWindow::repaint() -.
static bool	msgwin_recursor (struct MuttWindow *win)
	Recursor the Message Window - Implements MuttWindow::recursor() -.
void	msgwin_set_rows (struct MuttWindow *win, short rows)
	Resize the Message Window.
static int	msgwin_window_observer (struct NotifyCallback *nc)
	Notification that a Window has changed - Implements observer_t -.
struct MuttWindow *	msgwin_new (bool interactive)
	Create the Message Window.
const char *	msgwin_get_text (struct MuttWindow *win)
	Get the text from 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.
void	msgwin_set_text (struct MuttWindow *win, const char *text, enum ColorId color)
	Set the text for the Message Window.
void	msgwin_clear_text (struct MuttWindow *win)
	Clear the text in the Message Window.
struct MuttWindow *	msgwin_get_window (void)
	Get the Message Window pointer.
bool	msgwin_has_text (void)
	Does the Message Window currently hold any text?

Detailed Description

Message Window.

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

Function Documentation

measure()

void measure	(	struct MwCharArray *	chars,
		const char *	str,
		const struct AttrColor *	ac_color )

Measure a string in bytes and cells.

Parameters

chars	Results
str	String to measure
ac_color	Colour to associate

Calculate the size of each character in a string in bytes and screen cells.

Definition at line 107 of file msgwin.c.

{
  if (!str || !*str)
    return;
 
  mbstate_t mbstate = { 0 };
  struct MwChar mwc = { 0 };
 
  size_t str_len = mutt_str_len(str);
 
  while (*str && (str_len > 0))
  {
    wchar_t wc = L'\0';
    size_t consumed = mbrtowc(&wc, str, str_len, &mbstate);
    if (consumed == 0)
      break;
 
    if (consumed == ICONV_ILLEGAL_SEQ)
    {
      memset(&mbstate, 0, sizeof(mbstate));
      wc = ReplacementChar;
      consumed = 1;
    }
    else if (consumed == ICONV_BUF_TOO_SMALL)
    {
      wc = ReplacementChar;
      consumed = str_len;
    }
 
    int wchar_width = wcwidth(wc);
    if (wchar_width < 0)
      wchar_width = 1;
 
    if (wc == 0xfe0f) // Emoji variation
    {
      int size = ARRAY_SIZE(chars);
      if (size > 0)
      {
        struct MwChar *es_prev = ARRAY_GET(chars, size - 1);
        if (es_prev->width == 1)
          es_prev->width = 2;
      }
    }
 
    mwc = (struct MwChar) { wchar_width, consumed, ac_color };
    ARRAY_ADD(chars, mwc);
 
    str += consumed;
    str_len -= consumed;
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

msgwin_calc_rows()

int msgwin_calc_rows	(	struct MsgWinWindowData *	wdata,
		int	cols,
		const char *	str )

How many rows will a string need?

Parameters

wdata	Window data
cols	Columns to wrap at
str	Text to measure

Return values

num	Number of rows required
0	Error

Divide the width of a string by the width of the Message Window.

< Screen width used

< Offset into str

< Current row

Definition at line 179 of file msgwin.c.

{
  if (!wdata)
    return 0;
 
  for (int i = 0; i < MSGWIN_MAX_ROWS; i++)
  {
    ARRAY_FREE(&wdata->rows[i]);
  }
 
  if (!str || !*str)
    return 0;
 
  int width = 0;  
  int offset = 0; 
  int row = 0;    
  bool new_row = false;
 
  struct MwChunk *chunk = NULL;
  struct MwChar *mwc = NULL;
  ARRAY_FOREACH(mwc, &wdata->chars)
  {
    const bool nl = (mwc->bytes == 1) && (str[offset] == '\n');
    if (nl)
    {
      new_row = true;
      offset += mwc->bytes;
      continue;
    }
 
    if (((width + mwc->width) > cols) || new_row)
    {
      // ROW IS FULL
      new_row = false;
 
      row++;
      if (row >= MSGWIN_MAX_ROWS)
      {
        // NO MORE ROOM
        break;
      }
 
      // Start a new row
      struct MwChunk tmp = { offset, mwc->bytes, mwc->width, mwc->ac_color };
 
      mutt_debug(LL_DEBUG5, "row = %d\n", row);
      ARRAY_ADD(&wdata->rows[row], tmp);
      chunk = ARRAY_LAST(&wdata->rows[row]);
 
      width = 0;
    }
    else if (!chunk || (mwc->ac_color != chunk->ac_color))
    {
      // CHANGE OF COLOUR
      struct MwChunk tmp = { offset, mwc->bytes, mwc->width, mwc->ac_color };
      ARRAY_ADD(&wdata->rows[row], tmp);
      chunk = ARRAY_LAST(&wdata->rows[row]);
    }
    else
    {
      // MORE OF THE SAME
      chunk->bytes += mwc->bytes;
      chunk->width += mwc->width;
    }
 
    offset += mwc->bytes;
    width += mwc->width;
  }
 
  mutt_debug(LL_DEBUG5, "msgwin_calc_rows() => %d\n", row + 1);
  return row + 1;
}

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

win	Message Window
rows	Number 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 310 of file msgwin.c.

{
  if (!win)
    win = msgcont_get_msgwin();
  if (!win)
    return;
 
  rows = CLAMP(rows, 1, MSGWIN_MAX_ROWS);
 
  if (rows != win->req_rows)
  {
    win->req_rows = rows;
 
    msgcont_recalc_rows();
 
    mutt_window_reflow(NULL);
  }
}

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

ptr	New Window

Definition at line 381 of file msgwin.c.

{
  struct MuttWindow *win = mutt_window_new(WT_MESSAGE, MUTT_WIN_ORIENT_VERTICAL, MUTT_WIN_SIZE_FIXED,
                                           MUTT_WIN_SIZE_UNLIMITED, 1);
 
  struct MsgWinWindowData *wdata = msgwin_wdata_new();
 
  win->wdata = wdata;
  win->wdata_free = msgwin_wdata_free;
  win->recalc = msgwin_recalc;
  win->repaint = msgwin_repaint;
 
  if (interactive)
    win->recursor = msgwin_recursor;
 
  // Copy the container's dimensions
  struct GuiModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_GUI);
  if (mod_data && mod_data->message_container)
    win->state = mod_data->message_container->state;
 
  notify_observer_add(win->notify, NT_WINDOW, msgwin_window_observer, win);
 
  return win;
}

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

win	Message Window

Return values

ptr	Window text

Note

Do not free the returned string

Definition at line 413 of file msgwin.c.

{
  if (!win)
    win = msgcont_get_msgwin();
  if (!win)
    return NULL;
 
  struct MsgWinWindowData *wdata = win->wdata;
 
  return buf_string(wdata->text);
}

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

win	Message Window
text	Text to add
ac_color	Colour for text

Definition at line 431 of file msgwin.c.

{
  if (!win)
    win = msgcont_get_msgwin();
  if (!win)
    return;
 
  struct MsgWinWindowData *wdata = win->wdata;
 
  if (text)
  {
    buf_addstr(wdata->text, text);
    measure(&wdata->chars, text, ac_color);
    mutt_debug(LL_DEBUG5, "MW ADD: %zu, %s\n", buf_len(wdata->text),
               buf_string(wdata->text));
  }
  else
  {
    int rows = msgwin_calc_rows(wdata, win->state.cols, buf_string(wdata->text));
    msgwin_set_rows(win, rows);
    win->actions |= WA_RECALC;
  }
}

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

win	Message Window
text	Text to add
bytes	Number of bytes of text to add
ac_color	Colour for text

Definition at line 462 of file msgwin.c.

{
  if (!win)
    win = msgcont_get_msgwin();
  if (!win)
    return;
 
  struct MsgWinWindowData *wdata = win->wdata;
 
  if (text)
  {
    // Track the length of the text so far
    const size_t len = buf_len(wdata->text);
    buf_addstr_n(wdata->text, text, bytes);
    // and only measure the newly added text
    measure(&wdata->chars, wdata->text->data + len, ac_color);
    mutt_debug(LL_DEBUG5, "MW ADD: %zu, %s\n", buf_len(wdata->text),
               buf_string(wdata->text));
  }
  else
  {
    int rows = msgwin_calc_rows(wdata, win->state.cols, buf_string(wdata->text));
    msgwin_set_rows(win, rows);
    win->actions |= WA_RECALC;
  }
}

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

win	Message Window
text	Text to set
color	Colour for text

Note

The text string will be copied

If the Message Window is currently hidden (because another Window has been pushed on top of it in the Message Container) it will make itself visible and trigger a reflow so the message is shown to the user.

Definition at line 502 of file msgwin.c.

{
  if (!win)
    win = msgcont_get_msgwin();
  if (!win)
    return;
 
  const bool hidden = !win->state.visible;
 
  struct MsgWinWindowData *wdata = win->wdata;
 
  // If the text is unchanged: nothing to do, except reveal the window if it
  // was hidden so the user actually sees it.
  if (mutt_str_equal(buf_string(wdata->text), text) && !hidden)
    return;
 
  buf_strcpy(wdata->text, text);
  ARRAY_FREE(&wdata->chars);
  if (wdata->text)
  {
    const struct AttrColor *ac_normal = simple_color_get(MT_COLOR_NORMAL);
    const struct AttrColor *ac_color = simple_color_get(color);
    const struct AttrColor *ac_merge = merged_color_overlay(ac_normal, ac_color);
 
    measure(&wdata->chars, buf_string(wdata->text), ac_merge);
  }
 
  mutt_debug(LL_DEBUG5, "MW SET: %zu, %s\n", buf_len(wdata->text),
             buf_string(wdata->text));
 
  // If the window was hidden, reveal it and reflow so the message is seen.
  if (!win->state.visible)
  {
    window_set_visible(win, true);
    int rows = msgwin_calc_rows(wdata, win->state.cols, buf_string(wdata->text));
    win->req_rows = CLAMP(rows, 1, MSGWIN_MAX_ROWS);
    msgcont_recalc_rows();
    win->actions |= WA_RECALC;
    window_redraw(NULL);
    return;
  }
 
  int rows = msgwin_calc_rows(wdata, win->state.cols, buf_string(wdata->text));
  msgwin_set_rows(win, rows);
  win->actions |= WA_RECALC;
}

Here is the call graph for this function:

Here is the caller graph for this function:

msgwin_clear_text()

void msgwin_clear_text

(

struct MuttWindow *

win

)

Clear the text in the Message Window.

Parameters

win	Message Window

Clear the displayed text. If the Message Window is not the only Window in the Message Container, it is also hidden and the Windows are reflowed.

Definition at line 556 of file msgwin.c.

{
  if (!win)
    win = msgcont_get_msgwin();
  if (!win)
    return;
 
  struct MsgWinWindowData *wdata = win->wdata;
 
  // Force-clear even if the window was hidden (msgwin_set_text would skip it).
  if (!buf_is_empty(wdata->text))
  {
    buf_reset(wdata->text);
    ARRAY_FREE(&wdata->chars);
    for (int i = 0; i < MSGWIN_MAX_ROWS; i++)
    {
      ARRAY_FREE(&wdata->rows[i]);
    }
 
    if (win->state.visible)
    {
      int rows = msgwin_calc_rows(wdata, win->state.cols, buf_string(wdata->text));
      msgwin_set_rows(win, rows);
      win->actions |= WA_RECALC;
    }
  }
 
  // If the Message Window isn't alone in the stack, hide it again so the
  // Window beneath us regains the space.
  if (win->state.visible && (msgcont_num_windows() > 1))
  {
    window_set_visible(win, false);
    msgcont_recalc_rows();
    window_redraw(NULL);
  }
}

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

ptr	Message Window

Allow some users direct access to the Message Window.

Definition at line 599 of file msgwin.c.

{
  return msgcont_get_msgwin();
}

Here is the call graph for this function:

Here is the caller graph for this function:

msgwin_has_text()

bool msgwin_has_text

(

void

)

Does the Message Window currently hold any text?

Return values

true	The Message Window currently displays a message

Used by msgcont_push_window() to decide whether the Message Window should remain visible when another Window is pushed on top of it.

Definition at line 611 of file msgwin.c.

{
  struct MuttWindow *win = msgcont_get_msgwin();
  if (!win || !win->wdata)
    return false;
 
  const struct MsgWinWindowData *wdata = win->wdata;
  return !buf_is_empty(wdata->text);
}

Here is the call graph for this function:

Here is the caller graph for this function: