quoted.h File Reference

Quoted-Email colours. More...

#include "config.h"
#include <stddef.h>
#include <stdbool.h>
#include <stdint.h>
#include "core/lib.h"
#include "attr.h"
#include "color.h"

Include dependency graph for quoted.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	QuoteStyle
	Style of quoted text. More...

Macros
#define	COLOR_QUOTES_MAX   10
	Ten colours, quoted0..quoted9 (quoted and quoted0 are equivalent) More...

Functions
void	quoted_colors_clear (void)
	Reset the quoted-email colours. More...
struct AttrColor *	quoted_colors_get (int q)
	Return the color of a quote, cycling through the used quotes. More...
int	quoted_colors_num_used (void)
	Return the number of used quotes. More...
bool	quoted_colors_parse_color (enum ColorId cid, uint32_t fg, uint32_t bg, int attrs, int q_level, int *rc, struct Buffer *err)
	Parse the 'color quoted' command. More...
enum CommandResult	quoted_colors_parse_uncolor (enum ColorId cid, int q_level, struct Buffer *err)
	Parse the 'uncolor quoted' command. More...
struct QuoteStyle *	qstyle_classify (struct QuoteStyle **quote_list, const char *qptr, size_t length, bool *force_redraw, int *q_level)
	Find a style for a string. More...
void	qstyle_free_tree (struct QuoteStyle **quote_list)
	Free an entire tree of QuoteStyle. More...
void	qstyle_recolour (struct QuoteStyle *quote_list)
	Recolour quotes after colour changes. More...

Variables
struct AttrColor	QuotedColors []
	Array of colours for quoted email text. More...
int	NumQuotedColors
	Number of colours for quoted email text. More...

Detailed Description

Quoted-Email colours.

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

Macro Definition Documentation

COLOR_QUOTES_MAX

#define COLOR_QUOTES_MAX   10

Ten colours, quoted0..quoted9 (quoted and quoted0 are equivalent)

Definition at line 37 of file quoted.h.

Function Documentation

quoted_colors_clear()

void quoted_colors_clear

(

void

)

Reset the quoted-email colours.

Definition at line 57 of file quoted.c.

{
  color_debug(LL_DEBUG5, "QuotedColors: clean up\n");
  for (size_t i = 0; i < COLOR_QUOTES_MAX; i++)
  {
    attr_color_clear(&QuotedColors[i]);
  }
  NumQuotedColors = 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

quoted_colors_get()

struct AttrColor * quoted_colors_get

(

int

q

)

Return the color of a quote, cycling through the used quotes.

Parameters

q	Quote level

Return values

num	Color ID, e.g. MT_COLOR_QUOTED

Definition at line 72 of file quoted.c.

{
  if (NumQuotedColors == 0)
    return NULL;
  return &QuotedColors[q % NumQuotedColors];
}

Here is the caller graph for this function:

quoted_colors_num_used()

int quoted_colors_num_used

(

void

)

Return the number of used quotes.

Return values

num	Number of used quotes

Definition at line 83 of file quoted.c.

{
  return NumQuotedColors;
}

Here is the caller graph for this function:

quoted_colors_parse_color()

bool quoted_colors_parse_color	(	enum ColorId	cid,
		uint32_t	fg,
		uint32_t	bg,
		int	attrs,
		int	q_level,
		int *	rc,
		struct Buffer *	err
	)

Parse the 'color quoted' command.

Parameters

cid	Colour Id, should be MT_COLOR_QUOTED
fg	Foreground colour
bg	Background colour
attrs	Attributes, e.g. A_UNDERLINE
q_level	Quoting depth level
rc	Return code, e.g. MUTT_CMD_SUCCESS
err	Buffer for error messages

Return values

true	Colour was parsed

Definition at line 99 of file quoted.c.

{
  if (cid != MT_COLOR_QUOTED)
    return false;
 
  color_debug(LL_DEBUG5, "quoted %d\n", q_level);
  if (q_level >= COLOR_QUOTES_MAX)
  {
    mutt_buffer_printf(err, _("Maximum quoting level is %d"), COLOR_QUOTES_MAX - 1);
    return false;
  }
 
  if (q_level >= NumQuotedColors)
    NumQuotedColors = q_level + 1;
 
  struct AttrColor *ac = &QuotedColors[q_level];
  const bool was_set = ((ac->attrs != 0) || ac->curses_color);
  ac->attrs = attrs;
 
  struct CursesColor *cc = curses_color_new(fg, bg);
  curses_color_free(&ac->curses_color);
  ac->curses_color = cc;
 
  if (!cc)
    NumQuotedColors = find_highest_used();
 
  if (was_set)
    quoted_color_dump(ac, q_level, "QuotedColors changed: ");
  else
    quoted_color_dump(ac, q_level, "QuotedColors new: ");
 
  struct Buffer *buf = mutt_buffer_pool_get();
  get_colorid_name(cid, buf);
  color_debug(LL_DEBUG5, "NT_COLOR_SET: %s\n", buf->data);
  mutt_buffer_pool_release(&buf);
 
  if (q_level == 0)
  {
    // Copy the colour into the SimpleColors
    struct AttrColor *ac_quoted = simple_color_get(MT_COLOR_QUOTED);
    *ac_quoted = *ac;
    ac_quoted->ref_count = 1;
    if (ac_quoted->curses_color)
      ac_quoted->curses_color->ref_count++;
  }
 
  struct EventColor ev_c = { cid, ac };
  notify_send(ColorsNotify, NT_COLOR, NT_COLOR_SET, &ev_c);
 
  curses_colors_dump();
  quoted_color_list_dump();
 
  *rc = MUTT_CMD_SUCCESS;
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

quoted_colors_parse_uncolor()

enum CommandResult quoted_colors_parse_uncolor	(	enum ColorId	cid,
		int	q_level,
		struct Buffer *	err
	)

Parse the 'uncolor quoted' command.

Parameters

cid	Colour Id, should be MT_COLOR_QUOTED
q_level	Quoting depth level
err	Buffer for error messages

Return values

num	Result, e.g. MUTT_CMD_SUCCESS

Definition at line 163 of file quoted.c.

{
  color_debug(LL_DEBUG5, "unquoted %d\n", q_level);
 
  struct AttrColor *ac = &QuotedColors[q_level];
  attr_color_clear(ac);
  quoted_color_dump(ac, q_level, "QuotedColors clear: ");
 
  curses_colors_dump();
  quoted_color_list_dump();
 
  NumQuotedColors = find_highest_used();
 
  struct EventColor ev_c = { cid, ac };
  notify_send(ColorsNotify, NT_COLOR, NT_COLOR_RESET, &ev_c);
 
  return MUTT_CMD_SUCCESS;
}

Here is the call graph for this function:

Here is the caller graph for this function:

qstyle_classify()

struct QuoteStyle * qstyle_classify	(	struct QuoteStyle **	quote_list,
		const char *	qptr,
		size_t	length,
		bool *	force_redraw,
		int *	q_level
	)

Find a style for a string.

Parameters

[out]	quote_list	List of quote colours
[in]	qptr	String to classify
[in]	length	Length of string
[out]	force_redraw	Set to true if a screen redraw is needed
[out]	q_level	Quoting level

Return values

ptr	Quoting style

Definition at line 280 of file quoted.c.

{
  struct QuoteStyle *q_list = *quote_list;
  struct QuoteStyle *qc = NULL, *tmp = NULL, *ptr = NULL, *save = NULL;
  const char *tail_qptr = NULL;
  size_t offset, tail_lng;
  int index = -1;
 
  /* classify quoting prefix */
  while (q_list)
  {
    if (length <= q_list->prefix_len)
    {
      /* case 1: check the top level nodes */
 
      if (mutt_strn_equal(qptr, q_list->prefix, length))
      {
        if (length == q_list->prefix_len)
          return q_list; /* same prefix: return the current class */
 
        /* found shorter prefix */
        if (!tmp)
        {
          /* add a node above q_list */
          tmp = qstyle_new();
          tmp->prefix = mutt_strn_dup(qptr, length);
          tmp->prefix_len = length;
 
          /* replace q_list by tmp in the top level list */
          if (q_list->next)
          {
            tmp->next = q_list->next;
            q_list->next->prev = tmp;
          }
          if (q_list->prev)
          {
            tmp->prev = q_list->prev;
            q_list->prev->next = tmp;
          }
 
          /* make q_list a child of tmp */
          tmp->down = q_list;
          q_list->up = tmp;
 
          /* q_list has no siblings for now */
          q_list->next = NULL;
          q_list->prev = NULL;
 
          /* update the root if necessary */
          if (q_list == *quote_list)
            *quote_list = tmp;
 
          index = q_list->quote_n;
 
          /* tmp should be the return class too */
          qc = tmp;
 
          /* next class to test; if tmp is a shorter prefix for another
           * node, that node can only be in the top level list, so don't
           * go down after this point */
          q_list = tmp->next;
        }
        else
        {
          /* found another branch for which tmp is a shorter prefix */
 
          /* save the next sibling for later */
          save = q_list->next;
 
          /* unlink q_list from the top level list */
          if (q_list->next)
            q_list->next->prev = q_list->prev;
          if (q_list->prev)
            q_list->prev->next = q_list->next;
 
          /* at this point, we have a tmp->down; link q_list to it */
          ptr = tmp->down;
          /* sibling order is important here, q_list should be linked last */
          while (ptr->next)
            ptr = ptr->next;
          ptr->next = q_list;
          q_list->next = NULL;
          q_list->prev = ptr;
          q_list->up = tmp;
 
          index = q_list->quote_n;
 
          /* next class to test; as above, we shouldn't go down */
          q_list = save;
        }
 
        /* we found a shorter prefix, so certain quotes have changed classes */
        *force_redraw = true;
        continue;
      }
      else
      {
        /* shorter, but not a substring of the current class: try next */
        q_list = q_list->next;
        continue;
      }
    }
    else
    {
      /* case 2: try subclassing the current top level node */
 
      /* tmp != NULL means we already found a shorter prefix at case 1 */
      if (!tmp && mutt_strn_equal(qptr, q_list->prefix, q_list->prefix_len))
      {
        /* ok, it's a subclass somewhere on this branch */
 
        ptr = q_list;
        offset = q_list->prefix_len;
 
        q_list = q_list->down;
        tail_lng = length - offset;
        tail_qptr = qptr + offset;
 
        while (q_list)
        {
          if (length <= q_list->prefix_len)
          {
            if (mutt_strn_equal(tail_qptr, (q_list->prefix) + offset, tail_lng))
            {
              /* same prefix: return the current class */
              if (length == q_list->prefix_len)
                return q_list;
 
              /* found shorter common prefix */
              if (!tmp)
              {
                /* add a node above q_list */
                tmp = qstyle_new();
                tmp->prefix = mutt_strn_dup(qptr, length);
                tmp->prefix_len = length;
 
                /* replace q_list by tmp */
                if (q_list->next)
                {
                  tmp->next = q_list->next;
                  q_list->next->prev = tmp;
                }
                if (q_list->prev)
                {
                  tmp->prev = q_list->prev;
                  q_list->prev->next = tmp;
                }
 
                /* make q_list a child of tmp */
                tmp->down = q_list;
                tmp->up = q_list->up;
                q_list->up = tmp;
                if (tmp->up->down == q_list)
                  tmp->up->down = tmp;
 
                /* q_list has no siblings */
                q_list->next = NULL;
                q_list->prev = NULL;
 
                index = q_list->quote_n;
 
                /* tmp should be the return class too */
                qc = tmp;
 
                /* next class to test */
                q_list = tmp->next;
              }
              else
              {
                /* found another branch for which tmp is a shorter prefix */
 
                /* save the next sibling for later */
                save = q_list->next;
 
                /* unlink q_list from the top level list */
                if (q_list->next)
                  q_list->next->prev = q_list->prev;
                if (q_list->prev)
                  q_list->prev->next = q_list->next;
 
                /* at this point, we have a tmp->down; link q_list to it */
                ptr = tmp->down;
                while (ptr->next)
                  ptr = ptr->next;
                ptr->next = q_list;
                q_list->next = NULL;
                q_list->prev = ptr;
                q_list->up = tmp;
 
                index = q_list->quote_n;
 
                /* next class to test */
                q_list = save;
              }
 
              /* we found a shorter prefix, so we need a redraw */
              *force_redraw = true;
              continue;
            }
            else
            {
              q_list = q_list->next;
              continue;
            }
          }
          else
          {
            /* longer than the current prefix: try subclassing it */
            if (!tmp && mutt_strn_equal(tail_qptr, (q_list->prefix) + offset,
                                        q_list->prefix_len - offset))
            {
              /* still a subclass: go down one level */
              ptr = q_list;
              offset = q_list->prefix_len;
 
              q_list = q_list->down;
              tail_lng = length - offset;
              tail_qptr = qptr + offset;
 
              continue;
            }
            else
            {
              /* nope, try the next prefix */
              q_list = q_list->next;
              continue;
            }
          }
        }
 
        /* still not found so far: add it as a sibling to the current node */
        if (!qc)
        {
          tmp = qstyle_new();
          tmp->prefix = mutt_strn_dup(qptr, length);
          tmp->prefix_len = length;
 
          if (ptr->down)
          {
            tmp->next = ptr->down;
            ptr->down->prev = tmp;
          }
          ptr->down = tmp;
          tmp->up = ptr;
 
          tmp->quote_n = (*q_level)++;
          tmp->attr_color = quoted_colors_get(tmp->quote_n);
 
          return tmp;
        }
        else
        {
          if (index != -1)
            qstyle_insert(*quote_list, tmp, index, q_level);
 
          return qc;
        }
      }
      else
      {
        /* nope, try the next prefix */
        q_list = q_list->next;
        continue;
      }
    }
  }
 
  if (!qc)
  {
    /* not found so far: add it as a top level class */
    qc = qstyle_new();
    qc->prefix = mutt_strn_dup(qptr, length);
    qc->prefix_len = length;
    qc->quote_n = (*q_level)++;
    qc->attr_color = quoted_colors_get(qc->quote_n);
 
    if (*quote_list)
    {
      if ((*quote_list)->next)
      {
        qc->next = (*quote_list)->next;
        qc->next->prev = qc;
      }
      (*quote_list)->next = qc;
      qc->prev = *quote_list;
    }
    else
    {
      *quote_list = qc;
    }
  }
 
  if (index != -1)
    qstyle_insert(*quote_list, tmp, index, q_level);
 
  return qc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

qstyle_free_tree()

void qstyle_free_tree

(

struct QuoteStyle **

quote_list

)

Free an entire tree of QuoteStyle.

Parameters

[out]

quote_list

Quote list to free

Note

Use qstyle_free() to free a single object

Definition at line 206 of file quoted.c.

{
  struct QuoteStyle *next = NULL;
 
  while (*quote_list)
  {
    if ((*quote_list)->down)
      qstyle_free_tree(&((*quote_list)->down));
    next = (*quote_list)->next;
    qstyle_free(quote_list);
    *quote_list = next;
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

qstyle_recolour()

void qstyle_recolour

(

struct QuoteStyle *

quote_list

)

Recolour quotes after colour changes.

Parameters

quote_list

List of quote colours

Definition at line 608 of file quoted.c.

{
  if (!quote_list)
    return;
 
  int num = quoted_colors_num_used();
  int cur = 0;
 
  quoted_color_list_dump();
  qstyle_recurse(quote_list, num, &cur);
  quoted_color_list_dump();
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

QuotedColors

struct AttrColor QuotedColors[]

extern

Array of colours for quoted email text.

Definition at line 37 of file quoted.c.

NumQuotedColors

int NumQuotedColors

extern

Number of colours for quoted email text.

Definition at line 38 of file quoted.c.