bool.c File Reference

Type representing a boolean. More...

#include "config.h"
#include <limits.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include "mutt/lib.h"
#include "bool.h"
#include "set.h"
#include "subset.h"
#include "types.h"

Include dependency graph for bool.c:

Go to the source code of this file.

Functions
static int	bool_string_set (void *var, struct ConfigDef *cdef, const char *value, struct Buffer *err)
	Set a Bool by string - Implements ConfigSetType::string_set() -.
static int	bool_string_get (void *var, const struct ConfigDef *cdef, struct Buffer *result)
	Get a Bool as a string - Implements ConfigSetType::string_get() -.
static int	bool_native_set (void *var, const struct ConfigDef *cdef, intptr_t value, struct Buffer *err)
	Set a Bool config item by bool - Implements ConfigSetType::native_set() -.
static intptr_t	bool_native_get (void *var, const struct ConfigDef *cdef, struct Buffer *err)
	Get a bool from a Bool config item - Implements ConfigSetType::native_get() -.
static bool	bool_has_been_set (void *var, const struct ConfigDef *cdef)
	Is the config value different to its initial value?
static int	bool_reset (void *var, const struct ConfigDef *cdef, struct Buffer *err)
	Reset a Bool to its initial value - Implements ConfigSetType::reset() -.
int	bool_he_toggle (struct ConfigSubset *sub, struct HashElem *he, struct Buffer *err)
	Toggle the value of a bool.
int	bool_str_toggle (struct ConfigSubset *sub, const char *name, struct Buffer *err)
	Toggle the value of a bool.

Variables
const char *	BoolValues []
	Valid strings for creating a Bool.
const struct ConfigSetType	CstBool
	Config type representing an boolean.

Detailed Description

Type representing a boolean.

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

Function Documentation

bool_he_toggle()

int bool_he_toggle	(	struct ConfigSubset *	sub,
		struct HashElem *	he,
		struct Buffer *	err )

Toggle the value of a bool.

Parameters

sub	Config Subset
he	HashElem representing config item
err	Buffer for error messages

Return values

num	Result, e.g. CSR_SUCCESS

Definition at line 201 of file bool.c.

{
  if (!sub || !he || !he->data)
    return CSR_ERR_CODE;
 
  struct HashElem *he_base = cs_get_base(he);
  if (CONFIG_TYPE(he_base->type) != DT_BOOL)
    return CSR_ERR_CODE;
 
  intptr_t value = cs_he_native_get(sub->cs, he, err);
  if (value == INT_MIN)
    return CSR_ERR_CODE;
 
  int rc = cs_he_native_set(sub->cs, he, !value, err);
 
  if ((CSR_RESULT(rc) == CSR_SUCCESS) && !(rc & CSR_SUC_NO_CHANGE))
    cs_subset_notify_observers(sub, he, NT_CONFIG_SET);
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool_str_toggle()

int bool_str_toggle	(	struct ConfigSubset *	sub,
		const char *	name,
		struct Buffer *	err )

Toggle the value of a bool.

Parameters

sub	Config Subset
name	Name of config item
err	Buffer for error messages

Return values

num	Result, e.g. CSR_SUCCESS

Definition at line 229 of file bool.c.

{
  struct HashElem *he = cs_subset_create_inheritance(sub, name);
 
  return bool_he_toggle(sub, he, err);
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

BoolValues

const char* BoolValues[]

Initial value:

= {
  "no", "yes", "n", "y", "false", "true", "0", "1", "off", "on", NULL,
}

Valid strings for creating a Bool.

These strings are case-insensitive.

Definition at line 51 of file bool.c.

                           {
  "no", "yes", "n", "y", "false", "true", "0", "1", "off", "on", NULL,
};

CstBool

const struct ConfigSetType CstBool

Initial value:

= {
  DT_BOOL,
  "boolean",
  bool_string_set,
  bool_string_get,
  bool_native_set,
  bool_native_get,
  NULL, 
  NULL, 
  bool_has_been_set,
  bool_reset,
  NULL, 
}

Config type representing an boolean.

Definition at line 239 of file bool.c.

                                     {
  DT_BOOL,
  "boolean",
  bool_string_set,
  bool_string_get,
  bool_native_set,
  bool_native_get,
  NULL, // string_plus_equals
  NULL, // string_minus_equals
  bool_has_been_set,
  bool_reset,
  NULL, // destroy
};