form_ui.c File Reference

Text widget forms. More...

#include <stdlib.h>
#include <string.h>
#include <errno.h>
#include <ipxe/ansicol.h>
#include <ipxe/dynui.h>
#include <ipxe/jumpscroll.h>
#include <ipxe/settings.h>
#include <ipxe/editbox.h>
#include <ipxe/message.h>

Go to the source code of this file.

Data Structures
struct	form
	A form. More...
struct	form_control
	A form control. More...

Macros
#define	TITLE_ROW   1U
	Form title row. More...
#define	START_ROW   3U
	Starting control row. More...
#define	END_ROW   ( LINES - 3U )
	Ending control row. More...
#define	INSTRUCTION_ROW   ( LINES - 2U )
	Instructions row. More...
#define	INSTRUCTION_PAD   " "
	Padding between instructions. More...
#define	INPUT_WIDTH   ( COLS / 2U )
	Input field width. More...
#define	INPUT_COL   ( ( COLS - INPUT_WIDTH ) / 2U )
	Input field column. More...

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
static struct form *	alloc_form (struct dynamic_ui *dynui)
	Allocate form. More...
static void	free_form (struct form *form)
	Free form. More...
static int	layout_form (struct form *form)
	Assign form rows. More...
static void	draw_form (struct form *form)
	Draw form. More...
static void	draw_errors (struct form *form)
	Draw (or clear) error messages. More...
static int	parse_names (struct form *form)
	Parse setting names. More...
static void	load_values (struct form *form)
	Load current input values. More...
static int	save_values (struct form *form)
	Store current input values. More...
static int	submit_form (struct form *form)
	Submit form. More...
static int	form_loop (struct form *form)
	Form main loop. More...
int	show_form (struct dynamic_ui *dynui)
	Show form. More...

Detailed Description

Text widget forms.

Definition in file form_ui.c.

Macro Definition Documentation

TITLE_ROW

#define TITLE_ROW   1U

Form title row.

Definition at line 43 of file form_ui.c.

START_ROW

#define START_ROW   3U

Starting control row.

Definition at line 46 of file form_ui.c.

END_ROW

#define END_ROW   ( LINES - 3U )

Ending control row.

Definition at line 49 of file form_ui.c.

INSTRUCTION_ROW

#define INSTRUCTION_ROW   ( LINES - 2U )

Instructions row.

Definition at line 52 of file form_ui.c.

INSTRUCTION_PAD

#define INSTRUCTION_PAD   " "

Padding between instructions.

Definition at line 55 of file form_ui.c.

INPUT_WIDTH

#define INPUT_WIDTH   ( COLS / 2U )

Input field width.

Definition at line 58 of file form_ui.c.

INPUT_COL

#define INPUT_COL   ( ( COLS - INPUT_WIDTH ) / 2U )

Input field column.

Definition at line 61 of file form_ui.c.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

alloc_form()

static struct form* alloc_form ( struct dynamic_ui *  dynui )

static

Allocate form.

Parameters

dynui

Dynamic user interface

Return values

form	Form, or NULL on error

Definition at line 99 of file form_ui.c.

                                                             {
        struct form *form;
        struct form_control *control;
        struct dynamic_item *item;
        char *name;
        size_t len;

        /* Calculate total length */
        len = sizeof ( *form );
        list_for_each_entry ( item, &dynui->items, list ) {
                len += sizeof ( *control );
                if ( item->name )
                        len += ( strlen ( item->name ) + 1 /* NUL */ );
        }

        /* Allocate and initialise structure */
        form = zalloc ( len );
        if ( ! form )
                return NULL;
        control = ( ( ( void * ) form ) + sizeof ( *form ) );
        name = ( ( ( void * ) control ) +
                 ( dynui->count * sizeof ( *control ) ) );
        form->dynui = dynui;
        form->controls = control;
        list_for_each_entry ( item, &dynui->items, list ) {
                control->item = item;
                if ( item->name ) {
                        control->name = name;
                        name = ( stpcpy ( name, item->name ) + 1 /* NUL */ );
                }
                control++;
        }
        assert ( ( ( void * ) name ) == ( ( ( void * ) form ) + len ) );

        return form;
}

References assert(), control, form::controls, dynamic_ui::count, form::dynui, dynamic_ui::items, len, dynamic_item::list, list_for_each_entry, dynamic_item::name, name, NULL, stpcpy(), strlen(), and zalloc().

Referenced by show_form().

free_form()

static void free_form ( struct form *  form )

static

Free form.

Parameters

form

Form

Definition at line 141 of file form_ui.c.

                                            {
        unsigned int i;

        /* Free input value buffers */
        for ( i = 0 ; i < form->dynui->count ; i++ )
                free ( form->controls[i].value );

        /* Free form */
        free ( form );
}

References form::controls, dynamic_ui::count, form::dynui, free, and form_control::value.

Referenced by show_form().

layout_form()

static int layout_form ( struct form *  form )

static

Assign form rows.

Parameters

form

Form

Return values

rc	Return status code

Definition at line 158 of file form_ui.c.

                                             {
        struct form_control *control;
        struct dynamic_item *item;
        unsigned int labels = 0;
        unsigned int inputs = 0;
        unsigned int pad_control = 0;
        unsigned int pad_label = 0;
        unsigned int minimum;
        unsigned int remaining;
        unsigned int between;
        unsigned int row;
        unsigned int flags;
        unsigned int i;

        /* Count labels and inputs */
        for ( i = 0 ; i < form->dynui->count ; i++ ) {
                control = &form->controls[i];
                item = control->item;
                if ( item->text[0] )
                        labels++;
                if ( item->name ) {
                        if ( ! inputs )
                                form->scroll.current = i;
                        inputs++;
                        if ( item->flags & DYNUI_DEFAULT )
                                form->scroll.current = i;
                        form->scroll.count = ( i + 1 );
                }
        }
        form->scroll.rows = form->scroll.count;
        DBGC ( form, "FORM %p has %d controls (%d labels, %d inputs)\n",
               form, form->dynui->count, labels, inputs );

        /* Refuse to create forms with no inputs */
        if ( ! inputs )
                return -EINVAL;

        /* Calculate minimum number of rows */
        minimum = ( labels + ( inputs * 2 /* edit box and error message */ ) );
        remaining = ( END_ROW - START_ROW );
        DBGC ( form, "FORM %p has %d (of %d) usable rows\n",
               form, remaining, LINES );
        if ( minimum > remaining )
                return -ERANGE;
        remaining -= minimum;

        /* Insert blank row between controls, if space exists */
        between = ( form->dynui->count - 1 );
        if ( between <= remaining ) {
                pad_control = 1;
                remaining -= between;
                DBGC ( form, "FORM %p padding between controls\n", form );
        }

        /* Insert blank row after label, if space exists */
        if ( labels <= remaining ) {
                pad_label = 1;
                remaining -= labels;
                DBGC ( form, "FORM %p padding after labels\n", form );
        }

        /* Centre on screen */
        DBGC ( form, "FORM %p has %d spare rows\n", form, remaining );
        row = ( START_ROW + ( remaining / 2 ) );

        /* Position each control */
        for ( i = 0 ; i < form->dynui->count ; i++ ) {
                control = &form->controls[i];
                item = control->item;
                if ( item->text[0] ) {
                        control->row = row;
                        row++; /* Label text */
                        row += pad_label;
                }
                if ( item->name ) {
                        flags = ( ( item->flags & DYNUI_SECRET ) ?
                                  WIDGET_SECRET : 0 );
                        init_editbox ( &control->editbox, row, INPUT_COL,
                                       INPUT_WIDTH, flags, &control->value );
                        row++; /* Edit box */
                        row++; /* Error message (if any) */
                }
                row += pad_control;
        }
        assert ( row <= END_ROW );

        return 0;
}

References assert(), control, form::controls, jump_scroller::count, dynamic_ui::count, jump_scroller::current, DBGC, form::dynui, DYNUI_DEFAULT, DYNUI_SECRET, EINVAL, END_ROW, ERANGE, flags, dynamic_item::flags, init_editbox(), INPUT_COL, INPUT_WIDTH, LINES, dynamic_item::name, jump_scroller::rows, form::scroll, START_ROW, dynamic_item::text, and WIDGET_SECRET.

Referenced by show_form().

draw_form()

static void draw_form ( struct form *  form )

static

Draw form.

Parameters

form

Form

Definition at line 252 of file form_ui.c.

                                            {
        struct form_control *control;
        unsigned int i;

        /* Clear screen */
        color_set ( CPAIR_NORMAL, NULL );
        erase();

        /* Draw title, if any */
        attron ( A_BOLD );
        if ( form->dynui->title )
                msg ( TITLE_ROW, "%s", form->dynui->title );
        attroff ( A_BOLD );

        /* Draw controls */
        for ( i = 0 ; i < form->dynui->count ; i++ ) {
                control = &form->controls[i];

                /* Draw label, if any */
                if ( control->row )
                        msg ( control->row, "%s", control->item->text );

                /* Draw input, if any */
                if ( control->name )
                        draw_widget ( &control->editbox.widget );
        }

        /* Draw instructions */
        msg ( INSTRUCTION_ROW, "%s", "Ctrl-X - save changes"
              INSTRUCTION_PAD "Ctrl-C - discard changes" );
}

References A_BOLD, attroff(), attron(), color_set, control, form::controls, dynamic_ui::count, CPAIR_NORMAL, draw_widget(), form::dynui, erase(), INSTRUCTION_PAD, INSTRUCTION_ROW, msg(), NULL, dynamic_ui::title, and TITLE_ROW.

Referenced by show_form().

draw_errors()

static void draw_errors ( struct form *  form )

static

Draw (or clear) error messages.

Parameters

form

Form

Definition at line 289 of file form_ui.c.

                                              {
        struct form_control *control;
        unsigned int row;
        unsigned int i;

        /* Draw (or clear) errors */
        for ( i = 0 ; i < form->dynui->count ; i++ ) {
                control = &form->controls[i];

                /* Skip non-input controls */
                if ( ! control->name )
                        continue;

                /* Draw or clear error message as appropriate */
                row = ( control->editbox.widget.row + 1 );
                if ( control->rc != 0 ) {
                        color_set ( CPAIR_ALERT, NULL );
                        msg ( row, " %s ", strerror ( control->rc ) );
                        color_set ( CPAIR_NORMAL, NULL );
                } else {
                        clearmsg ( row );
                }
        }
}

References clearmsg(), color_set, control, form::controls, dynamic_ui::count, CPAIR_ALERT, CPAIR_NORMAL, form::dynui, msg(), NULL, form_control::row, and strerror().

Referenced by submit_form().

parse_names()

static int parse_names ( struct form *  form )

static

Parse setting names.

Parameters

form

Form

Return values

rc	Return status code

Definition at line 320 of file form_ui.c.

                                             {
        struct form_control *control;
        unsigned int i;
        int rc;

        /* Parse all setting names */
        for ( i = 0 ; i < form->dynui->count ; i++ ) {
                control = &form->controls[i];

                /* Skip labels */
                if ( ! control->name ) {
                        DBGC ( form, "FORM %p item %d is a label\n", form, i );
                        continue;
                }

                /* Parse setting name */
                DBGC ( form, "FORM %p item %d is for %s\n",
                       form, i, control->name );
                if ( ( rc = parse_setting_name ( control->name,
                                                 autovivify_child_settings,
                                                 &control->settings,
                                                 &control->setting ) ) != 0 )
                        return rc;

                /* Apply default type if necessary */
                if ( ! control->setting.type )
                        control->setting.type = &setting_type_string;
        }

        return 0;
}

References autovivify_child_settings(), control, form::controls, dynamic_ui::count, DBGC, form::dynui, parse_setting_name(), and rc.

Referenced by show_form().

load_values()

static void load_values ( struct form *  form )

static

Load current input values.

Parameters

form

Form

Definition at line 357 of file form_ui.c.

                                              {
        struct form_control *control;
        unsigned int i;

        /* Fetch all current setting values */
        for ( i = 0 ; i < form->dynui->count ; i++ ) {
                control = &form->controls[i];
                if ( ! control->name )
                        continue;
                fetchf_setting_copy ( control->settings, &control->setting,
                                      NULL, &control->setting,
                                      &control->value );
        }
}

References control, form::controls, dynamic_ui::count, form::dynui, fetchf_setting_copy(), and NULL.

Referenced by show_form().

save_values()

static int save_values ( struct form *  form )

static

Store current input values.

Parameters

form

Form

Return values

rc	Return status code

Definition at line 378 of file form_ui.c.

                                             {
        struct form_control *control;
        unsigned int i;
        int rc = 0;

        /* Store all current setting values */
        for ( i = 0 ; i < form->dynui->count ; i++ ) {
                control = &form->controls[i];
                if ( ! control->name )
                        continue;
                control->rc = storef_setting ( control->settings,
                                               &control->setting,
                                               control->value );
                if ( control->rc != 0 )
                        rc = control->rc;
        }

        return rc;
}

References control, form::controls, dynamic_ui::count, form::dynui, rc, and storef_setting().

Referenced by submit_form().

submit_form()

static int submit_form ( struct form *  form )

static

Submit form.

Parameters

form

Form

Return values

rc	Return status code

Definition at line 404 of file form_ui.c.

                                             {
        int rc;

        /* Attempt to save values */
        rc = save_values ( form );

        /* Draw (or clear) errors */
        draw_errors ( form );

        return rc;
}

References draw_errors(), rc, and save_values().

Referenced by form_loop().

form_loop()

static int form_loop ( struct form *  form )

static

Form main loop.

Parameters

form

Form

Return values

rc	Return status code

Definition at line 422 of file form_ui.c.

                                           {
        struct jump_scroller *scroll = &form->scroll;
        struct form_control *control;
        struct dynamic_item *item;
        unsigned int move;
        unsigned int i;
        int key;
        int rc;

        /* Main loop */
        while ( 1 ) {

                /* Draw current input */
                control = &form->controls[scroll->current];
                draw_widget ( &control->editbox.widget );

                /* Process keypress */
                key = edit_widget ( &control->editbox.widget, getkey ( 0 ) );

                /* Handle scroll keys */
                move = jump_scroll_key ( &form->scroll, key );

                /* Handle special keys */
                switch ( key ) {
                case CTRL_C:
                case ESC:
                        /* Cancel form */
                        return -ECANCELED;
                case KEY_ENTER:
                        /* Attempt to do the most intuitive thing when
                         * Enter is pressed.  If we are on the last
                         * input, then submit the form.  If we are
                         * editing an input which failed, then
                         * resubmit the form.  Otherwise, move to the
                         * next input.
                         */
                        if ( ( control->rc == 0 ) &&
                             ( scroll->current < ( scroll->count - 1 ) ) ) {
                                move = SCROLL_DOWN;
                                break;
                        }
                        /* fall through */
                case CTRL_X:
                        /* Submit form */
                        if ( ( rc = submit_form ( form ) ) == 0 )
                                return 0;
                        /* If current input is not the problem, move
                         * to the first input that needs fixing.
                         */
                        if ( control->rc == 0 ) {
                                for ( i = 0 ; i < form->dynui->count ; i++ ) {
                                        if ( form->controls[i].rc != 0 ) {
                                                scroll->current = i;
                                                break;
                                        }
                                }
                        }
                        break;
                default:
                        /* Move to input with matching shortcut key, if any */
                        item = dynui_shortcut ( form->dynui, key );
                        if ( item ) {
                                scroll->current = item->index;
                                if ( ! item->name )
                                        move = SCROLL_DOWN;
                        }
                        break;
                }

                /* Move selection, if applicable */
                while ( move ) {
                        move = jump_scroll_move ( &form->scroll, move );
                        control = &form->controls[scroll->current];
                        if ( control->name )
                                break;
                }
        }
}

References control, form::controls, jump_scroller::count, dynamic_ui::count, CTRL_C, CTRL_X, jump_scroller::current, draw_widget(), form::dynui, dynui_shortcut(), ECANCELED, edit_widget(), ESC, getkey(), dynamic_item::index, jump_scroll_key(), jump_scroll_move(), key, KEY_ENTER, move(), dynamic_item::name, form_control::rc, rc, form::scroll, SCROLL_DOWN, and submit_form().

Referenced by show_form().

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