debug.h File Reference

Colour Debugging. More...

#include "config.h"
#include <stdbool.h>
#include "mutt/lib.h"
#include "color.h"

Include dependency graph for debug.h:

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

Go to the source code of this file.

Functions
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_name (char *buf, int buflen, int color)
	Get a string to represent a colour name. More...
const char *	color_debug_log_attrs_list (int attrs)
	Get a string to represent some attributes in the log. More...
static const char *	color_debug_log_attrs (int attrs)
static const char *	color_debug_log_color (int fg, int bg)
static void	attr_color_dump (struct AttrColor *ac, const char *prefix)
static void	attr_color_list_dump (struct AttrColorList *acl, const char *title)
static void	curses_color_dump (struct CursesColor *cc, const char *prefix)
static void	curses_colors_dump (void)
static void	merged_colors_dump (void)
static void	quoted_color_dump (struct AttrColor *ac, int q_level, const char *prefix)
static void	quoted_color_list_dump (void)
static void	regex_color_dump (struct RegexColor *rcol, const char *prefix)
static void	regex_color_list_dump (const char *name, struct RegexColorList *rcl)
static void	regex_colors_dump_all (void)
static void	simple_color_dump (enum ColorId cid, const char *prefix)
static void	simple_colors_dump (bool force)
static int	color_debug (enum LogLevel level, const char *format,...)

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

Function Documentation

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_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;
}

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_attrs()

static const char * color_debug_log_attrs ( int  attrs )

inlinestatic

Definition at line 67 of file debug.h.

{ return ""; }

color_debug_log_color()

static const char * color_debug_log_color ( int  fg, int  bg  )

inlinestatic

Definition at line 68 of file debug.h.

{ return ""; }

attr_color_dump()

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

inlinestatic

Definition at line 70 of file debug.h.

{}

attr_color_list_dump()

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

inlinestatic

Definition at line 71 of file debug.h.

{}

curses_color_dump()

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

inlinestatic

Definition at line 73 of file debug.h.

{}

curses_colors_dump()

static void curses_colors_dump ( void  )

inlinestatic

Definition at line 74 of file debug.h.

{}

merged_colors_dump()

static void merged_colors_dump ( void  )

inlinestatic

Definition at line 76 of file debug.h.

{}

quoted_color_dump()

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

inlinestatic

Definition at line 78 of file debug.h.

{}

quoted_color_list_dump()

static void quoted_color_list_dump ( void  )

inlinestatic

Definition at line 79 of file debug.h.

{}

regex_color_dump()

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

inlinestatic

Definition at line 81 of file debug.h.

{}

regex_color_list_dump()

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

inlinestatic

Definition at line 82 of file debug.h.

{}

regex_colors_dump_all()

static void regex_colors_dump_all ( void  )

inlinestatic

Definition at line 83 of file debug.h.

{}

simple_color_dump()

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

inlinestatic

Definition at line 85 of file debug.h.

{}

simple_colors_dump()

static void simple_colors_dump ( bool  force )

inlinestatic

Definition at line 86 of file debug.h.

{}

color_debug()

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

inlinestatic

Definition at line 88 of file debug.h.

{ return 0; }