EDITLINE(3edit)

📦
version 3.1-20230828 · 4 versions
, in debian bookworm, ubuntu jammy, ubuntu noble

✨ EDITLINE(3edit) ✨

okay bestie, welcome to the editline page 💅. This is the manual for the editline library — line editor, history and tokenization functions. We're gonna go through everything, no skips, periodt. 💖

💖 NAME 💖

editline, el_init, el_init_fd, el_end, el_reset, el_gets, el_wgets, el_getc, el_wgetc, el_push, el_wpush, el_parse, el_wparse, el_set, el_wset, el_get, el_wget, el_source, el_resize, el_cursor, el_line, el_wline, el_insertstr, el_winsertstr, el_deletestr, el_wdeletestr, history_init, history_winit, history_end, history_wend, history, history_w, tok_init, tok_winit, tok_end, tok_wend, tok_reset, tok_wreset, tok_line, tok_wline, tok_str, tok_wstr — line editor, history and tokenization functions

📚 LIBRARY 📚

Command Line Editor Library (libedit, -ledit)

📜 SYNOPSIS 📜

#include <histedit.h>

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

EditLine *
el_init_fd(const char *prog, FILE *fin, FILE *fout, FILE *ferr,
    int fdin, int fdout, int fderr);

void
el_end(EditLine *e);

void
el_reset(EditLine *e);

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

const wchar_t *
el_wgets(EditLine *e, int *count);

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

int
el_wgetc(EditLine *e, wchar_t *wc);

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

void
el_wpush(EditLine *e, const wchar_t *wcs);

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

int
el_wparse(EditLine *e, int argc, const wchar_t *argv[]);

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

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

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

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

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

void
el_resize(EditLine *e);

int
el_cursor(EditLine *e, int count);

const LineInfo *
el_line(EditLine *e);

const LineInfoW *
el_wline(EditLine *e);

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

int
el_winsertstr(EditLine *e, const wchar_t *str);

void
el_deletestr(EditLine *e, int count);

void
el_wdeletestr(EditLine *e, int count);

History *
history_init(void);

HistoryW *
history_winit(void);

void
history_end(History *h);

void
history_wend(HistoryW *h);

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

int
history_w(HistoryW *h, HistEventW *ev, int op, ...);

Tokenizer *
tok_init(const char *IFS);

TokenizerW *
tok_winit(const wchar_t *IFS);

void
tok_end(Tokenizer *t);

void
tok_wend(TokenizerW *t);

void
tok_reset(Tokenizer *t);

void
tok_wreset(TokenizerW *t);

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

int
tok_wline(TokenizerW *t, const LineInfoW *li, int *argc,
    const wchar_t **argv[], int *cursorc, int *cursoro);

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

int
tok_wstr(TokenizerW *t, const wchar_t *str, int *argc,
    const wchar_t **argv[]);

🌸 DESCRIPTION 🌸

The editline library provides generic line editing, history and tokenization functions, similar to those found in sh(1). iykyk 💅

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

The editline library respects the LC_CTYPE locale set by the application program and never uses setlocale(3) to change the locale. no cap ✨

✨ LINE EDITING FUNCTIONS ✨

The line editing functions use a common data structure, EditLine, which is created by el_init() or el_init_fd() and freed by el_end().

The wide-character functions behave the same way as their narrow counterparts. fr fr

The following functions are available:

  • el_init() — okay so this is the main character init: it sets up the line editor and gives you back a data structure that all the other line editing functions are gonna use, or NULL on failure. 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_init_fd() — Like el_init() but allows specifying file descriptors for the stdio(3) corresponding streams, in case those were created with funopen(3). lowkey useful
  • el_end() — Clean up and finish with e, assumed to have been created with el_init() or el_init_fd(). bye bestie 👋
  • el_reset() — Reset the tty and the parser. This should be called after an error which may have upset the tty's state. important ⚠️
  • 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. If an error occurred, count is set to -1 and errno contains the error code that caused it. The return value may not remain valid across calls to el_gets() and must be copied if the data is to be retained. copy it if you need it 📋
  • el_wgetc() — Read a wide character from the tty, respecting the current locale, or from the input queue described in editline(7) if that is not empty, and store it in wc. If an invalid or incomplete character is found, it is discarded, errno is set to EILSEQ, and the next character is read and stored in wc. Returns 1 if a valid character was read, 0 on end of file, or -1 on read(2) failure. In the latter case, errno is set to indicate the error. wide char energy 🌈
  • el_getc() — Read a wide character as described for el_wgetc() and return 0 on end of file or -1 on failure. If the wide character can be represented as a single-byte character, convert it with wctob(3), store the result in ch, and return 1; otherwise, set errno to ERANGE and return -1. In the C or POSIX locale, this simply reads a byte, but for any other locale, including UTF-8, this is rarely useful. ngl, not the vibe for UTF-8 🙈
  • el_wpush() — Push the wide character string wcs back onto the input queue described in editline(7). If the queue overflows, for example due to a recursive macro, or if an error occurs, for example because wcs is NULL or memory allocation fails, the function beeps at the user, but does not report the problem to the caller. beep beep 📢
  • el_push() — Use the current locale to convert the multibyte string mbs to a wide character string, and pass the result to el_wpush(). convert and push
  • 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. parse it, bestie 🧚
  • el_set() — Set editline parameters. op determines which parameter to set, and each operation has its own parameter list. Returns 0 on success, -1 on failure. the big one 💅

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. prompt vibes
  • EL_PROMPT_ESC, char *(*f)(EditLine *), char c — Same as EL_PROMPT, but the c argument indicates the start/stop literal prompt character.

If a start/stop literal character is found in the prompt, the character itself is not printed, but characters after it are printed directly to the terminal without affecting the state of the current line. A subsequent second start/stop literal character ends this behavior. This is typically used to embed literal escape sequences that change the color/style of the terminal in the prompt. Note that the literal escape character cannot be the last character in the prompt, as the escape sequence is attached to the next character in the prompt. 0 unsets it. escape character realness ✨

  • EL_REFRESH — Re-display the current line on the next terminal line. refresh 🔄
  • EL_RPROMPT, char *(*f)(EditLine *) — Define right side prompt printing function as f, which is to return a string that contains the prompt. right side
  • EL_RPROMPT_ESC, char *(*f)(EditLine *), char c — Define the right prompt printing function but with a literal escape character. escape again
  • EL_TERMINAL, const char *type — Define terminal type of the tty to be type, or to TERM if type is NULL. terminal type
  • EL_EDITOR, const char *mode — Set editing mode to mode, which must be one of “emacs” or “vi”. emacs or vi, pick your fighter ⚔️
  • 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. signals, handle with care 🚨
  • EL_BIND, const char *, ..., NULL — Perform the bind builtin command. Refer to editrc(5) for more information. bind it
  • EL_ECHOTC, const char *, ..., NULL — Perform the echotc builtin command. Refer to editrc(5) for more information. echotc
  • EL_SETTC, const char *, ..., NULL — Perform the settc builtin command. Refer to editrc(5) for more information. settc
  • EL_SETTY, const char *, ..., NULL — Perform the setty builtin command. Refer to editrc(5) for more information. setty
  • EL_TELLTC, const char *, ..., NULL — Perform the telltc builtin command. Refer to editrc(5) for more information. telltc
  • 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: add your own function, main character energy 👑
    • CC_NORM — Add a normal character. normal
    • CC_NEWLINE — End of line was entered. newline
    • CC_EOF — EOF was entered. EOF
    • CC_ARGHACK — Expecting further command input as arguments, do nothing visually. arghack
  • CC_REFRESH — refresh the display, bestie. that's it, that's the whole job 💅
  • CC_REFRESH_BEEP — refresh the display and beep. lil refresh, lil noise, iconic combo ✨
  • CC_CURSOR — the cursor moved! so update stuff and then perform CC_REFRESH. two for one 🫶
  • CC_REDISPLAY — redisplay the entire input line. this one's your bestie when a key binding outputs extra info and everything gets scrambled 😭
  • CC_ERROR — an error happened 💀 beep, and flush the tty.
  • CC_FATAL — fatal error, no cap. reset the tty to a known state. this is the emergency-exit vibe 🙈
  • EL_HIST, History *(*func)(History *, int op, ...), const char *ptr — decides which history function gets used, which is usually just history(). ptr should be the value that history_init() handed back to you.
  • EL_EDITMODE, int flag — if flag is non-zero, editing is enabled (that's the default ✨). lowkey important caveat though: this is only an indication, and it does not affect how editline actually operates. at this time, it's the caller's job to check this (via el_get()) to figure out whether editing should be enabled or not. so like… you gotta do the vibe check yourself 👑
  • EL_UNBUFFERED, int flag — if flag is zero, unbuffered mode is off (the default). in unbuffered mode, el_gets() returns immediately after processing a single character. no waiting, no chill, just one char and go 🏃‍♀️
  • EL_SAFEREAD, int flag — if the flag argument is non-zero, editline tries to recover from read errors: it ignores the first interrupted error, and it tries to reset the input file descriptor to reset non-blocking I/O. this is disabled by default, and it's only desirable when editline is used in shell-like applications. fr fr, only turn this on if you know why 🚨
  • EL_GETCFN, el_rfunc_t f — whenever a character is read, use the function
int f(EditLine *e, wchar_t *wc)

which stores the character in wc and returns 1 on success, 0 on end of file, or -1 on I/O or encoding errors. the functions that use it internally include el_wgets(), el_wgetc(), el_gets(), and el_getc(). initially a builtin function is installed, and replacing it is discouraged because writing such a function is very error prone 😭. the builtin function can be restored at any time by passing the special value EL_BUILTIN_GETCFN instead of a function pointer. keep that one in your pocket 🎀

  • EL_CLIENTDATA, void *data — register data so it's associated with this EditLine structure. you can grab it back later with the corresponding el_get() call.
  • EL_SETFP, int fd, FILE *fp — set the current editline file pointer for “input” fd = 0, “output” fd = 1, or “error” fd = 2 from fp.

💫 el_get() — the receiving end 💫

Get editline parameters. op decides which parameter gets retrieved into result. returns 0 if it worked, -1 otherwise.

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

  • EL_PROMPT, char *(*f)(EditLine *), char *c — set f to a pointer to the function that displays the prompt. if c is not NULL, set it to the start/stop literal prompt character.
  • EL_RPROMPT, char *(*f)(EditLine *), char *c — set f to a pointer to the function that displays the prompt. if c is not NULL, set it to the start/stop literal prompt character. (yes bestie, it's the same description as EL_PROMPT — that's just how the page do 💅)
  • EL_EDITOR, const char **n — set the name of the editor in n, which will be one of “emacs” or “vi”. choose your fighter ⚔️
  • EL_GETTC, const char *name, void *value — if name is a valid termcap(5) capability, set value to the current value of that capability.
  • EL_SIGNAL, int *s — set s to non-zero if editline has installed private signal handlers (see el_get() above).
  • EL_EDITMODE, int *c — set c to non-zero if editing is enabled.
  • EL_GETCFN, el_rfunc_t *f — set f to a pointer to the function that reads characters, or to EL_BUILTIN_GETCFN if the builtin function is the one in use.
  • EL_CLIENTDATA, void **data — set data to the previously registered client data that was set by an el_set() call.
  • EL_UNBUFFERED, int *c — set c to non-zero if unbuffered mode is enabled.
  • EL_SAFEREAD, int *c — set c to non-zero if safe read is set.
  • EL_GETFP, int fd, FILE **fp — set fp to the current editline file pointer for “input” fd = 0, “output” fd = 1, or “error” fd = 2.

🌸 el_source() 🌸

Initialize editline by reading the contents of file. el_parse() gets called for each line in file. if file is NULL, it tries $EDITRC, and if that isn't set, $HOME/.editrc. peek at editrc(5) for the details on the format of file. el_source() returns 0 on success and -1 on error. the duality of girlhood 😭

🦋 el_resize() 🦋

Must be called if the terminal size changes. if EL_SIGNAL has been set with el_set(), then this happens automatically for you, slay. otherwise it's the application's responsibility to call el_resize() on the appropriate occasions. no one else is gonna do it for you, bestie 🫶

🎀 el_cursor() 🎀

Move the cursor to the right (if positive) or to the left (if negative) count characters. returns the resulting offset of the cursor from the beginning of the line.

⭐ el_line() ⭐

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

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, jsyk 👀. you can call this function after el_gets() to obtain the LineInfo structure pertaining to the line that function returned, and also from inside 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. very "make room for me" energy 💅

🌈 el_deletestr() 🌈

Delete count characters before the cursor. bye bye, character era 🦋

👑 HISTORY LIST FUNCTIONS 👑

The history functions all share one common data structure, History, which is created by history_init() and freed by history_end(). found family 🫶

The following functions are available:

✨ history_init() ✨

Initialize the history list, and return a data structure to be used by all the other history list functions — or NULL on failure 😭.

💜 history_end() 💜

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

🔥 history() 🔥

Perform operation op on the history list, with optional arguments as needed by the operation. ev gets changed accordingly to the operation. The following values for op are supported, along with the required argument list:

  • H_SETSIZE, int size — set the size of the history to size elements.
  • H_GETSIZE — get the number of events currently in the history.
  • H_END — cleans up and finishes with h, assumed to have been created with history_init().
  • H_CLEAR — clear the history. poof, gone 💨
  • H_FUNC, void *ptr, history_gfun_t first, history_gfun_t next, history_gfun_t last, history_gfun_t prev, history_gfun_t curr, history_sfun_t set, history_vfun_t clear, history_efun_t enter, history_efun_t add — define functions to perform the various history operations. ptr is the argument given to a function when it's invoked.
  • H_FIRST — return the first element in the history.
  • H_LAST — return the last element in the history.
  • H_PREV — return the previous element in the history. it's newer than the current one.
  • H_NEXT — return the next element in the history. it's older than the current one.
  • H_CURR — return the current element in the history.
  • H_SET, int position — set the cursor to point to the requested element.
  • H_ADD, const char *str — append str to the current element of the history, or perform the H_ENTER operation with argument str if there's no current element.
  • H_APPEND, const char *str — append str to the last new element of the history.
  • H_ENTER, const char *str — add str as a new element to the history and, if necessary, remove the oldest entry to keep the list at the size it was created with. if H_SETUNIQUE has been called with a non-zero argument, the element will not be entered into the history if its contents match the ones of the current history element. if the element is entered, history() returns 1; if it's ignored as a duplicate, it returns 0. finally, history() returns -1 if an error occurred. three possible outcomes, main character range 👑
  • H_PREV_STR, const char *str — return the closest previous event that starts with str.
  • H_NEXT_STR, const char *str — return the closest next event that starts with str.
  • H_PREV_EVENT, int e — return the previous event numbered e.
  • H_NEXT_EVENT, int e — return the next event numbered e.
  • H_LOAD, const char *file — load the history list stored in file.
  • H_SAVE, const char *file — save the history list to file.
  • H_SAVE_FP, FILE *fp — save the history list to the opened FILE pointer fp.
  • H_NSAVE_FP, size_t n, FILE *fp — save the last n history entries to the opened FILE pointer fp.
  • H_SETUNIQUE, int unique — set the flag that adjacent identical event strings should not be entered into the history. no repeats, we don't do reruns here 💅
  • H_GETUNIQUE — retrieve the current setting for whether adjacent identical elements should be entered into the history.
  • H_DEL, int e — delete the event numbered e. heads up: this function is only provided for readline compatibility. the caller is responsible for free'ing the string in the returned HistEvent 🚨

history() returns >= 0 if the operation op succeeds. otherwise -1 is returned and ev is updated to contain more details about the error.

🎀 TOKENIZATION FUNCTIONS 🎀

okay so bestie, these functions all share one common data structure called a Tokenizer, and here's the vibe: it gets created by tok_init() and freed by tok_end(). that's it, that's the lifecycle, no cap 💖

The following functions are available:

  • tok_init() — sets up the tokenizer and hands you back a data structure that literally every other tokenizer function is gonna need. IFS holds the Input Field Separators, and if it's NULL it just defaults to ⟨space⟩, ⟨tab⟩, and ⟨newline⟩. so cozy, so default ✨
  • tok_end() — cleans everything up and says bye to t, which we're assuming you made with tok_init() in the first place. no orphaned tokenizers in this house 🫶
  • tok_reset() — resets the tokenizer state. use this after a line has been successfully tokenized by tok_line() or tok_str(), and before you go tokenizing a whole new line. it's giving "fresh start, clean slate" 🦋
  • tok_line() — tokenizes li. If it succeeds, it modifies: argv to contain the words, argc to contain the number of words, cursorc (if it's not NULL) to contain the index of the word containing the cursor, and cursoro (if it's not NULL) to contain the offset within argv[cursorc] of the cursor. she's thorough, she's detail-oriented, we love her 💅

Returns 0 if successful, -1 for an internal error, 1 for an unmatched single quote, 2 for an unmatched double quote, and 3 for a backslash quoted ⟨newline⟩. and listen — a positive exit code means you should read another line and try the tokenization again. don't skip that part, i'm serious 😭

  • tok_str() — the simpler, chiller version of tok_line(). str is a NUL terminated string to tokenize. lowkey the easy mode, and that's valid 🌸

👑 SEE ALSO 👑

sh(1), signal(3), termcap(3), editrc(5edit), termcap(5), editline(7edit)

go read those too, bestie, it's called ✨enrichment✨ 📚

🌈 HISTORY 🌈

The editline library first appeared in 4.4BSD. CC_REDISPLAY appeared in NetBSD 1.3. CC_REFRESH_BEEP, EL_EDITMODE and the readline emulation appeared in NetBSD 1.4. EL_RPROMPT appeared in NetBSD 1.5.

a whole glow-up timeline fr fr, we love an evolution arc 🦋

💖 AUTHORS 💖

The editline library was written by Christos Zoulas. Luke Mewburn wrote this manual and implemented CC_REDISPLAY, CC_REFRESH_BEEP, EL_EDITMODE, and EL_RPROMPT. Jaromir Dolecek implemented the readline emulation. Johny Mattsson implemented wide-character support.

icons, every single one of them, no notes 👑✨

💀 BUGS 💀

At this time, it is the responsibility of the caller to check the result of the EL_EDITMODE operation of el_get() (after an el_source() or el_parse()) to figure out if editline should be used for further input. I.e., EL_EDITMODE is purely an indication of the result of the most recent editrc(5) edit command.

so yeah bestie, EL_EDITMODE is not gonna do the thinking for you — she's just reporting back what the last editrc(5) edit command said. you gotta check that yourself. the call is coming from inside the house 📞😭

and that's the whole page, we made it 🎉 this one's from the Debian crew, dated August 15, 2021 — thanks for reading the EDITLINE(3edit) manual with me, mwah 💋💖

📦 where this page comes from