menu_ui.c File Reference

Menu interface. More...

#include <string.h>
#include <errno.h>
#include <curses.h>
#include <ipxe/keys.h>
#include <ipxe/timer.h>
#include <ipxe/console.h>
#include <ipxe/ansicol.h>
#include <ipxe/jumpscroll.h>
#include <ipxe/dynui.h>

Go to the source code of this file.

Data Structures
struct	menu_ui
	A menu user interface. More...

Macros
#define	TITLE_ROW   1U
#define	MENU_ROW   3U
#define	MENU_COL   1U
#define	MENU_ROWS   ( LINES - 2U - MENU_ROW )
#define	MENU_COLS   ( COLS - 2U )
#define	MENU_PAD   2U

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
static void	draw_menu_item (struct menu_ui *ui, unsigned int index)
	Draw a numbered menu item. More...
static void	draw_menu_items (struct menu_ui *ui)
	Draw the current block of menu items. More...
static int	menu_loop (struct menu_ui *ui, struct dynamic_item **selected)
	Menu main loop. More...
int	show_menu (struct dynamic_ui *dynui, unsigned long timeout, unsigned long retimeout, const char *select, struct dynamic_item **selected)
	Show menu. More...

Detailed Description

Menu interface.

Definition in file menu_ui.c.

Macro Definition Documentation

TITLE_ROW

#define TITLE_ROW   1U

Definition at line 44 of file menu_ui.c.

MENU_ROW

#define MENU_ROW   3U

Definition at line 45 of file menu_ui.c.

MENU_COL

#define MENU_COL   1U

Definition at line 46 of file menu_ui.c.

MENU_ROWS

#define MENU_ROWS   ( LINES - 2U - MENU_ROW )

Definition at line 47 of file menu_ui.c.

MENU_COLS

#define MENU_COLS   ( COLS - 2U )

Definition at line 48 of file menu_ui.c.

MENU_PAD

#define MENU_PAD   2U

Definition at line 49 of file menu_ui.c.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

draw_menu_item()

static void draw_menu_item ( struct menu_ui *  ui, unsigned int  index  )

static

Draw a numbered menu item.

Parameters

ui	Menu user interface
index	Index

Definition at line 69 of file menu_ui.c.

                                                                      {
        struct dynamic_item *item;
        unsigned int row_offset;
        char buf[ MENU_COLS + 1 /* NUL */ ];
        char timeout_buf[6]; /* "(xxx)" + NUL */
        size_t timeout_len;
        size_t max_len;
        size_t len;

        /* Move to start of row */
        row_offset = ( index - ui->scroll.first );
        move ( ( MENU_ROW + row_offset ), MENU_COL );

        /* Get menu item */
        item = dynui_item ( ui->dynui, index );
        if ( item ) {

                /* Draw separators in a different colour */
                if ( ! item->name )
                        color_set ( CPAIR_SEPARATOR, NULL );

                /* Highlight if this is the selected item */
                if ( index == ui->scroll.current ) {
                        color_set ( CPAIR_SELECT, NULL );
                        attron ( A_BOLD );
                }

                /* Construct row */
                memset ( buf, ' ', ( sizeof ( buf ) - 1 ) );
                buf[ sizeof ( buf ) -1 ] = '\0';
                len = strlen ( item->text );
                max_len = ( sizeof ( buf ) - 1 /* NUL */ - ( 2 * MENU_PAD ) );
                if ( len > max_len )
                        len = max_len;
                memcpy ( ( buf + MENU_PAD ), item->text, len );

                /* Add timeout if applicable */
                timeout_len =
                        snprintf ( timeout_buf, sizeof ( timeout_buf ), "(%ld)",
                                   ( ( ui->timeout + TICKS_PER_SEC - 1 ) /
                                     TICKS_PER_SEC ) );
                if ( ( index == ui->scroll.current ) && ( ui->timeout != 0 ) ) {
                        memcpy ( ( buf + MENU_COLS - MENU_PAD - timeout_len ),
                                 timeout_buf, timeout_len );
                }

                /* Print row */
                printw ( "%s", buf );

                /* Reset attributes */
                color_set ( CPAIR_NORMAL, NULL );
                attroff ( A_BOLD );

        } else {
                /* Clear row if there is no corresponding menu item */
                clrtoeol();
        }

        /* Move cursor back to start of row */
        move ( ( MENU_ROW + row_offset ), MENU_COL );
}

References A_BOLD, attroff(), attron(), clrtoeol(), color_set, CPAIR_NORMAL, CPAIR_SELECT, CPAIR_SEPARATOR, jump_scroller::current, menu_ui::dynui, dynui_item(), jump_scroller::first, index, len, memcpy(), memset(), MENU_COL, MENU_COLS, MENU_PAD, MENU_ROW, move(), dynamic_item::name, NULL, printw(), menu_ui::scroll, snprintf(), strlen(), dynamic_item::text, TICKS_PER_SEC, and menu_ui::timeout.

Referenced by draw_menu_items(), menu_loop(), and show_menu().

draw_menu_items()

static void draw_menu_items ( struct menu_ui *  ui )

static

Draw the current block of menu items.

Parameters

ui	Menu user interface

Definition at line 136 of file menu_ui.c.

                                                   {
        unsigned int i;

        /* Draw ellipses before and/or after the list as necessary */
        color_set ( CPAIR_SEPARATOR, NULL );
        mvaddstr ( ( MENU_ROW - 1 ), ( MENU_COL + MENU_PAD ),
                   ( jump_scroll_is_first ( &ui->scroll ) ? "   " : "..." ) );
        mvaddstr ( ( MENU_ROW + MENU_ROWS ), ( MENU_COL + MENU_PAD ),
                   ( jump_scroll_is_last ( &ui->scroll ) ? "   " : "..." ) );
        color_set ( CPAIR_NORMAL, NULL );

        /* Draw visible items */
        for ( i = 0 ; i < MENU_ROWS ; i++ )
                draw_menu_item ( ui, ( ui->scroll.first + i ) );
}

References color_set, CPAIR_NORMAL, CPAIR_SEPARATOR, draw_menu_item(), jump_scroller::first, jump_scroll_is_first(), jump_scroll_is_last(), MENU_COL, MENU_PAD, MENU_ROW, MENU_ROWS, mvaddstr(), NULL, and menu_ui::scroll.

Referenced by menu_loop(), and show_menu().

menu_loop()

static int menu_loop ( struct menu_ui *  ui, struct dynamic_item **  selected  )

static

Menu main loop.

Parameters

ui	Menu user interface

Return values

selected	Selected item
rc	Return status code

Definition at line 159 of file menu_ui.c.

                                                                            {
        struct dynamic_item *item;
        unsigned long timeout;
        unsigned int previous;
        unsigned int move;
        int key;
        int chosen = 0;
        int rc = 0;

        do {
                /* Record current selection */
                previous = ui->scroll.current;

                /* Calculate timeout as remainder of current second */
                timeout = ( ui->timeout % TICKS_PER_SEC );
                if ( ( timeout == 0 ) && ( ui->timeout != 0 ) )
                        timeout = TICKS_PER_SEC;
                ui->timeout -= timeout;

                /* Get key */
                move = SCROLL_NONE;
                key = getkey ( timeout );
                if ( key < 0 ) {
                        /* Choose default if we finally time out */
                        if ( ui->timeout == 0 )
                                chosen = 1;
                } else {
                        /* Reset timeout after activity */
                        ui->timeout = ui->retimeout;

                        /* Handle scroll keys */
                        move = jump_scroll_key ( &ui->scroll, key );

                        /* Handle other keys */
                        switch ( key ) {
                        case ESC:
                        case CTRL_C:
                                rc = -ECANCELED;
                                break;
                        case CR:
                        case LF:
                                chosen = 1;
                                break;
                        default:
                                item = dynui_shortcut ( ui->dynui, key );
                                if ( item ) {
                                        ui->scroll.current = item->index;
                                        if ( item->name ) {
                                                chosen = 1;
                                        } else {
                                                move = SCROLL_DOWN;
                                        }
                                }
                                break;
                        }
                }

                /* Move selection, if applicable */
                while ( move ) {
                        move = jump_scroll_move ( &ui->scroll, move );
                        item = dynui_item ( ui->dynui, ui->scroll.current );
                        if ( item->name )
                                break;
                }

                /* Redraw selection if necessary */
                if ( ( ui->scroll.current != previous ) || ( timeout != 0 ) ) {
                        draw_menu_item ( ui, previous );
                        if ( jump_scroll ( &ui->scroll ) )
                                draw_menu_items ( ui );
                        draw_menu_item ( ui, ui->scroll.current );
                }

                /* Record selection */
                item = dynui_item ( ui->dynui, ui->scroll.current );
                assert ( item != NULL );
                assert ( item->name != NULL );
                *selected = item;

        } while ( ( rc == 0 ) && ! chosen );

        return rc;
}

References assert(), CR, CTRL_C, jump_scroller::current, draw_menu_item(), draw_menu_items(), menu_ui::dynui, dynui_item(), dynui_shortcut(), ECANCELED, ESC, getkey(), dynamic_item::index, jump_scroll(), jump_scroll_key(), jump_scroll_move(), key, LF, move(), dynamic_item::name, NULL, rc, menu_ui::retimeout, menu_ui::scroll, SCROLL_DOWN, SCROLL_NONE, TICKS_PER_SEC, menu_ui::timeout, and timeout().

Referenced by show_menu().

show_menu()

int show_menu	(	struct dynamic_ui *	dynui,
		unsigned long	timeout,
		unsigned long	retimeout,
		const char *	select,
		struct dynamic_item **	selected
	)

Show menu.

Parameters

dynui	Dynamic user interface
timeout	Initial timeout period, in ticks (0=indefinite)
retimeout	Post-activity timeout period, in ticks (0=indefinite)

Return values

selected	Selected item
rc	Return status code

Definition at line 252 of file menu_ui.c.

                                                 {
        struct dynamic_item *item;
        struct menu_ui ui;
        char buf[ MENU_COLS + 1 /* NUL */ ];
        int named_count = 0;
        int rc;

        /* Initialise UI */
        memset ( &ui, 0, sizeof ( ui ) );
        ui.dynui = dynui;
        ui.scroll.rows = MENU_ROWS;
        ui.timeout = timeout;
        ui.retimeout = retimeout;

        list_for_each_entry ( item, &dynui->items, list ) {
                if ( item->name ) {
                        if ( ! named_count )
                                ui.scroll.current = ui.scroll.count;
                        named_count++;
                        if ( select ) {
                                if ( strcmp ( select, item->name ) == 0 )
                                        ui.scroll.current = ui.scroll.count;
                        } else {
                                if ( item->flags & DYNUI_DEFAULT )
                                        ui.scroll.current = ui.scroll.count;
                        }
                }
                ui.scroll.count++;
        }
        if ( ! named_count ) {
                /* Menus with no named items cannot be selected from,
                 * and will seriously confuse the navigation logic.
                 * Refuse to display any such menus.
                 */
                return -ENOENT;
        }

        /* Initialise screen */
        initscr();
        start_color();
        color_set ( CPAIR_NORMAL, NULL );
        curs_set ( 0 );
        erase();

        /* Draw initial content */
        attron ( A_BOLD );
        snprintf ( buf, sizeof ( buf ), "%s", ui.dynui->title );
        mvprintw ( TITLE_ROW, ( ( COLS - strlen ( buf ) ) / 2 ), "%s", buf );
        attroff ( A_BOLD );
        jump_scroll ( &ui.scroll );
        draw_menu_items ( &ui );
        draw_menu_item ( &ui, ui.scroll.current );

        /* Enter main loop */
        rc = menu_loop ( &ui, selected );
        assert ( *selected );

        /* Clear screen */
        endwin();

        return rc;
}

References A_BOLD, assert(), attroff(), attron(), color_set, COLS, jump_scroller::count, CPAIR_NORMAL, jump_scroller::current, curs_set(), draw_menu_item(), draw_menu_items(), menu_ui::dynui, DYNUI_DEFAULT, endwin(), ENOENT, erase(), dynamic_item::flags, initscr(), dynamic_ui::items, jump_scroll(), list_for_each_entry, memset(), MENU_COLS, menu_loop(), MENU_ROWS, mvprintw, dynamic_item::name, NULL, rc, menu_ui::retimeout, jump_scroller::rows, menu_ui::scroll, select(), snprintf(), start_color, strcmp(), strlen(), menu_ui::timeout, timeout(), dynamic_ui::title, and TITLE_ROW.

Referenced by choose_exec().