number.c File Reference

Type representing a number. More...

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

Include dependency graph for number.c:

Go to the source code of this file.

Macros
#define	TOGGLE_BIT   ((SHRT_MAX + 1) << 1)

Functions
static intptr_t	native_get (void *var)
	Get an int from a Number config item.
static void	native_set (void *var, intptr_t val)
	Set an int into a Number config item.
static void	native_toggle (void *var)
	Toggle a Number config item.
static int	number_string_set (void *var, struct ConfigDef *cdef, const char *value, struct Buffer *err)
	Set a Number by string - Implements ConfigSetType::string_set() -.
static int	number_string_get (void *var, const struct ConfigDef *cdef, struct Buffer *result)
	Get a Number as a string - Implements ConfigSetType::string_get() -.
static int	number_native_set (void *var, const struct ConfigDef *cdef, intptr_t value, struct Buffer *err)
	Set a Number config item by int - Implements ConfigSetType::native_set() -.
static intptr_t	number_native_get (void *var, const struct ConfigDef *cdef, struct Buffer *err)
	Get an int from a Number config item - Implements ConfigSetType::native_get() -.
static int	number_string_plus_equals (void *var, const struct ConfigDef *cdef, const char *value, struct Buffer *err)
	Add to a Number by string - Implements ConfigSetType::string_plus_equals() -.
static int	number_string_minus_equals (void *var, const struct ConfigDef *cdef, const char *value, struct Buffer *err)
	Subtract from a Number by string - Implements ConfigSetType::string_minus_equals() -.
static bool	number_has_been_set (void *var, const struct ConfigDef *cdef)
	Is the config value different to its initial value?
static int	number_reset (void *var, const struct ConfigDef *cdef, struct Buffer *err)
	Reset a Number to its initial value - Implements ConfigSetType::reset() -.
int	number_he_toggle (struct ConfigSubset *sub, struct HashElem *he, struct Buffer *err)
	Toggle the value of a number (value <-> 0)

Variables
const struct ConfigSetType	CstNumber
	Config type representing a number.

Detailed Description

Type representing a number.

Authors

• Richard Russon
• Jakub Jindra
• 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 number.c.

Macro Definition Documentation

TOGGLE_BIT

#define TOGGLE_BIT   ((SHRT_MAX + 1) << 1)

Definition at line 47 of file number.c.

Function Documentation

native_get()

static intptr_t native_get ( void * var )

static

Get an int from a Number config item.

Definition at line 51 of file number.c.

{
  // take care of endianness and always read intptr_t value
  intptr_t v = *(intptr_t *) var;
  return (v & TOGGLE_BIT) ? 0 : (short) v;
}

Here is the caller graph for this function:

native_set()

static void native_set ( void * var, intptr_t val )

static

Set an int into a Number config item.

Definition at line 61 of file number.c.

{
  // cast to unsigned short to clear any pending toggle status bits
  val = (unsigned short) val;
  *(intptr_t *) var = val;
}

Here is the caller graph for this function:

native_toggle()

static void native_toggle ( void * var )

static

Toggle a Number config item.

Definition at line 71 of file number.c.

{
  *(intptr_t *) var = *(uintptr_t *) var ^ TOGGLE_BIT;
}

Here is the caller graph for this function:

number_he_toggle()

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

Toggle the value of a number (value <-> 0)

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 307 of file number.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_NUMBER)
    return CSR_ERR_CODE;
 
  struct ConfigDef *cdef = he_base->data;
  native_toggle(&cdef->var);
 
  cs_subset_notify_observers(sub, he, NT_CONFIG_SET);
 
  return CSR_SUCCESS;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

CstNumber

const struct ConfigSetType CstNumber

Initial value:

= {
  DT_NUMBER,
  "number",
  number_string_set,
  number_string_get,
  number_native_set,
  number_native_get,
  number_string_plus_equals,
  number_string_minus_equals,
  number_has_been_set,
  number_reset,
  NULL, 
}

Config type representing a number.

Definition at line 327 of file number.c.

                                       {
  DT_NUMBER,
  "number",
  number_string_set,
  number_string_get,
  number_native_set,
  number_native_get,
  number_string_plus_equals,
  number_string_minus_equals,
  number_has_been_set,
  number_reset,
  NULL, // destroy
};