Parse colour commands. More...

#include "config.h"
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include "mutt/lib.h"
#include "config/lib.h"
#include "core/lib.h"
#include "gui/lib.h"
#include "mutt.h"
#include "parse/lib.h"
#include "attr.h"
#include "color.h"
#include "command2.h"
#include "debug.h"
#include "dump.h"
#include "globals.h"
#include "notify2.h"
#include "parse_color.h"
#include "quoted.h"
#include "regex4.h"
#include "simple2.h"

Include dependency graph for command.c:

Go to the source code of this file.

Functions
void	get_colorid_name (unsigned int cid, struct Buffer *buf)
	Get the name of a color id.

static enum CommandResult	parse_object (struct Buffer buf, struct Buffer s, enum ColorId cid, int ql, struct Buffer *err)
	Identify a colour object.

static enum CommandResult	parse_uncolor (struct Buffer buf, struct Buffer s, struct Buffer *err, bool uncolor)
	Parse an 'uncolor' command.

static enum CommandResult	parse_color (struct Buffer buf, struct Buffer s, struct Buffer *err, parser_callback_t callback, bool color)
	Parse a 'color' command.

enum CommandResult	mutt_parse_uncolor (struct Buffer buf, struct Buffer s, intptr_t data, struct Buffer *err)
	Parse the 'uncolor' command - Implements Command::parse() -.

enum CommandResult	mutt_parse_unmono (struct Buffer buf, struct Buffer s, intptr_t data, struct Buffer *err)
	Parse the 'unmono' command - Implements Command::parse() -.

enum CommandResult	mutt_parse_color (struct Buffer buf, struct Buffer s, intptr_t data, struct Buffer *err)
	Parse the 'color' command - Implements Command::parse() -.

enum CommandResult	mutt_parse_mono (struct Buffer buf, struct Buffer s, intptr_t data, struct Buffer *err)
	Parse the 'mono' command - Implements Command::parse() -.

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

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

Detailed Description

Parse colour commands.

Authors

Pietro Cerutti
Richard Russon
Dennis Schön

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

Function Documentation

◆ get_colorid_name()

void get_colorid_name	(	unsigned int	cid,
		struct Buffer *	buf
	)

Get the name of a color id.

Parameters

cid	Colour, e.g. MT_COLOR_HEADER
buf	Buffer for result

Definition at line 127 of file command.c.

{
  const char *name = NULL;
 
  if ((cid >= MT_COLOR_COMPOSE_HEADER) && (cid <= MT_COLOR_COMPOSE_SECURITY_SIGN))
  {
    name = mutt_map_get_name(cid, ComposeColorFields);
    if (name)
    {
      buf_printf(buf, "compose %s", name);
      return;
    }
  }
 
  name = mutt_map_get_name(cid, ColorFields);
  if (name)
    buf_addstr(buf, name);
  else
    buf_printf(buf, "UNKNOWN %d", cid);
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parse_object()

static enum CommandResult parse_object	(	struct Buffer *	buf,
		struct Buffer *	s,
		enum ColorId *	cid,
		int *	ql,
		struct Buffer *	err
	)

static

Identify a colour object.

Parameters

[in]	buf	Temporary Buffer space
[in]	s	Buffer containing string to be parsed
[out]	cid	Object type, e.g. MT_COLOR_TILDE
[out]	ql	Quote level, if type MT_COLOR_QUOTED
[out]	err	Buffer for error messages

Return values

CommandResult Result e.g. MUTT_CMD_SUCCESS

Identify a colour object, e.g. "quoted", "compose header"

Definition at line 159 of file command.c.

{
  int rc;
 
  if (mutt_str_startswith(buf->data, "quoted") != 0)
  {
    int val = 0;
    if (buf->data[6] != '\0')
    {
      if (!mutt_str_atoi_full(buf->data + 6, &val) || (val > COLOR_QUOTES_MAX))
      {
        buf_printf(err, _("%s: no such object"), buf->data);
        return MUTT_CMD_WARNING;
      }
    }
 
    *ql = val;
    *cid = MT_COLOR_QUOTED;
    return MUTT_CMD_SUCCESS;
  }
 
  if (mutt_istr_equal(buf->data, "compose"))
  {
    if (!MoreArgs(s))
    {
      buf_printf(err, _("%s: too few arguments"), "color");
      return MUTT_CMD_WARNING;
    }
 
    parse_extract_token(buf, s, TOKEN_NO_FLAGS);
 
    rc = mutt_map_get_value(buf->data, ComposeColorFields);
    if (rc == -1)
    {
      buf_printf(err, _("%s: no such object"), buf->data);
      return MUTT_CMD_WARNING;
    }
 
    *cid = rc;
    return MUTT_CMD_SUCCESS;
  }
 
  rc = mutt_map_get_value(buf->data, ColorFields);
  if (rc == -1)
  {
    buf_printf(err, _("%s: no such object"), buf->data);
    return MUTT_CMD_WARNING;
  }
  else
  {
    color_debug(LL_DEBUG5, "object: %s\n", mutt_map_get_name(rc, ColorFields));
  }
 
  *cid = rc;
  return MUTT_CMD_SUCCESS;
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parse_uncolor()

static enum CommandResult parse_uncolor	(	struct Buffer *	buf,
		struct Buffer *	s,
		struct Buffer *	err,
		bool	uncolor
	)

static

Parse an 'uncolor' command.

Parameters

buf	Temporary Buffer space
s	Buffer containing string to be parsed
err	Buffer for error messages
uncolor	If true, 'uncolor', else 'unmono'

Return values

CommandResult Result e.g. MUTT_CMD_SUCCESS

Usage:

uncolor index pattern [pattern...]
unmono index pattern [pattern...]

Definition at line 229 of file command.c.

{
  if (OptNoCurses) // No GUI, so quietly discard the command
  {
    while (MoreArgs(s))
    {
      parse_extract_token(buf, s, TOKEN_NO_FLAGS);
    }
    return MUTT_CMD_SUCCESS;
  }
 
  parse_extract_token(buf, s, TOKEN_NO_FLAGS);
 
  if (mutt_str_equal(buf->data, "*"))
  {
    colors_cleanup();
    return MUTT_CMD_SUCCESS;
  }
 
  unsigned int cid = MT_COLOR_NONE;
  int ql = 0;
  color_debug(LL_DEBUG5, "uncolor: %s\n", buf_string(buf));
  enum CommandResult rc = parse_object(buf, s, &cid, &ql, err);
  if (rc != MUTT_CMD_SUCCESS)
    return rc;
 
  if (cid == -1)
  {
    buf_printf(err, _("%s: no such object"), buf->data);
    return MUTT_CMD_ERROR;
  }
 
  if (cid == MT_COLOR_QUOTED)
  {
    color_debug(LL_DEBUG5, "quoted\n");
    return quoted_colors_parse_uncolor(cid, ql, err);
  }
 
  if ((cid == MT_COLOR_STATUS) && !MoreArgs(s))
  {
    color_debug(LL_DEBUG5, "simple\n");
    simple_color_reset(cid); // default colour for the status bar
    return MUTT_CMD_SUCCESS;
  }
 
  if (!mutt_color_has_pattern(cid))
  {
    color_debug(LL_DEBUG5, "simple\n");
    simple_color_reset(cid);
    return MUTT_CMD_SUCCESS;
  }
 
  if (!MoreArgs(s))
  {
    if (regex_colors_parse_uncolor(cid, NULL, uncolor))
      return MUTT_CMD_SUCCESS;
    else
      return MUTT_CMD_ERROR;
  }
 
  do
  {
    parse_extract_token(buf, s, TOKEN_NO_FLAGS);
    if (mutt_str_equal("*", buf->data))
    {
      if (regex_colors_parse_uncolor(cid, NULL, uncolor))
        return MUTT_CMD_SUCCESS;
      else
        return MUTT_CMD_ERROR;
    }
 
    regex_colors_parse_uncolor(cid, buf->data, uncolor);
 
  } while (MoreArgs(s));
 
  return MUTT_CMD_SUCCESS;
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parse_color()

static enum CommandResult parse_color	(	struct Buffer *	buf,
		struct Buffer *	s,
		struct Buffer *	err,
		parser_callback_t	callback,
		bool	color
	)

static

Parse a 'color' command.

Parameters

buf	Temporary Buffer space
s	Buffer containing string to be parsed
err	Buffer for error messages
callback	Function to handle command - Implements parser_callback_t
color	If true "color", else "mono"

Return values

CommandResult Result e.g. MUTT_CMD_SUCCESS

Usage:

color OBJECT [ ATTRS ] FG BG [ REGEX ]
mono OBJECT ATTRS [ REGEX ]

Definition at line 321 of file command.c.

{
  int q_level = 0;
  unsigned int match = 0;
  enum ColorId cid = MT_COLOR_NONE;
  enum CommandResult rc = MUTT_CMD_ERROR;
  struct AttrColor *ac = NULL;
 
  if (!MoreArgs(s))
  {
    if (StartupComplete)
    {
      color_dump();
      rc = MUTT_CMD_SUCCESS;
    }
    else
    {
      buf_printf(err, _("%s: too few arguments"), color ? "color" : "mono");
      rc = MUTT_CMD_WARNING;
    }
 
    goto done;
  }
 
  parse_extract_token(buf, s, TOKEN_NO_FLAGS);
  color_debug(LL_DEBUG5, "color: %s\n", buf_string(buf));
 
  rc = parse_object(buf, s, &cid, &q_level, err);
  if (rc != MUTT_CMD_SUCCESS)
    goto done;
 
  ac = attr_color_new();
  rc = callback(buf, s, ac, err);
  if (rc != MUTT_CMD_SUCCESS)
    goto done;
 
  //------------------------------------------------------------------
  // Business Logic
 
  if ((ac->fg.type == CT_RGB) || (ac->bg.type == CT_RGB))
  {
#ifndef NEOMUTT_DIRECT_COLORS
    buf_printf(err, _("Direct colors support not compiled in: %s"), buf_string(s));
    return MUTT_CMD_ERROR;
#endif
 
    const bool c_color_directcolor = cs_subset_bool(NeoMutt->sub, "color_directcolor");
    if (!c_color_directcolor)
    {
      buf_printf(err, _("Direct colors support disabled: %s"), buf_string(s));
      return MUTT_CMD_ERROR;
    }
  }
 
  if ((ac->fg.color >= COLORS) || (ac->bg.color >= COLORS))
  {
    buf_printf(err, _("%s: color not supported by term"), buf_string(s));
    return MUTT_CMD_ERROR;
  }
 
  //------------------------------------------------------------------
 
  /* extract a regular expression if needed */
 
  if (mutt_color_has_pattern(cid) && (cid != MT_COLOR_STATUS))
  {
    color_debug(LL_DEBUG5, "regex needed\n");
    if (MoreArgs(s))
    {
      parse_extract_token(buf, s, TOKEN_NO_FLAGS);
    }
    else
    {
      buf_strcpy(buf, ".*");
    }
  }
 
  if (MoreArgs(s) && (cid != MT_COLOR_STATUS))
  {
    buf_printf(err, _("%s: too many arguments"), color ? "color" : "mono");
    rc = MUTT_CMD_WARNING;
    goto done;
  }
 
  if (regex_colors_parse_color_list(cid, buf->data, ac, &rc, err))
  {
    color_debug(LL_DEBUG5, "regex_colors_parse_color_list done\n");
    goto done;
    // do nothing
  }
  else if (quoted_colors_parse_color(cid, ac, q_level, &rc, err))
  {
    color_debug(LL_DEBUG5, "quoted_colors_parse_color done\n");
    goto done;
    // do nothing
  }
  else if ((cid == MT_COLOR_STATUS) && MoreArgs(s))
  {
    color_debug(LL_DEBUG5, "status\n");
    /* 'color status fg bg' can have up to 2 arguments:
     * 0 arguments: sets the default status color (handled below by else part)
     * 1 argument : colorize pattern on match
     * 2 arguments: colorize nth submatch of pattern */
    parse_extract_token(buf, s, TOKEN_NO_FLAGS);
 
    if (MoreArgs(s))
    {
      struct Buffer *tmp = buf_pool_get();
      parse_extract_token(tmp, s, TOKEN_NO_FLAGS);
      if (!mutt_str_atoui_full(tmp->data, &match))
      {
        buf_printf(err, _("%s: invalid number: %s"), color ? "color" : "mono", tmp->data);
        buf_pool_release(&tmp);
        rc = MUTT_CMD_WARNING;
        goto done;
      }
      buf_pool_release(&tmp);
    }
 
    if (MoreArgs(s))
    {
      buf_printf(err, _("%s: too many arguments"), color ? "color" : "mono");
      rc = MUTT_CMD_WARNING;
      goto done;
    }
 
    rc = regex_colors_parse_status_list(cid, buf->data, ac, match, err);
    goto done;
  }
  else // Remaining simple colours
  {
    color_debug(LL_DEBUG5, "simple\n");
    if (simple_color_set(cid, ac))
      rc = MUTT_CMD_SUCCESS;
    else
      rc = MUTT_CMD_ERROR;
  }
 
  if (rc == MUTT_CMD_SUCCESS)
  {
    get_colorid_name(cid, buf);
    color_debug(LL_DEBUG5, "NT_COLOR_SET: %s\n", buf->data);
    struct EventColor ev_c = { cid, NULL };
    notify_send(ColorsNotify, NT_COLOR, NT_COLOR_SET, &ev_c);
  }
 
done:
  attr_color_free(&ac);
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

◆ ColorFields

const struct Mapping ColorFields[]

Mapping of colour names to their IDs.

Definition at line 56 of file command.c.

◆ ComposeColorFields

const struct Mapping ComposeColorFields[]

Initial value:

= {
  
  { "header",            MT_COLOR_COMPOSE_HEADER },
  { "security_encrypt",  MT_COLOR_COMPOSE_SECURITY_ENCRYPT },
  { "security_sign",     MT_COLOR_COMPOSE_SECURITY_SIGN },
  { "security_both",     MT_COLOR_COMPOSE_SECURITY_BOTH },
  { "security_none",     MT_COLOR_COMPOSE_SECURITY_NONE },
  { NULL, 0 }
  
}

Mapping of compose colour names to their IDs.

Definition at line 111 of file command.c.

Functions

Variables

Detailed Description

Function Documentation

◆ get_colorid_name()

◆ parse_object()

◆ parse_uncolor()

◆ parse_color()

Variable Documentation

◆ ColorFields

◆ ComposeColorFields