shared_data.h File Reference

Data shared between Index, Pager and Sidebar. More...

#include <stdbool.h>
#include <stdio.h>

Include dependency graph for shared_data.h:

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

Go to the source code of this file.

Data Structures
struct	IndexSharedData
	Data shared between Index, Pager and Sidebar. More...

Enumerations
enum	ExpandoDataIndex {   ED_IND_DELETED_COUNT = 1 , ED_IND_DESCRIPTION , ED_IND_FLAGGED_COUNT , ED_IND_LIMIT_COUNT ,   ED_IND_LIMIT_PATTERN , ED_IND_LIMIT_SIZE , ED_IND_MAILBOX_PATH , ED_IND_MAILBOX_SIZE ,   ED_IND_MESSAGE_COUNT , ED_IND_NEW_COUNT , ED_IND_OLD_COUNT , ED_IND_POSTPONED_COUNT ,   ED_IND_READONLY , ED_IND_READ_COUNT , ED_IND_TAGGED_COUNT , ED_IND_UNREAD_COUNT ,   ED_IND_UNREAD_MAILBOXES }
	Expando UIDs for the Index. More...

Functions
void	index_shared_data_free (struct MuttWindow *win, void **ptr)
	Free Shared Index Data - Implements MuttWindow::wdata_free() -.
struct IndexSharedData *	index_shared_data_new (void)
	Create new Index Data.
bool	index_shared_data_is_cur_email (const struct IndexSharedData *shared, const struct Email *e)
	Check whether an email is the currently selected Email.
void	index_shared_data_set_mview (struct IndexSharedData *shared, struct MailboxView *mv)
	Set the MailboxView for the Index and friends.
void	index_shared_data_set_email (struct IndexSharedData *shared, struct Email *e)
	Set the current Email for the Index and friends.

Detailed Description

Data shared between Index, Pager and Sidebar.

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 shared_data.h.

Enumeration Type Documentation

ExpandoDataIndex

enum ExpandoDataIndex

Expando UIDs for the Index.

See also

ED_INDEX, ExpandoDomain

Enumerator
ED_IND_DELETED_COUNT	Mailbox.msg_deleted.
ED_IND_DESCRIPTION	Mailbox.name.
ED_IND_FLAGGED_COUNT	Mailbox.msg_flagged.
ED_IND_LIMIT_COUNT	Mailbox.vcount.
ED_IND_LIMIT_PATTERN	MailboxView.pattern.
ED_IND_LIMIT_SIZE	MailboxView.vsize.
ED_IND_MAILBOX_PATH	Mailbox.pathbuf, Mailbox.name.
ED_IND_MAILBOX_SIZE	Mailbox.size.
ED_IND_MESSAGE_COUNT	Mailbox.msg_count.
ED_IND_NEW_COUNT	Mailbox.msg_new.
ED_IND_OLD_COUNT	Mailbox.msg_unread, Mailbox.msg_new.
ED_IND_POSTPONED_COUNT	mutt_num_postponed()
ED_IND_READONLY	Mailbox.readonly, Mailbox.dontwrite.
ED_IND_READ_COUNT	Mailbox.msg_count, Mailbox.msg_unread.
ED_IND_TAGGED_COUNT	Mailbox.msg_tagged.
ED_IND_UNREAD_COUNT	Mailbox.msg_unread.
ED_IND_UNREAD_MAILBOXES	Mailbox, mutt_mailbox_check()

Definition at line 54 of file shared_data.h.

{
  ED_IND_DELETED_COUNT = 1,    
  ED_IND_DESCRIPTION,          
  ED_IND_FLAGGED_COUNT,        
  ED_IND_LIMIT_COUNT,          
  ED_IND_LIMIT_PATTERN,        
  ED_IND_LIMIT_SIZE,           
  ED_IND_MAILBOX_PATH,         
  ED_IND_MAILBOX_SIZE,         
  ED_IND_MESSAGE_COUNT,        
  ED_IND_NEW_COUNT,            
  ED_IND_OLD_COUNT,            
  ED_IND_POSTPONED_COUNT,      
  ED_IND_READONLY,             
  ED_IND_READ_COUNT,           
  ED_IND_TAGGED_COUNT,         
  ED_IND_UNREAD_COUNT,         
  ED_IND_UNREAD_MAILBOXES,     
};

Function Documentation

index_shared_data_new()

struct IndexSharedData * index_shared_data_new

(

void

)

Create new Index Data.

Return values

ptr	New IndexSharedData

Definition at line 307 of file shared_data.c.

{
  struct IndexSharedData *shared = MUTT_MEM_CALLOC(1, struct IndexSharedData);
 
  shared->notify = notify_new();
  shared->sub = NeoMutt->sub;
  shared->search_state = search_state_new();
 
  mutt_debug(LL_NOTIFY, "NT_INDEX_ADD: %p\n", (void *) shared);
  notify_send(shared->notify, NT_INDEX, NT_INDEX_ADD, shared);
 
  return shared;
}

Here is the call graph for this function:

Here is the caller graph for this function:

index_shared_data_is_cur_email()

bool index_shared_data_is_cur_email	(	const struct IndexSharedData *	shared,
		const struct Email *	e
	)

Check whether an email is the currently selected Email.

Parameters

shared	Shared Index data
e	Email to check

Return values

true	e is current
false	e is not current

Definition at line 264 of file shared_data.c.

{
  if (!shared)
    return false;
 
  return shared->email_seq == e->sequence;
}

Here is the caller graph for this function:

index_shared_data_set_mview()

void index_shared_data_set_mview	(	struct IndexSharedData *	shared,
		struct MailboxView *	mv
	)

Set the MailboxView for the Index and friends.

Parameters

shared	Shared Index data
mv	Mailbox View, may be NULL

Definition at line 160 of file shared_data.c.

{
  if (!shared)
    return;
 
  NotifyIndex subtype = NT_INDEX_NO_FLAGS;
 
  if (shared->mailbox_view != mv)
  {
    if (shared->mailbox_view)
    {
      notify_observer_remove(shared->mailbox_view->notify,
                             index_shared_mview_observer, shared);
    }
 
    shared->mailbox_view = mv;
    subtype |= NT_INDEX_MVIEW;
 
    if (mv)
      notify_observer_add(mv->notify, NT_MVIEW, index_shared_mview_observer, shared);
  }
 
  struct Mailbox *m = mview_mailbox(mv);
  if (shared->mailbox != m)
  {
    if (shared->mailbox)
      notify_observer_remove(shared->mailbox->notify, index_shared_mailbox_observer, shared);
 
    shared->mailbox = m;
    shared->email = NULL;
    shared->email_seq = 0;
    subtype |= NT_INDEX_MAILBOX | NT_INDEX_EMAIL;
 
    if (m)
      notify_observer_add(m->notify, NT_MAILBOX, index_shared_mailbox_observer, shared);
  }
 
  struct Account *a = m ? m->account : NULL;
  if (shared->account != a)
  {
    if (shared->account)
      notify_observer_remove(shared->account->notify, index_shared_account_observer, shared);
 
    shared->account = a;
    subtype |= NT_INDEX_ACCOUNT;
 
    if (a)
      notify_observer_add(a->notify, NT_ACCOUNT, index_shared_account_observer, shared);
  }
 
  struct ConfigSubset *sub = NeoMutt->sub;
#if 0
  if (m)
    sub = m->sub;
  else if (a)
    sub = a->sub;
#endif
  if (shared->sub != sub)
  {
    shared->sub = sub;
    subtype |= NT_INDEX_SUBSET;
  }
 
  if (subtype != NT_INDEX_NO_FLAGS)
  {
    mutt_debug(LL_NOTIFY, "NT_INDEX: %p\n", (void *) shared);
    notify_send(shared->notify, NT_INDEX, subtype, shared);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

index_shared_data_set_email()

void index_shared_data_set_email	(	struct IndexSharedData *	shared,
		struct Email *	e
	)

Set the current Email for the Index and friends.

Parameters

shared	Shared Index data
e	Current Email, may be NULL

Definition at line 235 of file shared_data.c.

{
  if (!shared)
    return;
 
  size_t seq = e ? e->sequence : 0;
  if ((shared->email != e) || (shared->email_seq != seq))
  {
    if (shared->email)
      notify_observer_remove(shared->email->notify, index_shared_email_observer, shared);
 
    shared->email = e;
    shared->email_seq = seq;
 
    if (e)
      notify_observer_add(e->notify, NT_EMAIL, index_shared_email_observer, shared);
 
    mutt_debug(LL_NOTIFY, "NT_INDEX_EMAIL: %p\n", (void *) shared->email);
    notify_send(shared->notify, NT_INDEX, NT_INDEX_EMAIL, shared);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function: