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_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 RegexColor **ptr)
	Free a Regex colour.
struct RegexColor *	regex_color_new (void)
	Create a new RegexColor.
struct RegexColorList *	regex_colors_get_list (enum ColorId cid)
	Return the RegexColorList for a Colour ID.
void	regex_color_list_clear (struct RegexColorList *rcl)
	Free the contents of a RegexColorList.
struct RegexColorList *	regex_color_list_new (void)
	Create a new 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)
	Parse a Regex 'uncolor' command.

Detailed Description

Regex Colour.

Authors

• Richard Russon

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

Function Documentation

STAILQ_HEAD()

STAILQ_HEAD	(	RegexColorList	,
		RegexColor	)

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 RegexColor **

ptr

)

Free a Regex colour.

Parameters

ptr	RegexColor to free

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

{
  return MUTT_MEM_CALLOC(1, struct RegexColor);
}

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 205 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:

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 187 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(&np);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

regex_color_list_new()

struct RegexColorList * regex_color_list_new

(

void

)

Create a new RegexColorList.

Return values

ptr	New RegexColorList

Definition at line 167 of file regex.c.

{
  struct RegexColorList *rcl = MUTT_MEM_CALLOC(1, struct RegexColorList);
 
  STAILQ_INIT(rcl);
 
  struct RegexColor *rcol = regex_color_new();
  STAILQ_INSERT_TAIL(rcl, rcol, entries);
 
  return rcl;
}

Here is the call 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 336 of file regex.c.

{
  if (cid == MT_COLOR_STATUS)
    return false;
 
  struct RegexColorList *rcl = regex_colors_get_list(cid);
  if (!rcl)
    return false;
 
  bool is_index = false;
  switch (cid)
  {
    case MT_COLOR_ATTACH_HEADERS:
    case MT_COLOR_BODY:
      break;
    case MT_COLOR_HEADER:
      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:
      is_index = true;
      break;
    default:
      return false;
  }
 
  *rc = add_pattern(rcl, pat, 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_string(buf));
  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 397 of file regex.c.

{
  if (cid != MT_COLOR_STATUS)
    return MUTT_CMD_ERROR;
 
  int rc = add_pattern(&StatusList, pat, 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_string(buf));
  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 )

Parse a Regex 'uncolor' command.

Parameters

cid	Colour ID, e.g. MT_COLOR_STATUS
pat	Pattern to remove (NULL to remove all)

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(&np);
      break;
    }
    prev = np;
  }
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function: