Type representing a quad-option. More...

#include "config.h"
#include <stddef.h>
#include <limits.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 (const struct ConfigSet cs, void var, struct ConfigDef cdef, const char value, struct Buffer *err)
	Set a Quad-option by string - Implements ConfigSetType::string_set() More...

static int	quad_string_get (const struct ConfigSet cs, void var, const struct ConfigDef cdef, struct Buffer result)
	Get a Quad-option as a string - Implements ConfigSetType::string_get() More...

static int	quad_native_set (const struct ConfigSet cs, void var, const struct ConfigDef cdef, intptr_t value, struct Buffer err)
	Set a Quad-option config item by int - Implements ConfigSetType::native_set() More...

static intptr_t	quad_native_get (const struct ConfigSet cs, void var, const struct ConfigDef cdef, struct Buffer err)
	Get an int object from a Quad-option config item - Implements ConfigSetType::native_get() More...

static int	quad_reset (const struct ConfigSet cs, void var, const struct ConfigDef cdef, struct Buffer err)
	Reset a Quad-option to its initial value - Implements ConfigSetType::reset() More...

static int	quad_toggle (int opt)
	Toggle (invert) the value of a quad option. More...

int	quad_he_toggle (struct ConfigSubset sub, struct HashElem he, struct Buffer *err)
	Toggle the value of a quad. More...

int	quad_str_toggle (struct ConfigSubset sub, const char name, struct Buffer *err)
	Toggle the value of a quad. More...

Variables
const char *	QuadValues []
	Valid strings for creating a QuadValue. More...

const struct ConfigSetType	cst_quad
	Config type representing a quad-option. More...

Detailed Description

Type representing a quad-option.

Authors

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

Function Documentation

◆ quad_string_set()

static int quad_string_set	(	const struct ConfigSet *	cs,
		void *	var,
		struct ConfigDef *	cdef,
		const char *	value,
		struct Buffer *	err
	)

static

Set a Quad-option by string - Implements ConfigSetType::string_set()

Definition at line 55 of file quad.c.

 {
   if (!value)
     return CSR_ERR_CODE; /* LCOV_EXCL_LINE */
 
   int num = -1;
   for (size_t i = 0; QuadValues[i]; i++)
   {
     if (mutt_istr_equal(QuadValues[i], value))
     {
       num = i;
       break;
     }
   }
 
   if (num < 0)
   {
     mutt_buffer_printf(err, _("Invalid quad value: %s"), value);
     return CSR_ERR_INVALID | CSR_INV_TYPE;
   }
 
   if (var)
   {
     if (num == (*(char *) var))
       return CSR_SUCCESS | CSR_SUC_NO_CHANGE;
 
     if (cdef->validator)
     {
       int rc = cdef->validator(cs, cdef, (intptr_t) num, err);
 
       if (CSR_RESULT(rc) != CSR_SUCCESS)
         return rc | CSR_INV_VALIDATOR;
     }
 
     *(char *) var = num;
   }
   else
   {
     cdef->initial = num;
   }
 
   return CSR_SUCCESS;
 }

Here is the call graph for this function:

◆ quad_string_get()

static int quad_string_get	(	const struct ConfigSet *	cs,
		void *	var,
		const struct ConfigDef *	cdef,
		struct Buffer *	result
	)

static

Get a Quad-option as a string - Implements ConfigSetType::string_get()

Definition at line 103 of file quad.c.

 {
   unsigned int value;
 
   if (var)
     value = *(char *) var;
   else
     value = (int) cdef->initial;
 
   if (value >= (mutt_array_size(QuadValues) - 1))
   {
     mutt_debug(LL_DEBUG1, "Variable has an invalid value: %d\n", value);
     return CSR_ERR_INVALID | CSR_INV_TYPE;
   }
 
   mutt_buffer_addstr(result, QuadValues[value]);
   return CSR_SUCCESS;
 }

Here is the call graph for this function:

◆ quad_native_set()

static int quad_native_set	(	const struct ConfigSet *	cs,
		void *	var,
		const struct ConfigDef *	cdef,
		intptr_t	value,
		struct Buffer *	err
	)

static

Set a Quad-option config item by int - Implements ConfigSetType::native_set()

Definition at line 126 of file quad.c.

 {
   if ((value < 0) || (value >= (mutt_array_size(QuadValues) - 1)))
   {
     mutt_buffer_printf(err, _("Invalid quad value: %ld"), value);
     return CSR_ERR_INVALID | CSR_INV_TYPE;
   }
 
   if (value == (*(char *) var))
     return CSR_SUCCESS | CSR_SUC_NO_CHANGE;
 
   if (cdef->validator)
   {
     int rc = cdef->validator(cs, cdef, value, err);
 
     if (CSR_RESULT(rc) != CSR_SUCCESS)
       return rc | CSR_INV_VALIDATOR;
   }
 
   *(char *) var = value;
   return CSR_SUCCESS;
 }

Here is the call graph for this function:

◆ quad_native_get()

static intptr_t quad_native_get	(	const struct ConfigSet *	cs,
		void *	var,
		const struct ConfigDef *	cdef,
		struct Buffer *	err
	)

static

Get an int object from a Quad-option config item - Implements ConfigSetType::native_get()

Definition at line 153 of file quad.c.

 {
   return *(char *) var;
 }

◆ quad_reset()

static int quad_reset	(	const struct ConfigSet *	cs,
		void *	var,
		const struct ConfigDef *	cdef,
		struct Buffer *	err
	)

static

Reset a Quad-option to its initial value - Implements ConfigSetType::reset()

Definition at line 162 of file quad.c.

 {
   if (cdef->initial == (*(char *) var))
     return CSR_SUCCESS | CSR_SUC_NO_CHANGE;
 
   if (cdef->validator)
   {
     int rc = cdef->validator(cs, cdef, cdef->initial, err);
 
     if (CSR_RESULT(rc) != CSR_SUCCESS)
       return rc | CSR_INV_VALIDATOR;
   }
 
   *(char *) var = cdef->initial;
   return CSR_SUCCESS;
 }

◆ quad_toggle()

static int quad_toggle ( int opt )

static

Toggle (invert) the value of a quad option.

Parameters

opt	Value to toggle

By toggling the low bit, the following are swapped:

MUTT_NO <–> MUTT_YES
MUTT_ASKNO <–> MUTT_ASKYES

Definition at line 188 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 202 of file quad.c.

 {
   if (!sub || !he || !he->data)
     return CSR_ERR_CODE;
 
   struct HashElem *he_base = cs_get_base(he);
   if (DTYPE(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:

◆ quad_str_toggle()

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

Toggle the value of a quad.

Parameters

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

Return values

num	Result, e.g. CSR_SUCCESS

See also: quad_toggle()

Definition at line 233 of file quad.c.

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

Here is the call 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 48 of file quad.c.

◆ cst_quad

const struct ConfigSetType cst_quad

Initial value:

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

Config type representing a quad-option.

Definition at line 243 of file quad.c.

Functions

Variables

Detailed Description

Function Documentation

◆ quad_string_set()

◆ quad_string_get()

◆ quad_native_set()

◆ quad_native_get()

◆ quad_reset()

◆ quad_toggle()

◆ quad_he_toggle()

◆ quad_str_toggle()

Variable Documentation

◆ QuadValues

◆ cst_quad