1 .\" $NetBSD: editline.3,v 1.80 2013/07/12 17:48:29 christos Exp $
3 .\" Copyright (c) 1997-2013 The NetBSD Foundation, Inc.
4 .\" All rights reserved.
6 .\" This file was contributed to The NetBSD Foundation by Luke Mewburn.
8 .\" Redistribution and use in source and binary forms, with or without
9 .\" modification, are permitted provided that the following conditions
11 .\" 1. Redistributions of source code must retain the above copyright
12 .\" notice, this list of conditions and the following disclaimer.
13 .\" 2. Redistributions in binary form must reproduce the above copyright
14 .\" notice, this list of conditions and the following disclaimer in the
15 .\" documentation and/or other materials provided with the distribution.
17 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
18 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
19 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
20 .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
21 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 .\" POSSIBILITY OF SUCH DAMAGE.
75 .Nd line editor, history and tokenization functions
81 .Fn el_init "const char *prog" "FILE *fin" "FILE *fout" "FILE *ferr"
83 .Fn el_init_fd "const char *prog" "FILE *fin" "FILE *fout" "FILE *ferr" "int fdin" "int fdout" "int fderr"
85 .Fn el_end "EditLine *e"
87 .Fn el_reset "EditLine *e"
89 .Fn el_gets "EditLine *e" "int *count"
91 .Fn el_wgets "EditLine *e" "int *count"
93 .Fn el_getc "EditLine *e" "char *ch"
95 .Fn el_wgetc "EditLine *e" "wchar_t *ch"
97 .Fn el_push "EditLine *e" "const char *str"
99 .Fn el_wpush "EditLine *e" "const wchar_t *str"
101 .Fn el_parse "EditLine *e" "int argc" "const char *argv[]"
103 .Fn el_wparse "EditLine *e" "int argc" "const wchar_t *argv[]"
105 .Fn el_set "EditLine *e" "int op" "..."
107 .Fn el_wset "EditLine *e" "int op" "..."
109 .Fn el_get "EditLine *e" "int op" "..."
111 .Fn el_wget "EditLine *e" "int op" "..."
113 .Fn el_source "EditLine *e" "const char *file"
115 .Fn el_resize "EditLine *e"
117 .Fn el_cursor "EditLine *e" "int count"
119 .Fn el_line "EditLine *e"
120 .Ft const LineInfoW *
121 .Fn el_wline "EditLine *e"
123 .Fn el_insertstr "EditLine *e" "const char *str"
125 .Fn el_winsertstr "EditLine *e" "const wchar_t *str"
127 .Fn el_deletestr "EditLine *e" "int count"
129 .Fn el_wdeletestr "EditLine *e" "int count"
135 .Fn history_end "History *h"
137 .Fn history_wend "HistoryW *h"
139 .Fn history "History *h" "HistEvent *ev" "int op" "..."
141 .Fn history_w "HistoryW *h" "HistEventW *ev" "int op" "..."
143 .Fn tok_init "const char *IFS"
145 .Fn tok_winit "const wchar_t *IFS"
147 .Fn tok_end "Tokenizer *t"
149 .Fn tok_wend "TokenizerW *t"
151 .Fn tok_reset "Tokenizer *t"
153 .Fn tok_wreset "TokenizerW *t"
155 .Fn tok_line "Tokenizer *t" "const LineInfo *li" "int *argc" "const char **argv[]" "int *cursorc" "int *cursoro"
157 .Fn tok_wline "TokenizerW *t" "const LineInfoW *li" "int *argc" "const wchar_t **argv[]" "int *cursorc" "int *cursoro"
159 .Fn tok_str "Tokenizer *t" "const char *str" "int *argc" "const char **argv[]"
161 .Fn tok_wstr "TokenizerW *t" "const wchar_t *str" "int *argc" "const wchar_t **argv[]"
165 library provides generic line editing, history and tokenization functions,
166 similar to those found in
169 These functions are available in the
171 library (which needs the
174 Programs should be linked with
176 .Sh LINE EDITING FUNCTIONS
177 The line editing functions use a common data structure,
186 The wide-character functions behave the same way as their narrow
189 The following functions are available:
192 Initialise the line editor, and return a data structure
193 to be used by all other line editing functions.
195 is the name of the invoking program, used when reading the
197 file to determine which settings to use.
202 are the input, output, and error streams (respectively) to use.
203 In this documentation, references to
205 are actually to this input/output stream combination.
209 but allows specifying file descriptors for the
211 corresponding streams, in case those were created with
214 Clean up and finish with
216 assumed to have been created with
221 Reset the tty and the parser.
222 This should be called after an error which may have upset the tty's
225 Read a line from the tty.
227 is modified to contain the number of characters read.
228 Returns the line read if successful, or
230 if no characters were read or if an error occurred.
231 If an error occurred,
235 contains the error code that caused it.
236 The return value may not remain valid across calls to
238 and must be copied if the data is to be retained.
240 Read a character from the tty.
242 is modified to contain the character read.
243 Returns the number of characters read if successful, \-1 otherwise,
246 can be inspected for the cause.
250 back onto the input stream.
251 This is used by the macro expansion mechanism.
252 Refer to the description of
257 for more information.
267 If the command is prefixed with
271 will only execute the command if
278 \-1 if the command is unknown,
279 0 if there was no error or
282 1 if the command returned an error.
285 for more information.
291 determines which parameter to set, and each operation has its
294 The following values for
296 are supported, along with the required argument list:
298 .It Dv EL_PROMPT , Fa "char *(*f)(EditLine *)"
299 Define prompt printing function as
301 which is to return a string that contains the prompt.
302 .It Dv EL_PROMPT_ESC , Fa "char *(*f)(EditLine *)" , Fa "char c"
307 argument indicates the start/stop literal prompt character.
309 If a start/stop literal character is found in the prompt, the
311 is not printed, but characters after it are printed directly to the
312 terminal without affecting the state of the current line.
313 A subsequent second start/stop literal character ends this behavior.
314 This is typically used to embed literal escape sequences that change the
315 color/style of the terminal in the prompt.
319 Re-display the current line on the next terminal line.
320 .It Dv EL_RPROMPT , Fa "char *(*f)(EditLine *)"
321 Define right side prompt printing function as
323 which is to return a string that contains the prompt.
324 .It Dv EL_RPROMPT_ESC , Fa "char *(*f)(EditLine *)" , Fa "char c"
325 Define the right prompt printing function but with a literal escape character.
326 .It Dv EL_TERMINAL , Fa "const char *type"
327 Define terminal type of the tty to be
335 .It Dv EL_EDITOR , Fa "const char *mode"
342 .It Dv EL_SIGNAL , Fa "int flag"
347 will install its own signal handler for the following signals when
348 reading command input:
358 Otherwise, the current signal handlers will be used.
359 .It Dv EL_BIND , Fa "const char *" , Fa "..." , Dv NULL
365 for more information.
366 .It Dv EL_ECHOTC , Fa "const char *" , Fa "..." , Dv NULL
372 for more information.
373 .It Dv EL_SETTC , Fa "const char *" , Fa "..." , Dv NULL
379 for more information.
380 .It Dv EL_SETTY , Fa "const char *" , Fa "..." , Dv NULL
386 for more information.
387 .It Dv EL_TELLTC , Fa "const char *" , Fa "..." , Dv NULL
393 for more information.
394 .It Dv EL_ADDFN , Fa "const char *name" , Fa "const char *help" , \
395 Fa "unsigned char (*func)(EditLine *e, int ch)"
396 Add a user defined function,
400 which is invoked when a key which is bound to
408 is the key which caused the invocation.
412 .Bl -tag -width "CC_REDISPLAY"
414 Add a normal character.
416 End of line was entered.
420 Expecting further command input as arguments, do nothing visually.
423 .It Dv CC_REFRESH_BEEP
424 Refresh display, and beep.
426 Cursor moved, so update and perform
429 Redisplay entire input line.
430 This is useful if a key binding outputs extra information.
435 Fatal error, reset tty to known state.
437 .It Dv EL_HIST , Fa "History *(*func)(History *, int op, ...)" , \
439 Defines which history function to use, which is usually
442 should be the value returned by
444 .It Dv EL_EDITMODE , Fa "int flag"
448 editing is enabled (the default).
449 Note that this is only an indication, and does not
450 affect the operation of
452 At this time, it is the caller's responsibility to
456 to determine if editing should be enabled or not.
457 .It Dv EL_UNBUFFERED , Fa "int flag"
461 unbuffered mode is disabled (the default).
464 will return immediately after processing a single character.
465 .It Dv EL_GETCFN , Fa "int (*f)(EditLine *, char *c)"
466 Define the character reading function as
468 which is to return the number of characters read and store them in
470 This function is called internally by
474 The builtin function can be set or restored with the special function
476 .Dq Dv EL_BUILTIN_GETCFN .
477 .It Dv EL_CLIENTDATA , Fa "void *data"
480 to be associated with this EditLine structure.
481 It can be retrieved with the corresponding
484 .It Dv EL_SETFP , Fa "int fd" , Fa "FILE *fp"
509 determines which parameter to retrieve into
511 Returns 0 if successful, \-1 otherwise.
513 The following values for
515 are supported, along with actual type of
518 .It Dv EL_PROMPT , Fa "char *(*f)(EditLine *)" , Fa "char *c"
519 Return a pointer to the function that displays the prompt in
525 return the start/stop literal prompt character in it.
526 .It Dv EL_RPROMPT , Fa "char *(*f)(EditLine *)" , Fa "char *c"
527 Return a pointer to the function that displays the prompt in
533 return the start/stop literal prompt character in it.
534 .It Dv EL_EDITOR , Fa "const char **"
535 Return the name of the editor, which will be one of
539 .It Dv EL_GETTC , Fa "const char *name" , Fa "void *value"
547 to the current value of that capability.
548 .It Dv EL_SIGNAL , Fa "int *"
551 has installed private signal handlers (see
554 .It Dv EL_EDITMODE , Fa "int *"
555 Return non-zero if editing is enabled.
556 .It Dv EL_GETCFN , Fa "int (**f)(EditLine *, char *)"
557 Return a pointer to the function that read characters, which is equal to
558 .Dq Dv EL_BUILTIN_GETCFN
559 in the case of the default builtin function.
560 .It Dv EL_CLIENTDATA , Fa "void **data"
563 previously registered with the corresponding
566 .It Dv EL_UNBUFFERED , Fa "int"
567 Return non-zero if unbuffered mode is enabled.
568 .It Dv EL_PREP_TERM , Fa "int"
569 Sets or clears terminal editing mode.
570 .It Dv EL_GETFP , Fa "int fd", Fa "FILE **fp"
593 by reading the contents of
596 is called for each line in
606 for details on the format of
609 Must be called if the terminal size changes.
614 then this is done automatically.
615 Otherwise, it's the responsibility of the application to call
617 on the appropriate occasions.
619 Move the cursor to the right (if positive) or to the left (if negative)
622 Returns the resulting offset of the cursor from the beginning of the line.
624 Return the editing information for the current line in a
626 structure, which is defined as follows:
628 typedef struct lineinfo {
629 const char *buffer; /* address of buffer */
630 const char *cursor; /* address of cursor */
631 const char *lastchar; /* address of last character */
636 is not NUL terminated.
637 This function may be called after
641 structure pertaining to line returned by that function,
642 and from within user defined functions added with
647 into the line at the cursor.
650 is empty or won't fit, and 0 otherwise.
654 characters before the cursor.
656 .Sh HISTORY LIST FUNCTIONS
657 The history functions use a common data structure,
664 The following functions are available:
667 Initialise the history list, and return a data structure
668 to be used by all other history list functions.
670 Clean up and finish with
672 assumed to have been created with
677 on the history list, with optional arguments as needed by the
680 is changed accordingly to operation.
681 The following values for
683 are supported, along with the required argument list:
685 .It Dv H_SETSIZE , Fa "int size"
686 Set size of history to
690 Get number of events currently in history.
692 Cleans up and finishes with
694 assumed to be created with
698 .It Dv H_FUNC , Fa "void *ptr" , Fa "history_gfun_t first" , \
699 Fa "history_gfun_t next" , Fa "history_gfun_t last" , \
700 Fa "history_gfun_t prev" , Fa "history_gfun_t curr" , \
701 Fa "history_sfun_t set" , Fa "history_vfun_t clear" , \
702 Fa "history_efun_t enter" , Fa "history_efun_t add"
703 Define functions to perform various history operations.
705 is the argument given to a function when it's invoked.
707 Return the first element in the history.
709 Return the last element in the history.
711 Return the previous element in the history.
713 Return the next element in the history.
715 Return the current element in the history.
717 Set the cursor to point to the requested element.
718 .It Dv H_ADD , Fa "const char *str"
721 to the current element of the history, or perform the
723 operation with argument
725 if there is no current element.
726 .It Dv H_APPEND , Fa "const char *str"
729 to the last new element of the history.
730 .It Dv H_ENTER , Fa "const char *str"
733 as a new element to the history, and, if necessary,
734 removing the oldest entry to keep the list to the created size.
737 was has been called with a non-zero arguments, the element
738 will not be entered into the history if its contents match
739 the ones of the current history element.
740 If the element is entered
742 returns 1, if it is ignored as a duplicate returns 0.
745 returns \-1 if an error occurred.
746 .It Dv H_PREV_STR , Fa "const char *str"
747 Return the closest previous event that starts with
749 .It Dv H_NEXT_STR , Fa "const char *str"
750 Return the closest next event that starts with
752 .It Dv H_PREV_EVENT , Fa "int e"
753 Return the previous event numbered
755 .It Dv H_NEXT_EVENT , Fa "int e"
756 Return the next event numbered
758 .It Dv H_LOAD , Fa "const char *file"
759 Load the history list stored in
761 .It Dv H_SAVE , Fa "const char *file"
762 Save the history list to
764 .It Dv H_SETUNIQUE , Fa "int unique"
765 Set flag that adjacent identical event strings should not be entered
768 Retrieve the current setting if adjacent identical elements should
769 be entered into the history.
770 .It Dv H_DEL , Fa "int e"
771 Delete the event numbered
773 This function is only provided for
776 The caller is responsible for free'ing the string in the returned
781 returns \*[Gt]= 0 if the operation
784 Otherwise, \-1 is returned and
786 is updated to contain more details about the error.
788 .Sh TOKENIZATION FUNCTIONS
789 The tokenization functions use a common data structure,
796 The following functions are available:
799 Initialise the tokenizer, and return a data structure
800 to be used by all other tokenizer functions.
802 contains the Input Field Separators, which defaults to
810 Clean up and finish with
812 assumed to have been created with
815 Reset the tokenizer state.
816 Use after a line has been successfully tokenized
821 and before a new line is to be tokenized.
825 If successful, modify:
827 to contain the words,
829 to contain the number of words,
833 to contain the index of the word containing the cursor,
838 to contain the offset within
844 \-1 for an internal error,
845 1 for an unmatched single quote,
846 2 for an unmatched double quote,
848 3 for a backslash quoted
850 A positive exit code indicates that another line should be read
851 and tokenization attempted again.
857 is a NUL terminated string to tokenize.
861 .\"XXX: provide some examples
871 library first appeared in
876 .Dv CC_REFRESH_BEEP ,
878 and the readline emulation appeared in
886 library was written by Christos Zoulas.
887 Luke Mewburn wrote this manual and implemented
889 .Dv CC_REFRESH_BEEP ,
893 Jaromir Dolecek implemented the readline emulation.
894 Johny Mattsson implemented wide-character support.
896 At this time, it is the responsibility of the caller to
897 check the result of the
907 should be used for further input.
910 is purely an indication of the result of the most recent