el_tok_line(3) - Linux man page

Name

Library

Synopsis

#include <histedit.h>

EditLine *
el_init(const char *prog, FILE *fin, FILE *fout, FILE *ferr);

void
el_end(EditLine *e);

void
el_reset(EditLine *e);

const char *
el_gets(EditLine *e, int *count);

int
el_getc(EditLine *e, char *ch);

void
el_push(EditLine *e, const char *str);

int
el_parse(EditLine *e, int argc, const char *argv[]);

int
el_set(EditLine *e, int op, ...);

int
el_get(EditLine *e, int op, ...);

int
el_source(EditLine *e, const char *file);

void
el_resize(EditLine *e);

const LineInfo *
el_line(EditLine *e);

int
el_insertstr(EditLine *e, const char *str);

void
el_deletestr(EditLine *e, int count);

History *
history_init();

void
history_end(History *h);

int
history(History *h, HistEvent *ev, int op, ...);

Tokenizer *
tok_init(const char *IFS);

void
tok_end(Tokenizer *t);

void
tok_reset(Tokenizer *t);

int
tok_line(Tokenizer *t, const LineInfo *li, int *argc, const char **argv[], int *cursorc, int *cursoro);

int
tok_str(Tokenizer *t, const char *str, int *argc, const char **argv[]);

Description

These functions are available in the libedit library (which needs the libcurses library). Programs should be linked with -ledit -lcurses.

Line Editing Functions

The following functions are available:

el_init()

Initialise the line editor, and return a data structure to be used by all other line editing functions. prog is the name of the invoking program, used when reading the editrc(5) file to determine which settings to use. fin, fout and ferr are the input, output, and error streams (respectively) to use. In this documentation, references to ''the tty'' are actually to this input/output stream combination.

el_end()

Clean up and finish with e, assumed to have been created with el_init().

el_reset()

Reset the tty and the parser. This should be called after an error which may have upset the tty's state.

el_gets()

Read a line from the tty. count is modified to contain the number of characters read. Returns the line read if successful, or NULL if no characters were read or if an error occurred.

el_getc()

Read a character from the tty. ch is modified to contain the character read. Returns the number of characters read if successful, -1 otherwise.

el_push()

Pushes str back onto the input stream. This is used by the macro expansion mechanism. Refer to the description of bind -s in editrc(5) for more information.

el_parse()

Parses the argv array (which is argc elements in size) to execute builtin editline commands. If the command is prefixed with ''prog :'' then el_parse() will only execute the command if ''prog'' matches the prog argument supplied to el_init(). The return value is -1 if the command is unknown, 0 if there was no error or ''prog'' didn't match, or 1 if the command returned an error. Refer to editrc(5) for more information.

el_set()

Set editline parameters. op determines which parameter to set, and each operation has its own parameter list.

The following values for op are supported, along with the required argument list:

EL_PROMPT , char *(*f)(EditLine *)

Define prompt printing function as f, which is to return a string that contains the prompt.

EL_REFRESH

Re-display the current line on the next terminal line.

EL_RPROMPT , char *(*f)(EditLine *)

Define right side prompt printing function as f, which is to return a string that contains the prompt.

EL_TERMINAL , const char *type

Define terminal type of the tty to be type, or to TERM if type is NULL .

EL_EDITOR , const char *mode

Set editing mode to mode, which must be one of ''emacs'' or ''vi''.

EL_SIGNAL , int flag

If flag is non-zero, editline will install its own signal handler for the following signals when reading command input: SIGCONT , SIGHUP , SIGINT , SIGQUIT , SIGSTOP , SIGTERM , SIGTSTP , and SIGWINCH . Otherwise, the current signal handlers will be used.

EL_BIND , const char *, ..., NULL

Perform the bind builtin command. Refer to editrc(5) for more information.

EL_ECHOTC , const char *, ..., NULL

Perform the echotc builtin command. Refer to editrc(5) for more information.

EL_SETTC , const char *, ..., NULL

Perform the settc builtin command. Refer to editrc(5) for more information.

EL_SETTY , const char *, ..., NULL

Perform the setty builtin command. Refer to editrc(5) for more information.

EL_TELLTC , const char *, ..., NULL

Perform the telltc builtin command. Refer to editrc(5) for more information.

EL_ADDFN , const char *name, const char *help, unsigned char (*func)(EditLine *e, int ch)

Add a user defined function, func(), referred to as name which is invoked when a key which is bound to name is entered. help is a description of name. At invocation time, ch is the key which caused the invocation. The return value of func() should be one of:

CC_NORM

Add a normal character.

CC_NEWLINE

End of line was entered.

CC_EOF

EOF was entered.

CC_ARGHACK

Expecting further command input as arguments, do nothing visually.

CC_REFRESH

Refresh display.

CC_REFRESH_BEEP

Refresh display, and beep.

CC_CURSOR

Cursor moved, so update and perform CC_REFRESH .

CC_REDISPLAY

Redisplay entire input line. This is useful if a key binding outputs extra information.

CC_ERROR

An error occurred. Beep, and flush tty.

CC_FATAL

Fatal error, reset tty to known state.

EL_HIST , History *(*func)(History *, int op, ...), const char *ptr

Defines which history function to use, which is usually history(). ptr should be the value returned by history_init().

EL_EDITMODE , int flag

If flag is non-zero, editing is enabled (the default). Note that this is only an indication, and does not affect the operation of . At this time, it is the caller's responsibility to check this (using el_get() ) to determine if editing should be enabled or not.

EL_GETCFN , int (*f)(EditLine *, char *c)

Define the character reading function as f, which is to return the number of characters read and store them in c. This function is called internally by el_gets() and el_getc(). The builtin function can be set or restored with the special function name ''EL_BUILTIN_GETCFN''.

EL_CLIENTDATA , void *data

Register data to be associated with this EditLine structure. It can be retrieved with the corresponding el_get() call.

EL_SETFP , int fd, Fa FILE *fp

Set the current editline file pointer for ''input'' fd = 0 , ''output'' fd = 1 , or ''error'' fd = 2 from fp.

el_get()

Get editline parameters. op determines which parameter to retrieve into result. Returns 0 if successful, -1 otherwise.

The following values for op are supported, along with actual type of result :

EL_PROMPT , char *(*f)(EditLine *)

Return a pointer to the function that displays the prompt.

EL_RPROMPT , char *(*f)(EditLine *)

Return a pointer to the function that displays the rightside prompt.

EL_EDITOR , const char *

Return the name of the editor, which will be one of ''emacs'' or ''vi''.

EL_GETTC , const char *name, Fa void *value

Return non-zero if name is a valid termcap(5) capability and set value to the current value of that capability.

EL_SIGNAL , int *

Return non-zero if editline has installed private signal handlers (see el_get() above).

EL_EDITMODE , int *

Return non-zero if editing is enabled.

EL_GETCFN , int (**f)(EditLine *, char *)

Return a pointer to the function that read characters, which is equal to ''EL_BUILTIN_GETCFN'' in the case of the default builtin function.

EL_CLIENTDATA , void **data

Retrieve data previously registered with the corresponding el_set() call.

EL_UNBUFFERED , int

Sets or clears unbuffered mode. In this mode, el_gets() will return immediately after processing a single character.

EL_PREP_TERM , int

Sets or clears terminal editing mode.

EL_GETFP , int fd", Fa FILE **fp

Return in fp the current editline file pointer for ''input'' fd = 0 , ''output'' fd = 1 , or ''error'' fd = 2 .

el_source()

Initialise editline by reading the contents of file. el_parse() is called for each line in file. If file is NULL , try $PWD/.editrc then $HOME/.editrc. Refer to editrc(5) for details on the format of file.

el_resize()

Must be called if the terminal size changes. If EL_SIGNAL has been set with el_set(), then this is done automatically. Otherwise, it's the responsibility of the application to call el_resize() on the appropriate occasions.

el_line()

Return the editing information for the current line in a LineInfo structure, which is defined as follows:

typedef struct lineinfo {
const char *buffer; /* address of buffer */

const char *cursor; /* address of cursor */

const char *lastchar; /* address of last character */

} LineInfo;

buffer is not NUL terminated. This function may be called after el_gets() to obtain the LineInfo structure pertaining to line returned by that function, and from within user defined functions added with EL_ADDFN .

el_insertstr()

Insert str into the line at the cursor. Returns -1 if str is empty or won't fit, and 0 otherwise.

el_deletestr()

Delete count characters before the cursor.

History List Functions

The following functions are available:

history_init()

Initialise the history list, and return a data structure to be used by all other history list functions.

history_end()

Clean up and finish with h, assumed to have been created with history_init().

history()