diff options
Diffstat (limited to 'lib/keystroke.h')
| -rw-r--r-- | lib/keystroke.h | 79 |
1 files changed, 40 insertions, 39 deletions
diff --git a/lib/keystroke.h b/lib/keystroke.h index 76fba15e..b04a2e20 100644 --- a/lib/keystroke.h +++ b/lib/keystroke.h @@ -22,26 +22,20 @@ #ifndef _ZEBRA_KEYSTROKE_H #define _ZEBRA_KEYSTROKE_H -#include <stddef.h> -#include <stdint.h> -#include <stdbool.h> +#include "misc.h" #include <arpa/telnet.h> #include "zassert.h" #include "vio_fifo.h" -#ifndef Inline -#define Inline static inline -#endif - /*============================================================================== * Keystroke buffering */ enum { keystroke_max_len = 100 } ; -enum keystroke_type +typedef enum keystroke_type { ks_null = 0, /* nothing, nada, bupkis... */ ks_char, /* character -- uint32_t */ @@ -52,17 +46,21 @@ enum keystroke_type ks_type_count, ks_type_reserved = 0x0F, -} ; +} keystroke_type_t ; + CONFIRM(ks_type_count <= ks_type_reserved) ; -enum keystroke_null +typedef enum keystroke_null { knull_not_eof, - knull_eof -}; + knull_eof, + knull_timed_out, +} keystroke_null_t ; -enum keystroke_flags +typedef enum keystroke_flags { + kf_null = 0, + kf_compound = 0x80, /* marker on all compound characters */ kf_reserved = 0x40, @@ -73,26 +71,33 @@ enum keystroke_flags kf_flag_mask = 0x70, /* flags for the keystroke */ kf_type_mask = 0x0F, /* extraction of type */ -} ; +} keystroke_flags_t ; -CONFIRM(ks_type_reserved == (enum keystroke_type)kf_type_mask) ; +/* The keystroke type and flags are designed so that they can be packed + * together as a single byte, the first of a "compound character". + */ +typedef uint8_t keystroke_compound_t ; + +CONFIRM(ks_type_reserved == (keystroke_type_t)kf_type_mask) ; +CONFIRM((kf_compound | kf_flag_mask | kf_type_mask) <= 0xFF) ; typedef struct keystroke* keystroke ; typedef struct keystroke_stream* keystroke_stream ; struct keystroke { - enum keystroke_type type ; - uint8_t flags ; /* the kf_flag_mask flags */ + keystroke_type_t type ; + keystroke_flags_t flags ; /* just the kf_flag_mask bits */ uint32_t value ; unsigned len ; uint8_t buf[keystroke_max_len] ; } ; +typedef struct keystroke keystroke_t[1] ; -#define keystroke_iac_callback_args void* context, keystroke stroke -typedef bool (keystroke_callback)(keystroke_iac_callback_args) ; +#define keystroke_callback_args void* context, keystroke stroke +typedef bool (keystroke_callback)(keystroke_callback_args) ; /* Telnet commands/options */ enum tn_Command @@ -170,25 +175,21 @@ enum tn_Option /*============================================================================== * Functions */ -extern keystroke_stream -keystroke_stream_new(uint8_t csi_char, keystroke_callback* iac_callback, - void* iac_callback_context) ; - -extern void -keystroke_stream_set_eof(keystroke_stream stream) ; - -extern keystroke_stream -keystroke_stream_free(keystroke_stream stream) ; - -extern bool -keystroke_stream_empty(keystroke_stream stream) ; -extern bool -keystroke_stream_eof(keystroke_stream stream) ; - -extern void -keystroke_input(keystroke_stream stream, uint8_t* ptr, size_t len, - keystroke steal) ; -extern int -keystroke_get(keystroke_stream stream, keystroke stroke) ; +extern keystroke_stream keystroke_stream_new(uint8_t csi_char, + const char* interrupts, + keystroke_callback* callback, void* callback_context) ; + +extern void keystroke_stream_set_eof(keystroke_stream stream, bool timed_out) ; + +extern keystroke_stream keystroke_stream_free(keystroke_stream stream) ; + +extern bool keystroke_get(keystroke_stream stream, keystroke stroke) ; +extern bool keystroke_steal(keystroke_stream stream, keystroke stroke) ; +extern void keystroke_steal_clear(keystroke_stream stream) ; +extern bool keystroke_stream_empty(keystroke_stream stream) ; +extern bool keystroke_stream_at_eof(keystroke_stream stream) ; +extern bool keystroke_stream_met_eof(keystroke_stream stream) ; + +extern void keystroke_input(keystroke_stream stream, uint8_t* ptr, int len) ; #endif /* _ZEBRA_KEYSTROKE_H */ |