dynui.c File Reference

Dynamic user interfaces. More...

#include <stdlib.h>
#include <string.h>
#include <assert.h>
#include <ipxe/list.h>
#include <ipxe/dynui.h>

Go to the source code of this file.

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
static	LIST_HEAD (dynamic_uis)
	List of all dynamic user interfaces. More...
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...

Detailed Description

Dynamic user interfaces.

Definition in file dynui.c.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

LIST_HEAD()

static LIST_HEAD ( dynamic_uis  )

static

List of all dynamic user interfaces.

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