functions.c File Reference

Sidebar functions. More...

#include "config.h"
#include <stdbool.h>
#include <stddef.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 "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)
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 -.
int	sb_function_dispatcher (struct MuttWindow *win, const struct KeyEvent *event)
	Perform a Sidebar function - Implements function_dispatcher_t -.

Variables
static struct SubMenu *	SmSidebar = NULL
	Sidebar functions.
static const struct MenuFuncOp	OpSidebar []
	Functions 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 70 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);
 
  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

)

Definition at line 82 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 92 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 115 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 131 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 157 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:

Variable Documentation

SmSidebar

struct SubMenu* SmSidebar = NULL

static

Sidebar functions.

Definition at line 45 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-toggle-virtual", OP_SIDEBAR_TOGGLE_VIRTUAL },
  { "sidebar-toggle-visible", OP_SIDEBAR_TOGGLE_VISIBLE },
  { NULL, 0 },
}

Functions for the Sidebar Window.

Definition at line 51 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-toggle-virtual", OP_SIDEBAR_TOGGLE_VIRTUAL },
  { "sidebar-toggle-visible", OP_SIDEBAR_TOGGLE_VISIBLE },
  { NULL, 0 },
};

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 },
  { 0, NULL },
  
}

All the NeoMutt functions that the Sidebar supports.

Definition at line 402 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 },
  { 0, NULL },
  // clang-format on
};