keyboard.h

Go to the documentation of this file.

#pragma once
 
#pragma once
 
#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 = 256,          
  KEY_DOWN = 257,        
  KEY_LEFT = 258,        
  KEY_RIGHT = 259,       
  KEY_DELETE = 260,      
  KEY_HOME = 261,        
  KEY_END = 262,         
  KEY_CTRL_DELETE = 263, 
  KEY_MINUS = '-',       
  KEY_0 = '0',           
  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);
 
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);