palette.h

Go to the documentation of this file.

#pragma once
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
typedef enum {
  PALETTE_STANDARD = 0,
  PALETTE_BLOCKS,
  PALETTE_DIGITAL,
  PALETTE_MINIMAL,
  PALETTE_COOL,
  PALETTE_CUSTOM,
  PALETTE_COUNT
} palette_type_t;
 
typedef struct {
  const char *name;
  const char *chars;
  size_t length;
  bool requires_utf8;
  bool is_validated;
} palette_def_t;
 
typedef struct {
  bool utf8_support;
  bool forced_utf8;
  char terminal_type[32];
  char locale_encoding[16];
} utf8_capabilities_t;
 
#define PALETTE_CHARS_STANDARD "   ...',;:clodxkO0KXNWM"
 
#define PALETTE_CHARS_BLOCKS "   ░░▒▒▓▓██"
 
#define PALETTE_CHARS_DIGITAL "   -=≡≣▰▱◼"
 
#define PALETTE_CHARS_MINIMAL "   .-+*#"
 
#define PALETTE_CHARS_COOL "   ▁▂▃▄▅▆▇█"
 
typedef struct {
  char bytes[4];
  uint8_t byte_len;
  uint8_t display_width;
} utf8_char_info_t;
 
typedef struct {
  utf8_char_info_t *chars;
  size_t char_count;
  size_t total_bytes;
  char *raw_string;
} utf8_palette_t;
 
extern const char DEFAULT_ASCII_PALETTE[];
 
extern const size_t DEFAULT_ASCII_PALETTE_LEN;
 
const palette_def_t *get_builtin_palette(palette_type_t type);
 
bool validate_palette_chars(const char *chars, size_t len);
 
bool palette_requires_utf8_encoding(const char *chars, size_t len);
 
bool detect_client_utf8_support(utf8_capabilities_t *caps);
 
palette_type_t select_compatible_palette(palette_type_t requested, bool client_utf8);
 
int apply_palette_config(palette_type_t type, const char *custom_chars);
 
int build_client_luminance_palette(const char *palette_chars, size_t palette_len, char luminance_mapping[256]);
 
int initialize_client_palette(palette_type_t palette_type, const char *custom_chars, char client_palette_chars[256],
                              size_t *client_palette_len, char client_luminance_palette[256]);
 
utf8_palette_t *utf8_palette_create(const char *palette_string);
 
void utf8_palette_destroy(utf8_palette_t *palette);
 
const utf8_char_info_t *utf8_palette_get_char(const utf8_palette_t *palette, size_t index);
 
size_t utf8_palette_get_char_count(const utf8_palette_t *palette);
 
bool utf8_palette_contains_char(const utf8_palette_t *palette, const char *utf8_char, size_t char_bytes);
 
size_t utf8_palette_find_char_index(const utf8_palette_t *palette, const char *utf8_char, size_t char_bytes);
 
size_t utf8_palette_find_all_char_indices(const utf8_palette_t *palette, const char *utf8_char, size_t char_bytes,
                                          size_t *indices, size_t max_indices);