sidebar.c

Go to the documentation of this file.

 
#include "config.h"
#include <stdbool.h>
#include <stdio.h>
#include "private.h"
#include "mutt/lib.h"
#include "config/lib.h"
#include "core/lib.h"
#include "gui/lib.h"
#include "lib.h"
#include "color/lib.h"
#include "index/lib.h"
 
struct ListHead SidebarPinned = STAILQ_HEAD_INITIALIZER(SidebarPinned); 

const struct Command SbCommands[] = {
  // clang-format off
  { "sidebar-pin", CMD_SIDEBAR_PIN, parse_sidebar_pin,
        N_("Pin a mailbox in the sidebar (keep visible)"),
        N_("sidebar-pin <mailbox> [ <mailbox> ... ]"),
        "optionalfeatures.html#sidebar-pin" },
  { "sidebar-unpin", CMD_SIDEBAR_UNPIN, parse_sidebar_unpin,
        N_("Unpin a previously pinned mailbox in the sidebar"),
        N_("sidebar-unpin { * | <mailbox> ... }"),
        "optionalfeatures.html#sidebar-pin" },
 
  // Deprecated
  { "sidebar_pin",         CMD_NONE, NULL, "sidebar-pin",   NULL, NULL, CF_SYNONYM },
  { "sidebar_unpin",       CMD_NONE, NULL, "sidebar-unpin", NULL, NULL, CF_SYNONYM },
  { "sidebar_whitelist",   CMD_NONE, NULL, "sidebar-pin",   NULL, NULL, CF_SYNONYM },
  { "unsidebar_whitelist", CMD_NONE, NULL, "sidebar-unpin", NULL, NULL, CF_SYNONYM },
 
  { NULL, CMD_NONE, NULL, NULL, NULL, NULL, CF_NO_FLAGS },
  // clang-format on
};

struct Mailbox *sb_get_highlight(struct MuttWindow *win)
{
  const bool c_sidebar_visible = cs_subset_bool(NeoMutt->sub, "sidebar_visible");
  if (!c_sidebar_visible)
    return NULL;
 
  struct SidebarWindowData *wdata = sb_wdata_get(win);
  if (!wdata || (wdata->hil_index < 0))
    return NULL;
 
  struct SbEntry **sbep = ARRAY_GET(&wdata->entries, wdata->hil_index);
  if (!sbep)
    return NULL;
 
  return (*sbep)->mailbox;
}

void sb_add_mailbox(struct SidebarWindowData *wdata, struct Mailbox *m)
{
  if (!m)
    return;
 
  struct SbEntry **sbep = NULL;
  ARRAY_FOREACH(sbep, &wdata->entries)
  {
    if ((*sbep)->mailbox == m)
      return;
  }
 
  /* Any new/deleted mailboxes will cause a refresh.  As long as
   * they're valid, our pointers will be updated in prepare_sidebar() */
 
  struct IndexSharedData *shared = wdata->shared;
  struct SbEntry *entry = MUTT_MEM_CALLOC(1, struct SbEntry);
  entry->mailbox = m;
  entry->score = -1;
 
  if (wdata->top_index < 0)
    wdata->top_index = ARRAY_SIZE(&wdata->entries);
  if (wdata->bot_index < 0)
    wdata->bot_index = ARRAY_SIZE(&wdata->entries);
  if ((wdata->opn_index < 0) && shared->mailbox &&
      mutt_str_equal(m->realpath, shared->mailbox->realpath))
  {
    wdata->opn_index = ARRAY_SIZE(&wdata->entries);
  }
 
  ARRAY_ADD(&wdata->entries, entry);
}

void sb_remove_mailbox(struct SidebarWindowData *wdata, const struct Mailbox *m)
{
  struct SbEntry **sbep = NULL;
  ARRAY_FOREACH(sbep, &wdata->entries)
  {
    if ((*sbep)->mailbox != m)
      continue;
 
    struct SbEntry *sbe_remove = *sbep;
    ARRAY_REMOVE(&wdata->entries, sbep);
    FREE(&sbe_remove);
 
    if (wdata->opn_index == ARRAY_FOREACH_IDX_sbep)
    {
      // Open item was deleted
      wdata->opn_index = -1;
    }
    else if ((wdata->opn_index > 0) && (wdata->opn_index > ARRAY_FOREACH_IDX_sbep))
    {
      // Open item is still visible, so adjust the index
      wdata->opn_index--;
    }
 
    if (wdata->hil_index == ARRAY_FOREACH_IDX_sbep)
    {
      // If possible, keep the highlight where it is
      struct SbEntry **sbep_cur = ARRAY_GET(&wdata->entries, ARRAY_FOREACH_IDX_sbep);
      if (!sbep_cur)
      {
        // The last entry was deleted, so backtrack
        sb_prev(wdata);
      }
      else if ((*sbep_cur)->is_hidden)
      {
        // Find the next unhidden entry, or the previous
        if (!sb_next(wdata) && !sb_prev(wdata))
          wdata->hil_index = -1;
      }
    }
    else if ((wdata->hil_index > 0) && (wdata->hil_index > ARRAY_FOREACH_IDX_sbep))
    {
      // Highlighted item is still visible, so adjust the index
      wdata->hil_index--;
    }
    break;
  }
}

void sb_set_current_mailbox(struct SidebarWindowData *wdata, struct Mailbox *m)
{
  wdata->opn_index = -1;
 
  struct SbEntry **sbep = NULL;
  ARRAY_FOREACH(sbep, &wdata->entries)
  {
    if (m && m->visible)
    {
      if (mutt_str_equal((*sbep)->mailbox->realpath, m->realpath))
      {
        wdata->opn_index = ARRAY_FOREACH_IDX_sbep;
        wdata->hil_index = ARRAY_FOREACH_IDX_sbep;
        break;
      }
    }
    (*sbep)->is_hidden = !(*sbep)->mailbox->visible;
  }
}

void sb_init(void)
{
  // Set a default style
  struct AttrColor *ac = simple_color_get(MT_COLOR_SIDEBAR_HIGHLIGHT);
  ac->attrs = A_UNDERLINE;
 
  // Listen for dialog creation events
  notify_observer_add(AllDialogsWindow->notify, NT_WINDOW,
                      sb_insertion_window_observer, NULL);
}

void sb_cleanup(void)
{
  if (AllDialogsWindow)
    notify_observer_remove(AllDialogsWindow->notify, sb_insertion_window_observer, NULL);
  mutt_list_free(&SidebarPinned);
}