draw.c File Reference

Paint the Menu. More...

#include "config.h"
#include <stdbool.h>
#include <string.h>
#include <wchar.h>
#include "mutt/lib.h"
#include "config/lib.h"
#include "email/lib.h"
#include "core/lib.h"
#include "gui/lib.h"
#include "lib.h"
#include "color/lib.h"
#include "index/lib.h"
#include "pattern/lib.h"

Include dependency graph for draw.c:

Go to the source code of this file.

Functions
static const struct AttrColor *	get_color (int index, unsigned char *s)
	Choose a colour for a line of the index.
static void	print_enriched_string (struct MuttWindow *win, int index, const struct AttrColor *ac_def, struct AttrColor *ac_ind, struct Buffer *buf, struct ConfigSubset *sub)
	Display a string with embedded colours and graphics.
static void	menu_pad_string (struct Menu *menu, struct Buffer *buf)
	Pad a string with spaces for display in the Menu.
void	menu_redraw_full (struct Menu *menu)
	Force the redraw of the Menu.
void	menu_redraw_index (struct Menu *menu)
	Force the redraw of the index.
void	menu_redraw_motion (struct Menu *menu)
	Force the redraw of the list part of the menu.
void	menu_redraw_current (struct Menu *menu)
	Redraw the current menu.
int	menu_redraw (struct Menu *menu)
	Redraw the parts of the screen that have been flagged to be redrawn.

Detailed Description

Paint the Menu.

Authors

• Richard Russon
• Pietro Cerutti

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

Function Documentation

get_color()

const struct AttrColor * get_color ( int index, unsigned char * s )

static

Choose a colour for a line of the index.

Parameters

index	Index number
s	String of embedded colour codes

Return values

num	Colour pair in an integer

Text is coloured by inserting special characters into the string, e.g. MT_COLOR_INDEX_AUTHOR

Definition at line 53 of file draw.c.

{
  const int type = *s;
  struct RegexColorList *rcl = regex_colors_get_list(type);
  struct Mailbox *m_cur = get_current_mailbox();
  struct Email *e = mutt_get_virt_email(m_cur, index);
  if (!rcl || !e)
  {
    return simple_color_get(type);
  }
 
  struct RegexColor *np = NULL;
  const struct AttrColor *ac_merge = NULL;
 
  struct EmailModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_EMAIL);
  ASSERT(mod_data);
 
  struct Buffer *buf = buf_pool_get();
  buf_strcpy(buf, (const char *) (s + 1));
  char *marker = (char *) buf_find_char(buf, MUTT_SPECIAL_INDEX);
  if (marker)
    *marker = '\0';
 
  // %Gx %{tags-transformed} - Transformed message tags
  if (type == MT_COLOR_INDEX_TAG)
  {
    STAILQ_FOREACH(np, rcl, entries)
    {
      const char *transform = mutt_hash_find(mod_data->tag_transforms, np->pattern);
      if (transform && strstr(buf_string(buf), transform))
 
      {
        ac_merge = merged_color_overlay(ac_merge, &np->attr_color);
      }
    }
    goto done;
  }
 
  STAILQ_FOREACH(np, rcl, entries)
  {
    if (mutt_pattern_exec(SLIST_FIRST(np->color_pattern),
                          MUTT_MATCH_FULL_ADDRESS, m_cur, e, NULL))
    {
      ac_merge = merged_color_overlay(ac_merge, &np->attr_color);
    }
  }
 
done:
  buf_pool_release(&buf);
  return ac_merge;
}

Here is the call graph for this function:

Here is the caller graph for this function:

print_enriched_string()

void print_enriched_string ( struct MuttWindow * win, int index, const struct AttrColor * ac_def, struct AttrColor * ac_ind, struct Buffer * buf, struct ConfigSubset * sub )

static

Display a string with embedded colours and graphics.

Parameters

win	Window
index	Index number
ac_def	Default colour for the line
ac_ind	Indicator colour for the line
buf	String of embedded colour codes
sub	Config items

Definition at line 114 of file draw.c.

{
  wchar_t wc = 0;
  size_t k;
  size_t n = mutt_str_len(buf_string(buf));
  unsigned char *s = (unsigned char *) buf->data;
  mbstate_t mbstate = { 0 };
 
  const bool c_ascii_chars = cs_subset_bool(sub, "ascii_chars");
  while (*s)
  {
    if (*s < MUTT_TREE_MAX)
    {
      /* Combining tree fg color and another bg color requires having
       * use_default_colors, because the other bg color may be undefined. */
      mutt_curses_set_color(ac_ind);
 
      while (*s && (*s < MUTT_TREE_MAX))
      {
        switch (*s)
        {
          case MUTT_TREE_LLCORNER:
            if (c_ascii_chars)
              mutt_window_addch(win, '`');
#ifdef WACS_LLCORNER
            else
              add_wch(WACS_LLCORNER);
#else
            else if (CharsetIsUtf8)
              mutt_window_addstr(win, "\342\224\224"); /* WACS_LLCORNER */
            else
              mutt_window_addch(win, ACS_LLCORNER);
#endif
            break;
          case MUTT_TREE_ULCORNER:
            if (c_ascii_chars)
              mutt_window_addch(win, ',');
#ifdef WACS_ULCORNER
            else
              add_wch(WACS_ULCORNER);
#else
            else if (CharsetIsUtf8)
              mutt_window_addstr(win, "\342\224\214"); /* WACS_ULCORNER */
            else
              mutt_window_addch(win, ACS_ULCORNER);
#endif
            break;
          case MUTT_TREE_LTEE:
            if (c_ascii_chars)
              mutt_window_addch(win, '|');
#ifdef WACS_LTEE
            else
              add_wch(WACS_LTEE);
#else
            else if (CharsetIsUtf8)
              mutt_window_addstr(win, "\342\224\234"); /* WACS_LTEE */
            else
              mutt_window_addch(win, ACS_LTEE);
#endif
            break;
          case MUTT_TREE_HLINE:
            if (c_ascii_chars)
              mutt_window_addch(win, '-');
#ifdef WACS_HLINE
            else
              add_wch(WACS_HLINE);
#else
            else if (CharsetIsUtf8)
              mutt_window_addstr(win, "\342\224\200"); /* WACS_HLINE */
            else
              mutt_window_addch(win, ACS_HLINE);
#endif
            break;
          case MUTT_TREE_VLINE:
            if (c_ascii_chars)
              mutt_window_addch(win, '|');
#ifdef WACS_VLINE
            else
              add_wch(WACS_VLINE);
#else
            else if (CharsetIsUtf8)
              mutt_window_addstr(win, "\342\224\202"); /* WACS_VLINE */
            else
              mutt_window_addch(win, ACS_VLINE);
#endif
            break;
          case MUTT_TREE_TTEE:
            if (c_ascii_chars)
              mutt_window_addch(win, '-');
#ifdef WACS_TTEE
            else
              add_wch(WACS_TTEE);
#else
            else if (CharsetIsUtf8)
              mutt_window_addstr(win, "\342\224\254"); /* WACS_TTEE */
            else
              mutt_window_addch(win, ACS_TTEE);
#endif
            break;
          case MUTT_TREE_BTEE:
            if (c_ascii_chars)
              mutt_window_addch(win, '-');
#ifdef WACS_BTEE
            else
              add_wch(WACS_BTEE);
#else
            else if (CharsetIsUtf8)
              mutt_window_addstr(win, "\342\224\264"); /* WACS_BTEE */
            else
              mutt_window_addch(win, ACS_BTEE);
#endif
            break;
          case MUTT_TREE_SPACE:
            mutt_window_addch(win, ' ');
            break;
          case MUTT_TREE_RARROW:
            mutt_window_addch(win, '>');
            break;
          case MUTT_TREE_STAR:
            mutt_window_addch(win, '*'); /* fake thread indicator */
            break;
          case MUTT_TREE_HIDDEN:
            mutt_window_addch(win, '&');
            break;
          case MUTT_TREE_EQUALS:
            mutt_window_addch(win, '=');
            break;
          case MUTT_TREE_MISSING:
            mutt_window_addch(win, '?');
            break;
          default:
            break;
        }
        s++;
        n--;
      }
      const struct AttrColor *ac_merge = merged_color_overlay(ac_def, ac_ind);
      mutt_curses_set_color(ac_merge);
    }
    else if ((*s == MUTT_SPECIAL_INDEX) && (n >= 2))
    {
      s++;
      if (*s == MT_COLOR_INDEX)
      {
        const struct AttrColor *ac_merge = merged_color_overlay(ac_def, ac_ind);
        mutt_curses_set_color(ac_merge);
      }
      else
      {
        const struct AttrColor *color = get_color(index, s);
        const struct AttrColor *ac_merge = merged_color_overlay(ac_def, color);
        ac_merge = merged_color_overlay(ac_merge, ac_ind);
 
        mutt_curses_set_color(ac_merge);
      }
      s++;
      n -= 2;
    }
    else if ((k = mbrtowc(&wc, (char *) s, n, &mbstate)) > 0)
    {
      mutt_window_addnstr(win, (char *) s, k);
      s += k;
      n -= k;
    }
    else
    {
      break;
    }
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

menu_pad_string()

void menu_pad_string ( struct Menu * menu, struct Buffer * buf )

static

Pad a string with spaces for display in the Menu.

Parameters

menu	Current Menu
buf	Buffer containing the string

Note

The string is padded in-place.

Definition at line 294 of file draw.c.

{
  int max_cols = menu->win->state.cols;
  const bool c_arrow_cursor = cs_subset_bool(menu->sub, "arrow_cursor");
  if (c_arrow_cursor)
  {
    const char *const c_arrow_string = cs_subset_string(menu->sub, "arrow_string");
    if (max_cols > 0)
      max_cols -= (mutt_strwidth(c_arrow_string) + 1);
  }
 
  int buf_cols = mutt_strwidth(buf_string(buf));
  for (; buf_cols < max_cols; buf_cols++)
  {
    buf_addch(buf, ' ');
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

menu_redraw_full()

void menu_redraw_full

(

struct Menu *

menu

)

Force the redraw of the Menu.

Parameters

menu	Current Menu

Definition at line 316 of file draw.c.

{
  mutt_curses_set_color_by_id(MT_COLOR_NORMAL);
  mutt_window_clear(menu->win);
 
  menu->page_len = menu->win->state.rows;
 
  menu->redraw = MENU_REDRAW_INDEX;
}

Here is the call graph for this function:

Here is the caller graph for this function:

menu_redraw_index()

void menu_redraw_index

(

struct Menu *

menu

)

Force the redraw of the index.

Parameters

menu	Current Menu

Definition at line 330 of file draw.c.

{
  struct Buffer *buf = buf_pool_get();
  const struct AttrColor *ac = NULL;
 
  const bool c_arrow_cursor = cs_subset_bool(menu->sub, "arrow_cursor");
  const char *const c_arrow_string = cs_subset_string(menu->sub, "arrow_string");
  const int arrow_width = mutt_strwidth(c_arrow_string);
  struct AttrColor *ac_ind = menu->show_indicator ? simple_color_get(MT_COLOR_INDICATOR) : NULL;
  for (int i = menu->top; i < (menu->top + menu->page_len); i++)
  {
    if (i < menu->max)
    {
      ac = menu->color(menu, i);
 
      buf_reset(buf);
      menu->make_entry(menu, i, menu->win->state.cols, buf);
      menu_pad_string(menu, buf);
 
      mutt_curses_set_color(ac);
      mutt_window_move(menu->win, i - menu->top, 0);
 
      if (i == menu->current)
        mutt_curses_set_color(ac_ind);
 
      if (c_arrow_cursor)
      {
        if (i == menu->current)
        {
          mutt_window_addstr(menu->win, c_arrow_string);
          mutt_curses_set_color(ac);
          mutt_window_addch(menu->win, ' ');
        }
        else
        {
          /* Print space chars to match the screen width of `$arrow_string` */
          mutt_window_printf(menu->win, "%*s", arrow_width + 1, "");
        }
      }
 
      if ((i == menu->current) && !c_arrow_cursor)
      {
        print_enriched_string(menu->win, i, ac, ac_ind, buf, menu->sub);
      }
      else
      {
        print_enriched_string(menu->win, i, ac, NULL, buf, menu->sub);
      }
    }
    else
    {
      mutt_curses_set_color_by_id(MT_COLOR_NORMAL);
      mutt_window_clearline(menu->win, i - menu->top);
    }
  }
  mutt_curses_set_color_by_id(MT_COLOR_NORMAL);
  menu->redraw = MENU_REDRAW_NONE;
  buf_pool_release(&buf);
}

Here is the call graph for this function:

Here is the caller graph for this function:

menu_redraw_motion()

void menu_redraw_motion

(

struct Menu *

menu

)

Force the redraw of the list part of the menu.

Parameters

menu	Current Menu

Definition at line 394 of file draw.c.

{
  struct Buffer *buf = buf_pool_get();
 
  /* Note: menu->color() for the index can end up retrieving a message
   * over imap (if matching against ~h for instance).  This can
   * generate status messages.  So we want to call it *before* we
   * position the cursor for drawing. */
  const struct AttrColor *old_color = menu->color(menu, menu->old_current);
  mutt_window_move(menu->win, menu->old_current - menu->top, 0);
  mutt_curses_set_color(old_color);
 
  const bool c_arrow_cursor = cs_subset_bool(menu->sub, "arrow_cursor");
  struct AttrColor *ac_ind = menu->show_indicator ? simple_color_get(MT_COLOR_INDICATOR) : NULL;
  if (c_arrow_cursor)
  {
    const char *const c_arrow_string = cs_subset_string(menu->sub, "arrow_string");
    const int arrow_width = mutt_strwidth(c_arrow_string);
    /* clear the arrow */
    /* Print space chars to match the screen width of `$arrow_string` */
    mutt_window_printf(menu->win, "%*s", arrow_width + 1, "");
    mutt_curses_set_color_by_id(MT_COLOR_NORMAL);
 
    menu->make_entry(menu, menu->old_current, menu->win->state.cols, buf);
    menu_pad_string(menu, buf);
    mutt_window_move(menu->win, menu->old_current - menu->top, arrow_width + 1);
    print_enriched_string(menu->win, menu->old_current, old_color, NULL, buf, menu->sub);
 
    /* now draw it in the new location */
    mutt_curses_set_color(ac_ind);
    mutt_window_move(menu->win, menu->current - menu->top, 0);
    mutt_window_addstr(menu->win, c_arrow_string);
  }
  else
  {
    mutt_curses_set_color_by_id(MT_COLOR_NORMAL);
    /* erase the current indicator */
    menu->make_entry(menu, menu->old_current, menu->win->state.cols, buf);
    menu_pad_string(menu, buf);
    print_enriched_string(menu->win, menu->old_current, old_color, NULL, buf, menu->sub);
 
    /* now draw the new one to reflect the change */
    const struct AttrColor *cur_color = menu->color(menu, menu->current);
    cur_color = merged_color_overlay(cur_color, ac_ind);
    buf_reset(buf);
    menu->make_entry(menu, menu->current, menu->win->state.cols, buf);
    menu_pad_string(menu, buf);
    mutt_window_move(menu->win, menu->current - menu->top, 0);
    mutt_curses_set_color(cur_color);
    print_enriched_string(menu->win, menu->current, cur_color, ac_ind, buf, menu->sub);
  }
  mutt_curses_set_color_by_id(MT_COLOR_NORMAL);
  buf_pool_release(&buf);
}

Here is the call graph for this function:

Here is the caller graph for this function:

menu_redraw_current()

void menu_redraw_current

(

struct Menu *

menu

)

Redraw the current menu.

Parameters

menu	Current Menu

Definition at line 453 of file draw.c.

{
  struct Buffer *buf = buf_pool_get();
  const struct AttrColor *ac = menu->color(menu, menu->current);
 
  mutt_window_move(menu->win, menu->current - menu->top, 0);
  menu->make_entry(menu, menu->current, menu->win->state.cols, buf);
  menu_pad_string(menu, buf);
 
  struct AttrColor *ac_ind = menu->show_indicator ? simple_color_get(MT_COLOR_INDICATOR) : NULL;
  const bool c_arrow_cursor = cs_subset_bool(menu->sub, "arrow_cursor");
  if (c_arrow_cursor)
  {
    mutt_curses_set_color(ac_ind);
    const char *const c_arrow_string = cs_subset_string(menu->sub, "arrow_string");
    mutt_window_addstr(menu->win, c_arrow_string);
    mutt_curses_set_color(ac);
    mutt_window_addch(menu->win, ' ');
    menu_pad_string(menu, buf);
    print_enriched_string(menu->win, menu->current, ac, NULL, buf, menu->sub);
  }
  else
  {
    print_enriched_string(menu->win, menu->current, ac, ac_ind, buf, menu->sub);
  }
  mutt_curses_set_color_by_id(MT_COLOR_NORMAL);
  buf_pool_release(&buf);
}

Here is the call graph for this function:

Here is the caller graph for this function:

menu_redraw()

int menu_redraw

(

struct Menu *

menu

)

Redraw the parts of the screen that have been flagged to be redrawn.

Parameters

menu	Menu to redraw

Return values

OP_NULL	Menu was redrawn
OP_REDRAW	Full redraw required

Definition at line 488 of file draw.c.

{
  /* See if all or part of the screen needs to be updated.  */
  if (menu->redraw & MENU_REDRAW_FULL)
    menu_redraw_full(menu);
 
  if (menu->redraw & MENU_REDRAW_INDEX)
    menu_redraw_index(menu);
  else if (menu->redraw & MENU_REDRAW_MOTION)
    menu_redraw_motion(menu);
  else if (menu->redraw == MENU_REDRAW_CURRENT)
    menu_redraw_current(menu);
 
  return OP_NULL;
}

Here is the call graph for this function:

Here is the caller graph for this function: