[console] Add centralised concept of colours and colour pairs

Add a centralised concept of colours and colour pairs (using the
default colour pairs as configured via config/colour.h).  A colour
pair consists of a pair of colour indices.

Add the ability to redefine both a colour pair and an individual
colour index, with minimal overhead if this feature is not required
(e.g. because the relevant shell commands are not present in the
build).

Signed-off-by: Michael Brown <mcb30@ipxe.org>
This commit is contained in:
Michael Brown
2013-12-07 20:53:20 +00:00
parent 4c51f9602d
commit 7025f5c648
5 changed files with 361 additions and 0 deletions

View File

@@ -0,0 +1,73 @@
#ifndef _IPXE_ANSICOL_H
#define _IPXE_ANSICOL_H
/** @file
*
* ANSI colours
*
*/
FILE_LICENCE ( GPL2_OR_LATER );
#include <stdint.h>
#include <curses.h> /* For COLOR_RED etc. */
/** Default colour (usually white foreground, black background) */
#define COLOUR_DEFAULT 9
#define COLOR_DEFAULT COLOUR_DEFAULT
/** RGB value for "not defined" */
#define ANSICOL_NO_RGB 0x01000000
/**
* @defgroup ansicolpairs ANSI colour pairs
* @{
*/
/** Default colour pair */
#define CPAIR_DEFAULT 0
/** Normal text */
#define CPAIR_NORMAL 1
/** Highlighted text */
#define CPAIR_SELECT 2
/** Unselectable text (e.g. continuation ellipses, menu separators) */
#define CPAIR_SEPARATOR 3
/** Editable text */
#define CPAIR_EDIT 4
/** Error text */
#define CPAIR_ALERT 5
/** URL text */
#define CPAIR_URL 6
/** PXE selected menu entry */
#define CPAIR_PXE 7
/** @} */
/** An ANSI colour pair definition */
struct ansicol_pair {
/** Foreground colour index */
uint8_t foreground;
/** Background colour index */
uint8_t background;
} __attribute__ (( packed ));
/* ansicol.c */
extern void ansicol_set_pair ( unsigned int cpair );
extern int ansicol_define_pair ( unsigned int cpair, unsigned int foreground,
unsigned int background );
/* ansicoldef.c */
extern int ansicol_define ( unsigned int colour, unsigned int ansi,
uint32_t rgb );
/* Function provided by ansicol.c but overridden by ansicoldef.c, if present */
extern void ansicol_set ( unsigned int colour, unsigned int which );
#endif /* _IPXE_ANSICOL_H */

View File

@@ -66,6 +66,8 @@ FILE_LICENCE ( GPL2_OR_LATER );
#define ERRFILE_null_reboot ( ERRFILE_CORE | 0x001a0000 )
#define ERRFILE_pinger ( ERRFILE_CORE | 0x001b0000 )
#define ERRFILE_fbcon ( ERRFILE_CORE | 0x001c0000 )
#define ERRFILE_ansicol ( ERRFILE_CORE | 0x001d0000 )
#define ERRFILE_ansicoldef ( ERRFILE_CORE | 0x001e0000 )
#define ERRFILE_eisa ( ERRFILE_DRIVER | 0x00000000 )
#define ERRFILE_isa ( ERRFILE_DRIVER | 0x00010000 )