termcolor.h File Reference

#include <stdbool.h>
#include <stdio.h>

Go to the source code of this file.

Enumerations
enum	term_color_error_t {   TermColorErrorNone = 0 , TermColorErrorAllocationFailed = 1 , TermColorErrorPrintingFailed = 2 , TermColorErrorInvalidColor = 3 ,   TermColorErrorUnterminatedColor = 4 , TERM_COLOR_ERROR_COUNT }

Functions
int	_tcol_color_generate (char *dst, size_t dstn, size_t *len, int rep, int foreground, int background)
const char *	tcol_errorstr (const enum term_color_error_t err)
int	tcol_color_parse (char *dst, size_t dstn, char color[16], size_t k, size_t *len)
void	tcol_override_color_checks (bool enable_color)
bool	tcol_has_color (void)
int	tcol_fprintf (FILE *stream, const char *fmt,...)
int	tcol_printf (const char *fmt,...)
int	tcol_snprintf (char *buffer, size_t N, const char *fmt,...)

Enumeration Type Documentation

term_color_error_t

enum term_color_error_t

Enumerator
TermColorErrorNone
TermColorErrorAllocationFailed
TermColorErrorPrintingFailed
TermColorErrorInvalidColor
TermColorErrorUnterminatedColor
TERM_COLOR_ERROR_COUNT

Definition at line 36 of file termcolor.h.

                        {
    TermColorErrorNone = 0,
    TermColorErrorAllocationFailed = 1,
    TermColorErrorPrintingFailed = 2,
    TermColorErrorInvalidColor = 3,
    TermColorErrorUnterminatedColor = 4,
    TERM_COLOR_ERROR_COUNT
};

Function Documentation

_tcol_color_generate()

int _tcol_color_generate	(	char *	dst,
		size_t	dstn,
		size_t *	len,
		int	rep,
		int	foreground,
		int	background )

Definition at line 76 of file termcolor.c.

                                                         {
    /* Much of the code here was informed by the following gist:
       https://gist.github.com/fnky/458719343aabd01cfb17a3a4f7296797 */
 
    size_t j = 0;
 
    /* This macro checks to make sure we don't overrun the buffer when we add
        a new character, */
    #define __APPEND(c) do { \
        dst[j++] = (c); \
        if (j >= dstn) return TermColorErrorNone; \
    } while (0)
 
    /* Every escape code begins with "\e[" */
    __APPEND('\033');
    __APPEND('[');
 
    /* Add the appropriate parameters to our escape sequence depending on the
       flags set in rep(resentation). */
    if (rep & _termcolor_internal_color_BOLD) {
        __APPEND('1');
        __APPEND(';');
    }
    if (rep & _termcolor_internal_color_FANT) {
        __APPEND('2');
        __APPEND(';');
    }
    if (rep & _termcolor_internal_color_ITLC) {
        __APPEND('3');
        __APPEND(';');
    }
    if (rep & _termcolor_internal_color_UNDR) {
        __APPEND('4');
        __APPEND(';');
    }
    if (rep & _termcolor_internal_color_BLNK) {
        __APPEND('5');
        __APPEND(';');
    }
    if (rep & _termcolor_internal_color_STRK) {
        __APPEND('9');
        __APPEND(';');
    }
 
    /* If foreground and background colors were provided, snprintf them to dst. */
    if (foreground != -1) {
        j += snprintf(dst + j, dstn - j, "%d;", foreground);
        if (j >= dstn) return TermColorErrorNone;
    }
    if (background != -1) {
        j += snprintf(dst + j, dstn - j, "%d;", background + 10);
        if (j >= dstn) return TermColorErrorNone;
    }
 
    if (dst[j - 1] == ';') {
        j--;
    }
 
    /* Graphics mode escape sequences end with 'm' */
    __APPEND('m');
 
    *len = j;
    return TermColorErrorNone;
}

tcol_color_parse()

int tcol_color_parse	(	char *	dst,
		size_t	dstn,
		char	color[16],
		size_t	k,
		size_t *	len )

Definition at line 142 of file termcolor.c.

                                  {
    if (!use_color) {
        *len = 0;
        return TermColorErrorNone;
    }
 
    /* '0' signifies no color, i.e. a reset */
    if (k == 1 && *color == '0') {
        size_t j = 0;
        __APPEND('\033');
        __APPEND('[');
        __APPEND('m');
        *len = j;
        return TermColorErrorNone;
    }
 
    /* As -1 they are ignored. Otherwise they are set to the foreground color
       code. The backround code is later added 10 to. */
    int foreground = -1;
    int background = -1;
 
    enum _termcolor_internal_color rep = 0;
    size_t i;
    for (i = 0; i < k; i++) {
        switch (color[i]) {
            /* Farily straightforward; just sets the flags corresponding to the
               color attributes. */
            case '+':
                rep |= _termcolor_internal_color_BOLD;
                break;
            case '-':
                rep |= _termcolor_internal_color_FANT;
                break;
            case '_':
                rep |= _termcolor_internal_color_UNDR;
                break;
            case '*':
                rep |= _termcolor_internal_color_BLNK;
                break;
            case '~':
                rep |= _termcolor_internal_color_STRK;
                break;
            case '/':
                rep |= _termcolor_internal_color_ITLC;
                break;
 
                /* Here we take the character after the ',' and use that as our
                   background color code, like Nano does. */
            case ',': {
                if (i + 1 >= k) {
                    return TermColorErrorInvalidColor;
                }
                const int result = _termcolor_internal_lookup(color[i + 1]);
                if (result == -1) {
                    return TermColorErrorInvalidColor;
                }
                background = result;
                i++;
                break;
            }
            default: {
                /* If we haven't matched anything, we assume its a foreground
                   color. Make sure it is and error if not. */
                const int result = _termcolor_internal_lookup(color[i]);
                if (result != -1) {
                    foreground = result;
                    break;
                }
                return TermColorErrorInvalidColor;
            }
        }
    }
 
    return _tcol_color_generate(dst, dstn, len, rep, foreground, background);
}

tcol_errorstr()

const char * tcol_errorstr ( const enum term_color_error_t err )

inline

Definition at line 32 of file termcolor.c.

                                                                    {
    return tcol_errorstrs[err];
}

tcol_fprintf()

int tcol_fprintf	(	FILE *	stream,
		const char *	fmt,
			... )

Definition at line 365 of file termcolor.c.

                                                     {
    va_list ap;
    va_start(ap, fmt);
    const int status = tcol_vfprintf(stream, fmt, ap);
    va_end(ap);
    return status;
}

tcol_has_color()

bool tcol_has_color

(

void

)

Definition at line 36 of file termcolor.c.

                          {
    return use_color;
}

tcol_override_color_checks()

void tcol_override_color_checks

(

bool

enable_color

)

Definition at line 40 of file termcolor.c.

                                                   {
    use_color = enable_color;
}

tcol_printf()

int tcol_printf	(	const char *	fmt,
			... )

Definition at line 373 of file termcolor.c.

                                      {
    va_list ap;
    va_start(ap, fmt);
    const int status = tcol_vfprintf(stdout, fmt, ap);
    va_end(ap);
    return status;
}

tcol_snprintf()

int tcol_snprintf	(	char *	buffer,
		size_t	N,
		const char *	fmt,
			... )

Definition at line 382 of file termcolor.c.

                                                                {
    va_list ap;
    va_start(ap, fmt);
    const int status = tcol_vsnprintf(stream, N, fmt, ap);
    va_end(ap);
    return status;
}