dump.h File Reference

Colour Dump Command. More...

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

Go to the source code of this file.

Functions
void	color_dump (void)
	Display all the colours in the Pager.
const char *	color_log_attrs_list (int attrs)
	Get a string to represent some attributes in the log.
void	color_log_color_attrs (struct AttrColor *ac, struct Buffer *swatch)
	Get a colourful string to represent a colour in the log.
const char *	color_log_name (char *buf, int buflen, struct ColorElement *elem)
	Get a string to represent a colour name.

Detailed Description

Colour Dump Command.

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 dump.h.

Function Documentation

color_dump()

void color_dump

(

void

)

Display all the colours in the Pager.

Definition at line 451 of file dump.c.

{
  struct Buffer *tempfile = buf_pool_get();
 
  buf_mktemp(tempfile);
  FILE *fp = mutt_file_fopen(buf_string(tempfile), "w");
  if (!fp)
  {
    // LCOV_EXCL_START
    // L10N: '%s' is the file name of the temporary file
    mutt_error(_("Could not create temporary file %s"), buf_string(tempfile));
    buf_pool_release(&tempfile);
    return;
    // LCOV_EXCL_STOP
  }
 
  struct Buffer *buf = buf_pool_get();
 
  simple_colors_dump(buf);
  quoted_colors_dump(buf);
  status_colors_dump(buf);
  regex_colors_dump(buf);
 
#ifdef USE_DEBUG_COLOR
  merged_colors_dump(buf);
  ansi_colors_dump(buf);
  curses_colors_dump(buf);
  log_multiline(LL_DEBUG1, buf_string(buf));
#endif
 
  mutt_file_save_str(fp, buf_string(buf));
  buf_pool_release(&buf);
  mutt_file_fclose(&fp);
 
  struct PagerData pdata = { 0 };
  struct PagerView pview = { &pdata };
 
  pdata.fname = buf_string(tempfile);
 
  pview.banner = "color";
  pview.flags = MUTT_SHOWCOLOR;
  pview.mode = PAGER_MODE_OTHER;
 
  mutt_do_pager(&pview, NULL);
  buf_pool_release(&tempfile);
}

Here is the call graph for this function:

Here is the caller graph for this function:

color_log_attrs_list()

const char * color_log_attrs_list

(

int

attrs

)

Get a string to represent some attributes in the log.

Parameters

attrs

Attributes, e.g. A_UNDERLINE

Return values

ptr	Generated string

Note

Do not free the returned string

Definition at line 135 of file dump.c.

{
  static char text[64];
 
  text[0] = '\0';
  int pos = 0;
  // We can ignore the A_NORMAL case
  if (attrs & A_BLINK)
    pos += snprintf(text + pos, sizeof(text) - pos, "blink ");
  if (attrs & A_BOLD)
    pos += snprintf(text + pos, sizeof(text) - pos, "bold ");
  if (attrs & A_ITALIC)
    pos += snprintf(text + pos, sizeof(text) - pos, "italic ");
  if (attrs & A_REVERSE)
    pos += snprintf(text + pos, sizeof(text) - pos, "reverse ");
  if (attrs & A_STANDOUT)
    pos += snprintf(text + pos, sizeof(text) - pos, "standout ");
  if (attrs & A_UNDERLINE)
    pos += snprintf(text + pos, sizeof(text) - pos, "underline ");
 
  return text;
}

Here is the caller graph for this function:

color_log_color_attrs()

void color_log_color_attrs	(	struct AttrColor *	ac,
		struct Buffer *	swatch
	)

Get a colourful string to represent a colour in the log.

Parameters

ac	Colour
swatch	Buffer for swatch

Note

Do not free the returned string

Definition at line 52 of file dump.c.

{
  buf_reset(swatch);
 
  if (ac->attrs & A_BLINK)
    buf_add_printf(swatch, "\033[5m");
  if (ac->attrs & A_BOLD)
    buf_add_printf(swatch, "\033[1m");
  if (ac->attrs & A_ITALIC)
    buf_add_printf(swatch, "\033[3m");
  if (ac->attrs == A_NORMAL)
    buf_add_printf(swatch, "\033[0m");
  if (ac->attrs & A_REVERSE)
    buf_add_printf(swatch, "\033[7m");
  if (ac->attrs & A_STANDOUT)
    buf_add_printf(swatch, "\033[1m");
  if (ac->attrs & A_UNDERLINE)
    buf_add_printf(swatch, "\033[4m");
 
  if (ac->fg.color >= 0)
  {
    switch (ac->fg.type)
    {
      case CT_SIMPLE:
      {
        buf_add_printf(swatch, "\033[%dm", 30 + ac->fg.color);
        break;
      }
 
      case CT_PALETTE:
      {
        buf_add_printf(swatch, "\033[38;5;%dm", ac->fg.color);
        break;
      }
 
      case CT_RGB:
      {
        int r = (ac->fg.color >> 16) & 0xff;
        int g = (ac->fg.color >> 8) & 0xff;
        int b = (ac->fg.color >> 0) & 0xff;
        buf_add_printf(swatch, "\033[38;2;%d;%d;%dm", r, g, b);
        break;
      }
    }
  }
 
  if (ac->bg.color >= 0)
  {
    switch (ac->bg.type)
    {
      case CT_SIMPLE:
      {
        buf_add_printf(swatch, "\033[%dm", 40 + ac->bg.color);
        break;
      }
 
      case CT_PALETTE:
      {
        buf_add_printf(swatch, "\033[48;5;%dm", ac->bg.color);
        break;
      }
 
      case CT_RGB:
      {
        int r = (ac->bg.color >> 16) & 0xff;
        int g = (ac->bg.color >> 8) & 0xff;
        int b = (ac->bg.color >> 0) & 0xff;
        buf_add_printf(swatch, "\033[48;2;%d;%d;%dm", r, g, b);
        break;
      }
    }
  }
 
  buf_addstr(swatch, "XXXXXX\033[0m");
}

Here is the call graph for this function:

Here is the caller graph for this function:

color_log_name()

const char * color_log_name	(	char *	buf,
		int	buflen,
		struct ColorElement *	elem
	)

Get a string to represent a colour name.

Parameters

buf	Buffer for the result
buflen	Length of the Buffer
elem	Colour to use

Return values

ptr	Generated string

Definition at line 165 of file dump.c.

{
  if (elem->color < 0)
    return "default";
 
  switch (elem->type)
  {
    case CT_SIMPLE:
    {
      const char *prefix = NULL;
      switch (elem->prefix)
      {
        case COLOR_PREFIX_ALERT:
          prefix = "alert";
          break;
        case COLOR_PREFIX_BRIGHT:
          prefix = "bright";
          break;
        case COLOR_PREFIX_LIGHT:
          prefix = "light";
          break;
        default:
          prefix = "";
          break;
      }
 
      const char *name = mutt_map_get_name(elem->color, ColorNames);
      snprintf(buf, buflen, "%s%s", prefix, name);
      break;
    }
 
    case CT_PALETTE:
    {
      if (elem->color < 256)
        snprintf(buf, buflen, "color%d", elem->color);
      else
        snprintf(buf, buflen, "BAD:%d", elem->color); // LCOV_EXCL_LINE
      break;
    }
 
    case CT_RGB:
    {
      int r = (elem->color >> 16) & 0xff;
      int g = (elem->color >> 8) & 0xff;
      int b = (elem->color >> 0) & 0xff;
      snprintf(buf, buflen, "#%02x%02x%02x", r, g, b);
      break;
    }
  }
 
  return buf;
}

Here is the call graph for this function:

Here is the caller graph for this function: