config_cache.c File Reference

Cache of config variables. More...

#include "config.h"
#include <stdbool.h>
#include <string.h>
#include "mutt/lib.h"
#include "config/lib.h"
#include "config_cache.h"
#include "neomutt.h"

Include dependency graph for config_cache.c:

Go to the source code of this file.

Functions
static int	cc_config_observer (struct NotifyCallback *nc)
	Notification that a Config Variable has changed - Implements observer_t -.
static void	cache_setup (void)
	Setup a cache of some config variables.
const struct Slist *	cc_assumed_charset (void)
	Get the cached value of $assumed_charset.
const char *	cc_charset (void)
	Get the cached value of $charset.
const char *	cc_maildir_field_delimiter (void)
	Get the cached value of $maildir_field_delimiter.
void	config_cache_cleanup (void)
	Cleanup the cache of charset config variables.

Variables
static bool	CacheActive = false
	Is the cache enabled?
static const struct Slist *	CachedAssumedCharset = NULL
	Cached value of $assumed_charset.
static const char *	CachedCharset = NULL
	Cached value of $charset.
static const char *	CachedMaildirFieldDelimiter = NULL
	Cached value of $maildir_field_delimiter.

Detailed Description

Cache of config variables.

Authors

• Richard Russon
• Pietro Cerutti

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

Function Documentation

cache_setup()

static void cache_setup ( void  )

static

Setup a cache of some config variables.

Definition at line 83 of file config_cache.c.

{
  if (CacheActive)
    return; // LCOV_EXCL_LINE
 
  notify_observer_add(NeoMutt->sub->notify, NT_CONFIG, cc_config_observer, NULL);
 
  CachedAssumedCharset = cs_subset_slist(NeoMutt->sub, "assumed_charset");
  CachedCharset = cs_subset_string(NeoMutt->sub, "charset");
  CachedMaildirFieldDelimiter = cs_subset_string(NeoMutt->sub, "maildir_field_delimiter");
 
  CacheActive = true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

cc_assumed_charset()

const struct Slist * cc_assumed_charset

(

void

)

Get the cached value of $assumed_charset.

Return values

ptr	Value of $assumed_charset

Definition at line 101 of file config_cache.c.

{
  if (!CacheActive)
  {
    cache_setup();
    CachedAssumedCharset = cs_subset_slist(NeoMutt->sub, "assumed_charset");
  }
 
  return CachedAssumedCharset;
}

Here is the call graph for this function:

Here is the caller graph for this function:

cc_charset()

const char * cc_charset

(

void

)

Get the cached value of $charset.

Return values

ptr	Value of $charset

Definition at line 116 of file config_cache.c.

{
  if (!CacheActive)
  {
    cache_setup();
    CachedCharset = cs_subset_string(NeoMutt->sub, "charset");
  }
 
  return CachedCharset;
}

Here is the call graph for this function:

Here is the caller graph for this function:

cc_maildir_field_delimiter()

const char * cc_maildir_field_delimiter

(

void

)

Get the cached value of $maildir_field_delimiter.

Return values

ptr	Value of $maildir_field_delimiter

Definition at line 131 of file config_cache.c.

{
  if (!CacheActive)
  {
    cache_setup();
    CachedMaildirFieldDelimiter = cs_subset_string(NeoMutt->sub, "maildir_field_delimiter");
  }
 
  return CachedMaildirFieldDelimiter;
}

Here is the call graph for this function:

Here is the caller graph for this function:

config_cache_cleanup()

void config_cache_cleanup

(

void

)

Cleanup the cache of charset config variables.

Definition at line 145 of file config_cache.c.

{
  if (NeoMutt)
    notify_observer_remove(NeoMutt->sub->notify, cc_config_observer, NULL);
 
  // Don't free them, the config system owns the data
  CachedAssumedCharset = NULL;
  CachedCharset = NULL;
  CachedMaildirFieldDelimiter = NULL;
 
  CacheActive = false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

CacheActive

bool CacheActive = false

static

Is the cache enabled?

Definition at line 39 of file config_cache.c.

CachedAssumedCharset

const struct Slist* CachedAssumedCharset = NULL

static

Cached value of $assumed_charset.

Definition at line 41 of file config_cache.c.

CachedCharset

const char* CachedCharset = NULL

static

Cached value of $charset.

Definition at line 43 of file config_cache.c.

CachedMaildirFieldDelimiter

const char* CachedMaildirFieldDelimiter = NULL

static

Cached value of $maildir_field_delimiter.

Definition at line 45 of file config_cache.c.