window.c

Go to the documentation of this file.

 
#include "config.h"
#include <stdbool.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 "expando/lib.h"
#include "index/lib.h"
#include "expando.h"
#include "module_data.h"

static int imap_is_prefix(const char *folder, const char *mbox)
{
  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;
}

static const char *abbrev_folder(const char *mbox, const char *folder, enum MailboxType type)
{
  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;
}

static const char *abbrev_url(const char *mbox, enum MailboxType type)
{
  /* 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;
}

static const struct AttrColor *calc_color(const struct Mailbox *m, bool current, bool highlight)
{
  const 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_SPOOL_FILE) &&
      mutt_str_equal(mailbox_path(m), c_spool_file))
  {
    ac = merged_color_overlay(ac, simple_color_get(MT_COLOR_SIDEBAR_SPOOL_FILE));
  }
 
  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);
  }
 
  const 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;
}

static int calc_path_depth(const char *mbox, const char *delims, const char **last_part)
{
  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;
}

void sb_entry_set_display_name(struct SbEntry *entry)
{
  const char *path = mailbox_path(entry->mailbox);
 
  const char *const c_folder = cs_subset_string(NeoMutt->sub, "folder");
  // Try to abbreviate the full path
  const char *abbr = abbrev_folder(path, c_folder, entry->mailbox->type);
  if (!abbr)
    abbr = abbrev_url(path, entry->mailbox->type);
  const char *short_path = abbr ? abbr : path;
 
  /* Compute the depth */
  const char *last_part = abbr;
  const char *const c_sidebar_delim_chars = cs_subset_string(NeoMutt->sub, "sidebar_delim_chars");
  entry->depth = calc_path_depth(abbr, c_sidebar_delim_chars, &last_part);
 
  const bool short_path_is_abbr = (short_path == abbr);
  const bool c_sidebar_short_path = cs_subset_bool(NeoMutt->sub, "sidebar_short_path");
  if (c_sidebar_short_path)
  {
    short_path = last_part;
  }
 
  // Don't indent if we were unable to create an abbreviation.
  // Otherwise, the full path will be indent, and it looks unusual.
  const bool c_sidebar_folder_indent = cs_subset_bool(NeoMutt->sub, "sidebar_folder_indent");
  if (c_sidebar_folder_indent && short_path_is_abbr)
  {
    const short c_sidebar_component_depth = cs_subset_number(NeoMutt->sub, "sidebar_component_depth");
    if (c_sidebar_component_depth > 0)
      entry->depth -= c_sidebar_component_depth;
  }
  else if (!c_sidebar_folder_indent)
  {
    entry->depth = 0;
  }
 
  mutt_str_copy(entry->box, short_path, sizeof(entry->box));
}

static void make_sidebar_entry(char *buf, size_t buflen, int width, struct SbEntry *sbe,
                               struct IndexSharedData *shared, int index)
{
  struct SidebarData sdata = { sbe, shared, index };
 
  struct Buffer *tmp = buf_pool_get();
  const struct Expando *c_sidebar_format = cs_subset_expando(NeoMutt->sub, "sidebar_format");
  expando_filter(c_sidebar_format, SidebarRenderCallbacks, &sdata,
                 MUTT_FORMAT_NONE, width, NeoMutt->env, tmp);
  mutt_str_copy(buf, buf_string(tmp), buflen);
  buf_pool_release(&tmp);
 
  /* 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, capping to available buffer space */
    int pad = width - w;
    if ((s + pad) >= (int) buflen)
      pad = (int) buflen - s - 1;
    if (pad > 0)
    {
      memset(buf + s, ' ', pad);
      buf[s + pad] = '\0';
    }
  }
  else if (w > width)
  {
    /* Truncate to fit */
    size_t len = mutt_wstr_trunc(buf, buflen, width, NULL);
    buf[len] = '\0';
  }
}

static void update_entries_visibility(struct SidebarWindowData *wdata)
{
  struct SidebarModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_SIDEBAR);
  /* 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_sbep;
    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(&mod_data->sidebar_pinned, mailbox_path(sbe->mailbox)) ||
        mutt_list_find(&mod_data->sidebar_pinned, 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;
    }
  }
}

static int sb_first_visible(struct SidebarWindowData *wdata, int index)
{
  if (index < 0)
    index = 0;
 
  struct SbEntry **sbep = NULL;
  ARRAY_FOREACH_FROM(sbep, &wdata->entries, index)
  {
    if (!(*sbep)->is_hidden)
      return ARRAY_FOREACH_IDX_sbep;
  }
 
  return -1;
}

static int sb_page_bottom(struct SidebarWindowData *wdata, int top, int page_size)
{
  if (top < 0)
    return -1;
 
  int row = 0;
  int last = -1;
 
  struct SbEntry **sbep = NULL;
  ARRAY_FOREACH_FROM(sbep, &wdata->entries, top)
  {
    if (row >= page_size)
      break;
    if ((*sbep)->is_hidden)
      continue;
 
    last = ARRAY_FOREACH_IDX_sbep;
    row++;
  }
 
  return last;
}

static bool prepare_sidebar(struct SidebarWindowData *wdata, int page_size)
{
  if (ARRAY_EMPTY(&wdata->entries) || (page_size <= 0))
    return false;
 
  struct SbEntry **sbep = NULL;
 
  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;
  sbep = (wdata->top_index >= 0) ? ARRAY_GET(&wdata->entries, wdata->top_index) : NULL;
  const struct SbEntry *top_entry = sbep ? *sbep : NULL;
 
  update_entries_visibility(wdata);
  const enum EmailSortType c_sidebar_sort = cs_subset_sort(NeoMutt->sub, "sidebar_sort");
  sb_sort_entries(wdata, c_sidebar_sort);
 
  if (opn_entry || hil_entry)
  {
    ARRAY_FOREACH(sbep, &wdata->entries)
    {
      if ((opn_entry == *sbep) && (*sbep)->mailbox->visible)
        wdata->opn_index = ARRAY_FOREACH_IDX_sbep;
      if ((hil_entry == *sbep) && (*sbep)->mailbox->visible)
        wdata->hil_index = ARRAY_FOREACH_IDX_sbep;
    }
  }
 
  if ((wdata->hil_index < 0) || (hil_entry && hil_entry->is_hidden) ||
      (c_sidebar_sort != 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;
    }
  }
 
  /* The viewport (top_index) is persistent: it is preserved across recalcs so
   * that scrolling (<sidebar-scroll-*>) and recentring
   * (<sidebar-scroll-selection-to-*>) survive a later repaint.  Restore the
   * remembered top entry after the re-sort, then snap it to a visible entry. */
  if (top_entry)
  {
    ARRAY_FOREACH(sbep, &wdata->entries)
    {
      if ((top_entry == *sbep) && (*sbep)->mailbox->visible)
      {
        wdata->top_index = ARRAY_FOREACH_IDX_sbep;
        break;
      }
    }
  }
  wdata->top_index = sb_first_visible(wdata, wdata->top_index);
 
  /* Is the selection within the current viewport? */
  int bot = sb_page_bottom(wdata, wdata->top_index, page_size);
  const bool hil_in_view = (wdata->top_index >= 0) &&
                           (wdata->hil_index >= wdata->top_index) &&
                           (wdata->hil_index <= bot);
 
  if (wdata->repage || !hil_in_view)
  {
    /* Reframe the view, paging so that the selection is visible.  Entries may
     * be hidden ($sidebar_new_mail_only, etc.) so we count visible entries. */
    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++;
      }
    }
    wdata->repage = false;
  }
  else
  {
    /* Keep the persistent viewport, just recompute the bottom */
    wdata->bot_index = bot;
  }
 
  if (wdata->bot_index > (ARRAY_SIZE(&wdata->entries) - 1))
    wdata->bot_index = ARRAY_SIZE(&wdata->entries) - 1;
 
  wdata->previous_sort = c_sidebar_sort;
 
  return (wdata->hil_index >= 0);
}

int sb_recalc(struct MuttWindow *win)
{
  struct SidebarWindowData *wdata = sb_wdata_get(win);
  struct IndexSharedData *shared = wdata->shared;
 
  if (ARRAY_EMPTY(&wdata->entries))
  {
    struct MailboxArray ma = neomutt_mailboxes_get(NeoMutt, MUTT_MAILBOX_ANY);
    struct Mailbox **mp = NULL;
    ARRAY_FOREACH(mp, &ma)
    {
      struct Mailbox *m = *mp;
 
      if (m->visible)
        sb_add_mailbox(wdata, m);
    }
    ARRAY_FREE(&ma); // Clean up the ARRAY, but not the Mailboxes
  }
 
  if (!prepare_sidebar(wdata, win->state.rows))
  {
    win->actions |= WA_REPAINT;
    return 0;
  }
 
  int num_rows = win->state.rows;
  int num_cols = win->state.cols;
 
  if (ARRAY_EMPTY(&wdata->entries) || (num_rows <= 0))
    return 0;
 
  if (wdata->top_index < 0)
    return 0;
 
  int width = num_cols - wdata->divider_width;
  int row = 0;
  struct Mailbox *m_cur = shared->mailbox;
  struct SbEntry **sbep = NULL;
  ARRAY_FOREACH_FROM(sbep, &wdata->entries, wdata->top_index)
  {
    if (row >= num_rows)
      break;
 
    if ((*sbep)->is_hidden)
      continue;
 
    struct SbEntry *entry = (*sbep);
    struct Mailbox *m = entry->mailbox;
 
    const int entryidx = ARRAY_FOREACH_IDX_sbep;
    entry->color = calc_color(m, (entryidx == wdata->opn_index),
                              (entryidx == wdata->hil_index));
 
    if (m_cur && (m_cur->realpath[0] != '\0') &&
        mutt_str_equal(m->realpath, m_cur->realpath))
    {
      m->msg_unread = m_cur->msg_unread;
      m->msg_count = m_cur->msg_count;
      m->msg_flagged = m_cur->msg_flagged;
    }
 
    sb_entry_set_display_name(entry);
    make_sidebar_entry(entry->display, sizeof(entry->display), width, entry, shared, entryidx);
    row++;
  }
 
  win->actions |= WA_REPAINT;
  mutt_debug(LL_DEBUG5, "recalc done, request WA_REPAINT\n");
  return 0;
}

static int draw_divider(struct SidebarWindowData *wdata, struct MuttWindow *win,
                        int num_rows, int num_cols)
{
  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");
 
  const 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, i, col);
 
    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;
}

static void fill_empty_space(struct MuttWindow *win, int first_row,
                             int num_rows, int div_width, int num_cols)
{
  /* Fill the remaining rows with blank space */
  const 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, first_row + r, div_width);
    mutt_curses_set_color_by_id(MT_COLOR_SIDEBAR_BACKGROUND);
 
    for (int i = 0; i < num_cols; i++)
      mutt_window_addch(win, ' ');
  }
}

int sb_repaint(struct MuttWindow *win)
{
  struct SidebarWindowData *wdata = sb_wdata_get(win);
  const bool c_sidebar_on_right = cs_subset_bool(NeoMutt->sub, "sidebar_on_right");
 
  int row = 0;
  int num_rows = win->state.rows;
  int num_cols = win->state.cols;
 
  if (wdata->top_index >= 0)
  {
    int col = 0;
    if (c_sidebar_on_right)
      col = wdata->divider_width;
 
    struct SbEntry **sbep = NULL;
    ARRAY_FOREACH_FROM(sbep, &wdata->entries, wdata->top_index)
    {
      if (row >= num_rows)
        break;
 
      if ((*sbep)->is_hidden)
        continue;
 
      struct SbEntry *entry = (*sbep);
      mutt_window_move(win, row, col);
      mutt_curses_set_color(entry->color);
      mutt_window_printf(win, "%s", entry->display);
      mutt_refresh();
      row++;
    }
  }
 
  fill_empty_space(win, row, num_rows - row, wdata->divider_width,
                   num_cols - wdata->divider_width);
  draw_divider(wdata, win, num_rows, num_cols);
 
  mutt_debug(LL_DEBUG5, "repaint done\n");
  return 0;
}