keyboard.h

Go to the documentation of this file.

#pragma once

 
#include <ascii-chat/common/buffer_sizes.h>
#include <stdbool.h>
#include <stddef.h>
#include "../common/error_codes.h"
 
/* ============================================================================
 * Keyboard Key Enumeration
 * ============================================================================ */

typedef enum {
  KEY_NONE = 0,               
  KEY_ESCAPE = 27,            
  KEY_SPACE = 32,             
  KEY_UP = 0x110000,          
  KEY_DOWN = 0x110001,        
  KEY_LEFT = 0x110002,        
  KEY_RIGHT = 0x110003,       
  KEY_DELETE = 0x110004,      
  KEY_HOME = 0x110005,        
  KEY_END = 0x110006,         
  KEY_CTRL_DELETE = 0x110007, 
  KEY_PASTE_BEGIN = 0x110008,
  KEY_PASTE_END = 0x110009,
  KEY_PASTE = 0x11000a,
  KEY_MEDIA_SUBMIT = 0x11000b, 
  KEY_F12 = 0x11000c,          
  KEY_PAGEUP = 0x11000d,
  KEY_PAGEDOWN = 0x11000e,
  KEY_SHIFT_ENTER = 0x11000f, 
  KEY_SHIFT_ESCAPE = 0x110010, 
  KEY_MINUS = '-',            
  KEY_0 = '0',                
  KEY_1 = '1',                
  KEY_2 = '2',                
  KEY_3 = '3',                
  KEY_C = 'c',                
  KEY_R = 'r',                
  KEY_M = 'm',                
  KEY_F = 'f',                
  KEY_QUESTION = '?',         
  KEY_BACKTICK = '`',         
} keyboard_key_t;
 
/* ============================================================================
 * Keyboard Functions
 * @{
 */

asciichat_error_t keyboard_init(void);

void keyboard_destroy(void);

keyboard_key_t keyboard_read_nonblocking(void);
bool keyboard_input_available(void);

keyboard_key_t keyboard_read_with_timeout(uint32_t timeout_ms);
 
/* ============================================================================
 * Interactive Line Editing
 * @{
 */

typedef struct {
  char *buffer;                    
  size_t max_len;                  
  size_t *len;                     
  size_t *cursor;                  
  bool echo;                       
  char mask_char;                  
  const char *prefix;              
  bool (*validator)(const char *); 
  keyboard_key_t key;              
} keyboard_line_edit_opts_t;

typedef enum {
  LINE_EDIT_CONTINUE,  
  LINE_EDIT_ACCEPTED,  
  LINE_EDIT_CANCELLED, 
  LINE_EDIT_NO_INPUT   
} keyboard_line_edit_result_t;

keyboard_line_edit_result_t keyboard_read_line_interactive(keyboard_line_edit_opts_t *opts);
keyboard_line_edit_result_t keyboard_apply_key(keyboard_line_edit_opts_t *opts);


bool keyboard_is_initialized(void);
bool keyboard_request_background(void);
bool keyboard_query_background(uint8_t *r, uint8_t *g, uint8_t *b);

typedef struct {
  uint8_t bytes[UTF8_MAX_BYTES];
  unsigned length, expected;
} keyboard_text_decoder_t;

keyboard_key_t keyboard_text_decode(keyboard_text_decoder_t *state, int input);

size_t keyboard_text_encode(keyboard_key_t key, char text[UTF8_BUFFER_SIZE]);

keyboard_key_t keyboard_text_utf16(uint16_t *pending_high, uint16_t unit);

keyboard_key_t keyboard_stream_read(int (*read_byte)(void));
void keyboard_stream_reset(void);
bool keyboard_stream_ready(int (*read_byte)(void));

uint64_t keyboard_stream_terminal_reply_ns(void);

bool keyboard_stream_query_background(int (*read_byte)(void), bool (*send_query)(void), uint8_t *r, uint8_t *g,
                                      uint8_t *b);

bool keyboard_stream_background(uint8_t *r, uint8_t *g, uint8_t *b);