mutt_config.c File Reference

Definitions of config variables. More...

#include "config.h"
#include <ctype.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <stdio.h>
#include "mutt/lib.h"
#include "config/lib.h"
#include "email/lib.h"
#include "core/lib.h"
#include "attach/lib.h"
#include "expando/lib.h"
#include "index/lib.h"
#include "mutt_logging.h"
#include "mutt_thread.h"
#include "mx.h"

Include dependency graph for mutt_config.c:

Go to the source code of this file.

Macros
#define	CONFIG_INIT_TYPE(CS, NAME)
#define	CONFIG_INIT_VARS(CS, NAME)

Functions
static int	multipart_validator (const struct ConfigDef *cdef, intptr_t value, struct Buffer *err)
	Validate the "show_multipart_alternative" config variable - Implements ConfigDef::validator() -.
struct ExpandoNode *	parse_index_date_recv_local (const char *str, struct ExpandoFormat *fmt, int did, int uid, ExpandoParserFlags flags, const char **parsed_until, struct ExpandoParseError *err)
	Parse a Date Expando - Implements ExpandoDefinition::parse() -.
struct ExpandoNode *	parse_index_date_local (const char *str, struct ExpandoFormat *fmt, int did, int uid, ExpandoParserFlags flags, const char **parsed_until, struct ExpandoParseError *err)
	Parse a Date Expando - Implements ExpandoDefinition::parse() -.
struct ExpandoNode *	parse_index_date (const char *str, struct ExpandoFormat *fmt, int did, int uid, ExpandoParserFlags flags, const char **parsed_until, struct ExpandoParseError *err)
	Parse a Date Expando - Implements ExpandoDefinition::parse() -.
struct ExpandoNode *	parse_index_hook (const char *str, struct ExpandoFormat *fmt, int did, int uid, ExpandoParserFlags flags, const char **parsed_until, struct ExpandoParseError *err)
	Parse an index-hook - Implements ExpandoDefinition::parse() -.
struct ExpandoNode *	parse_tags_transformed (const char *str, struct ExpandoFormat *fmt, int did, int uid, ExpandoParserFlags flags, const char **parsed_until, struct ExpandoParseError *err)
	Parse a Tags-Transformed Expando - Implements ExpandoDefinition::parse() -.
struct ExpandoNode *	parse_subject (const char *str, struct ExpandoFormat *fmt, int did, int uid, ExpandoParserFlags flags, const char **parsed_until, struct ExpandoParseError *err)
	Parse a Subject Expando - Implements ExpandoDefinition::parse() -.
static bool	config_init_main (struct ConfigSet *cs)
	Register main config variables - Implements module_init_config_t -.
static void	init_types (struct ConfigSet *cs)
	Create the config types.
static void	init_variables (struct ConfigSet *cs)
	Define the config variables.
void	init_config (struct ConfigSet *cs)
	Initialise the config system.

Variables
const struct ExpandoDefinition	IndexFormatDef []
	Expando definitions.
static const struct Mapping	SortAuxMethods []
	Sort methods for '$sort_aux' for the index.
const struct Mapping	SortMethods []
	Sort methods for '$sort' for the index.
static const struct ExpandoDefinition	AttachFormatDef []
	Expando definitions.
static const struct ExpandoDefinition *const	IndexFormatDefNoPadding = &(IndexFormatDef[3])
	IndexFormatDefNoPadding - Index format definitions, without padding.
const struct ExpandoDefinition *const	StatusFormatDefNoPadding = &(StatusFormatDef[3])
	StatusFormatDefNoPadding - Status format definitions, without padding.
static struct ConfigDef	MainVars []
	General Config definitions for NeoMutt.
static struct ConfigDef	MainVarsIdn []
	IDN Config definitions.

Detailed Description

Definitions of config variables.

Authors

• Aditya De Saha
• Louis Brauer
• Pietro Cerutti
• Richard Russon
• Ashish Panigrahi
• наб
• Tóth János

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

Macro Definition Documentation

CONFIG_INIT_TYPE

#define CONFIG_INIT_TYPE	(		CS,
			NAME
	)

Value:

  extern const struct ConfigSetType Cst##NAME;                                 \
  cs_register_type(CS, &Cst##NAME)

Definition at line 54 of file mutt_config.c.

CONFIG_INIT_VARS

#define CONFIG_INIT_VARS	(		CS,
			NAME
	)

Value:

  bool config_init_##NAME(struct ConfigSet *cs);                               \
  config_init_##NAME(CS)

Definition at line 58 of file mutt_config.c.

Function Documentation

init_types()

static void init_types ( struct ConfigSet *  cs )

static

Create the config types.

Parameters

cs	Config items

Define the config types, e.g. DT_STRING.

Definition at line 868 of file mutt_config.c.

{
  CONFIG_INIT_TYPE(cs, Address);
  CONFIG_INIT_TYPE(cs, Bool);
  CONFIG_INIT_TYPE(cs, Enum);
  CONFIG_INIT_TYPE(cs, Expando);
  CONFIG_INIT_TYPE(cs, Long);
  CONFIG_INIT_TYPE(cs, Mbtable);
  CONFIG_INIT_TYPE(cs, MyVar);
  CONFIG_INIT_TYPE(cs, Number);
  CONFIG_INIT_TYPE(cs, Path);
  CONFIG_INIT_TYPE(cs, Quad);
  CONFIG_INIT_TYPE(cs, Regex);
  CONFIG_INIT_TYPE(cs, Slist);
  CONFIG_INIT_TYPE(cs, Sort);
  CONFIG_INIT_TYPE(cs, String);
}

Here is the caller graph for this function:

init_variables()

static void init_variables ( struct ConfigSet *  cs )

static

Define the config variables.

Parameters

cs	Config items

Definition at line 890 of file mutt_config.c.

{
  // Define the config variables
  config_init_main(cs);
  CONFIG_INIT_VARS(cs, alias);
#if defined(USE_AUTOCRYPT)
  CONFIG_INIT_VARS(cs, autocrypt);
#endif
  CONFIG_INIT_VARS(cs, browser);
  CONFIG_INIT_VARS(cs, compose);
  CONFIG_INIT_VARS(cs, conn);
  CONFIG_INIT_VARS(cs, email);
#if defined(USE_HCACHE)
  CONFIG_INIT_VARS(cs, hcache);
#endif
  CONFIG_INIT_VARS(cs, helpbar);
  CONFIG_INIT_VARS(cs, history);
  CONFIG_INIT_VARS(cs, imap);
  CONFIG_INIT_VARS(cs, index);
  CONFIG_INIT_VARS(cs, maildir);
  CONFIG_INIT_VARS(cs, mbox);
  CONFIG_INIT_VARS(cs, menu);
  CONFIG_INIT_VARS(cs, mh);
  CONFIG_INIT_VARS(cs, ncrypt);
  CONFIG_INIT_VARS(cs, nntp);
#if defined(USE_NOTMUCH)
  CONFIG_INIT_VARS(cs, notmuch);
#endif
  CONFIG_INIT_VARS(cs, pager);
  CONFIG_INIT_VARS(cs, pattern);
  CONFIG_INIT_VARS(cs, pop);
  CONFIG_INIT_VARS(cs, progress);
  CONFIG_INIT_VARS(cs, send);
  CONFIG_INIT_VARS(cs, sidebar);
}

Here is the call graph for this function:

Here is the caller graph for this function:

init_config()

void init_config

(

struct ConfigSet *

cs

)

Initialise the config system.

Parameters

cs	Config items

Definition at line 930 of file mutt_config.c.

{
  init_types(cs);
  init_variables(cs);
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

IndexFormatDef

const struct ExpandoDefinition IndexFormatDef[]

Expando definitions.

Config:

• $attribution_intro
• $attribution_trailer
• $forward_attribution_intro
• $forward_attribution_trailer
• $forward_format
• $index_format
• $message_format
• $pager_format

Note

Longer Expandos must precede any similar, but shorter Expandos

Definition at line 312 of file mutt_config.c.

SortAuxMethods

const struct Mapping SortAuxMethods[]

static

Initial value:

= {
  
  { "date",          EMAIL_SORT_DATE },
  { "date-received", EMAIL_SORT_DATE_RECEIVED },
  { "from",          EMAIL_SORT_FROM },
  { "label",         EMAIL_SORT_LABEL },
  { "score",         EMAIL_SORT_SCORE },
  { "size",          EMAIL_SORT_SIZE },
  { "spam",          EMAIL_SORT_SPAM },
  { "subject",       EMAIL_SORT_SUBJECT },
  { "to",            EMAIL_SORT_TO },
  { "unsorted",      EMAIL_SORT_UNSORTED },
  
  { "date-sent",     EMAIL_SORT_DATE },
  { "mailbox-order", EMAIL_SORT_UNSORTED },
  { "threads",       EMAIL_SORT_DATE },
  { NULL, 0 },
  
}

Sort methods for '$sort_aux' for the index.

Definition at line 65 of file mutt_config.c.

SortMethods

const struct Mapping SortMethods[]

Initial value:

= {
  
  { "date",          EMAIL_SORT_DATE },
  { "date-received", EMAIL_SORT_DATE_RECEIVED },
  { "from",          EMAIL_SORT_FROM },
  { "label",         EMAIL_SORT_LABEL },
  { "score",         EMAIL_SORT_SCORE },
  { "size",          EMAIL_SORT_SIZE },
  { "spam",          EMAIL_SORT_SPAM },
  { "subject",       EMAIL_SORT_SUBJECT },
  { "threads",       EMAIL_SORT_THREADS },
  { "to",            EMAIL_SORT_TO },
  { "unsorted",      EMAIL_SORT_UNSORTED },
  
  { "date-sent",     EMAIL_SORT_DATE },
  { "mailbox-order", EMAIL_SORT_UNSORTED },
  { NULL, 0 },
  
}

Sort methods for '$sort' for the index.

Definition at line 88 of file mutt_config.c.

AttachFormatDef

const struct ExpandoDefinition AttachFormatDef[]

static

Initial value:

= {
  
  { "*", "padding-soft",     ED_GLOBAL, ED_GLO_PADDING_SOFT,     node_padding_parse },
  { ">", "padding-hard",     ED_GLOBAL, ED_GLO_PADDING_HARD,     node_padding_parse },
  { "|", "padding-eol",      ED_GLOBAL, ED_GLO_PADDING_EOL,      node_padding_parse },
  { "c", "charset-convert",  ED_BODY,   ED_BOD_CHARSET_CONVERT,  NULL },
  { "C", "charset",          ED_ATTACH, ED_ATT_CHARSET,          NULL },
  { "d", "description",      ED_BODY,   ED_BOD_DESCRIPTION,      NULL },
  { "D", "deleted",          ED_BODY,   ED_BOD_DELETED,          NULL },
  { "e", "mime-encoding",    ED_BODY,   ED_BOD_MIME_ENCODING,    NULL },
  { "f", "file",             ED_BODY,   ED_BOD_FILE,             NULL },
  { "F", "file-disposition", ED_BODY,   ED_BOD_FILE_DISPOSITION, NULL },
  { "I", "disposition",      ED_BODY,   ED_BOD_DISPOSITION,      NULL },
  { "m", "mime-major",       ED_BODY,   ED_BOD_MIME_MAJOR,       NULL },
  { "M", "mime-minor",       ED_BODY,   ED_BOD_MIME_MINOR,       NULL },
  { "n", "number",           ED_ATTACH, ED_ATT_NUMBER,           NULL },
  { "Q", "attach-qualifies", ED_BODY,   ED_BOD_ATTACH_QUALIFIES, NULL },
  { "s", "file-size",        ED_BODY,   ED_BOD_FILE_SIZE,        NULL },
  { "t", "tagged",           ED_BODY,   ED_BOD_TAGGED,           NULL },
  { "T", "tree",             ED_ATTACH, ED_ATT_TREE,             NULL },
  { "u", "unlink",           ED_BODY,   ED_BOD_UNLINK,           NULL },
  { "X", "attach-count",     ED_BODY,   ED_BOD_ATTACH_COUNT,     NULL },
  { NULL, NULL, 0, -1, NULL }
  
}

Expando definitions.

Config:

• $attach_format

Definition at line 131 of file mutt_config.c.

IndexFormatDefNoPadding

const struct ExpandoDefinition* const IndexFormatDefNoPadding = &(IndexFormatDef[3])

static

IndexFormatDefNoPadding - Index format definitions, without padding.

Definition at line 373 of file mutt_config.c.

StatusFormatDefNoPadding

const struct ExpandoDefinition* const StatusFormatDefNoPadding = &(StatusFormatDef[3])

StatusFormatDefNoPadding - Status format definitions, without padding.

Definition at line 376 of file mutt_config.c.

MainVars

struct ConfigDef MainVars[]

static

General Config definitions for NeoMutt.

Definition at line 381 of file mutt_config.c.

MainVarsIdn

struct ConfigDef MainVarsIdn[]

static

Initial value:

= {
  
  { "idn_decode", DT_BOOL, true, 0, NULL,
    "(idn) Decode international domain names"
  },
  { "idn_encode", DT_BOOL, true, 0, NULL,
    "(idn) Encode international domain names"
  },
  { NULL },
  
}

IDN Config definitions.

Definition at line 835 of file mutt_config.c.