quoted.h File Reference

Quoted-Email colours. More...

#include "config.h"
#include <stdbool.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.

Macros
#define	COLOR_QUOTES_MAX   10
	Ten colours, quoted0..quoted9 (quoted and quoted0 are equivalent)
#define	COLOR_QUOTED(cid)   ((cid) == MT_COLOR_QUOTED)

Functions
void	quoted_colors_init (void)
	Initialise the Quoted colours.
void	quoted_colors_reset (void)
	Reset the quoted-email colours.
void	quoted_colors_cleanup (void)
	Cleanup the quoted-email colours.
struct AttrColor *	quoted_colors_get (int q)
	Return the color of a quote, cycling through the used quotes.
int	quoted_colors_num_used (void)
	Return the number of used quotes.
bool	quoted_colors_parse_color (enum ColorId cid, struct AttrColor *ac_val, int q_level, int *rc, struct Buffer *err)
	Parse the 'color quoted' command.
enum CommandResult	quoted_colors_parse_uncolor (enum ColorId cid, int q_level, struct Buffer *err)
	Parse the 'uncolor quoted' command.

Variables
struct AttrColor	QuotedColors []
	Array of colours for quoted email text.

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 35 of file quoted.h.

COLOR_QUOTED

#define COLOR_QUOTED

(

cid

)

((cid) == MT_COLOR_QUOTED)

Definition at line 39 of file quoted.h.

Function Documentation

quoted_colors_init()

void quoted_colors_init

(

void

)

Initialise the Quoted colours.

Definition at line 49 of file quoted.c.

{
  for (size_t i = 0; i < COLOR_QUOTES_MAX; i++)
  {
    struct AttrColor *ac = &QuotedColors[i];
    ac->fg.color = COLOR_DEFAULT;
    ac->bg.color = COLOR_DEFAULT;
  }
  NumQuotedColors = 0;
}

Here is the caller graph for this function:

quoted_colors_reset()

void quoted_colors_reset

(

void

)

Reset the quoted-email colours.

Definition at line 63 of file quoted.c.

{
  color_debug(LL_DEBUG5, "QuotedColors: reset\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_cleanup()

void quoted_colors_cleanup

(

void

)

Cleanup the quoted-email colours.

Definition at line 76 of file quoted.c.

{
  quoted_colors_reset();
}

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

enum	ColorId, e.g. MT_COLOR_QUOTED

Definition at line 86 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 97 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,
		struct AttrColor *	ac_val,
		int	q_level,
		int *	rc,
		struct Buffer *	err
	)

Parse the 'color quoted' command.

Parameters

cid	Colour Id, should be MT_COLOR_QUOTED
ac_val	Colour value to use
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 125 of file quoted.c.

{
  if (!COLOR_QUOTED(cid))
    return false;
 
  color_debug(LL_DEBUG5, "quoted %d\n", q_level);
  if (q_level >= COLOR_QUOTES_MAX)
  {
    buf_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];
 
  attr_color_overwrite(ac, ac_val);
 
  struct CursesColor *cc = ac->curses_color;
  if (!cc)
    NumQuotedColors = find_highest_used();
 
  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 (q_level == 0)
  {
    // Copy the colour into the SimpleColors
    struct AttrColor *ac_quoted = simple_color_get(MT_COLOR_QUOTED);
    curses_color_free(&ac_quoted->curses_color);
    *ac_quoted = *ac;
    ac_quoted->ref_count = 1;
    if (ac_quoted->curses_color)
    {
      ac_quoted->curses_color->ref_count++;
      curses_color_dump(cc, "curses rc++");
    }
  }
 
  struct EventColor ev_c = { cid, ac };
  notify_send(ColorsNotify, NT_COLOR, NT_COLOR_SET, &ev_c);
 
  curses_colors_dump(buf);
 
  *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

enum	CommandResult, e.g. MUTT_CMD_SUCCESS

Definition at line 184 of file quoted.c.

{
  color_debug(LL_DEBUG5, "unquoted %d\n", q_level);
 
  struct AttrColor *ac = &QuotedColors[q_level];
  attr_color_clear(ac);
 
  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:

Variable Documentation

QuotedColors

struct AttrColor QuotedColors[]

extern

Array of colours for quoted email text.

Definition at line 43 of file quoted.c.