Sidebar Function API

Prototype for a Sidebar Function. More...

Collaboration diagram for Sidebar Function API:

Functions
int	op_sidebar_start_search (struct SidebarFunctionData *fdata, const struct KeyEvent *event)
	Selects the last unhidden mailbox - Implements sidebar_function_t -.
int	op_sidebar_first (struct SidebarFunctionData *fdata, const struct KeyEvent *event)
	Selects the first unhidden mailbox - Implements sidebar_function_t -.
static int	op_sidebar_select_entry_by_number (struct SidebarFunctionData *fdata, const struct KeyEvent *event)
	Jump to a specific mailbox - Implements sidebar_function_t -.
int	op_sidebar_last (struct SidebarFunctionData *fdata, const struct KeyEvent *event)
	Selects the last unhidden mailbox - Implements sidebar_function_t -.
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 -.
int	op_sidebar_open (struct SidebarFunctionData *fdata, const struct KeyEvent *event)
	Open highlighted mailbox - Implements sidebar_function_t -.
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_select_page_top (struct SidebarFunctionData *fdata, const struct KeyEvent *event)
	Selects the entry at the top of the visible page - Implements sidebar_function_t -.
static int	op_sidebar_select_page_middle (struct SidebarFunctionData *fdata, const struct KeyEvent *event)
	Selects the entry at the middle of the visible page - Implements sidebar_function_t -.
static int	op_sidebar_select_page_bottom (struct SidebarFunctionData *fdata, const struct KeyEvent *event)
	Selects the entry at the bottom of the visible page - Implements sidebar_function_t -.
static int	op_sidebar_scroll_half_down (struct SidebarFunctionData *fdata, const struct KeyEvent *event)
	Scrolls down by half a page - Implements sidebar_function_t -.
static int	op_sidebar_scroll_half_up (struct SidebarFunctionData *fdata, const struct KeyEvent *event)
	Scrolls up by half a page - Implements sidebar_function_t -.
static int	op_sidebar_scroll_line_down (struct SidebarFunctionData *fdata, const struct KeyEvent *event)
	Scrolls down by one line - Implements sidebar_function_t -.
static int	op_sidebar_scroll_line_up (struct SidebarFunctionData *fdata, const struct KeyEvent *event)
	Scrolls up by one line - Implements sidebar_function_t -.
int	op_sidebar_scroll_page_down (struct SidebarFunctionData *fdata, const struct KeyEvent *event)
	Scrolls down by one page - Implements sidebar_function_t -.
int	op_sidebar_scroll_page_up (struct SidebarFunctionData *fdata, const struct KeyEvent *event)
	Scrolls up by one page - Implements sidebar_function_t -.
static int	op_sidebar_scroll_selection_to_top (struct SidebarFunctionData *fdata, const struct KeyEvent *event)
	Scrolls so the selection is at the top of the screen - Implements sidebar_function_t -.
static int	op_sidebar_scroll_selection_to_middle (struct SidebarFunctionData *fdata, const struct KeyEvent *event)
	Scrolls so the selection is at the middle of the screen - Implements sidebar_function_t -.
static int	op_sidebar_scroll_selection_to_bottom (struct SidebarFunctionData *fdata, const struct KeyEvent *event)
	Scrolls so the selection is at the bottom of the screen - 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 -.

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_start_search()

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

Selects the last unhidden mailbox - Implements sidebar_function_t -.

Definition at line 185 of file functions_fuzzy.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 MenuDefinition *md = NULL;
  struct Buffer *buf = buf_pool_get();
  const int old_hil_index = 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;
 
  md = sb_fuzzy_init_menu();
 
  if (mw_get_field_notify(_("Sidebar search: "), buf, MUTT_COMP_UNBUFFERED,
                          HC_NONE, NULL, NULL, sidebar_matcher_cb, wdata->win,
                          md, sb_fuzzy_function_dispatcher) != 0)
  {
    wdata->hil_index = old_hil_index;
    goto done;
  }
 
  if (!buf || buf_is_empty(buf) || (wdata->hil_index == wdata->opn_index))
  {
    wdata->hil_index = old_hil_index;
    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);
  }
 
  menudef_free(&md);
  buf_pool_release(&buf);
  return rc;
}

Here is the call graph for this function:

op_sidebar_first()

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

Selects the first unhidden mailbox - Implements sidebar_function_t -.

Definition at line 412 of file functions_sidebar.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_select_entry_by_number()

int op_sidebar_select_entry_by_number ( struct SidebarFunctionData * fdata, const struct KeyEvent * event )

static

Jump to a specific mailbox - Implements sidebar_function_t -.

Definition at line 438 of file functions_sidebar.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))
  {
    mutt_error(_("There are no mailboxes"));
    return FR_ERROR;
  }
 
  const int count = ARRAY_SIZE(&wdata->entries);
  struct Buffer *buf = buf_pool_get();
  int rc = FR_ERROR;
 
  int num = event->count;
  if (num == 0)
  {
    if ((mw_get_field(_("Jump to: "), buf, MUTT_COMP_NONE, HC_OTHER, NULL, NULL) != 0) ||
        buf_is_empty(buf))
    {
      rc = FR_NO_ACTION;
      goto done;
    }
 
    if (!mutt_str_atoi_full(buf_string(buf), &num))
    {
      mutt_error(_("Invalid index number"));
      goto done;
    }
  }
 
  if ((num < 1) || (num > count))
  {
    mutt_error(_("Invalid index number"));
    goto done;
  }
 
  if ((num - 1) == wdata->hil_index)
  {
    rc = FR_NO_ACTION;
    goto done;
  }
 
  wdata->hil_index = num - 1; // entry numbers are 1-based
  wdata->win->actions |= WA_RECALC;
  rc = op_sidebar_open(fdata, event);
 
done:
  buf_pool_release(&buf);
  return rc;
}

Here is the call graph for this function:

op_sidebar_last()

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

Selects the last unhidden mailbox - Implements sidebar_function_t -.

Definition at line 496 of file functions_sidebar.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()

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

Selects the next unhidden mailbox - Implements sidebar_function_t -.

Definition at line 521 of file functions_sidebar.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()

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 554 of file functions_sidebar.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()

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

Open highlighted mailbox - Implements sidebar_function_t -.

Definition at line 592 of file functions_sidebar.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:

Here is the caller graph for this function:

op_sidebar_prev()

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

Selects the previous unhidden mailbox - Implements sidebar_function_t -.

Definition at line 607 of file functions_sidebar.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()

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 640 of file functions_sidebar.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_select_page_top()

int op_sidebar_select_page_top ( struct SidebarFunctionData * fdata, const struct KeyEvent * event )

static

Selects the entry at the top of the visible page - Implements sidebar_function_t -.

Definition at line 679 of file functions_sidebar.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) || (wdata->top_index < 0))
    return FR_NO_ACTION;
 
  const int index = sb_screen_row_index(wdata, 0);
  if ((index < 0) || (index == wdata->hil_index))
    return FR_NO_ACTION;
 
  wdata->hil_index = index;
  wdata->win->actions |= WA_RECALC;
  return FR_SUCCESS;
}

Here is the call graph for this function:

op_sidebar_select_page_middle()

int op_sidebar_select_page_middle ( struct SidebarFunctionData * fdata, const struct KeyEvent * event )

static

Selects the entry at the middle of the visible page - Implements sidebar_function_t -.

Definition at line 701 of file functions_sidebar.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) || (wdata->top_index < 0))
    return FR_NO_ACTION;
 
  const int index = sb_screen_row_index(wdata, wdata->win->state.rows / 2);
  if ((index < 0) || (index == wdata->hil_index))
    return FR_NO_ACTION;
 
  wdata->hil_index = index;
  wdata->win->actions |= WA_RECALC;
  return FR_SUCCESS;
}

Here is the call graph for this function:

op_sidebar_select_page_bottom()

int op_sidebar_select_page_bottom ( struct SidebarFunctionData * fdata, const struct KeyEvent * event )

static

Selects the entry at the bottom of the visible page - Implements sidebar_function_t -.

Definition at line 723 of file functions_sidebar.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) || (wdata->top_index < 0))
    return FR_NO_ACTION;
 
  const int index = sb_screen_row_index(wdata, wdata->win->state.rows - 1);
  if ((index < 0) || (index == wdata->hil_index))
    return FR_NO_ACTION;
 
  wdata->hil_index = index;
  wdata->win->actions |= WA_RECALC;
  return FR_SUCCESS;
}

Here is the call graph for this function:

op_sidebar_scroll_half_down()

int op_sidebar_scroll_half_down ( struct SidebarFunctionData * fdata, const struct KeyEvent * event )

static

Scrolls down by half a page - Implements sidebar_function_t -.

Definition at line 745 of file functions_sidebar.c.

{
  const int half_page = MAX(fdata->wdata->win->state.rows / 2, 1);
  return sb_scroll_view(fdata, MAX(event->count, 1) * half_page);
}

Here is the call graph for this function:

op_sidebar_scroll_half_up()

int op_sidebar_scroll_half_up ( struct SidebarFunctionData * fdata, const struct KeyEvent * event )

static

Scrolls up by half a page - Implements sidebar_function_t -.

Definition at line 755 of file functions_sidebar.c.

{
  const int half_page = MAX(fdata->wdata->win->state.rows / 2, 1);
  return sb_scroll_view(fdata, 0 - MAX(event->count, 1) * half_page);
}

Here is the call graph for this function:

op_sidebar_scroll_line_down()

int op_sidebar_scroll_line_down ( struct SidebarFunctionData * fdata, const struct KeyEvent * event )

static

Scrolls down by one line - Implements sidebar_function_t -.

Definition at line 765 of file functions_sidebar.c.

{
  return sb_scroll_view(fdata, MAX(event->count, 1));
}

Here is the call graph for this function:

op_sidebar_scroll_line_up()

int op_sidebar_scroll_line_up ( struct SidebarFunctionData * fdata, const struct KeyEvent * event )

static

Scrolls up by one line - Implements sidebar_function_t -.

Definition at line 774 of file functions_sidebar.c.

{
  return sb_scroll_view(fdata, 0 - MAX(event->count, 1));
}

Here is the call graph for this function:

op_sidebar_scroll_page_down()

int op_sidebar_scroll_page_down	(	struct SidebarFunctionData *	fdata,
		const struct KeyEvent *	event )

Scrolls down by one page - Implements sidebar_function_t -.

Definition at line 783 of file functions_sidebar.c.

{
  const int page = MAX(fdata->wdata->win->state.rows, 1);
  return sb_scroll_view(fdata, MAX(event->count, 1) * page);
}

Here is the call graph for this function:

op_sidebar_scroll_page_up()

int op_sidebar_scroll_page_up	(	struct SidebarFunctionData *	fdata,
		const struct KeyEvent *	event )

Scrolls up by one page - Implements sidebar_function_t -.

Definition at line 792 of file functions_sidebar.c.

{
  const int page = MAX(fdata->wdata->win->state.rows, 1);
  return sb_scroll_view(fdata, 0 - MAX(event->count, 1) * page);
}

Here is the call graph for this function:

op_sidebar_scroll_selection_to_top()

int op_sidebar_scroll_selection_to_top ( struct SidebarFunctionData * fdata, const struct KeyEvent * event )

static

Scrolls so the selection is at the top of the screen - Implements sidebar_function_t -.

Definition at line 827 of file functions_sidebar.c.

{
  return sb_scroll_selection_to_row(fdata, 0);
}

Here is the call graph for this function:

op_sidebar_scroll_selection_to_middle()

int op_sidebar_scroll_selection_to_middle ( struct SidebarFunctionData * fdata, const struct KeyEvent * event )

static

Scrolls so the selection is at the middle of the screen - Implements sidebar_function_t -.

Definition at line 836 of file functions_sidebar.c.

{
  return sb_scroll_selection_to_row(fdata, fdata->wdata->win->state.rows / 2);
}

Here is the call graph for this function:

op_sidebar_scroll_selection_to_bottom()

int op_sidebar_scroll_selection_to_bottom ( struct SidebarFunctionData * fdata, const struct KeyEvent * event )

static

Scrolls so the selection is at the bottom of the screen - Implements sidebar_function_t -.

Definition at line 845 of file functions_sidebar.c.

{
  return sb_scroll_selection_to_row(fdata, fdata->wdata->win->state.rows - 1);
}

Here is the call graph for this function:

op_sidebar_toggle_visible()

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 854 of file functions_sidebar.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()

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

static

Deprecated - Implements sidebar_function_t -.

Definition at line 865 of file functions_sidebar.c.

{
  return FR_SUCCESS;
}