diff options
author | Michael Brown <mcb30@ipxe.org> | 2024-06-18 15:17:03 -0700 |
---|---|---|
committer | Michael Brown <mcb30@ipxe.org> | 2024-06-18 15:17:03 -0700 |
commit | 76e0933d781474acf52000cba0afaebe32361667 (patch) | |
tree | 7dd18decf7175080a9e086a583574571efbd192d | |
parent | bf98eae5daeb0b9281562e70fdf3768a629adde8 (diff) | |
download | ipxe-76e0933d781474acf52000cba0afaebe32361667.tar.gz |
[hci] Rename "item" command's first parameter from "label" to "name"
Switch terminology for the "item" command from "item <label> <text>"
to "item <name> <text>", in preparation for repurposing the "item"
command to cover interactive forms as well as menus.
Since this renaming affects only a positional parameter, it does not
break compatibility with any existing scripts.
Signed-off-by: Michael Brown <mcb30@ipxe.org>
-rw-r--r-- | src/core/menu.c | 22 | ||||
-rw-r--r-- | src/hci/commands/menu_cmd.c | 12 | ||||
-rw-r--r-- | src/hci/tui/menu_ui.c | 26 | ||||
-rw-r--r-- | src/include/ipxe/menu.h | 6 |
4 files changed, 33 insertions, 33 deletions
diff --git a/src/core/menu.c b/src/core/menu.c index ab5b0c7f5..b9d0d5b77 100644 --- a/src/core/menu.c +++ b/src/core/menu.c @@ -94,20 +94,20 @@ struct menu * create_menu ( const char *name, const char *title ) { * Add menu item * * @v menu Menu - * @v label Label, or NULL + * @v name Name, or NULL * @v text Text, or NULL * @v shortcut Shortcut key * @v is_default Item is the default item * @ret item Menu item, or NULL on failure */ -struct menu_item * add_menu_item ( struct menu *menu, const char *label, +struct menu_item * add_menu_item ( struct menu *menu, const char *name, const char *text, int shortcut, int is_default ) { - size_t label_len; + size_t name_len; size_t text_len; size_t len; struct menu_item *item; - char *label_copy; + char *name_copy; char *text_copy; /* Use empty text if none given */ @@ -115,19 +115,19 @@ struct menu_item * add_menu_item ( struct menu *menu, const char *label, text = ""; /* Allocate item */ - label_len = ( label ? ( strlen ( label ) + 1 /* NUL */ ) : 0 ); + name_len = ( name ? ( strlen ( name ) + 1 /* NUL */ ) : 0 ); text_len = ( strlen ( text ) + 1 /* NUL */ ); - len = ( sizeof ( *item ) + label_len + text_len ); + len = ( sizeof ( *item ) + name_len + text_len ); item = zalloc ( len ); if ( ! item ) return NULL; - label_copy = ( ( void * ) ( item + 1 ) ); - text_copy = ( label_copy + label_len ); + name_copy = ( ( void * ) ( item + 1 ) ); + text_copy = ( name_copy + name_len ); /* Initialise item */ - if ( label ) { - strcpy ( label_copy, label ); - item->label = label_copy; + if ( name ) { + strcpy ( name_copy, name ); + item->name = name_copy; } strcpy ( text_copy, text ); item->text = text_copy; diff --git a/src/hci/commands/menu_cmd.c b/src/hci/commands/menu_cmd.c index 76bce8695..8b6d2a9f1 100644 --- a/src/hci/commands/menu_cmd.c +++ b/src/hci/commands/menu_cmd.c @@ -135,7 +135,7 @@ static struct option_descriptor item_opts[] = { /** "item" command descriptor */ static struct command_descriptor item_cmd = COMMAND_DESC ( struct item_options, item_opts, 0, MAX_ARGUMENTS, - "[<label> [<text>]]" ); + "[<name> [<text>]]" ); /** * The "item" command @@ -148,7 +148,7 @@ static int item_exec ( int argc, char **argv ) { struct item_options opts; struct menu *menu; struct menu_item *item; - char *label = NULL; + char *name = NULL; char *text = NULL; int rc; @@ -156,9 +156,9 @@ static int item_exec ( int argc, char **argv ) { if ( ( rc = parse_options ( argc, argv, &item_cmd, &opts ) ) != 0 ) goto err_parse_options; - /* Parse label, if present */ + /* Parse name, if present */ if ( ! opts.is_gap ) - label = argv[optind++]; /* May be NULL */ + name = argv[optind++]; /* May be NULL */ /* Parse text, if present */ if ( optind < argc ) { @@ -174,7 +174,7 @@ static int item_exec ( int argc, char **argv ) { goto err_parse_menu; /* Add menu item */ - item = add_menu_item ( menu, label, ( text ? text : "" ), + item = add_menu_item ( menu, name, ( text ? text : "" ), opts.key, opts.is_default ); if ( ! item ) { rc = -ENOMEM; @@ -257,7 +257,7 @@ static int choose_exec ( int argc, char **argv ) { /* Store setting */ if ( ( rc = storef_setting ( setting.settings, &setting.setting, - item->label ) ) != 0 ) { + item->name ) ) != 0 ) { printf ( "Could not store \"%s\": %s\n", setting.setting.name, strerror ( rc ) ); goto err_store; diff --git a/src/hci/tui/menu_ui.c b/src/hci/tui/menu_ui.c index f9dd9d100..cac61a7da 100644 --- a/src/hci/tui/menu_ui.c +++ b/src/hci/tui/menu_ui.c @@ -99,7 +99,7 @@ static void draw_menu_item ( struct menu_ui *ui, unsigned int index ) { if ( item ) { /* Draw separators in a different colour */ - if ( ! item->label ) + if ( ! item->name ) color_set ( CPAIR_SEPARATOR, NULL ); /* Highlight if this is the selected item */ @@ -225,7 +225,7 @@ static int menu_loop ( struct menu_ui *ui, struct menu_item **selected ) { continue; } ui->scroll.current = i; - if ( item->label ) { + if ( item->name ) { chosen = 1; } else { move = +1; @@ -239,7 +239,7 @@ static int menu_loop ( struct menu_ui *ui, struct menu_item **selected ) { while ( move ) { move = jump_scroll_move ( &ui->scroll, move ); item = menu_item ( ui->menu, ui->scroll.current ); - if ( item->label ) + if ( item->name ) break; } @@ -254,7 +254,7 @@ static int menu_loop ( struct menu_ui *ui, struct menu_item **selected ) { /* Record selection */ item = menu_item ( ui->menu, ui->scroll.current ); assert ( item != NULL ); - assert ( item->label != NULL ); + assert ( item->name != NULL ); *selected = item; } while ( ( rc == 0 ) && ! chosen ); @@ -275,7 +275,7 @@ int show_menu ( struct menu *menu, unsigned long timeout, struct menu_item *item; struct menu_ui ui; char buf[ MENU_COLS + 1 /* NUL */ ]; - int labelled_count = 0; + int named_count = 0; int rc; /* Initialise UI */ @@ -284,12 +284,12 @@ int show_menu ( struct menu *menu, unsigned long timeout, ui.scroll.rows = MENU_ROWS; ui.timeout = timeout; list_for_each_entry ( item, &menu->items, list ) { - if ( item->label ) { - if ( ! labelled_count ) + if ( item->name ) { + if ( ! named_count ) ui.scroll.current = ui.scroll.count; - labelled_count++; + named_count++; if ( select ) { - if ( strcmp ( select, item->label ) == 0 ) + if ( strcmp ( select, item->name ) == 0 ) ui.scroll.current = ui.scroll.count; } else { if ( item->is_default ) @@ -298,10 +298,10 @@ int show_menu ( struct menu *menu, unsigned long timeout, } ui.scroll.count++; } - if ( ! labelled_count ) { - /* Menus with no labelled items cannot be selected - * from, and will seriously confuse the navigation - * logic. Refuse to display any such menus. + 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; } diff --git a/src/include/ipxe/menu.h b/src/include/ipxe/menu.h index 3cc99be48..d11a92559 100644 --- a/src/include/ipxe/menu.h +++ b/src/include/ipxe/menu.h @@ -27,8 +27,8 @@ struct menu { struct menu_item { /** List of menu items */ struct list_head list; - /** Label */ - const char *label; + /** Name */ + const char *name; /** Text */ const char *text; /** Shortcut key */ @@ -38,7 +38,7 @@ struct menu_item { }; extern struct menu * create_menu ( const char *name, const char *title ); -extern struct menu_item * add_menu_item ( struct menu *menu, const char *label, +extern struct menu_item * add_menu_item ( struct menu *menu, const char *name, const char *text, int shortcut, int is_default ); extern void destroy_menu ( struct menu *menu ); |