keys.h

Go to the documentation of this file.

#ifndef _IPXE_KEYS_H
#define _IPXE_KEYS_H

/** @file
 *
 * Key definitions
 *
 */

FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );

/*
 * Symbolic names for some standard ASCII characters
 *
 */

#define NUL             0x00
#define CTRL_A          0x01
#define CTRL_B          0x02
#define CTRL_C          0x03
#define CTRL_D          0x04
#define CTRL_E          0x05
#define CTRL_F          0x06
#define CTRL_G          0x07
#define CTRL_H          0x08
#define CTRL_I          0x09
#define CTRL_J          0x0a
#define CTRL_K          0x0b
#define CTRL_L          0x0c
#define CTRL_M          0x0d
#define CTRL_N          0x0e
#define CTRL_O          0x0f
#define CTRL_P          0x10
#define CTRL_Q          0x11
#define CTRL_R          0x12
#define CTRL_S          0x13
#define CTRL_T          0x14
#define CTRL_U          0x15
#define CTRL_V          0x16
#define CTRL_W          0x17
#define CTRL_X          0x18
#define CTRL_Y          0x19
#define CTRL_Z          0x1a

#define BACKSPACE       CTRL_H
#define TAB             CTRL_I
#define LF              CTRL_J
#define CR              CTRL_M
#define ESC             0x1b

/*
 * Special keys outside the normal Unicode range
 *
 * The names are chosen to match those used by curses.  The values are
 * chosen to facilitate easy conversion from a received ANSI escape
 * sequence to a KEY_XXX constant.
 *
 * Note that the values are exposed to iPXE commands via parse_key()
 * and therefore may not be changed without breaking existing scripts.
 */

/**
 * Minimum value for special keypresses
 *
 * This value is chosen to lie above the maximum Unicode code point
 * value 0x10ffff.
 */
#define KEY_MIN         0x110000

/**
 * Construct relative key value for special key
 *
 * @v key               Key value
 * @ret rkey            Relative key value
 */
#define KEY_REL( key ) ( (key) - KEY_MIN )

/**
 * Construct ANSI escape sequence key value
 *
 * @v n                 ANSI escape sequence numeric portion, or 0 for none
 * @v terminator        ANSI escape sequence terminating character
 * @ret key             Key value
 */
#define KEY_ANSI( n, terminator ) \
        ( KEY_MIN + ( ( (n) + 1 ) << 8 ) + (terminator) )

/**
 * Extract ANSI escape sequence numeric portion
 *
 * @v key               Key value (or relative key value)
 * @ret n               ANSI escape sequence numeric portion, or 0 for none
 */
#define KEY_ANSI_N( key ) ( ( ( (key) >> 8 ) & 0xff ) - 1 )

/**
 * Extract ANSI escape sequence terminating character
 *
 * @v key               Key value (or relative key value)
 * @ret terminator      ANSI escape sequence terminating character
 */
#define KEY_ANSI_TERMINATOR( key ) ( (key) & 0xff )

#define KEY_UP          KEY_ANSI ( 0, 'A' )     /**< Up arrow */
#define KEY_DOWN        KEY_ANSI ( 0, 'B' )     /**< Down arrow */
#define KEY_RIGHT       KEY_ANSI ( 0, 'C' )     /**< Right arrow */
#define KEY_LEFT        KEY_ANSI ( 0, 'D' )     /**< Left arrow */
#define KEY_END         KEY_ANSI ( 0, 'F' )     /**< End */
#define KEY_HOME        KEY_ANSI ( 0, 'H' )     /**< Home */
#define KEY_IC          KEY_ANSI ( 2, '~' )     /**< Insert */
#define KEY_DC          KEY_ANSI ( 3, '~' )     /**< Delete */
#define KEY_PPAGE       KEY_ANSI ( 5, '~' )     /**< Page up */
#define KEY_NPAGE       KEY_ANSI ( 6, '~' )     /**< Page down */
#define KEY_F5          KEY_ANSI ( 15, '~' )    /**< F5 */
#define KEY_F6          KEY_ANSI ( 17, '~' )    /**< F6 */
#define KEY_F7          KEY_ANSI ( 18, '~' )    /**< F7 */
#define KEY_F8          KEY_ANSI ( 19, '~' )    /**< F8 (for PXE) */
#define KEY_F9          KEY_ANSI ( 20, '~' )    /**< F9 */
#define KEY_F10         KEY_ANSI ( 21, '~' )    /**< F10 */
#define KEY_F11         KEY_ANSI ( 23, '~' )    /**< F11 */
#define KEY_F12         KEY_ANSI ( 24, '~' )    /**< F12 */

/* Not in the [KEY_MIN,KEY_MAX] range; terminals seem to send these as
 * normal ASCII values.
 */
#define KEY_BACKSPACE   BACKSPACE
#define KEY_ENTER       LF

#endif /* _IPXE_KEYS_H */