functions.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 "core/lib.h"
#include "gui/lib.h"
#include "functions.h"
#include "lib.h"
#include "editor/lib.h"
#include "fuzzy/lib.h"
#include "history/lib.h"
#include "index/lib.h"
#include "key/lib.h"
#include "menu/lib.h"
#include "module_data.h"
 
// clang-format off
static const struct MenuFuncOp OpSidebar[] = { /* map: sidebar */
  { "sidebar-first",          OP_SIDEBAR_FIRST          },
  { "sidebar-last",           OP_SIDEBAR_LAST           },
  { "sidebar-next",           OP_SIDEBAR_NEXT           },
  { "sidebar-next-new",       OP_SIDEBAR_NEXT_NEW       },
  { "sidebar-open",           OP_SIDEBAR_OPEN           },
  { "sidebar-page-down",      OP_SIDEBAR_PAGE_DOWN      },
  { "sidebar-page-up",        OP_SIDEBAR_PAGE_UP        },
  { "sidebar-prev",           OP_SIDEBAR_PREV           },
  { "sidebar-prev-new",       OP_SIDEBAR_PREV_NEW       },
  { "sidebar-abort-search",   OP_SIDEBAR_ABORT_SEARCH   },
  { "sidebar-start-search",   OP_SIDEBAR_START_SEARCH   },
  { "sidebar-toggle-virtual", OP_SIDEBAR_TOGGLE_VIRTUAL },
  { "sidebar-toggle-visible", OP_SIDEBAR_TOGGLE_VISIBLE },
  { NULL, 0 },
};

const struct MenuOpSeq SidebarDefaultBindings[] = {
  { OP_SIDEBAR_NEXT,         "<down>" },
  { OP_SIDEBAR_PREV,         "<up>"   },
  { 0, NULL },
};
// clang-format on

void sidebar_init_keys(struct NeoMutt *n, struct SubMenu *sm_generic)
{
  struct SidebarModuleData *mod_data = neomutt_get_module_data(n, MODULE_ID_SIDEBAR);
  ASSERT(mod_data);
 
  struct MenuDefinition *md = NULL;
  struct SubMenu *sm = NULL;
  struct SubMenu *sm_editor = editor_get_submenu();
  ASSERT(sm_editor);
 
  sm = km_register_submenu(OpSidebar);
  md = km_register_menu(MENU_SIDEBAR, "sidebar");
  km_menu_add_submenu(md, sm);
  km_menu_add_submenu(md, sm_editor);
  km_menu_add_bindings(md, SidebarDefaultBindings);
 
  mod_data->md_sidebar = md;
  mod_data->sm_sidebar = sm;
}

struct SubMenu *sidebar_get_submenu(void)
{
  struct SidebarModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_SIDEBAR);
  ASSERT(mod_data);
 
  return mod_data->sm_sidebar;
}

bool sb_next(struct SidebarWindowData *wdata)
{
  struct SbEntry **sbep = NULL;
  ARRAY_FOREACH_FROM(sbep, &wdata->entries, wdata->hil_index + 1)
  {
    if (!(*sbep)->is_hidden)
    {
      wdata->hil_index = ARRAY_FOREACH_IDX_sbep;
      return true;
    }
  }
 
  return false;
}

static bool sb_next_n(struct SidebarWindowData *wdata, int count)
{
  int orig = wdata->hil_index;
  for (int i = 0; i < count; i++)
  {
    if (!sb_next(wdata))
      break;
  }
  return (wdata->hil_index != orig);
}

static bool sb_prev_n(struct SidebarWindowData *wdata, int count)
{
  int orig = wdata->hil_index;
  for (int i = 0; i < count; i++)
  {
    if (!sb_prev(wdata))
      break;
  }
  return (wdata->hil_index != orig);
}

static struct SbEntry **sb_next_new(struct SidebarWindowData *wdata, size_t begin, size_t end)
{
  struct SbEntry **sbep = NULL;
  ARRAY_FOREACH_FROM_TO(sbep, &wdata->entries, begin, end)
  {
    if ((*sbep)->mailbox->has_new || ((*sbep)->mailbox->msg_unread != 0))
      return sbep;
  }
  return NULL;
}

bool sb_prev(struct SidebarWindowData *wdata)
{
  struct SbEntry **sbep = NULL, **prev = NULL;
  ARRAY_FOREACH_TO(sbep, &wdata->entries, wdata->hil_index)
  {
    if (!(*sbep)->is_hidden)
      prev = sbep;
  }
 
  if (prev)
  {
    wdata->hil_index = ARRAY_IDX(&wdata->entries, prev);
    return true;
  }
 
  return false;
}

static struct SbEntry **sb_prev_new(struct SidebarWindowData *wdata, size_t begin, size_t end)
{
  struct SbEntry **sbep = NULL, **prev = NULL;
  ARRAY_FOREACH_FROM_TO(sbep, &wdata->entries, begin, end)
  {
    if ((*sbep)->mailbox->has_new || ((*sbep)->mailbox->msg_unread != 0))
      prev = sbep;
  }
 
  return prev;
}
 
// -----------------------------------------------------------------------------

static int op_sidebar_first(struct SidebarFunctionData *fdata, const struct KeyEvent *event)
{
  struct SidebarWindowData *wdata = fdata->wdata;
  if (!mutt_window_is_visible(wdata->win))
    return FR_NO_ACTION;
 
  if (ARRAY_EMPTY(&wdata->entries) || (wdata->hil_index < 0))
    return FR_NO_ACTION;
 
  int orig_hil_index = wdata->hil_index;
 
  wdata->hil_index = 0;
  if ((*ARRAY_GET(&wdata->entries, wdata->hil_index))->is_hidden)
    if (!sb_next(wdata))
      wdata->hil_index = orig_hil_index;
 
  if (orig_hil_index == wdata->hil_index)
    return FR_NO_ACTION;
 
  wdata->win->actions |= WA_RECALC;
  return FR_SUCCESS;
}

static int op_sidebar_last(struct SidebarFunctionData *fdata, const struct KeyEvent *event)
{
  struct SidebarWindowData *wdata = fdata->wdata;
  if (!mutt_window_is_visible(wdata->win))
    return FR_NO_ACTION;
 
  if (ARRAY_EMPTY(&wdata->entries) || (wdata->hil_index < 0))
    return FR_NO_ACTION;
 
  int orig_hil_index = wdata->hil_index;
 
  wdata->hil_index = ARRAY_SIZE(&wdata->entries);
  if (!sb_prev(wdata))
    wdata->hil_index = orig_hil_index;
 
  if (orig_hil_index == wdata->hil_index)
    return FR_NO_ACTION;
 
  wdata->win->actions |= WA_RECALC;
  return FR_SUCCESS;
}

static int op_sidebar_next(struct SidebarFunctionData *fdata, const struct KeyEvent *event)
{
  struct SidebarWindowData *wdata = fdata->wdata;
  if (!mutt_window_is_visible(wdata->win))
    return FR_NO_ACTION;
 
  if (ARRAY_EMPTY(&wdata->entries) || (wdata->hil_index < 0))
    return FR_NO_ACTION;
 
  const int count = event->count;
  if (count > 0)
  {
    if (!sb_next_n(wdata, count))
      return FR_NO_ACTION;
  }
  else
  {
    if (!sb_next(wdata))
    {
      mutt_message(_("You are on the last entry"));
      return FR_ERROR;
    }
  }
 
  wdata->win->actions |= WA_RECALC;
  return FR_SUCCESS;
}

static int op_sidebar_next_new(struct SidebarFunctionData *fdata, const struct KeyEvent *event)
{
  struct SidebarWindowData *wdata = fdata->wdata;
  if (!mutt_window_is_visible(wdata->win))
    return FR_NO_ACTION;
 
  const size_t max_entries = ARRAY_SIZE(&wdata->entries);
  if ((max_entries == 0) || (wdata->hil_index < 0))
    return FR_NO_ACTION;
 
  const int count = MAX(event->count, 1);
  const bool c_sidebar_next_new_wrap = cs_subset_bool(fdata->n->sub, "sidebar_next_new_wrap");
  int orig_hil_index = wdata->hil_index;
 
  for (int i = 0; i < count; i++)
  {
    struct SbEntry **sbep = NULL;
    if ((sbep = sb_next_new(wdata, wdata->hil_index + 1, max_entries)) ||
        (c_sidebar_next_new_wrap && (sbep = sb_next_new(wdata, 0, wdata->hil_index))))
    {
      wdata->hil_index = ARRAY_IDX(&wdata->entries, sbep);
    }
    else
    {
      break;
    }
  }
 
  if (wdata->hil_index == orig_hil_index)
    return FR_NO_ACTION;
 
  wdata->win->actions |= WA_RECALC;
  return FR_SUCCESS;
}

static int op_sidebar_open(struct SidebarFunctionData *fdata, const struct KeyEvent *event)
{
  struct SidebarWindowData *wdata = fdata->wdata;
  struct MuttWindow *win_sidebar = wdata->win;
  if (!mutt_window_is_visible(win_sidebar))
    return FR_NO_ACTION;
 
  struct MuttWindow *dlg = dialog_find(win_sidebar);
  index_change_folder(dlg, sb_get_highlight(win_sidebar));
  return FR_SUCCESS;
}

static int op_sidebar_page_down(struct SidebarFunctionData *fdata, const struct KeyEvent *event)
{
  struct SidebarWindowData *wdata = fdata->wdata;
  if (!mutt_window_is_visible(wdata->win))
    return FR_NO_ACTION;
 
  if (ARRAY_EMPTY(&wdata->entries) || (wdata->bot_index < 0))
    return FR_NO_ACTION;
 
  int orig_hil_index = wdata->hil_index;
  const int page_size = wdata->win->state.rows;
  const int count = MAX(event->count, 1);
 
  if (!sb_next_n(wdata, count * page_size))
    return FR_NO_ACTION;
 
  /* If we landed on a hidden entry, go up to the last unhidden one */
  if ((*ARRAY_GET(&wdata->entries, wdata->hil_index))->is_hidden)
    sb_prev(wdata);
 
  if (orig_hil_index == wdata->hil_index)
    return FR_NO_ACTION;
 
  wdata->repage = true;
  wdata->win->actions |= WA_RECALC;
  return FR_SUCCESS;
}

static int op_sidebar_page_up(struct SidebarFunctionData *fdata, const struct KeyEvent *event)
{
  struct SidebarWindowData *wdata = fdata->wdata;
  if (!mutt_window_is_visible(wdata->win))
    return FR_NO_ACTION;
 
  if (ARRAY_EMPTY(&wdata->entries) || (wdata->top_index < 0))
    return FR_NO_ACTION;
 
  int orig_hil_index = wdata->hil_index;
  const int page_size = wdata->win->state.rows;
  const int count = MAX(event->count, 1);
 
  if (!sb_prev_n(wdata, count * page_size))
    return FR_NO_ACTION;
 
  /* If we landed on a hidden entry, go down to the last unhidden one */
  if ((*ARRAY_GET(&wdata->entries, wdata->hil_index))->is_hidden)
    sb_next(wdata);
 
  if (orig_hil_index == wdata->hil_index)
    return FR_NO_ACTION;
 
  wdata->repage = true;
  wdata->win->actions |= WA_RECALC;
  return FR_SUCCESS;
}

static int op_sidebar_prev(struct SidebarFunctionData *fdata, const struct KeyEvent *event)
{
  struct SidebarWindowData *wdata = fdata->wdata;
  if (!mutt_window_is_visible(wdata->win))
    return FR_NO_ACTION;
 
  if (ARRAY_EMPTY(&wdata->entries) || (wdata->hil_index < 0))
    return FR_NO_ACTION;
 
  const int count = event->count;
  if (count > 0)
  {
    if (!sb_prev_n(wdata, count))
      return FR_NO_ACTION;
  }
  else
  {
    if (!sb_prev(wdata))
    {
      mutt_message(_("You are on the first entry"));
      return FR_ERROR;
    }
  }
 
  wdata->win->actions |= WA_RECALC;
  return FR_SUCCESS;
}

static int op_sidebar_prev_new(struct SidebarFunctionData *fdata, const struct KeyEvent *event)
{
  struct SidebarWindowData *wdata = fdata->wdata;
  if (!mutt_window_is_visible(wdata->win))
    return FR_NO_ACTION;
 
  const size_t max_entries = ARRAY_SIZE(&wdata->entries);
  if ((max_entries == 0) || (wdata->hil_index < 0))
    return FR_NO_ACTION;
 
  const int count = MAX(event->count, 1);
  const bool c_sidebar_next_new_wrap = cs_subset_bool(fdata->n->sub, "sidebar_next_new_wrap");
  int orig_hil_index = wdata->hil_index;
 
  for (int i = 0; i < count; i++)
  {
    struct SbEntry **sbep = NULL;
    if ((sbep = sb_prev_new(wdata, 0, wdata->hil_index)) ||
        (c_sidebar_next_new_wrap &&
         (sbep = sb_prev_new(wdata, wdata->hil_index + 1, max_entries))))
    {
      wdata->hil_index = ARRAY_IDX(&wdata->entries, sbep);
    }
    else
    {
      break;
    }
  }
 
  if (wdata->hil_index == orig_hil_index)
    return FR_NO_ACTION;
 
  wdata->win->actions |= WA_RECALC;
  return FR_SUCCESS;
}

static int op_sidebar_toggle_visible(struct SidebarFunctionData *fdata,
                                     const struct KeyEvent *event)
{
  bool_str_toggle(fdata->n->sub, "sidebar_visible", NULL);
  mutt_window_reflow(NULL);
  return FR_SUCCESS;
}

static int op_sidebar_toggle_virtual(struct SidebarFunctionData *fdata,
                                     const struct KeyEvent *event)
{
  return FR_SUCCESS;
}

static void sidebar_matcher_cb(const char *text, void *data)
{
  struct MuttWindow *win = data;
  struct SidebarWindowData *wdata = win->wdata;
  wdata->hil_index = -1;
  wdata->repage = true;
 
  struct SbEntry **sbep = NULL;
 
  if (text[0] == '\0')
  {
    ARRAY_FOREACH(sbep, &wdata->entries)
    {
      struct SbEntry *sbe = *sbep;
      sbe->mailbox->visible = true;
      sbe->score = -1;
      if (wdata->hil_index == -1)
        wdata->hil_index = ARRAY_FOREACH_IDX_sbep;
    }
    wdata->win->actions |= WA_RECALC;
    return;
  }
 
  struct FuzzyOptions opts = { .smart_case = true };
  struct FuzzyResult result = { 0 };
  int best_score = -1;
  int best_index = -1;
  struct Buffer *buf = buf_pool_get();
 
  ARRAY_FOREACH(sbep, &wdata->entries)
  {
    struct SbEntry *sbe = *sbep;
    buf_printf(buf, "%s %s", sbe->box, sbe->display);
    int score = fuzzy_match(text, buf_string(buf), FUZZY_ALGO_SUBSEQ, &opts, &result);
    if (score > 0)
    {
      // Extra 2 points for new (unseen) mail
      //       1 point  for old (seen)   mail
      score += (2 * sbe->mailbox->msg_new);
      score += (sbe->mailbox->msg_unread - sbe->mailbox->msg_new);
    }
    sbe->score = score;
    if (score >= 0)
    {
      if ((best_score == -1) || (score > best_score))
      {
        best_score = score;
        best_index = ARRAY_FOREACH_IDX_sbep;
      }
      sbe->mailbox->visible = true;
    }
    else
    {
      sbe->mailbox->visible = false;
    }
  }
 
  if (best_index != -1)
    wdata->hil_index = best_index;
 
  wdata->win->actions |= WA_RECALC;
  buf_pool_release(&buf);
}

static int op_sidebar_abort_search(struct SidebarFunctionData *fdata,
                                   const struct KeyEvent *event)
{
  struct SidebarWindowData *wdata = fdata->wdata;
  if (wdata->search_active)
    return FR_DONE;
  else
    return FR_NO_ACTION;
}

static int op_sidebar_start_search(struct SidebarFunctionData *fdata,
                                   const struct KeyEvent *event)
{
  struct SidebarWindowData *wdata = fdata->wdata;
  if (ARRAY_EMPTY(&wdata->entries) || (wdata->hil_index < 0))
  {
    mutt_warning(_("There are no mailboxes"));
    return FR_ERROR;
  }
 
  const bool was_visible = cs_subset_bool(fdata->n->sub, "sidebar_visible");
  if (!was_visible)
  {
    cs_subset_str_native_set(fdata->n->sub, "sidebar_visible", true, NULL);
    mutt_window_reflow(NULL);
  }
 
  struct Buffer *buf = buf_pool_get();
  int orghlidx = wdata->hil_index;
 
  struct SbEntry **sbep = NULL;
  ARRAY_FOREACH(sbep, &wdata->entries)
  {
    struct SbEntry *sbe = *sbep;
    if (sbe->box[0] == '\0')
      sb_entry_set_display_name(sbe);
  }
 
  int rc = FR_NO_ACTION;
  wdata->search_active = true;
 
  if (mw_get_field_notify(_("Sidebar search: "), buf, MUTT_COMP_UNBUFFERED,
                          HC_NONE, NULL, NULL, sidebar_matcher_cb, wdata->win,
                          fdata->mod_data->md_sidebar, sb_function_dispatcher) != 0)
  {
    wdata->hil_index = orghlidx;
    goto done;
  }
 
  if (!buf || buf_is_empty(buf) || (wdata->hil_index == -1))
  {
    wdata->hil_index = orghlidx;
    goto done;
  }
 
  ARRAY_FOREACH(sbep, &wdata->entries)
  {
    struct SbEntry *sbe = *sbep;
    sbe->score = -1;
  }
  rc = FR_SUCCESS;
 
done:
  ARRAY_FOREACH(sbep, &wdata->entries)
  {
    (*sbep)->mailbox->visible = true;
  }
  wdata->search_active = false;
  wdata->repage = false;
  wdata->win->actions |= WA_RECALC;
 
  if (rc == FR_SUCCESS)
  {
    struct MuttWindow *dlg = dialog_find(wdata->win);
    index_change_folder(dlg, sb_get_highlight(wdata->win));
  }
 
  if (!was_visible)
  {
    cs_subset_str_native_set(fdata->n->sub, "sidebar_visible", false, NULL);
    mutt_window_reflow(NULL);
  }
 
  buf_pool_release(&buf);
  return rc;
}
 
// -----------------------------------------------------------------------------

static const struct SidebarFunction SidebarFunctions[] = {
  // clang-format off
  { OP_SIDEBAR_FIRST,          op_sidebar_first },
  { OP_SIDEBAR_LAST,           op_sidebar_last },
  { OP_SIDEBAR_NEXT,           op_sidebar_next },
  { OP_SIDEBAR_NEXT_NEW,       op_sidebar_next_new },
  { OP_SIDEBAR_OPEN,           op_sidebar_open },
  { OP_SIDEBAR_PAGE_DOWN,      op_sidebar_page_down },
  { OP_SIDEBAR_PAGE_UP,        op_sidebar_page_up },
  { OP_SIDEBAR_PREV,           op_sidebar_prev },
  { OP_SIDEBAR_PREV_NEW,       op_sidebar_prev_new },
  { OP_SIDEBAR_TOGGLE_VIRTUAL, op_sidebar_toggle_virtual },
  { OP_SIDEBAR_TOGGLE_VISIBLE, op_sidebar_toggle_visible },
  { OP_SIDEBAR_ABORT_SEARCH,   op_sidebar_abort_search },
  { OP_SIDEBAR_START_SEARCH,   op_sidebar_start_search },
  { 0, NULL },
  // clang-format on
};

int sb_function_dispatcher(struct MuttWindow *win, const struct KeyEvent *event)
{
  if (!event || !win || !win->wdata)
    return FR_UNKNOWN;
 
  const int op = event->op;
 
  struct SidebarModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_SIDEBAR);
 
  struct SidebarFunctionData fdata = {
    .n = NeoMutt,
    .mod_data = mod_data,
    .wdata = win->wdata,
  };
 
  int rc = FR_UNKNOWN;
  for (size_t i = 0; SidebarFunctions[i].op != OP_NULL; i++)
  {
    const struct SidebarFunction *fn = &SidebarFunctions[i];
    if (fn->op == op)
    {
      rc = fn->function(&fdata, event);
      break;
    }
  }
 
  if (rc == FR_UNKNOWN) // Not our function
    return rc;
 
  const char *result = dispatcher_get_retval_name(rc);
  mutt_debug(LL_DEBUG1, "Handled %s (%d) -> %s\n", opcodes_get_name(op), op, NONULL(result));
 
  dispatcher_flush_on_error(rc);
  return rc;
}