Special key interpretation. More...

#include <ctype.h>
#include <ipxe/console.h>
#include <ipxe/process.h>
#include <ipxe/keys.h>
#include <ipxe/timer.h>
#include <ipxe/nap.h>

Macros
#define	GETKEY_TIMEOUT ( TICKS_PER_SEC / 4 )

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)

static int	getchar_timeout (unsigned long timeout)
	Read character from console if available within timeout period. More...

int	getkey (unsigned long timeout)
	Get single keypress. More...

Detailed Description

Special key interpretation.

Definition in file getkey.c.

Macro Definition Documentation

◆ GETKEY_TIMEOUT

#define GETKEY_TIMEOUT ( TICKS_PER_SEC / 4 )

Definition at line 39 of file getkey.c.

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL )

◆ getchar_timeout()

static int getchar_timeout ( unsigned long timeout )

static

Read character from console if available within timeout period.

Parameters

timeout Timeout period, in ticks (0=indefinite)

Return values

character Character read from console

Definition at line 47 of file getkey.c.

                                                      {
         unsigned long start = currticks();
 
         while ( ( timeout == 0 ) || ( ( currticks() - start ) < timeout ) ) {
                 step();
                 if ( iskey() )
                         return getchar();
                 cpu_nap();
         }
 
         return -1;
 }

References cpu_nap(), currticks(), getchar(), iskey(), start, step(), and timeout().

Referenced by getkey().

◆ getkey()

int getkey ( unsigned long timeout )

Get single keypress.

Parameters

timeout Timeout period, in ticks (0=indefinite)

Return values

key	Key pressed

The returned key will be an ASCII value or a KEY_XXX special constant. This function differs from getchar() in that getchar() will return "special" keys (e.g. cursor keys) as a series of characters forming an ANSI escape sequence.

Definition at line 71 of file getkey.c.

                                      {
         int character;
         unsigned int n = 0;
 
         character = getchar_timeout ( timeout );
         if ( character != ESC )
                 return character;
 
         character = getchar_timeout ( GETKEY_TIMEOUT );
         if ( character < 0 )
                 return ESC;
 
         if ( isalpha ( character ) )
                 return ( toupper ( character ) - 'A' + 1 );
 
         while ( ( character = getchar_timeout ( GETKEY_TIMEOUT ) ) >= 0 ) {
                 if ( isdigit ( character ) ) {
                         n = ( ( n * 10 ) + ( character - '0' ) );
                         continue;
                 }
                 if ( character >= 0x40 )
                         return KEY_ANSI ( n, character );
         }
 
         return ESC;
 }

References ESC, getchar_timeout(), GETKEY_TIMEOUT, isalpha(), isdigit(), KEY_ANSI, timeout(), and toupper().

Referenced by bios_inject(), form_loop(), main_loop(), menu_loop(), prompt(), pxe_menu_prompt_and_select(), pxe_menu_select(), and readline_history().

Macros