regex.c File Reference

Regex Colour. More...

#include "config.h"
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include "mutt/lib.h"
#include "config/lib.h"
#include "core/lib.h"
#include "index/lib.h"
#include "pattern/lib.h"
#include "attr.h"
#include "color.h"
#include "command2.h"
#include "debug.h"
#include "notify2.h"
#include "regex4.h"

Include dependency graph for regex.c:

Go to the source code of this file.

Functions
void	regex_colors_init (void)
	Initialise the Regex colours.
void	regex_colors_reset (void)
	Reset the Regex colours.
void	regex_colors_cleanup (void)
	Cleanup the Regex colours.
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 RegexColor *	regex_color_new (void)
	Create a new RegexColor.
void	regex_color_list_clear (struct RegexColorList *rcl)
	Free the contents of a RegexColorList.
struct RegexColorList *	regex_colors_get_list (enum ColorId cid)
	Return the RegexColorList for a colour id.
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.
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.

Variables
struct RegexColorList	AttachList
	List of colours applied to the attachment headers.
struct RegexColorList	BodyList
	List of colours applied to the email body.
struct RegexColorList	HeaderList
	List of colours applied to the email headers.
struct RegexColorList	IndexAuthorList
	List of colours applied to the author in the index.
struct RegexColorList	IndexCollapsedList
	List of colours applied to a collapsed thread in the index.
struct RegexColorList	IndexDateList
	List of colours applied to the date in the index.
struct RegexColorList	IndexFlagsList
	List of colours applied to the flags in the index.
struct RegexColorList	IndexLabelList
	List of colours applied to the label in the index.
struct RegexColorList	IndexList
	List of default colours applied to the index.
struct RegexColorList	IndexNumberList
	List of colours applied to the message number in the index.
struct RegexColorList	IndexSizeList
	List of colours applied to the size in the index.
struct RegexColorList	IndexSubjectList
	List of colours applied to the subject in the index.
struct RegexColorList	IndexTagList
	List of colours applied to tags in the index.
struct RegexColorList	IndexTagsList
	List of colours applied to the tags in the index.
struct RegexColorList	StatusList
	List of colours applied to the status bar.

Detailed Description

Regex Colour.

Authors

• Richard Russon
• Pietro Cerutti

Copyright

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

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 regex.c.

Function Documentation

regex_colors_init()

void regex_colors_init

(

void

)

Initialise the Regex colours.

Definition at line 68 of file regex.c.

{
  color_debug(LL_DEBUG5, "init AttachList, BodyList, etc\n");
  STAILQ_INIT(&AttachList);
  STAILQ_INIT(&BodyList);
  STAILQ_INIT(&HeaderList);
  STAILQ_INIT(&IndexAuthorList);
  STAILQ_INIT(&IndexCollapsedList);
  STAILQ_INIT(&IndexDateList);
  STAILQ_INIT(&IndexLabelList);
  STAILQ_INIT(&IndexNumberList);
  STAILQ_INIT(&IndexSizeList);
  STAILQ_INIT(&IndexTagsList);
  STAILQ_INIT(&IndexFlagsList);
  STAILQ_INIT(&IndexList);
  STAILQ_INIT(&IndexSubjectList);
  STAILQ_INIT(&IndexTagList);
  STAILQ_INIT(&StatusList);
}

Here is the call graph for this function:

Here is the caller graph for this function:

regex_colors_reset()

void regex_colors_reset

(

void

)

Reset the Regex colours.

Definition at line 91 of file regex.c.

{
  color_debug(LL_DEBUG5, "reset regex\n");
  regex_color_list_clear(&AttachList);
  regex_color_list_clear(&BodyList);
  regex_color_list_clear(&HeaderList);
  regex_color_list_clear(&IndexList);
  regex_color_list_clear(&IndexAuthorList);
  regex_color_list_clear(&IndexCollapsedList);
  regex_color_list_clear(&IndexDateList);
  regex_color_list_clear(&IndexLabelList);
  regex_color_list_clear(&IndexNumberList);
  regex_color_list_clear(&IndexSizeList);
  regex_color_list_clear(&IndexTagsList);
  regex_color_list_clear(&IndexFlagsList);
  regex_color_list_clear(&IndexSubjectList);
  regex_color_list_clear(&IndexTagList);
  regex_color_list_clear(&StatusList);
}

Here is the call graph for this function:

Here is the caller graph for this function:

regex_colors_cleanup()

void regex_colors_cleanup

(

void

)

Cleanup the Regex colours.

Definition at line 114 of file regex.c.

{
  regex_colors_reset();
}

Here is the call graph for this function:

Here is the caller graph for this function:

regex_color_clear()

void regex_color_clear

(

struct RegexColor *

rcol

)

Free the contents of a Regex colour.

Parameters

rcol	RegexColor to empty

Note

The RegexColor object isn't freed

Definition at line 125 of file regex.c.

{
  if (!rcol)
    return;
 
  rcol->match = 0;
  rcol->stop_matching = false;
 
  attr_color_clear(&rcol->attr_color);
  FREE(&rcol->pattern);
  regfree(&rcol->regex);
  mutt_pattern_free(&rcol->color_pattern);
}

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

list	RegexColorList holding the colour
ptr	RegexColor to free

Definition at line 144 of file regex.c.

{
  if (!ptr || !*ptr)
    return;
 
  struct RegexColor *rcol = *ptr;
  regex_color_clear(rcol);
 
  FREE(ptr);
}

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

ptr	New RegexColor

Definition at line 159 of file regex.c.

{
  return MUTT_MEM_CALLOC(1, struct RegexColor);
}

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

rcl	List to clear

Free each of the RegexColorList in a list.

Note

The list object isn't freed, only emptied

Definition at line 172 of file regex.c.

{
  if (!rcl)
    return;
 
  struct RegexColor *np = NULL, *tmp = NULL;
  STAILQ_FOREACH_SAFE(np, rcl, entries, tmp)
  {
    STAILQ_REMOVE(rcl, np, RegexColor, entries);
    regex_color_free(rcl, &np);
  }
}

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

cid	Colour Id, e.g. MT_COLOR_BODY

Return values

ptr	RegexColorList

Definition at line 190 of file regex.c.

{
  switch (cid)
  {
    case MT_COLOR_ATTACH_HEADERS:
      return &AttachList;
    case MT_COLOR_BODY:
      return &BodyList;
    case MT_COLOR_HEADER:
      return &HeaderList;
    case MT_COLOR_INDEX:
      return &IndexList;
    case MT_COLOR_INDEX_AUTHOR:
      return &IndexAuthorList;
    case MT_COLOR_INDEX_COLLAPSED:
      return &IndexCollapsedList;
    case MT_COLOR_INDEX_DATE:
      return &IndexDateList;
    case MT_COLOR_INDEX_FLAGS:
      return &IndexFlagsList;
    case MT_COLOR_INDEX_LABEL:
      return &IndexLabelList;
    case MT_COLOR_INDEX_NUMBER:
      return &IndexNumberList;
    case MT_COLOR_INDEX_SIZE:
      return &IndexSizeList;
    case MT_COLOR_INDEX_SUBJECT:
      return &IndexSubjectList;
    case MT_COLOR_INDEX_TAG:
      return &IndexTagList;
    case MT_COLOR_INDEX_TAGS:
      return &IndexTagsList;
    case MT_COLOR_STATUS:
      return &StatusList;
    default:
      return NULL;
  }
}

Here is the caller graph for this function:

add_pattern()

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  )

static

Associate a colour to a pattern.

Parameters

rcl	List of existing colours
s	String to match
sensitive	true if the pattern case-sensitive
ac_val	Colour value to use
err	Buffer for error messages
is_index	true of this is for the index
match	Number of regex subexpression to match (0 for entire pattern)

Return values

CommandResult

Result e.g. MUTT_CMD_SUCCESS

is_index used to store compiled pattern only for 'index' color object when called from mutt_parse_color()

Definition at line 243 of file regex.c.

{
  struct RegexColor *rcol = NULL;
 
  STAILQ_FOREACH(rcol, rcl, entries)
  {
    if ((sensitive && mutt_str_equal(s, rcol->pattern)) ||
        (!sensitive && mutt_istr_equal(s, rcol->pattern)))
    {
      break;
    }
  }
 
  if (rcol) // found a matching regex
  {
    struct AttrColor *ac = &rcol->attr_color;
    attr_color_overwrite(ac, ac_val);
  }
  else
  {
    rcol = regex_color_new();
    if (is_index)
    {
      struct Buffer *buf = buf_pool_get();
      buf_strcpy(buf, s);
      const char *const c_simple_search = cs_subset_string(NeoMutt->sub, "simple_search");
      mutt_check_simple(buf, NONULL(c_simple_search));
      struct MailboxView *mv_cur = get_current_mailbox_view();
      struct Menu *menu = get_current_menu();
      rcol->color_pattern = mutt_pattern_comp(mv_cur, menu, buf->data, MUTT_PC_FULL_MSG, err);
      buf_pool_release(&buf);
      if (!rcol->color_pattern)
      {
        regex_color_free(rcl, &rcol);
        return MUTT_CMD_ERROR;
      }
    }
    else
    {
      uint16_t flags = 0;
      if (sensitive)
        flags = mutt_mb_is_lower(s) ? REG_ICASE : 0;
      else
        flags = REG_ICASE;
 
      const int r = REG_COMP(&rcol->regex, s, flags);
      if (r != 0)
      {
        regerror(r, &rcol->regex, err->data, err->dsize);
        regex_color_free(rcl, &rcol);
        return MUTT_CMD_ERROR;
      }
    }
    rcol->pattern = mutt_str_dup(s);
    rcol->match = match;
 
    struct AttrColor *ac = &rcol->attr_color;
 
    attr_color_overwrite(ac, ac_val);
 
    STAILQ_INSERT_TAIL(rcl, rcol, entries);
  }
 
  if (is_index)
  {
    /* force re-caching of index colors */
    struct EventColor ev_c = { MT_COLOR_INDEX, NULL };
    notify_send(ColorsNotify, NT_COLOR, NT_COLOR_SET, &ev_c);
  }
 
  return MUTT_CMD_SUCCESS;
}

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

cid	Colour Id, should be MT_COLOR_STATUS
pat	Regex pattern
ac	Colour value to use
rc	Return code, e.g. MUTT_CMD_SUCCESS
err	Buffer for error messages

Return values

true	Colour was parsed

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

Definition at line 329 of file regex.c.

{
  if (cid == MT_COLOR_STATUS)
    return false;
 
  struct RegexColorList *rcl = regex_colors_get_list(cid);
  if (!rcl)
    return false;
 
  bool sensitive = false;
  bool is_index = false;
  switch (cid)
  {
    case MT_COLOR_ATTACH_HEADERS:
    case MT_COLOR_BODY:
      sensitive = true;
      is_index = false;
      break;
    case MT_COLOR_HEADER:
      sensitive = false;
      is_index = false;
      break;
    case MT_COLOR_INDEX:
    case MT_COLOR_INDEX_AUTHOR:
    case MT_COLOR_INDEX_COLLAPSED:
    case MT_COLOR_INDEX_DATE:
    case MT_COLOR_INDEX_FLAGS:
    case MT_COLOR_INDEX_LABEL:
    case MT_COLOR_INDEX_NUMBER:
    case MT_COLOR_INDEX_SIZE:
    case MT_COLOR_INDEX_SUBJECT:
    case MT_COLOR_INDEX_TAG:
    case MT_COLOR_INDEX_TAGS:
      sensitive = true;
      is_index = true;
      break;
    default:
      return false;
  }
 
  *rc = add_pattern(rcl, pat, sensitive, ac, err, is_index, 0);
 
  struct Buffer *buf = buf_pool_get();
  get_colorid_name(cid, buf);
  color_debug(LL_DEBUG5, "NT_COLOR_SET: %s\n", buf->data);
  buf_pool_release(&buf);
 
  if (!is_index) // else it will be logged in add_pattern()
  {
    struct EventColor ev_c = { cid, NULL };
    notify_send(ColorsNotify, NT_COLOR, NT_COLOR_SET, &ev_c);
  }
 
  return true;
}

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

cid	Colour ID, should be MT_COLOR_STATUS
pat	Regex pattern
ac	Colour value to use
match	Use the nth regex submatch
err	Buffer for error messages

Return values

CommandResult

Result e.g. MUTT_CMD_SUCCESS

Definition at line 396 of file regex.c.

{
  if (cid != MT_COLOR_STATUS)
    return MUTT_CMD_ERROR;
 
  int rc = add_pattern(&StatusList, pat, true, ac, err, false, match);
  if (rc != MUTT_CMD_SUCCESS)
    return rc;
 
  struct Buffer *buf = buf_pool_get();
  get_colorid_name(cid, buf);
  color_debug(LL_DEBUG5, "NT_COLOR_SET: %s\n", buf->data);
  buf_pool_release(&buf);
 
  struct EventColor ev_c = { cid, NULL };
  notify_send(ColorsNotify, NT_COLOR, NT_COLOR_SET, &ev_c);
 
  return rc;
}

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

cid	Colour Id, e.g. MT_COLOR_STATUS
pat	Pattern to remove (NULL to remove all)
uncolor	true if 'uncolor', false if 'unmono'

Return values

true	If colours were unset

Definition at line 424 of file regex.c.

{
  struct RegexColorList *cl = regex_colors_get_list(cid);
  if (!cl)
    return false;
 
  if (!pat) // Reset all patterns
  {
    if (STAILQ_EMPTY(cl))
      return true;
 
    mutt_debug(LL_NOTIFY, "NT_COLOR_RESET: [ALL]\n");
    struct EventColor ev_c = { cid, NULL };
    notify_send(ColorsNotify, NT_COLOR, NT_COLOR_RESET, &ev_c);
 
    regex_color_list_clear(cl);
    return true;
  }
 
  bool rc = false;
  struct RegexColor *np = NULL, *prev = NULL;
  prev = NULL;
  STAILQ_FOREACH(np, cl, entries)
  {
    if (mutt_str_equal(pat, np->pattern))
    {
      rc = true;
 
      color_debug(LL_DEBUG1, "Freeing pattern \"%s\" from XXX\n", pat);
      if (prev)
        STAILQ_REMOVE_AFTER(cl, prev, entries);
      else
        STAILQ_REMOVE_HEAD(cl, entries);
 
      mutt_debug(LL_NOTIFY, "NT_COLOR_RESET: XXX\n");
      struct EventColor ev_c = { cid, &np->attr_color };
      notify_send(ColorsNotify, NT_COLOR, NT_COLOR_RESET, &ev_c);
 
      regex_color_free(cl, &np);
      break;
    }
    prev = np;
  }
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

AttachList

struct RegexColorList AttachList

List of colours applied to the attachment headers.

Definition at line 48 of file regex.c.

BodyList

struct RegexColorList BodyList

List of colours applied to the email body.

Definition at line 49 of file regex.c.

HeaderList

struct RegexColorList HeaderList

List of colours applied to the email headers.

Definition at line 50 of file regex.c.

IndexAuthorList

struct RegexColorList IndexAuthorList

List of colours applied to the author in the index.

Definition at line 51 of file regex.c.

IndexCollapsedList

struct RegexColorList IndexCollapsedList

List of colours applied to a collapsed thread in the index.

Definition at line 52 of file regex.c.

IndexDateList

struct RegexColorList IndexDateList

List of colours applied to the date in the index.

Definition at line 53 of file regex.c.

IndexFlagsList

struct RegexColorList IndexFlagsList

List of colours applied to the flags in the index.

Definition at line 54 of file regex.c.

IndexLabelList

struct RegexColorList IndexLabelList

List of colours applied to the label in the index.

Definition at line 55 of file regex.c.

IndexList

struct RegexColorList IndexList

List of default colours applied to the index.

Definition at line 56 of file regex.c.

IndexNumberList

struct RegexColorList IndexNumberList

List of colours applied to the message number in the index.

Definition at line 57 of file regex.c.

IndexSizeList

struct RegexColorList IndexSizeList

List of colours applied to the size in the index.

Definition at line 58 of file regex.c.

IndexSubjectList

struct RegexColorList IndexSubjectList

List of colours applied to the subject in the index.

Definition at line 59 of file regex.c.

IndexTagList

struct RegexColorList IndexTagList

List of colours applied to tags in the index.

Definition at line 60 of file regex.c.

IndexTagsList

struct RegexColorList IndexTagsList

List of colours applied to the tags in the index.

Definition at line 61 of file regex.c.

StatusList

struct RegexColorList StatusList

List of colours applied to the status bar.

Definition at line 62 of file regex.c.