color.h File Reference

Color and attribute parsing. More...

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

Include dependency graph for color.h:

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

Go to the source code of this file.

Data Structures
struct	ColorLine
	A regular expression and a color to highlight a line. More...
struct	EventColor
	An Event that happened to a Colour. More...

Enumerations
enum	ColorId {   MT_COLOR_NONE = 50, MT_COLOR_ATTACHMENT, MT_COLOR_ATTACH_HEADERS, MT_COLOR_BODY,   MT_COLOR_BOLD, MT_COLOR_COMPOSE_HEADER, MT_COLOR_COMPOSE_SECURITY_BOTH, MT_COLOR_COMPOSE_SECURITY_ENCRYPT,   MT_COLOR_COMPOSE_SECURITY_NONE, MT_COLOR_COMPOSE_SECURITY_SIGN, MT_COLOR_ERROR, MT_COLOR_HDRDEFAULT,   MT_COLOR_HEADER, MT_COLOR_INDICATOR, MT_COLOR_MARKERS, MT_COLOR_MESSAGE,   MT_COLOR_MESSAGE_LOG, MT_COLOR_NORMAL, MT_COLOR_OPTIONS, MT_COLOR_PROGRESS,   MT_COLOR_PROMPT, MT_COLOR_QUOTED, MT_COLOR_SEARCH, MT_COLOR_SIDEBAR_DIVIDER,   MT_COLOR_SIDEBAR_FLAGGED, MT_COLOR_SIDEBAR_HIGHLIGHT, MT_COLOR_SIDEBAR_INDICATOR, MT_COLOR_SIDEBAR_NEW,   MT_COLOR_SIDEBAR_ORDINARY, MT_COLOR_SIDEBAR_SPOOLFILE, MT_COLOR_SIDEBAR_UNREAD, MT_COLOR_SIGNATURE,   MT_COLOR_STATUS, MT_COLOR_TILDE, MT_COLOR_TREE, MT_COLOR_UNDERLINE,   MT_COLOR_WARNING, MT_COLOR_INDEX, MT_COLOR_INDEX_AUTHOR, MT_COLOR_INDEX_FLAGS,   MT_COLOR_INDEX_SUBJECT, MT_COLOR_INDEX_TAG, MT_COLOR_INDEX_COLLAPSED, MT_COLOR_INDEX_DATE,   MT_COLOR_INDEX_LABEL, MT_COLOR_INDEX_NUMBER, MT_COLOR_INDEX_SIZE, MT_COLOR_INDEX_TAGS,   MT_COLOR_MAX }
	List of all colored objects. More...
enum	NotifyColor { NT_COLOR_SET = 1, NT_COLOR_RESET }
	Types of Color Event. More...

Functions
	STAILQ_HEAD (ColorLineList, ColorLine)
bool	mutt_color_is_header (enum ColorId color_id)
	Colour is for an Email header. More...
int	mutt_color_alloc (uint32_t fg, uint32_t bg)
	Allocate a colour pair. More...
int	mutt_color_combine (uint32_t fg_attr, uint32_t bg_attr)
	Combine two colours. More...
void	mutt_color_free (uint32_t fg, uint32_t bg)
	Free a colour. More...
void	mutt_colors_init (void)
	Initialize colours. More...
void	mutt_colors_cleanup (void)
	Cleanup all the colours. More...
enum CommandResult	mutt_parse_color (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
	Parse the 'color' command - Implements Command::parse() More...
enum CommandResult	mutt_parse_mono (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
	Parse the 'mono' command - Implements Command::parse() More...
enum CommandResult	mutt_parse_uncolor (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
	Parse the 'uncolor' command - Implements Command::parse() More...
enum CommandResult	mutt_parse_unmono (struct Buffer *buf, struct Buffer *s, intptr_t data, struct Buffer *err)
	Parse the 'unmono' command - Implements Command::parse() More...
int	mutt_color (enum ColorId id)
	Return the color of an object. More...
struct ColorLineList *	mutt_color_status_line (void)
	Return the ColorLineList for the status_line. More...
struct ColorLineList *	mutt_color_index (void)
	Return the ColorLineList for the index. More...
struct ColorLineList *	mutt_color_headers (void)
	Return the ColorLineList for headers. More...
struct ColorLineList *	mutt_color_body (void)
	Return the ColorLineList for the body. More...
struct ColorLineList *	mutt_color_attachments (void)
	Return the ColorLineList for the attachments. More...
struct ColorLineList *	mutt_color_index_author (void)
	Return the ColorLineList for author in the index. More...
struct ColorLineList *	mutt_color_index_flags (void)
	Return the ColorLineList for flags in the index. More...
struct ColorLineList *	mutt_color_index_subject (void)
	Return the ColorLineList for subject in the index. More...
struct ColorLineList *	mutt_color_index_tags (void)
	Return the ColorLineList for tags in the index. More...
int	mutt_color_quote (int quote)
	Return the color of a quote, cycling through the used quotes. More...
int	mutt_color_quotes_used (void)
	Return the number of used quotes. More...
void	mutt_color_observer_add (observer_t callback, void *global_data)
	Add an observer. More...
void	mutt_color_observer_remove (observer_t callback, void *global_data)
	Remove an observer. More...

Detailed Description

Color and attribute parsing.

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

Enumeration Type Documentation

ColorId

enum ColorId

List of all colored objects.

This enumeration starts at 50 to avoid any of the values being 37 (ASCII %). Inserting colour codes into expando strings, when one of the colour codes was '', was causing formatting problems.

Enumerator
MT_COLOR_NONE
MT_COLOR_ATTACHMENT	MIME attachments text (entire line)
MT_COLOR_ATTACH_HEADERS	MIME attachment test (takes a pattern)
MT_COLOR_BODY	Pager: highlight body of message (takes a pattern)
MT_COLOR_BOLD	Bold text.
MT_COLOR_COMPOSE_HEADER	Header labels, e.g. From:
MT_COLOR_COMPOSE_SECURITY_BOTH	Mail will be encrypted and signed.
MT_COLOR_COMPOSE_SECURITY_ENCRYPT	Mail will be encrypted.
MT_COLOR_COMPOSE_SECURITY_NONE	Mail will not be encrypted or signed.
MT_COLOR_COMPOSE_SECURITY_SIGN	Mail will be signed.
MT_COLOR_ERROR	Error message.
MT_COLOR_HDRDEFAULT	Header default colour.
MT_COLOR_HEADER	Message headers (takes a pattern)
MT_COLOR_INDICATOR	Selected item in list.
MT_COLOR_MARKERS	Pager: markers, line continuation.
MT_COLOR_MESSAGE	Informational message.
MT_COLOR_MESSAGE_LOG	Menu showing log messages.
MT_COLOR_NORMAL	Plain text.
MT_COLOR_OPTIONS	Options in prompt.
MT_COLOR_PROGRESS	Progress bar.
MT_COLOR_PROMPT	Question/user input.
MT_COLOR_QUOTED	Pager: quoted text.
MT_COLOR_SEARCH	Pager: search matches.
MT_COLOR_SIDEBAR_DIVIDER	Line dividing sidebar from the index/pager.
MT_COLOR_SIDEBAR_FLAGGED	Mailbox with flagged messages.
MT_COLOR_SIDEBAR_HIGHLIGHT	Select cursor.
MT_COLOR_SIDEBAR_INDICATOR	Current open mailbox.
MT_COLOR_SIDEBAR_NEW	Mailbox with new mail.
MT_COLOR_SIDEBAR_ORDINARY	Mailbox with no new or flagged messages.
MT_COLOR_SIDEBAR_SPOOLFILE	$spool_file (Spool mailbox)
MT_COLOR_SIDEBAR_UNREAD	Mailbox with unread mail.
MT_COLOR_SIGNATURE	Pager: signature lines.
MT_COLOR_STATUS	Status bar (takes a pattern)
MT_COLOR_TILDE	Pager: empty lines after message.
MT_COLOR_TREE	Index: tree-drawing characters.
MT_COLOR_UNDERLINE	Underlined text.
MT_COLOR_WARNING	Warning messages.
MT_COLOR_INDEX	Index: default colour (takes a pattern)
MT_COLOR_INDEX_AUTHOR	Index: author field (takes a pattern)
MT_COLOR_INDEX_FLAGS	Index: flags field (takes a pattern)
MT_COLOR_INDEX_SUBJECT	Index: subject field (takes a pattern)
MT_COLOR_INDEX_TAG	Index: tag field (g, takes a pattern)
MT_COLOR_INDEX_COLLAPSED	Index: number of messages in collapsed thread.
MT_COLOR_INDEX_DATE	Index: date field.
MT_COLOR_INDEX_LABEL	Index: label field.
MT_COLOR_INDEX_NUMBER	Index: index number.
MT_COLOR_INDEX_SIZE	Index: size field.
MT_COLOR_INDEX_TAGS	Index: tags field (g, J)
MT_COLOR_MAX

Definition at line 39 of file color.h.

{
  MT_COLOR_NONE = 50,
  MT_COLOR_ATTACHMENT,               
  MT_COLOR_ATTACH_HEADERS,           
  MT_COLOR_BODY,                     
  MT_COLOR_BOLD,                     
  MT_COLOR_COMPOSE_HEADER,           
  MT_COLOR_COMPOSE_SECURITY_BOTH,    
  MT_COLOR_COMPOSE_SECURITY_ENCRYPT, 
  MT_COLOR_COMPOSE_SECURITY_NONE,    
  MT_COLOR_COMPOSE_SECURITY_SIGN,    
  MT_COLOR_ERROR,                    
  MT_COLOR_HDRDEFAULT,               
  MT_COLOR_HEADER,                   
  MT_COLOR_INDICATOR,                
  MT_COLOR_MARKERS,                  
  MT_COLOR_MESSAGE,                  
  MT_COLOR_MESSAGE_LOG,              
  MT_COLOR_NORMAL,                   
  MT_COLOR_OPTIONS,                  
  MT_COLOR_PROGRESS,                 
  MT_COLOR_PROMPT,                   
  MT_COLOR_QUOTED,                   
  MT_COLOR_SEARCH,                   
#ifdef USE_SIDEBAR
  MT_COLOR_SIDEBAR_DIVIDER,          
  MT_COLOR_SIDEBAR_FLAGGED,          
  MT_COLOR_SIDEBAR_HIGHLIGHT,        
  MT_COLOR_SIDEBAR_INDICATOR,        
  MT_COLOR_SIDEBAR_NEW,              
  MT_COLOR_SIDEBAR_ORDINARY,         
  MT_COLOR_SIDEBAR_SPOOLFILE,        
  MT_COLOR_SIDEBAR_UNREAD,           
#endif
  MT_COLOR_SIGNATURE,                
  MT_COLOR_STATUS,                   
  MT_COLOR_TILDE,                    
  MT_COLOR_TREE,                     
  MT_COLOR_UNDERLINE,                
  MT_COLOR_WARNING,                  
  /* please no non-MT_COLOR_INDEX objects after this point */
  MT_COLOR_INDEX,                    
  MT_COLOR_INDEX_AUTHOR,             
  MT_COLOR_INDEX_FLAGS,              
  MT_COLOR_INDEX_SUBJECT,            
  MT_COLOR_INDEX_TAG,                
  /* below here - only index coloring stuff that doesn't have a pattern */
  MT_COLOR_INDEX_COLLAPSED,          
  MT_COLOR_INDEX_DATE,               
  MT_COLOR_INDEX_LABEL,              
  MT_COLOR_INDEX_NUMBER,             
  MT_COLOR_INDEX_SIZE,               
  MT_COLOR_INDEX_TAGS,               
  MT_COLOR_MAX,
};

NotifyColor

enum NotifyColor

Types of Color Event.

Observers of NT_COLOR will be passed an EventColor.

Enumerator
NT_COLOR_SET	A new Color has been set.
NT_COLOR_RESET	Color has been reset/removed.

Definition at line 132 of file color.h.

{
  NT_COLOR_SET = 1, 
  NT_COLOR_RESET,   
};

Function Documentation

STAILQ_HEAD()

STAILQ_HEAD	(	ColorLineList	,
		ColorLine
	)

mutt_color_is_header()

bool mutt_color_is_header

(

enum ColorId

color_id

)

Colour is for an Email header.

Parameters

color_id

Colour, e.g. MT_COLOR_HEADER

Return values

true	Colour is for an Email header

Definition at line 1526 of file color.c.

{
    return (color_id == MT_COLOR_HEADER) || (color_id == MT_COLOR_HDRDEFAULT);
}

Here is the caller graph for this function:

mutt_color_alloc()

int mutt_color_alloc	(	uint32_t	fg,
		uint32_t	bg
	)

Allocate a colour pair.

Parameters

fg	Foreground colour ID
bg	Background colour ID

Return values

num	Combined colour pair

Definition at line 478 of file color.c.

{
#ifdef USE_SLANG_CURSES
  char fgc[128], bgc[128];
#endif
  struct ColorList *p = Colors.user_colors;

  /* check to see if this color is already allocated to save space */
  while (p)
  {
    if ((p->fg == fg) && (p->bg == bg))
    {
      (p->count)++;
      return COLOR_PAIR(p->index);
    }
    p = p->next;
  }

  /* check to see if there are colors left */
  if (++Colors.num_user_colors > COLOR_PAIRS)
    return A_NORMAL;

  /* find the smallest available index (object) */
  int i = 1;
  while (true)
  {
    p = Colors.user_colors;
    while (p)
    {
      if (p->index == i)
        break;
      p = p->next;
    }
    if (!p)
      break;
    i++;
  }

  p = mutt_mem_malloc(sizeof(struct ColorList));
  p->next = Colors.user_colors;
  Colors.user_colors = p;

  p->index = i;
  p->count = 1;
  p->bg = bg;
  p->fg = fg;

#ifdef USE_SLANG_CURSES
  /*
   * If using s-lang always use SLtt_set_color which allows using truecolor
   * values. Note that I couldn't figure out if s-lang somehow reports
   * truecolor support.
   */
  SLtt_set_color(i, NULL, get_color_name(fgc, sizeof(fgc), fg),
                 get_color_name(bgc, sizeof(bgc), bg));
#else
#ifdef HAVE_USE_DEFAULT_COLORS
  if (fg == COLOR_DEFAULT)
    fg = COLOR_UNSET;
  if (bg == COLOR_DEFAULT)
    bg = COLOR_UNSET;
#endif
  init_pair(i, fg, bg);
#endif

  mutt_debug(LL_DEBUG3, "Color pairs used so far: %d\n", Colors.num_user_colors);

  return COLOR_PAIR(p->index);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_color_combine()

int mutt_color_combine	(	uint32_t	fg_attr,
		uint32_t	bg_attr
	)

Combine two colours.

Parameters

fg_attr	Colour pair of foreground to use
bg_attr	Colour pair of background to use

Return values

num	Colour pair of combined colour

Definition at line 581 of file color.c.

{
  uint32_t fg = COLOR_DEFAULT;
  uint32_t bg = COLOR_DEFAULT;

  mutt_lookup_color(fg_attr, &fg, NULL);
  mutt_lookup_color(bg_attr, NULL, &bg);

  if ((fg == COLOR_DEFAULT) && (bg == COLOR_DEFAULT))
    return A_NORMAL;
  return mutt_color_alloc(fg, bg);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_color_free()

void mutt_color_free	(	uint32_t	fg,
		uint32_t	bg
	)

Free a colour.

Parameters

fg	Foreground colour ID
bg	Background colour ID

If there are no more users, the resource will be freed.

Definition at line 284 of file color.c.

{
  struct ColorList *q = NULL;

  struct ColorList *p = Colors.user_colors;
  while (p)
  {
    if ((p->fg == fg) && (p->bg == bg))
    {
      (p->count)--;
      if (p->count > 0)
        return;

      Colors.num_user_colors--;
      mutt_debug(LL_DEBUG1, "Color pairs used so far: %d\n", Colors.num_user_colors);

      if (p == Colors.user_colors)
      {
        Colors.user_colors = Colors.user_colors->next;
        FREE(&p);
        return;
      }
      q = Colors.user_colors;
      while (q)
      {
        if (q->next == p)
        {
          q->next = p->next;
          FREE(&p);
          return;
        }
        q = q->next;
      }
      /* can't get here */
    }
    p = p->next;
  }
}

Here is the caller graph for this function:

mutt_colors_init()

void mutt_colors_init

(

void

)

Initialize colours.

Definition at line 393 of file color.c.

{
  Colors.notify = notify_new();

  quotes_init();
  defs_init();

#ifdef HAVE_COLOR
  start_color();
#endif

  notify_set_parent(Colors.notify, NeoMutt->notify);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_colors_cleanup()

void mutt_colors_cleanup

(

void

)

Cleanup all the colours.

Definition at line 384 of file color.c.

{
  colors_clear();
  notify_free(&Colors.notify);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_parse_color()

enum CommandResult mutt_parse_color	(	struct Buffer *	buf,
		struct Buffer *	s,
		intptr_t	data,
		struct Buffer *	err
	)

Parse the 'color' command - Implements Command::parse()

Definition at line 1357 of file color.c.

{
  bool dry_run = false;

  if (OptNoCurses || !has_colors())
    dry_run = true;

  return parse_color(buf, s, err, parse_color_pair, dry_run, true);
}

Here is the call graph for this function:

mutt_parse_mono()

enum CommandResult mutt_parse_mono	(	struct Buffer *	buf,
		struct Buffer *	s,
		intptr_t	data,
		struct Buffer *	err
	)

Parse the 'mono' command - Implements Command::parse()

Definition at line 1372 of file color.c.

{
  bool dry_run = false;

#ifdef HAVE_COLOR
  if (OptNoCurses || has_colors())
    dry_run = true;
#else
  if (OptNoCurses)
    dry_run = true;
#endif

  return parse_color(buf, s, err, parse_attr_spec, dry_run, false);
}

Here is the call graph for this function:

mutt_parse_uncolor()

enum CommandResult mutt_parse_uncolor	(	struct Buffer *	buf,
		struct Buffer *	s,
		intptr_t	data,
		struct Buffer *	err
	)

Parse the 'uncolor' command - Implements Command::parse()

Definition at line 923 of file color.c.

{
  if (OptNoCurses || !has_colors())
  {
    *s->dptr = '\0'; /* fake that we're done parsing */
    return MUTT_CMD_SUCCESS;
  }
  return parse_uncolor(buf, s, err, true);
}

Here is the call graph for this function:

mutt_parse_unmono()

enum CommandResult mutt_parse_unmono	(	struct Buffer *	buf,
		struct Buffer *	s,
		intptr_t	data,
		struct Buffer *	err
	)

Parse the 'unmono' command - Implements Command::parse()

Definition at line 938 of file color.c.

{
  if (OptNoCurses || !has_colors())
  {
    *s->dptr = '\0'; /* fake that we're done parsing */
    return MUTT_CMD_SUCCESS;
  }
  return parse_uncolor(buf, s, err, false);
}

Here is the call graph for this function:

mutt_color()

int mutt_color

(

enum ColorId

id

)

Return the color of an object.

Parameters

id

Object id

Return values

num	Color ID, e.g. MT_COLOR_HEADER

Definition at line 1393 of file color.c.

{
  return Colors.defs[id];
}

Here is the caller graph for this function:

mutt_color_status_line()

struct ColorLineList* mutt_color_status_line

(

void

)

Return the ColorLineList for the status_line.

Return values

ptr	ColorLineList

Definition at line 1402 of file color.c.

{
  return get_color_line_list(&Colors.status_list);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_color_index()

struct ColorLineList* mutt_color_index

(

void

)

Return the ColorLineList for the index.

Return values

ptr	ColorLineList

Definition at line 1411 of file color.c.

{
  return get_color_line_list(&Colors.index_list);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_color_headers()

struct ColorLineList* mutt_color_headers

(

void

)

Return the ColorLineList for headers.

Return values

ptr	ColorLineList

Definition at line 1420 of file color.c.

{
  return get_color_line_list(&Colors.hdr_list);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_color_body()

struct ColorLineList* mutt_color_body

(

void

)

Return the ColorLineList for the body.

Return values

ptr	ColorLineList

Definition at line 1429 of file color.c.

{
  return get_color_line_list(&Colors.body_list);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_color_attachments()

struct ColorLineList* mutt_color_attachments

(

void

)

Return the ColorLineList for the attachments.

Return values

ptr	ColorLineList

Definition at line 1438 of file color.c.

{
  return get_color_line_list(&Colors.attach_list);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_color_index_author()

struct ColorLineList* mutt_color_index_author

(

void

)

Return the ColorLineList for author in the index.

Return values

ptr	ColorLineList

Definition at line 1447 of file color.c.

{
  return get_color_line_list(&Colors.index_author_list);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_color_index_flags()

struct ColorLineList* mutt_color_index_flags

(

void

)

Return the ColorLineList for flags in the index.

Return values

ptr	ColorLineList

Definition at line 1456 of file color.c.

{
  return get_color_line_list(&Colors.index_flags_list);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_color_index_subject()

struct ColorLineList* mutt_color_index_subject

(

void

)

Return the ColorLineList for subject in the index.

Return values

ptr	ColorLineList

Definition at line 1465 of file color.c.

{
  return get_color_line_list(&Colors.index_subject_list);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_color_index_tags()

struct ColorLineList* mutt_color_index_tags

(

void

)

Return the ColorLineList for tags in the index.

Return values

ptr	ColorLineList

Definition at line 1474 of file color.c.

{
  return get_color_line_list(&Colors.index_tag_list);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_color_quote()

int mutt_color_quote

(

int

q

)

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

Parameters

q	Quote number

Return values

num	Color ID, e.g. MT_COLOR_QUOTED

Definition at line 1484 of file color.c.

{
  const int used = Colors.quotes_used;
  if (used == 0)
    return 0;
  return Colors.quotes[q % used];
}

Here is the caller graph for this function:

mutt_color_quotes_used()

int mutt_color_quotes_used

(

void

)

Return the number of used quotes.

Return values

num	Number of used quotes

Definition at line 1496 of file color.c.

{
  return Colors.quotes_used;
}

Here is the caller graph for this function:

mutt_color_observer_add()

void mutt_color_observer_add	(	observer_t	callback,
		void *	global_data
	)

Add an observer.

Parameters

callback	The callback
global_data	The data

Definition at line 1506 of file color.c.

{
  notify_observer_add(Colors.notify, NT_COLOR, callback, global_data);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_color_observer_remove()

void mutt_color_observer_remove	(	observer_t	callback,
		void *	global_data
	)

Remove an observer.

Parameters

callback	The callback
global_data	The data

Definition at line 1516 of file color.c.

{
  notify_observer_remove(Colors.notify, callback, global_data);
}

Here is the call graph for this function:

Here is the caller graph for this function: