observer.c File Reference

Sidebar observers. 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 "color/lib.h"
#include "index/lib.h"

Include dependency graph for observer.c:

Go to the source code of this file.

Functions
void	sb_win_remove_observers (struct MuttWindow *win)
	Remove Observers from the Sidebar Window.
static bool	calc_divider (struct SidebarWindowData *wdata)
	Decide what actions are required for the divider.
static struct MuttWindow *	sb_win_init (struct MuttWindow *dlg)
	Initialise and insert the Sidebar Window.
static void	sb_init_data (struct MuttWindow *win)
	Initialise the Sidebar data.
static int	sb_account_observer (struct NotifyCallback *nc)
	Notification that an Account has changed - Implements observer_t -.
static int	sb_color_observer (struct NotifyCallback *nc)
	Notification that a Color has changed - Implements observer_t -.
static int	sb_command_observer (struct NotifyCallback *nc)
	Notification that a Command has occurred - Implements observer_t -.
static int	sb_config_observer (struct NotifyCallback *nc)
	Notification that a Config Variable has changed - Implements observer_t -.
static int	sb_index_observer (struct NotifyCallback *nc)
	Notification that the Index has changed - Implements observer_t -.
static int	sb_mailbox_observer (struct NotifyCallback *nc)
	Notification that a Mailbox has changed - Implements observer_t -.
static int	sb_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.
int	sb_insertion_window_observer (struct NotifyCallback *nc)
	Notification that a Window has changed - Implements observer_t -.

Detailed Description

Sidebar observers.

Authors

• Richard Russon
• Ashish Panigrahi
• Pietro Cerutti

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

Function Documentation

sb_win_remove_observers()

void sb_win_remove_observers

(

struct MuttWindow *

win

)

Remove Observers from the Sidebar Window.

Parameters

win	Sidebar Window

Definition at line 447 of file observer.c.

{
  if (!win || !NeoMutt)
    return;
 
  struct MuttWindow *dlg = window_find_parent(win, WT_DLG_INDEX);
 
  mutt_color_observer_remove(sb_color_observer, win);
  notify_observer_remove(NeoMutt->notify, sb_account_observer, win);
  notify_observer_remove(NeoMutt->notify, sb_command_observer, win);
  notify_observer_remove(NeoMutt->sub->notify, sb_config_observer, win);
  notify_observer_remove(dlg->notify, sb_index_observer, win);
  notify_observer_remove(NeoMutt->notify, sb_mailbox_observer, win);
  notify_observer_remove(win->notify, sb_window_observer, win);
}

Here is the call graph for this function:

Here is the caller graph for this function:

calc_divider()

static bool calc_divider ( struct SidebarWindowData *  wdata )

static

Decide what actions are required for the divider.

Parameters

wdata

Sidebar data

Return values

true	The width has changed

If the divider changes width, then Window will need to be reflowed.

Definition at line 51 of file observer.c.

{
  enum DivType type = SB_DIV_USER;
  bool changed = false;
  const char *const c_sidebar_divider_char = cs_subset_string(NeoMutt->sub, "sidebar_divider_char");
 
  // Calculate the width of the delimiter in screen cells
  int width = mutt_strwidth(c_sidebar_divider_char);
  if (width < 1)
  {
    type = SB_DIV_ASCII;
    goto done;
  }
 
  const bool c_ascii_chars = cs_subset_bool(NeoMutt->sub, "ascii_chars");
  if (c_ascii_chars || !CharsetIsUtf8)
  {
    const size_t len = mutt_str_len(c_sidebar_divider_char);
    for (size_t i = 0; i < len; i++)
    {
      if (c_sidebar_divider_char[i] & ~0x7F) // high-bit is set
      {
        type = SB_DIV_ASCII;
        width = 1;
        break;
      }
    }
  }
 
done:
  changed = (width != wdata->divider_width);
 
  wdata->divider_type = type;
  wdata->divider_width = width;
 
  return changed;
}

Here is the call graph for this function:

Here is the caller graph for this function:

sb_win_init()

static struct MuttWindow * sb_win_init ( struct MuttWindow *  dlg )

static

Initialise and insert the Sidebar Window.

Parameters

dlg	Index Dialog

Return values

ptr	Sidebar Window

Definition at line 94 of file observer.c.

{
  dlg->orient = MUTT_WIN_ORIENT_HORIZONTAL;
 
  struct MuttWindow *index_panel = TAILQ_FIRST(&dlg->children);
  mutt_window_remove_child(dlg, index_panel);
 
  struct MuttWindow *pager_panel = TAILQ_FIRST(&dlg->children);
  mutt_window_remove_child(dlg, pager_panel);
 
  struct MuttWindow *cont_right = mutt_window_new(WT_CONTAINER, MUTT_WIN_ORIENT_VERTICAL,
                                                  MUTT_WIN_SIZE_MAXIMISE, MUTT_WIN_SIZE_UNLIMITED,
                                                  MUTT_WIN_SIZE_UNLIMITED);
  dlg->focus = cont_right;
 
  mutt_window_add_child(cont_right, index_panel);
  mutt_window_add_child(cont_right, pager_panel);
  cont_right->focus = index_panel;
 
  const short c_sidebar_width = cs_subset_number(NeoMutt->sub, "sidebar_width");
  struct MuttWindow *win_sidebar = mutt_window_new(WT_SIDEBAR, MUTT_WIN_ORIENT_HORIZONTAL,
                                                   MUTT_WIN_SIZE_FIXED, c_sidebar_width,
                                                   MUTT_WIN_SIZE_UNLIMITED);
  const bool c_sidebar_visible = cs_subset_bool(NeoMutt->sub, "sidebar_visible");
  win_sidebar->state.visible = c_sidebar_visible && (c_sidebar_width > 0);
 
  struct IndexSharedData *shared = dlg->wdata;
  win_sidebar->wdata = sb_wdata_new(win_sidebar, shared);
  win_sidebar->wdata_free = sb_wdata_free;
 
  calc_divider(win_sidebar->wdata);
 
  win_sidebar->recalc = sb_recalc;
  win_sidebar->repaint = sb_repaint;
 
  const bool c_sidebar_on_right = cs_subset_bool(NeoMutt->sub, "sidebar_on_right");
  if (c_sidebar_on_right)
  {
    mutt_window_add_child(dlg, cont_right);
    mutt_window_add_child(dlg, win_sidebar);
  }
  else
  {
    mutt_window_add_child(dlg, win_sidebar);
    mutt_window_add_child(dlg, cont_right);
  }
 
  sb_win_add_observers(win_sidebar);
 
  return win_sidebar;
}

Here is the call graph for this function:

Here is the caller graph for this function:

sb_init_data()

static void sb_init_data ( struct MuttWindow *  win )

static

Initialise the Sidebar data.

Parameters

win	Sidebar Window

Definition at line 150 of file observer.c.

{
  struct SidebarWindowData *wdata = sb_wdata_get(win);
  if (!wdata)
    return;
 
  if (!ARRAY_EMPTY(&wdata->entries))
    return;
 
  struct MailboxList ml = STAILQ_HEAD_INITIALIZER(ml);
  neomutt_mailboxlist_get_all(&ml, NeoMutt, MUTT_MAILBOX_ANY);
  struct MailboxNode *np = NULL;
  STAILQ_FOREACH(np, &ml, entries)
  {
    if (np->mailbox->visible)
      sb_add_mailbox(wdata, np->mailbox);
  }
  neomutt_mailboxlist_clear(&ml);
}

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

{
  if (!win || !NeoMutt)
    return;
 
  struct MuttWindow *dlg = window_find_parent(win, WT_DLG_INDEX);
 
  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_ALL, 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: