mutt_config.c File Reference

Definitions of config variables. More...

#include "config.h"
#include <stddef.h>
#include <stdbool.h>
#include "mutt/lib.h"
#include "address/lib.h"
#include "config/lib.h"
#include "email/lib.h"
#include "core/lib.h"
#include "alias/lib.h"
#include "gui/lib.h"
#include "bcache/lib.h"
#include "compose/lib.h"
#include "browser.h"
#include "commands.h"
#include "handler.h"
#include "hdrline.h"
#include "hook.h"
#include "index.h"
#include "init.h"
#include "mailcap.h"
#include "main.h"
#include "mutt_globals.h"
#include "mutt_logging.h"
#include "mutt_mailbox.h"
#include "mutt_menu.h"
#include "mutt_thread.h"
#include "muttlib.h"
#include "mx.h"
#include "pager.h"
#include "progress.h"
#include "recvattach.h"
#include "recvcmd.h"
#include "remailer.h"
#include "rfc3676.h"
#include "score.h"
#include "sort.h"
#include "status.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
int	multipart_validator (const struct ConfigSet *cs, const struct ConfigDef *cdef, intptr_t value, struct Buffer *err)
	Validate the "show_multipart_alternative" config variable - Implements ConfigDef::validator() More...
int	pager_validator (const struct ConfigSet *cs, const struct ConfigDef *cdef, intptr_t value, struct Buffer *err)
	Check for config variables that can't be set from the pager - Implements ConfigDef::validator() More...
int	reply_validator (const struct ConfigSet *cs, const struct ConfigDef *cdef, intptr_t value, struct Buffer *err)
	Validate the "reply_regex" config variable - Implements ConfigDef::validator() More...
static bool	config_init_main (struct ConfigSet *cs)
	Register main config variables - Implements module_init_config_t. More...
static void	init_types (struct ConfigSet *cs)
	Create the config types. More...
static void	init_variables (struct ConfigSet *cs)
	Define the config variables. More...
struct ConfigSet *	init_config (size_t size)
	Initialise the config system. More...

Variables
char *	C_Escape = NULL
bool	C_IgnoreLinearWhiteSpace = false
const struct Mapping	SortAuxMethods []
	Sort methods for '$sort_aux' for the index. More...
const struct Mapping	SortMethods []
	Sort methods for '$sort' for the index. More...
const struct Mapping	SortBrowserMethods []
	Sort methods for the folder/dir browser. More...
struct ConfigDef	MainVars []

Detailed Description

Definitions of config variables.

Authors

• Michael R. Elkins
• g10 Code GmbH

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 68 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 72 of file mutt_config.c.

Function Documentation

multipart_validator()

int multipart_validator	(	const struct ConfigSet *	cs,
		const struct ConfigDef *	cdef,
		intptr_t	value,
		struct Buffer *	err
	)

Validate the "show_multipart_alternative" config variable - Implements ConfigDef::validator()

Definition at line 142 of file mutt_config.c.

{
  if (value == 0)
    return CSR_SUCCESS;

  const char *str = (const char *) value;

  if (mutt_str_equal(str, "inline") || mutt_str_equal(str, "info"))
    return CSR_SUCCESS;

  mutt_buffer_printf(err, _("Invalid value for option %s: %s"), cdef->name, str);
  return CSR_ERR_INVALID;
}

Here is the call graph for this function:

pager_validator()

int pager_validator	(	const struct ConfigSet *	cs,
		const struct ConfigDef *	cdef,
		intptr_t	value,
		struct Buffer *	err
	)

Check for config variables that can't be set from the pager - Implements ConfigDef::validator()

Definition at line 160 of file mutt_config.c.

{
  if (CurrentMenu == MENU_PAGER)
  {
    mutt_buffer_printf(err, _("Option %s may not be set or reset from the pager"),
                       cdef->name);
    return CSR_ERR_INVALID;
  }

  return CSR_SUCCESS;
}

Here is the call graph for this function:

Here is the caller graph for this function:

reply_validator()

int reply_validator	(	const struct ConfigSet *	cs,
		const struct ConfigDef *	cdef,
		intptr_t	value,
		struct Buffer *	err
	)

Validate the "reply_regex" config variable - Implements ConfigDef::validator()

Definition at line 176 of file mutt_config.c.

{
  if (pager_validator(cs, cdef, value, err) != CSR_SUCCESS)
    return CSR_ERR_INVALID;

  if (!OptAttachMsg)
    return CSR_SUCCESS;

  mutt_buffer_printf(err, _("Option %s may not be set when in attach-message mode"),
                     cdef->name);
  return CSR_ERR_INVALID;
}

Here is the call graph for this function:

config_init_main()

static bool config_init_main ( struct ConfigSet *  cs )

static

Register main config variables - Implements module_init_config_t.

Definition at line 776 of file mutt_config.c.

{
  return cs_register_variables(cs, MainVars, 0);
}

Here is the call graph for this function:

Here is the caller graph for this function:

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 787 of file mutt_config.c.

{
  CONFIG_INIT_TYPE(cs, address);
  CONFIG_INIT_TYPE(cs, bool);
  CONFIG_INIT_TYPE(cs, enum);
  CONFIG_INIT_TYPE(cs, long);
  CONFIG_INIT_TYPE(cs, mbtable);
  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 807 of file mutt_config.c.

{
  // Define the config variables
  config_init_main(cs);
  CONFIG_INIT_VARS(cs, alias);
#ifdef USE_AUTOCRYPT
  CONFIG_INIT_VARS(cs, autocrypt);
#endif
  CONFIG_INIT_VARS(cs, compose);
  CONFIG_INIT_VARS(cs, conn);
#ifdef USE_HCACHE
  CONFIG_INIT_VARS(cs, hcache);
#endif
  CONFIG_INIT_VARS(cs, helpbar);
  CONFIG_INIT_VARS(cs, history);
#ifdef USE_IMAP
  CONFIG_INIT_VARS(cs, imap);
#endif
  CONFIG_INIT_VARS(cs, maildir);
  CONFIG_INIT_VARS(cs, mbox);
  CONFIG_INIT_VARS(cs, ncrypt);
#ifdef USE_NNTP
  CONFIG_INIT_VARS(cs, nntp);
#endif
#ifdef USE_NOTMUCH
  CONFIG_INIT_VARS(cs, notmuch);
#endif
  CONFIG_INIT_VARS(cs, pattern);
#ifdef USE_POP
  CONFIG_INIT_VARS(cs, pop);
#endif
  CONFIG_INIT_VARS(cs, send);
#ifdef USE_SIDEBAR
  CONFIG_INIT_VARS(cs, sidebar);
#endif
}

Here is the call graph for this function:

Here is the caller graph for this function:

init_config()

struct ConfigSet* init_config

(

size_t

size

)

Initialise the config system.

Parameters

size	Size for Config Hash Table

Return values

ptr	New Config Set

Definition at line 849 of file mutt_config.c.

{
  struct ConfigSet *cs = cs_new(size);

  init_types(cs);
  init_variables(cs);

  return cs;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

C_Escape

char* C_Escape = NULL

Definition at line 77 of file mutt_config.c.

C_IgnoreLinearWhiteSpace

bool C_IgnoreLinearWhiteSpace = false

Definition at line 78 of file mutt_config.c.

SortAuxMethods

const struct Mapping SortAuxMethods[]

Initial value:

= {
  
  { "date",          SORT_DATE },
  { "date-received", SORT_RECEIVED },
  { "date-sent",     SORT_DATE },
  { "from",          SORT_FROM },
  { "label",         SORT_LABEL },
  { "mailbox-order", SORT_ORDER },
  { "score",         SORT_SCORE },
  { "size",          SORT_SIZE },
  { "spam",          SORT_SPAM },
  { "subject",       SORT_SUBJECT },
  { "threads",       SORT_DATE },
  { "to",            SORT_TO },
  { NULL,            0 },
  
}

Sort methods for '$sort_aux' for the index.

Definition at line 83 of file mutt_config.c.

SortMethods

const struct Mapping SortMethods[]

Initial value:

= {
  
  { "date",          SORT_DATE },
  { "date-received", SORT_RECEIVED },
  { "date-sent",     SORT_DATE },
  { "from",          SORT_FROM },
  { "label",         SORT_LABEL },
  { "mailbox-order", SORT_ORDER },
  { "score",         SORT_SCORE },
  { "size",          SORT_SIZE },
  { "spam",          SORT_SPAM },
  { "subject",       SORT_SUBJECT },
  { "threads",       SORT_THREADS },
  { "to",            SORT_TO },
  { NULL,            0 },
  
}

Sort methods for '$sort' for the index.

Definition at line 104 of file mutt_config.c.

SortBrowserMethods

const struct Mapping SortBrowserMethods[]

Initial value:

= {
  
  { "alpha",    SORT_SUBJECT },
  { "count",    SORT_COUNT },
  { "date",     SORT_DATE },
  { "desc",     SORT_DESC },
  { "new",      SORT_UNREAD },
  { "unread",   SORT_UNREAD },
  { "size",     SORT_SIZE },
  { "unsorted", SORT_ORDER },
  { NULL,       0 },
  
}

Sort methods for the folder/dir browser.

Definition at line 125 of file mutt_config.c.

MainVars

struct ConfigDef MainVars[]

Definition at line 190 of file mutt_config.c.