module.c File Reference

Definition of the Compmbox Module. More...

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

Include dependency graph for module.c:

Go to the source code of this file.

Functions
static bool	compmbox_init (struct NeoMutt *n)
	Initialise a Module - Implements Module::init()
static bool	compmbox_commands_register (struct NeoMutt *n, struct CommandArray *ca)
	Register NeoMutt Commands - Implements Module::commands_register()
static bool	compmbox_cleanup (struct NeoMutt *n, void *data)
	Clean up a Module - Implements Module::cleanup()

Variables
const struct Command	CompCommands []
	Compression Commands.
const struct Module	ModuleCompmbox
	Module for the Compmbox library.

Detailed Description

Definition of the Compmbox 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

compmbox_init()

static bool compmbox_init ( struct NeoMutt * n )

static

Initialise a Module - Implements Module::init()

Definition at line 41 of file module.c.

{
  struct CompmboxModuleData *mod_data = MUTT_MEM_CALLOC(1, struct CompmboxModuleData);
  neomutt_set_module_data(n, MODULE_ID_COMPMBOX, 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:

compmbox_commands_register()

static bool compmbox_commands_register ( struct NeoMutt * n, struct CommandArray * ca )

static

Register NeoMutt Commands - Implements Module::commands_register()

Definition at line 55 of file module.c.

{
  return commands_register(ca, CompCommands);
}

Here is the call graph for this function:

compmbox_cleanup()

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

static

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

Definition at line 63 of file module.c.

{
  struct CompmboxModuleData *mod_data = data;
 
  notify_free(&mod_data->notify);
 
  FREE(&mod_data);
  return true;
}

Here is the call graph for this function:

Variable Documentation

CompCommands

const struct Command CompCommands[]

extern

Compression Commands.

Definition at line 62 of file compress.c.

                                      {
  // clang-format off
  { "append-hook", CMD_APPEND_HOOK, parse_compress_hook,
        N_("Define command to append to a compressed mailbox"),
        N_("append-hook <regex> <shell-command>"),
        "optionalfeatures.html#append-hook" },
  { "close-hook", CMD_CLOSE_HOOK, parse_compress_hook,
        N_("Define command to close a compressed mailbox"),
        N_("close-hook <regex> <shell-command>"),
        "optionalfeatures.html#close-hook" },
  { "open-hook", CMD_OPEN_HOOK, parse_compress_hook,
        N_("Define command to open a compressed mailbox"),
        N_("open-hook <regex> <shell-command>"),
        "optionalfeatures.html#open-hook" },
 
  { NULL, CMD_NONE, NULL, NULL, NULL, NULL, CF_NO_FLAGS },
  // clang-format on
};

ModuleCompmbox

const struct Module ModuleCompmbox

Initial value:

= {
  MODULE_ID_COMPMBOX,
  "compmbox",
  compmbox_init,
  NULL, 
  NULL, 
  compmbox_commands_register,
  NULL, 
  NULL, 
  compmbox_cleanup,
}

Module for the Compmbox library.

Definition at line 76 of file module.c.

                                     {
  MODULE_ID_COMPMBOX,
  "compmbox",
  compmbox_init,
  NULL, // config_define_types
  NULL, // config_define_variables
  compmbox_commands_register,
  NULL, // gui_init
  NULL, // gui_cleanup
  compmbox_cleanup,
};