functions.c File Reference

Sidebar functions. More...

#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 dependency graph for functions.c:

Go to the source code of this file.

Functions
void	sidebar_init_keys (struct SubMenu *sm_generic)
	Initialise the Sidebar Keybindings - Implements ::init_keys_api.
struct SubMenu *	sidebar_get_submenu (void)
	Get the Sidebar SubMenu.
bool	sb_next (struct SidebarWindowData *wdata)
	Find the next unhidden Mailbox.
static struct SbEntry **	sb_next_new (struct SidebarWindowData *wdata, size_t begin, size_t end)
	Return the next mailbox with new messages.
bool	sb_prev (struct SidebarWindowData *wdata)
	Find the previous unhidden Mailbox.
static struct SbEntry **	sb_prev_new (struct SidebarWindowData *wdata, size_t begin, size_t end)
	Return the previous mailbox with new messages.
static int	op_sidebar_first (struct SidebarWindowData *wdata, const struct KeyEvent *event)
	Selects the first unhidden mailbox - Implements sidebar_function_t -.
static int	op_sidebar_last (struct SidebarWindowData *wdata, const struct KeyEvent *event)
	Selects the last unhidden mailbox - Implements sidebar_function_t -.
static int	op_sidebar_next (struct SidebarWindowData *wdata, const struct KeyEvent *event)
	Selects the next unhidden mailbox - Implements sidebar_function_t -.
static int	op_sidebar_next_new (struct SidebarWindowData *wdata, const struct KeyEvent *event)
	Selects the next new mailbox - Implements sidebar_function_t -.
static int	op_sidebar_open (struct SidebarWindowData *wdata, const struct KeyEvent *event)
	Open highlighted mailbox - Implements sidebar_function_t -.
static int	op_sidebar_page_down (struct SidebarWindowData *wdata, 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 SidebarWindowData *wdata, const struct KeyEvent *event)
	Selects the last entry in the previous page of mailboxes - Implements sidebar_function_t -.
static int	op_sidebar_prev (struct SidebarWindowData *wdata, const struct KeyEvent *event)
	Selects the previous unhidden mailbox - Implements sidebar_function_t -.
static int	op_sidebar_prev_new (struct SidebarWindowData *wdata, const struct KeyEvent *event)
	Selects the previous new mailbox - Implements sidebar_function_t -.
static int	op_sidebar_toggle_visible (struct SidebarWindowData *wdata, const struct KeyEvent *event)
	Make the sidebar (in)visible - Implements sidebar_function_t -.
static int	op_sidebar_toggle_virtual (struct SidebarWindowData *wdata, const struct KeyEvent *event)
	Deprecated - Implements sidebar_function_t -.
static void	sidebar_matcher_cb (const char *text, void *data)
	React to keys as they are entered - Implements get_field_callback_t.
static int	op_sidebar_abort_search (struct SidebarWindowData *wdata, const struct KeyEvent *event)
	Close the Sidebar Search - Implements sidebar_function_t -.
static int	op_sidebar_start_search (struct SidebarWindowData *wdata, const struct KeyEvent *event)
	Selects the last unhidden mailbox - Implements sidebar_function_t -.
int	sb_function_dispatcher (struct MuttWindow *win, const struct KeyEvent *event)
	Perform a Sidebar function - Implements function_dispatcher_t -.

Variables
struct MenuDefinition *	MdSidebar = NULL
	Sidebar Menu Definition.
struct SubMenu *	SmSidebar = NULL
	Sidebar functions.
static const struct MenuFuncOp	OpSidebar []
	Functions for the Sidebar Window.
const struct MenuOpSeq	SidebarDefaultBindings []
	Key bindings for the Sidebar Window.
static const struct SidebarFunction	SidebarFunctions []
	All the NeoMutt functions that the Sidebar supports.

Detailed Description

Sidebar functions.

Authors

• Pietro Cerutti
• Richard Russon

Copyright

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Definition in file functions.c.

Function Documentation

sidebar_init_keys()

void sidebar_init_keys

(

struct SubMenu *

sm_generic

)

Initialise the Sidebar Keybindings - Implements ::init_keys_api.

Definition at line 87 of file functions.c.

{
  struct MenuDefinition *md = NULL;
  struct SubMenu *sm = NULL;
 
  sm = km_register_submenu(OpSidebar);
  md = km_register_menu(MENU_SIDEBAR, "sidebar");
  km_menu_add_submenu(md, sm);
  km_menu_add_submenu(md, SmEditor);
  km_menu_add_bindings(md, SidebarDefaultBindings);
 
  MdSidebar = md;
  SmSidebar = sm;
}

Here is the call graph for this function:

Here is the caller graph for this function:

sidebar_get_submenu()

struct SubMenu * sidebar_get_submenu

(

void

)

Get the Sidebar SubMenu.

Return values

ptr	Sidebar SubMenu

Definition at line 106 of file functions.c.

{
  return SmSidebar;
}

Here is the caller graph for this function:

sb_next()

bool sb_next

(

struct SidebarWindowData *

wdata

)

Find the next unhidden Mailbox.

Parameters

wdata

Sidebar data

Return values

true	Mailbox found

Definition at line 116 of file functions.c.

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

Here is the caller graph for this function:

sb_next_new()

static struct SbEntry ** sb_next_new ( struct SidebarWindowData * wdata, size_t begin, size_t end )

static

Return the next mailbox with new messages.

Parameters

wdata	Sidebar data
begin	Starting index for searching
end	Ending index for searching

Return values

ptr	Pointer to the first entry with new messages
NULL	None could be found

Definition at line 139 of file functions.c.

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

Here is the caller graph for this function:

sb_prev()

bool sb_prev

(

struct SidebarWindowData *

wdata

)

Find the previous unhidden Mailbox.

Parameters

wdata

Sidebar data

Return values

true	Mailbox found

Definition at line 155 of file functions.c.

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

Here is the caller graph for this function:

sb_prev_new()

static struct SbEntry ** sb_prev_new ( struct SidebarWindowData * wdata, size_t begin, size_t end )

static

Return the previous mailbox with new messages.

Parameters

wdata	Sidebar data
begin	Starting index for searching
end	Ending index for searching

Return values

ptr	Pointer to the first entry with new messages
NULL	None could be found

Definition at line 181 of file functions.c.

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

Here is the caller graph for this function:

sidebar_matcher_cb()

static void sidebar_matcher_cb ( const char * text, void * data )

static

React to keys as they are entered - Implements get_field_callback_t.

Definition at line 424 of file functions.c.

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

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

MdSidebar

struct MenuDefinition* MdSidebar = NULL

Sidebar Menu Definition.

Definition at line 48 of file functions.c.

SmSidebar

struct SubMenu* SmSidebar = NULL

Sidebar functions.

Definition at line 51 of file functions.c.

OpSidebar

const struct MenuFuncOp OpSidebar[]

static

Initial value:

= { 
  { "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 },
}

Functions for the Sidebar Window.

Definition at line 57 of file functions.c.

                                             { /* 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 },
};

SidebarDefaultBindings

const struct MenuOpSeq SidebarDefaultBindings[]

Initial value:

= {
  { OP_SIDEBAR_NEXT,         "<down>" },
  { OP_SIDEBAR_PREV,         "<up>"   },
  { 0, NULL },
}

Key bindings for the Sidebar Window.

Definition at line 77 of file functions.c.

                                                  {
  { OP_SIDEBAR_NEXT,         "<down>" },
  { OP_SIDEBAR_PREV,         "<up>"   },
  { 0, NULL },
};

SidebarFunctions

const struct SidebarFunction SidebarFunctions[]

static

Initial value:

= {
  
  { 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 },
  
}

All the NeoMutt functions that the Sidebar supports.

Definition at line 583 of file functions.c.

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