colour.h

Go to the documentation of this file.

// SPDX-License-Identifier: LGPL-3.0-only
 
#pragma once
 
#include <ctu_format_api.h>
 
#include "core/compiler.h"
#include "core/analyze.h"
 
#include <stdarg.h>
 
CT_BEGIN_API
 
typedef struct arena_t arena_t;
 
 
typedef enum colour_t
{
    eColourRed,
    eColourGreen,
    eColourYellow,
    eColourBlue,
    eColourMagenta,
    eColourCyan,
    eColourWhite,
 
    eColourDefault,
 
    eColourCount
} colour_t;
 
typedef struct colour_pallete_t
{
    const char *colours[eColourCount];
    STA_FIELD_STRING const char *reset;
} colour_pallete_t;
 
typedef struct format_context_t
{
    arena_t *arena;
    const colour_pallete_t *pallete;
} format_context_t;
 
CT_FORMAT_API extern const colour_pallete_t kColourNone;
 
CT_FORMAT_API extern const colour_pallete_t kColourDefault;
 
STA_RET_STRING CT_PUREFN
CT_FORMAT_API const char *colour_get(IN_NOTNULL const colour_pallete_t *colours, IN_DOMAIN(<, eColourCount) colour_t idx);
 
STA_RET_STRING CT_PUREFN
CT_FORMAT_API const char *colour_reset(IN_NOTNULL const colour_pallete_t *colours);
 
STA_RET_STRING
CT_FORMAT_API char *colour_text(
    format_context_t context,
    IN_DOMAIN(<, eColourCount) colour_t idx,
    IN_STRING const char *text);
 
STA_RET_STRING STA_PRINTF(3, 4)
CT_FORMAT_API char *colour_format(
    format_context_t context,
    IN_DOMAIN(<, eColourCount) colour_t idx,
    STA_FORMAT_STRING const char *fmt, ...);
 
STA_RET_STRING
CT_FORMAT_API char *colour_vformat(
    format_context_t context,
    IN_DOMAIN(<, eColourCount) colour_t idx,
    IN_STRING const char *fmt, va_list args);
 
 
CT_END_API