set.h

Go to the documentation of this file.

 
#ifndef MUTT_CONFIG_SET_H
#define MUTT_CONFIG_SET_H
 
#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
#include "mutt/lib.h"
#include "types.h"
 
/* Config Set Results */
#define CSR_SUCCESS       0 
#define CSR_ERR_CODE      1 
#define CSR_ERR_UNKNOWN   2 
#define CSR_ERR_INVALID   3 
 
/* Flags for CSR_SUCCESS */
#define CSR_SUC_INHERITED (1 << 4) 
#define CSR_SUC_EMPTY     (1 << 5) 
#define CSR_SUC_WARNING   (1 << 6) 
#define CSR_SUC_NO_CHANGE (1 << 7) 
 
/* Flags for CSR_INVALID */
#define CSR_INV_TYPE      (1 << 4) 
#define CSR_INV_VALIDATOR (1 << 5) 
#define CSV_INV_NOT_IMPL  (1 << 6) 

#define CSR_RESULT_MASK 0x0F
#define CSR_RESULT(x) ((x) & CSR_RESULT_MASK)
 
#define IP (intptr_t)

struct ConfigDef
{
  const char   *name;      
  uint32_t      type;      
  intptr_t      initial;   
  intptr_t      data;      

  int (*validator)(const struct ConfigDef *cdef, intptr_t value, struct Buffer *err);
 
  const char *docs; 
  intptr_t    var;  
};

struct ConfigSetType
{
  int type;                  
  const char *name;          

  int (*string_set)(void *var, struct ConfigDef *cdef, const char *value, struct Buffer *err);

  int (*string_get)(void *var, const struct ConfigDef *cdef, struct Buffer *result);

  int (*native_set)(void *var, const struct ConfigDef *cdef, intptr_t value, struct Buffer *err);

  intptr_t (*native_get)(void *var, const struct ConfigDef *cdef, struct Buffer *err);

  int (*string_plus_equals)(void *var, const struct ConfigDef *cdef, const char *value, struct Buffer *err);

  int (*string_minus_equals)(void *var, const struct ConfigDef *cdef, const char *value, struct Buffer *err);

  bool (*has_been_set)(void *var, const struct ConfigDef *cdef);

  int (*reset)(void *var, const struct ConfigDef *cdef, struct Buffer *err);

  void (*destroy)(void *var, const struct ConfigDef *cdef);
};

struct ConfigSet
{
  struct HashTable *hash;         
  struct ConfigSetType types[18]; 
};
 
struct ConfigSet *cs_new(size_t size);
void              cs_free(struct ConfigSet **ptr);
 
struct HashElem *           cs_get_base    (struct HashElem *he);
struct HashElem *           cs_get_elem    (const struct ConfigSet *cs, const char *name);
const struct ConfigSetType *cs_get_type_def(const struct ConfigSet *cs, unsigned int type);
 
bool             cs_register_type     (struct ConfigSet *cs, const struct ConfigSetType *cst);
struct HashElem *cs_register_variable (const struct ConfigSet *cs, struct ConfigDef *cdef, struct Buffer *err);
bool             cs_register_variables(const struct ConfigSet *cs, struct ConfigDef vars[]);
struct HashElem *cs_create_variable   (const struct ConfigSet *cs, struct ConfigDef *cdef, struct Buffer *err);
struct HashElem *cs_inherit_variable  (const struct ConfigSet *cs, struct HashElem *he_parent, const char *name);
void             cs_uninherit_variable(const struct ConfigSet *cs, const char *name);
 
bool     cs_he_has_been_set        (const struct ConfigSet *cs, struct HashElem *he);
int      cs_he_initial_get         (const struct ConfigSet *cs, struct HashElem *he,                    struct Buffer *result);
int      cs_he_initial_set         (const struct ConfigSet *cs, struct HashElem *he, const char *value, struct Buffer *err);
intptr_t cs_he_native_get          (const struct ConfigSet *cs, struct HashElem *he,                    struct Buffer *err);
int      cs_he_native_set          (const struct ConfigSet *cs, struct HashElem *he, intptr_t value,    struct Buffer *err);
int      cs_he_reset               (const struct ConfigSet *cs, struct HashElem *he,                    struct Buffer *err);
int      cs_he_string_get          (const struct ConfigSet *cs, struct HashElem *he,                    struct Buffer *result);
int      cs_he_string_minus_equals (const struct ConfigSet *cs, struct HashElem *he, const char *value, struct Buffer *err);
int      cs_he_string_plus_equals  (const struct ConfigSet *cs, struct HashElem *he, const char *value, struct Buffer *err);
int      cs_he_string_set          (const struct ConfigSet *cs, struct HashElem *he, const char *value, struct Buffer *err);
int      cs_he_delete              (const struct ConfigSet *cs, struct HashElem *he,                    struct Buffer *err);
 
bool     cs_str_has_been_set       (const struct ConfigSet *cs, const char *name);
int      cs_str_initial_get        (const struct ConfigSet *cs, const char *name,                       struct Buffer *result);
int      cs_str_native_set         (const struct ConfigSet *cs, const char *name,    intptr_t value,    struct Buffer *err);
int      cs_str_reset              (const struct ConfigSet *cs, const char *name,                       struct Buffer *err);
int      cs_str_string_set         (const struct ConfigSet *cs, const char *name,    const char *value, struct Buffer *err);
 
extern bool StartupComplete;

static inline bool startup_only(const struct ConfigDef *cdef, struct Buffer *err)
{
  if ((cdef->type & D_ON_STARTUP) && StartupComplete)
  {
    buf_printf(err, _("Option %s may only be set at startup"), cdef->name);
    return true;
  }
 
  return false;
}
 
#endif /* MUTT_CONFIG_SET_H */