NeoMutt  2021-02-05-666-ge300cd
Teaching an old dog new tricks
DOXYGEN
mbtable.c
Go to the documentation of this file.
1 
35 #include "config.h"
36 #include <stdint.h>
37 #include <string.h>
38 #include <wchar.h>
39 #include "mutt/lib.h"
40 #include "mbtable.h"
41 #include "set.h"
42 #include "types.h"
43 
49 struct MbTable *mbtable_parse(const char *s)
50 {
51  struct MbTable *t = NULL;
52  size_t slen, k;
53  mbstate_t mbstate;
54  char *d = NULL;
55 
56  slen = mutt_str_len(s);
57  if (!slen)
58  return NULL;
59 
60  t = mutt_mem_calloc(1, sizeof(struct MbTable));
61 
62  t->orig_str = mutt_str_dup(s);
63  /* This could be more space efficient. However, being used on tiny
64  * strings (`$to_chars` and `$status_chars`), the overhead is not great. */
65  t->chars = mutt_mem_calloc(slen, sizeof(char *));
66  t->segmented_str = mutt_mem_calloc(slen * 2, sizeof(char));
67  d = t->segmented_str;
68 
69  memset(&mbstate, 0, sizeof(mbstate));
70  while (slen && (k = mbrtowc(NULL, s, slen, &mbstate)))
71  {
72  if ((k == (size_t) (-1)) || (k == (size_t) (-2)))
73  {
74  /* XXX put message in err buffer; fail? warning? */
75  mutt_debug(LL_DEBUG1, "mbrtowc returned %d converting %s in %s\n",
76  (k == (size_t) (-1)) ? -1 : -2, s, t->orig_str);
77  if (k == (size_t) (-1))
78  memset(&mbstate, 0, sizeof(mbstate));
79  k = (k == (size_t) (-1)) ? 1 : slen;
80  }
81 
82  slen -= k;
83  t->chars[t->len++] = d;
84  while (k--)
85  *d++ = *s++;
86  *d++ = '\0';
87  }
88 
89  return t;
90 }
91 
95 static void mbtable_destroy(const struct ConfigSet *cs, void *var, const struct ConfigDef *cdef)
96 {
97  struct MbTable **m = var;
98  if (!*m)
99  return;
100 
101  mbtable_free(m);
102 }
103 
107 static int mbtable_string_set(const struct ConfigSet *cs, void *var, struct ConfigDef *cdef,
108  const char *value, struct Buffer *err)
109 {
110  /* Store empty mbtables as NULL */
111  if (value && (value[0] == '\0'))
112  value = NULL;
113 
114  struct MbTable *table = NULL;
115 
116  int rc = CSR_SUCCESS;
117 
118  if (var)
119  {
120  struct MbTable *curval = *(struct MbTable **) var;
121  if (curval && mutt_str_equal(value, curval->orig_str))
123 
124  table = mbtable_parse(value);
125 
126  if (cdef->validator)
127  {
128  rc = cdef->validator(cs, cdef, (intptr_t) table, err);
129 
130  if (CSR_RESULT(rc) != CSR_SUCCESS)
131  {
132  mbtable_free(&table);
133  return rc | CSR_INV_VALIDATOR;
134  }
135  }
136 
137  mbtable_destroy(cs, var, cdef);
138 
139  *(struct MbTable **) var = table;
140 
141  if (!table)
142  rc |= CSR_SUC_EMPTY;
143  }
144  else
145  {
146  if (cdef->type & DT_INITIAL_SET)
147  FREE(&cdef->initial);
148 
149  cdef->type |= DT_INITIAL_SET;
150  cdef->initial = (intptr_t) mutt_str_dup(value);
151  }
152 
153  return rc;
154 }
155 
159 static int mbtable_string_get(const struct ConfigSet *cs, void *var,
160  const struct ConfigDef *cdef, struct Buffer *result)
161 {
162  const char *str = NULL;
163 
164  if (var)
165  {
166  struct MbTable *table = *(struct MbTable **) var;
167  if (!table || !table->orig_str)
168  return CSR_SUCCESS | CSR_SUC_EMPTY; /* empty string */
169  str = table->orig_str;
170  }
171  else
172  {
173  str = (char *) cdef->initial;
174  }
175 
176  mutt_buffer_addstr(result, str);
177  return CSR_SUCCESS;
178 }
179 
185 static struct MbTable *mbtable_dup(struct MbTable *table)
186 {
187  if (!table)
188  return NULL; /* LCOV_EXCL_LINE */
189 
190  struct MbTable *m = mutt_mem_calloc(1, sizeof(*m));
191  m->orig_str = mutt_str_dup(table->orig_str);
192  return m;
193 }
194 
198 static int mbtable_native_set(const struct ConfigSet *cs, void *var,
199  const struct ConfigDef *cdef, intptr_t value,
200  struct Buffer *err)
201 {
202  int rc;
203 
204  if (cdef->validator)
205  {
206  rc = cdef->validator(cs, cdef, value, err);
207 
208  if (CSR_RESULT(rc) != CSR_SUCCESS)
209  return rc | CSR_INV_VALIDATOR;
210  }
211 
212  mbtable_free(var);
213 
214  struct MbTable *table = mbtable_dup((struct MbTable *) value);
215 
216  rc = CSR_SUCCESS;
217  if (!table)
218  rc |= CSR_SUC_EMPTY;
219 
220  *(struct MbTable **) var = table;
221  return rc;
222 }
223 
227 static intptr_t mbtable_native_get(const struct ConfigSet *cs, void *var,
228  const struct ConfigDef *cdef, struct Buffer *err)
229 {
230  struct MbTable *table = *(struct MbTable **) var;
231 
232  return (intptr_t) table;
233 }
234 
238 static int mbtable_reset(const struct ConfigSet *cs, void *var,
239  const struct ConfigDef *cdef, struct Buffer *err)
240 {
241  struct MbTable *table = NULL;
242  const char *initial = (const char *) cdef->initial;
243 
244  struct MbTable *curtable = *(struct MbTable **) var;
245  const char *curval = curtable ? curtable->orig_str : NULL;
246 
247  int rc = CSR_SUCCESS;
248  if (!curtable)
249  rc |= CSR_SUC_EMPTY;
250 
251  if (mutt_str_equal(initial, curval))
252  return rc | CSR_SUC_NO_CHANGE;
253 
254  if (initial)
255  table = mbtable_parse(initial);
256 
257  if (cdef->validator)
258  {
259  rc = cdef->validator(cs, cdef, (intptr_t) table, err);
260 
261  if (CSR_RESULT(rc) != CSR_SUCCESS)
262  {
263  mbtable_destroy(cs, &table, cdef);
264  return rc | CSR_INV_VALIDATOR;
265  }
266  }
267 
268  if (!table)
269  rc |= CSR_SUC_EMPTY;
270 
271  mbtable_destroy(cs, var, cdef);
272 
273  *(struct MbTable **) var = table;
274  return rc;
275 }
276 
281 void mbtable_free(struct MbTable **table)
282 {
283  if (!table || !*table)
284  return;
285 
286  FREE(&(*table)->orig_str);
287  FREE(&(*table)->chars);
288  FREE(&(*table)->segmented_str);
289  FREE(table);
290 }
291 
295 const struct ConfigSetType cst_mbtable = {
296  DT_MBTABLE,
297  "mbtable",
302  NULL, // string_plus_equals
303  NULL, // string_minus_equals
306 };
#define CSR_SUCCESS
Action completed successfully.
Definition: set.h:35
bool mutt_str_equal(const char *a, const char *b)
Compare two strings.
Definition: string.c:904
Container for lots of config items.
Definition: set.h:259
void * mutt_mem_calloc(size_t nmemb, size_t size)
Allocate zeroed memory on the heap.
Definition: memory.c:50
Constants for all the config types.
char ** chars
The array of multibyte character strings.
Definition: mbtable.h:37
A collection of config items.
intptr_t initial
Initial value.
Definition: set.h:67
String manipulation buffer.
Definition: buffer.h:33
char * mutt_str_dup(const char *str)
Copy a string, safely.
Definition: string.c:370
#define DT_INITIAL_SET
Config item must have its initial value freed.
Definition: types.h:79
#define DT_MBTABLE
multibyte char table
Definition: types.h:34
multibyte character table
Definition: mbtable.h:33
Definition: set.h:63
static int mbtable_reset(const struct ConfigSet *cs, void *var, const struct ConfigDef *cdef, struct Buffer *err)
Reset an MbTable to its initial value - Implements ConfigSetType::reset() -.
Definition: mbtable.c:238
#define CSR_RESULT(x)
Definition: set.h:52
#define CSR_SUC_EMPTY
Value is empty/unset.
Definition: set.h:42
#define CSR_SUC_NO_CHANGE
The value hasn&#39;t changed.
Definition: set.h:44
struct MbTable * mbtable_parse(const char *s)
Parse a multibyte string into a table.
Definition: mbtable.c:49
size_t mutt_buffer_addstr(struct Buffer *buf, const char *s)
Add a string to a Buffer.
Definition: buffer.c:225
static intptr_t mbtable_native_get(const struct ConfigSet *cs, void *var, const struct ConfigDef *cdef, struct Buffer *err)
Get an MbTable object from a MbTable config item - Implements ConfigSetType::native_get() -...
Definition: mbtable.c:227
int(* validator)(const struct ConfigSet *cs, const struct ConfigDef *cdef, intptr_t value, struct Buffer *err)
Definition: set.h:82
Type representing a multibyte character table.
static int mbtable_string_set(const struct ConfigSet *cs, void *var, struct ConfigDef *cdef, const char *value, struct Buffer *err)
Set an MbTable by string - Implements ConfigSetType::string_set() -.
Definition: mbtable.c:107
uint32_t type
Variable type, e.g. DT_STRING.
Definition: set.h:66
#define mutt_debug(LEVEL,...)
Definition: logging.h:85
char * orig_str
Original string used to generate this object.
Definition: mbtable.h:35
size_t mutt_str_len(const char *a)
Calculate the length of a string, safely.
Definition: string.c:664
Log at debug level 1.
Definition: logging.h:40
#define FREE(x)
Definition: memory.h:40
static int mbtable_native_set(const struct ConfigSet *cs, void *var, const struct ConfigDef *cdef, intptr_t value, struct Buffer *err)
Set an MbTable config item by MbTable object - Implements ConfigSetType::native_set() -...
Definition: mbtable.c:198
static void mbtable_destroy(const struct ConfigSet *cs, void *var, const struct ConfigDef *cdef)
Destroy an MbTable object - Implements ConfigSetType::destroy() -.
Definition: mbtable.c:95
Convenience wrapper for the library headers.
static struct MbTable * mbtable_dup(struct MbTable *table)
Create a copy of an MbTable object.
Definition: mbtable.c:185
int len
Number of characters.
Definition: mbtable.h:36
#define CSR_INV_VALIDATOR
Value was rejected by the validator.
Definition: set.h:48
static int mbtable_string_get(const struct ConfigSet *cs, void *var, const struct ConfigDef *cdef, struct Buffer *result)
Get a MbTable as a string - Implements ConfigSetType::string_get() -.
Definition: mbtable.c:159
void mbtable_free(struct MbTable **table)
Free an MbTable object.
Definition: mbtable.c:281
char * segmented_str
Each chars entry points inside this string.
Definition: mbtable.h:38