store.c File Reference

Shared store code. More...

#include "config.h"
#include <stdbool.h>
#include <stdio.h>
#include "mutt/lib.h"
#include "config/lib.h"
#include "lib.h"

Include dependency graph for store.c:

Go to the source code of this file.

Macros
#define	STORE_BACKEND(name)

Functions
struct Slist *	store_backend_list (void)
	Get a list of backend names.
const struct StoreOps *	store_get_backend_ops (const char *str)
	Get the API functions for an store backend.
bool	store_is_valid_backend (const char *str)
	Is the string a valid Store backend.

Variables
static const struct StoreOps *	StoreOps []
	Backend implementations.

Detailed Description

Shared store code.

Authors

• Pietro Cerutti
• 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 store.c.

Macro Definition Documentation

STORE_BACKEND

#define STORE_BACKEND

(

name

)

Value:

extern const struct StoreOps store_##name##_ops;

Definition at line 37 of file store.c.

Function Documentation

store_backend_list()

struct Slist * store_backend_list

(

void

)

Get a list of backend names.

Return values

ptr	List of names

Note

Caller should free the Slist

Definition at line 69 of file store.c.

{
  struct Slist *sl = slist_new(D_SLIST_SEP_SPACE);
 
  const struct StoreOps **store_ops = StoreOps;
 
  for (; *store_ops; store_ops++)
  {
    slist_add_string(sl, (*store_ops)->name);
  }
 
  return sl;
}

Here is the call graph for this function:

Here is the caller graph for this function:

store_get_backend_ops()

const struct StoreOps * store_get_backend_ops

(

const char *

str

)

Get the API functions for an store backend.

Parameters

str	Name of the Store

Return values

ptr	Set of function pointers

Definition at line 88 of file store.c.

{
  const struct StoreOps **store_ops = StoreOps;
 
  if (!str || (*str == '\0'))
  {
    return *store_ops;
  }
 
  for (; *store_ops; store_ops++)
    if (mutt_str_equal(str, (*store_ops)->name))
      return *store_ops;
 
  return NULL;
}

Here is the call graph for this function:

Here is the caller graph for this function:

store_is_valid_backend()

bool store_is_valid_backend

(

const char *

str

)

Is the string a valid Store backend.

Parameters

str	Store name

Return values

true	s is recognized as a valid backend
false	otherwise

Definition at line 110 of file store.c.

{
  return store_get_backend_ops(str);
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

StoreOps

const struct StoreOps* StoreOps[]

static

Initial value:

= {
 
  &store_lmdb_ops, 
 
 
  &store_gdbm_ops, 
 
 
 
 
 
  &store_tdb_ops,
 
  NULL,
}

Backend implementations.

Definition at line 47 of file store.c.

                                           {
#ifdef HAVE_LMDB
  &store_lmdb_ops, // Strongly recommended
#endif
#ifdef HAVE_GDBM
  &store_gdbm_ops, // Good fallback
#endif
#ifdef HAVE_ROCKSDB
  &store_rocksdb_ops,
#endif
#ifdef HAVE_TDB
  &store_tdb_ops,
#endif
  NULL,
};