quad.h File Reference

Type representing a quad-option. More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Enumerations
enum	QuadOption {   MUTT_ABORT = -1, MUTT_NO, MUTT_YES, MUTT_ASKNO,   MUTT_ASKYES }
	Possible values for a quad-option. More...

Functions
void	quad_init (struct ConfigSet *cs)
	Register the Quad-option config type. 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...

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.h.

Enumeration Type Documentation

QuadOption

enum QuadOption

Possible values for a quad-option.

Enumerator
MUTT_ABORT	User aborted the question (with Ctrl-G)
MUTT_NO	User answered 'No', or assume 'No'.
MUTT_YES	User answered 'Yes', or assume 'Yes'.
MUTT_ASKNO	Ask the user, defaulting to 'No'.
MUTT_ASKYES	Ask the user, defaulting to 'Yes'.

Definition at line 36 of file quad.h.

{
  MUTT_ABORT = -1, 
  MUTT_NO,         
  MUTT_YES,        
  MUTT_ASKNO,      
  MUTT_ASKYES,     
};

Function Documentation

quad_init()

void quad_init

(

struct ConfigSet *

cs

)

Register the Quad-option config type.

Parameters

cs	Config items

Definition at line 184 of file quad.c.

{
  const struct ConfigSetType cst_quad = {
    "quad",
    quad_string_set,
    quad_string_get,
    quad_native_set,
    quad_native_get,
    NULL, // string_plus_equals
    NULL, // string_minus_equals
    quad_reset,
    NULL, // destroy
  };
  cs_register_type(cs, DT_QUAD, &cst_quad);
}

Here is the call graph for this function:

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 222 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 253 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:

Here is the caller graph for this function:

Variable Documentation

QuadValues

const char* QuadValues[]

Valid strings for creating a QuadValue.

These strings are case-insensitive.

Definition at line 48 of file quad.c.