debug.c File Reference

Colour Debugging. More...

#include "config.h"
#include <stdarg.h>
#include <stdbool.h>
#include <stdio.h>
#include "mutt/lib.h"
#include "gui/lib.h"
#include "lib.h"

Include dependency graph for debug.c:

Go to the source code of this file.

Functions
int	color_debug (enum LogLevel level, const char *format,...)
	Write to the log file. More...
const char *	color_debug_log_color_attrs (int fg, int bg, int attrs)
	Get a colourful string to represent a colour in the log. More...
const char *	color_debug_log_color (int fg, int bg)
	Get a colourful string to represent a colour in the log. More...
const char *	color_debug_log_attrs (int attrs)
	Get a string to represent some attributes in the log. More...
const char *	color_debug_log_attrs_list (int attrs)
	Get a string to represent some attributes in the log. More...
const char *	color_debug_log_name (char *buf, int buflen, int color)
	Get a string to represent a colour name. More...
void	attr_color_dump (struct AttrColor *ac, const char *prefix)
	Dump an Attr Colour to the log. More...
void	attr_color_list_dump (struct AttrColorList *acl, const char *title)
	Dump all the Attr Colours to the log. More...
void	curses_color_dump (struct CursesColor *cc, const char *prefix)
	Log one Curses colour. More...
void	curses_colors_dump (void)
	Log all the Curses colours. More...
void	quoted_color_dump (struct AttrColor *ac, int q_level, const char *prefix)
	Log a Quoted colour. More...
void	quoted_color_list_dump (void)
	Log all the Quoted colours. More...
void	regex_color_dump (struct RegexColor *rcol, const char *prefix)
	Dump a Regex colour to the log. More...
void	regex_color_list_dump (const char *name, struct RegexColorList *rcl)
	Dump one Regex's colours to the log. More...
void	regex_colors_dump_all (void)
	Dump all the Regex colours to the log. More...
void	simple_color_dump (enum ColorId cid, const char *prefix)
	Dump a Simple colour to the log. More...
void	simple_colors_dump (bool force)
	Dump all the Simple colours to the log. More...
void	merged_colors_dump (void)
	Dump all the Merged colours to the log. More...

Detailed Description

Colour Debugging.

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

Function Documentation

color_debug()

int color_debug	(	enum LogLevel	level,
		const char *	format,
			...
	)

Write to the log file.

Parameters

level	Logging level, e.g. LL_DEBUG1
format	Printf format string
...	Args for printf

Return values

num	Number of characters printed

Definition at line 44 of file debug.c.

{
  char buf[1024] = { 0 };
 
  va_list ap;
  va_start(ap, format);
  int len = vsnprintf(buf, sizeof(buf), format, ap);
  va_end(ap);
 
  mutt_debug(level, buf);
 
  return len;
}

Here is the caller graph for this function:

color_debug_log_color_attrs()

const char * color_debug_log_color_attrs	(	int	fg,
		int	bg,
		int	attrs
	)

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

Parameters

fg	Foreground colour
bg	Background colour
attrs	Attributes, e.g. A_UNDERLINE

Return values

ptr	Generated string

Note

Do not free the returned string

Definition at line 67 of file debug.c.

{
  static char text[64];
  int pos = 0;
 
  if (attrs & A_BLINK)
    pos += snprintf(text + pos, sizeof(text) - pos, "\033[5m");
  if (attrs & A_BOLD)
    pos += snprintf(text + pos, sizeof(text) - pos, "\033[1m");
  if (attrs & A_NORMAL)
    pos += snprintf(text + pos, sizeof(text) - pos, "\033[0m");
  if (attrs & A_REVERSE)
    pos += snprintf(text + pos, sizeof(text) - pos, "\033[7m");
  if (attrs & A_STANDOUT)
    pos += snprintf(text + pos, sizeof(text) - pos, "\033[1m");
  if (attrs & A_UNDERLINE)
    pos += snprintf(text + pos, sizeof(text) - pos, "\033[4m");
 
  if (fg >= 0)
    pos += snprintf(text + pos, sizeof(text) - pos, "\033[38;5;%dm", fg);
  if (bg >= 0)
    pos += snprintf(text + pos, sizeof(text) - pos, "\033[48;5;%dm", bg);
 
  snprintf(text + pos, sizeof(text) - pos, "XXXXXX\033[0m");
 
  return text;
}

color_debug_log_color()

const char * color_debug_log_color	(	int	fg,
		int	bg
	)

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

Parameters

fg	Foreground colour
bg	Background colour

Return values

ptr	Generated string

Note

Do not free the returned string

Definition at line 103 of file debug.c.

{
  static char text[64];
  snprintf(text, sizeof(text), "\033[38;5;%dm\033[48;5;%dmXXXXXX\033[0m", fg, bg);
  return text;
}

Here is the caller graph for this function:

color_debug_log_attrs()

const char * color_debug_log_attrs

(

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 117 of file debug.c.

{
  static char text[64];
  struct Mapping attr_names[] = {
    { "\033[5mBLI\033[0m", A_BLINK },
    { "\033[1mBLD\033[0m", A_BOLD },
    { "\033[0mNOR\033[0m", A_NORMAL },
    { "\033[7mREV\033[0m", A_REVERSE },
    { "\033[1mSTD\033[0m", A_STANDOUT },
    { "\033[4mUND\033[0m", A_UNDERLINE },
    { NULL, 0 },
  };
 
  int offset = 0;
  text[0] = '\0';
  for (int i = 0; attr_names[i].name; i++)
  {
    if (attrs & attr_names[i].value)
    {
      offset += snprintf(text + offset, sizeof(text) - offset, "%s ",
                         attr_names[i].name);
    }
  }
  return text;
}

Here is the caller graph for this function:

color_debug_log_attrs_list()

const char * color_debug_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 150 of file debug.c.

{
  static char text[64];
 
  text[0] = '\0';
  int pos = 0;
  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_NORMAL)
    pos += snprintf(text + pos, sizeof(text) - pos, "normal ");
  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;
}

color_debug_log_name()

const char * color_debug_log_name	(	char *	buf,
		int	buflen,
		int	color
	)

Get a string to represent a colour name.

Parameters

buf	Buffer for the result
buflen	Length of the Buffer
color	Palette colour number

Return values

ptr	Generated string

Definition at line 181 of file debug.c.

{
  if (color < 0)
    return "default";
 
  if (color < 256)
    snprintf(buf, buflen, "color%d", color);
  else
    snprintf(buf, buflen, "BAD:%d", color);
 
  return buf;
}

attr_color_dump()

void attr_color_dump	(	struct AttrColor *	ac,
		const char *	prefix
	)

Dump an Attr Colour to the log.

Parameters

ac	AttrColor to dump
prefix	prefix for the log block

Definition at line 199 of file debug.c.

{
  if (!ac)
    return;
 
  int index = ac->curses_color ? ac->curses_color->index : -1;
 
  int fg = COLOR_DEFAULT;
  int bg = COLOR_DEFAULT;
  struct CursesColor *cc = ac->curses_color;
  if (cc)
  {
    fg = cc->fg;
    bg = cc->bg;
  }
  const char *color = color_debug_log_color(fg, bg);
  const char *attrs = color_debug_log_attrs(ac->attrs);
  color_debug(LL_DEBUG5, "%s| %5d | %s | 0x%08x | %s\n", NONULL(prefix), index,
              color, ac->attrs, attrs);
}

Here is the call graph for this function:

Here is the caller graph for this function:

attr_color_list_dump()

void attr_color_list_dump	(	struct AttrColorList *	acl,
		const char *	title
	)

Dump all the Attr Colours to the log.

Parameters

acl	List of Attr colours
title	Title for the log block

Definition at line 225 of file debug.c.

{
  if (!acl)
    return;
 
  int count = 0;
  struct AttrColor *ac = NULL;
  TAILQ_FOREACH(ac, acl, entries)
  {
    count++;
  }
 
  color_debug(LL_DEBUG5, "\033[1;32m%s:\033[0m (%d)\n", title, count);
  if (count == 0)
    return;
 
  color_debug(LL_DEBUG5, "    | Index | Colour | Attrs      | Attrs\n");
 
  TAILQ_FOREACH(ac, acl, entries)
  {
    attr_color_dump(ac, "    ");
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

curses_color_dump()

void curses_color_dump	(	struct CursesColor *	cc,
		const char *	prefix
	)

Log one Curses colour.

Parameters

cc	CursesColor to log
prefix	Prefix for the log line

Definition at line 254 of file debug.c.

{
  if (!cc)
    return;
 
  const char *color = color_debug_log_color(cc->fg, cc->bg);
  color_debug(LL_DEBUG5, "%s| %5d | %3d %3d | %s | %2d |\n", NONULL(prefix),
              cc->index, cc->fg, cc->bg, color, cc->ref_count);
}

Here is the call graph for this function:

Here is the caller graph for this function:

curses_colors_dump()

void curses_colors_dump

(

void

)

Log all the Curses colours.

Definition at line 267 of file debug.c.

{
  color_debug(LL_DEBUG5, "\033[1;32mCursesColors:\033[0m (%d)\n", NumCursesColors);
  if (TAILQ_EMPTY(&CursesColors))
    return;
 
  color_debug(LL_DEBUG5, "    | index |  fg  bg | colour | rc |\n");
 
  struct CursesColor *cc = NULL;
  TAILQ_FOREACH(cc, &CursesColors, entries)
  {
    curses_color_dump(cc, "    ");
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

quoted_color_dump()

void quoted_color_dump	(	struct AttrColor *	ac,
		int	q_level,
		const char *	prefix
	)

Log a Quoted colour.

Parameters

ac	Quoted colour
q_level	Quote level
prefix	Prefix for the log line

Definition at line 288 of file debug.c.

{
  if (!ac)
    return;
 
  int index = ac->curses_color ? ac->curses_color->index : -1;
 
  int fg = COLOR_DEFAULT;
  int bg = COLOR_DEFAULT;
  struct CursesColor *cc = ac->curses_color;
  if (cc)
  {
    fg = cc->fg;
    bg = cc->bg;
  }
  const char *color = color_debug_log_color(fg, bg);
  const char *attrs = color_debug_log_attrs(ac->attrs);
  color_debug(LL_DEBUG5, "%s| quoted%d | %5d | %s | 0x%08x | %s\n", prefix,
              q_level, index, color, ac->attrs, attrs);
}

Here is the call graph for this function:

Here is the caller graph for this function:

quoted_color_list_dump()

void quoted_color_list_dump

(

void

)

Log all the Quoted colours.

Definition at line 312 of file debug.c.

{
  color_debug(LL_DEBUG5, "\033[1;32mQuotedColors:\033[0m (%d)\n", NumQuotedColors);
  color_debug(LL_DEBUG5, "    | Name    | Index | Colour | Attrs      | Attrs\n");
  for (size_t i = 0; i < COLOR_QUOTES_MAX; i++)
  {
    quoted_color_dump(&QuotedColors[i], i, "    ");
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

regex_color_dump()

void regex_color_dump	(	struct RegexColor *	rcol,
		const char *	prefix
	)

Dump a Regex colour to the log.

Parameters

rcol	Regex to dump
prefix	Prefix for the log line

Definition at line 327 of file debug.c.

{
  if (!rcol)
    return;
 
  struct AttrColor *ac = &rcol->attr_color;
  int index = ac->curses_color ? ac->curses_color->index : -1;
 
  int fg = COLOR_DEFAULT;
  int bg = COLOR_DEFAULT;
  struct CursesColor *cc = ac->curses_color;
  if (cc)
  {
    fg = cc->fg;
    bg = cc->bg;
  }
  const char *color = color_debug_log_color(fg, bg);
  const char *attrs = color_debug_log_attrs(ac->attrs);
  color_debug(LL_DEBUG5, "%s| %5d | %s | 0x%08x | %-8s | %s\n", NONULL(prefix),
              index, color, ac->attrs, attrs, rcol->pattern);
}

Here is the call graph for this function:

Here is the caller graph for this function:

regex_color_list_dump()

void regex_color_list_dump	(	const char *	name,
		struct RegexColorList *	rcl
	)

Dump one Regex's colours to the log.

Parameters

name	Name of the Regex
rcl	RegexColorList to dump

Definition at line 354 of file debug.c.

{
  if (!name || !rcl)
    return;
 
  int count = 0;
  struct RegexColor *rcol = NULL;
  STAILQ_FOREACH(rcol, rcl, entries)
  {
    count++;
  }
 
  color_debug(LL_DEBUG5, "\033[1;32mRegexColorList %s\033[0m (%d)\n", name, count);
  if (count == 0)
    return;
 
  color_debug(LL_DEBUG5, "    | Index | Colour | Attrs      | Attrs    | Pattern\n");
  STAILQ_FOREACH(rcol, rcl, entries)
  {
    regex_color_dump(rcol, "    ");
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

regex_colors_dump_all()

void regex_colors_dump_all

(

void

)

Dump all the Regex colours to the log.

Definition at line 380 of file debug.c.

{
  regex_color_list_dump("AttachList", &AttachList);
  regex_color_list_dump("BodyList", &BodyList);
  regex_color_list_dump("HeaderList", &HeaderList);
  regex_color_list_dump("IndexAuthorList", &IndexAuthorList);
  regex_color_list_dump("IndexCollapsedList", &IndexCollapsedList);
  regex_color_list_dump("IndexDateList", &IndexDateList);
  regex_color_list_dump("IndexFlagsList", &IndexFlagsList);
  regex_color_list_dump("IndexLabelList", &IndexLabelList);
  regex_color_list_dump("IndexList", &IndexList);
  regex_color_list_dump("IndexNumberList", &IndexNumberList);
  regex_color_list_dump("IndexSizeList", &IndexSizeList);
  regex_color_list_dump("IndexSubjectList", &IndexSubjectList);
  regex_color_list_dump("IndexTagList", &IndexTagList);
  regex_color_list_dump("IndexTagsList", &IndexTagsList);
  regex_color_list_dump("StatusList", &StatusList);
}

Here is the call graph for this function:

Here is the caller graph for this function:

simple_color_dump()

void simple_color_dump	(	enum ColorId	cid,
		const char *	prefix
	)

Dump a Simple colour to the log.

Parameters

cid	Colour Id, e.g. MT_COLOR_UNDERLINE
prefix	Prefix for the log line

Definition at line 404 of file debug.c.

{
  struct AttrColor *ac = &SimpleColors[cid];
  int index = ac->curses_color ? ac->curses_color->index : -1;
  const char *name = NULL;
  const char *compose = "";
 
  name = mutt_map_get_name(cid, ColorFields);
  if (!name)
  {
    name = mutt_map_get_name(cid, ComposeColorFields);
    if (name)
    {
      compose = "compose ";
    }
  }
 
  int fg = COLOR_DEFAULT;
  int bg = COLOR_DEFAULT;
  struct CursesColor *cc = ac->curses_color;
  if (cc)
  {
    fg = cc->fg;
    bg = cc->bg;
  }
  const char *color_str = color_debug_log_color(fg, bg);
  const char *attrs_str = color_debug_log_attrs(ac->attrs);
  color_debug(LL_DEBUG5, "%s| %s%-17s | %5d | %s | 0x%08x | %s\n", prefix,
              compose, name, index, color_str, ac->attrs, attrs_str);
}

Here is the call graph for this function:

Here is the caller graph for this function:

simple_colors_dump()

void simple_colors_dump

(

bool

force

)

Dump all the Simple colours to the log.

Parameters

force

If true, list unset colours

Definition at line 439 of file debug.c.

{
  color_debug(LL_DEBUG5, "\033[1;32mSimpleColors:\033[0m\n");
  color_debug(LL_DEBUG5, "    | Name              | Index | Colour | Attrs      | Attrs\n");
  for (enum ColorId cid = MT_COLOR_NONE; cid < MT_COLOR_MAX; cid++)
  {
    struct AttrColor *ac = &SimpleColors[cid];
    if (!force && !attr_color_is_set(ac))
      continue;
 
    simple_color_dump(cid, "    ");
  }
}

Here is the call graph for this function:

merged_colors_dump()

void merged_colors_dump

(

void

)

Dump all the Merged colours to the log.

Definition at line 456 of file debug.c.

{
  attr_color_list_dump(&MergedColors, "MergedColors");
}

Here is the call graph for this function:

Here is the caller graph for this function: