editstring_test.c File Reference

Editable string tests. More...

#include <stdlib.h>
#include <string.h>
#include <ctype.h>
#include <ipxe/keys.h>
#include <ipxe/editstring.h>
#include <ipxe/test.h>

Go to the source code of this file.

Data Structures
struct	editstring_test
	An editable string test. More...

Macros
#define	KEYS(...)
	Define an inline key sequence.
#define	EDITSTRING_TEST(name, START, EXPECTED, KEYS)
	Define an editable string test.
#define	editstring_ok(test)

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	EDITSTRING_TEST (simple, "", "hello world!", KEYS( 'h', 'e', 'l', 'l', 'o', ' ', 'w', 'o', 'r', 'l', 'd', '!'))
	EDITSTRING_TEST (simple_null, NULL, "hi there", KEYS( 'h', 'i', ' ', 't', 'h', 'e', 'r', 'e'))
	EDITSTRING_TEST (insert, "in middle", "in the middle", KEYS(KEY_LEFT, KEY_LEFT, KEY_LEFT, KEY_LEFT, KEY_LEFT, KEY_LEFT, 't', 'h', 'e', ' '))
	EDITSTRING_TEST (backspace_end, "byebye", "bye", KEYS(KEY_BACKSPACE, KEY_BACKSPACE, KEY_BACKSPACE))
	EDITSTRING_TEST (backspace_all, "abc", "", KEYS(KEY_BACKSPACE, KEY_BACKSPACE, KEY_BACKSPACE))
	EDITSTRING_TEST (backspace_empty, NULL, "", KEYS(KEY_BACKSPACE))
	EDITSTRING_TEST (backspace_beyond, "too far", "", KEYS(KEY_BACKSPACE, KEY_BACKSPACE, KEY_BACKSPACE, KEY_BACKSPACE, KEY_BACKSPACE, KEY_BACKSPACE, KEY_BACKSPACE, KEY_BACKSPACE, KEY_BACKSPACE))
	EDITSTRING_TEST (delete_dc, "go away", "goaway", KEYS(KEY_HOME, KEY_RIGHT, KEY_RIGHT, KEY_DC))
	EDITSTRING_TEST (delete_ctrl_d, "not here", "nohere", KEYS(KEY_LEFT, KEY_LEFT, KEY_LEFT, KEY_LEFT, KEY_LEFT, KEY_LEFT, CTRL_D, CTRL_D))
	EDITSTRING_TEST (word_end, "remove these two words", "remove these ", KEYS(CTRL_W, CTRL_W))
	EDITSTRING_TEST (word_start, "no word", "word", KEYS(CTRL_A, KEY_RIGHT, KEY_RIGHT, KEY_RIGHT, CTRL_W))
	EDITSTRING_TEST (word_mid, "delete this word", "delete word", KEYS(KEY_LEFT, KEY_LEFT, KEY_LEFT, KEY_LEFT, CTRL_W))
	EDITSTRING_TEST (sol, "everything must go", "go", KEYS(KEY_LEFT, KEY_LEFT, CTRL_U))
	EDITSTRING_TEST (eol, "all is lost", "all", KEYS(KEY_HOME, KEY_RIGHT, KEY_RIGHT, KEY_RIGHT, CTRL_K))
static void	editstring_okx (struct editstring_test *test, const char *file, unsigned int line)
	Report an editable string test result.
static void	editstring_test_exec (void)
	Perform editable string self-tests.

Variables
struct self_test editstring_test	__self_test
	Editable string self-test.

Detailed Description

Editable string tests.

Definition in file editstring_test.c.

Macro Definition Documentation

KEYS

#define KEYS

(

...

)

Value:

{ __VA_ARGS__ }

Define an inline key sequence.

Definition at line 55 of file editstring_test.c.

Referenced by EDITSTRING_TEST(), EDITSTRING_TEST(), EDITSTRING_TEST(), EDITSTRING_TEST(), EDITSTRING_TEST(), EDITSTRING_TEST(), EDITSTRING_TEST(), EDITSTRING_TEST(), EDITSTRING_TEST(), EDITSTRING_TEST(), EDITSTRING_TEST(), EDITSTRING_TEST(), EDITSTRING_TEST(), and EDITSTRING_TEST().

EDITSTRING_TEST

#define EDITSTRING_TEST	(		name,
			START,
			EXPECTED,
			KEYS )

Value:

        static const int name ## _keys[] = KEYS;                        \
        static struct editstring_test name = {                               \
                .start = START,                                         \
                .keys = name ## _keys,                                      \
                .count = ( sizeof ( name ## _keys ) /                       \
                           sizeof ( name ## _keys[0] ) ),           \
                .expected = EXPECTED,                                   \
        };

Define an editable string test.

Definition at line 58 of file editstring_test.c.

#define EDITSTRING_TEST( name, START, EXPECTED, KEYS )                  \
        static const int name ## _keys[] = KEYS;                        \
        static struct editstring_test name = {                          \
                .start = START,                                         \
                .keys = name ## _keys,                                  \
                .count = ( sizeof ( name ## _keys ) /                   \
                           sizeof ( name ## _keys[0] ) ),               \
                .expected = EXPECTED,                                   \
        };

editstring_ok

#define editstring_ok

(

test

)

Value:

editstring_okx ( test, __FILE__, __LINE__ )

Definition at line 170 of file editstring_test.c.

Referenced by editstring_test_exec().

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

EDITSTRING_TEST() [1/14]

EDITSTRING_TEST	(	simple	,
		""	,
		"hello world!"	,
		KEYS('h', 'e', 'l', 'l', 'o', ' ', 'w', 'o', 'r', 'l', 'd', '!')	)

References KEYS.

EDITSTRING_TEST() [2/14]

EDITSTRING_TEST	(	simple_null	,
		NULL	,
		"hi there"	,
		KEYS('h', 'i', ' ', 't', 'h', 'e', 'r', 'e')	)

References KEYS, and NULL.

EDITSTRING_TEST() [3/14]

EDITSTRING_TEST	(	insert	,
		"in middle"	,
		"in the middle"	,
		KEYS(KEY_LEFT, KEY_LEFT, KEY_LEFT, KEY_LEFT, KEY_LEFT, KEY_LEFT, 't', 'h', 'e', ' ')	)

References KEY_LEFT, and KEYS.

EDITSTRING_TEST() [4/14]

EDITSTRING_TEST	(	backspace_end	,
		"byebye"	,
		"bye"	,
		KEYS(KEY_BACKSPACE, KEY_BACKSPACE, KEY_BACKSPACE)	)

References KEY_BACKSPACE, and KEYS.

EDITSTRING_TEST() [5/14]

EDITSTRING_TEST	(	backspace_all	,
		"abc"	,
		""	,
		KEYS(KEY_BACKSPACE, KEY_BACKSPACE, KEY_BACKSPACE)	)

References KEY_BACKSPACE, and KEYS.

EDITSTRING_TEST() [6/14]

EDITSTRING_TEST	(	backspace_empty	,
		NULL	,
		""	,
		KEYS(KEY_BACKSPACE)	)

References KEY_BACKSPACE, KEYS, and NULL.

EDITSTRING_TEST() [7/14]

EDITSTRING_TEST	(	backspace_beyond	,
		"too far"	,
		""	,
		KEYS(KEY_BACKSPACE, KEY_BACKSPACE, KEY_BACKSPACE, KEY_BACKSPACE, KEY_BACKSPACE, KEY_BACKSPACE, KEY_BACKSPACE, KEY_BACKSPACE, KEY_BACKSPACE)	)

References KEY_BACKSPACE, and KEYS.

EDITSTRING_TEST() [8/14]

EDITSTRING_TEST	(	delete_dc	,
		"go away"	,
		"goaway"	,
		KEYS(KEY_HOME, KEY_RIGHT, KEY_RIGHT, KEY_DC)	)

References KEY_DC, KEY_HOME, KEY_RIGHT, and KEYS.

EDITSTRING_TEST() [9/14]

EDITSTRING_TEST	(	delete_ctrl_d	,
		"not here"	,
		"nohere"	,
		KEYS(KEY_LEFT, KEY_LEFT, KEY_LEFT, KEY_LEFT, KEY_LEFT, KEY_LEFT, CTRL_D, CTRL_D)	)

References CTRL_D, KEY_LEFT, and KEYS.

EDITSTRING_TEST() [10/14]

EDITSTRING_TEST	(	word_end	,
		"remove these two words"	,
		"remove these "	,
		KEYS(CTRL_W, CTRL_W)	)

References CTRL_W, and KEYS.

EDITSTRING_TEST() [11/14]

EDITSTRING_TEST	(	word_start	,
		"no word"	,
		"word"	,
		KEYS(CTRL_A, KEY_RIGHT, KEY_RIGHT, KEY_RIGHT, CTRL_W)	)

References CTRL_A, CTRL_W, KEY_RIGHT, and KEYS.

EDITSTRING_TEST() [12/14]

EDITSTRING_TEST	(	word_mid	,
		"delete this word"	,
		"delete word"	,
		KEYS(KEY_LEFT, KEY_LEFT, KEY_LEFT, KEY_LEFT, CTRL_W)	)

References CTRL_W, KEY_LEFT, and KEYS.

EDITSTRING_TEST() [13/14]

EDITSTRING_TEST	(	sol	,
		"everything must go"	,
		"go"	,
		KEYS(KEY_LEFT, KEY_LEFT, CTRL_U)	)

References CTRL_U, KEY_LEFT, and KEYS.

EDITSTRING_TEST() [14/14]

EDITSTRING_TEST	(	eol	,
		"all is lost"	,
		"all"	,
		KEYS(KEY_HOME, KEY_RIGHT, KEY_RIGHT, KEY_RIGHT, CTRL_K)	)

References CTRL_K, KEY_HOME, KEY_RIGHT, and KEYS.

editstring_okx()

void editstring_okx ( struct editstring_test * test, const char * file, unsigned int line )

static

Report an editable string test result.

Parameters

test	Editable string test
file	Test code file
line	Test code line

Definition at line 135 of file editstring_test.c.

                                                 {
        struct edit_string string;
        unsigned int i;
        char *actual;
        int key;
 
        /* Initialise editable string */
        memset ( &string, 0, sizeof ( string ) );
        actual = NULL;
        init_editstring ( &string, &actual );
 
        /* Set initial string content */
        okx ( replace_string ( &string, test->start ) == 0, file, line );
        okx ( actual != NULL, file, line );
        okx ( string.cursor == ( test->start ? strlen ( test->start ) : 0 ),
              file, line );
        DBGC ( test, "Initial string: \"%s\"\n", actual );
 
        /* Inject keypresses */
        for ( i = 0 ; i < test->count ; i++ ) {
                key = test->keys[i];
                okx ( edit_string ( &string, key ) == 0, file, line );
                okx ( actual != NULL, file, line );
                okx ( string.cursor <= strlen ( actual ), file, line );
                DBGC ( test, "After key %#02x (%c): \"%s\"\n",
                       key, ( isprint ( key ) ? key : '.' ), actual );
        }
 
        /* Verify result string */
        okx ( strcmp ( actual, test->expected ) == 0, file, line );
 
        /* Free result string */
        free ( actual );
}

References edit_string::cursor, DBGC, free, init_editstring(), isprint(), key, memset(), NULL, okx, replace_string(), strcmp(), string, strlen(), and test.

editstring_test_exec()

void editstring_test_exec ( void )

static

Perform editable string self-tests.

Definition at line 176 of file editstring_test.c.

                                          {
 
        editstring_ok ( &simple );
        editstring_ok ( &simple_null );
        editstring_ok ( &insert );
        editstring_ok ( &backspace_end );
        editstring_ok ( &backspace_all );
        editstring_ok ( &backspace_empty );
        editstring_ok ( &backspace_beyond );
        editstring_ok ( &delete_dc );
        editstring_ok ( &delete_ctrl_d );
        editstring_ok ( &word_end );
        editstring_ok ( &word_start );
        editstring_ok ( &word_mid );
        editstring_ok ( &sol );
        editstring_ok ( &eol );
}

References editstring_ok.

Variable Documentation

__self_test

struct self_test editstring_test __self_test

Initial value:

= {
        .name = "editstring",
        .exec = editstring_test_exec,
}

Editable string self-test.

Definition at line 195 of file editstring_test.c.

                                               {
        .name = "editstring",
        .exec = editstring_test_exec,
};