private.h File Reference

GUI display the mailboxes in a side panel. More...

#include <stdbool.h>
#include "mutt/lib.h"
#include "email/lib.h"
#include "core/lib.h"

Include dependency graph for private.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	SbEntry
	Info about folders in the sidebar. More...
struct	SidebarWindowData
	Sidebar private Window data -. More...

Enumerations
enum	ExpandoDataSidebar {   ED_SID_DELETED_COUNT = 1 , ED_SID_DESCRIPTION , ED_SID_FLAGGED , ED_SID_FLAGGED_COUNT ,   ED_SID_LIMITED_COUNT , ED_SID_MESSAGE_COUNT , ED_SID_NAME , ED_SID_FUZZY_SCORE ,   ED_SID_NEW_MAIL , ED_SID_NOTIFY , ED_SID_OLD_COUNT , ED_SID_POLL ,   ED_SID_READ_COUNT , ED_SID_TAGGED_COUNT , ED_SID_UNREAD_COUNT , ED_SID_UNSEEN_COUNT }
	Expando UIDs for the Sidebar. More...
enum	DivType { SB_DIV_USER , SB_DIV_ASCII }
	Source of the sidebar divider character. More...

Functions
	ARRAY_HEAD (SbEntryArray, struct SbEntry *)
void	sb_add_mailbox (struct SidebarWindowData *wdata, struct Mailbox *m)
	Add a Mailbox to the Sidebar.
void	sb_remove_mailbox (struct SidebarWindowData *wdata, const struct Mailbox *m)
	Remove a Mailbox from the Sidebar.
void	sb_set_current_mailbox (struct SidebarWindowData *wdata, struct Mailbox *m)
	Set the current Mailbox.
struct Mailbox *	sb_get_highlight (struct MuttWindow *win)
	Get the Mailbox that's highlighted in the sidebar.
enum CommandResult	parse_sidebar_unpin (const struct Command *cmd, struct Buffer *line, const struct ParseContext *pc, struct ParseError *pe)
	Parse the 'sidebar-unpin' command - Implements Command::parse() -.
enum CommandResult	parse_sidebar_pin (const struct Command *cmd, struct Buffer *line, const struct ParseContext *pc, struct ParseError *pe)
	Parse the 'sidebar-pin' command - Implements Command::parse() -.
bool	sb_next (struct SidebarWindowData *wdata)
	Find the next unhidden Mailbox.
bool	sb_prev (struct SidebarWindowData *wdata)
	Find the previous unhidden Mailbox.
int	sb_insertion_window_observer (struct NotifyCallback *nc)
	Notification that a Window has changed - Implements observer_t -.
void	sb_win_add_observers (struct MuttWindow *win)
	Add Observers to the Sidebar Window.
void	sb_sort_entries (struct SidebarWindowData *wdata, enum EmailSortType sort)
	Sort the Sidebar entries.
void	sb_wdata_free (struct MuttWindow *win, void **ptr)
	Free Sidebar Window data - Implements MuttWindow::wdata_free() -.
struct SidebarWindowData *	sb_wdata_get (struct MuttWindow *win)
	Get the Sidebar data for this window.
struct SidebarWindowData *	sb_wdata_new (struct MuttWindow *win, struct IndexSharedData *shared)
	Create new Window data for the Sidebar.
void	sb_entry_set_display_name (struct SbEntry *entry)
	Set the display name for an SbEntry.
int	sb_recalc (struct MuttWindow *win)
	Recalculate the Sidebar display - Implements MuttWindow::recalc() -.
int	sb_repaint (struct MuttWindow *win)
	Repaint the Sidebar display - Implements MuttWindow::repaint() -.

Variables
struct ListHead	SidebarPinned
	List of mailboxes to always display in the sidebar.

Detailed Description

GUI display the mailboxes in a side panel.

Authors

• 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 private.h.

Enumeration Type Documentation

ExpandoDataSidebar

enum ExpandoDataSidebar

Expando UIDs for the Sidebar.

See also

ED_SIDEBAR, ExpandoDomain

Enumerator
ED_SID_DELETED_COUNT	Mailbox.msg_deleted.
ED_SID_DESCRIPTION	Mailbox.name.
ED_SID_FLAGGED	Mailbox.msg_flagged.
ED_SID_FLAGGED_COUNT	Mailbox.msg_flagged.
ED_SID_LIMITED_COUNT	Mailbox.vcount.
ED_SID_MESSAGE_COUNT	Mailbox.msg_count.
ED_SID_NAME	SbEntry.box.
ED_SID_FUZZY_SCORE	SbEntry.score.
ED_SID_NEW_MAIL	Mailbox.has_new.
ED_SID_NOTIFY	Mailbox.notify_user.
ED_SID_OLD_COUNT	Mailbox.msg_unread, Mailbox.msg_new.
ED_SID_POLL	Mailbox.poll_new_mail.
ED_SID_READ_COUNT	Mailbox.msg_count, Mailbox.msg_unread.
ED_SID_TAGGED_COUNT	Mailbox.msg_tagged.
ED_SID_UNREAD_COUNT	Mailbox.msg_unread.
ED_SID_UNSEEN_COUNT	Mailbox.msg_new.

Definition at line 58 of file private.h.

{
  ED_SID_DELETED_COUNT = 1,    
  ED_SID_DESCRIPTION,          
  ED_SID_FLAGGED,              
  ED_SID_FLAGGED_COUNT,        
  ED_SID_LIMITED_COUNT,        
  ED_SID_MESSAGE_COUNT,        
  ED_SID_NAME,                 
  ED_SID_FUZZY_SCORE,          
  ED_SID_NEW_MAIL,             
  ED_SID_NOTIFY,               
  ED_SID_OLD_COUNT,            
  ED_SID_POLL,                 
  ED_SID_READ_COUNT,           
  ED_SID_TAGGED_COUNT,         
  ED_SID_UNREAD_COUNT,         
  ED_SID_UNSEEN_COUNT,         
};

DivType

enum DivType

Source of the sidebar divider character.

Enumerator
SB_DIV_USER	User configured using $sidebar_divider_char.
SB_DIV_ASCII	An ASCII vertical bar (pipe)

Definition at line 81 of file private.h.

{
  SB_DIV_USER,  
  SB_DIV_ASCII, 
};

Function Documentation

ARRAY_HEAD()

ARRAY_HEAD	(	SbEntryArray	,
		struct SbEntry *	)

sb_add_mailbox()

void sb_add_mailbox	(	struct SidebarWindowData *	wdata,
		struct Mailbox *	m )

Add a Mailbox to the Sidebar.

Parameters

wdata	Sidebar data
m	Mailbox to add

The Sidebar will be re-sorted, and the indices updated, when sb_recalc() is called.

Definition at line 100 of file sidebar.c.

{
  if (!m)
    return;
 
  struct SbEntry **sbep = NULL;
  ARRAY_FOREACH(sbep, &wdata->entries)
  {
    if ((*sbep)->mailbox == m)
      return;
  }
 
  /* Any new/deleted mailboxes will cause a refresh.  As long as
   * they're valid, our pointers will be updated in prepare_sidebar() */
 
  struct IndexSharedData *shared = wdata->shared;
  struct SbEntry *entry = MUTT_MEM_CALLOC(1, struct SbEntry);
  entry->mailbox = m;
  entry->score = -1;
 
  if (wdata->top_index < 0)
    wdata->top_index = ARRAY_SIZE(&wdata->entries);
  if (wdata->bot_index < 0)
    wdata->bot_index = ARRAY_SIZE(&wdata->entries);
  if ((wdata->opn_index < 0) && shared->mailbox &&
      mutt_str_equal(m->realpath, shared->mailbox->realpath))
  {
    wdata->opn_index = ARRAY_SIZE(&wdata->entries);
  }
 
  ARRAY_ADD(&wdata->entries, entry);
}

Here is the call graph for this function:

Here is the caller graph for this function:

sb_remove_mailbox()

void sb_remove_mailbox	(	struct SidebarWindowData *	wdata,
		const struct Mailbox *	m )

Remove a Mailbox from the Sidebar.

Parameters

wdata	Sidebar data
m	Mailbox to remove

Definition at line 138 of file sidebar.c.

{
  struct SbEntry **sbep = NULL;
  ARRAY_FOREACH(sbep, &wdata->entries)
  {
    if ((*sbep)->mailbox != m)
      continue;
 
    struct SbEntry *sbe_remove = *sbep;
    ARRAY_REMOVE(&wdata->entries, sbep);
    FREE(&sbe_remove);
 
    if (wdata->opn_index == ARRAY_FOREACH_IDX_sbep)
    {
      // Open item was deleted
      wdata->opn_index = -1;
    }
    else if ((wdata->opn_index > 0) && (wdata->opn_index > ARRAY_FOREACH_IDX_sbep))
    {
      // Open item is still visible, so adjust the index
      wdata->opn_index--;
    }
 
    if (wdata->hil_index == ARRAY_FOREACH_IDX_sbep)
    {
      // If possible, keep the highlight where it is
      struct SbEntry **sbep_cur = ARRAY_GET(&wdata->entries, ARRAY_FOREACH_IDX_sbep);
      if (!sbep_cur)
      {
        // The last entry was deleted, so backtrack
        sb_prev(wdata);
      }
      else if ((*sbep_cur)->is_hidden)
      {
        // Find the next unhidden entry, or the previous
        if (!sb_next(wdata) && !sb_prev(wdata))
          wdata->hil_index = -1;
      }
    }
    else if ((wdata->hil_index > 0) && (wdata->hil_index > ARRAY_FOREACH_IDX_sbep))
    {
      // Highlighted item is still visible, so adjust the index
      wdata->hil_index--;
    }
    break;
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

sb_set_current_mailbox()

void sb_set_current_mailbox	(	struct SidebarWindowData *	wdata,
		struct Mailbox *	m )

Set the current Mailbox.

Parameters

wdata	Sidebar data
m	Mailbox

Definition at line 191 of file sidebar.c.

{
  wdata->opn_index = -1;
 
  struct SbEntry **sbep = NULL;
  ARRAY_FOREACH(sbep, &wdata->entries)
  {
    if (m && m->visible)
    {
      if (mutt_str_equal((*sbep)->mailbox->realpath, m->realpath))
      {
        wdata->opn_index = ARRAY_FOREACH_IDX_sbep;
        wdata->hil_index = ARRAY_FOREACH_IDX_sbep;
        break;
      }
    }
    (*sbep)->is_hidden = !(*sbep)->mailbox->visible;
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

sb_get_highlight()

struct Mailbox * sb_get_highlight

(

struct MuttWindow *

win

)

Get the Mailbox that's highlighted in the sidebar.

Parameters

win	Sidebar Window

Return values

ptr

Mailbox

Definition at line 75 of file sidebar.c.

{
  const bool c_sidebar_visible = cs_subset_bool(NeoMutt->sub, "sidebar_visible");
  if (!c_sidebar_visible)
    return NULL;
 
  struct SidebarWindowData *wdata = sb_wdata_get(win);
  if (!wdata || (wdata->hil_index < 0))
    return NULL;
 
  struct SbEntry **sbep = ARRAY_GET(&wdata->entries, wdata->hil_index);
  if (!sbep)
    return NULL;
 
  return (*sbep)->mailbox;
}

Here is the call graph for this function:

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_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_win_add_observers()

void sb_win_add_observers

(

struct MuttWindow *

win

)

Add Observers to the Sidebar Window.

Parameters

win	Sidebar Window

Definition at line 442 of file observer.c.

{
  if (!win || !NeoMutt)
    return;
 
  struct MuttWindow *dlg = window_find_parent(win, WT_DLG_INDEX);
  if (!dlg)
    return;
 
  mutt_color_observer_add(sb_color_observer, win);
  notify_observer_add(NeoMutt->notify, NT_ACCOUNT, sb_account_observer, win);
  notify_observer_add(NeoMutt->notify, NT_COMMAND, sb_command_observer, win);
  notify_observer_add(NeoMutt->sub->notify, NT_CONFIG, sb_config_observer, win);
  notify_observer_add(dlg->notify, NT_INDEX, sb_index_observer, win);
  notify_observer_add(NeoMutt->notify, NT_MAILBOX, sb_mailbox_observer, win);
  notify_observer_add(win->notify, NT_WINDOW, sb_window_observer, win);
}

Here is the call graph for this function:

Here is the caller graph for this function:

sb_sort_entries()

void sb_sort_entries	(	struct SidebarWindowData *	wdata,
		enum EmailSortType	sort )

Sort the Sidebar entries.

Parameters

wdata	Sidebar data
sort	Sort order, e.g. SB_SORT_PATH

Sort the wdata->entries array according to the current sort config option $sidebar_sort. This calls qsort to do the work which calls our callback function "cb_qsort_sbe".

Once sorted, the prev/next links will be reconstructed.

Definition at line 161 of file sort.c.

{
  sort_t fn = NULL;
 
  switch (sort & SORT_MASK)
  {
    case SB_SORT_COUNT:
      fn = sb_sort_count;
      break;
    case SB_SORT_DESC:
      fn = sb_sort_desc;
      break;
    case SB_SORT_FLAGGED:
      fn = sb_sort_flagged;
      break;
    case SB_SORT_PATH:
      fn = sb_sort_path;
      break;
    case SB_SORT_UNREAD:
      fn = sb_sort_unread;
      break;
    case SB_SORT_UNSORTED:
    default:
      fn = sb_sort_unsorted;
      break;
  }
 
  bool sort_reverse = (sort & SORT_REVERSE);
  ARRAY_SORT(&wdata->entries, fn, &sort_reverse);
}

Here is the call graph for this function:

Here is the caller graph for this function:

sb_wdata_get()

struct SidebarWindowData * sb_wdata_get

(

struct MuttWindow *

win

)

Get the Sidebar data for this window.

Parameters

win

Window

Definition at line 77 of file wdata.c.

{
  if (!win || (win->type != WT_SIDEBAR))
    return NULL;
 
  return win->wdata;
}

Here is the caller graph for this function:

sb_wdata_new()

struct SidebarWindowData * sb_wdata_new	(	struct MuttWindow *	win,
		struct IndexSharedData *	shared )

Create new Window data for the Sidebar.

Parameters

win	Sidebar Window
shared	Index shared data

Return values

ptr	New Window data

Definition at line 44 of file wdata.c.

{
  struct SidebarWindowData *wdata = MUTT_MEM_CALLOC(1, struct SidebarWindowData);
  wdata->win = win;
  wdata->shared = shared;
  ARRAY_INIT(&wdata->entries);
  return wdata;
}

Here is the caller graph for this function:

sb_entry_set_display_name()

void sb_entry_set_display_name

(

struct SbEntry *

entry

)

Set the display name for an SbEntry.

Parameters

entry

SbEntry to update

Definition at line 305 of file window.c.

{
  const char *path = mailbox_path(entry->mailbox);
 
  const char *const c_folder = cs_subset_string(NeoMutt->sub, "folder");
  // Try to abbreviate the full path
  const char *abbr = abbrev_folder(path, c_folder, entry->mailbox->type);
  if (!abbr)
    abbr = abbrev_url(path, entry->mailbox->type);
  const char *short_path = abbr ? abbr : path;
 
  /* Compute the depth */
  const char *last_part = abbr;
  const char *const c_sidebar_delim_chars = cs_subset_string(NeoMutt->sub, "sidebar_delim_chars");
  entry->depth = calc_path_depth(abbr, c_sidebar_delim_chars, &last_part);
 
  const bool short_path_is_abbr = (short_path == abbr);
  const bool c_sidebar_short_path = cs_subset_bool(NeoMutt->sub, "sidebar_short_path");
  if (c_sidebar_short_path)
  {
    short_path = last_part;
  }
 
  // Don't indent if we were unable to create an abbreviation.
  // Otherwise, the full path will be indent, and it looks unusual.
  const bool c_sidebar_folder_indent = cs_subset_bool(NeoMutt->sub, "sidebar_folder_indent");
  if (c_sidebar_folder_indent && short_path_is_abbr)
  {
    const short c_sidebar_component_depth = cs_subset_number(NeoMutt->sub, "sidebar_component_depth");
    if (c_sidebar_component_depth > 0)
      entry->depth -= c_sidebar_component_depth;
  }
  else if (!c_sidebar_folder_indent)
  {
    entry->depth = 0;
  }
 
  mutt_str_copy(entry->box, short_path, sizeof(entry->box));
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

SidebarPinned

struct ListHead SidebarPinned

extern

List of mailboxes to always display in the sidebar.

Definition at line 44 of file sidebar.c.