simple.c File Reference

Simple colour. More...

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

Include dependency graph for simple.c:

Go to the source code of this file.

Functions
void	simple_colors_init (void)
	Initialise the simple colour definitions. More...
void	simple_colors_clear (void)
	Reset the simple colour definitions. More...
struct AttrColor *	simple_color_get (enum ColorId cid)
	Get the colour of an object by its ID. More...
bool	simple_color_is_set (enum ColorId cid)
	Is the object coloured? More...
bool	simple_color_is_header (enum ColorId cid)
	Colour is for an Email header. More...
struct AttrColor *	simple_color_set (enum ColorId cid, int fg, int bg, int attrs)
	Set the colour of a simple object. More...
void	simple_color_reset (enum ColorId cid)
	Clear the colour of a simple object. More...

Variables
struct AttrColor	SimpleColors [MT_COLOR_MAX]
	Array of Simple colours. More...

Detailed Description

Simple 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 simple.c.

Function Documentation

simple_colors_init()

void simple_colors_init

(

void

)

Initialise the simple colour definitions.

Definition at line 42 of file simple.c.

{
  // Set some defaults
  color_debug(LL_DEBUG5, "init indicator, markers, etc\n");
  SimpleColors[MT_COLOR_INDICATOR].attrs = A_REVERSE;
  SimpleColors[MT_COLOR_MARKERS].attrs = A_REVERSE;
  SimpleColors[MT_COLOR_SEARCH].attrs = A_REVERSE;
#ifdef USE_SIDEBAR
  SimpleColors[MT_COLOR_SIDEBAR_HIGHLIGHT].attrs = A_UNDERLINE;
#endif
  SimpleColors[MT_COLOR_STATUS].attrs = A_REVERSE;
}

Here is the call graph for this function:

Here is the caller graph for this function:

simple_colors_clear()

void simple_colors_clear

(

void

)

Reset the simple colour definitions.

Definition at line 58 of file simple.c.

{
  color_debug(LL_DEBUG5, "clean up defs\n");
  for (size_t i = 0; i < MT_COLOR_MAX; i++)
  {
    attr_color_clear(&SimpleColors[i]);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

simple_color_get()

struct AttrColor * simple_color_get

(

enum ColorId

cid

)

Get the colour of an object by its ID.

Parameters

cid	Colour Id, e.g. MT_COLOR_SEARCH

Return values

ptr	AttrColor of the object

Note

Do not free the returned object

Definition at line 74 of file simple.c.

{
  if (cid >= MT_COLOR_MAX)
  {
    mutt_error("colour overflow %d", cid);
    return NULL;
  }
  if (cid <= MT_COLOR_NONE)
  {
    mutt_error("colour underflow %d", cid);
    return NULL;
  }
 
  return &SimpleColors[cid];
}

Here is the caller graph for this function:

simple_color_is_set()

bool simple_color_is_set

(

enum ColorId

cid

)

Is the object coloured?

Parameters

cid	Colour Id, e.g. MT_COLOR_SEARCH

Return values

true	Yes, a 'color' command has been used on this object

Definition at line 95 of file simple.c.

{
  return attr_color_is_set(simple_color_get(cid));
}

Here is the call graph for this function:

Here is the caller graph for this function:

simple_color_is_header()

bool simple_color_is_header

(

enum ColorId

cid

)

Colour is for an Email header.

Parameters

cid	Colour Id, e.g. MT_COLOR_HEADER

Return values

true	Colour is for an Email header

Definition at line 105 of file simple.c.

{
  return (cid == MT_COLOR_HEADER) || (cid == MT_COLOR_HDRDEFAULT);
}

Here is the caller graph for this function:

simple_color_set()

struct AttrColor * simple_color_set	(	enum ColorId	cid,
		int	fg,
		int	bg,
		int	attrs
	)

Set the colour of a simple object.

Parameters

cid	Colour Id, e.g. MT_COLOR_SEARCH
fg	Foreground colour
bg	Background colour
attrs	Attributes, e.g. A_UNDERLINE

Return values

ptr

Colour

Definition at line 118 of file simple.c.

{
  struct AttrColor *ac = simple_color_get(cid);
  if (!ac)
    return NULL;
 
  struct CursesColor *cc = curses_color_new(fg, bg);
  curses_color_free(&ac->curses_color);
  ac->curses_color = cc;
  ac->attrs = attrs;
 
  struct Buffer *buf = mutt_buffer_pool_get();
  get_colorid_name(cid, buf);
  color_debug(LL_DEBUG5, "NT_COLOR_SET: %s\n", buf->data);
  mutt_buffer_pool_release(&buf);
 
  struct EventColor ev_c = { cid, NULL };
  notify_send(ColorsNotify, NT_COLOR, NT_COLOR_SET, &ev_c);
 
  return ac;
}

Here is the call graph for this function:

Here is the caller graph for this function:

simple_color_reset()

void simple_color_reset

(

enum ColorId

cid

)

Clear the colour of a simple object.

Parameters

cid	Colour Id, e.g. MT_COLOR_SEARCH

Definition at line 144 of file simple.c.

{
  struct AttrColor *ac = simple_color_get(cid);
  if (!ac)
    return;
 
  struct Buffer *buf = mutt_buffer_pool_get();
  get_colorid_name(cid, buf);
  color_debug(LL_DEBUG5, "NT_COLOR_RESET: %s\n", buf->data);
  mutt_buffer_pool_release(&buf);
 
  attr_color_clear(ac);
 
  struct EventColor ev_c = { cid, ac };
  notify_send(ColorsNotify, NT_COLOR, NT_COLOR_RESET, &ev_c);
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

SimpleColors

struct AttrColor SimpleColors[MT_COLOR_MAX]

Array of Simple colours.

Definition at line 37 of file simple.c.