ANSI colour definitions. More...

#include <stdio.h>
#include <errno.h>
#include <ipxe/ansiesc.h>
#include <ipxe/ansicol.h>
#include <config/colour.h>

Macros
#define	ANSICOL_DEFINE(basic, rgb) ( ( (basic) << 28 ) \| (rgb) )
	Construct ANSI colour definition. More...

#define	ANSICOL_BASIC(ansicol) ( (ansicol) >> 28 )
	Extract basic colour from ANSI colour definition. More...

#define	ANSICOL_RGB(ansicol) ( ( (ansicol) >> 0 ) & 0xffffffUL )
	Extract 24-bit RGB value from ANSI colour definition. More...

#define	ANSICOL_RED(ansicol) ( ( (ansicol) >> 16 ) & 0xff )
	Extract 24-bit RGB value red component from ANSI colour definition. More...

#define	ANSICOL_GREEN(ansicol) ( ( (ansicol) >> 8 ) & 0xff )
	Extract 24-bit RGB value green component from ANSI colour definition. More...

#define	ANSICOL_BLUE(ansicol) ( ( (ansicol) >> 0 ) & 0xff )
	Extract 24-bit RGB value blue component from ANSI colour definition. More...

#define	ANSICOL_DEFAULT(basic)
	Construct default ANSI colour definition. More...

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)

int	ansicol_define (unsigned int colour, unsigned int basic, uint32_t rgb)
	Define ANSI colour. More...

void	ansicol_set (unsigned int colour, unsigned int which)
	Set ANSI colour (using colour definitions) More...

void	ansicol_reset_magic (void)
	Reset magic colour. More...

void	ansicol_set_magic_transparent (void)
	Set magic colour to transparent. More...

Variables
static uint32_t	ansicols []
	ANSI colour definitions. More...

static uint8_t	ansicol_magic = COLOR_NORMAL_BG
	Magic basic colour. More...

Detailed Description

ANSI colour definitions.

Definition in file ansicoldef.c.

Macro Definition Documentation

◆ ANSICOL_DEFINE

#define ANSICOL_DEFINE	(	basic,
		rgb
	)	( ( (basic) << 28 ) \| (rgb) )

Construct ANSI colour definition.

Parameters

basic	Basic colour
rgb	24-bit RGB value (or ANSICOL_NO_RGB)

Return values

ansicol ANSI colour definition

Definition at line 45 of file ansicoldef.c.

◆ ANSICOL_BASIC

#define ANSICOL_BASIC ( ansicol ) ( (ansicol) >> 28 )

Extract basic colour from ANSI colour definition.

Parameters

ansicol ANSI colour definition

Return values

basic Basic colour

Definition at line 53 of file ansicoldef.c.

◆ ANSICOL_RGB

#define ANSICOL_RGB ( ansicol ) ( ( (ansicol) >> 0 ) & 0xffffffUL )

Extract 24-bit RGB value from ANSI colour definition.

Parameters

ansicol ANSI colour definition

Return values

rgb	24-bit RGB value

Definition at line 61 of file ansicoldef.c.

◆ ANSICOL_RED

#define ANSICOL_RED ( ansicol ) ( ( (ansicol) >> 16 ) & 0xff )

Extract 24-bit RGB value red component from ANSI colour definition.

Parameters

ansicol ANSI colour definition

Return values

red	Red component

Definition at line 69 of file ansicoldef.c.

◆ ANSICOL_GREEN

#define ANSICOL_GREEN ( ansicol ) ( ( (ansicol) >> 8 ) & 0xff )

Extract 24-bit RGB value green component from ANSI colour definition.

Parameters

ansicol ANSI colour definition

Return values

green Green component

Definition at line 77 of file ansicoldef.c.

◆ ANSICOL_BLUE

#define ANSICOL_BLUE ( ansicol ) ( ( (ansicol) >> 0 ) & 0xff )

Extract 24-bit RGB value blue component from ANSI colour definition.

Parameters

ansicol ANSI colour definition

Return values

blue	Blue component

Definition at line 85 of file ansicoldef.c.

◆ ANSICOL_DEFAULT

#define ANSICOL_DEFAULT ( basic )

Value:

ANSICOL_DEFINE ( ( ( (basic) == COLOR_NORMAL_BG ) ?             \
                           ANSICOL_MAGIC : (basic) ),                   \
                         ANSICOL_NO_RGB )

Construct default ANSI colour definition.

Parameters

basic Basic colour

Return values

ansicol ANSI colour definition

Colours default to being just a basic colour. If the colour matches the normal UI text background colour, then its basic colour value is set to ANSICOL_MAGIC.

Definition at line 97 of file ansicoldef.c.

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL )

◆ ansicol_define()

int ansicol_define	(	unsigned int	colour,
		unsigned int	basic,
		uint32_t	rgb
	)

Define ANSI colour.

Parameters

colour	Colour index
basic	Basic colour
rgb	24-bit RGB value (or ANSICOL_NO_RGB)

Return values

rc	Return status code

Definition at line 125 of file ansicoldef.c.

                                                                              {
         uint32_t ansicol;
 
         /* Fail if colour index is out of range */
         if ( colour >= ( sizeof ( ansicols ) / sizeof ( ansicols[0] ) ) )
                 return -EINVAL;
 
         /* Update colour definition */
         ansicol = ANSICOL_DEFINE ( basic, rgb );
         ansicols[colour] = ansicol;
         DBGC ( &ansicols[0], "ANSICOL redefined colour %d as basic %d RGB "
                "%#06lx%s\n", colour, ANSICOL_BASIC ( ansicol ),
                ANSICOL_RGB ( ansicol ),
                ( ( ansicol & ANSICOL_NO_RGB ) ? " [norgb]" : "" ) );
 
         return 0;
 }

References ANSICOL_BASIC, ANSICOL_DEFINE, ANSICOL_NO_RGB, ANSICOL_RGB, ansicols, colour, DBGC, and EINVAL.

Referenced by colour_exec().

◆ ansicol_set()

void ansicol_set	(	unsigned int	colour,
		unsigned int	which
	)

Set ANSI colour (using colour definitions)

Set ANSI colour (when no colour definition support is present)

Parameters

colour	Colour index
which	Foreground/background selector

Definition at line 149 of file ansicoldef.c.

                                                              {
         uint32_t ansicol;
         unsigned int basic;
 
         /* Use default colour if colour index is out of range */
         if ( colour < ( sizeof ( ansicols ) / sizeof ( ansicols[0] ) ) ) {
                 ansicol = ansicols[colour];
         } else {
                 ansicol = ANSICOL_DEFINE ( COLOUR_DEFAULT, ANSICOL_NO_RGB );
         }
 
         /* If basic colour is out of range, use the magic colour */
         basic = ANSICOL_BASIC ( ansicol );
         if ( basic >= 10 )
                 basic = ansicol_magic;
 
         /* Set basic colour first */
         printf ( CSI "%c%dm", which, basic );
 
         /* Set 24-bit RGB colour, if applicable */
         if ( ! ( ansicol & ANSICOL_NO_RGB ) ) {
                 printf ( CSI "%c8;2;%d;%d;%dm", which, ANSICOL_RED ( ansicol ),
                          ANSICOL_GREEN ( ansicol ), ANSICOL_BLUE ( ansicol ) );
         }
 }

References ANSICOL_BASIC, ANSICOL_BLUE, ANSICOL_DEFINE, ANSICOL_GREEN, ansicol_magic, ANSICOL_NO_RGB, ANSICOL_RED, ansicols, assert(), colour, COLOUR_DEFAULT, CSI, and printf().

◆ ansicol_reset_magic()

void ansicol_reset_magic ( void )

Reset magic colour.

Definition at line 179 of file ansicoldef.c.

                                   {
 
         /* Set to the compile-time default background colour */
         ansicol_magic = COLOR_NORMAL_BG;
 }

References ansicol_magic, and COLOR_NORMAL_BG.

Referenced by efifb_configure(), and vesafb_configure().

◆ ansicol_set_magic_transparent()

void ansicol_set_magic_transparent ( void )

Set magic colour to transparent.

Definition at line 189 of file ansicoldef.c.

                                             {
 
         /* Set to the console default colour (which will give a
          * transparent background on the framebuffer console).
          */
         ansicol_magic = COLOR_DEFAULT;
 }

References ansicol_magic, and COLOR_DEFAULT.

Referenced by efifb_configure(), and vesafb_configure().

Variable Documentation

◆ ansicols

uint32_t ansicols[]

static

Initial value:

= {
        [COLOR_BLACK]   = ANSICOL_DEFAULT ( COLOR_BLACK ),
        [COLOR_RED]     = ANSICOL_DEFAULT ( COLOR_RED ),
        [COLOR_GREEN]   = ANSICOL_DEFAULT ( COLOR_GREEN ),
        [COLOR_YELLOW]  = ANSICOL_DEFAULT ( COLOR_YELLOW ),
        [COLOR_BLUE]    = ANSICOL_DEFAULT ( COLOR_BLUE ),
        [COLOR_MAGENTA] = ANSICOL_DEFAULT ( COLOR_MAGENTA ),
        [COLOR_CYAN]    = ANSICOL_DEFAULT ( COLOR_CYAN ),
        [COLOR_WHITE]   = ANSICOL_DEFAULT ( COLOR_WHITE ),
}

ANSI colour definitions.

Definition at line 103 of file ansicoldef.c.

Referenced by ansicol_define(), and ansicol_set().

◆ ansicol_magic

uint8_t ansicol_magic = COLOR_NORMAL_BG

static

Magic basic colour.

Definition at line 115 of file ansicoldef.c.

Referenced by ansicol_reset_magic(), ansicol_set(), and ansicol_set_magic_transparent().

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ ANSICOL_DEFINE

◆ ANSICOL_BASIC

◆ ANSICOL_RGB

◆ ANSICOL_RED

◆ ANSICOL_GREEN

◆ ANSICOL_BLUE

◆ ANSICOL_DEFAULT

Function Documentation

◆ FILE_LICENCE()

◆ ansicol_define()

◆ ansicol_set()

◆ ansicol_reset_magic()

◆ ansicol_set_magic_transparent()

Variable Documentation

◆ ansicols

◆ ansicol_magic