iPXE
keys.h
Go to the documentation of this file.
1 #ifndef _IPXE_KEYS_H
2 #define _IPXE_KEYS_H
3 
4 /** @file
5  *
6  * Key definitions
7  *
8  */
9 
10 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
11 
12 /*
13  * Symbolic names for some standard ASCII characters
14  *
15  */
16 
17 #define NUL 0x00
18 #define CTRL_A 0x01
19 #define CTRL_B 0x02
20 #define CTRL_C 0x03
21 #define CTRL_D 0x04
22 #define CTRL_E 0x05
23 #define CTRL_F 0x06
24 #define CTRL_G 0x07
25 #define CTRL_H 0x08
26 #define CTRL_I 0x09
27 #define CTRL_J 0x0a
28 #define CTRL_K 0x0b
29 #define CTRL_L 0x0c
30 #define CTRL_M 0x0d
31 #define CTRL_N 0x0e
32 #define CTRL_O 0x0f
33 #define CTRL_P 0x10
34 #define CTRL_Q 0x11
35 #define CTRL_R 0x12
36 #define CTRL_S 0x13
37 #define CTRL_T 0x14
38 #define CTRL_U 0x15
39 #define CTRL_V 0x16
40 #define CTRL_W 0x17
41 #define CTRL_X 0x18
42 #define CTRL_Y 0x19
43 #define CTRL_Z 0x1a
44 
45 #define BACKSPACE CTRL_H
46 #define TAB CTRL_I
47 #define LF CTRL_J
48 #define CR CTRL_M
49 #define ESC 0x1b
50 
51 /*
52  * Special keys outside the normal Unicode range
53  *
54  * The names are chosen to match those used by curses. The values are
55  * chosen to facilitate easy conversion from a received ANSI escape
56  * sequence to a KEY_XXX constant.
57  *
58  * Note that the values are exposed to iPXE commands via parse_key()
59  * and therefore may not be changed without breaking existing scripts.
60  */
61 
62 /**
63  * Minimum value for special keypresses
64  *
65  * This value is chosen to lie above the maximum Unicode code point
66  * value 0x10ffff.
67  */
68 #define KEY_MIN 0x110000
69 
70 /**
71  * Construct relative key value for special key
72  *
73  * @v key Key value
74  * @ret rkey Relative key value
75  */
76 #define KEY_REL( key ) ( (key) - KEY_MIN )
77 
78 /**
79  * Construct ANSI escape sequence key value
80  *
81  * @v n ANSI escape sequence numeric portion, or 0 for none
82  * @v terminator ANSI escape sequence terminating character
83  * @ret key Key value
84  */
85 #define KEY_ANSI( n, terminator ) \
86  ( KEY_MIN + ( ( (n) + 1 ) << 8 ) + (terminator) )
87 
88 /**
89  * Extract ANSI escape sequence numeric portion
90  *
91  * @v key Key value (or relative key value)
92  * @ret n ANSI escape sequence numeric portion, or 0 for none
93  */
94 #define KEY_ANSI_N( key ) ( ( ( (key) >> 8 ) & 0xff ) - 1 )
95 
96 /**
97  * Extract ANSI escape sequence terminating character
98  *
99  * @v key Key value (or relative key value)
100  * @ret terminator ANSI escape sequence terminating character
101  */
102 #define KEY_ANSI_TERMINATOR( key ) ( (key) & 0xff )
103 
104 #define KEY_UP KEY_ANSI ( 0, 'A' ) /**< Up arrow */
105 #define KEY_DOWN KEY_ANSI ( 0, 'B' ) /**< Down arrow */
106 #define KEY_RIGHT KEY_ANSI ( 0, 'C' ) /**< Right arrow */
107 #define KEY_LEFT KEY_ANSI ( 0, 'D' ) /**< Left arrow */
108 #define KEY_END KEY_ANSI ( 0, 'F' ) /**< End */
109 #define KEY_HOME KEY_ANSI ( 0, 'H' ) /**< Home */
110 #define KEY_IC KEY_ANSI ( 2, '~' ) /**< Insert */
111 #define KEY_DC KEY_ANSI ( 3, '~' ) /**< Delete */
112 #define KEY_PPAGE KEY_ANSI ( 5, '~' ) /**< Page up */
113 #define KEY_NPAGE KEY_ANSI ( 6, '~' ) /**< Page down */
114 #define KEY_F5 KEY_ANSI ( 15, '~' ) /**< F5 */
115 #define KEY_F6 KEY_ANSI ( 17, '~' ) /**< F6 */
116 #define KEY_F7 KEY_ANSI ( 18, '~' ) /**< F7 */
117 #define KEY_F8 KEY_ANSI ( 19, '~' ) /**< F8 (for PXE) */
118 #define KEY_F9 KEY_ANSI ( 20, '~' ) /**< F9 */
119 #define KEY_F10 KEY_ANSI ( 21, '~' ) /**< F10 */
120 #define KEY_F11 KEY_ANSI ( 23, '~' ) /**< F11 */
121 #define KEY_F12 KEY_ANSI ( 24, '~' ) /**< F12 */
122 
123 /* Not in the [KEY_MIN,KEY_MAX] range; terminals seem to send these as
124  * normal ASCII values.
125  */
126 #define KEY_BACKSPACE BACKSPACE
127 #define KEY_ENTER LF
128 
129 #endif /* _IPXE_KEYS_H */
FILE_LICENCE(GPL2_OR_LATER_OR_UBDL)