Colour Parsing API

Prototype for a function to parse color config. More...

Functions
enum CommandResult	parse_color_pair (const struct Command *cmd, struct Buffer *line, struct AttrColor *ac, struct Buffer *err)
	Parse a pair of colours - Implements parser_callback_t -.
enum CommandResult	parse_attr_spec (const struct Command *cmd, struct Buffer *line, struct AttrColor *ac, struct Buffer *err)
	Parse an attribute description - Implements parser_callback_t -.

Detailed Description

Prototype for a function to parse color config.

Parameters

[in]	cmd	Command being parsed
[in]	line	Buffer containing string to be parsed
[out]	ac	Colour
[out]	err	Buffer for error messages

Return values

0	Success
-1	Error

Precondition

cmd is not NULL

line is not NULL

ac is not NULL

err is not NULL

Function Documentation

parse_color_pair()

enum CommandResult parse_color_pair	(	const struct Command *	cmd,
		struct Buffer *	line,
		struct AttrColor *	ac,
		struct Buffer *	err )

Parse a pair of colours - Implements parser_callback_t -.

Parse a pair of colours, e.g. "red default"

Definition at line 282 of file parse_color.c.

{
  struct Buffer *token = buf_pool_get();
  enum CommandResult rc = MUTT_CMD_WARNING;
 
  while (true)
  {
    if (!MoreArgsF(line, TOKEN_COMMENT))
    {
      buf_printf(err, _("%s: too few arguments"), cmd->name);
      goto done;
    }
 
    parse_extract_token(token, line, TOKEN_COMMENT);
    if (buf_is_empty(token))
      continue;
 
    int attr = mutt_map_get_value(buf_string(token), AttributeNames);
    if (attr == -1)
    {
      rc = parse_color_name(buf_string(token), &ac->fg, err);
      if (rc != MUTT_CMD_SUCCESS)
        goto done;
      break;
    }
 
    if (attr == A_NORMAL)
      ac->attrs = attr; // Clear all attributes
    else
      ac->attrs |= attr; // Merge with other attributes
  }
 
  if (!MoreArgsF(line, TOKEN_COMMENT))
  {
    buf_printf(err, _("%s: too few arguments"), "color");
    rc = MUTT_CMD_WARNING;
    goto done;
  }
 
  parse_extract_token(token, line, TOKEN_COMMENT);
 
  rc = parse_color_name(buf_string(token), &ac->bg, err);
 
done:
  buf_pool_release(&token);
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

parse_attr_spec()

enum CommandResult parse_attr_spec	(	const struct Command *	cmd,
		struct Buffer *	line,
		struct AttrColor *	ac,
		struct Buffer *	err )

Parse an attribute description - Implements parser_callback_t -.

Definition at line 334 of file parse_color.c.

{
  struct Buffer *token = buf_pool_get();
  enum CommandResult rc = MUTT_CMD_WARNING;
 
  if (!MoreArgs(line))
  {
    buf_printf(err, _("%s: too few arguments"), cmd->name);
    goto done;
  }
 
  parse_extract_token(token, line, TOKEN_NO_FLAGS);
 
  int attr = mutt_map_get_value(buf_string(token), AttributeNames);
  if (attr == -1)
  {
    buf_printf(err, _("%s: no such attribute"), buf_string(token));
    goto done;
  }
 
  if (attr == A_NORMAL)
    ac->attrs = attr; // Clear all attributes
  else
    ac->attrs |= attr; // Merge with other attributes
 
  rc = MUTT_CMD_SUCCESS;
 
done:
  buf_pool_release(&token);
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function: