NeoMutt  2022-04-29-215-gc12b98
Teaching an old dog new tricks
DOXYGEN
regex4.h File Reference

Regex Colour. More...

#include "config.h"
#include <stdbool.h>
#include <stdint.h>
#include "mutt/lib.h"
#include "attr.h"
#include "color.h"
+ Include dependency graph for regex4.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  RegexColor
 A regular expression and a color to highlight a line. More...
 

Functions

 STAILQ_HEAD (RegexColorList, RegexColor)
 
void regex_color_clear (struct RegexColor *rcol)
 Free the contents of a Regex colour. More...
 
void regex_color_free (struct RegexColorList *list, struct RegexColor **ptr)
 Free a Regex colour. More...
 
struct RegexColorregex_color_new (void)
 Create a new RegexColor. More...
 
void regex_colors_clear (void)
 Clear the Regex colours. More...
 
struct RegexColorList * regex_colors_get_list (enum ColorId cid)
 Return the RegexColorList for a colour id. More...
 
void regex_colors_init (void)
 Initialise the Regex colours. More...
 
void regex_color_list_clear (struct RegexColorList *rcl)
 Free the contents of a RegexColorList. More...
 
bool regex_colors_parse_color_list (enum ColorId cid, const char *pat, uint32_t fg, uint32_t bg, int attrs, int *rc, struct Buffer *err)
 Parse a Regex 'color' command. More...
 
int regex_colors_parse_status_list (enum ColorId cid, const char *pat, uint32_t fg, uint32_t bg, int attrs, int match, struct Buffer *err)
 Parse a Regex 'color status' command. More...
 
bool regex_colors_parse_uncolor (enum ColorId cid, const char *pat, bool uncolor)
 Parse a Regex 'uncolor' command. More...
 

Detailed Description

Regex Colour.

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

Function Documentation

◆ STAILQ_HEAD()

STAILQ_HEAD ( RegexColorList  ,
RegexColor   
)

◆ regex_color_clear()

void regex_color_clear ( struct RegexColor rcol)

Free the contents of a Regex colour.

Parameters
rcolRegexColor to empty
Note
The RegexColor object isn't freed

Definition at line 99 of file regex.c.

100{
101 if (!rcol)
102 return;
103
104 rcol->match = 0;
105 rcol->stop_matching = false;
106
108 FREE(&rcol->pattern);
109 regfree(&rcol->regex);
111}
void attr_color_clear(struct AttrColor *ac)
Free the contents of an AttrColor.
Definition: attr.c:44
void mutt_pattern_free(struct PatternList **pat)
Free a Pattern.
Definition: compile.c:1038
#define FREE(x)
Definition: memory.h:43
regex_t regex
Compiled regex.
Definition: regex4.h:40
struct PatternList * color_pattern
Compiled pattern to speed up index color calculation.
Definition: regex4.h:42
struct AttrColor attr_color
Colour and attributes to apply.
Definition: regex4.h:38
char * pattern
Pattern to match.
Definition: regex4.h:39
bool stop_matching
Used by the pager for body patterns, to prevent the color from being retried once it fails.
Definition: regex4.h:44
int match
Substring to match, 0 for old behaviour.
Definition: regex4.h:41
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ regex_color_free()

void regex_color_free ( struct RegexColorList *  list,
struct RegexColor **  ptr 
)

Free a Regex colour.

Parameters
listRegexColorList holding the colour
ptrRegexColor to free

Definition at line 118 of file regex.c.

119{
120 if (!ptr || !*ptr)
121 return;
122
123 struct RegexColor *rcol = *ptr;
124 regex_color_clear(rcol);
125
126 FREE(ptr);
127}
void regex_color_clear(struct RegexColor *rcol)
Free the contents of a Regex colour.
Definition: regex.c:99
A regular expression and a color to highlight a line.
Definition: regex4.h:37
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ regex_color_new()

struct RegexColor * regex_color_new ( void  )

Create a new RegexColor.

Return values
ptrNew RegexColor

Definition at line 133 of file regex.c.

134{
135 struct RegexColor *rcol = mutt_mem_calloc(1, sizeof(*rcol));
136
137 return rcol;
138}
void * mutt_mem_calloc(size_t nmemb, size_t size)
Allocate zeroed memory on the heap.
Definition: memory.c:50
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ regex_colors_clear()

void regex_colors_clear ( void  )

Clear the Regex colours.

Definition at line 79 of file regex.c.

80{
81 color_debug(LL_DEBUG5, "clean up regex\n");
91}
struct RegexColorList IndexFlagsList
List of colours applied to the flags in the index.
Definition: regex.c:52
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:54
struct RegexColorList StatusList
List of colours applied to the status bar.
Definition: regex.c:56
struct RegexColorList IndexList
List of default colours applied to the index.
Definition: regex.c:53
struct RegexColorList IndexTagList
List of colours applied to tags in the index.
Definition: regex.c:55
struct RegexColorList BodyList
List of colours applied to the email body.
Definition: regex.c:49
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_color_list_clear(struct RegexColorList *rcl)
Free the contents of a RegexColorList.
Definition: regex.c:148
int color_debug(enum LogLevel level, const char *format,...)
Write to the log file.
Definition: debug.c:44
@ LL_DEBUG5
Log at debug level 5.
Definition: logging.h:44
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ regex_colors_get_list()

struct RegexColorList * regex_colors_get_list ( enum ColorId  cid)

Return the RegexColorList for a colour id.

Parameters
cidColour Id, e.g. MT_COLOR_BODY
Return values
ptrRegexColorList

Definition at line 166 of file regex.c.

167{
168 switch (cid)
169 {
171 return &AttachList;
172 case MT_COLOR_BODY:
173 return &BodyList;
174 case MT_COLOR_HEADER:
175 return &HeaderList;
176 case MT_COLOR_INDEX:
177 return &IndexList;
179 return &IndexAuthorList;
181 return &IndexFlagsList;
183 return &IndexSubjectList;
185 return &IndexTagList;
186 case MT_COLOR_STATUS:
187 return &StatusList;
188 default:
189 return NULL;
190 }
191}
@ MT_COLOR_INDEX_AUTHOR
Index: author field (takes a pattern)
Definition: color.h:78
@ MT_COLOR_HEADER
Message headers (takes a pattern)
Definition: color.h:48
@ MT_COLOR_STATUS
Status bar (takes a pattern)
Definition: color.h:71
@ MT_COLOR_INDEX_SUBJECT
Index: subject field (takes a pattern)
Definition: color.h:80
@ MT_COLOR_BODY
Pager: highlight body of message (takes a pattern)
Definition: color.h:39
@ MT_COLOR_INDEX_TAG
Index: tag field (g, takes a pattern)
Definition: color.h:81
@ MT_COLOR_ATTACH_HEADERS
MIME attachment test (takes a pattern)
Definition: color.h:38
@ MT_COLOR_INDEX
Index: default colour (takes a pattern)
Definition: color.h:77
@ MT_COLOR_INDEX_FLAGS
Index: flags field (takes a pattern)
Definition: color.h:79
+ Here is the caller graph for this function:

◆ regex_colors_init()

void regex_colors_init ( void  )

Initialise the Regex colours.

Definition at line 62 of file regex.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ regex_color_list_clear()

void regex_color_list_clear ( struct RegexColorList *  rcl)

Free the contents of a RegexColorList.

Parameters
rclList to clear

Free each of the RegexColorList in a list.

Note
The list object isn't freed, only emptied

Definition at line 148 of file regex.c.

149{
150 if (!rcl)
151 return;
152
153 struct RegexColor *np = NULL, *tmp = NULL;
154 STAILQ_FOREACH_SAFE(np, rcl, entries, tmp)
155 {
156 STAILQ_REMOVE(rcl, np, RegexColor, entries);
157 regex_color_free(rcl, &np);
158 }
159}
void regex_color_free(struct RegexColorList *list, struct RegexColor **ptr)
Free a Regex colour.
Definition: regex.c:118
#define STAILQ_REMOVE(head, elm, type, field)
Definition: queue.h:402
#define STAILQ_FOREACH_SAFE(var, head, field, tvar)
Definition: queue.h:362
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ regex_colors_parse_color_list()

bool regex_colors_parse_color_list ( enum ColorId  cid,
const char *  pat,
uint32_t  fg,
uint32_t  bg,
int  attrs,
int *  rc,
struct Buffer err 
)

Parse a Regex 'color' command.

Parameters
cidColour Id, should be MT_COLOR_QUOTED
patRegex pattern
fgForeground colour
bgBackground colour
attrsAttributes, e.g. A_UNDERLINE
rcReturn code, e.g. MUTT_CMD_SUCCESS
errBuffer for error messages
Return values
trueColour was parsed

Parse a Regex 'color' command, e.g. "color index green default pattern"

Definition at line 310 of file regex.c.

313{
314 if (cid == MT_COLOR_STATUS)
315 return false;
316
317 struct RegexColorList *rcl = regex_colors_get_list(cid);
318 if (!rcl)
319 return false;
320
321 bool sensitive = false;
322 bool is_index = false;
323 switch (cid)
324 {
326 case MT_COLOR_BODY:
327 sensitive = true;
328 is_index = false;
329 break;
330 case MT_COLOR_HEADER:
331 sensitive = false;
332 is_index = false;
333 break;
334 case MT_COLOR_INDEX:
339 sensitive = true;
340 is_index = true;
341 break;
342 default:
343 return false;
344 }
345
346 *rc = add_pattern(rcl, pat, sensitive, fg, bg, attrs, err, is_index, 0);
347
348 struct Buffer *buf = mutt_buffer_pool_get();
349 get_colorid_name(cid, buf);
350 color_debug(LL_DEBUG5, "NT_COLOR_SET: %s\n", buf->data);
352
353 if (!is_index) // else it will be logged in add_pattern()
354 {
355 struct EventColor ev_c = { cid, NULL };
357 }
358
360 return true;
361}
void get_colorid_name(unsigned int cid, struct Buffer *buf)
Get the name of a color id.
Definition: command.c:329
struct Notify * ColorsNotify
Notifications: ColorId, EventColor.
Definition: notify.c:34
struct RegexColorList * regex_colors_get_list(enum ColorId cid)
Return the RegexColorList for a colour id.
Definition: regex.c:166
static enum CommandResult add_pattern(struct RegexColorList *rcl, const char *s, bool sensitive, uint32_t fg, uint32_t bg, int attrs, struct Buffer *err, bool is_index, int match)
Associate a colour to a pattern.
Definition: regex.c:209
void regex_colors_dump_all(void)
Dump all the Regex colours to the log.
Definition: debug.c:380
bool notify_send(struct Notify *notify, enum NotifyType event_type, int event_subtype, void *event_data)
Send out a notification message.
Definition: notify.c:171
@ NT_COLOR_SET
Color has been set.
Definition: notify2.h:41
@ NT_COLOR
Colour has changed, NotifyColor, EventColor.
Definition: notify_type.h:41
void mutt_buffer_pool_release(struct Buffer **pbuf)
Free a Buffer from the pool.
Definition: pool.c:112
struct Buffer * mutt_buffer_pool_get(void)
Get a Buffer from the pool.
Definition: pool.c:101
String manipulation buffer.
Definition: buffer.h:34
char * data
Pointer to data.
Definition: buffer.h:35
An Event that happened to a Colour.
Definition: notify2.h:53
enum ColorId cid
Colour ID that has changed.
Definition: notify2.h:54
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ regex_colors_parse_status_list()

int regex_colors_parse_status_list ( enum ColorId  cid,
const char *  pat,
uint32_t  fg,
uint32_t  bg,
int  attrs,
int  match,
struct Buffer err 
)

Parse a Regex 'color status' command.

Parameters
cidColour ID, should be MT_COLOR_QUOTED
patRegex pattern
fgForeground colour
bgBackground colour
attrsAttributes, e.g. A_UNDERLINE
matchUse the nth regex submatch
errBuffer for error messages
Return values
CommandResultResult e.g. MUTT_CMD_SUCCESS

Definition at line 374 of file regex.c.

376{
377 if (cid != MT_COLOR_STATUS)
378 return MUTT_CMD_ERROR;
379
380 int rc = add_pattern(&StatusList, pat, true, fg, bg, attrs, err, false, match);
381 if (rc != MUTT_CMD_SUCCESS)
382 return rc;
383
384 struct Buffer *buf = mutt_buffer_pool_get();
385 get_colorid_name(cid, buf);
386 color_debug(LL_DEBUG5, "NT_COLOR_SET: %s\n", buf->data);
388
389 struct EventColor ev_c = { cid, NULL };
391
393 return rc;
394}
@ MUTT_CMD_SUCCESS
Success: Command worked.
Definition: command.h:37
@ MUTT_CMD_ERROR
Error: Can't help the user.
Definition: command.h:35
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ regex_colors_parse_uncolor()

bool regex_colors_parse_uncolor ( enum ColorId  cid,
const char *  pat,
bool  uncolor 
)

Parse a Regex 'uncolor' command.

Parameters
cidColour Id, e.g. MT_COLOR_STATUS
patPattern to remove (NULL to remove all)
uncolortrue if 'uncolor', false if 'unmono'
Return values
trueIf colours were unset

Definition at line 403 of file regex.c.

404{
405 struct RegexColorList *cl = regex_colors_get_list(cid);
406 if (!cl)
407 return false;
408
409 if (!pat) // Reset all patterns
410 {
411 if (STAILQ_EMPTY(cl))
412 return true;
413
414 mutt_debug(LL_NOTIFY, "NT_COLOR_RESET: [ALL]\n");
415 struct EventColor ev_c = { cid, NULL };
417
419 return true;
420 }
421
422 bool rc = false;
423 struct RegexColor *np = NULL, *prev = NULL;
424 prev = NULL;
425 STAILQ_FOREACH(np, cl, entries)
426 {
427 if (mutt_str_equal(pat, np->pattern))
428 {
429 rc = true;
430
431 mutt_debug(LL_DEBUG1, "Freeing pattern \"%s\" from XXX\n", pat);
432 if (prev)
433 STAILQ_REMOVE_AFTER(cl, prev, entries);
434 else
435 STAILQ_REMOVE_HEAD(cl, entries);
436
437 mutt_debug(LL_NOTIFY, "NT_COLOR_RESET: XXX\n");
438 struct EventColor ev_c = { cid, &np->attr_color };
440
441 regex_color_free(cl, &np);
442 break;
443 }
444 prev = np;
445 }
446
447 return rc;
448}
#define mutt_debug(LEVEL,...)
Definition: logging.h:84
@ LL_DEBUG1
Log at debug level 1.
Definition: logging.h:40
@ LL_NOTIFY
Log of notifications.
Definition: logging.h:45
bool mutt_str_equal(const char *a, const char *b)
Compare two strings.
Definition: string.c:807
@ NT_COLOR_RESET
Color has been reset/removed.
Definition: notify2.h:42
#define STAILQ_REMOVE_HEAD(head, field)
Definition: queue.h:422
#define STAILQ_REMOVE_AFTER(head, elm, field)
Definition: queue.h:416
#define STAILQ_FOREACH(var, head, field)
Definition: queue.h:352
#define STAILQ_EMPTY(head)
Definition: queue.h:348
+ Here is the call graph for this function:
+ Here is the caller graph for this function: