Sidebar Function API

Prototype for a Sidebar Function. More...

Collaboration diagram for Sidebar Function API:

Functions
static int	op_sidebar_first (struct SidebarFunctionData *fdata, const struct KeyEvent *event)
	Selects the first unhidden mailbox - Implements sidebar_function_t -.
static int	op_sidebar_last (struct SidebarFunctionData *fdata, const struct KeyEvent *event)
	Selects the last unhidden mailbox - Implements sidebar_function_t -.
static int	op_sidebar_next (struct SidebarFunctionData *fdata, const struct KeyEvent *event)
	Selects the next unhidden mailbox - Implements sidebar_function_t -.
static int	op_sidebar_next_new (struct SidebarFunctionData *fdata, const struct KeyEvent *event)
	Selects the next new mailbox - Implements sidebar_function_t -.
static int	op_sidebar_open (struct SidebarFunctionData *fdata, const struct KeyEvent *event)
	Open highlighted mailbox - Implements sidebar_function_t -.
static int	op_sidebar_page_down (struct SidebarFunctionData *fdata, const struct KeyEvent *event)
	Selects the first entry in the next page of mailboxes - Implements sidebar_function_t -.
static int	op_sidebar_page_up (struct SidebarFunctionData *fdata, const struct KeyEvent *event)
	Selects the last entry in the previous page of mailboxes - Implements sidebar_function_t -.
static int	op_sidebar_prev (struct SidebarFunctionData *fdata, const struct KeyEvent *event)
	Selects the previous unhidden mailbox - Implements sidebar_function_t -.
static int	op_sidebar_prev_new (struct SidebarFunctionData *fdata, const struct KeyEvent *event)
	Selects the previous new mailbox - Implements sidebar_function_t -.
static int	op_sidebar_toggle_visible (struct SidebarFunctionData *fdata, const struct KeyEvent *event)
	Make the sidebar (in)visible - Implements sidebar_function_t -.
static int	op_sidebar_toggle_virtual (struct SidebarFunctionData *fdata, const struct KeyEvent *event)
	Deprecated - Implements sidebar_function_t -.
static int	op_sidebar_abort_search (struct SidebarFunctionData *fdata, const struct KeyEvent *event)
	Close the Sidebar Search - Implements sidebar_function_t -.
static int	op_sidebar_start_search (struct SidebarFunctionData *fdata, const struct KeyEvent *event)
	Selects the last unhidden mailbox - Implements sidebar_function_t -.

Detailed Description

Prototype for a Sidebar Function.

Parameters

fdata	Sidebar Function context data
event	Event to process

Return values

enum	FunctionRetval

Precondition

fdata is not NULL

event is not NULL

Function Documentation

op_sidebar_first()

static int op_sidebar_first ( struct SidebarFunctionData * fdata, const struct KeyEvent * event )

static

Selects the first unhidden mailbox - Implements sidebar_function_t -.

Definition at line 237 of file functions.c.

{
  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;
}

Here is the call graph for this function:

op_sidebar_last()

static int op_sidebar_last ( struct SidebarFunctionData * fdata, const struct KeyEvent * event )

static

Selects the last unhidden mailbox - Implements sidebar_function_t -.

Definition at line 263 of file functions.c.

{
  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;
}

Here is the call graph for this function:

op_sidebar_next()

static int op_sidebar_next ( struct SidebarFunctionData * fdata, const struct KeyEvent * event )

static

Selects the next unhidden mailbox - Implements sidebar_function_t -.

Definition at line 288 of file functions.c.

{
  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;
}

Here is the call graph for this function:

op_sidebar_next_new()

static int op_sidebar_next_new ( struct SidebarFunctionData * fdata, const struct KeyEvent * event )

static

Selects the next new mailbox - Implements sidebar_function_t -.

Search down the list of mail folders for one containing new mail.

Definition at line 321 of file functions.c.

{
  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;
}

Here is the call graph for this function:

op_sidebar_open()

static int op_sidebar_open ( struct SidebarFunctionData * fdata, const struct KeyEvent * event )

static

Open highlighted mailbox - Implements sidebar_function_t -.

Definition at line 359 of file functions.c.

{
  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;
}

Here is the call graph for this function:

op_sidebar_page_down()

static int op_sidebar_page_down ( struct SidebarFunctionData * fdata, const struct KeyEvent * event )

static

Selects the first entry in the next page of mailboxes - Implements sidebar_function_t -.

Definition at line 374 of file functions.c.

{
  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;
}

Here is the call graph for this function:

op_sidebar_page_up()

static int op_sidebar_page_up ( struct SidebarFunctionData * fdata, const struct KeyEvent * event )

static

Selects the last entry in the previous page of mailboxes - Implements sidebar_function_t -.

Definition at line 405 of file functions.c.

{
  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;
}

Here is the call graph for this function:

op_sidebar_prev()

static int op_sidebar_prev ( struct SidebarFunctionData * fdata, const struct KeyEvent * event )

static

Selects the previous unhidden mailbox - Implements sidebar_function_t -.

Definition at line 436 of file functions.c.

{
  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;
}

Here is the call graph for this function:

op_sidebar_prev_new()

static int op_sidebar_prev_new ( struct SidebarFunctionData * fdata, const struct KeyEvent * event )

static

Selects the previous new mailbox - Implements sidebar_function_t -.

Search up the list of mail folders for one containing new mail.

Definition at line 469 of file functions.c.

{
  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;
}

Here is the call graph for this function:

op_sidebar_toggle_visible()

static int op_sidebar_toggle_visible ( struct SidebarFunctionData * fdata, const struct KeyEvent * event )

static

Make the sidebar (in)visible - Implements sidebar_function_t -.

Definition at line 508 of file functions.c.

{
  bool_str_toggle(fdata->n->sub, "sidebar_visible", NULL);
  mutt_window_reflow(NULL);
  return FR_SUCCESS;
}

Here is the call graph for this function:

op_sidebar_toggle_virtual()

static int op_sidebar_toggle_virtual ( struct SidebarFunctionData * fdata, const struct KeyEvent * event )

static

Deprecated - Implements sidebar_function_t -.

Definition at line 519 of file functions.c.

{
  return FR_SUCCESS;
}

op_sidebar_abort_search()

static int op_sidebar_abort_search ( struct SidebarFunctionData * fdata, const struct KeyEvent * event )

static

Close the Sidebar Search - Implements sidebar_function_t -.

Close the Sidebar Search without a selection.

Definition at line 597 of file functions.c.

{
  struct SidebarWindowData *wdata = fdata->wdata;
  if (wdata->search_active)
    return FR_DONE;
  else
    return FR_NO_ACTION;
}

op_sidebar_start_search()

static int op_sidebar_start_search ( struct SidebarFunctionData * fdata, const struct KeyEvent * event )

static

Selects the last unhidden mailbox - Implements sidebar_function_t -.

Definition at line 610 of file functions.c.

{
  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;
}

Here is the call graph for this function: