terminal.h

Go to the documentation of this file.

#pragma once
 
#include <stdbool.h>
#include <stdint.h>
#include "../common.h"
 
// ============================================================================
// 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
 
/* ============================================================================
 * 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);
 
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_hide_cursor(int fd, bool hide);
 
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 {
  TERM_CAP_COLOR_16 = 0x0001,
  TERM_CAP_COLOR_256 = 0x0002,
  TERM_CAP_COLOR_TRUE = 0x0004,
  TERM_CAP_UTF8 = 0x0008,
  TERM_CAP_BACKGROUND = 0x0010
} 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;
} 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 print_terminal_capabilities(const terminal_capabilities_t *caps);
 
void test_terminal_output_modes(void);
 
terminal_capabilities_t apply_color_mode_override(terminal_capabilities_t caps);
 
/* ============================================================================
 * 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.
 */
 
#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);
 
#endif