editstring.h File Reference

Editable strings. More...

Go to the source code of this file.

Data Structures
struct	edit_string
	An editable string. More...

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
static __nonnull void	init_editstring (struct edit_string *string, char **buf)
	Initialise editable string. More...
	__attribute__ ((nonnull(1))) int replace_string(struct edit_string *string
__nonnull int	edit_string (struct edit_string *string, int key)
	Edit editable string. More...

Variables
const char *	replacement

Detailed Description

Editable strings.

Definition in file editstring.h.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

init_editstring()

static __nonnull void init_editstring ( struct edit_string *  string, char **  buf  )

inlinestatic

Initialise editable string.

Parameters

string	Editable string
buf	Dynamically allocated string buffer

The buf parameter must be the address of a caller-provided pointer to a NUL-terminated string allocated using malloc() (or equivalent, such as strdup()). Any edits made to the string will realloc() the string buffer as needed.

The caller may choose leave the initial string buffer pointer as NULL, in which case it will be allocated upon the first attempt to insert a character into the buffer. If the caller does this, then it must be prepared to find the pointer still NULL after editing, since the user may never attempt to insert any characters.

Definition at line 46 of file editstring.h.

                                                            {

        string->buf = buf;
}

Referenced by editstring_okx(), init_editbox(), and readline_history().

__attribute__()

__attribute__

(

(nonnull(1))

)

edit_string()

__nonnull int edit_string	(	struct edit_string *	string,
		int	key
	)

Edit editable string.

Parameters

string	Editable string
key	Key pressed by user

Return values

key	Key returned to application, zero, or negative error

Handles keypresses and updates the content of the editable string. Basic line editing facilities (delete/insert/cursor) are supported. If edit_string() understands and uses the keypress it will return zero, otherwise it will return the original key.

The string's edit history will be updated to allow the caller to efficiently bring the display into sync with the string content.

This function does not itself update the display in any way.

Errors may safely be ignored if it is deemed that subsequently failing to update the display will provide sufficient feedback to the user.

Definition at line 255 of file editstring.c.

                                                        {
        const char *buf = *(string->buf);
        size_t len = ( buf ? strlen ( buf ) : 0 );
        int retval = 0;

        /* Prepare edit history */
        string->last_cursor = string->cursor;
        string->mod_start = string->cursor;
        string->mod_end = string->cursor;

        /* Interpret key */
        if ( ( key >= 0x20 ) && ( key <= 0x7e ) ) {
                /* Printable character; insert at current position */
                retval = insert_character ( string, key );
        } else switch ( key ) {
        case KEY_BACKSPACE:
                /* Backspace */
                backspace ( string );
                break;
        case KEY_DC:
        case CTRL_D:
                /* Delete character */
                delete_character ( string );
                break;
        case CTRL_W:
                /* Delete word */
                kill_word ( string );
                break;
        case CTRL_U:
                /* Delete to start of line */
                kill_sol ( string );
                break;
        case CTRL_K:
                /* Delete to end of line */
                kill_eol ( string );
                break;
        case KEY_HOME:
        case CTRL_A:
                /* Start of line */
                string->cursor = 0;
                break;
        case KEY_END:
        case CTRL_E:
                /* End of line */
                string->cursor = len;
                break;
        case KEY_LEFT:
        case CTRL_B:
                /* Cursor left */
                if ( string->cursor > 0 )
                        string->cursor--;
                break;
        case KEY_RIGHT:
        case CTRL_F:
                /* Cursor right */
                if ( string->cursor < len )
                        string->cursor++;
                break;
        default:
                retval = key;
                break;
        }

        return retval;
}

References backspace(), CTRL_A, CTRL_B, CTRL_D, CTRL_E, CTRL_F, CTRL_K, CTRL_U, CTRL_W, delete_character(), insert_character(), key, KEY_BACKSPACE, KEY_DC, KEY_END, KEY_HOME, KEY_LEFT, KEY_RIGHT, kill_eol(), kill_sol(), kill_word(), len, retval, string, and strlen().

Referenced by edit_editbox(), and readline_history().

Variable Documentation

replacement

const char* replacement

Definition at line 53 of file editstring.h.

Referenced by image_exec(), image_replace(), myri10ge_net_poll(), and replace_string().