module.c File Reference

Definition of the Index Module. More...

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

Include dependency graph for module.c:

Go to the source code of this file.

Functions
static bool	index_init (struct NeoMutt *n)
	Initialise a Module - Implements Module::init()
static bool	index_config_define_variables (struct NeoMutt *n, struct ConfigSet *cs)
	Define the Config Variables - Implements Module::config_define_variables()
static bool	index_commands_register (struct NeoMutt *n, struct CommandArray *ca)
	Register NeoMutt Commands - Implements Module::commands_register()
static bool	index_cleanup (struct NeoMutt *n)
	Clean up a Module - Implements Module::cleanup()

Variables
struct ConfigDef	IndexVars []
	Config definitions for the Index.
const struct Command	IndexCommands []
	Index Commands.
const struct Module	ModuleIndex
	Module for the Index library.

Detailed Description

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

index_init()

static bool index_init ( struct NeoMutt * n )

static

Initialise a Module - Implements Module::init()

Definition at line 45 of file module.c.

{
  struct IndexModuleData *md = MUTT_MEM_CALLOC(1, struct IndexModuleData);
  neomutt_set_module_data(n, MODULE_ID_INDEX, md);
 
  subjectrx_init(n, md);
  return true;
}

Here is the call graph for this function:

index_config_define_variables()

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

static

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

Definition at line 57 of file module.c.

{
  return cs_register_variables(cs, IndexVars);
}

Here is the call graph for this function:

index_commands_register()

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

static

Register NeoMutt Commands - Implements Module::commands_register()

Definition at line 65 of file module.c.

{
  return commands_register(ca, IndexCommands);
}

Here is the call graph for this function:

index_cleanup()

static bool index_cleanup ( struct NeoMutt * n )

static

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

Definition at line 73 of file module.c.

{
  struct IndexModuleData *md = neomutt_get_module_data(n, MODULE_ID_INDEX);
  ASSERT(md);
 
  subjectrx_cleanup(md);
 
  FREE(&md);
  return true;
}

Here is the call graph for this function:

Variable Documentation

IndexVars

struct ConfigDef IndexVars[]

extern

Config definitions for the Index.

Definition at line 87 of file config.c.

                               {
  // clang-format off
  { "beep_new", DT_BOOL, false, 0, NULL,
    "Make a noise when new mail arrives"
  },
  { "change_folder_next", DT_BOOL, false, 0, NULL,
    "Suggest the next folder, rather than the first when using '<change-folder>'"
  },
  { "collapse_all", DT_BOOL, false, 0, NULL,
    "Collapse all threads when entering a folder"
  },
  { "crypt_chars", DT_MBTABLE, IP "SPsK ", 0, NULL,
    "User-configurable crypto flags: signed, encrypted etc."
  },
  { "flag_chars", DT_MBTABLE, IP "*!DdrONon- ", 0, NULL,
    "User-configurable index flags: tagged, new, etc"
  },
  { "from_chars", DT_MBTABLE, 0, 0, NULL,
    "User-configurable index flags: to address, cc address, etc"
  },
  { "index_format", DT_EXPANDO|D_NOT_EMPTY, IP "%4C %Z %{%b %d} %-15.15L (%<l?%4l&%4c>) %s", IP &IndexFormatDef, NULL,
    "printf-like format string for the index menu (emails)"
  },
  { "mark_macro_prefix", DT_STRING, IP "'", 0, NULL,
    "Prefix for macros using '<mark-message>'"
  },
  { "new_mail_command", DT_EXPANDO|D_STRING_COMMAND, 0, IP StatusFormatDefNoPadding, NULL,
    "External command to run when new mail arrives"
  },
  { "quit", DT_QUAD, MUTT_YES, 0, NULL,
    "Prompt before exiting NeoMutt"
  },
  { "read_only", DT_BOOL, false, 0, NULL,
    "Open folders in read-only mode"
  },
  // L10N: $status_format default format
  { "status_format", DT_EXPANDO|D_L10N_STRING, IP N_("-%r-NeoMutt: %D [Msgs:%<M?%M/>%m%<n? New:%n>%<o? Old:%o>%<d? Del:%d>%<F? Flag:%F>%<t? Tag:%t>%<p? Post:%p>%<b? Inc:%b>%<l? %l>]---(%<T?%T/>%s/%S)-%>-(%P)---"), IP &StatusFormatDef, NULL,
    "printf-like format string for the index's status line"
  },
  { "status_chars", DT_MBTABLE, IP "-*%A", 0, NULL,
    "Indicator characters for the status bar"
  },
  { "to_chars", DT_MBTABLE, IP " +TCFLR", 0, NULL,
    "Indicator characters for the 'To' field in the index"
  },
  { "ts_enabled", DT_BOOL, false, 0, NULL,
    "Allow NeoMutt to set the terminal status line and icon"
  },
  // L10N: $ts_icon_format default format
  { "ts_icon_format", DT_EXPANDO|D_L10N_STRING, IP N_("M%<n?AIL&ail>"), IP StatusFormatDefNoPadding, NULL,
    "printf-like format string for the terminal's icon title"
  },
  // L10N: $ts_status_format default format
  { "ts_status_format", DT_EXPANDO|D_L10N_STRING, IP N_("NeoMutt with %<m?%m messages&no messages>%<n? [%n NEW]>"), IP StatusFormatDefNoPadding, NULL,
    "printf-like format string for the terminal's status (window title)"
  },
  { "uncollapse_jump", DT_BOOL, false, 0, NULL,
    "When opening a thread, jump to the next unread message"
  },
  { "uncollapse_new", DT_BOOL, true, 0, NULL,
    "Open collapsed threads when new mail arrives"
  },
 
  { "hdr_format",       DT_SYNONYM, IP "index_format",   IP "2021-03-21" },
  { "xterm_icon",       DT_SYNONYM, IP "ts_icon_format", IP "2021-03-21" },
  { "xterm_set_titles", DT_SYNONYM, IP "ts_enabled",     IP "2021-03-21" },
  { "xterm_title",      DT_SYNONYM, IP "ts_status_format", IP "2021-03-21" },
 
  { NULL },
  // clang-format on
};

IndexCommands

const struct Command IndexCommands[]

extern

Index Commands.

Definition at line 38 of file commands.c.

                                       {
  // clang-format off
  { "subject-regex", CMD_SUBJECT_REGEX, parse_subjectrx_list,
        N_("Apply regex-based rewriting to message subjects"),
        N_("subject-regex <regex> <replacement>"),
        "advancedusage.html#display-munging" },
  { "unsubject-regex", CMD_UNSUBJECT_REGEX, parse_unsubjectrx_list,
        N_("Remove subject-rewriting rules"),
        N_("unsubject-regex { * | <regex> }"),
        "advancedusage.html#display-munging" },
 
  // Deprecated
  { "subjectrx",           CMD_NONE, NULL, "subject-regex",       NULL, NULL, CF_SYNONYM },
  { "unsubjectrx",         CMD_NONE, NULL, "unsubject-regex",     NULL, NULL, CF_SYNONYM },
 
  { NULL, CMD_NONE, NULL, NULL, NULL, NULL, CF_NO_FLAGS },
  // clang-format on
};

ModuleIndex

const struct Module ModuleIndex

Initial value:

= {
  MODULE_ID_INDEX,
  "index",
  index_init,
  NULL, 
  index_config_define_variables,
  index_commands_register,
  NULL, 
  NULL, 
  index_cleanup,
}

Module for the Index library.

Definition at line 87 of file module.c.

                                  {
  MODULE_ID_INDEX,
  "index",
  index_init,
  NULL, // config_define_types
  index_config_define_variables,
  index_commands_register,
  NULL, // gui_init
  NULL, // gui_cleanup
  index_cleanup,
};