ansicol.c File Reference

ANSI colours. More...

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

Go to the source code of this file.

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
__weak void	ansicol_set (unsigned int colour, unsigned int which)
	Set ANSI colour (when no colour definition support is present)
static void	ansicol_foreground (unsigned int colour)
	Set ANSI foreground colour.
static void	ansicol_background (unsigned int colour)
	Set ANSI background colour.
void	ansicol_set_pair (unsigned int cpair)
	Set ANSI foreground and background colour.
int	ansicol_define_pair (unsigned int cpair, unsigned int foreground, unsigned int background)
	Define ANSI colour pair.

Variables
static struct ansicol_pair	ansicol_pairs []
	ANSI colour pair definitions.

Detailed Description

ANSI colours.

Definition in file ansicol.c.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

ansicol_set()

__weak void ansicol_set	(	unsigned int	colour,
		unsigned int	which )

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

Parameters

colour	Colour index
which	Foreground/background selector

Definition at line 58 of file ansicol.c.

                                                                    {
 
        /* Colour indices are hardcoded and should never be out of range */
        assert ( colour < 10 );
 
        /* Set basic colour */
        printf ( CSI "%c%dm", which, colour );
}

References __weak, assert, colour, CSI, and printf().

Referenced by ansicol_background(), and ansicol_foreground().

ansicol_foreground()

void ansicol_foreground ( unsigned int colour )

static

Set ANSI foreground colour.

Parameters

colour

Colour index

Definition at line 72 of file ansicol.c.

                                                       {
        ansicol_set ( colour, '3' );
}

References ansicol_set(), and colour.

Referenced by ansicol_set_pair().

ansicol_background()

void ansicol_background ( unsigned int colour )

static

Set ANSI background colour.

Parameters

colour

Colour index

Definition at line 81 of file ansicol.c.

                                                       {
        ansicol_set ( colour, '4' );
}

References ansicol_set(), and colour.

Referenced by ansicol_set_pair().

ansicol_set_pair()

void ansicol_set_pair

(

unsigned int

cpair

)

Set ANSI foreground and background colour.

Parameters

cpair

Colour pair index

Definition at line 90 of file ansicol.c.

                                             {
        struct ansicol_pair *pair;
 
        /* Colour pair indices are hardcoded and should never be out of range */
        assert ( cpair < ( sizeof ( ansicol_pairs ) /
                           sizeof ( ansicol_pairs[0] ) ) );
 
        /* Set both foreground and background colours */
        pair = &ansicol_pairs[cpair];
        ansicol_foreground ( pair->foreground );
        ansicol_background ( pair->background );
}

References ansicol_background(), ansicol_foreground(), ansicol_pairs, assert, ansicol_pair::background, and ansicol_pair::foreground.

Referenced by ansiscr_attrs(), ansiscr_reset(), colour_exec(), console_exec(), and cpair_exec().

ansicol_define_pair()

int ansicol_define_pair	(	unsigned int	cpair,
		unsigned int	foreground,
		unsigned int	background )

Define ANSI colour pair.

Parameters

cpair	Colour pair index
foreground	Foreground colour index
background	Background colour index

Return values

rc	Return status code

Definition at line 111 of file ansicol.c.

                                                    {
        struct ansicol_pair *pair;
 
        /* Fail if colour index is out of range */
        if ( cpair >= ( sizeof ( ansicol_pairs ) / sizeof ( ansicol_pairs[0] )))
                return -EINVAL;
 
        /* Update colour pair definition */
        pair = &ansicol_pairs[cpair];
        pair->foreground = foreground;
        pair->background = background;
        DBGC ( &ansicol_pairs[0], "ANSICOL redefined colour pair %d as "
               "foreground %d background %d\n", cpair, foreground, background );
 
        return 0;
}

References ansicol_pairs, ansicol_pair::background, DBGC, EINVAL, and ansicol_pair::foreground.

Referenced by cpair_exec().

Variable Documentation

ansicol_pairs

struct ansicol_pair ansicol_pairs[]

static

Initial value:

= {
        [CPAIR_DEFAULT] = { COLOR_DEFAULT, COLOR_DEFAULT },
        [CPAIR_NORMAL] = { COLOR_NORMAL_FG, COLOR_NORMAL_BG },
        [CPAIR_SELECT] = { COLOR_SELECT_FG, COLOR_SELECT_BG },
        [CPAIR_SEPARATOR] = { COLOR_SEPARATOR_FG, COLOR_SEPARATOR_BG },
        [CPAIR_EDIT] = { COLOR_EDIT_FG, COLOR_EDIT_BG },
        [CPAIR_ALERT] = { COLOR_ALERT_FG, COLOR_ALERT_BG },
        [CPAIR_URL] = { COLOR_URL_FG, COLOR_URL_BG },
        [CPAIR_PXE] = { COLOR_PXE_FG, COLOR_PXE_BG },
}

ANSI colour pair definitions.

Definition at line 41 of file ansicol.c.

                                             {
        [CPAIR_DEFAULT] = { COLOR_DEFAULT, COLOR_DEFAULT },
        [CPAIR_NORMAL] = { COLOR_NORMAL_FG, COLOR_NORMAL_BG },
        [CPAIR_SELECT] = { COLOR_SELECT_FG, COLOR_SELECT_BG },
        [CPAIR_SEPARATOR] = { COLOR_SEPARATOR_FG, COLOR_SEPARATOR_BG },
        [CPAIR_EDIT] = { COLOR_EDIT_FG, COLOR_EDIT_BG },
        [CPAIR_ALERT] = { COLOR_ALERT_FG, COLOR_ALERT_BG },
        [CPAIR_URL] = { COLOR_URL_FG, COLOR_URL_BG },
        [CPAIR_PXE] = { COLOR_PXE_FG, COLOR_PXE_BG },
};

Referenced by ansicol_define_pair(), and ansicol_set_pair().