NeoMutt  2022-04-29-323-g5fcc6c
Teaching an old dog new tricks
DOXYGEN
bool.h File Reference

Type representing a boolean. More...

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

Go to the source code of this file.

Functions

int bool_he_toggle (struct ConfigSubset *sub, struct HashElem *he, struct Buffer *err)
 Toggle the value of a bool. More...
 
int bool_str_toggle (struct ConfigSubset *sub, const char *name, struct Buffer *err)
 Toggle the value of a bool. More...
 

Variables

const char * BoolValues []
 Valid strings for creating a Bool. More...
 

Detailed Description

Type representing a boolean.

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

Function Documentation

◆ bool_he_toggle()

int bool_he_toggle ( struct ConfigSubset sub,
struct HashElem he,
struct Buffer err 
)

Toggle the value of a bool.

Parameters
subConfig Subset
heHashElem representing config item
errBuffer for error messages
Return values
numResult, e.g. CSR_SUCCESS

Definition at line 186 of file bool.c.

187{
188 if (!sub || !he || !he->data)
189 return CSR_ERR_CODE;
190
191 struct HashElem *he_base = cs_get_base(he);
192 if (DTYPE(he_base->type) != DT_BOOL)
193 return CSR_ERR_CODE;
194
195 intptr_t value = cs_he_native_get(sub->cs, he, err);
196 if (value == INT_MIN)
197 return CSR_ERR_CODE;
198
199 int rc = cs_he_native_set(sub->cs, he, !value, err);
200
201 if ((CSR_RESULT(rc) == CSR_SUCCESS) && !(rc & CSR_SUC_NO_CHANGE))
203
204 return rc;
205}
struct HashElem * cs_get_base(struct HashElem *he)
Find the root Config Item.
Definition: set.c:189
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:685
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:790
#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
struct ConfigSet * cs
Parent ConfigSet.
Definition: subset.h:51
The item stored in a Hash Table.
Definition: hash.h:44
int type
Type of data stored in Hash Table, e.g. DT_STRING.
Definition: hash.h:45
void * data
User-supplied data.
Definition: hash.h:47
void cs_subset_notify_observers(const struct ConfigSubset *sub, struct HashElem *he, enum NotifyConfig ev)
Notify all observers of an event.
Definition: subset.c:229
@ NT_CONFIG_SET
Config item has been set.
Definition: subset.h:62
#define DTYPE(x)
Mask for the Data Type.
Definition: types.h:44
#define DT_BOOL
boolean option
Definition: types.h:30
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ bool_str_toggle()

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

Toggle the value of a bool.

Parameters
subConfig Subset
nameName of config item
errBuffer for error messages
Return values
numResult, e.g. CSR_SUCCESS

Definition at line 214 of file bool.c.

215{
216 struct HashElem *he = cs_subset_create_inheritance(sub, name);
217
218 return bool_he_toggle(sub, he, err);
219}
int bool_he_toggle(struct ConfigSubset *sub, struct HashElem *he, struct Buffer *err)
Toggle the value of a bool.
Definition: bool.c:186
struct HashElem * cs_subset_create_inheritance(const struct ConfigSubset *sub, const char *name)
Create a Subset config item (inherited)
Definition: subset.c:200
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Variable Documentation

◆ BoolValues

const char* BoolValues[]
extern

Valid strings for creating a Bool.

These strings are case-insensitive.

Definition at line 50 of file bool.c.