NeoMutt  2024-03-23-142-g2b2e76
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
bool.c
Go to the documentation of this file.
1
35#include "config.h"
36#include <stddef.h>
37#include <limits.h>
38#include <stdbool.h>
39#include <stdint.h>
40#include "mutt/lib.h"
41#include "bool.h"
42#include "set.h"
43#include "subset.h"
44#include "types.h"
45
51const char *BoolValues[] = {
52 "no", "yes", "n", "y", "false", "true", "0", "1", "off", "on", NULL,
53};
54
58static int bool_string_set(const struct ConfigSet *cs, void *var, struct ConfigDef *cdef,
59 const char *value, struct Buffer *err)
60{
61 if (!value)
62 return CSR_ERR_CODE; /* LCOV_EXCL_LINE */
63
64 int num = -1;
65 for (size_t i = 0; BoolValues[i]; i++)
66 {
67 if (mutt_istr_equal(BoolValues[i], value))
68 {
69 num = i % 2;
70 break;
71 }
72 }
73
74 if (num < 0)
75 {
76 buf_printf(err, _("Invalid boolean value: %s"), value);
78 }
79
80 if (var)
81 {
82 if (num == (*(bool *) var))
84
85 if (startup_only(cdef, err))
87
88 if (cdef->validator)
89 {
90 int rc = cdef->validator(cs, cdef, (intptr_t) num, err);
91
92 if (CSR_RESULT(rc) != CSR_SUCCESS)
93 return rc | CSR_INV_VALIDATOR;
94 }
95
96 *(bool *) var = num;
97 }
98 else
99 {
100 cdef->initial = num;
101 }
102
103 return CSR_SUCCESS;
104}
105
109static int bool_string_get(const struct ConfigSet *cs, void *var,
110 const struct ConfigDef *cdef, struct Buffer *result)
111{
112 int index;
113
114 if (var)
115 index = *(bool *) var;
116 else
117 index = (int) cdef->initial;
118
119 if (index > 1)
120 return CSR_ERR_INVALID | CSR_INV_TYPE; /* LCOV_EXCL_LINE */
121
122 buf_addstr(result, BoolValues[index]);
123 return CSR_SUCCESS;
124}
125
129static int bool_native_set(const struct ConfigSet *cs, void *var,
130 const struct ConfigDef *cdef, intptr_t value, struct Buffer *err)
131{
132 if ((value < 0) || (value > 1))
133 {
134 buf_printf(err, _("Invalid boolean value: %ld"), (long) value);
136 }
137
138 if (value == (*(bool *) var))
140
141 if (startup_only(cdef, err))
143
144 if (cdef->validator)
145 {
146 int rc = cdef->validator(cs, cdef, value, err);
147
148 if (CSR_RESULT(rc) != CSR_SUCCESS)
149 return rc | CSR_INV_VALIDATOR;
150 }
151
152 *(bool *) var = value;
153 return CSR_SUCCESS;
154}
155
159static intptr_t bool_native_get(const struct ConfigSet *cs, void *var,
160 const struct ConfigDef *cdef, struct Buffer *err)
161{
162 return *(bool *) var;
163}
164
168static int bool_reset(const struct ConfigSet *cs, void *var,
169 const struct ConfigDef *cdef, struct Buffer *err)
170{
171 if (cdef->initial == (*(bool *) var))
173
174 if (startup_only(cdef, err))
176
177 if (cdef->validator)
178 {
179 int rc = cdef->validator(cs, cdef, cdef->initial, err);
180
181 if (CSR_RESULT(rc) != CSR_SUCCESS)
182 return rc | CSR_INV_VALIDATOR;
183 }
184
185 *(bool *) var = cdef->initial;
186 return CSR_SUCCESS;
187}
188
196int bool_he_toggle(struct ConfigSubset *sub, struct HashElem *he, struct Buffer *err)
197{
198 if (!sub || !he || !he->data)
199 return CSR_ERR_CODE;
200
201 struct HashElem *he_base = cs_get_base(he);
202 if (DTYPE(he_base->type) != DT_BOOL)
203 return CSR_ERR_CODE;
204
205 intptr_t value = cs_he_native_get(sub->cs, he, err);
206 if (value == INT_MIN)
207 return CSR_ERR_CODE;
208
209 int rc = cs_he_native_set(sub->cs, he, !value, err);
210
211 if ((CSR_RESULT(rc) == CSR_SUCCESS) && !(rc & CSR_SUC_NO_CHANGE))
213
214 return rc;
215}
216
224int bool_str_toggle(struct ConfigSubset *sub, const char *name, struct Buffer *err)
225{
226 struct HashElem *he = cs_subset_create_inheritance(sub, name);
227
228 return bool_he_toggle(sub, he, err);
229}
230
234const struct ConfigSetType CstBool = {
235 DT_BOOL,
236 "boolean",
241 NULL, // string_plus_equals
242 NULL, // string_minus_equals
244 NULL, // destroy
245};
const struct ConfigSetType CstBool
Config type representing an boolean.
Definition: bool.c:234
int bool_str_toggle(struct ConfigSubset *sub, const char *name, struct Buffer *err)
Toggle the value of a bool.
Definition: bool.c:224
int bool_he_toggle(struct ConfigSubset *sub, struct HashElem *he, struct Buffer *err)
Toggle the value of a bool.
Definition: bool.c:196
const char * BoolValues[]
Valid strings for creating a Bool.
Definition: bool.c:51
Type representing a boolean.
int buf_printf(struct Buffer *buf, const char *fmt,...)
Format a string overwriting a Buffer.
Definition: buffer.c:160
size_t buf_addstr(struct Buffer *buf, const char *s)
Add a string to a Buffer.
Definition: buffer.c:225
struct HashElem * cs_get_base(struct HashElem *he)
Find the root Config Item.
Definition: set.c:160
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:708
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:813
static bool startup_only(const struct ConfigDef *cdef, struct Buffer *err)
Validator function for D_ON_STARTUP.
Definition: set.h:296
#define CSR_ERR_INVALID
Value hasn't been set.
Definition: set.h:38
#define CSR_INV_TYPE
Value is not valid for the type.
Definition: set.h:47
#define CSR_INV_VALIDATOR
Value was rejected by the validator.
Definition: set.h:48
#define CSR_SUC_NO_CHANGE
The value hasn't changed.
Definition: set.h:44
#define CSR_ERR_CODE
Problem with the code.
Definition: set.h:36
#define CSR_RESULT(x)
Definition: set.h:52
#define CSR_SUCCESS
Action completed successfully.
Definition: set.h:35
static intptr_t bool_native_get(const struct ConfigSet *cs, void *var, const struct ConfigDef *cdef, struct Buffer *err)
Get a bool from a Bool config item - Implements ConfigSetType::native_get() -.
Definition: bool.c:159
static int bool_native_set(const struct ConfigSet *cs, void *var, const struct ConfigDef *cdef, intptr_t value, struct Buffer *err)
Set a Bool config item by bool - Implements ConfigSetType::native_set() -.
Definition: bool.c:129
static int bool_reset(const struct ConfigSet *cs, void *var, const struct ConfigDef *cdef, struct Buffer *err)
Reset a Bool to its initial value - Implements ConfigSetType::reset() -.
Definition: bool.c:168
static int bool_string_get(const struct ConfigSet *cs, void *var, const struct ConfigDef *cdef, struct Buffer *result)
Get a Bool as a string - Implements ConfigSetType::string_get() -.
Definition: bool.c:109
static int bool_string_set(const struct ConfigSet *cs, void *var, struct ConfigDef *cdef, const char *value, struct Buffer *err)
Set a Bool by string - Implements ConfigSetType::string_set() -.
Definition: bool.c:58
Convenience wrapper for the library headers.
#define _(a)
Definition: message.h:28
bool mutt_istr_equal(const char *a, const char *b)
Compare two strings, ignoring case.
Definition: string.c:721
Parse the 'set' command.
String manipulation buffer.
Definition: buffer.h:36
Definition: set.h:64
int(* validator)(const struct ConfigSet *cs, const struct ConfigDef *cdef, intptr_t value, struct Buffer *err)
Definition: set.h:82
intptr_t initial
Initial value.
Definition: set.h:67
Container for lots of config items.
Definition: set.h:252
A set of inherited config items.
Definition: subset.h:47
struct ConfigSet * cs
Parent ConfigSet.
Definition: subset.h:51
The item stored in a Hash Table.
Definition: hash.h:43
int type
Type of data stored in Hash Table, e.g. DT_STRING.
Definition: hash.h:44
void * data
User-supplied data.
Definition: hash.h:46
struct HashElem * cs_subset_create_inheritance(const struct ConfigSubset *sub, const char *name)
Create a Subset config item (inherited)
Definition: subset.c:208
void cs_subset_notify_observers(const struct ConfigSubset *sub, struct HashElem *he, enum NotifyConfig ev)
Notify all observers of an event.
Definition: subset.c:237
Subset of Config Items.
@ NT_CONFIG_SET
Config item has been set.
Definition: subset.h:62
Constants for all the config types.
#define DTYPE(t)
Definition: types.h:50
@ DT_BOOL
boolean option
Definition: types.h:32