window.c File Reference

Sidebar Window. More...

#include "config.h"
#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
#include <string.h>
#include "private.h"
#include "mutt/lib.h"
#include "config/lib.h"
#include "email/lib.h"
#include "core/lib.h"
#include "gui/lib.h"
#include "color/lib.h"
#include "index/lib.h"
#include "format_flags.h"
#include "muttlib.h"

Include dependency graph for window.c:

Go to the source code of this file.

Data Structures
struct	SidebarFormatData
	Data passed to sidebar_format_str() More...

Functions
static int	imap_is_prefix (const char *folder, const char *mbox)
	Check if folder matches the beginning of mbox. More...
static const char *	abbrev_folder (const char *mbox, const char *folder, enum MailboxType type)
	Abbreviate a Mailbox path using a folder. More...
static const char *	abbrev_url (const char *mbox, enum MailboxType type)
	Abbreviate a url-style Mailbox path. More...
static size_t	add_indent (char *buf, size_t buflen, const struct SbEntry *sbe)
	Generate the needed indentation. More...
static struct AttrColor *	calc_color (const struct Mailbox *m, bool current, bool highlight)
	Calculate the colour of a Sidebar row. More...
static int	calc_path_depth (const char *mbox, const char *delims, const char **last_part)
	Calculate the depth of a Mailbox path. More...
static const char *	sidebar_format_str (char *buf, size_t buflen, size_t col, int cols, char op, const char *src, const char *prec, const char *if_str, const char *else_str, intptr_t data, MuttFormatFlags flags)
	Format a string for the sidebar - Implements format_t -. More...
static void	make_sidebar_entry (char *buf, size_t buflen, int width, struct SbEntry *sbe, struct IndexSharedData *shared)
	Turn mailbox data into a sidebar string. More...
static void	update_entries_visibility (struct SidebarWindowData *wdata)
	Should a SbEntry be displayed in the sidebar? More...
static bool	prepare_sidebar (struct SidebarWindowData *wdata, int page_size)
	Prepare the list of SbEntry's for the sidebar display. More...
int	sb_recalc (struct MuttWindow *win)
	Recalculate the Sidebar display - Implements MuttWindow::recalc() -. More...
static int	draw_divider (struct SidebarWindowData *wdata, struct MuttWindow *win, int num_rows, int num_cols)
	Draw a line between the sidebar and the rest of neomutt. More...
static void	fill_empty_space (struct MuttWindow *win, int first_row, int num_rows, int div_width, int num_cols)
	Wipe the remaining Sidebar space. More...
int	sb_repaint (struct MuttWindow *win)
	Repaint the Sidebar display - Implements MuttWindow::repaint() -. More...

Detailed Description

Sidebar Window.

Authors

• Justin Hibbits
• Thomer M. Gil
• Richard Russon
• Kevin J. McCarthy
• R Primus

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

Function Documentation

imap_is_prefix()

static int imap_is_prefix ( const char *  folder, const char *  mbox  )

static

Check if folder matches the beginning of mbox.

Parameters

folder	Folder
mbox	Mailbox path

Return values

num	Length of the prefix

Definition at line 99 of file window.c.

{
  int plen = 0;
 
  struct Url *url_m = url_parse(mbox);
  struct Url *url_f = url_parse(folder);
  if (!url_m || !url_f)
    goto done;
 
  if (!mutt_istr_equal(url_m->host, url_f->host))
    goto done;
 
  if (url_m->user && url_f->user && !mutt_istr_equal(url_m->user, url_f->user))
    goto done;
 
  size_t mlen = mutt_str_len(url_m->path);
  size_t flen = mutt_str_len(url_f->path);
  if (flen > mlen)
    goto done;
 
  if (!mutt_strn_equal(url_m->path, url_f->path, flen))
    goto done;
 
  plen = strlen(mbox) - mlen + flen;
 
done:
  url_free(&url_m);
  url_free(&url_f);
 
  return plen;
}

Here is the call graph for this function:

Here is the caller graph for this function:

abbrev_folder()

static const char * abbrev_folder ( const char *  mbox, const char *  folder, enum MailboxType  type  )

static

Abbreviate a Mailbox path using a folder.

Parameters

mbox	Mailbox path to shorten
folder	Folder path to use
type	Mailbox type

Return values

ptr	Pointer into the mbox param

Definition at line 138 of file window.c.

{
  if (!mbox || !folder)
    return NULL;
 
  if (type == MUTT_IMAP)
  {
    int prefix = imap_is_prefix(folder, mbox);
    if (prefix == 0)
      return NULL;
    return mbox + prefix;
  }
 
  const char *const c_sidebar_delim_chars = cs_subset_string(NeoMutt->sub, "sidebar_delim_chars");
  if (!c_sidebar_delim_chars)
    return NULL;
 
  size_t flen = mutt_str_len(folder);
  if (flen == 0)
    return NULL;
  if (strchr(c_sidebar_delim_chars, folder[flen - 1])) // folder ends with a delimiter
    flen--;
 
  size_t mlen = mutt_str_len(mbox);
  if (mlen < flen)
    return NULL;
 
  if (!mutt_strn_equal(folder, mbox, flen))
    return NULL;
 
  // After the match, check that mbox has a delimiter
  if (!strchr(c_sidebar_delim_chars, mbox[flen]))
    return NULL;
 
  if (mlen > flen)
  {
    return mbox + flen + 1;
  }
 
  // mbox and folder are equal, use the chunk after the last delimiter
  while (mlen--)
  {
    if (strchr(c_sidebar_delim_chars, mbox[mlen]))
    {
      return mbox + mlen + 1;
    }
  }
 
  return NULL;
}

Here is the call graph for this function:

Here is the caller graph for this function:

abbrev_url()

static const char * abbrev_url ( const char *  mbox, enum MailboxType  type  )

static

Abbreviate a url-style Mailbox path.

Parameters

mbox	Mailbox path to shorten
type	Mailbox type

Return values

ptr	mbox unchanged

Use heuristics to shorten a non-local Mailbox path. Strip the host part (or database part for Notmuch).

e.g.

• imap://user@host.com/apple/banana becomes apple/banana
• notmuch:///home/user/db?query=hello becomes query=hello

Definition at line 202 of file window.c.

{
  /* This is large enough to skip `notmuch://`,
   * but not so large that it will go past the host part. */
  const int scheme_len = 10;
 
  size_t len = mutt_str_len(mbox);
  if ((len < scheme_len) || ((type != MUTT_NNTP) && (type != MUTT_IMAP) &&
                             (type != MUTT_NOTMUCH) && (type != MUTT_POP)))
  {
    return mbox;
  }
 
  const char split = (type == MUTT_NOTMUCH) ? '?' : '/';
 
  // Skip over the scheme, e.g. `imaps://`, `notmuch://`
  const char *last = strchr(mbox + scheme_len, split);
  if (last)
    mbox = last + 1;
  return mbox;
}

Here is the call graph for this function:

Here is the caller graph for this function:

add_indent()

static size_t add_indent ( char *  buf, size_t  buflen, const struct SbEntry *  sbe  )

static

Generate the needed indentation.

Parameters

buf	Output buffer
buflen	Size of output buffer
sbe	Sidebar entry

Return values

num	Bytes written

Definition at line 231 of file window.c.

{
  size_t res = 0;
  const char *const c_sidebar_indent_string = cs_subset_string(NeoMutt->sub, "sidebar_indent_string");
  for (int i = 0; i < sbe->depth; i++)
  {
    res += mutt_str_copy(buf + res, c_sidebar_indent_string, buflen - res);
  }
  return res;
}

Here is the call graph for this function:

Here is the caller graph for this function:

calc_color()

static struct AttrColor * calc_color ( const struct Mailbox *  m, bool  current, bool  highlight  )

static

Calculate the colour of a Sidebar row.

Parameters

m	Mailbox
current	true, if this is the current Mailbox
highlight	true, if this Mailbox has the highlight on it

Return values

num	ColorId, e.g. MT_COLOR_SIDEBAR_NEW

Definition at line 249 of file window.c.

{
  struct AttrColor *ac = NULL;
 
  const char *const c_spool_file = cs_subset_string(NeoMutt->sub, "spool_file");
  if (simple_color_is_set(MT_COLOR_SIDEBAR_SPOOLFILE) &&
      mutt_str_equal(mailbox_path(m), c_spool_file))
  {
    ac = merged_color_overlay(ac, simple_color_get(MT_COLOR_SIDEBAR_SPOOLFILE));
  }
 
  if (simple_color_is_set(MT_COLOR_SIDEBAR_FLAGGED) && (m->msg_flagged > 0))
  {
    ac = merged_color_overlay(ac, simple_color_get(MT_COLOR_SIDEBAR_FLAGGED));
  }
 
  if (simple_color_is_set(MT_COLOR_SIDEBAR_UNREAD) && (m->msg_unread > 0))
  {
    ac = merged_color_overlay(ac, simple_color_get(MT_COLOR_SIDEBAR_UNREAD));
  }
 
  if (simple_color_is_set(MT_COLOR_SIDEBAR_NEW) && m->has_new)
  {
    ac = merged_color_overlay(ac, simple_color_get(MT_COLOR_SIDEBAR_NEW));
  }
 
  if (!ac && simple_color_is_set(MT_COLOR_SIDEBAR_ORDINARY))
  {
    ac = simple_color_get(MT_COLOR_SIDEBAR_ORDINARY);
  }
 
  struct AttrColor *ac_bg = simple_color_get(MT_COLOR_NORMAL);
  ac_bg = merged_color_overlay(ac_bg, simple_color_get(MT_COLOR_SIDEBAR_BACKGROUND));
  ac = merged_color_overlay(ac_bg, ac);
 
  if (current || highlight)
  {
    int color;
    if (current)
    {
      if (simple_color_is_set(MT_COLOR_SIDEBAR_INDICATOR))
        color = MT_COLOR_SIDEBAR_INDICATOR;
      else
        color = MT_COLOR_INDICATOR;
    }
    else
    {
      color = MT_COLOR_SIDEBAR_HIGHLIGHT;
    }
 
    ac = merged_color_overlay(ac, simple_color_get(color));
  }
 
  return ac;
}

Here is the call graph for this function:

Here is the caller graph for this function:

calc_path_depth()

static int calc_path_depth ( const char *  mbox, const char *  delims, const char **  last_part  )

static

Calculate the depth of a Mailbox path.

Parameters

[in]	mbox	Mailbox path to examine
[in]	delims	Delimiter characters
[out]	last_part	Last path component

Return values

num

Depth

Definition at line 312 of file window.c.

{
  if (!mbox || !delims || !last_part)
    return 0;
 
  int depth = 0;
  const char *match = NULL;
  while ((match = strpbrk(mbox, delims)))
  {
    depth++;
    mbox = match + 1;
  }
 
  *last_part = mbox;
  return depth;
}

Here is the caller graph for this function:

make_sidebar_entry()

static void make_sidebar_entry ( char *  buf, size_t  buflen, int  width, struct SbEntry *  sbe, struct IndexSharedData *  shared  )

static

Turn mailbox data into a sidebar string.

Parameters

[out]	buf	Buffer in which to save string
[in]	buflen	Buffer length
[in]	width	Desired width in screen cells
[in]	sbe	Mailbox object
[in]	shared	Shared Index Data

Take all the relevant mailbox data and the desired screen width and then get mutt_expando_format to do the actual work.

See also

$sidebar_format, sidebar_format_str()

Definition at line 554 of file window.c.

{
  struct SidebarFormatData data = { sbe, shared };
 
  const char *const c_sidebar_format = cs_subset_string(NeoMutt->sub, "sidebar_format");
  mutt_expando_format(buf, buflen, 0, width, NONULL(c_sidebar_format),
                      sidebar_format_str, (intptr_t) &data, MUTT_FORMAT_NO_FLAGS);
 
  /* Force string to be exactly the right width */
  int w = mutt_strwidth(buf);
  int s = mutt_str_len(buf);
  width = MIN(buflen, width);
  if (w < width)
  {
    /* Pad with spaces */
    memset(buf + s, ' ', width - w);
    buf[s + width - w] = '\0';
  }
  else if (w > width)
  {
    /* Truncate to fit */
    size_t len = mutt_wstr_trunc(buf, buflen, width, NULL);
    buf[len] = '\0';
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

update_entries_visibility()

static void update_entries_visibility ( struct SidebarWindowData *  wdata )

static

Should a SbEntry be displayed in the sidebar?

Parameters

wdata

Sidebar data

For each SbEntry in the entries array, check whether we should display it. This is determined by several criteria. If the Mailbox:

• is the currently open mailbox
• is the currently highlighted mailbox
• has unread messages
• has flagged messages
• is pinned

Definition at line 593 of file window.c.

{
  /* Aliases for readability */
  const bool c_sidebar_new_mail_only = cs_subset_bool(NeoMutt->sub, "sidebar_new_mail_only");
  const bool c_sidebar_non_empty_mailbox_only = cs_subset_bool(NeoMutt->sub, "sidebar_non_empty_mailbox_only");
  struct SbEntry *sbe = NULL;
 
  struct IndexSharedData *shared = wdata->shared;
  struct SbEntry **sbep = NULL;
  ARRAY_FOREACH(sbep, &wdata->entries)
  {
    int i = ARRAY_FOREACH_IDX;
    sbe = *sbep;
 
    sbe->is_hidden = false;
 
    if (!sbe->mailbox->visible)
    {
      sbe->is_hidden = true;
      continue;
    }
 
    if (shared->mailbox &&
        mutt_str_equal(sbe->mailbox->realpath, shared->mailbox->realpath))
    {
      /* Spool directories are always visible */
      continue;
    }
 
    if (mutt_list_find(&SidebarPinned, mailbox_path(sbe->mailbox)) ||
        mutt_list_find(&SidebarPinned, sbe->mailbox->name))
    {
      /* Explicitly asked to be visible */
      continue;
    }
 
    if (c_sidebar_non_empty_mailbox_only && (i != wdata->opn_index) &&
        (sbe->mailbox->msg_count == 0))
    {
      sbe->is_hidden = true;
    }
 
    if (c_sidebar_new_mail_only && (i != wdata->opn_index) &&
        (sbe->mailbox->msg_unread == 0) && (sbe->mailbox->msg_flagged == 0) &&
        !sbe->mailbox->has_new)
    {
      sbe->is_hidden = true;
    }
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

prepare_sidebar()

static bool prepare_sidebar ( struct SidebarWindowData *  wdata, int  page_size  )

static

Prepare the list of SbEntry's for the sidebar display.

Parameters

wdata	Sidebar data
page_size	Number of lines on a page

Return values

false	No, don't draw the sidebar
true	Yes, draw the sidebar

Before painting the sidebar, we determine which are visible, sort them and set up our page pointers.

This is a lot of work to do each refresh, but there are many things that can change outside of the sidebar that we don't hear about.

Definition at line 657 of file window.c.

{
  if (ARRAY_EMPTY(&wdata->entries) || (page_size <= 0))
    return false;
 
  struct SbEntry **sbep = NULL;
  const bool c_sidebar_new_mail_only = cs_subset_bool(NeoMutt->sub, "sidebar_new_mail_only");
  const bool c_sidebar_non_empty_mailbox_only = cs_subset_bool(NeoMutt->sub, "sidebar_non_empty_mailbox_only");
 
  sbep = (wdata->opn_index >= 0) ? ARRAY_GET(&wdata->entries, wdata->opn_index) : NULL;
  const struct SbEntry *opn_entry = sbep ? *sbep : NULL;
  sbep = (wdata->hil_index >= 0) ? ARRAY_GET(&wdata->entries, wdata->hil_index) : NULL;
  const struct SbEntry *hil_entry = sbep ? *sbep : NULL;
 
  update_entries_visibility(wdata);
  const short c_sidebar_sort_method = cs_subset_sort(NeoMutt->sub, "sidebar_sort_method");
  sb_sort_entries(wdata, c_sidebar_sort_method);
 
  if (opn_entry || hil_entry)
  {
    ARRAY_FOREACH(sbep, &wdata->entries)
    {
      if ((opn_entry == *sbep) && (*sbep)->mailbox->visible)
        wdata->opn_index = ARRAY_FOREACH_IDX;
      if ((hil_entry == *sbep) && (*sbep)->mailbox->visible)
        wdata->hil_index = ARRAY_FOREACH_IDX;
    }
  }
 
  if ((wdata->hil_index < 0) || (hil_entry && hil_entry->is_hidden) ||
      (c_sidebar_sort_method != wdata->previous_sort))
  {
    if (wdata->opn_index >= 0)
    {
      wdata->hil_index = wdata->opn_index;
    }
    else
    {
      wdata->hil_index = 0;
      /* Note is_hidden will only be set when `$sidebar_new_mail_only` */
      if ((*ARRAY_GET(&wdata->entries, 0))->is_hidden && !sb_next(wdata))
        wdata->hil_index = -1;
    }
  }
 
  /* Set the Top and Bottom to frame the wdata->hil_index in groups of page_size */
 
  /* If `$sidebar_new_mail_only` or `$sidebar_non_empty_mailbox_only` is set,
   * some entries may be hidden so we need to scan for the framing interval */
  if (c_sidebar_new_mail_only || c_sidebar_non_empty_mailbox_only)
  {
    wdata->top_index = -1;
    wdata->bot_index = -1;
    while (wdata->bot_index < wdata->hil_index)
    {
      wdata->top_index = wdata->bot_index + 1;
      int page_entries = 0;
      while (page_entries < page_size)
      {
        wdata->bot_index++;
        if (wdata->bot_index >= ARRAY_SIZE(&wdata->entries))
          break;
        if (!(*ARRAY_GET(&wdata->entries, wdata->bot_index))->is_hidden)
          page_entries++;
      }
    }
  }
  else
  {
    /* Otherwise we can just calculate the interval */
    wdata->top_index = (wdata->hil_index / page_size) * page_size;
    wdata->bot_index = wdata->top_index + page_size - 1;
  }
 
  if (wdata->bot_index > (ARRAY_SIZE(&wdata->entries) - 1))
    wdata->bot_index = ARRAY_SIZE(&wdata->entries) - 1;
 
  wdata->previous_sort = c_sidebar_sort_method;
 
  return (wdata->hil_index >= 0);
}

Here is the call graph for this function:

Here is the caller graph for this function:

draw_divider()

static int draw_divider ( struct SidebarWindowData *  wdata, struct MuttWindow *  win, int  num_rows, int  num_cols  )

static

Draw a line between the sidebar and the rest of neomutt.

Parameters

wdata	Sidebar data
win	Window to draw on
num_rows	Height of the Sidebar
num_cols	Width of the Sidebar

Return values

0	Empty string
num	Character occupies n screen columns

Draw a divider using characters from the config option "sidebar_divider_char". This can be an ASCII or Unicode character. We calculate these characters' width in screen columns.

If the user hasn't set $sidebar_divider_char we pick a character for them, respecting the value of $ascii_chars.

Definition at line 863 of file window.c.

{
  if ((num_rows < 1) || (num_cols < 1) || (wdata->divider_width > num_cols) ||
      (wdata->divider_width == 0))
  {
    return 0;
  }
 
  const int width = wdata->divider_width;
  const char *const c_sidebar_divider_char = cs_subset_string(NeoMutt->sub, "sidebar_divider_char");
 
  struct AttrColor *ac = simple_color_get(MT_COLOR_NORMAL);
  ac = merged_color_overlay(ac, simple_color_get(MT_COLOR_SIDEBAR_BACKGROUND));
  ac = merged_color_overlay(ac, simple_color_get(MT_COLOR_SIDEBAR_DIVIDER));
  mutt_curses_set_color(ac);
 
  const bool c_sidebar_on_right = cs_subset_bool(NeoMutt->sub, "sidebar_on_right");
  const int col = c_sidebar_on_right ? 0 : (num_cols - width);
 
  for (int i = 0; i < num_rows; i++)
  {
    mutt_window_move(win, col, i);
 
    if (wdata->divider_type == SB_DIV_USER)
      mutt_window_addstr(win, NONULL(c_sidebar_divider_char));
    else
      mutt_window_addch(win, '|');
  }
 
  mutt_curses_set_color_by_id(MT_COLOR_NORMAL);
  return width;
}

Here is the call graph for this function:

Here is the caller graph for this function:

fill_empty_space()

static void fill_empty_space ( struct MuttWindow *  win, int  first_row, int  num_rows, int  div_width, int  num_cols  )

static

Wipe the remaining Sidebar space.

Parameters

win	Window to draw on
first_row	Window line to start (0-based)
num_rows	Number of rows to fill
div_width	Width in screen characters taken by the divider
num_cols	Number of columns to fill

Write spaces over the area the sidebar isn't using.

Definition at line 907 of file window.c.

{
  /* Fill the remaining rows with blank space */
  struct AttrColor *ac = simple_color_get(MT_COLOR_NORMAL);
  ac = merged_color_overlay(ac, simple_color_get(MT_COLOR_SIDEBAR_BACKGROUND));
  mutt_curses_set_color(ac);
 
  const bool c_sidebar_on_right = cs_subset_bool(NeoMutt->sub, "sidebar_on_right");
  if (!c_sidebar_on_right)
    div_width = 0;
  for (int r = 0; r < num_rows; r++)
  {
    mutt_window_move(win, div_width, first_row + r);
    mutt_curses_set_color_by_id(MT_COLOR_SIDEBAR_BACKGROUND);
 
    for (int i = 0; i < num_cols; i++)
      mutt_window_addch(win, ' ');
  }
}

Here is the call graph for this function:

Here is the caller graph for this function: