neomutt.h File Reference

Container for Accounts, Notifications. More...

#include <locale.h>
#include <stdbool.h>
#include <stddef.h>
#include <sys/types.h>
#include "account.h"
#include "mailbox.h"

Include dependency graph for neomutt.h:

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

Go to the source code of this file.

Data Structures
struct	NeoMutt
	Container for Accounts, Notifications. More...

Macros
#define	mutt_file_fopen_masked(PATH, MODE)   mutt_file_fopen_masked_full(PATH, MODE, __FILE__, __LINE__, __func__)

Enumerations
enum	NotifyGlobal { NT_GLOBAL_STARTUP = 1 , NT_GLOBAL_SHUTDOWN , NT_GLOBAL_COMMAND }
	Events not associated with an object. More...

Functions
bool	neomutt_account_add (struct NeoMutt *n, struct Account *a)
	Add an Account to the global list.
bool	neomutt_account_remove (struct NeoMutt *n, const struct Account *a)
	Remove an Account from the global list.
void	neomutt_free (struct NeoMutt **ptr)
	Free a NeoMutt.
struct NeoMutt *	neomutt_new (struct ConfigSet *cs)
	Create the main NeoMutt object.
void	neomutt_mailboxlist_clear (struct MailboxList *ml)
	Free a Mailbox List.
size_t	neomutt_mailboxlist_get_all (struct MailboxList *head, struct NeoMutt *n, enum MailboxType type)
	Get a List of all Mailboxes.

Variables
struct NeoMutt *	NeoMutt
	Global NeoMutt object.

Detailed Description

Container for Accounts, Notifications.

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

Macro Definition Documentation

mutt_file_fopen_masked

#define mutt_file_fopen_masked	(		PATH,
			MODE
	)		mutt_file_fopen_masked_full(PATH, MODE, __FILE__, __LINE__, __func__)

Definition at line 75 of file neomutt.h.

Enumeration Type Documentation

NotifyGlobal

enum NotifyGlobal

Events not associated with an object.

Observers of NT_GLOBAL will not be passed any Event data.

Enumerator
NT_GLOBAL_STARTUP	NeoMutt is initialised.
NT_GLOBAL_SHUTDOWN	NeoMutt is about to close.
NT_GLOBAL_COMMAND	A NeoMutt command.

Definition at line 59 of file neomutt.h.

{
  NT_GLOBAL_STARTUP = 1, 
  NT_GLOBAL_SHUTDOWN,    
  NT_GLOBAL_COMMAND,     
};

Function Documentation

neomutt_account_add()

bool neomutt_account_add	(	struct NeoMutt *	n,
		struct Account *	a
	)

Add an Account to the global list.

Parameters

n	NeoMutt
a	Account to add

Return values

true	Account was added

Definition at line 110 of file neomutt.c.

{
  if (!n || !a)
    return false;
 
  TAILQ_INSERT_TAIL(&n->accounts, a, entries);
  notify_set_parent(a->notify, n->notify);
 
  mutt_debug(LL_NOTIFY, "NT_ACCOUNT_ADD: %s %p\n",
             mailbox_get_type_name(a->type), (void *) a);
  struct EventAccount ev_a = { a };
  notify_send(n->notify, NT_ACCOUNT, NT_ACCOUNT_ADD, &ev_a);
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

neomutt_account_remove()

bool neomutt_account_remove	(	struct NeoMutt *	n,
		const struct Account *	a
	)

Remove an Account from the global list.

Parameters

n	NeoMutt
a	Account to remove

Return values

true	Account was removed

Note

If a is NULL, all the Accounts will be removed

Definition at line 133 of file neomutt.c.

{
  if (!n || TAILQ_EMPTY(&n->accounts))
    return false;
 
  if (!a)
  {
    mutt_debug(LL_NOTIFY, "NT_ACCOUNT_DELETE_ALL\n");
    struct EventAccount ev_a = { NULL };
    notify_send(n->notify, NT_ACCOUNT, NT_ACCOUNT_DELETE_ALL, &ev_a);
  }
 
  bool result = false;
  struct Account *np = NULL;
  struct Account *tmp = NULL;
  TAILQ_FOREACH_SAFE(np, &n->accounts, entries, tmp)
  {
    if (a && (np != a))
      continue;
 
    TAILQ_REMOVE(&n->accounts, np, entries);
    account_free(&np);
    result = true;
    if (a)
      break;
  }
  return result;
}

Here is the call graph for this function:

Here is the caller graph for this function:

neomutt_free()

void neomutt_free

(

struct NeoMutt **

ptr

)

Free a NeoMutt.

Parameters

[out]

ptr

NeoMutt to free

Definition at line 86 of file neomutt.c.

{
  if (!ptr || !*ptr)
    return;
 
  struct NeoMutt *n = *ptr;
 
  neomutt_account_remove(n, NULL);
  cs_subset_free(&n->sub);
  notify_free(&n->notify_resize);
  notify_free(&n->notify_timeout);
  notify_free(&n->notify);
  if (n->time_c_locale)
    freelocale(n->time_c_locale);
 
  FREE(ptr);
}

Here is the call graph for this function:

Here is the caller graph for this function:

neomutt_new()

struct NeoMutt * neomutt_new

(

struct ConfigSet *

cs

)

Create the main NeoMutt object.

Parameters

cs	Config Set

Return values

ptr	New NeoMutt

Definition at line 50 of file neomutt.c.

{
  if (!cs)
    return NULL;
 
  struct NeoMutt *n = mutt_mem_calloc(1, sizeof(*NeoMutt));
 
  TAILQ_INIT(&n->accounts);
  n->notify = notify_new();
  n->sub = cs_subset_new(NULL, NULL, n->notify);
  n->sub->cs = cs;
  n->sub->scope = SET_SCOPE_NEOMUTT;
 
  n->time_c_locale = duplocale(LC_GLOBAL_LOCALE);
  if (n->time_c_locale)
    n->time_c_locale = newlocale(LC_TIME_MASK, "C", n->time_c_locale);
 
  if (!n->time_c_locale)
  {
    mutt_error("%s", strerror(errno)); // LCOV_EXCL_LINE
    mutt_exit(1);                      // LCOV_EXCL_LINE
  }
 
  n->notify_timeout = notify_new();
  notify_set_parent(n->notify_timeout, n->notify);
 
  n->notify_resize = notify_new();
  notify_set_parent(n->notify_resize, n->notify);
 
  return n;
}

Here is the call graph for this function:

Here is the caller graph for this function:

neomutt_mailboxlist_clear()

void neomutt_mailboxlist_clear

(

struct MailboxList *

ml

)

Free a Mailbox List.

Parameters

ml	Mailbox List to free

Note

The Mailboxes aren't freed

Definition at line 168 of file neomutt.c.

{
  if (!ml)
    return;
 
  struct MailboxNode *mn = NULL;
  struct MailboxNode *tmp = NULL;
  STAILQ_FOREACH_SAFE(mn, ml, entries, tmp)
  {
    STAILQ_REMOVE(ml, mn, MailboxNode, entries);
    FREE(&mn);
  }
}

Here is the caller graph for this function:

neomutt_mailboxlist_get_all()

size_t neomutt_mailboxlist_get_all	(	struct MailboxList *	head,
		struct NeoMutt *	n,
		enum MailboxType	type
	)

Get a List of all Mailboxes.

Parameters

head	List to store the Mailboxes
n	NeoMutt
type	Type of Account to match, see MailboxType

Return values

num	Number of Mailboxes in the List

Note

If type is MUTT_MAILBOX_ANY then all Mailbox types will be matched

Definition at line 191 of file neomutt.c.

{
  if (!n)
    return 0;
 
  size_t count = 0;
  struct Account *a = NULL;
  struct MailboxNode *mn = NULL;
 
  TAILQ_FOREACH(a, &n->accounts, entries)
  {
    if ((type > MUTT_UNKNOWN) && (a->type != type))
      continue;
 
    STAILQ_FOREACH(mn, &a->mailboxes, entries)
    {
      struct MailboxNode *mn2 = mutt_mem_calloc(1, sizeof(*mn2));
      mn2->mailbox = mn->mailbox;
      STAILQ_INSERT_TAIL(head, mn2, entries);
      count++;
    }
  }
 
  return count;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

NeoMutt

struct NeoMutt* NeoMutt

extern

Global NeoMutt object.

Definition at line 43 of file neomutt.c.