module.c File Reference

Definition of the Autocrypt Module. More...

#include "config.h"
#include <stdbool.h>
#include <stddef.h>
#include "mutt/lib.h"
#include "config/lib.h"
#include "core/lib.h"
#include "lib.h"
#include "module_data.h"

Include dependency graph for module.c:

Go to the source code of this file.

Functions
static bool	autocrypt_init (struct NeoMutt *n)
	Initialise a Module - Implements Module::init()
static bool	autocrypt_config_define_variables (struct NeoMutt *n, struct ConfigSet *cs)
	Define the Config Variables - Implements Module::config_define_variables()
static bool	autocrypt_cleanup (struct NeoMutt *n, void *data)
	Clean up a Module - Implements Module::cleanup()

Variables
struct ConfigDef	AutocryptVars []
	Config definitions for the autocrypt library.
const struct Module	ModuleAutocrypt
	Module for the Autocrypt library.

Detailed Description

Definition of the Autocrypt Module.

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

Function Documentation

autocrypt_init()

static bool autocrypt_init ( struct NeoMutt * n )

static

Initialise a Module - Implements Module::init()

Definition at line 45 of file module.c.

{
  struct AutocryptModuleData *mod_data = MUTT_MEM_CALLOC(1, struct AutocryptModuleData);
  neomutt_set_module_data(n, MODULE_ID_AUTOCRYPT, mod_data);
 
  mod_data->notify = notify_new();
  notify_set_parent(mod_data->notify, n->notify);
 
  return true;
}

Here is the call graph for this function:

autocrypt_config_define_variables()

static bool autocrypt_config_define_variables ( struct NeoMutt * n, struct ConfigSet * cs )

static

Define the Config Variables - Implements Module::config_define_variables()

Definition at line 59 of file module.c.

{
  bool rc = false;
 
#if defined(USE_AUTOCRYPT)
  rc |= cs_register_variables(cs, AutocryptVars);
#endif
 
  return rc;
}

Here is the call graph for this function:

autocrypt_cleanup()

static bool autocrypt_cleanup ( struct NeoMutt * n, void * data )

static

Clean up a Module - Implements Module::cleanup()

Definition at line 73 of file module.c.

{
  struct AutocryptModuleData *mod_data = data;
 
  notify_free(&mod_data->notify);
 
  mutt_autocrypt_cleanup(mod_data);
 
  FREE(&mod_data->autocrypt_sign_as);
  FREE(&mod_data->autocrypt_default_key);
 
  FREE(&mod_data);
  return true;
}

Here is the call graph for this function:

Variable Documentation

AutocryptVars

struct ConfigDef AutocryptVars[]

extern

Config definitions for the autocrypt library.

Definition at line 59 of file config.c.

                                   {
  // clang-format off
  { "autocrypt", DT_BOOL, false, 0, NULL,
    "Enables the Autocrypt feature"
  },
  { "autocrypt_acct_format", DT_EXPANDO, IP "%4n %-30a %20p %10s", IP &AutocryptFormatDef, NULL,
    "Format of the autocrypt account menu"
  },
  { "autocrypt_dir", DT_PATH|D_PATH_DIR, IP "~/.mutt/autocrypt", 0, NULL,
    "Location of autocrypt files, including the GPG keyring and SQLite database"
  },
  { "autocrypt_reply", DT_BOOL, true, 0, NULL,
    "Replying to an autocrypt email automatically enables autocrypt in the reply"
  },
  { NULL },
  // clang-format on
};

ModuleAutocrypt

const struct Module ModuleAutocrypt

Initial value:

= {
  MODULE_ID_AUTOCRYPT,
  "autocrypt",
  autocrypt_init,
  NULL, 
  autocrypt_config_define_variables,
  NULL, 
  NULL, 
  NULL, 
  autocrypt_cleanup,
}

Module for the Autocrypt library.

Definition at line 91 of file module.c.

                                      {
  MODULE_ID_AUTOCRYPT,
  "autocrypt",
  autocrypt_init,
  NULL, // config_define_types
  autocrypt_config_define_variables,
  NULL, // commands_register
  NULL, // gui_init
  NULL, // gui_cleanup
  autocrypt_cleanup,
};