private.h File Reference

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

#include <stdbool.h>
#include "mutt/lib.h"
#include "config/lib.h"
#include "gui/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	DivType { SB_DIV_USER, SB_DIV_ASCII, SB_DIV_UTF8 }
	Source of the sidebar divider character. More...

Functions
void	sb_add_mailbox (struct SidebarWindowData *wdata, struct Mailbox *m)
	Add a Mailbox to the Sidebar. More...
void	sb_remove_mailbox (struct SidebarWindowData *wdata, struct Mailbox *m)
	Remove a Mailbox from the Sidebar. More...
void	sb_set_current_mailbox (struct SidebarWindowData *wdata, struct Mailbox *m)
	Set the current Mailbox. More...
bool	select_next (struct SidebarWindowData *wdata)
	Selects the next unhidden mailbox. More...
bool	select_prev (struct SidebarWindowData *wdata)
	Selects the previous unhidden mailbox. More...
int	sb_insertion_window_observer (struct NotifyCallback *nc)
	Notification that a Window has changed - Implements observer_t. More...
void	sb_win_add_observers (struct MuttWindow *win)
	Add Observers to the Sidebar Window. More...
void	sb_sort_entries (struct SidebarWindowData *wdata, enum SortType sort)
	Sort the Sidebar entries. More...
void	sb_wdata_free (struct MuttWindow *win, void **ptr)
	Free Sidebar Window data - Implements MuttWindow::wdata_free() -. More...
struct SidebarWindowData *	sb_wdata_get (struct MuttWindow *win)
	Get the Sidebar data for this window. More...
struct SidebarWindowData *	sb_wdata_new (struct IndexSharedData *shared)
	Create new Window data for the Sidebar. More...
int	sb_recalc (struct MuttWindow *win)
	Recalculate the Sidebar display - Implements MuttWindow::recalc() -. More...
int	sb_repaint (struct MuttWindow *win)
	Repaint the Sidebar display - Implements MuttWindow::repaint() -. More...

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

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

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)
SB_DIV_UTF8	A unicode line-drawing character.

Definition at line 52 of file private.h.

{
  SB_DIV_USER,  
  SB_DIV_ASCII, 
  SB_DIV_UTF8,  
};

Function Documentation

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 84 of file sidebar.c.

{
  if (!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, sizeof(struct SbEntry));
  entry->mailbox = m;

  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,
		struct Mailbox *	m
	)

Remove a Mailbox from the Sidebar.

Parameters

wdata	Sidebar data
m	Mailbox to remove

Definition at line 114 of file sidebar.c.

{
  struct SbEntry **sbep = NULL;
  ARRAY_FOREACH(sbep, &wdata->entries)
  {
    if (mutt_str_equal((*sbep)->mailbox->realpath, m->realpath))
    {
      struct SbEntry *sbe_remove = *sbep;
      ARRAY_REMOVE(&wdata->entries, sbep);
      FREE(&sbe_remove);

      if (wdata->opn_index == ARRAY_FOREACH_IDX)
      {
        // Open item was deleted
        wdata->opn_index = -1;
      }
      else if ((wdata->opn_index > 0) && (wdata->opn_index > ARRAY_FOREACH_IDX))
      {
        // Open item is still visible, so adjust the index
        wdata->opn_index--;
      }

      if (wdata->hil_index == ARRAY_FOREACH_IDX)
      {
        // If possible, keep the highlight where it is
        struct SbEntry **sbep_cur = ARRAY_GET(&wdata->entries, ARRAY_FOREACH_IDX);
        if (!sbep_cur)
        {
          // The last entry was deleted, so backtrack
          select_prev(wdata);
        }
        else if ((*sbep)->is_hidden)
        {
          // Find the next unhidden entry, or the previous
          if (!select_next(wdata))
            if (!select_prev(wdata))
              wdata->hil_index = -1;
        }
      }
      else if ((wdata->hil_index > 0) && (wdata->hil_index > ARRAY_FOREACH_IDX))
      {
        // 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 168 of file sidebar.c.

{
  wdata->opn_index = -1;

  struct SbEntry **sbep = NULL;
  ARRAY_FOREACH(sbep, &wdata->entries)
  {
    if (m)
    {
      if (mutt_str_equal((*sbep)->mailbox->realpath, m->realpath))
      {
        wdata->opn_index = ARRAY_FOREACH_IDX;
        wdata->hil_index = ARRAY_FOREACH_IDX;
        break;
      }
    }
    (*sbep)->is_hidden = ((*sbep)->mailbox->flags & MB_HIDDEN);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

select_next()

bool select_next

(

struct SidebarWindowData *

wdata

)

Selects the next unhidden mailbox.

Parameters

wdata

Sidebar data

Return values

true	The selection changed

Definition at line 45 of file functions.c.

{
  if (ARRAY_EMPTY(&wdata->entries) || (wdata->hil_index < 0))
    return false;

  struct SbEntry **sbep = NULL;
  ARRAY_FOREACH_FROM(sbep, &wdata->entries, wdata->hil_index + 1)
  {
    if (!(*sbep)->is_hidden)
    {
      wdata->hil_index = ARRAY_FOREACH_IDX;
      return true;
    }
  }

  return false;
}

Here is the caller graph for this function:

select_prev()

bool select_prev

(

struct SidebarWindowData *

wdata

)

Selects the previous unhidden mailbox.

Parameters

wdata

Sidebar data

Return values

true	The selection changed

Definition at line 113 of file functions.c.

{
  if (ARRAY_EMPTY(&wdata->entries) || (wdata->hil_index < 0))
    return false;

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

int sb_insertion_window_observer

(

struct NotifyCallback *

nc

)

Notification that a Window has changed - Implements observer_t.

Definition at line 470 of file observer.c.

{
  if ((nc->event_type != NT_WINDOW) || !nc->event_data)
    return -1;

  if (nc->event_subtype != NT_WINDOW_DIALOG)
    return 0;

  struct EventWindow *ev_w = nc->event_data;
  if (ev_w->win->type != WT_DLG_INDEX)
    return 0;

  if (ev_w->flags & WN_VISIBLE)
  {
    mutt_debug(LL_DEBUG5, "insertion: visible\n");
    struct MuttWindow *win_sidebar = sb_win_init(ev_w->win);
    sb_init_data(win_sidebar);
  }
  else if (ev_w->flags & WN_HIDDEN)
  {
    mutt_debug(LL_DEBUG5, "insertion: hidden\n");
    sb_win_remove_observers(ev_w->win);
  }

  return 0;
}

Here is the call graph for this function:

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 435 of file observer.c.

{
  if (!win || !NeoMutt)
    return;

  notify_observer_add(NeoMutt->notify, NT_ACCOUNT, sb_account_observer, win);
  notify_observer_add(NeoMutt->notify, NT_COLOR, sb_color_observer, win);
  notify_observer_add(NeoMutt->notify, NT_COMMAND, sb_command_observer, win);
  notify_observer_add(NeoMutt->notify, NT_CONFIG, sb_config_observer, win);
  notify_observer_add(NeoMutt->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 SortType	sort
	)

Sort the Sidebar entries.

Parameters

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

Sort the wdata->entries array according to the current sort config option $sidebar_sort_method. 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 177 of file sort.c.

{
  sort_t fn = sb_sort_unsorted;

  switch (sort & SORT_MASK)
  {
    case SORT_COUNT:
      fn = sb_sort_count;
      break;
    case SORT_DESC:
      fn = sb_sort_desc;
      break;
    case SORT_FLAGGED:
      fn = sb_sort_flagged;
      break;
    case SORT_PATH:
      fn = sb_sort_path;
      break;
    case SORT_UNREAD:
      fn = sb_sort_unread;
      break;
    case SORT_ORDER:
      fn = sb_sort_order;
    default:
      break;
  }

  sb_sort_reverse = (sort & SORT_REVERSE);
  ARRAY_SORT(&wdata->entries, fn);
}

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 70 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 IndexSharedData *

shared

)

Create new Window data for the Sidebar.

Return values

ptr	New Window data

Definition at line 41 of file wdata.c.

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

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

SidebarWhitelist

struct ListHead SidebarWhitelist

List of mailboxes to always display in the sidebar.

Definition at line 44 of file sidebar.c.