simple2.h File Reference

Simple colour. More...

#include "config.h"
#include <stdbool.h>
#include "color.h"

Include dependency graph for simple2.h:

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

Go to the source code of this file.

Macros
#define	COLOR_COMPOSE(cid)

Functions
void	simple_colors_init (void)
	Initialise the simple colour definitions.
void	simple_colors_reset (void)
	Reset the simple colour definitions.
void	simple_colors_cleanup (void)
	Cleanup the simple colour definitions.
struct AttrColor *	simple_color_get (enum ColorId cid)
	Get the colour of an object by its ID.
bool	simple_color_is_set (enum ColorId cid)
	Is the object coloured?
void	simple_color_reset (enum ColorId cid)
	Clear the colour of a simple object.
struct AttrColor *	simple_color_set (enum ColorId cid, struct AttrColor *ac_val)
	Set the colour of a simple object.

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

Macro Definition Documentation

COLOR_COMPOSE

#define COLOR_COMPOSE

(

cid

)

Value:

(((cid) >= MT_COLOR_COMPOSE_HEADER) && ((cid) <= MT_COLOR_COMPOSE_SECURITY_SIGN))

Definition at line 32 of file simple2.h.

Function Documentation

simple_colors_init()

void simple_colors_init

(

void

)

Initialise the simple colour definitions.

Definition at line 47 of file simple.c.

{
  for (int i = 0; i < MT_COLOR_MAX; i++)
  {
    SimpleColors[i].fg.color = COLOR_DEFAULT;
    SimpleColors[i].bg.color = COLOR_DEFAULT;
  }
 
  // Set some defaults
  color_debug(LL_DEBUG5, "init indicator, markers, etc\n");
  SimpleColors[MT_COLOR_BOLD].attrs = A_BOLD;
  SimpleColors[MT_COLOR_INDICATOR].attrs = A_REVERSE;
  SimpleColors[MT_COLOR_ITALIC].attrs = A_ITALIC;
  SimpleColors[MT_COLOR_MARKERS].attrs = A_REVERSE;
  SimpleColors[MT_COLOR_SEARCH].attrs = A_REVERSE;
  SimpleColors[MT_COLOR_STATUS].attrs = A_REVERSE;
  SimpleColors[MT_COLOR_STRIPE_EVEN].attrs = A_BOLD;
  SimpleColors[MT_COLOR_UNDERLINE].attrs = A_UNDERLINE;
}

Here is the call graph for this function:

Here is the caller graph for this function:

simple_colors_reset()

void simple_colors_reset

(

void

)

Reset the simple colour definitions.

Definition at line 70 of file simple.c.

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

Here is the call graph for this function:

Here is the caller graph for this function:

simple_colors_cleanup()

void simple_colors_cleanup

(

void

)

Cleanup the simple colour definitions.

Definition at line 83 of file simple.c.

{
  simple_colors_reset();
}

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 95 of file simple.c.

{
  if (cid >= MT_COLOR_MAX)
  {
    mutt_debug(LL_DEBUG1, "color overflow %d/%d\n", cid, MT_COLOR_MAX);
    return NULL;
  }
  if (cid <= MT_COLOR_NONE)
  {
    mutt_debug(LL_DEBUG1, "color underflow %d/%d\n", cid, MT_COLOR_NONE);
    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 116 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_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 150 of file simple.c.

{
  struct AttrColor *ac = simple_color_get(cid);
  if (!ac)
    return;
 
  struct Buffer *buf = buf_pool_get();
  get_colorid_name(cid, buf);
  color_debug(LL_DEBUG5, "NT_COLOR_RESET: %s\n", buf_string(buf));
  buf_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:

simple_color_set()

struct AttrColor * simple_color_set	(	enum ColorId	cid,
		struct AttrColor *	ac_val )

Set the colour of a simple object.

Parameters

cid	Colour ID, e.g. MT_COLOR_SEARCH
ac_val	Colour value to use

Return values

ptr

Colour

Definition at line 127 of file simple.c.

{
  struct AttrColor *ac = simple_color_get(cid);
  if (!ac)
    return NULL;
 
  attr_color_overwrite(ac, ac_val);
 
  struct Buffer *buf = buf_pool_get();
  get_colorid_name(cid, buf);
  color_debug(LL_DEBUG5, "NT_COLOR_SET: %s\n", buf_string(buf));
  buf_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: