parse_color.c File Reference

Parse colour commands. More...

#include "config.h"
#include <stdbool.h>
#include <stdlib.h>
#include "mutt/lib.h"
#include "core/lib.h"
#include "gui/lib.h"
#include "parse_color.h"
#include "parse/lib.h"
#include "attr.h"
#include "color.h"
#include "debug.h"

Include dependency graph for parse_color.c:

Go to the source code of this file.

Functions
int	parse_color_prefix (const char *s, enum ColorPrefix *prefix)
	Parse a colour prefix, e.g.
enum CommandResult	parse_color_namedcolor (const char *s, struct ColorElement *elem, struct Buffer *err)
	Parse a named colour, e.g.
enum CommandResult	parse_color_colornnn (const char *s, struct ColorElement *elem, struct Buffer *err)
	Parse a colorNNN, e.g.
enum CommandResult	parse_color_rrggbb (const char *s, struct ColorElement *elem, struct Buffer *err)
	Parse an RGB colour, e.g.
enum CommandResult	parse_color_name (const char *s, struct ColorElement *elem, struct Buffer *err)
	Parse a colour name.
enum CommandResult	parse_color_pair (struct Buffer *buf, struct Buffer *s, struct AttrColor *ac, struct Buffer *err)
	Parse a pair of colours - Implements parser_callback_t -.
enum CommandResult	parse_attr_spec (struct Buffer *buf, struct Buffer *s, struct AttrColor *ac, struct Buffer *err)
	Parse an attribute description - Implements parser_callback_t -.

Variables
const struct Mapping	ColorNames []
	Mapping between a colour name and an ncurses colour.
static struct Mapping	AttributeNames []
	Mapping of attribute names to their IDs.

Detailed Description

Parse colour commands.

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 parse_color.c.

Function Documentation

parse_color_prefix()

int parse_color_prefix	(	const char *	s,
		enum ColorPrefix *	prefix )

Parse a colour prefix, e.g.

"bright"

Parameters

[in]	s	String to parse
[out]	prefix	parsed prefix, see ColorPrefix

Return values

num	Length of the matched prefix
0	No prefix matched

If prefixes should be parsed, but their value is irrelevant, NULL can be passed as 'prefix'.

Definition at line 83 of file parse_color.c.

{
  if (!s || !prefix)
    return 0;
 
  int clen = 0;
 
  if ((clen = mutt_istr_startswith(s, "bright")))
  {
    color_debug(LL_DEBUG5, "bright\n");
    if (prefix)
      *prefix = COLOR_PREFIX_BRIGHT;
  }
  else if ((clen = mutt_istr_startswith(s, "alert")))
  {
    color_debug(LL_DEBUG5, "alert\n");
    if (prefix)
      *prefix = COLOR_PREFIX_ALERT;
  }
  else if ((clen = mutt_istr_startswith(s, "light")))
  {
    color_debug(LL_DEBUG5, "light\n");
    if (prefix)
      *prefix = COLOR_PREFIX_LIGHT;
  }
 
  return clen;
}

Here is the call graph for this function:

Here is the caller graph for this function:

parse_color_namedcolor()

enum CommandResult parse_color_namedcolor	(	const char *	s,
		struct ColorElement *	elem,
		struct Buffer *	err )

Parse a named colour, e.g.

"brightred"

Parameters

[in]	s	String to parse
[out]	elem	Colour element to update
[out]	err	Buffer for error messages

Return values

MUTT_CMD_SUCCESS	Colour parsed successfully
MUTT_CMD_WARNING	Unknown colour, try other parsers

Definition at line 120 of file parse_color.c.

{
  if (!s || !elem)
    return MUTT_CMD_ERROR;
 
  // COLOR_DEFAULT (-1) interferes with mutt_map_get_value()
  if (mutt_str_equal(s, "default"))
  {
    elem->color = COLOR_DEFAULT;
    elem->type = CT_SIMPLE;
    elem->prefix = COLOR_PREFIX_NONE;
    return MUTT_CMD_SUCCESS;
  }
 
  enum ColorPrefix prefix = COLOR_PREFIX_NONE;
  s += parse_color_prefix(s, &prefix);
 
  int color = mutt_map_get_value(s, ColorNames);
  if (color == -1)
    return MUTT_CMD_WARNING;
 
  elem->color = color;
  elem->type = CT_SIMPLE;
  elem->prefix = prefix;
 
  const char *name = mutt_map_get_name(elem->color, ColorNames);
  if (name)
    color_debug(LL_DEBUG5, "color: %s\n", name);
 
  return MUTT_CMD_SUCCESS;
}

Here is the call graph for this function:

Here is the caller graph for this function:

parse_color_colornnn()

enum CommandResult parse_color_colornnn	(	const char *	s,
		struct ColorElement *	elem,
		struct Buffer *	err )

Parse a colorNNN, e.g.

"color123"

Parameters

[in]	s	String to parse
[out]	elem	Colour element to update
[out]	err	Buffer for error messages

Return values

MUTT_CMD_SUCCESS	Colour parsed successfully
MUTT_CMD_WARNING	Unknown colour, try other parsers
MUTT_CMD_ERROR	Error, colour could not be parsed

On MUTT_CMD_ERROR, an error message will be written to err.

Definition at line 164 of file parse_color.c.

{
  if (!s || !elem)
    return MUTT_CMD_ERROR;
 
  /* prefixes bright, alert, light are only allowed for named colours and
   * colorNNN for backwards compatibility. */
  enum ColorPrefix prefix = COLOR_PREFIX_NONE;
  s += parse_color_prefix(s, &prefix);
 
  int clen = 0;
  /* allow aliases for xterm color resources */
  if ((clen = mutt_istr_startswith(s, "color")) == 0)
    return MUTT_CMD_WARNING;
 
  s += clen;
  char *eptr = NULL;
 
  unsigned long color = strtoul(s, &eptr, 10);
  /* There are only 256 xterm colors.  Do not confuse with COLORS which is
   * the number of colours the terminal supports (usually one of 16, 256,
   * 16777216 (=24bit)). */
  if ((*s == '\0') || (*eptr != '\0') || (color >= 256))
  {
    buf_printf(err, _("%s: color not supported by term"), s);
    return MUTT_CMD_ERROR;
  }
 
  elem->color = color;
  elem->type = CT_PALETTE;
  elem->prefix = prefix;
 
  color_debug(LL_DEBUG5, "colorNNN %d\n", elem->color);
  return MUTT_CMD_SUCCESS;
}

Here is the call graph for this function:

Here is the caller graph for this function:

parse_color_rrggbb()

enum CommandResult parse_color_rrggbb	(	const char *	s,
		struct ColorElement *	elem,
		struct Buffer *	err )

Parse an RGB colour, e.g.

"#12FE45"

Parameters

[in]	s	String to parse
[out]	elem	Colour element to update
[out]	err	Buffer for error messages

Return values

MUTT_CMD_SUCCESS	Colour parsed successfully
MUTT_CMD_WARNING	Unknown colour, try other parsers
MUTT_CMD_ERROR	Error, colour could not be parsed

On MUTT_CMD_ERROR, an error message will be written to err.

Definition at line 212 of file parse_color.c.

{
  if (!s || !elem)
    return MUTT_CMD_ERROR;
 
  /* parse #RRGGBB colours */
  if (s[0] != '#')
    return MUTT_CMD_WARNING;
 
  s++;
  char *eptr = NULL;
  unsigned long color = strtoul(s, &eptr, 16);
 
  if ((*s == '\0') || !eptr || (*eptr != '\0') || ((eptr - s) != 6))
  {
    buf_printf(err, _("%s: color not supported by term"), s);
    return MUTT_CMD_ERROR;
  }
 
  elem->color = color;
  elem->type = CT_RGB;
  elem->prefix = COLOR_PREFIX_NONE;
 
  color_debug(LL_DEBUG5, "#RRGGBB: %ld\n", color);
  return MUTT_CMD_SUCCESS;
}

Here is the call graph for this function:

Here is the caller graph for this function:

parse_color_name()

enum CommandResult parse_color_name	(	const char *	s,
		struct ColorElement *	elem,
		struct Buffer *	err )

Parse a colour name.

Parameters

[in]	s	String to parse
[out]	elem	Colour element to update
[out]	err	Buffer for error messages

Return values

CommandResult

Result e.g. MUTT_CMD_SUCCESS

Parse a colour name, such as "red", "brightgreen", "color123", "#12FE45"

Definition at line 249 of file parse_color.c.

{
  color_debug(LL_DEBUG5, "Parsing color name: %s\n", s);
 
  /* Try the different colour syntaxes.  A return value of MUTT_CMD_WARNING
   * means, we should try the next syntax. */
  enum CommandResult cr;
 
  /* #RRGGBB */
  cr = parse_color_rrggbb(s, elem, err);
  if (cr != MUTT_CMD_WARNING)
    return cr;
 
  /* color123 */
  cr = parse_color_colornnn(s, elem, err);
  if (cr != MUTT_CMD_WARNING)
    return cr;
 
  /* named color, e.g. "brightred" */
  cr = parse_color_namedcolor(s, elem, err);
  if (cr != MUTT_CMD_WARNING)
    return cr;
 
  buf_printf(err, _("%s: no such color"), s);
  return MUTT_CMD_WARNING;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

ColorNames

const struct Mapping ColorNames[]

Initial value:

= {
  
  { "black",   COLOR_BLACK },
  { "blue",    COLOR_BLUE },
  { "cyan",    COLOR_CYAN },
  { "green",   COLOR_GREEN },
  { "magenta", COLOR_MAGENTA },
  { "red",     COLOR_RED },
  { "white",   COLOR_WHITE },
  { "yellow",  COLOR_YELLOW },
  { "default", COLOR_DEFAULT },
  { 0, 0 },
  
}

Mapping between a colour name and an ncurses colour.

Definition at line 42 of file parse_color.c.

                                    {
  // clang-format off
  { "black",   COLOR_BLACK },
  { "blue",    COLOR_BLUE },
  { "cyan",    COLOR_CYAN },
  { "green",   COLOR_GREEN },
  { "magenta", COLOR_MAGENTA },
  { "red",     COLOR_RED },
  { "white",   COLOR_WHITE },
  { "yellow",  COLOR_YELLOW },
  { "default", COLOR_DEFAULT },
  { 0, 0 },
  // clang-format on
};

AttributeNames

struct Mapping AttributeNames[]

static

Initial value:

= {
  
  { "bold",      A_BOLD      },
  { "italic",    A_ITALIC    },
  { "none",      A_NORMAL    },
  { "normal",    A_NORMAL    },
  { "reverse",   A_REVERSE   },
  { "standout",  A_STANDOUT  },
  { "underline", A_UNDERLINE },
  { NULL, 0 },
  
}

Mapping of attribute names to their IDs.

Definition at line 60 of file parse_color.c.

                                         {
  // clang-format off
  { "bold",      A_BOLD      },
  { "italic",    A_ITALIC    },
  { "none",      A_NORMAL    },
  { "normal",    A_NORMAL    },
  { "reverse",   A_REVERSE   },
  { "standout",  A_STANDOUT  },
  { "underline", A_UNDERLINE },
  { NULL, 0 },
  // clang-format on
};