terminal.h

Go to the documentation of this file.

#pragma once
 
#include <stdbool.h>
#include <stdint.h>
#include "../common.h"
#include "../log/types.h"
 
// ============================================================================
// Cross-platform CLI Utilities
// ============================================================================
 
#ifdef _WIN32
#include "windows/getopt.h"
#else
#include <getopt.h>
#endif
 
// ============================================================================
// Platform-Specific Signal Definitions
// ============================================================================
 
#ifdef _WIN32
// Windows doesn't have these signals natively
#define SIGWINCH 28 // Window size change (not supported on Windows)
#define SIGTERM 15  // Termination signal (limited support on Windows)
#endif
 
// ============================================================================
// Theme-Aware Default Colors
// ============================================================================
 
#define TERMINAL_COLOR_THEME_LIGHT_FG_R 65
#define TERMINAL_COLOR_THEME_LIGHT_FG_G 61
#define TERMINAL_COLOR_THEME_LIGHT_FG_B 61
 
#define TERMINAL_COLOR_THEME_DARK_FG_R 204
#define TERMINAL_COLOR_THEME_DARK_FG_G 204
#define TERMINAL_COLOR_THEME_DARK_FG_B 204
 
#define TERMINAL_COLOR_THEME_LIGHT_BG_R 255
#define TERMINAL_COLOR_THEME_LIGHT_BG_G 255
#define TERMINAL_COLOR_THEME_LIGHT_BG_B 255
 
#define TERMINAL_COLOR_THEME_DARK_BG_R 0
#define TERMINAL_COLOR_THEME_DARK_BG_G 0
#define TERMINAL_COLOR_THEME_DARK_BG_B 0
 
/* ============================================================================
 * Terminal Data Structures
 * ============================================================================
 */
 
typedef struct {
  int rows; 
  int cols; 
} terminal_size_t;
 
/* ============================================================================
 * Terminal Control Functions
 * @{
 */
 
asciichat_error_t terminal_get_size(terminal_size_t *size);
 
asciichat_error_t terminal_set_raw_mode(bool enable);
 
asciichat_error_t terminal_set_echo(bool enable);
 
bool terminal_supports_color(void);
 
bool terminal_supports_unicode(void);
 
bool terminal_supports_utf8(void);
 
asciichat_error_t terminal_clear_screen(void);
 
asciichat_error_t terminal_move_cursor(int row, int col);
 
asciichat_error_t terminal_move_cursor_relative(int offset);
 
void terminal_enable_ansi(void);
 
asciichat_error_t terminal_set_buffering(bool line_buffered);
 
asciichat_error_t terminal_flush(int fd);
 
asciichat_error_t terminal_get_cursor_position(int *row, int *col);
 
asciichat_error_t terminal_save_cursor(void);
 
asciichat_error_t terminal_restore_cursor(void);
 
asciichat_error_t terminal_set_title(const char *title);
 
asciichat_error_t terminal_ring_bell(void);
 
asciichat_error_t terminal_cursor_hide(void);
 
asciichat_error_t terminal_cursor_show(void);
 
asciichat_error_t terminal_set_scroll_region(int top, int bottom);
 
asciichat_error_t terminal_reset(int fd);
 
asciichat_error_t terminal_cursor_home(int fd);
 
asciichat_error_t terminal_clear_scrollback(int fd);
 
/* ============================================================================
 * Terminal Detection and Capabilities
 * @{
 */
 
typedef enum {
  TERM_COLOR_AUTO = -1,
  TERM_COLOR_NONE = 0,
  TERM_COLOR_16 = 1,
  TERM_COLOR_256 = 2,
  TERM_COLOR_TRUECOLOR = 3
} terminal_color_mode_t;
 
typedef enum {
  COLOR_FILTER_NONE = 0,
  COLOR_FILTER_BLACK = 1,
  COLOR_FILTER_WHITE = 2,
  COLOR_FILTER_GREEN = 3,
  COLOR_FILTER_MAGENTA = 4,
  COLOR_FILTER_FUCHSIA = 5,
  COLOR_FILTER_ORANGE = 6,
  COLOR_FILTER_TEAL = 7,
  COLOR_FILTER_CYAN = 8,
  COLOR_FILTER_PINK = 9,
  COLOR_FILTER_RED = 10,
  COLOR_FILTER_YELLOW = 11,
  COLOR_FILTER_RAINBOW = 12,
  COLOR_FILTER_COUNT
} color_filter_t;
 
typedef enum {
  TERM_CAP_COLOR_16 = 0x0001,
  TERM_CAP_COLOR_256 = 0x0002,
  TERM_CAP_COLOR_TRUE = 0x0004,
  TERM_CAP_UTF8 = 0x0008,
  TERM_CAP_BACKGROUND = 0x0010,
  TERM_CAP_MATRIX_RAIN = 0x0020
} terminal_capability_flags_t;
 
typedef enum {
  RENDER_MODE_FOREGROUND = 0,
  RENDER_MODE_BACKGROUND = 1,
  RENDER_MODE_HALF_BLOCK = 2
} render_mode_t;
 
typedef struct {
  terminal_color_mode_t color_level;
  uint32_t capabilities;
  uint32_t color_count;
  bool utf8_support;
  bool detection_reliable;
  render_mode_t render_mode;
  char term_type[64];
  char colorterm[64];
  bool wants_background;
  int palette_type;
  char palette_custom[64];
  uint8_t desired_fps;
  color_filter_t color_filter;
  bool wants_padding;
  size_t pad_height;
} terminal_capabilities_t;
 
typedef struct {
  int fd;
  const char *path;
  bool owns_fd;
} tty_info_t;
 
/* ============================================================================
 * Terminal Capability Detection Functions
 * @{
 */
 
terminal_capabilities_t detect_terminal_capabilities(void);
 
tty_info_t get_current_tty(void);
 
bool is_valid_tty_path(const char *path);
 
asciichat_error_t get_terminal_size(unsigned short int *width, unsigned short int *height);
 
const char *terminal_color_level_name(terminal_color_mode_t level);
 
const char *terminal_capabilities_summary(const terminal_capabilities_t *caps);
 
void test_terminal_output_modes(void);
 
terminal_capabilities_t apply_color_mode_override(terminal_capabilities_t caps);
 
bool terminal_should_color_output(int fd);
 
terminal_color_mode_t terminal_get_effective_color_mode(void);
 
bool terminal_has_dark_background(void);
 
bool terminal_query_background_color(uint8_t *bg_r, uint8_t *bg_g, uint8_t *bg_b);
 
/* ============================================================================
 * Windows Console Resize Detection
 * @{
 *
 * Windows-specific functionality for detecting console window resize events.
 * Unix systems use SIGWINCH signal, but Windows requires polling or event
 * monitoring, so a background thread is used.
 */
 
bool terminal_should_use_control_sequences(int fd);
 
/* ============================================================================
 * Interactive Mode and TTY State Detection
 * @{
 *
 * Centralized functions for detecting TTY status and interactive mode.
 * These functions consolidate scattered isatty() checks throughout the codebase.
 */
 
bool terminal_is_stdin_tty(void);
 
bool terminal_is_stdout_tty(void);
 
bool terminal_is_stderr_tty(void);
 
bool terminal_is_interactive(void);
 
bool terminal_is_piped_output(void);
 
bool terminal_should_force_stderr(void);
 
int terminal_choose_log_fd(log_level_t level);
 
bool terminal_can_prompt_user(void);
 
/* ============================================================================
 * Console Control and TTY Operations
 * ============================================================================ */
 
typedef enum {
  CONSOLE_CTRL_C = 0,     
  CONSOLE_CTRL_BREAK = 1, 
  CONSOLE_CLOSE = 2,      
  CONSOLE_LOGOFF = 3,     
  CONSOLE_SHUTDOWN = 4    
} console_ctrl_event_t;
 
typedef bool (*console_ctrl_handler_t)(console_ctrl_event_t event);
 
bool platform_set_console_ctrl_handler(console_ctrl_handler_t handler);
 
int platform_isatty(int fd);
 
const char *platform_ttyname(int fd);
 
/* ============================================================================
 * Renderer Color Selection (Cross-Platform Abstraction)
 * ============================================================================ */
 
void terminal_get_default_foreground_color(int theme, uint8_t *out_r, uint8_t *out_g, uint8_t *out_b);
 
void terminal_get_default_background_color(int theme, uint8_t *out_r, uint8_t *out_g, uint8_t *out_b);
 
unsigned short int terminal_get_effective_width(void);
 
unsigned short int terminal_get_effective_height(void);
 
#ifdef _WIN32
typedef void (*terminal_resize_callback_t)(int cols, int rows);
 
int terminal_start_resize_detection(terminal_resize_callback_t callback);
 
void terminal_stop_resize_detection(void);
 
#else
void terminal_stop_resize_detection(void);
#endif