dynui.h File Reference

Dynamic user interfaces. More...

#include <ipxe/list.h>

Go to the source code of this file.

Data Structures
struct	dynamic_ui
	A dynamic user interface. More...
struct	dynamic_item
	A dynamic user interface item. More...

Macros
#define	DYNUI_DEFAULT   0x0001
	Dynamic user interface item is default selection. More...
#define	DYNUI_SECRET   0x0002
	Dynamic user interface item represents a secret. More...

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
struct dynamic_ui *	create_dynui (const char *name, const char *title)
	Create dynamic user interface. More...
struct dynamic_item *	add_dynui_item (struct dynamic_ui *dynui, const char *name, const char *text, unsigned int flags, int shortcut)
	Add dynamic user interface item. More...
void	destroy_dynui (struct dynamic_ui *dynui)
	Destroy dynamic user interface. More...
struct dynamic_ui *	find_dynui (const char *name)
	Find dynamic user interface. More...
struct dynamic_item *	dynui_item (struct dynamic_ui *dynui, unsigned int index)
	Find dynamic user interface item by index. More...
struct dynamic_item *	dynui_shortcut (struct dynamic_ui *dynui, int key)
	Find dynamic user interface item by shortcut key. More...
int	show_menu (struct dynamic_ui *dynui, unsigned long timeout, unsigned long retimeout, const char *select, struct dynamic_item **selected)
	Show menu. More...
int	show_form (struct dynamic_ui *dynui)
	Show form. More...

Detailed Description

Dynamic user interfaces.

Definition in file dynui.h.

Macro Definition Documentation

DYNUI_DEFAULT

#define DYNUI_DEFAULT   0x0001

Dynamic user interface item is default selection.

Definition at line 46 of file dynui.h.

DYNUI_SECRET

#define DYNUI_SECRET   0x0002

Dynamic user interface item represents a secret.

Definition at line 49 of file dynui.h.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

create_dynui()

struct dynamic_ui* create_dynui	(	const char *	name,
		const char *	title
	)

Create dynamic user interface.

Parameters

name	User interface name, or NULL
title	User interface title, or NULL

Return values

dynui

Dynamic user interface, or NULL on failure

Definition at line 49 of file dynui.c.

                                                                         {
        struct dynamic_ui *dynui;
        size_t name_len;
        size_t title_len;
        size_t len;
        char *name_copy;
        char *title_copy;

        /* Destroy any existing user interface of this name */
        dynui = find_dynui ( name );
        if ( dynui )
                destroy_dynui ( dynui );

        /* Use empty title if none given */
        if ( ! title )
                title = "";

        /* Allocate user interface */
        name_len = ( name ? ( strlen ( name ) + 1 /* NUL */ ) : 0 );
        title_len = ( strlen ( title ) + 1 /* NUL */ );
        len = ( sizeof ( *dynui ) + name_len + title_len );
        dynui = zalloc ( len );
        if ( ! dynui )
                return NULL;
        name_copy = ( ( void * ) ( dynui + 1 ) );
        title_copy = ( name_copy + name_len );

        /* Initialise user interface */
        if ( name ) {
                strcpy ( name_copy, name );
                dynui->name = name_copy;
        }
        strcpy ( title_copy, title );
        dynui->title = title_copy;
        INIT_LIST_HEAD ( &dynui->items );

        /* Add to list of user interfaces */
        list_add_tail ( &dynui->list, &dynamic_uis );

        DBGC ( dynui, "DYNUI %s created with title \"%s\"\n",
               dynui->name, dynui->title );

        return dynui;
}

References DBGC, destroy_dynui(), find_dynui(), INIT_LIST_HEAD, dynamic_ui::items, len, dynamic_ui::list, list_add_tail, dynamic_ui::name, name, NULL, strcpy(), strlen(), dynamic_ui::title, and zalloc().

Referenced by dynui_exec().

add_dynui_item()

struct dynamic_item* add_dynui_item	(	struct dynamic_ui *	dynui,
		const char *	name,
		const char *	text,
		unsigned int	flags,
		int	shortcut
	)

Add dynamic user interface item.

Parameters

dynui	Dynamic user interface
name	Name, or NULL
text	Text, or NULL
flags	Flags
shortcut	Shortcut key

Return values

item	User interface item, or NULL on failure

Definition at line 104 of file dynui.c.

                                                                          {
        struct dynamic_item *item;
        size_t name_len;
        size_t text_len;
        size_t len;
        char *name_copy;
        char *text_copy;

        /* Use empty text if none given */
        if ( ! text )
                text = "";

        /* Allocate item */
        name_len = ( name ? ( strlen ( name ) + 1 /* NUL */ ) : 0 );
        text_len = ( strlen ( text ) + 1 /* NUL */ );
        len = ( sizeof ( *item ) + name_len + text_len );
        item = zalloc ( len );
        if ( ! item )
                return NULL;
        name_copy = ( ( void * ) ( item + 1 ) );
        text_copy = ( name_copy + name_len );

        /* Initialise item */
        if ( name ) {
                strcpy ( name_copy, name );
                item->name = name_copy;
        }
        strcpy ( text_copy, text );
        item->text = text_copy;
        item->index = dynui->count++;
        item->flags = flags;
        item->shortcut = shortcut;

        /* Add to list of items */
        list_add_tail ( &item->list, &dynui->items );

        return item;
}

References dynamic_ui::count, flags, dynamic_item::flags, dynamic_item::index, dynamic_ui::items, len, dynamic_item::list, list_add_tail, dynamic_item::name, name, NULL, dynamic_item::shortcut, strcpy(), strlen(), dynamic_item::text, and zalloc().

Referenced by item_exec().

destroy_dynui()

void destroy_dynui

(

struct dynamic_ui *

dynui

)

Destroy dynamic user interface.

Parameters

dynui

Dynamic user interface

Definition at line 150 of file dynui.c.

                                                {
        struct dynamic_item *item;
        struct dynamic_item *tmp;

        /* Remove from list of user interfaces */
        list_del ( &dynui->list );

        /* Free items */
        list_for_each_entry_safe ( item, tmp, &dynui->items, list ) {
                list_del ( &item->list );
                free ( item );
        }

        /* Free user interface */
        free ( dynui );
}

References free, dynamic_ui::items, dynamic_item::list, dynamic_ui::list, list_del, list_for_each_entry_safe, and tmp.

Referenced by choose_exec(), create_dynui(), dynui_exec(), and present_exec().

find_dynui()

struct dynamic_ui* find_dynui

(

const char *

name

)

Find dynamic user interface.

Parameters

name	User interface name, or NULL

Return values

dynui

Dynamic user interface, or NULL if not found

Definition at line 173 of file dynui.c.

                                                    {
        struct dynamic_ui *dynui;

        list_for_each_entry ( dynui, &dynamic_uis, list ) {
                if ( ( dynui->name == name ) ||
                     ( strcmp ( dynui->name, name ) == 0 ) ) {
                        return dynui;
                }
        }

        return NULL;
}

References dynamic_ui::list, list_for_each_entry, dynamic_ui::name, name, NULL, and strcmp().

Referenced by create_dynui(), and parse_dynui().

dynui_item()

struct dynamic_item* dynui_item	(	struct dynamic_ui *	dynui,
		unsigned int	index
	)

Find dynamic user interface item by index.

Parameters

dynui	Dynamic user interface
index	Index

Return values

item	User interface item, or NULL if not found

Definition at line 193 of file dynui.c.

                                                        {
        struct dynamic_item *item;

        list_for_each_entry ( item, &dynui->items, list ) {
                if ( index-- == 0 )
                        return item;
        }

        return NULL;
}

References index, dynamic_ui::items, dynamic_item::list, list_for_each_entry, and NULL.

Referenced by draw_menu_item(), and menu_loop().

dynui_shortcut()

struct dynamic_item* dynui_shortcut	(	struct dynamic_ui *	dynui,
		int	key
	)

Find dynamic user interface item by shortcut key.

Parameters

dynui	Dynamic user interface
key	Shortcut key

Return values

item	User interface item, or NULL if not found

Definition at line 212 of file dynui.c.

                                                                           {
        struct dynamic_item *item;

        list_for_each_entry ( item, &dynui->items, list ) {
                if ( key && ( key == item->shortcut ) )
                        return item;
        }

        return NULL;
}

References dynamic_ui::items, key, dynamic_item::list, list_for_each_entry, NULL, and dynamic_item::shortcut.

Referenced by form_loop(), and menu_loop().

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().

show_form()

int show_form

(

struct dynamic_ui *

dynui

)

Show form.

Parameters

dynui

Dynamic user interface

Return values

rc	Return status code

Definition at line 508 of file form_ui.c.

                                           {
        struct form *form;
        int rc;

        /* Allocate and initialise structure */
        form = alloc_form ( dynui );
        if ( ! form ) {
                rc = -ENOMEM;
                goto err_alloc;
        }

        /* Parse setting names and load current values */
        if ( ( rc = parse_names ( form ) ) != 0 )
                goto err_parse_names;
        load_values ( form );

        /* Lay out form on screen */
        if ( ( rc = layout_form ( form ) ) != 0 )
                goto err_layout;

        /* Draw initial form */
        initscr();
        start_color();
        draw_form ( form );

        /* Run main loop */
        if ( ( rc = form_loop ( form ) ) != 0 )
                goto err_loop;

 err_loop:
        color_set ( CPAIR_NORMAL, NULL );
        endwin();
 err_layout:
 err_parse_names:
        free_form ( form );
 err_alloc:
        return rc;
}

References alloc_form(), color_set, CPAIR_NORMAL, draw_form(), form::dynui, endwin(), ENOMEM, form_loop(), free_form(), initscr(), layout_form(), load_values(), NULL, parse_names(), rc, and start_color.

Referenced by login_ui(), and present_exec().