module.c File Reference

Definition of the Pattern Module. More...

#include "config.h"
#include <stdbool.h>
#include <stddef.h>
#include "private.h"
#include "mutt/lib.h"
#include "config/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	pattern_init (struct NeoMutt *n)
	Initialise a Module - Implements Module::init()
static bool	pattern_config_define_variables (struct NeoMutt *n, struct ConfigSet *cs)
	Define the Config Variables - Implements Module::config_define_variables()
static bool	pattern_cleanup (struct NeoMutt *n, void *data)
	Clean up a Module - Implements Module::cleanup()

Variables
struct ConfigDef	PatternVars []
	Config definitions for the pattern library.
const struct Module	ModulePattern
	Module for the Pattern library.

Detailed Description

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

pattern_init()

static bool pattern_init ( struct NeoMutt * n )

static

Initialise a Module - Implements Module::init()

Definition at line 43 of file module.c.

{
  struct PatternModuleData *mod_data = MUTT_MEM_CALLOC(1, struct PatternModuleData);
 
  // clang-format off
  mod_data->range_regexes[RANGE_K_REL]  = (struct RangeRegex){ RANGE_REL_RX,  1, 3, 0, { 0 } };
  mod_data->range_regexes[RANGE_K_ABS]  = (struct RangeRegex){ RANGE_ABS_RX,  1, 3, 0, { 0 } };
  mod_data->range_regexes[RANGE_K_LT]   = (struct RangeRegex){ RANGE_LT_RX,   1, 2, 0, { 0 } };
  mod_data->range_regexes[RANGE_K_GT]   = (struct RangeRegex){ RANGE_GT_RX,   2, 1, 0, { 0 } };
  mod_data->range_regexes[RANGE_K_BARE] = (struct RangeRegex){ RANGE_BARE_RX, 1, 1, 0, { 0 } };
  // clang-format on
 
  neomutt_set_module_data(n, MODULE_ID_PATTERN, 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:

pattern_config_define_variables()

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

static

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

Definition at line 66 of file module.c.

{
  return cs_register_variables(cs, PatternVars);
}

Here is the call graph for this function:

pattern_cleanup()

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

static

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

Definition at line 74 of file module.c.

{
  struct PatternModuleData *mod_data = data;
 
  notify_free(&mod_data->notify);
 
  for (int i = 0; i < RANGE_K_INVALID; i++)
  {
    if (mod_data->range_regexes[i].ready)
      regfree(&mod_data->range_regexes[i].cooked);
  }
 
  FREE(&mod_data);
  return true;
}

Here is the call graph for this function:

Variable Documentation

PatternVars

struct ConfigDef PatternVars[]

extern

Config definitions for the pattern library.

Definition at line 57 of file config.c.

                                 {
  // clang-format off
  { "external_search_command", DT_STRING|D_STRING_COMMAND, 0, 0, NULL,
    "External search command"
  },
  { "pattern_format", DT_EXPANDO, IP "%2n %-15e  %d", IP &PatternFormatDef, NULL,
    "printf-like format string for the pattern completion menu"
  },
  { "simple_search", DT_STRING, IP "~f %s | ~s %s", 0, NULL,
    "Pattern to search for when search doesn't contain ~'s"
  },
  { "thorough_search", DT_BOOL, true, 0, NULL,
    "Decode headers and messages before searching them"
  },
  { NULL },
  // clang-format on
};

ModulePattern

const struct Module ModulePattern

Initial value:

= {
  MODULE_ID_PATTERN,
  "pattern",
  pattern_init,
  NULL, 
  pattern_config_define_variables,
  NULL, 
  NULL, 
  NULL, 
  pattern_cleanup,
}

Module for the Pattern library.

Definition at line 93 of file module.c.

                                    {
  MODULE_ID_PATTERN,
  "pattern",
  pattern_init,
  NULL, // config_define_types
  pattern_config_define_variables,
  NULL, // commands_register
  NULL, // gui_init
  NULL, // gui_cleanup
  pattern_cleanup,
};