XgEdLine


Data Structures

struct  EDITHISTORY
 Line input history. More...
struct  EDLINE
 Edit line information structure. More...

Typedefs

typedef int(* EDLINEGET )(void *)
 Input routine type.
typedef int(* EDLINEPUT )(void *, int)
 Output routine type.
typedef int(* EDLINEMAP )(int, int *)
 Character mapping routine type.

Edit mode flags

Used when calling EdLineOpen to enable specific line editor features.

#define EDIT_MODE_ECHO   0x0001
 Enables echoing of input characters.
#define EDIT_MODE_BINARY   0x0002
 Enables binary mode (currently unused).
#define EDIT_MODE_HISTORY   0x0004
 Enables input line history.

Line editor input commands

Special keys which are interpreted by the editor as commands.

#define EDIT_KEY_IGNORE   0x00
 No operation. Default is Ctrl-@.
#define EDIT_KEY_HOME   0x01
 Move cursor to line begin. Default is Ctrl-A.
#define EDIT_KEY_LEFT   0x02
 Move cursor left. Default is Ctrl-B.
#define EDIT_KEY_END   0x05
 Move cursor to line end. Default is Ctrl-E.
#define EDIT_KEY_RIGHT   0x06
 Move cursor right. Default is Ctrl-F.
#define EDIT_KEY_REMOVE   0x08
 Delete left character. Default is Ctrl-H.
#define EDIT_KEY_ENTER   0x0a
 Confirm input. Default is Ctrl-J.
#define EDIT_KEY_UP   0x12
 History upwards. Default is Ctrl-R.
#define EDIT_KEY_DOWN   0x16
 History downwards. Default is Ctrl-V.
#define EDIT_KEY_RESTORE   0x1b
 Restore default. Default is ESC.

Line editor output commands

Special characters used by the editor to update the output.

#define EDIT_CHAR_SPACE   ' '
 Clear character right.
#define EDIT_CHAR_BACKSPACE   '\b'
 Move cursor left.
#define EDIT_CHAR_ALARM   '\a'
 Invoke audible alarm.
#define EDIT_STR_EOL   "\r\n"
 Terminate input.

Define Documentation

#define EDIT_MODE_ECHO   0x0001

Enables echoing of input characters.

Definition at line 63 of file edline.h.

Referenced by LuaThread().

#define EDIT_MODE_BINARY   0x0002

Enables binary mode (currently unused).

Definition at line 65 of file edline.h.

#define EDIT_MODE_HISTORY   0x0004

Enables input line history.

Definition at line 67 of file edline.h.

Referenced by LuaThread().

#define EDIT_KEY_IGNORE   0x00

No operation. Default is Ctrl-@.

Definition at line 78 of file edline.h.

#define EDIT_KEY_HOME   0x01

Move cursor to line begin. Default is Ctrl-A.

Definition at line 82 of file edline.h.

#define EDIT_KEY_LEFT   0x02

Move cursor left. Default is Ctrl-B.

Definition at line 86 of file edline.h.

#define EDIT_KEY_END   0x05

Move cursor to line end. Default is Ctrl-E.

Definition at line 90 of file edline.h.

#define EDIT_KEY_RIGHT   0x06

Move cursor right. Default is Ctrl-F.

Definition at line 94 of file edline.h.

#define EDIT_KEY_REMOVE   0x08

Delete left character. Default is Ctrl-H.

Definition at line 98 of file edline.h.

#define EDIT_KEY_ENTER   0x0a

Confirm input. Default is Ctrl-J.

Definition at line 102 of file edline.h.

#define EDIT_KEY_UP   0x12

History upwards. Default is Ctrl-R.

Definition at line 107 of file edline.h.

#define EDIT_KEY_DOWN   0x16

History downwards. Default is Ctrl-V.

Definition at line 111 of file edline.h.

#define EDIT_KEY_RESTORE   0x1b

Restore default. Default is ESC.

Definition at line 115 of file edline.h.

#define EDIT_CHAR_SPACE   ' '

Clear character right.

Definition at line 128 of file edline.h.

#define EDIT_CHAR_BACKSPACE   '\b'

Move cursor left.

Definition at line 132 of file edline.h.

#define EDIT_CHAR_ALARM   '\a'

Invoke audible alarm.

Definition at line 136 of file edline.h.

#define EDIT_STR_EOL   "\r\n"

Terminate input.

Definition at line 140 of file edline.h.


Typedef Documentation

typedef int(* EDLINEGET)(void *)

Input routine type.

Definition at line 155 of file edline.h.

typedef int(* EDLINEPUT)(void *, int)

Output routine type.

Definition at line 157 of file edline.h.

typedef int(* EDLINEMAP)(int, int *)

Character mapping routine type.

Definition at line 159 of file edline.h.


© 2000-2007 by egnite Software GmbH - visit http://www.ethernut.de/