Terminal colours

Terminal colours for formatting. More...

Collaboration diagram for Terminal colours:

Data Structures
struct	colour_pallete_t
	a colour pallete More...
struct	format_context_t
	a formatting context when using colours More...

Enumerations
enum	colour_t {   eColourRed , eColourGreen , eColourYellow , eColourBlue ,   eColourMagenta , eColourCyan , eColourWhite , eColourDefault ,   eColourCount }
	a colour code More...

Functions
STA_RET_STRING CT_PUREFN CT_FORMAT_API const char *	colour_get (const colour_pallete_t *colours, colour_t idx)
	get a colours string form from a pallete More...
STA_RET_STRING CT_PUREFN CT_FORMAT_API const char *	colour_reset (const colour_pallete_t *colours)
	get a reset string from a pallete More...
STA_RET_STRING CT_FORMAT_API char *	colour_text (format_context_t context, colour_t idx, const char *text)
	add colour to a string More...
STA_RET_STRING	STA_PRINTF (3, 4) CT_FORMAT_API char *colour_format(format_context_t context
	format a string and add colour to it More...
STA_RET_STRING colour_t STA_FORMAT_STRING const char STA_RET_STRING CT_FORMAT_API char *	colour_vformat (format_context_t context, colour_t idx, const char *fmt, va_list args)
	format a string and add colour to it More...

Variables
CT_FORMAT_API const colour_pallete_t	kColourNone
	a colour pallete that applies no colours More...
CT_FORMAT_API const colour_pallete_t	kColourDefault
	a colour pallete that applies ANSI VT100 colours More...
STA_RET_STRING colour_t	idx
STA_RET_STRING colour_t STA_FORMAT_STRING const char *	fmt

Detailed Description

Terminal colours for formatting.

Enumeration Type Documentation

colour_t

enum colour_t

a colour code

Enumerator
eColourRed
eColourGreen
eColourYellow
eColourBlue
eColourMagenta
eColourCyan
eColourWhite
eColourDefault
eColourCount

Definition at line 22 of file colour.h.

Function Documentation

colour_get()

STA_RET_STRING CT_PUREFN CT_FORMAT_API const char* colour_get	(	const colour_pallete_t *	colours,
		colour_t	idx
	)

get a colours string form from a pallete

Parameters

colours	the pallete to get the colour from
idx	the colour to get

Returns

the colour string

Definition at line 39 of file colour.c.

colour_reset()

STA_RET_STRING CT_PUREFN CT_FORMAT_API const char* colour_reset

(

const colour_pallete_t *

colours

)

get a reset string from a pallete

Parameters

colours

the pallete to get the reset from

Returns

the reset string

Definition at line 48 of file colour.c.

colour_text()

STA_RET_STRING CT_FORMAT_API char* colour_text	(	format_context_t	context,
		colour_t	idx,
		const char *	text
	)

add colour to a string

Parameters

context	the context to use
idx	the colour to add
text	the text to colour

Returns

the coloured string

Definition at line 56 of file colour.c.

colour_vformat()

STA_RET_STRING colour_t STA_FORMAT_STRING const char STA_RET_STRING CT_FORMAT_API char* colour_vformat	(	format_context_t	context,
		colour_t	idx,
		const char *	fmt,
		va_list	args
	)

format a string and add colour to it

Parameters

context	the context to use
idx	the colour to add
fmt	the format string
args	the format arguments

Returns

the coloured string

Definition at line 76 of file colour.c.

STA_PRINTF()

STA_RET_STRING STA_PRINTF	(	3	,
		4
	)

format a string and add colour to it

Parameters

context	the context to use
idx	the colour to add
fmt	the format string
...	the format arguments

Returns

the coloured string

Variable Documentation

fmt

STA_RET_STRING colour_t STA_FORMAT_STRING const char* fmt

Definition at line 99 of file colour.h.

idx

STA_RET_STRING colour_t idx

Definition at line 98 of file colour.h.

kColourDefault

CT_FORMAT_API const colour_pallete_t kColourDefault

extern

a colour pallete that applies ANSI VT100 colours

Definition at line 24 of file colour.c.

kColourNone

CT_FORMAT_API const colour_pallete_t kColourNone

extern

a colour pallete that applies no colours

Definition at line 10 of file colour.c.