NeoMutt  2020-06-26-89-g172cd3
Teaching an old dog new tricks
DOXYGEN
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

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.

37 {
38  MUTT_ABORT = -1,
39  MUTT_NO,
40  MUTT_YES,
41  MUTT_ASKNO,
42  MUTT_ASKYES,
43 };
User aborted the question (with Ctrl-G)
Definition: quad.h:38
User answered 'Yes', or assume 'Yes'.
Definition: quad.h:40
Ask the user, defaulting to 'Yes'.
Definition: quad.h:42
User answered 'No', or assume 'No'.
Definition: quad.h:39
Ask the user, defaulting to 'No'.
Definition: quad.h:41

Function Documentation

◆ quad_init()

void quad_init ( struct ConfigSet cs)

Register the Quad-option config type.

Parameters
csConfig items

Definition at line 184 of file quad.c.

185 {
186  const struct ConfigSetType cst_quad = {
187  "quad",
192  NULL, // string_plus_equals
193  NULL, // string_minus_equals
194  quad_reset,
195  NULL, // destroy
196  };
197  cs_register_type(cs, DT_QUAD, &cst_quad);
198 }
Type definition for a config item.
Definition: set.h:88
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()
Definition: quad.c:103
#define DT_QUAD
quad-option (no/yes/ask-no/ask-yes)
Definition: types.h:37
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()
Definition: quad.c:55
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()
Definition: quad.c:162
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()
Definition: quad.c:126
bool cs_register_type(struct ConfigSet *cs, unsigned int type, const struct ConfigSetType *cst)
Register a type of config item.
Definition: set.c:251
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() ...
Definition: quad.c:153
+ 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
subConfig subset
heHashElem representing config item
errBuffer for error messages
Return values
numResult, e.g. CSR_SUCCESS
See also
quad_toggle()

Definition at line 222 of file quad.c.

223 {
224  if (!sub || !he || !he->data)
225  return CSR_ERR_CODE;
226 
227  struct HashElem *he_base = cs_get_base(he);
228  if (DTYPE(he_base->type) != DT_QUAD)
229  return CSR_ERR_CODE;
230 
231  intptr_t value = cs_he_native_get(sub->cs, he, err);
232  if (value == INT_MIN)
233  return CSR_ERR_CODE;
234 
235  value = quad_toggle(value);
236  int rc = cs_he_native_set(sub->cs, he, value, err);
237 
238  if ((CSR_RESULT(rc) == CSR_SUCCESS) && !(rc & CSR_SUC_NO_CHANGE))
240 
241  return rc;
242 }
static int quad_toggle(int opt)
Toggle (invert) the value of a quad option.
Definition: quad.c:208
#define CSR_RESULT(x)
Definition: set.h:52
void cs_subset_notify_observers(const struct ConfigSubset *sub, struct HashElem *he, enum NotifyConfig ev)
Notify all observers of an event.
Definition: subset.c:218
struct HashElem * cs_get_base(struct HashElem *he)
Find the root Config Item.
Definition: set.c:191
#define DT_QUAD
quad-option (no/yes/ask-no/ask-yes)
Definition: types.h:37
#define DTYPE(x)
Mask for the Data Type.
Definition: types.h:44
struct ConfigSet * cs
Parent ConfigSet.
Definition: subset.h:51
int cs_he_native_set(const struct ConfigSet *cs, struct HashElem *he, intptr_t value, struct Buffer *err)
Natively set the value of a HashElem config item.
Definition: set.c:687
#define CSR_SUCCESS
Action completed successfully.
Definition: set.h:35
Config item has been set.
Definition: subset.h:62
void * data
User-supplied data.
Definition: hash.h:47
#define CSR_ERR_CODE
Problem with the code.
Definition: set.h:36
int type
Type of data stored in Hash Table, e.g. DT_STRING.
Definition: hash.h:45
The item stored in a Hash Table.
Definition: hash.h:43
intptr_t cs_he_native_get(const struct ConfigSet *cs, struct HashElem *he, struct Buffer *err)
Natively get the value of a HashElem config item.
Definition: set.c:792
#define CSR_SUC_NO_CHANGE
The value hasn't changed.
Definition: set.h:44
+ 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
subConfig subset
nameHashElem representing config item
errBuffer for error messages
Return values
numResult, e.g. CSR_SUCCESS
See also
quad_toggle()

Definition at line 253 of file quad.c.

254 {
255  struct HashElem *he = cs_subset_create_inheritance(sub, name);
256 
257  return quad_he_toggle(sub, he, err);
258 }
struct HashElem * cs_subset_create_inheritance(const struct ConfigSubset *sub, const char *name)
Create a Subset config item (inherited)
Definition: subset.c:189
int quad_he_toggle(struct ConfigSubset *sub, struct HashElem *he, struct Buffer *err)
Toggle the value of a quad.
Definition: quad.c:222
The item stored in a Hash Table.
Definition: hash.h:43
+ 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.