Color and attribute parsing. More...

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

Include dependency graph for color.h:

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

Macros
#define	COLOR_DEFAULT (-2)

#define	COLOR_UNSET UINT32_MAX

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_ITALIC , 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_BACKGROUND , 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_COLLAPSED , MT_COLOR_INDEX_DATE , MT_COLOR_INDEX_FLAGS , MT_COLOR_INDEX_LABEL , MT_COLOR_INDEX_NUMBER , MT_COLOR_INDEX_SIZE , MT_COLOR_INDEX_SUBJECT , MT_COLOR_INDEX_TAG , MT_COLOR_INDEX_TAGS , MT_COLOR_MAX }
	List of all colored objects. More...

Functions
void	mutt_colors_init (void)
	Initialize colours. More...

void	mutt_colors_cleanup (void)
	Cleanup all the colours. More...

bool	mutt_color_has_pattern (enum ColorId cid)
	Check if a color object supports a regex pattern. More...

void	colors_clear (void)
	Reset all the simple, quoted and regex colours. More...

Variables
const struct Mapping	ColorNames []
	Mapping between a colour name and an ncurses colour. More...

const struct Mapping	ColorFields []
	Mapping of colour names to their IDs. More...

const struct Mapping	ComposeColorFields []
	Mapping of compose colour names to their IDs. More...

Detailed Description

Color and attribute parsing.

Authors

Michael R. Elkins
R Primus

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.

Macro Definition Documentation

◆ COLOR_DEFAULT

#define COLOR_DEFAULT (-2)

Definition at line 102 of file color.h.

◆ COLOR_UNSET

#define COLOR_UNSET UINT32_MAX

Definition at line 103 of 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_ITALIC	Italic text.
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_BACKGROUND	Background colour for the Sidebar.
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.
MT_COLOR_INDEX_AUTHOR	Index: author field.
MT_COLOR_INDEX_COLLAPSED	Index: number of messages in collapsed thread.
MT_COLOR_INDEX_DATE	Index: date field.
MT_COLOR_INDEX_FLAGS	Index: flags 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_SUBJECT	Index: subject field.
MT_COLOR_INDEX_TAG	Index: tag field (G)
MT_COLOR_INDEX_TAGS	Index: tags field (g, J)
MT_COLOR_MAX

Definition at line 37 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_ITALIC,                   
  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_BACKGROUND,       
  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,                  
  // Index colours which all take a pattern
  MT_COLOR_INDEX,                    
  MT_COLOR_INDEX_AUTHOR,             
  MT_COLOR_INDEX_COLLAPSED,          
  MT_COLOR_INDEX_DATE,               
  MT_COLOR_INDEX_FLAGS,              
  MT_COLOR_INDEX_LABEL,              
  MT_COLOR_INDEX_NUMBER,             
  MT_COLOR_INDEX_SIZE,               
  MT_COLOR_INDEX_SUBJECT,            
  MT_COLOR_INDEX_TAG,                
  MT_COLOR_INDEX_TAGS,               
  MT_COLOR_MAX,
};

Function Documentation

◆ mutt_colors_init()

void mutt_colors_init ( void )

Initialize colours.

Definition at line 82 of file color.c.

{
  color_debug(LL_DEBUG5, "init\n");
  color_notify_init();
  simple_colors_init();
  regex_colors_init();
  curses_colors_init();
  merged_colors_init();
 
  start_color();
  use_default_colors();
  color_debug(LL_DEBUG5, "COLORS = %d, COLOR_PAIRS = %d\n", COLORS, COLOR_PAIRS);
 
  notify_set_parent(ColorsNotify, 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 72 of file color.c.

{
  colors_clear();
  merged_colors_clear();
  color_notify_free();
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mutt_color_has_pattern()

bool mutt_color_has_pattern ( enum ColorId cid )

Check if a color object supports a regex pattern.

Parameters

cid	Object type, e.g. MT_COLOR_TILDE

Return values

true	The color object supports patterns

Definition at line 103 of file color.c.

{
  return (cid == MT_COLOR_ATTACH_HEADERS) || (cid == MT_COLOR_BODY) ||
         (cid == MT_COLOR_HEADER) || (cid == MT_COLOR_INDEX) ||
         (cid == MT_COLOR_INDEX_AUTHOR) || (cid == MT_COLOR_INDEX_COLLAPSED) ||
         (cid == MT_COLOR_INDEX_DATE) || (cid == MT_COLOR_INDEX_FLAGS) ||
         (cid == MT_COLOR_INDEX_LABEL) || (cid == MT_COLOR_INDEX_NUMBER) ||
         (cid == MT_COLOR_INDEX_SIZE) || (cid == MT_COLOR_INDEX_SUBJECT) ||
         (cid == MT_COLOR_INDEX_TAG) || (cid == MT_COLOR_INDEX_TAGS) ||
         (cid == MT_COLOR_STATUS);
}

Here is the caller graph for this function:

◆ colors_clear()

void colors_clear ( void )

Reset all the simple, quoted and regex colours.

Definition at line 57 of file color.c.

{
  color_debug(LL_DEBUG5, "clean up\n");
  mutt_debug(LL_NOTIFY, "NT_COLOR_RESET: [ALL]\n");
  struct EventColor ev_c = { MT_COLOR_MAX, NULL };
  notify_send(ColorsNotify, NT_COLOR, NT_COLOR_RESET, &ev_c);
 
  simple_colors_clear();
  quoted_colors_clear();
  regex_colors_clear();
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

◆ ColorNames

const struct Mapping ColorNames[]

extern

Mapping between a colour name and an ncurses colour.

Definition at line 39 of file color.c.

◆ ColorFields

const struct Mapping ColorFields[]

extern

Mapping of colour names to their IDs.

Definition at line 53 of file command.c.

◆ ComposeColorFields

const struct Mapping ComposeColorFields[]

extern

Mapping of compose colour names to their IDs.

Definition at line 108 of file command.c.

Macros

Enumerations

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ COLOR_DEFAULT

◆ COLOR_UNSET

Enumeration Type Documentation

◆ ColorId

Function Documentation

◆ mutt_colors_init()

◆ mutt_colors_cleanup()

◆ mutt_color_has_pattern()

◆ colors_clear()

Variable Documentation

◆ ColorNames

◆ ColorFields

◆ ComposeColorFields