editbox.c File Reference

Editable text box widget. More...

#include <string.h>
#include <assert.h>
#include <ipxe/ansicol.h>
#include <ipxe/editbox.h>

Go to the source code of this file.

Macros
#define	EDITBOX_MIN_CHARS   3

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
static void	draw_editbox (struct widget *widget)
	Draw text box widget.
static int	edit_editbox (struct widget *widget, int key)
	Edit text box widget.

Variables
struct widget_operations	editbox_operations
	Text box widget operations.

Detailed Description

Editable text box widget.

Definition in file editbox.c.

Macro Definition Documentation

EDITBOX_MIN_CHARS

#define EDITBOX_MIN_CHARS   3

Definition at line 38 of file editbox.c.

Referenced by draw_editbox().

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

draw_editbox()

void draw_editbox ( struct widget * widget )

static

Draw text box widget.

Parameters

widget

Text widget

Definition at line 45 of file editbox.c.

                                                   {
        struct edit_box *box = container_of ( widget, struct edit_box, widget );
        const char *content = *(box->string.buf);
        size_t width = widget->width;
        char buf[ width + 1 ];
        signed int cursor_offset, underflow, overflow, first;
        size_t len;
 
        /* Adjust starting offset so that cursor remains within box */
        cursor_offset = ( box->string.cursor - box->first );
        underflow = ( EDITBOX_MIN_CHARS - cursor_offset );
        overflow = ( cursor_offset - ( width - 1 ) );
        first = box->first;
        if ( underflow > 0 ) {
                first -= underflow;
                if ( first < 0 )
                        first = 0;
        } else if ( overflow > 0 ) {
                first += overflow;
        }
        box->first = first;
        cursor_offset = ( box->string.cursor - first );
 
        /* Construct underscore-padded string portion */
        memset ( buf, '_', width );
        buf[width] = '\0';
        len = ( content ? ( strlen ( content ) - first ) : 0 );
        if ( len > width )
                len = width;
        if ( widget->flags & WIDGET_SECRET ) {
                memset ( buf, '*', len );
        } else {
                memcpy ( buf, ( content + first ), len );
        }
 
        /* Print box content and move cursor */
        color_set ( CPAIR_EDIT, NULL );
        mvprintw ( widget->row, widget->col, "%s", buf );
        move ( widget->row, ( widget->col + cursor_offset ) );
        color_set ( CPAIR_NORMAL, NULL );
}

References box(), widget::col, color_set, container_of, CPAIR_EDIT, CPAIR_NORMAL, EDITBOX_MIN_CHARS, first, widget::flags, len, memcpy(), memset(), move(), mvprintw, NULL, widget::row, strlen(), WIDGET_SECRET, and widget::width.

edit_editbox()

int edit_editbox ( struct widget * widget, int key )

static

Edit text box widget.

Parameters

widget	Text widget
key	Key pressed by user

Return values

key	Key returned to application, or zero

Definition at line 94 of file editbox.c.

                                                           {
        struct edit_box *box = container_of ( widget, struct edit_box, widget );
 
        return edit_string ( &box->string, key );
}

References box(), container_of, edit_string(), and key.

Variable Documentation

editbox_operations

struct widget_operations editbox_operations

Initial value:

= {
        .draw = draw_editbox,
        .edit = edit_editbox,
}

Text box widget operations.

Definition at line 101 of file editbox.c.

                                              {
        .draw = draw_editbox,
        .edit = edit_editbox,
};

Referenced by init_editbox().