quad.c File Reference

Type representing a quad-option. More...

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

Include dependency graph for quad.c:

Go to the source code of this file.

Functions
static int	quad_string_set (void *var, struct ConfigDef *cdef, const char *value, struct Buffer *err)
	Set a Quad-option by string - Implements ConfigSetType::string_set() -.
static int	quad_string_get (void *var, const struct ConfigDef *cdef, struct Buffer *result)
	Get a Quad-option as a string - Implements ConfigSetType::string_get() -.
static int	quad_native_set (void *var, const struct ConfigDef *cdef, intptr_t value, struct Buffer *err)
	Set a Quad-option config item by int - Implements ConfigSetType::native_set() -.
static intptr_t	quad_native_get (void *var, const struct ConfigDef *cdef, struct Buffer *err)
	Get an int object from a Quad-option config item - Implements ConfigSetType::native_get() -.
static bool	quad_has_been_set (void *var, const struct ConfigDef *cdef)
	Is the config value different to its initial value?
static int	quad_reset (void *var, const struct ConfigDef *cdef, struct Buffer *err)
	Reset a Quad-option to its initial value - Implements ConfigSetType::reset() -.
static int	quad_toggle (int opt)
	Toggle (invert) the value of a quad option.
int	quad_he_toggle (struct ConfigSubset *sub, struct HashElem *he, struct Buffer *err)
	Toggle the value of a quad.

Variables
const char *	QuadValues []
	Valid strings for creating a QuadValue.
const struct ConfigSetType	CstQuad
	Config type representing a quad-option.

Detailed Description

Type representing a quad-option.

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

Function Documentation

quad_toggle()

static int quad_toggle ( int opt )

static

Toggle (invert) the value of a quad option.

Parameters

opt	Value to toggle

Return values

num

New value

By toggling the low bit, the following are swapped:

• MUTT_NO <--> MUTT_YES
• MUTT_ASKNO <--> MUTT_ASKYES

Definition at line 209 of file quad.c.

{
  return opt ^ 1;
}

Here is the caller graph for this function:

quad_he_toggle()

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

Toggle the value of a quad.

Parameters

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

Return values

num	Result, e.g. CSR_SUCCESS

See also

quad_toggle()

Definition at line 223 of file quad.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_QUAD)
    return CSR_ERR_CODE;
 
  intptr_t value = cs_he_native_get(sub->cs, he, err);
  if (value == INT_MIN)
    return CSR_ERR_CODE;
 
  value = quad_toggle(value);
  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:

Variable Documentation

QuadValues

const char* QuadValues[]

Initial value:

= {
  "no", "yes", "ask-no", "ask-yes", NULL,
}

Valid strings for creating a QuadValue.

These strings are case-insensitive.

Definition at line 54 of file quad.c.

                           {
  "no", "yes", "ask-no", "ask-yes", NULL,
};

CstQuad

const struct ConfigSetType CstQuad

Initial value:

= {
  DT_QUAD,
  "quad",
  quad_string_set,
  quad_string_get,
  quad_native_set,
  quad_native_get,
  NULL, 
  NULL, 
  quad_has_been_set,
  quad_reset,
  NULL, 
}

Config type representing a quad-option.

Definition at line 248 of file quad.c.

                                     {
  DT_QUAD,
  "quad",
  quad_string_set,
  quad_string_get,
  quad_native_set,
  quad_native_get,
  NULL, // string_plus_equals
  NULL, // string_minus_equals
  quad_has_been_set,
  quad_reset,
  NULL, // destroy
};