attr.h File Reference

Colour and attributes. More...

#include "config.h"
#include <stdbool.h>
#include "mutt/lib.h"
#include "curses2.h"

Include dependency graph for attr.h:

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

Go to the source code of this file.

Data Structures
struct	ColorElement
	One element of a Colour. More...
struct	AttrColor
	A curses colour and its attributes. More...

Enumerations
enum	ColorType { CT_SIMPLE , CT_PALETTE , CT_RGB }
	Type of Colour. More...
enum	ColorPrefix { COLOR_PREFIX_NONE , COLOR_PREFIX_ALERT , COLOR_PREFIX_BRIGHT , COLOR_PREFIX_LIGHT }
	Constants for colour prefixes of named colours. More...

Functions
	TAILQ_HEAD (AttrColorList, AttrColor)
void	attr_color_clear (struct AttrColor *ac)
	Free the contents of an AttrColor.
struct AttrColor	attr_color_copy (const struct AttrColor *ac)
	Copy a colour.
void	attr_color_free (struct AttrColor **ptr)
	Free an AttrColor.
bool	attr_color_is_set (const struct AttrColor *ac)
	Is the object coloured?
bool	attr_color_match (struct AttrColor *ac1, struct AttrColor *ac2)
	Do the colours match?
struct AttrColor *	attr_color_new (void)
	Create a new AttrColor.
void	attr_color_list_clear (struct AttrColorList *acl)
	Free the contents of an AttrColorList.
struct AttrColor *	attr_color_list_find (struct AttrColorList *acl, color_t fg, color_t bg, int attrs)
	Find an AttrColor in a list.
void	attr_color_overwrite (struct AttrColor *ac_old, struct AttrColor *ac_new)
	Update an AttrColor in-place.

Detailed Description

Colour and attributes.

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

Enumeration Type Documentation

ColorType

enum ColorType

Type of Colour.

Enumerator
CT_SIMPLE	Simple colour, e.g. "Red".
CT_PALETTE	Palette colour, e.g. "color207".
CT_RGB	True colour, e.g. "#11AAFF".

Definition at line 34 of file attr.h.

{
  CT_SIMPLE,    
  CT_PALETTE,   
  CT_RGB,       
};

ColorPrefix

enum ColorPrefix

Constants for colour prefixes of named colours.

Enumerator
COLOR_PREFIX_NONE	no prefix
COLOR_PREFIX_ALERT	"alert" colour prefix
COLOR_PREFIX_BRIGHT	"bright" colour prefix
COLOR_PREFIX_LIGHT	"light" colour prefix

Definition at line 44 of file attr.h.

{
  COLOR_PREFIX_NONE,   
  COLOR_PREFIX_ALERT,  
  COLOR_PREFIX_BRIGHT, 
  COLOR_PREFIX_LIGHT,  
};

Function Documentation

TAILQ_HEAD()

TAILQ_HEAD	(	AttrColorList	,
		AttrColor
	)

attr_color_clear()

void attr_color_clear

(

struct AttrColor *

ac

)

Free the contents of an AttrColor.

Parameters

ac	AttrColor to empty

Note

The AttrColor object isn't freed

Definition at line 49 of file attr.c.

{
  if (!ac)
    return;
 
  if (ac->curses_color)
    color_debug(LL_DEBUG5, "clear %p\n", (void *) ac);
  curses_color_free(&ac->curses_color);
 
  memset(&ac->fg, 0, sizeof(ac->fg));
  memset(&ac->bg, 0, sizeof(ac->bg));
 
  ac->fg.color = COLOR_DEFAULT;
  ac->bg.color = COLOR_DEFAULT;
  ac->attrs = A_NORMAL;
}

Here is the call graph for this function:

Here is the caller graph for this function:

attr_color_copy()

struct AttrColor attr_color_copy

(

const struct AttrColor *

ac

)

Copy a colour.

Parameters

ac	Colour to copy

Return values

obj	Copy of the colour

Definition at line 167 of file attr.c.

{
  if (ac)
    return *ac;
  else
    return (struct AttrColor){ 0 };
}

Here is the caller graph for this function:

attr_color_free()

void attr_color_free

(

struct AttrColor **

ptr

)

Free an AttrColor.

Parameters

ptr	AttrColor to free

Definition at line 70 of file attr.c.

{
  if (!ptr || !*ptr)
    return;
 
  struct AttrColor *ac = *ptr;
  if (ac->ref_count > 1)
  {
    ac->ref_count--;
    *ptr = NULL;
    return;
  }
 
  attr_color_clear(ac);
  FREE(ptr);
}

Here is the call graph for this function:

Here is the caller graph for this function:

attr_color_is_set()

bool attr_color_is_set

(

const struct AttrColor *

ac

)

Is the object coloured?

Parameters

ac	Colour to check

Return values

true	Yes, a 'color' command has been used on this object

Definition at line 180 of file attr.c.

{
  if (!ac)
    return false;
 
  return ((ac->attrs != A_NORMAL) || ac->curses_color);
}

Here is the caller graph for this function:

attr_color_match()

bool attr_color_match	(	struct AttrColor *	ac1,
		struct AttrColor *	ac2
	)

Do the colours match?

Parameters

ac1	First colour
ac2	Second colour

Return values

true	The colours and attributes match

Definition at line 194 of file attr.c.

{
  if ((!ac1) ^ (!ac2)) // One is set, but not the other
    return false;
 
  if (!ac1) // Two empty colours match
    return true;
 
  return ((ac1->curses_color == ac2->curses_color) && (ac1->attrs == ac2->attrs));
}

Here is the caller graph for this function:

attr_color_new()

struct AttrColor * attr_color_new

(

void

)

Create a new AttrColor.

Return values

ptr	New AttrColor

Definition at line 91 of file attr.c.

{
  struct AttrColor *ac = mutt_mem_calloc(1, sizeof(*ac));
 
  ac->fg.color = COLOR_DEFAULT;
  ac->fg.type = CT_SIMPLE;
  ac->fg.prefix = COLOR_PREFIX_NONE;
 
  ac->bg.color = COLOR_DEFAULT;
  ac->bg.type = CT_SIMPLE;
  ac->bg.prefix = COLOR_PREFIX_NONE;
 
  ac->attrs = A_NORMAL;
 
  ac->ref_count = 1;
 
  return ac;
}

Here is the call graph for this function:

Here is the caller graph for this function:

attr_color_list_clear()

void attr_color_list_clear

(

struct AttrColorList *

acl

)

Free the contents of an AttrColorList.

Parameters

acl	List to clear

Free each of the AttrColors in a list.

Note

The list object isn't freed, only emptied

Definition at line 118 of file attr.c.

{
  if (!acl)
    return;
 
  struct AttrColor *ac = NULL;
  struct AttrColor *tmp = NULL;
  TAILQ_FOREACH_SAFE(ac, acl, entries, tmp)
  {
    TAILQ_REMOVE(acl, ac, entries);
    attr_color_free(&ac);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

attr_color_list_find()

struct AttrColor * attr_color_list_find	(	struct AttrColorList *	acl,
		color_t	fg,
		color_t	bg,
		int	attrs
	)

Find an AttrColor in a list.

Parameters

acl	List to search
fg	Foreground colour
bg	Background colour
attrs	Attributes, e.g. A_UNDERLINE

Return values

ptr	Matching AttrColor

Definition at line 140 of file attr.c.

{
  if (!acl)
    return NULL;
 
  struct AttrColor *ac = NULL;
  TAILQ_FOREACH(ac, acl, entries)
  {
    if (ac->attrs != attrs)
      continue;
 
    struct CursesColor *cc = ac->curses_color;
    if (!cc)
      continue;
 
    if ((cc->fg == fg) && (cc->bg == bg))
      return ac;
  }
  return NULL;
}

Here is the caller graph for this function:

attr_color_overwrite()

void attr_color_overwrite	(	struct AttrColor *	ac_old,
		struct AttrColor *	ac_new
	)

Update an AttrColor in-place.

Parameters

ac_old	AttrColor to overwrite
ac_new	AttrColor to copy

Definition at line 396 of file attr.c.

{
  if (!ac_old || !ac_new)
    return;
 
  color_t fg = ac_new->fg.color;
  color_t bg = ac_new->bg.color;
  int attrs = ac_new->attrs;
 
  modify_color_by_prefix(ac_new->fg.prefix, true, &fg, &attrs);
  modify_color_by_prefix(ac_new->bg.prefix, false, &bg, &attrs);
 
#ifdef NEOMUTT_DIRECT_COLORS
  if ((ac_new->fg.type == CT_SIMPLE) || (ac_new->fg.type == CT_PALETTE))
    fg = color_xterm256_to_24bit(fg);
  else if (fg < 8)
    fg = 8;
  if ((ac_new->bg.type == CT_SIMPLE) || (ac_new->bg.type == CT_PALETTE))
    bg = color_xterm256_to_24bit(bg);
  else if (bg < 8)
    bg = 8;
#endif
 
  struct CursesColor *cc = curses_color_new(fg, bg);
  curses_color_free(&ac_old->curses_color);
  ac_old->fg = ac_new->fg;
  ac_old->bg = ac_new->bg;
  ac_old->attrs = attrs;
  ac_old->curses_color = cc;
}

Here is the call graph for this function:

Here is the caller graph for this function: