ansi_style.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2026 TU Dresden
 * SPDX-FileCopyrightText: 2026 Carl Seifert <carl.seifert@tu-dresden.de>
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once


 
#include "macros/xtstr.h"
 
#ifdef __cplusplus
extern "C" {
#endif


#define _ANSI_SGR_PREFIX         "\x1b["

#define _ANSI_SGR_SUFFIX         "m"



#define _ANSI_COLOR_CODE_PRIMARY "0"

#define _ANSI_COLOR_CODE_BLACK   _ANSI_COLOR_CODE_PRIMARY

#define _ANSI_COLOR_CODE_RED     "1"

#define _ANSI_COLOR_CODE_GREEN   "2"

#define _ANSI_COLOR_CODE_YELLOW  "3"

#define _ANSI_COLOR_CODE_BLUE    "4"

#define _ANSI_COLOR_CODE_PURPLE  "5"

#define _ANSI_COLOR_CODE_CYAN    "6"

#define _ANSI_COLOR_CODE_WHITE   "7"

#define _ANSI_COLOR_CODE_RGB(r, g, b) "8;2;" XTSTR(r) ";" XTSTR(g) ";" XTSTR(b)

#define _ANSI_COLOR_CODE_INDEXED(index) "8;5;" XTSTR(index)



#define _ANSI_COLOR_MODIFIER_FOREGROUND        "3"

#define _ANSI_COLOR_MODIFIER_BRIGHT_FOREGROUND "9"

#define _ANSI_COLOR_MODIFIER_BACKGROUND        "4"

#define _ANSI_COLOR_MODIFIER_BRIGHT_BACKGROUND "10"


 
#ifndef DOXYGEN
/* This macro resolves the color suffix (preprocessor token) to the macro, e.g.
 * RED => _ANSI_COLOR_CODE_RED. */
#  define __ANSI_COLOR(color) _ANSI_COLOR_CODE_ ## color
#endif

#define ANSI_STYLE_FOREGROUND(color) \
    _ANSI_COLOR_MODIFIER_FOREGROUND __ANSI_COLOR(color)

#define ANSI_STYLE_FG(color) ANSI_STYLE_FOREGROUND(color)

#define ANSI_STYLE_FOREGROUND_BRIGHT(color) \
    _ANSI_COLOR_MODIFIER_BRIGHT_FOREGROUND __ANSI_COLOR(color)

#define ANSI_STYLE_FG_BRIGHT(color) ANSI_STYLE_FOREGROUND_BRIGHT(color)

#define ANSI_STYLE_BACKGROUND(color) \
    _ANSI_COLOR_MODIFIER_BACKGROUND __ANSI_COLOR(color)

#define ANSI_STYLE_BG(color) ANSI_STYLE_BACKGROUND(color)

#define ANSI_STYLE_BACKGROUND_BRIGHT(color) \
    _ANSI_COLOR_MODIFIER_BRIGHT_BACKGROUND __ANSI_COLOR(color)

#define ANSI_STYLE_BG_BRIGHT(color) ANSI_STYLE_BACKGROUND_BRIGHT(color)


 
#ifndef DOXYGEN
#  define ANSI_STYLE_NONE                     "0"
#endif

#define ANSI_STYLE_BOLD                       "1"

#define ANSI_STYLE_DIM                        "2"

#define ANSI_STYLE_ITALIC                     "3"
#define ANSI_STYLE_UNDERLINED                 "4"

#define ANSI_STYLE_BLINK_SLOW                 "5"
#define ANSI_STYLE_BLINK_FAST                 "6"

#define ANSI_STYLE_NEGATED                    "7"

#define ANSI_STYLE_CONCEALED                  "8"

#define ANSI_STYLE_STRIKETHROUGH              "9"


 
#ifndef DOXYGEN
/* These macros apply multiple SGR text styles given as suffixes of their respective
 * ANSI_STYLE_... macro, so styling macros at the expansion site are kept short.
 * Example: __ANSI_STYLE_2(BOLD, UNDERLINED) => ";"  ANSI_STYLE_BOLD ";" ANSI_STYLE_UNDERLINED
 * __ANSI_GET_STYLE implements variadic style parameters, so ANSI_STYLE can be given
 * anywhere between zero and 5 style macros. This limit may be increased in the future. */
 
/* __ANSI_GET_STYLE returns the correct concatenation macro (__ANSI_STYLE_N) based on the
 * number of arguments. */
#  define __ANSI_GET_STYLE(_0, _1, _2, _3, _4, _5, _6, name, ...) name
/* __ANSI_STYLED builds the longer style macro from just the suffix token. */
#  define __ANSI_STYLED(keyword)        ANSI_STYLE_ ## keyword
/* These macros recursively expand 1 to 5 style arguments. */
#  define __ANSI_STYLE_0()                 __ANSI_STYLED(NONE)
#  define __ANSI_STYLE_1(a)                __ANSI_STYLED(a)
#  define __ANSI_STYLE_2(a, b)             __ANSI_STYLE_1(a)             ";" __ANSI_STYLED(b)
#  define __ANSI_STYLE_3(a, b, c)          __ANSI_STYLE_2(a, b)          ";" __ANSI_STYLED(c)
#  define __ANSI_STYLE_4(a, b, c, d)       __ANSI_STYLE_3(a, b, c)       ";" __ANSI_STYLED(d)
#  define __ANSI_STYLE_5(a, b, c, d, e)    __ANSI_STYLE_4(a, b, c, d)    ";" __ANSI_STYLED(e)
#  define __ANSI_STYLE_6(a, b, c, d, e, f) __ANSI_STYLE_5(a, b, c, d, e) ";" __ANSI_STYLED(f)
 
/* This macro calls __ANSI_GET_STYLE and expands to the concatenated SGR
 * style string (";" .. ";" ...) */
#  define __ANSI_APPLY_STYLES(...) \
    __ANSI_GET_STYLE(dummy, ##__VA_ARGS__, \
        __ANSI_STYLE_6, __ANSI_STYLE_5, __ANSI_STYLE_4, __ANSI_STYLE_3, __ANSI_STYLE_2, \
        __ANSI_STYLE_1, __ANSI_STYLE_0 \
    )(__VA_ARGS__)
 
#endif

#define ANSI_STYLE(...) \
    _ANSI_SGR_PREFIX \
    __ANSI_APPLY_STYLES(__VA_ARGS__) \
    _ANSI_SGR_SUFFIX

#define ANSI_STYLE_RESET _ANSI_SGR_PREFIX ANSI_STYLE_NONE _ANSI_SGR_SUFFIX

#define ANSI_STYLED(text, ...) \
    ANSI_STYLE(__VA_ARGS__) text ANSI_STYLE_RESET
 /* end of section */
 
#ifdef __cplusplus
}
#endif
 /* end of group */