NeoMutt  2024-04-25-127-g771158
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
regex.c
Go to the documentation of this file.
1
31#include "config.h"
32#include <stdbool.h>
33#include <stddef.h>
34#include <stdint.h>
35#include "mutt/lib.h"
36#include "config/lib.h"
37#include "core/lib.h"
38#include "index/lib.h"
39#include "pattern/lib.h"
40#include "attr.h"
41#include "color.h"
42#include "command2.h"
43#include "debug.h"
44#include "notify2.h"
45#include "regex4.h"
46
47// clang-format off
48struct RegexColorList AttachList;
49struct RegexColorList BodyList;
50struct RegexColorList HeaderList;
51struct RegexColorList IndexAuthorList;
52struct RegexColorList IndexCollapsedList;
53struct RegexColorList IndexDateList;
54struct RegexColorList IndexFlagsList;
55struct RegexColorList IndexLabelList;
56struct RegexColorList IndexList;
57struct RegexColorList IndexNumberList;
58struct RegexColorList IndexSizeList;
59struct RegexColorList IndexSubjectList;
60struct RegexColorList IndexTagList;
61struct RegexColorList IndexTagsList;
62struct RegexColorList StatusList;
63// clang-format on
64
69{
70 color_debug(LL_DEBUG5, "init AttachList, BodyList, etc\n");
86}
87
92{
93 color_debug(LL_DEBUG5, "clean up regex\n");
109}
110
118{
119 if (!rcol)
120 return;
121
122 rcol->match = 0;
123 rcol->stop_matching = false;
124
126 FREE(&rcol->pattern);
127 regfree(&rcol->regex);
129}
130
136void regex_color_free(struct RegexColorList *list, struct RegexColor **ptr)
137{
138 if (!ptr || !*ptr)
139 return;
140
141 struct RegexColor *rcol = *ptr;
142 regex_color_clear(rcol);
143
144 FREE(ptr);
145}
146
152{
153 struct RegexColor *rcol = mutt_mem_calloc(1, sizeof(*rcol));
154
155 return rcol;
156}
157
166void regex_color_list_clear(struct RegexColorList *rcl)
167{
168 if (!rcl)
169 return;
170
171 struct RegexColor *np = NULL, *tmp = NULL;
172 STAILQ_FOREACH_SAFE(np, rcl, entries, tmp)
173 {
174 STAILQ_REMOVE(rcl, np, RegexColor, entries);
175 regex_color_free(rcl, &np);
176 }
177}
178
184struct RegexColorList *regex_colors_get_list(enum ColorId cid)
185{
186 switch (cid)
187 {
189 return &AttachList;
190 case MT_COLOR_BODY:
191 return &BodyList;
192 case MT_COLOR_HEADER:
193 return &HeaderList;
194 case MT_COLOR_INDEX:
195 return &IndexList;
197 return &IndexAuthorList;
199 return &IndexCollapsedList;
201 return &IndexDateList;
203 return &IndexFlagsList;
205 return &IndexLabelList;
207 return &IndexNumberList;
209 return &IndexSizeList;
211 return &IndexSubjectList;
213 return &IndexTagList;
215 return &IndexTagsList;
216 case MT_COLOR_STATUS:
217 return &StatusList;
218 default:
219 return NULL;
220 }
221}
222
237static enum CommandResult add_pattern(struct RegexColorList *rcl, const char *s,
238 bool sensitive, struct AttrColor *ac_val,
239 struct Buffer *err, bool is_index, int match)
240{
241 struct RegexColor *rcol = NULL;
242
243 STAILQ_FOREACH(rcol, rcl, entries)
244 {
245 if ((sensitive && mutt_str_equal(s, rcol->pattern)) ||
246 (!sensitive && mutt_istr_equal(s, rcol->pattern)))
247 {
248 break;
249 }
250 }
251
252 if (rcol) // found a matching regex
253 {
254 struct AttrColor *ac = &rcol->attr_color;
255 attr_color_overwrite(ac, ac_val);
256 }
257 else
258 {
259 rcol = regex_color_new();
260 if (is_index)
261 {
262 struct Buffer *buf = buf_pool_get();
263 buf_strcpy(buf, s);
264 const char *const c_simple_search = cs_subset_string(NeoMutt->sub, "simple_search");
265 mutt_check_simple(buf, NONULL(c_simple_search));
266 struct MailboxView *mv_cur = get_current_mailbox_view();
267 struct Menu *menu = get_current_menu();
268 rcol->color_pattern = mutt_pattern_comp(mv_cur, menu, buf->data, MUTT_PC_FULL_MSG, err);
269 buf_pool_release(&buf);
270 if (!rcol->color_pattern)
271 {
272 regex_color_free(rcl, &rcol);
273 return MUTT_CMD_ERROR;
274 }
275 }
276 else
277 {
278 uint16_t flags = 0;
279 if (sensitive)
280 flags = mutt_mb_is_lower(s) ? REG_ICASE : 0;
281 else
282 flags = REG_ICASE;
283
284 const int r = REG_COMP(&rcol->regex, s, flags);
285 if (r != 0)
286 {
287 regerror(r, &rcol->regex, err->data, err->dsize);
288 regex_color_free(rcl, &rcol);
289 return MUTT_CMD_ERROR;
290 }
291 }
292 rcol->pattern = mutt_str_dup(s);
293 rcol->match = match;
294
295 struct AttrColor *ac = &rcol->attr_color;
296
297 attr_color_overwrite(ac, ac_val);
298
299 STAILQ_INSERT_TAIL(rcl, rcol, entries);
300 }
301
302 if (is_index)
303 {
304 /* force re-caching of index colors */
305 struct EventColor ev_c = { MT_COLOR_INDEX, NULL };
307 }
308
309 return MUTT_CMD_SUCCESS;
310}
311
323bool regex_colors_parse_color_list(enum ColorId cid, const char *pat,
324 struct AttrColor *ac, int *rc, struct Buffer *err)
325
326{
327 if (cid == MT_COLOR_STATUS)
328 return false;
329
330 struct RegexColorList *rcl = regex_colors_get_list(cid);
331 if (!rcl)
332 return false;
333
334 bool sensitive = false;
335 bool is_index = false;
336 switch (cid)
337 {
339 case MT_COLOR_BODY:
340 sensitive = true;
341 is_index = false;
342 break;
343 case MT_COLOR_HEADER:
344 sensitive = false;
345 is_index = false;
346 break;
347 case MT_COLOR_INDEX:
358 sensitive = true;
359 is_index = true;
360 break;
361 default:
362 return false;
363 }
364
365 *rc = add_pattern(rcl, pat, sensitive, ac, err, is_index, 0);
366
367 struct Buffer *buf = buf_pool_get();
368 get_colorid_name(cid, buf);
369 color_debug(LL_DEBUG5, "NT_COLOR_SET: %s\n", buf->data);
370 buf_pool_release(&buf);
371
372 if (!is_index) // else it will be logged in add_pattern()
373 {
374 struct EventColor ev_c = { cid, NULL };
376 }
377
378 return true;
379}
380
391 struct AttrColor *ac, int match, struct Buffer *err)
392{
393 if (cid != MT_COLOR_STATUS)
394 return MUTT_CMD_ERROR;
395
396 int rc = add_pattern(&StatusList, pat, true, ac, err, false, match);
397 if (rc != MUTT_CMD_SUCCESS)
398 return rc;
399
400 struct Buffer *buf = buf_pool_get();
401 get_colorid_name(cid, buf);
402 color_debug(LL_DEBUG5, "NT_COLOR_SET: %s\n", buf->data);
403 buf_pool_release(&buf);
404
405 struct EventColor ev_c = { cid, NULL };
407
408 return rc;
409}
410
418bool regex_colors_parse_uncolor(enum ColorId cid, const char *pat, bool uncolor)
419{
420 struct RegexColorList *cl = regex_colors_get_list(cid);
421 if (!cl)
422 return false;
423
424 if (!pat) // Reset all patterns
425 {
426 if (STAILQ_EMPTY(cl))
427 return true;
428
429 mutt_debug(LL_NOTIFY, "NT_COLOR_RESET: [ALL]\n");
430 struct EventColor ev_c = { cid, NULL };
432
434 return true;
435 }
436
437 bool rc = false;
438 struct RegexColor *np = NULL, *prev = NULL;
439 prev = NULL;
440 STAILQ_FOREACH(np, cl, entries)
441 {
442 if (mutt_str_equal(pat, np->pattern))
443 {
444 rc = true;
445
446 color_debug(LL_DEBUG1, "Freeing pattern \"%s\" from XXX\n", pat);
447 if (prev)
448 STAILQ_REMOVE_AFTER(cl, prev, entries);
449 else
450 STAILQ_REMOVE_HEAD(cl, entries);
451
452 mutt_debug(LL_NOTIFY, "NT_COLOR_RESET: XXX\n");
453 struct EventColor ev_c = { cid, &np->attr_color };
455
456 regex_color_free(cl, &np);
457 break;
458 }
459 prev = np;
460 }
461
462 return rc;
463}
void attr_color_overwrite(struct AttrColor *ac_old, struct AttrColor *ac_new)
Update an AttrColor in-place.
Definition: attr.c:395
void attr_color_clear(struct AttrColor *ac)
Free the contents of an AttrColor.
Definition: attr.c:48
Colour and attributes.
size_t buf_strcpy(struct Buffer *buf, const char *s)
Copy a string into a Buffer.
Definition: buffer.c:395
void get_colorid_name(unsigned int cid, struct Buffer *buf)
Get the name of a color id.
Definition: command.c:127
struct Notify * ColorsNotify
Notifications: ColorId, EventColor.
Definition: notify.c:35
struct RegexColorList IndexCollapsedList
List of colours applied to a collapsed thread in the index.
Definition: regex.c:52
struct RegexColorList IndexFlagsList
List of colours applied to the flags in the index.
Definition: regex.c:54
struct RegexColorList IndexAuthorList
List of colours applied to the author in the index.
Definition: regex.c:51
struct RegexColorList IndexSubjectList
List of colours applied to the subject in the index.
Definition: regex.c:59
struct RegexColorList IndexLabelList
List of colours applied to the label in the index.
Definition: regex.c:55
struct RegexColorList * regex_colors_get_list(enum ColorId cid)
Return the RegexColorList for a colour id.
Definition: regex.c:184
int regex_colors_parse_status_list(enum ColorId cid, const char *pat, struct AttrColor *ac, int match, struct Buffer *err)
Parse a Regex 'color status' command.
Definition: regex.c:390
bool regex_colors_parse_color_list(enum ColorId cid, const char *pat, struct AttrColor *ac, int *rc, struct Buffer *err)
Parse a Regex 'color' command.
Definition: regex.c:323
struct RegexColorList StatusList
List of colours applied to the status bar.
Definition: regex.c:62
void regex_colors_init(void)
Initialise the Regex colours.
Definition: regex.c:68
struct RegexColorList IndexList
List of default colours applied to the index.
Definition: regex.c:56
void regex_color_free(struct RegexColorList *list, struct RegexColor **ptr)
Free a Regex colour.
Definition: regex.c:136
struct RegexColorList IndexTagList
List of colours applied to tags in the index.
Definition: regex.c:60
struct RegexColorList BodyList
List of colours applied to the email body.
Definition: regex.c:49
struct RegexColorList IndexTagsList
List of colours applied to the tags in the index.
Definition: regex.c:61
bool regex_colors_parse_uncolor(enum ColorId cid, const char *pat, bool uncolor)
Parse a Regex 'uncolor' command.
Definition: regex.c:418
struct RegexColorList HeaderList
List of colours applied to the email headers.
Definition: regex.c:50
struct RegexColorList AttachList
List of colours applied to the attachment headers.
Definition: regex.c:48
void regex_colors_cleanup(void)
Clear the Regex colours.
Definition: regex.c:91
struct RegexColorList IndexDateList
List of colours applied to the date in the index.
Definition: regex.c:53
struct RegexColor * regex_color_new(void)
Create a new RegexColor.
Definition: regex.c:151
struct RegexColorList IndexNumberList
List of colours applied to the message number in the index.
Definition: regex.c:57
void regex_color_list_clear(struct RegexColorList *rcl)
Free the contents of a RegexColorList.
Definition: regex.c:166
struct RegexColorList IndexSizeList
List of colours applied to the size in the index.
Definition: regex.c:58
static enum CommandResult add_pattern(struct RegexColorList *rcl, const char *s, bool sensitive, struct AttrColor *ac_val, struct Buffer *err, bool is_index, int match)
Associate a colour to a pattern.
Definition: regex.c:237
void regex_color_clear(struct RegexColor *rcol)
Free the contents of a Regex colour.
Definition: regex.c:117
Color and attribute parsing.
ColorId
List of all colored objects.
Definition: color.h:40
@ MT_COLOR_INDEX_AUTHOR
Index: author field.
Definition: color.h:84
@ MT_COLOR_HEADER
Message headers (takes a pattern)
Definition: color.h:53
@ MT_COLOR_STATUS
Status bar (takes a pattern)
Definition: color.h:75
@ MT_COLOR_INDEX_SIZE
Index: size field.
Definition: color.h:90
@ MT_COLOR_INDEX_TAGS
Index: tags field (g, J)
Definition: color.h:93
@ MT_COLOR_INDEX_SUBJECT
Index: subject field.
Definition: color.h:91
@ MT_COLOR_BODY
Pager: highlight body of message (takes a pattern)
Definition: color.h:44
@ MT_COLOR_INDEX_DATE
Index: date field.
Definition: color.h:86
@ MT_COLOR_INDEX_TAG
Index: tag field (G)
Definition: color.h:92
@ MT_COLOR_ATTACH_HEADERS
MIME attachment test (takes a pattern)
Definition: color.h:43
@ MT_COLOR_INDEX_LABEL
Index: label field.
Definition: color.h:88
@ MT_COLOR_INDEX
Index: default colour.
Definition: color.h:83
@ MT_COLOR_INDEX_NUMBER
Index: index number.
Definition: color.h:89
@ MT_COLOR_INDEX_FLAGS
Index: flags field.
Definition: color.h:87
@ MT_COLOR_INDEX_COLLAPSED
Index: number of messages in collapsed thread.
Definition: color.h:85
Parse colour commands.
CommandResult
Error codes for command_t parse functions.
Definition: command.h:36
@ MUTT_CMD_SUCCESS
Success: Command worked.
Definition: command.h:39
@ MUTT_CMD_ERROR
Error: Can't help the user.
Definition: command.h:37
struct PatternList * mutt_pattern_comp(struct MailboxView *mv, struct Menu *menu, const char *s, PatternCompFlags flags, struct Buffer *err)
Create a Pattern.
Definition: compile.c:906
void mutt_pattern_free(struct PatternList **pat)
Free a Pattern.
Definition: compile.c:778
const char * cs_subset_string(const struct ConfigSubset *sub, const char *name)
Get a string config item by name.
Definition: helpers.c:291
Convenience wrapper for the config headers.
Convenience wrapper for the core headers.
Colour Debugging.
static int color_debug(enum LogLevel level, const char *format,...)
Definition: debug.h:53
#define mutt_debug(LEVEL,...)
Definition: logging2.h:89
GUI manage the main index (list of emails)
struct MailboxView * get_current_mailbox_view(void)
Get the current Mailbox view.
Definition: index.c:683
struct Menu * get_current_menu(void)
Get the current Menu.
Definition: index.c:731
@ LL_DEBUG5
Log at debug level 5.
Definition: logging2.h:47
@ LL_DEBUG1
Log at debug level 1.
Definition: logging2.h:43
@ LL_NOTIFY
Log of notifications.
Definition: logging2.h:48
bool mutt_mb_is_lower(const char *s)
Does a multi-byte string contain only lowercase characters?
Definition: mbyte.c:354
void * mutt_mem_calloc(size_t nmemb, size_t size)
Allocate zeroed memory on the heap.
Definition: memory.c:51
#define FREE(x)
Definition: memory.h:45
Convenience wrapper for the library headers.
bool notify_send(struct Notify *notify, enum NotifyType event_type, int event_subtype, void *event_data)
Send out a notification message.
Definition: notify.c:173
bool mutt_istr_equal(const char *a, const char *b)
Compare two strings, ignoring case.
Definition: string.c:672
char * mutt_str_dup(const char *str)
Copy a string, safely.
Definition: string.c:253
bool mutt_str_equal(const char *a, const char *b)
Compare two strings.
Definition: string.c:660
Colour notifications.
@ NT_COLOR_RESET
Color has been reset/removed.
Definition: notify2.h:42
@ NT_COLOR_SET
Color has been set.
Definition: notify2.h:41
@ NT_COLOR
Colour has changed, NotifyColor, EventColor.
Definition: notify_type.h:41
Match patterns to emails.
#define MUTT_PC_FULL_MSG
Enable body and header matching.
Definition: lib.h:69
void mutt_check_simple(struct Buffer *s, const char *simple)
Convert a simple search into a real request.
Definition: pattern.c:112
struct Buffer * buf_pool_get(void)
Get a Buffer from the pool.
Definition: pool.c:81
void buf_pool_release(struct Buffer **ptr)
Return a Buffer to the pool.
Definition: pool.c:94
#define STAILQ_REMOVE_HEAD(head, field)
Definition: queue.h:422
#define STAILQ_REMOVE(head, elm, type, field)
Definition: queue.h:402
#define STAILQ_INIT(head)
Definition: queue.h:372
#define STAILQ_REMOVE_AFTER(head, elm, field)
Definition: queue.h:416
#define STAILQ_FOREACH(var, head, field)
Definition: queue.h:352
#define STAILQ_INSERT_TAIL(head, elm, field)
Definition: queue.h:389
#define STAILQ_EMPTY(head)
Definition: queue.h:348
#define STAILQ_FOREACH_SAFE(var, head, field, tvar)
Definition: queue.h:362
#define REG_COMP(preg, regex, cflags)
Compile a regular expression.
Definition: regex3.h:49
Regex Colour.
#define NONULL(x)
Definition: string2.h:37
A curses colour and its attributes.
Definition: attr.h:66
String manipulation buffer.
Definition: buffer.h:36
size_t dsize
Length of data.
Definition: buffer.h:39
char * data
Pointer to data.
Definition: buffer.h:37
An Event that happened to a Colour.
Definition: notify2.h:53
enum ColorId cid
Colour ID that has changed.
Definition: notify2.h:54
View of a Mailbox.
Definition: mview.h:40
Definition: lib.h:79
Container for Accounts, Notifications.
Definition: neomutt.h:42
struct ConfigSubset * sub
Inherited config items.
Definition: neomutt.h:46
A regular expression and a color to highlight a line.
Definition: regex4.h:36
regex_t regex
Compiled regex.
Definition: regex4.h:39
struct PatternList * color_pattern
Compiled pattern to speed up index color calculation.
Definition: regex4.h:41
struct AttrColor attr_color
Colour and attributes to apply.
Definition: regex4.h:37
char * pattern
Pattern to match.
Definition: regex4.h:38
bool stop_matching
Used by the pager for body patterns, to prevent the color from being retried once it fails.
Definition: regex4.h:43
int match
Substring to match, 0 for old behaviour.
Definition: regex4.h:40