neomutt.h File Reference

Container for Accounts, Notifications. More...

#include <locale.h>
#include <stdbool.h>
#include <sys/types.h>
#include "account.h"
#include "command.h"
#include "mailbox.h"
#include "module_api.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)
	Open a file with proper permissions, tracked for debugging.

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.
void	neomutt_account_remove (struct NeoMutt *n, struct Account *a)
	Remove an Account from the global list.
void	neomutt_accounts_free (struct NeoMutt *n)
void	neomutt_free (struct NeoMutt **ptr)
	Free a NeoMutt.
struct NeoMutt *	neomutt_new (void)
	Create the main NeoMutt object.
void *	neomutt_get_module_data (struct NeoMutt *n, enum ModuleId id)
	Get the private data for a Module.
void	neomutt_set_module_data (struct NeoMutt *n, enum ModuleId id, void *data)
	Set the private data for a Module.
bool	neomutt_init (struct NeoMutt *n, char **envp, const struct Module **modules)
	Initialise NeoMutt.
void	neomutt_cleanup (struct NeoMutt *n)
	Clean up NeoMutt and Modules.
bool	neomutt_gui_init (struct NeoMutt *n)
	Initialise the GUI Modules.
void	neomutt_gui_cleanup (struct NeoMutt *n)
	Clean up the GUI Modules.
struct MailboxArray	neomutt_mailboxes_get (struct NeoMutt *n, enum MailboxType type)
	Get an Array of matching 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 )

Value:

mutt_file_fopen_masked_full(PATH, MODE, __FILE__, __LINE__, __func__)

Open a file with proper permissions, tracked for debugging.

Definition at line 92 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 67 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 537 of file neomutt.c.

{
  if (!n || !a)
    return false;
 
  ARRAY_ADD(&n->accounts, a);
  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()

void neomutt_account_remove	(	struct NeoMutt *	n,
		struct Account *	a )

Remove an Account from the global list.

Parameters

n	NeoMutt
a	Account to remove

Definition at line 557 of file neomutt.c.

{
  if (!n || !a || ARRAY_EMPTY(&n->accounts))
    return;
 
  struct Account **ap = NULL;
  ARRAY_FOREACH(ap, &n->accounts)
  {
    if ((*ap) != a)
      continue;
 
    ARRAY_REMOVE(&n->accounts, ap);
    account_free(&a);
    break;
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

neomutt_accounts_free()

void neomutt_accounts_free

(

struct NeoMutt *

n

)

• Free all the Accounts

  Parameters

  n

  NeoMutt

Definition at line 578 of file neomutt.c.

{
  if (!n)
    return;
 
  if (!ARRAY_EMPTY(&n->accounts))
  {
    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);
 
    struct Account **ap = NULL;
    ARRAY_FOREACH(ap, &n->accounts)
    {
      account_free(ap);
    }
  }
 
  ARRAY_FREE(&n->accounts);
}

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 501 of file neomutt.c.

{
  if (!ptr || !*ptr)
    return;
 
  struct NeoMutt *n = *ptr;
 
  neomutt_accounts_free(n);
 
  if (n->sub)
  {
    struct ConfigSet *cs = n->sub->cs;
    cs_subset_free(&n->sub);
    cs_free(&cs);
  }
 
  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(&n->home_dir);
  FREE(&n->username);
 
  envlist_free(&n->env);
 
  FREE(ptr);
}

Here is the call graph for this function:

Here is the caller graph for this function:

neomutt_new()

struct NeoMutt * neomutt_new

(

void

)

Create the main NeoMutt object.

Return values

ptr	New NeoMutt

Definition at line 338 of file neomutt.c.

{
  return MUTT_MEM_CALLOC(1, struct NeoMutt);
}

Here is the caller graph for this function:

neomutt_get_module_data()

void * neomutt_get_module_data	(	struct NeoMutt *	n,
		enum ModuleId	id )

Get the private data for a Module.

Parameters

n	NeoMutt
id	Module Id

Return values

ptr	Private Module data

Definition at line 666 of file neomutt.c.

{
  if (!n)
    return NULL;
 
  return n->module_data[id];
}

neomutt_set_module_data()

void neomutt_set_module_data	(	struct NeoMutt *	n,
		enum ModuleId	id,
		void *	data )

Set the private data for a Module.

Parameters

n	NeoMutt
id	Module Id
data	Private Module data

Definition at line 680 of file neomutt.c.

{
  if (!n)
    return;
 
  n->module_data[id] = data;
}

Here is the caller graph for this function:

neomutt_init()

bool neomutt_init	(	struct NeoMutt *	n,
		char **	envp,
		const struct Module **	modules )

Initialise NeoMutt.

Parameters

n	NeoMutt
envp	External environment
modules	Library modules to initialise

Return values

true

Success

Definition at line 350 of file neomutt.c.

{
  if (!n || !modules)
    return false;
 
  for (int i = 0; modules[i]; i++)
  {
    const struct Module *mod = modules[i];
 
    n->modules[mod->mid] = mod;
  }
 
  if (!init_env(n, envp))
    return false;
 
  if (!init_locale(n))
    return false;
 
  if (!init_config(n))
    return false;
 
  if (!init_commands(n))
    return false;
 
  if (!init_modules(n))
    return false;
 
  ARRAY_INIT(&n->accounts);
  n->notify = notify_new();
  notify_set_parent(n->sub->notify, n->notify);
 
  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);
 
  // Change the current umask, and save the original one
  n->user_default_umask = umask(077);
  mutt_debug(LL_DEBUG1, "user's umask %03o\n", n->user_default_umask);
  mutt_debug(LL_DEBUG3, "umask set to 077\n");
 
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

neomutt_cleanup()

void neomutt_cleanup

(

struct NeoMutt *

n

)

Clean up NeoMutt and Modules.

Parameters

n

NeoMutt

Definition at line 474 of file neomutt.c.

{
  if (!n)
    return;
 
  cleanup_gui_modules(n);
 
  commands_clear(&n->commands);
  cleanup_modules(n);
}

Here is the call graph for this function:

Here is the caller graph for this function:

neomutt_gui_init()

bool neomutt_gui_init

(

struct NeoMutt *

n

)

Initialise the GUI Modules.

Parameters

n

NeoMutt

Return values

true

Success

Definition at line 400 of file neomutt.c.

{
  if (!n)
    return false;
 
  return init_gui_modules(n);
}

Here is the call graph for this function:

Here is the caller graph for this function:

neomutt_gui_cleanup()

void neomutt_gui_cleanup

(

struct NeoMutt *

n

)

Clean up the GUI Modules.

Parameters

n

NeoMutt

Definition at line 489 of file neomutt.c.

{
  if (!n)
    return;
 
  cleanup_gui_modules(n);
}

Here is the call graph for this function:

Here is the caller graph for this function:

neomutt_mailboxes_get()

struct MailboxArray neomutt_mailboxes_get	(	struct NeoMutt *	n,
		enum MailboxType	type )

Get an Array of matching Mailboxes.

Parameters

n	NeoMutt
type	Type of Account to match, see MailboxType

Return values

obj	Array of Mailboxes

Note

If type is MUTT_MAILBOX_ANY then all Mailbox types will be matched

Definition at line 607 of file neomutt.c.

{
  struct MailboxArray ma = ARRAY_HEAD_INITIALIZER;
 
  if (!n)
    return ma;
 
  struct Account **ap = NULL;
  struct Mailbox **mp = NULL;
 
  ARRAY_FOREACH(ap, &n->accounts)
  {
    struct Account *a = *ap;
    if ((type > MUTT_UNKNOWN) && (a->type != type))
      continue;
 
    ARRAY_FOREACH(mp, &a->mailboxes)
    {
      ARRAY_ADD(&ma, *mp);
    }
  }
 
  return ma;
}

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 49 of file neomutt.c.