xref: /dpdk/lib/cmdline/cmdline_vt100.h (revision 99a2dd955fba6e4cc23b77d590a033650ced9c45)
1*99a2dd95SBruce Richardson /* SPDX-License-Identifier: BSD-3-Clause
2*99a2dd95SBruce Richardson  * Copyright(c) 2010-2014 Intel Corporation.
3*99a2dd95SBruce Richardson  * Copyright (c) 2009, Olivier MATZ <zer0@droids-corp.org>
4*99a2dd95SBruce Richardson  * All rights reserved.
5*99a2dd95SBruce Richardson  */
6*99a2dd95SBruce Richardson 
7*99a2dd95SBruce Richardson #ifndef _CMDLINE_VT100_H_
8*99a2dd95SBruce Richardson #define _CMDLINE_VT100_H_
9*99a2dd95SBruce Richardson 
10*99a2dd95SBruce Richardson #include <stdint.h>
11*99a2dd95SBruce Richardson 
12*99a2dd95SBruce Richardson #ifdef __cplusplus
13*99a2dd95SBruce Richardson extern "C" {
14*99a2dd95SBruce Richardson #endif
15*99a2dd95SBruce Richardson 
16*99a2dd95SBruce Richardson #define vt100_bell         "\007"
17*99a2dd95SBruce Richardson #define vt100_bs           "\010"
18*99a2dd95SBruce Richardson #define vt100_bs_clear     "\010 \010"
19*99a2dd95SBruce Richardson #define vt100_tab          "\011"
20*99a2dd95SBruce Richardson #define vt100_crnl         "\012\015"
21*99a2dd95SBruce Richardson #define vt100_clear_right  "\033[0K"
22*99a2dd95SBruce Richardson #define vt100_clear_left   "\033[1K"
23*99a2dd95SBruce Richardson #define vt100_clear_down   "\033[0J"
24*99a2dd95SBruce Richardson #define vt100_clear_up     "\033[1J"
25*99a2dd95SBruce Richardson #define vt100_clear_line   "\033[2K"
26*99a2dd95SBruce Richardson #define vt100_clear_screen "\033[2J"
27*99a2dd95SBruce Richardson #define vt100_up_arr       "\033\133\101"
28*99a2dd95SBruce Richardson #define vt100_down_arr     "\033\133\102"
29*99a2dd95SBruce Richardson #define vt100_right_arr    "\033\133\103"
30*99a2dd95SBruce Richardson #define vt100_left_arr     "\033\133\104"
31*99a2dd95SBruce Richardson #define vt100_multi_right  "\033\133%uC"
32*99a2dd95SBruce Richardson #define vt100_multi_left   "\033\133%uD"
33*99a2dd95SBruce Richardson #define vt100_suppr        "\033\133\063\176"
34*99a2dd95SBruce Richardson #ifndef RTE_EXEC_ENV_WINDOWS
35*99a2dd95SBruce Richardson #define vt100_home         "\033M\033E"
36*99a2dd95SBruce Richardson #else
37*99a2dd95SBruce Richardson #define vt100_home         "\033M\033[E"
38*99a2dd95SBruce Richardson #endif
39*99a2dd95SBruce Richardson #define vt100_word_left    "\033\142"
40*99a2dd95SBruce Richardson #define vt100_word_right   "\033\146"
41*99a2dd95SBruce Richardson 
42*99a2dd95SBruce Richardson /* Result of parsing : it must be synchronized with
43*99a2dd95SBruce Richardson  * cmdline_vt100_commands[] in vt100.c */
44*99a2dd95SBruce Richardson #define CMDLINE_KEY_UP_ARR 0
45*99a2dd95SBruce Richardson #define CMDLINE_KEY_DOWN_ARR 1
46*99a2dd95SBruce Richardson #define CMDLINE_KEY_RIGHT_ARR 2
47*99a2dd95SBruce Richardson #define CMDLINE_KEY_LEFT_ARR 3
48*99a2dd95SBruce Richardson #define CMDLINE_KEY_BKSPACE 4
49*99a2dd95SBruce Richardson #define CMDLINE_KEY_RETURN 5
50*99a2dd95SBruce Richardson #define CMDLINE_KEY_CTRL_A 6
51*99a2dd95SBruce Richardson #define CMDLINE_KEY_CTRL_E 7
52*99a2dd95SBruce Richardson #define CMDLINE_KEY_CTRL_K 8
53*99a2dd95SBruce Richardson #define CMDLINE_KEY_CTRL_Y 9
54*99a2dd95SBruce Richardson #define CMDLINE_KEY_CTRL_C 10
55*99a2dd95SBruce Richardson #define CMDLINE_KEY_CTRL_F 11
56*99a2dd95SBruce Richardson #define CMDLINE_KEY_CTRL_B 12
57*99a2dd95SBruce Richardson #define CMDLINE_KEY_SUPPR 13
58*99a2dd95SBruce Richardson #define CMDLINE_KEY_TAB 14
59*99a2dd95SBruce Richardson #define CMDLINE_KEY_CTRL_D 15
60*99a2dd95SBruce Richardson #define CMDLINE_KEY_CTRL_L 16
61*99a2dd95SBruce Richardson #define CMDLINE_KEY_RETURN2 17
62*99a2dd95SBruce Richardson #define CMDLINE_KEY_META_BKSPACE 18
63*99a2dd95SBruce Richardson #define CMDLINE_KEY_WLEFT 19
64*99a2dd95SBruce Richardson #define CMDLINE_KEY_WRIGHT 20
65*99a2dd95SBruce Richardson #define CMDLINE_KEY_HELP 21
66*99a2dd95SBruce Richardson #define CMDLINE_KEY_CTRL_W 22
67*99a2dd95SBruce Richardson #define CMDLINE_KEY_CTRL_P 23
68*99a2dd95SBruce Richardson #define CMDLINE_KEY_CTRL_N 24
69*99a2dd95SBruce Richardson #define CMDLINE_KEY_META_D 25
70*99a2dd95SBruce Richardson #define CMDLINE_KEY_BKSPACE2 26
71*99a2dd95SBruce Richardson 
72*99a2dd95SBruce Richardson extern const char *cmdline_vt100_commands[];
73*99a2dd95SBruce Richardson 
74*99a2dd95SBruce Richardson enum cmdline_vt100_parser_state {
75*99a2dd95SBruce Richardson 	CMDLINE_VT100_INIT,
76*99a2dd95SBruce Richardson 	CMDLINE_VT100_ESCAPE,
77*99a2dd95SBruce Richardson 	CMDLINE_VT100_ESCAPE_CSI
78*99a2dd95SBruce Richardson };
79*99a2dd95SBruce Richardson 
80*99a2dd95SBruce Richardson #define CMDLINE_VT100_BUF_SIZE 8
81*99a2dd95SBruce Richardson struct cmdline_vt100 {
82*99a2dd95SBruce Richardson 	uint8_t bufpos;
83*99a2dd95SBruce Richardson 	char buf[CMDLINE_VT100_BUF_SIZE];
84*99a2dd95SBruce Richardson 	enum cmdline_vt100_parser_state state;
85*99a2dd95SBruce Richardson };
86*99a2dd95SBruce Richardson 
87*99a2dd95SBruce Richardson /**
88*99a2dd95SBruce Richardson  * Init
89*99a2dd95SBruce Richardson  */
90*99a2dd95SBruce Richardson void vt100_init(struct cmdline_vt100 *vt);
91*99a2dd95SBruce Richardson 
92*99a2dd95SBruce Richardson /**
93*99a2dd95SBruce Richardson  * Input a new character.
94*99a2dd95SBruce Richardson  * Return -1 if the character is not part of a control sequence
95*99a2dd95SBruce Richardson  * Return -2 if c is not the last char of a control sequence
96*99a2dd95SBruce Richardson  * Else return the index in vt100_commands[]
97*99a2dd95SBruce Richardson  */
98*99a2dd95SBruce Richardson int vt100_parser(struct cmdline_vt100 *vt, char c);
99*99a2dd95SBruce Richardson 
100*99a2dd95SBruce Richardson #ifdef __cplusplus
101*99a2dd95SBruce Richardson }
102*99a2dd95SBruce Richardson #endif
103*99a2dd95SBruce Richardson 
104*99a2dd95SBruce Richardson #endif
105