prompt.c File Reference

Prompt for keypress. More...

#include <errno.h>
#include <stdio.h>
#include <ipxe/console.h>
#include <usr/prompt.h>

Go to the source code of this file.

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
int	prompt (const char *text, unsigned long timeout, int key)
	Prompt for keypress. More...

Detailed Description

Prompt for keypress.

Definition in file prompt.c.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

prompt()

int prompt	(	const char *	text,
		unsigned long	timeout,
		int	key
	)

Prompt for keypress.

Parameters

text	Prompt string
timeout	Timeout period, in ticks (0=indefinite)
key	Key to wait for (0=any key)

Return values

rc	Return status code

Returns success if the specified key was pressed within the specified timeout period.

Definition at line 49 of file prompt.c.

                                                                {
        int key_pressed;

        /* Display prompt */
        printf ( "%s", text );

        /* Wait for key */
        key_pressed = getkey ( timeout );

        /* Clear the prompt line */
        while ( *(text++) )
                printf ( "\b \b" );

        /* Check for timeout */
        if ( key_pressed < 0 )
                return -ETIMEDOUT;

        /* Check for correct key pressed */
        if ( key && ( key_pressed != key ) )
                return -ECANCELED;

        return 0;
}

References ECANCELED, ETIMEDOUT, getkey(), key, printf(), and timeout().

Referenced by prompt_exec(), readline(), readline_history(), and shell_banner().