dynui_cmd.c File Reference

Dynamic user interface commands. More...

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <errno.h>
#include <getopt.h>
#include <ipxe/dynui.h>
#include <ipxe/command.h>
#include <ipxe/parseopt.h>
#include <ipxe/settings.h>
#include <ipxe/features.h>

Go to the source code of this file.

Data Structures
struct	dynui_options
	"dynui" options More...
struct	item_options
	"item" options More...
struct	choose_options
	"choose" options More...
struct	present_options
	"present" options More...

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
	FEATURE (FEATURE_MISC, "Menu", DHCP_EB_FEATURE_MENU, 1)
static int	dynui_exec (int argc, char **argv)
	The "dynui" command.
static int	item_exec (int argc, char **argv)
	The "item" command.
static int	choose_exec (int argc, char **argv)
	The "choose" command.
static int	present_exec (int argc, char **argv)
	The "present" command.
	COMMAND (menu, dynui_exec)
	Dynamic user interface commands.
	COMMAND (form, dynui_exec)
	COMMAND (item, item_exec)
	COMMAND (choose, choose_exec)
	COMMAND (present, present_exec)

Variables
static struct option_descriptor	dynui_opts []
	"dynui" option list
static struct command_descriptor	dynui_cmd
	"dynui" command descriptor
static struct option_descriptor	item_opts []
	"item" option list
static struct command_descriptor	item_cmd
	"item" command descriptor
static struct option_descriptor	choose_opts []
	"choose" option list
static struct command_descriptor	choose_cmd
	"choose" command descriptor
static struct option_descriptor	present_opts []
	"present" option list
static struct command_descriptor	present_cmd
	"present" command descriptor

Detailed Description

Dynamic user interface commands.

Definition in file dynui_cmd.c.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

FEATURE()

FEATURE	(	FEATURE_MISC	,
		"Menu"	,
		DHCP_EB_FEATURE_MENU	,
		1	)

References DHCP_EB_FEATURE_MENU, and FEATURE_MISC.

dynui_exec()

int dynui_exec ( int argc, char ** argv )

static

The "dynui" command.

Parameters

argc	Argument count
argv	Argument list

Return values

rc	Return status code

Definition at line 74 of file dynui_cmd.c.

                                                {
        struct dynui_options opts;
        struct dynamic_ui *dynui;
        char *title;
        int rc;
 
        /* Parse options */
        if ( ( rc = parse_options ( argc, argv, &dynui_cmd, &opts ) ) != 0 )
                goto err_parse_options;
 
        /* Parse title */
        title = concat_args ( &argv[optind] );
        if ( ! title ) {
                rc = -ENOMEM;
                goto err_parse_title;
        }
 
        /* Create dynamic user interface */
        dynui = create_dynui ( opts.name, title );
        if ( ! dynui ) {
                rc = -ENOMEM;
                goto err_create_dynui;
        }
 
        /* Destroy dynamic user interface, if applicable */
        if ( opts.delete )
                destroy_dynui ( dynui );
 
        /* Success */
        rc = 0;
 
 err_create_dynui:
        free ( title );
 err_parse_title:
 err_parse_options:
        return rc;
}

References concat_args(), create_dynui(), destroy_dynui(), dynui_cmd, ENOMEM, free, optind, opts, parse_options(), rc, and dynamic_ui::title.

Referenced by COMMAND(), and COMMAND().

item_exec()

int item_exec ( int argc, char ** argv )

static

The "item" command.

Parameters

argc	Argument count
argv	Argument list

Return values

rc	Return status code

Definition at line 154 of file dynui_cmd.c.

                                               {
        struct item_options opts;
        struct dynamic_ui *dynui;
        struct dynamic_item *item;
        unsigned int flags = 0;
        char *name = NULL;
        char *text = NULL;
        int rc;
 
        /* Parse options */
        if ( ( rc = parse_options ( argc, argv, &item_cmd, &opts ) ) != 0 )
                goto err_parse_options;
 
        /* Parse name, if present */
        if ( ! opts.is_gap )
                name = argv[optind++]; /* May be NULL */
 
        /* Parse text, if present */
        if ( optind < argc ) {
                text = concat_args ( &argv[optind] );
                if ( ! text ) {
                        rc = -ENOMEM;
                        goto err_parse_text;
                }
        }
 
        /* Identify dynamic user interface */
        if ( ( rc = parse_dynui ( opts.dynui, &dynui ) ) != 0 )
                goto err_parse_dynui;
 
        /* Add dynamic user interface item */
        if ( opts.is_default )
                flags |= DYNUI_DEFAULT;
        if ( opts.is_secret )
                flags |= DYNUI_SECRET;
        item = add_dynui_item ( dynui, name, ( text ? text : "" ), flags,
                                opts.key );
        if ( ! item ) {
                rc = -ENOMEM;
                goto err_add_dynui_item;
        }
 
        /* Success */
        rc = 0;
 
 err_add_dynui_item:
 err_parse_dynui:
        free ( text );
 err_parse_text:
 err_parse_options:
        return rc;
}

References add_dynui_item(), concat_args(), DYNUI_DEFAULT, DYNUI_SECRET, ENOMEM, flags, free, item_cmd, name, NULL, optind, opts, parse_dynui(), parse_options(), rc, and dynamic_item::text.

Referenced by COMMAND().

choose_exec()

int choose_exec ( int argc, char ** argv )

static

The "choose" command.

Parameters

argc	Argument count
argv	Argument list

Return values

rc	Return status code

Definition at line 246 of file dynui_cmd.c.

                                                 {
        struct choose_options opts;
        struct named_setting setting;
        struct dynamic_ui *dynui;
        struct dynamic_item *item;
        int rc;
 
        /* Parse options */
        if ( ( rc = parse_options ( argc, argv, &choose_cmd, &opts ) ) != 0 )
                goto err_parse_options;
 
        /* Parse setting name */
        if ( ( rc = parse_autovivified_setting ( argv[optind],
                                                 &setting ) ) != 0 )
                goto err_parse_setting;
 
        /* Identify dynamic user interface */
        if ( ( rc = parse_dynui ( opts.dynui, &dynui ) ) != 0 )
                goto err_parse_dynui;
 
        /* Show as menu */
        if ( ( rc = show_menu ( dynui, opts.timeout, opts.retimeout,
                                opts.select, &item ) ) != 0 )
                goto err_show_menu;
 
        /* Apply default type if necessary */
        if ( ! setting.setting.type )
                setting.setting.type = &setting_type_string;
 
        /* Store setting */
        if ( ( rc = storef_setting ( setting.settings, &setting.setting,
                                     item->name ) ) != 0 ) {
                printf ( "Could not store \"%s\": %s\n",
                         setting.setting.name, strerror ( rc ) );
                goto err_store;
        }
 
        /* Success */
        rc = 0;
 
 err_store:
 err_show_menu:
        /* Destroy dynamic user interface, if applicable */
        if ( ! opts.keep )
                destroy_dynui ( dynui );
 err_parse_dynui:
 err_parse_setting:
 err_parse_options:
        return rc;
}

References choose_cmd, destroy_dynui(), dynamic_item::name, setting::name, optind, opts, parse_autovivified_setting(), parse_dynui(), parse_options(), printf(), rc, show_menu(), storef_setting(), strerror(), and setting::type.

Referenced by COMMAND().

present_exec()

int present_exec ( int argc, char ** argv )

static

The "present" command.

Parameters

argc	Argument count
argv	Argument list

Return values

rc	Return status code

Definition at line 324 of file dynui_cmd.c.

                                                  {
        struct present_options opts;
        struct dynamic_ui *dynui;
        int rc;
 
        /* Parse options */
        if ( ( rc = parse_options ( argc, argv, &present_cmd, &opts ) ) != 0 )
                goto err_parse_options;
 
        /* Identify dynamic user interface */
        if ( ( rc = parse_dynui ( opts.dynui, &dynui ) ) != 0 )
                goto err_parse_dynui;
 
        /* Show as form */
        if ( ( rc = show_form ( dynui ) ) != 0 )
                goto err_show_form;
 
        /* Success */
        rc = 0;
 
 err_show_form:
        /* Destroy dynamic user interface, if applicable */
        if ( ! opts.keep )
                destroy_dynui ( dynui );
 err_parse_dynui:
 err_parse_options:
        return rc;
}

References destroy_dynui(), opts, parse_dynui(), parse_options(), present_cmd, rc, and show_form().

Referenced by COMMAND().

COMMAND() [1/5]

COMMAND	(	menu	,
		dynui_exec	)

Dynamic user interface commands.

References dynui_exec().

COMMAND() [2/5]

COMMAND	(	form	,
		dynui_exec	)

References dynui_exec().

COMMAND() [3/5]

COMMAND	(	item	,
		item_exec	)

References item_exec().

COMMAND() [4/5]

COMMAND	(	choose	,
		choose_exec	)

References choose_exec().

COMMAND() [5/5]

COMMAND	(	present	,
		present_exec	)

References present_exec().

Variable Documentation

dynui_opts

struct option_descriptor dynui_opts[]

static

Initial value:

= {
        OPTION_DESC ( "name", 'n', required_argument,
                      struct dynui_options, name, parse_string ),
        OPTION_DESC ( "delete", 'd', no_argument,
                      struct dynui_options, delete, parse_flag ),
}

"dynui" option list

Definition at line 55 of file dynui_cmd.c.

                                               {
        OPTION_DESC ( "name", 'n', required_argument,
                      struct dynui_options, name, parse_string ),
        OPTION_DESC ( "delete", 'd', no_argument,
                      struct dynui_options, delete, parse_flag ),
};

dynui_cmd

struct command_descriptor dynui_cmd

static

Initial value:

=
        COMMAND_DESC ( struct dynui_options, dynui_opts, 0, MAX_ARGUMENTS,
                       "[<title>]" )

"dynui" command descriptor

Definition at line 63 of file dynui_cmd.c.

Referenced by dynui_exec(), and PROVIDE_REQUIRING_SYMBOL().

item_opts

struct option_descriptor item_opts[]

static

Initial value:

= {
        OPTION_DESC ( "menu", 'm', required_argument,
                      struct item_options, dynui, parse_string ),
        OPTION_DESC ( "form", 'f', required_argument,
                      struct item_options, dynui, parse_string ),
        OPTION_DESC ( "key", 'k', required_argument,
                      struct item_options, key, parse_key ),
        OPTION_DESC ( "default", 'd', no_argument,
                      struct item_options, is_default, parse_flag ),
        OPTION_DESC ( "secret", 's', no_argument,
                      struct item_options, is_secret, parse_flag ),
        OPTION_DESC ( "gap", 'g', no_argument,
                      struct item_options, is_gap, parse_flag ),
}

"item" option list

Definition at line 127 of file dynui_cmd.c.

                                              {
        OPTION_DESC ( "menu", 'm', required_argument,
                      struct item_options, dynui, parse_string ),
        OPTION_DESC ( "form", 'f', required_argument,
                      struct item_options, dynui, parse_string ),
        OPTION_DESC ( "key", 'k', required_argument,
                      struct item_options, key, parse_key ),
        OPTION_DESC ( "default", 'd', no_argument,
                      struct item_options, is_default, parse_flag ),
        OPTION_DESC ( "secret", 's', no_argument,
                      struct item_options, is_secret, parse_flag ),
        OPTION_DESC ( "gap", 'g', no_argument,
                      struct item_options, is_gap, parse_flag ),
};

item_cmd

struct command_descriptor item_cmd

static

Initial value:

=
        COMMAND_DESC ( struct item_options, item_opts, 0, MAX_ARGUMENTS,
                       "[<name> [<text>]]" )

"item" command descriptor

Definition at line 143 of file dynui_cmd.c.

Referenced by item_exec().

choose_opts

struct option_descriptor choose_opts[]

static

Initial value:

= {
        OPTION_DESC ( "menu", 'm', required_argument,
                      struct choose_options, dynui, parse_string ),
        OPTION_DESC ( "default", 'd', required_argument,
                      struct choose_options, select, parse_string ),
        OPTION_DESC ( "timeout", 't', required_argument,
                      struct choose_options, timeout, parse_timeout ),
        OPTION_DESC ( "retimeout", 'r', required_argument,
                      struct choose_options, retimeout, parse_timeout ),
        OPTION_DESC ( "keep", 'k', no_argument,
                      struct choose_options, keep, parse_flag ),
}

"choose" option list

Definition at line 222 of file dynui_cmd.c.

                                                {
        OPTION_DESC ( "menu", 'm', required_argument,
                      struct choose_options, dynui, parse_string ),
        OPTION_DESC ( "default", 'd', required_argument,
                      struct choose_options, select, parse_string ),
        OPTION_DESC ( "timeout", 't', required_argument,
                      struct choose_options, timeout, parse_timeout ),
        OPTION_DESC ( "retimeout", 'r', required_argument,
                      struct choose_options, retimeout, parse_timeout ),
        OPTION_DESC ( "keep", 'k', no_argument,
                      struct choose_options, keep, parse_flag ),
};

choose_cmd

struct command_descriptor choose_cmd

static

Initial value:

=
        COMMAND_DESC ( struct choose_options, choose_opts, 1, 1, "<setting>" )

"choose" command descriptor

Definition at line 236 of file dynui_cmd.c.

Referenced by choose_exec().

present_opts

struct option_descriptor present_opts[]

static

Initial value:

= {
        OPTION_DESC ( "form", 'f', required_argument,
                      struct present_options, dynui, parse_string ),
        OPTION_DESC ( "keep", 'k', no_argument,
                      struct present_options, keep, parse_flag ),
}

"present" option list

Definition at line 306 of file dynui_cmd.c.

                                                 {
        OPTION_DESC ( "form", 'f', required_argument,
                      struct present_options, dynui, parse_string ),
        OPTION_DESC ( "keep", 'k', no_argument,
                      struct present_options, keep, parse_flag ),
};

present_cmd

struct command_descriptor present_cmd

static

Initial value:

=
        COMMAND_DESC ( struct present_options, present_opts, 0, 0, NULL )

"present" command descriptor

Definition at line 314 of file dynui_cmd.c.

Referenced by present_exec().