curses2.h File Reference

Curses Colour. More...

#include "config.h"
#include <stdint.h>
#include "mutt/lib.h"

Include dependency graph for curses2.h:

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

Go to the source code of this file.

Data Structures
struct	CursesColor
	Colour in the ncurses palette. More...

Typedefs
typedef int32_t	color_t
	Type for 24-bit colour value.

Functions
	TAILQ_HEAD (CursesColorList, CursesColor)
void	curses_color_free (struct CursesColor **ptr)
	Free a CursesColor.
struct CursesColor *	curses_color_new (color_t fg, color_t bg)
	Create a new CursesColor.
void	curses_colors_init (void)
	Initialise the Curses colours.
struct CursesColor *	curses_colors_find (color_t fg, color_t bg)
	Find a Curses colour by foreground/background.

Detailed Description

Curses Colour.

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

Typedef Documentation

color_t

typedef int32_t color_t

Type for 24-bit colour value.

Definition at line 31 of file curses2.h.

Function Documentation

TAILQ_HEAD()

TAILQ_HEAD	(	CursesColorList	,
		CursesColor
	)

curses_color_free()

void curses_color_free

(

struct CursesColor **

ptr

)

Free a CursesColor.

Parameters

ptr	CursesColor to be freed

Definition at line 120 of file curses.c.

{
  if (!ptr || !*ptr)
    return;
 
  struct CursesColor *cc = *ptr;
 
  cc->ref_count--;
  if (cc->ref_count > 0)
  {
    curses_color_dump(cc, "curses rc--");
    *ptr = NULL;
    return;
  }
 
  curses_color_dump(cc, "curses free");
  TAILQ_REMOVE(&CursesColors, cc, entries);
  NumCursesColors--;
  color_debug(LL_DEBUG5, "CursesColors: %d\n", NumCursesColors);
  FREE(ptr);
}

Here is the call graph for this function:

Here is the caller graph for this function:

curses_color_new()

struct CursesColor * curses_color_new	(	color_t	fg,
		color_t	bg
	)

Create a new CursesColor.

Parameters

fg	Foreground colour
bg	Background colour

Return values

ptr	New CursesColor

If the colour already exists, this function will return a pointer to the object (and increase its ref-count).

Definition at line 151 of file curses.c.

{
  color_debug(LL_DEBUG5, "fg %d, bg %d\n", fg, bg);
  if ((fg == COLOR_DEFAULT) && (bg == COLOR_DEFAULT))
  {
    color_debug(LL_DEBUG5, "both unset\n");
    return NULL;
  }
 
  struct CursesColor *cc = curses_colors_find(fg, bg);
  if (cc)
  {
    cc->ref_count++;
    curses_color_dump(cc, "curses rc++");
    return cc;
  }
 
  color_debug(LL_DEBUG5, "new curses\n");
  int index = curses_color_init(fg, bg);
  if (index == 0)
    return NULL;
 
  struct CursesColor *cc_new = MUTT_MEM_CALLOC(1, struct CursesColor);
  NumCursesColors++;
  color_debug(LL_DEBUG5, "CursesColor %p\n", (void *) cc_new);
  cc_new->fg = fg;
  cc_new->bg = bg;
  cc_new->ref_count = 1;
  cc_new->index = index;
 
  // insert curses colour
  TAILQ_FOREACH(cc, &CursesColors, entries)
  {
    if (cc->index > index)
    {
      color_debug(LL_DEBUG5, "insert\n");
      TAILQ_INSERT_BEFORE(cc, cc_new, entries);
      goto done;
    }
  }
 
  TAILQ_INSERT_TAIL(&CursesColors, cc_new, entries);
  color_debug(LL_DEBUG5, "tail\n");
 
done:
  curses_color_dump(cc_new, "curses new");
  color_debug(LL_DEBUG5, "CursesColors: %d\n", NumCursesColors);
  return cc_new;
}

Here is the call graph for this function:

Here is the caller graph for this function:

curses_colors_init()

void curses_colors_init

(

void

)

Initialise the Curses colours.

Definition at line 44 of file curses.c.

{
  color_debug(LL_DEBUG5, "init CursesColors\n");
  TAILQ_INIT(&CursesColors);
  NumCursesColors = 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

curses_colors_find()

struct CursesColor * curses_colors_find	(	color_t	fg,
		color_t	bg
	)

Find a Curses colour by foreground/background.

Parameters

fg	Foreground colour
bg	Background colour

Return values

ptr	Curses colour

Definition at line 57 of file curses.c.

{
  struct CursesColor *cc = NULL;
  TAILQ_FOREACH(cc, &CursesColors, entries)
  {
    if ((cc->fg == fg) && (cc->bg == bg))
    {
      curses_color_dump(cc, "find");
      return cc;
    }
  }
 
  return NULL;
}

Here is the call graph for this function:

Here is the caller graph for this function: