NeoMutt  2024-04-25-89-g194907
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
regex4.h File Reference

Regex Colour. More...

#include "config.h"
#include <stdbool.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.
 
void regex_color_free (struct RegexColorList *list, struct RegexColor **ptr)
 Free a Regex colour.
 
struct RegexColorregex_color_new (void)
 Create a new RegexColor.
 
void regex_colors_cleanup (void)
 Clear the Regex colours.
 
struct RegexColorList * regex_colors_get_list (enum ColorId cid)
 Return the RegexColorList for a colour id.
 
void regex_colors_init (void)
 Initialise the Regex colours.
 
void regex_color_list_clear (struct RegexColorList *rcl)
 Free the contents of a RegexColorList.
 
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.
 
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.
 
bool regex_colors_parse_uncolor (enum ColorId cid, const char *pat, bool uncolor)
 Parse a Regex 'uncolor' command.
 

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 117 of file regex.c.

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}
void attr_color_clear(struct AttrColor *ac)
Free the contents of an AttrColor.
Definition: attr.c:48
void mutt_pattern_free(struct PatternList **pat)
Free a Pattern.
Definition: compile.c:778
#define FREE(x)
Definition: memory.h:45
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
+ 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 136 of file regex.c.

137{
138 if (!ptr || !*ptr)
139 return;
140
141 struct RegexColor *rcol = *ptr;
142 regex_color_clear(rcol);
143
144 FREE(ptr);
145}
void regex_color_clear(struct RegexColor *rcol)
Free the contents of a Regex colour.
Definition: regex.c:117
A regular expression and a color to highlight a line.
Definition: regex4.h:36
+ 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 151 of file regex.c.

152{
153 struct RegexColor *rcol = mutt_mem_calloc(1, sizeof(*rcol));
154
155 return rcol;
156}
void * mutt_mem_calloc(size_t nmemb, size_t size)
Allocate zeroed memory on the heap.
Definition: memory.c:51
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ regex_colors_cleanup()

void regex_colors_cleanup ( void  )

Clear the Regex colours.

Definition at line 91 of file regex.c.

92{
93 color_debug(LL_DEBUG5, "clean up regex\n");
109}
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 StatusList
List of colours applied to the status bar.
Definition: regex.c:62
struct RegexColorList IndexList
List of default colours applied to the index.
Definition: regex.c:56
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
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
struct RegexColorList IndexDateList
List of colours applied to the date in the index.
Definition: regex.c:53
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 int color_debug(enum LogLevel level, const char *format,...)
Definition: debug.h:53
@ LL_DEBUG5
Log at debug level 5.
Definition: logging2.h:47
+ 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 184 of file regex.c.

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}
@ 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
+ Here is the caller graph for this function:

◆ regex_colors_init()

void regex_colors_init ( void  )

Initialise the Regex colours.

Definition at line 68 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 166 of file regex.c.

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}
void regex_color_free(struct RegexColorList *list, struct RegexColor **ptr)
Free a Regex colour.
Definition: regex.c:136
#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,
struct AttrColor ac,
int *  rc,
struct Buffer err 
)

Parse a Regex 'color' command.

Parameters
cidColour Id, should be MT_COLOR_QUOTED
patRegex pattern
acColour value to use
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 323 of file regex.c.

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}
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 * regex_colors_get_list(enum ColorId cid)
Return the RegexColorList for a colour id.
Definition: regex.c:184
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
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
@ NT_COLOR_SET
Color has been set.
Definition: notify2.h:41
@ NT_COLOR
Colour has changed, NotifyColor, EventColor.
Definition: notify_type.h:41
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
String manipulation buffer.
Definition: buffer.h:36
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
+ 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,
struct AttrColor ac,
int  match,
struct Buffer err 
)

Parse a Regex 'color status' command.

Parameters
cidColour ID, should be MT_COLOR_QUOTED
patRegex pattern
acColour value to use
matchUse the nth regex submatch
errBuffer for error messages
Return values
CommandResultResult e.g. MUTT_CMD_SUCCESS

Definition at line 390 of file regex.c.

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}
@ MUTT_CMD_SUCCESS
Success: Command worked.
Definition: command.h:39
@ MUTT_CMD_ERROR
Error: Can't help the user.
Definition: command.h:37
+ 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 418 of file regex.c.

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}
#define mutt_debug(LEVEL,...)
Definition: logging2.h:89
@ LL_DEBUG1
Log at debug level 1.
Definition: logging2.h:43
@ LL_NOTIFY
Log of notifications.
Definition: logging2.h:48
bool mutt_str_equal(const char *a, const char *b)
Compare two strings.
Definition: string.c:660
@ 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: