sidebar.c File Reference

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

#include "config.h"
#include <stdbool.h>
#include <stdio.h>
#include "private.h"
#include "mutt/lib.h"
#include "config/lib.h"
#include "core/lib.h"
#include "gui/lib.h"
#include "lib.h"
#include "color/lib.h"
#include "index/lib.h"

Include dependency graph for sidebar.c:

Go to the source code of this file.

Functions
struct Mailbox *	sb_get_highlight (struct MuttWindow *win)
	Get the Mailbox that's highlighted in the sidebar.
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.
void	sb_init (void)
	Set up the Sidebar.
void	sb_cleanup (void)
	Clean up the Sidebar.

Variables
struct ListHead	SidebarPinned = STAILQ_HEAD_INITIALIZER(SidebarPinned)
	List of mailboxes to always display in the sidebar.
const struct Command	SbCommands []
	Sidebar Commands.

Detailed Description

GUI display the mailboxes in a side panel.

Authors

• Kevin J. McCarthy
• Richard Russon
• Pietro Cerutti
• Whitney Cumber

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 sidebar.c.

Function Documentation

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->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_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;
 
  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 137 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)->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 190 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_init()

void sb_init

(

void

)

Set up the Sidebar.

Definition at line 213 of file sidebar.c.

{
  // Set a default style
  struct AttrColor *ac = simple_color_get(MT_COLOR_SIDEBAR_HIGHLIGHT);
  ac->attrs = A_UNDERLINE;
 
  // Listen for dialog creation events
  notify_observer_add(AllDialogsWindow->notify, NT_WINDOW,
                      sb_insertion_window_observer, NULL);
}

Here is the call graph for this function:

Here is the caller graph for this function:

sb_cleanup()

void sb_cleanup

(

void

)

Clean up the Sidebar.

Definition at line 227 of file sidebar.c.

{
  if (AllDialogsWindow)
    notify_observer_remove(AllDialogsWindow->notify, sb_insertion_window_observer, NULL);
  mutt_list_free(&SidebarPinned);
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

SidebarPinned

struct ListHead SidebarPinned = STAILQ_HEAD_INITIALIZER(SidebarPinned)

List of mailboxes to always display in the sidebar.

Definition at line 44 of file sidebar.c.

SbCommands

const struct Command SbCommands[]

Initial value:

= {
  
  { "sidebar-pin", CMD_SIDEBAR_PIN, parse_sidebar_pin, CMD_NO_DATA,
        N_("Pin a mailbox in the sidebar (keep visible)"),
        N_("sidebar-pin <mailbox> [ <mailbox> ... ]"),
        "optionalfeatures.html#sidebar-pin" },
  { "sidebar-unpin", CMD_SIDEBAR_UNPIN, parse_sidebar_unpin, CMD_NO_DATA,
        N_("Unpin a previously pinned mailbox in the sidebar"),
        N_("sidebar-unpin { * | <mailbox> ... }"),
        "optionalfeatures.html#sidebar-pin" },
 
  
  { "sidebar_pin",         CMD_NONE, NULL, IP "sidebar-pin",   NULL, NULL, NULL, CF_SYNONYM },
  { "sidebar_unpin",       CMD_NONE, NULL, IP "sidebar-unpin", NULL, NULL, NULL, CF_SYNONYM },
  { "sidebar_whitelist",   CMD_NONE, NULL, IP "sidebar-pin",   NULL, NULL, NULL, CF_SYNONYM },
  { "unsidebar_whitelist", CMD_NONE, NULL, IP "sidebar-unpin", NULL, NULL, NULL, CF_SYNONYM },
 
  { NULL, CMD_NONE, NULL, CMD_NO_DATA, NULL, NULL, NULL, CF_NO_FLAGS },
  
}

Sidebar Commands.

Definition at line 49 of file sidebar.c.

                                    {
  // clang-format off
  { "sidebar-pin", CMD_SIDEBAR_PIN, parse_sidebar_pin, CMD_NO_DATA,
        N_("Pin a mailbox in the sidebar (keep visible)"),
        N_("sidebar-pin <mailbox> [ <mailbox> ... ]"),
        "optionalfeatures.html#sidebar-pin" },
  { "sidebar-unpin", CMD_SIDEBAR_UNPIN, parse_sidebar_unpin, CMD_NO_DATA,
        N_("Unpin a previously pinned mailbox in the sidebar"),
        N_("sidebar-unpin { * | <mailbox> ... }"),
        "optionalfeatures.html#sidebar-pin" },
 
  // Deprecated
  { "sidebar_pin",         CMD_NONE, NULL, IP "sidebar-pin",   NULL, NULL, NULL, CF_SYNONYM },
  { "sidebar_unpin",       CMD_NONE, NULL, IP "sidebar-unpin", NULL, NULL, NULL, CF_SYNONYM },
  { "sidebar_whitelist",   CMD_NONE, NULL, IP "sidebar-pin",   NULL, NULL, NULL, CF_SYNONYM },
  { "unsidebar_whitelist", CMD_NONE, NULL, IP "sidebar-unpin", NULL, NULL, NULL, CF_SYNONYM },
 
  { NULL, CMD_NONE, NULL, CMD_NO_DATA, NULL, NULL, NULL, CF_NO_FLAGS },
  // clang-format on
};