color.h

Go to the documentation of this file.

#ifndef MUTT_COLOR_H
#define MUTT_COLOR_H

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

struct ColorLine
{
  regex_t regex;                     
  int match;                         
  char *pattern;                     
  struct PatternList *color_pattern; 
  uint32_t fg;                       
  uint32_t bg;                       
  int pair;                          

  bool stop_matching : 1;            

  STAILQ_ENTRY(ColorLine) entries;   
};
STAILQ_HEAD(ColorLineList, ColorLine);

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,                   
#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,
};

struct ColorList
{
  /* TrueColor uses 24bit. Use fixed-width integer type to make sure it fits.
   * Use the upper 8 bits to store flags.  */
  uint32_t fg;
  uint32_t bg;
  short index;
  short count;
  struct ColorList *next;
};

struct Colors
{
  int *defs;                               

  struct ColorLineList attach_list;        
  struct ColorLineList body_list;          
  struct ColorLineList hdr_list;           
  struct ColorLineList index_author_list;  
  struct ColorLineList index_flags_list;   
  struct ColorLineList index_list;         
  struct ColorLineList index_subject_list; 
  struct ColorLineList index_tag_list;     
  struct ColorLineList status_list;        

  int *quotes;                             
  int quotes_used;                         

  struct ColorList *user_colors;
  int num_user_colors;

  struct Notify *notify;                   
};

struct EventColor
{
  bool set; 
};

int  mutt_color_alloc  (struct Colors *c, uint32_t fg,      uint32_t bg);
int  mutt_color_combine(struct Colors *c, uint32_t fg_attr, uint32_t bg_attr);
void mutt_color_free   (struct Colors *c, uint32_t fg,      uint32_t bg);

struct Colors *mutt_colors_new(void);
void           mutt_colors_free(struct Colors **ptr);

enum CommandResult mutt_parse_color  (struct Buffer *buf, struct Buffer *s, unsigned long data, struct Buffer *err);
enum CommandResult mutt_parse_mono   (struct Buffer *buf, struct Buffer *s, unsigned long data, struct Buffer *err);
enum CommandResult mutt_parse_uncolor(struct Buffer *buf, struct Buffer *s, unsigned long data, struct Buffer *err);
enum CommandResult mutt_parse_unmono (struct Buffer *buf, struct Buffer *s, unsigned long data, struct Buffer *err);

#endif /* MUTT_COLOR_H */