Option configuration console. More...

#include <stdio.h>
#include <stdarg.h>
#include <stdlib.h>
#include <unistd.h>
#include <string.h>
#include <curses.h>
#include <ipxe/console.h>
#include <ipxe/settings.h>
#include <ipxe/editbox.h>
#include <ipxe/keys.h>
#include <ipxe/ansicol.h>
#include <ipxe/jumpscroll.h>
#include <ipxe/message.h>
#include <ipxe/settings_ui.h>
#include <config/branding.h>

Data Structures
struct	settings_ui_row
	A settings user interface row. More...

struct	settings_ui
	A settings user interface. More...

Macros
#define	TITLE_ROW 1U

#define	SETTINGS_LIST_ROW 3U

#define	SETTINGS_LIST_COL 1U

#define	SETTINGS_LIST_ROWS ( LINES - 6U - SETTINGS_LIST_ROW )

#define	INFO_ROW ( LINES - 5U )

#define	ALERT_ROW ( LINES - 2U )

#define	INSTRUCTION_ROW ( LINES - 2U )

#define	INSTRUCTION_PAD " "

#define	SETTING_ROW_TEXT(cols)
	Layout of text within a setting row. More...

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)

static unsigned int	select_setting_row (struct settings_ui *ui, unsigned int index)
	Select a setting. More...

static size_t	string_copy (char dest, const char src, size_t len)
	Copy string without NUL termination. More...

static void	draw_setting_row (struct settings_ui *ui)
	Draw setting row. More...

static int	edit_setting (struct settings_ui *ui, int key)
	Edit setting ui. More...

static int	save_setting (struct settings_ui *ui)
	Save setting ui value back to configuration settings. More...

static void	draw_title_row (struct settings_ui *ui)
	Draw title row. More...

static void	draw_info_row (struct settings_ui *ui)
	Draw information row. More...

static void	draw_instruction_row (struct settings_ui *ui)
	Draw instruction row. More...

static void	draw_setting_rows (struct settings_ui *ui)
	Draw the current block of setting rows. More...

static void	select_settings (struct settings_ui ui, struct settings settings)
	Select settings block. More...

static int	main_loop (struct settings *settings)

int	settings_ui (struct settings *settings)

Detailed Description

Option configuration console.

Definition in file settings_ui.c.

Macro Definition Documentation

◆ TITLE_ROW

#define TITLE_ROW 1U

Definition at line 49 of file settings_ui.c.

◆ SETTINGS_LIST_ROW

#define SETTINGS_LIST_ROW 3U

Definition at line 50 of file settings_ui.c.

◆ SETTINGS_LIST_COL

#define SETTINGS_LIST_COL 1U

Definition at line 51 of file settings_ui.c.

◆ SETTINGS_LIST_ROWS

#define SETTINGS_LIST_ROWS ( LINES - 6U - SETTINGS_LIST_ROW )

Definition at line 52 of file settings_ui.c.

◆ INFO_ROW

#define INFO_ROW ( LINES - 5U )

Definition at line 53 of file settings_ui.c.

◆ ALERT_ROW

#define ALERT_ROW ( LINES - 2U )

Definition at line 54 of file settings_ui.c.

◆ INSTRUCTION_ROW

#define INSTRUCTION_ROW ( LINES - 2U )

Definition at line 55 of file settings_ui.c.

◆ INSTRUCTION_PAD

#define INSTRUCTION_PAD " "

Definition at line 56 of file settings_ui.c.

◆ SETTING_ROW_TEXT

#define SETTING_ROW_TEXT ( cols )

Value:

struct {                                \
        char start[0];                                                  \
        char pad1[1];                                                   \
        union {                                                         \
                struct {                                                \
                        char name[ cols - 1 - 1 - 1 - 1 - 1 ];          \
                        char pad2[1];                                   \
                } __attribute__ (( packed )) settings;                  \
                struct {                                                \
                        char name[15];                                  \
                        char pad2[1];                                   \
                        char value[ cols - 1 - 15 - 1 - 1 - 1 - 1 ];    \
                } __attribute__ (( packed )) setting;                   \
        } u;                                                            \
        char pad3[1];                                                   \
        char nul;                                                       \
} __attribute__ (( packed ))

Layout of text within a setting row.

Definition at line 59 of file settings_ui.c.

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL )

◆ select_setting_row()

static unsigned int select_setting_row	(	struct settings_ui *	ui,
		unsigned int	index
	)

static

Select a setting.

Parameters

ui	Settings user interface
index	Index of setting row

Return values

count Number of setting rows

Definition at line 121 of file settings_ui.c.

                                                               {
         SETTING_ROW_TEXT ( COLS ) *text;
         struct settings *settings;
         struct setting *setting;
         struct setting *previous = NULL;
         unsigned int count = 0;
 
         /* Free any previous setting value */
         free ( ui->row.buf );
         ui->row.buf = NULL;
 
         /* Initialise structure */
         memset ( &ui->row, 0, sizeof ( ui->row ) );
         ui->row.row = ( SETTINGS_LIST_ROW + index - ui->scroll.first );
 
         /* Include parent settings block, if applicable */
         if ( ui->settings->parent && ( count++ == index ) )
                 ui->row.settings = ui->settings->parent;
 
         /* Include any child settings blocks, if applicable */
         list_for_each_entry ( settings, &ui->settings->children, siblings ) {
                 if ( count++ == index )
                         ui->row.settings = settings;
         }
 
         /* Include any applicable settings */
         for_each_table_entry ( setting, SETTINGS ) {
 
                 /* Skip inapplicable settings */
                 if ( ! setting_applies ( ui->settings, setting ) )
                         continue;
 
                 /* Skip duplicate settings */
                 if ( previous && ( setting_cmp ( setting, previous ) == 0 ) )
                         continue;
                 previous = setting;
 
                 /* Read current setting value and origin */
                 if ( count++ == index ) {
                         fetchf_setting_copy ( ui->settings, setting,
                                               &ui->row.origin,
                                               &ui->row.setting, &ui->row.buf );
                 }
         }
 
         /* Initialise edit box */
         memset ( &ui->row.editbox, 0, sizeof ( ui->row.editbox ) );
         init_editbox ( &ui->row.editbox, ui->row.row,
                        ( SETTINGS_LIST_COL +
                          offsetof ( typeof ( *text ), u.setting.value ) ),
                        sizeof ( text->u.setting.value ), 0, &ui->row.buf );
 
         return count;
 }

References settings_ui_row::buf, settings::children, COLS, count, settings_ui_row::editbox, fetchf_setting_copy(), jump_scroller::first, for_each_table_entry, free, index, init_editbox(), list_for_each_entry, memset(), NULL, offsetof, settings_ui_row::origin, settings::parent, settings_ui_row::row, settings_ui::row, settings_ui::scroll, settings_ui_row::setting, setting_applies(), setting_cmp(), SETTING_ROW_TEXT, SETTINGS, settings_ui_row::settings, settings_ui::settings, SETTINGS_LIST_COL, SETTINGS_LIST_ROW, typeof(), and u.

Referenced by draw_setting_rows(), main_loop(), and select_settings().

◆ string_copy()

static size_t string_copy	(	char *	dest,
		const char *	src,
		size_t	len
	)

static

Copy string without NUL termination.

Parameters

dest	Destination
src	Source
len	Maximum length of destination

Return values

len	Length of (unterminated) string

Definition at line 185 of file settings_ui.c.

                                                                       {
         size_t src_len;
 
         src_len = strlen ( src );
         if ( len > src_len )
                 len = src_len;
         memcpy ( dest, src, len );
         return len;
 }

References dest, len, memcpy(), src, and strlen().

Referenced by draw_setting_row().

◆ draw_setting_row()

static void draw_setting_row ( struct settings_ui * ui )

static

Draw setting row.

Parameters

ui	Settings UI

Definition at line 200 of file settings_ui.c.

                                                         {
         SETTING_ROW_TEXT ( COLS ) text;
         unsigned int curs_offset;
         const char *value;
 
         /* Fill row with spaces */
         memset ( &text, ' ', sizeof ( text ) );
         text.nul = '\0';
 
         /* Construct row content */
         if ( ui->row.settings ) {
 
                 /* Construct space-padded name */
                 value = ( ( ui->row.settings == ui->settings->parent ) ?
                           ".." : ui->row.settings->name );
                 curs_offset = string_copy ( text.u.settings.name, value,
                                             sizeof ( text.u.settings.name ) );
                 text.u.settings.name[curs_offset] = '/';
                 curs_offset += offsetof ( typeof ( text ), u.settings );
 
         } else {
 
                 /* Construct dot-padded name */
                 memset ( text.u.setting.name, '.',
                          sizeof ( text.u.setting.name ) );
                 string_copy ( text.u.setting.name, ui->row.setting.name,
                               sizeof ( text.u.setting.name ) );
 
                 /* Construct space-padded value */
                 value = ui->row.buf;
                 if ( ! ( value && value[0] ) )
                         value = "<not specified>";
                 curs_offset = string_copy ( text.u.setting.value, value,
                                             sizeof ( text.u.setting.value ) );
                 curs_offset += offsetof ( typeof ( text ), u.setting.value );
         }
 
         /* Print row */
         if ( ( ui->row.origin == ui->settings ) || ( ui->row.settings != NULL ))
                 attron ( A_BOLD );
         mvprintw ( ui->row.row, SETTINGS_LIST_COL, "%s", text.start );
         attroff ( A_BOLD );
         move ( ui->row.row, ( SETTINGS_LIST_COL + curs_offset ) );
 }

References A_BOLD, attroff(), attron(), settings_ui_row::buf, COLS, memset(), move(), mvprintw, setting::name, settings::name, NULL, offsetof, settings_ui_row::origin, settings::parent, settings_ui_row::row, settings_ui::row, settings_ui_row::setting, SETTING_ROW_TEXT, settings_ui_row::settings, settings_ui::settings, SETTINGS_LIST_COL, string_copy(), typeof(), u, and value.

Referenced by draw_setting_rows(), and main_loop().

◆ edit_setting()

static int edit_setting	(	struct settings_ui *	ui,
		int	key
	)

static

Edit setting ui.

Parameters

ui	Settings UI
key	Key pressed by user

Return values

key	Key returned to application, or zero

Definition at line 252 of file settings_ui.c.

                                                             {
         assert ( ui->row.setting.name != NULL );
         ui->row.editing = 1;
         return edit_widget ( &ui->row.editbox.widget, key );
 }

References assert(), edit_widget(), settings_ui_row::editbox, settings_ui_row::editing, key, setting::name, NULL, settings_ui::row, settings_ui_row::setting, and edit_box::widget.

Referenced by main_loop().

◆ save_setting()

static int save_setting ( struct settings_ui * ui )

static

Save setting ui value back to configuration settings.

Parameters

ui	Settings UI

Definition at line 263 of file settings_ui.c.

                                                    {
         assert ( ui->row.setting.name != NULL );
         return storef_setting ( ui->settings, &ui->row.setting, ui->row.buf );
 }

References assert(), settings_ui_row::buf, setting::name, NULL, settings_ui::row, settings_ui_row::setting, settings_ui::settings, and storef_setting().

Referenced by main_loop().

◆ draw_title_row()

static void draw_title_row ( struct settings_ui * ui )

static

Draw title row.

Parameters

ui	Settings UI

Definition at line 273 of file settings_ui.c.

                                                       {
         const char *name;
 
         clearmsg ( TITLE_ROW );
         name = settings_name ( ui->settings );
         attron ( A_BOLD );
         msg ( TITLE_ROW, PRODUCT_SHORT_NAME " configuration settings%s%s",
               ( name[0] ? " - " : "" ), name );
         attroff ( A_BOLD );
 }

References A_BOLD, attroff(), attron(), clearmsg(), msg(), name, PRODUCT_SHORT_NAME, settings_ui::settings, settings_name(), and TITLE_ROW.

Referenced by select_settings().

◆ draw_info_row()

static void draw_info_row ( struct settings_ui * ui )

static

Draw information row.

Parameters

ui	Settings UI

Definition at line 289 of file settings_ui.c.

                                                      {
         char buf[32];
 
         /* Draw nothing unless this row represents a setting */
         clearmsg ( INFO_ROW );
         clearmsg ( INFO_ROW + 1 );
         if ( ! ui->row.setting.name )
                 return;
 
         /* Determine a suitable setting name */
         setting_name ( ( ui->row.origin ?
                          ui->row.origin : ui->settings ),
                        &ui->row.setting, buf, sizeof ( buf ) );
 
         /* Draw row */
         attron ( A_BOLD );
         msg ( INFO_ROW, "%s - %s", buf, ui->row.setting.description );
         attroff ( A_BOLD );
         color_set ( CPAIR_URL, NULL );
         msg ( ( INFO_ROW + 1 ), PRODUCT_SETTING_URI, ui->row.setting.name );
         color_set ( CPAIR_NORMAL, NULL );
 }

References A_BOLD, attroff(), attron(), clearmsg(), color_set, CPAIR_NORMAL, CPAIR_URL, setting::description, INFO_ROW, msg(), setting::name, NULL, settings_ui_row::origin, PRODUCT_SETTING_URI, settings_ui::row, settings_ui_row::setting, setting_name(), and settings_ui::settings.

Referenced by main_loop().

◆ draw_instruction_row()

static void draw_instruction_row ( struct settings_ui * ui )

static

Draw instruction row.

Parameters

ui	Settings UI

Definition at line 317 of file settings_ui.c.

                                                             {
 
         clearmsg ( INSTRUCTION_ROW );
         if ( ui->row.editing ) {
                 msg ( INSTRUCTION_ROW,
                       "Enter - accept changes" INSTRUCTION_PAD
                       "Ctrl-C - discard changes" );
         } else {
                 msg ( INSTRUCTION_ROW,
                       "%sCtrl-X - exit configuration utility",
                       ( ( ui->row.origin == ui->settings ) ?
                         "Ctrl-D - delete setting" INSTRUCTION_PAD : "" ) );
         }
 }

References clearmsg(), settings_ui_row::editing, INSTRUCTION_PAD, INSTRUCTION_ROW, msg(), settings_ui_row::origin, settings_ui::row, and settings_ui::settings.

Referenced by main_loop().

◆ draw_setting_rows()

static void draw_setting_rows ( struct settings_ui * ui )

static

Draw the current block of setting rows.

Parameters

ui	Settings UI

Definition at line 337 of file settings_ui.c.

                                                          {
         unsigned int i;
 
         /* Draw ellipses before and/or after the list as necessary */
         color_set ( CPAIR_SEPARATOR, NULL );
         mvaddstr ( ( SETTINGS_LIST_ROW - 1 ), ( SETTINGS_LIST_COL + 1 ),
                    jump_scroll_is_first ( &ui->scroll ) ? "   " : "..." );
         mvaddstr ( ( SETTINGS_LIST_ROW + SETTINGS_LIST_ROWS ),
                    ( SETTINGS_LIST_COL + 1 ),
                    jump_scroll_is_last ( &ui->scroll ) ? "   " : "..." );
         color_set ( CPAIR_NORMAL, NULL );
 
         /* Draw visible settings. */
         for ( i = 0 ; i < SETTINGS_LIST_ROWS ; i++ ) {
                 if ( ( ui->scroll.first + i ) < ui->scroll.count ) {
                         select_setting_row ( ui, ( ui->scroll.first + i ) );
                         draw_setting_row ( ui );
                 } else {
                         clearmsg ( SETTINGS_LIST_ROW + i );
                 }
         }
 }

References clearmsg(), color_set, jump_scroller::count, CPAIR_NORMAL, CPAIR_SEPARATOR, draw_setting_row(), jump_scroller::first, jump_scroll_is_first(), jump_scroll_is_last(), mvaddstr(), NULL, settings_ui::scroll, select_setting_row(), SETTINGS_LIST_COL, SETTINGS_LIST_ROW, and SETTINGS_LIST_ROWS.

Referenced by main_loop(), and select_settings().

◆ select_settings()

static void select_settings	(	struct settings_ui *	ui,
		struct settings *	settings
	)

static

Select settings block.

Parameters

ui	Settings UI
settings	Settings block

Definition at line 366 of file settings_ui.c.

                                                           {
 
         ui->settings = settings_target ( settings );
         ui->scroll.count = select_setting_row ( ui, 0 );
         ui->scroll.rows = SETTINGS_LIST_ROWS;
         ui->scroll.current = 0;
         ui->scroll.first = 0;
         draw_title_row ( ui );
         draw_setting_rows ( ui );
         select_setting_row ( ui, 0 );
 }

References jump_scroller::count, jump_scroller::current, draw_setting_rows(), draw_title_row(), jump_scroller::first, jump_scroller::rows, settings_ui::scroll, select_setting_row(), settings_ui::settings, SETTINGS_LIST_ROWS, and settings_target().

Referenced by main_loop().

◆ main_loop()

static int main_loop ( struct settings * settings )

static

Definition at line 379 of file settings_ui.c.

                                                    {
         struct settings_ui ui;
         unsigned int previous;
         unsigned int move;
         int redraw = 1;
         int key;
         int rc;
 
         /* Print initial screen content */
         color_set ( CPAIR_NORMAL, NULL );
         memset ( &ui, 0, sizeof ( ui ) );
         select_settings ( &ui, settings );
 
         while ( 1 ) {
 
                 /* Redraw rows if necessary */
                 if ( redraw ) {
                         draw_info_row ( &ui );
                         draw_instruction_row ( &ui );
                         color_set ( ( ui.row.editing ?
                                       CPAIR_EDIT : CPAIR_SELECT ), NULL );
                         draw_setting_row ( &ui );
                         color_set ( CPAIR_NORMAL, NULL );
                         curs_set ( ui.row.editing );
                         redraw = 0;
                 }
 
                 /* Edit setting, if we are currently editing */
                 if ( ui.row.editing ) {
 
                         /* Sanity check */
                         assert ( ui.row.setting.name != NULL );
 
                         /* Redraw edit box */
                         draw_widget ( &ui.row.editbox.widget );
 
                         /* Process keypress */
                         key = edit_setting ( &ui, getkey ( 0 ) );
                         switch ( key ) {
                         case CR:
                         case LF:
                                 if ( ( rc = save_setting ( &ui ) ) != 0 ) {
                                         alert ( ALERT_ROW, " %s ",
                                                 strerror ( rc ) );
                                 }
                                 /* Fall through */
                         case CTRL_C:
                                 select_setting_row ( &ui, ui.scroll.current );
                                 redraw = 1;
                                 break;
                         default:
                                 /* Do nothing */
                                 break;
                         }
 
                         continue;
                 }
 
                 /* Otherwise, navigate through settings */
                 key = getkey ( 0 );
                 move = jump_scroll_key ( &ui.scroll, key );
                 if ( move ) {
                         previous = ui.scroll.current;
                         jump_scroll_move ( &ui.scroll, move );
                         if ( ui.scroll.current != previous ) {
                                 draw_setting_row ( &ui );
                                 redraw = 1;
                                 if ( jump_scroll ( &ui.scroll ) )
                                         draw_setting_rows ( &ui );
                                 select_setting_row ( &ui, ui.scroll.current );
                         }
                         continue;
                 }
 
                 /* Handle non-navigation keys */
                 switch ( key ) {
                 case CTRL_D:
                         if ( ! ui.row.setting.name )
                                 break;
                         if ( ( rc = delete_setting ( ui.settings,
                                                      &ui.row.setting ) ) != 0 ){
                                 alert ( ALERT_ROW, " %s ", strerror ( rc ) );
                         }
                         select_setting_row ( &ui, ui.scroll.current );
                         redraw = 1;
                         break;
                 case CTRL_X:
                         select_setting_row ( &ui, -1U );
                         return 0;
                 case CR:
                 case LF:
                         if ( ui.row.settings ) {
                                 select_settings ( &ui, ui.row.settings );
                                 redraw = 1;
                         }
                         /* Fall through */
                 default:
                         if ( ui.row.setting.name ) {
                                 edit_setting ( &ui, key );
                                 redraw = 1;
                         }
                         break;
                 }
         }
 }

References alert(), ALERT_ROW, assert(), color_set, CPAIR_EDIT, CPAIR_NORMAL, CPAIR_SELECT, CR, CTRL_C, CTRL_D, CTRL_X, jump_scroller::current, curs_set(), delete_setting(), draw_info_row(), draw_instruction_row(), draw_setting_row(), draw_setting_rows(), draw_widget(), edit_setting(), settings_ui_row::editbox, settings_ui_row::editing, getkey(), jump_scroll(), jump_scroll_key(), jump_scroll_move(), key, LF, memset(), move(), setting::name, NULL, rc, settings_ui::row, save_setting(), settings_ui::scroll, select_setting_row(), select_settings(), settings_ui_row::setting, settings_ui_row::settings, settings_ui::settings, strerror(), and edit_box::widget.

Referenced by settings_ui().

◆ settings_ui()

int settings_ui ( struct settings * settings )

Definition at line 485 of file settings_ui.c.

                                               {
         int rc;
 
         initscr();
         start_color();
         color_set ( CPAIR_NORMAL, NULL );
         curs_set ( 0 );
         erase();
         
         rc = main_loop ( settings );
 
         endwin();
 
         return rc;
 }

References color_set, CPAIR_NORMAL, curs_set(), endwin(), erase(), initscr(), main_loop(), NULL, rc, and start_color.

Data Structures

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ TITLE_ROW

◆ SETTINGS_LIST_ROW

◆ SETTINGS_LIST_COL

◆ SETTINGS_LIST_ROWS

◆ INFO_ROW

◆ ALERT_ROW

◆ INSTRUCTION_ROW

◆ INSTRUCTION_PAD

◆ SETTING_ROW_TEXT

Function Documentation

◆ FILE_LICENCE()

◆ select_setting_row()

◆ string_copy()

◆ draw_setting_row()

◆ edit_setting()

◆ save_setting()

◆ draw_title_row()

◆ draw_info_row()

◆ draw_instruction_row()

◆ draw_setting_rows()

◆ select_settings()

◆ main_loop()

◆ settings_ui()