editline.3

   1 .\"     $NetBSD: editline.3,v 1.101 2021/08/15 10:12:54 wiz Exp $
   2 .\"
   3 .\" Copyright (c) 1997-2014 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" This file was contributed to The NetBSD Foundation by Luke Mewburn.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  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.
  16 .\"
  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.
  28 .\"
  29 .Dd August 15, 2021
  30 .Dt EDITLINE 3
  31 .Os
  32 .Sh NAME
  33 .Nm editline ,
  34 .Nm el_init ,
  35 .Nm el_init_fd ,
  36 .Nm el_end ,
  37 .Nm el_reset ,
  38 .Nm el_gets ,
  39 .Nm el_wgets ,
  40 .Nm el_getc ,
  41 .Nm el_wgetc ,
  42 .Nm el_push ,
  43 .Nm el_wpush ,
  44 .Nm el_parse ,
  45 .Nm el_wparse ,
  46 .Nm el_set ,
  47 .Nm el_wset ,
  48 .Nm el_get ,
  49 .Nm el_wget ,
  50 .Nm el_source ,
  51 .Nm el_resize ,
  52 .Nm el_cursor ,
  53 .Nm el_line ,
  54 .Nm el_wline ,
  55 .Nm el_insertstr ,
  56 .Nm el_winsertstr ,
  57 .Nm el_deletestr ,
  58 .Nm el_wdeletestr ,
  59 .Nm history_init ,
  60 .Nm history_winit ,
  61 .Nm history_end ,
  62 .Nm history_wend ,
  63 .Nm history ,
  64 .Nm history_w ,
  65 .Nm tok_init ,
  66 .Nm tok_winit ,
  67 .Nm tok_end ,
  68 .Nm tok_wend ,
  69 .Nm tok_reset ,
  70 .Nm tok_wreset ,
  71 .Nm tok_line ,
  72 .Nm tok_wline ,
  73 .Nm tok_str ,
  74 .Nm tok_wstr
  75 .Nd line editor, history and tokenization functions
  76 .Sh LIBRARY
  77 .Lb libedit
  78 .Sh SYNOPSIS
  79 .In histedit.h
  80 .Ft EditLine *
  81 .Fn el_init "const char *prog" "FILE *fin" "FILE *fout" "FILE *ferr"
  82 .Ft EditLine *
  83 .Fn el_init_fd "const char *prog" "FILE *fin" "FILE *fout" "FILE *ferr" "int fdin" "int fdout" "int fderr"
  84 .Ft void
  85 .Fn el_end "EditLine *e"
  86 .Ft void
  87 .Fn el_reset "EditLine *e"
  88 .Ft const char *
  89 .Fn el_gets "EditLine *e" "int *count"
  90 .Ft const wchar_t *
  91 .Fn el_wgets "EditLine *e" "int *count"
  92 .Ft int
  93 .Fn el_getc "EditLine *e" "char *ch"
  94 .Ft int
  95 .Fn el_wgetc "EditLine *e" "wchar_t *wc"
  96 .Ft void
  97 .Fn el_push "EditLine *e" "const char *mbs"
  98 .Ft void
  99 .Fn el_wpush "EditLine *e" "const wchar_t *wcs"
 100 .Ft int
 101 .Fn el_parse "EditLine *e" "int argc" "const char *argv[]"
 102 .Ft int
 103 .Fn el_wparse "EditLine *e" "int argc" "const wchar_t *argv[]"
 104 .Ft int
 105 .Fn el_set "EditLine *e" "int op" "..."
 106 .Ft int
 107 .Fn el_wset "EditLine *e" "int op" "..."
 108 .Ft int
 109 .Fn el_get "EditLine *e" "int op" "..."
 110 .Ft int
 111 .Fn el_wget "EditLine *e" "int op" "..."
 112 .Ft int
 113 .Fn el_source "EditLine *e" "const char *file"
 114 .Ft void
 115 .Fn el_resize "EditLine *e"
 116 .Ft int
 117 .Fn el_cursor "EditLine *e" "int count"
 118 .Ft const LineInfo *
 119 .Fn el_line "EditLine *e"
 120 .Ft const LineInfoW *
 121 .Fn el_wline "EditLine *e"
 122 .Ft int
 123 .Fn el_insertstr "EditLine *e" "const char *str"
 124 .Ft int
 125 .Fn el_winsertstr "EditLine *e" "const wchar_t *str"
 126 .Ft void
 127 .Fn el_deletestr "EditLine *e" "int count"
 128 .Ft void
 129 .Fn el_wdeletestr "EditLine *e" "int count"
 130 .Ft History *
 131 .Fn history_init void
 132 .Ft HistoryW *
 133 .Fn history_winit void
 134 .Ft void
 135 .Fn history_end "History *h"
 136 .Ft void
 137 .Fn history_wend "HistoryW *h"
 138 .Ft int
 139 .Fn history "History *h" "HistEvent *ev" "int op" "..."
 140 .Ft int
 141 .Fn history_w "HistoryW *h" "HistEventW *ev" "int op" "..."
 142 .Ft Tokenizer *
 143 .Fn tok_init "const char *IFS"
 144 .Ft TokenizerW *
 145 .Fn tok_winit "const wchar_t *IFS"
 146 .Ft void
 147 .Fn tok_end "Tokenizer *t"
 148 .Ft void
 149 .Fn tok_wend "TokenizerW *t"
 150 .Ft void
 151 .Fn tok_reset "Tokenizer *t"
 152 .Ft void
 153 .Fn tok_wreset "TokenizerW *t"
 154 .Ft int
 155 .Fn tok_line "Tokenizer *t" "const LineInfo *li" "int *argc" "const char **argv[]" "int *cursorc" "int *cursoro"
 156 .Ft int
 157 .Fn tok_wline "TokenizerW *t" "const LineInfoW *li" "int *argc" "const wchar_t **argv[]" "int *cursorc" "int *cursoro"
 158 .Ft int
 159 .Fn tok_str "Tokenizer *t" "const char *str" "int *argc" "const char **argv[]"
 160 .Ft int
 161 .Fn tok_wstr "TokenizerW *t" "const wchar_t *str" "int *argc" "const wchar_t **argv[]"
 162 .Sh DESCRIPTION
 163 The
 164 .Nm
 165 library provides generic line editing, history and tokenization functions,
 166 similar to those found in
 167 .Xr sh 1 .
 168 .Pp
 169 These functions are available in the
 170 .Nm libedit
 171 library (which needs the
 172 .Nm libtermcap
 173 library).
 174 Programs should be linked with
 175 .Fl ledit ltermcap .
 176 .Pp
 177 The
 178 .Nm
 179 library respects the
 180 .Ev LC_CTYPE
 181 locale set by the application program and never uses
 182 .Xr setlocale 3
 183 to change the locale.
 184 .Sh LINE EDITING FUNCTIONS
 185 The line editing functions use a common data structure,
 186 .Fa EditLine ,
 187 which is created by
 188 .Fn el_init
 189 or
 190 .Fn el_init_fd
 191 and freed by
 192 .Fn el_end .
 193 .Pp
 194 The wide-character functions behave the same way as their narrow
 195 counterparts.
 196 .Pp
 197 The following functions are available:
 198 .Bl -tag -width 4n
 199 .It Fn el_init
 200 Initialize the line editor, and return a data structure
 201 to be used by all other line editing functions, or
 202 .Dv NULL
 203 on failure.
 204 .Fa prog
 205 is the name of the invoking program, used when reading the
 206 .Xr editrc 5
 207 file to determine which settings to use.
 208 .Fa fin ,
 209 .Fa fout
 210 and
 211 .Fa ferr
 212 are the input, output, and error streams (respectively) to use.
 213 In this documentation, references to
 214 .Dq the tty
 215 are actually to this input/output stream combination.
 216 .It Fn el_init_fd
 217 Like
 218 .Fn el_init
 219 but allows specifying file descriptors for the
 220 .Xr stdio 3
 221 corresponding streams, in case those were created with
 222 .Xr funopen 3 .
 223 .It Fn el_end
 224 Clean up and finish with
 225 .Fa e ,
 226 assumed to have been created with
 227 .Fn el_init
 228 or
 229 .Fn el_init_fd .
 230 .It Fn el_reset
 231 Reset the tty and the parser.
 232 This should be called after an error which may have upset the tty's
 233 state.
 234 .It Fn el_gets
 235 Read a line from the tty.
 236 .Fa count
 237 is modified to contain the number of characters read.
 238 Returns the line read if successful, or
 239 .Dv NULL
 240 if no characters were read or if an error occurred.
 241 If an error occurred,
 242 .Fa count
 243 is set to \-1 and
 244 .Dv errno
 245 contains the error code that caused it.
 246 The return value may not remain valid across calls to
 247 .Fn el_gets
 248 and must be copied if the data is to be retained.
 249 .It Fn el_wgetc
 250 Read a wide character from the tty, respecting the current locale,
 251 or from the input queue described in
 252 .Xr editline 7
 253 if that is not empty, and store it in
 254 .Fa wc .
 255 If an invalid or incomplete character is found, it is discarded,
 256 .Va errno
 257 is set to
 258 .Er EILSEQ ,
 259 and the next character is read and stored in
 260 .Fa wc .
 261 Returns 1 if a valid character was read, 0 on end of file, or \-1 on
 262 .Xr read 2
 263 failure.
 264 In the latter case,
 265 .Va errno
 266 is set to indicate the error.
 267 .It Fn el_getc
 268 Read a wide character as described for
 269 .Fn el_wgetc
 270 and return 0 on end of file or \-1 on failure.
 271 If the wide character can be represented as a single-byte character,
 272 convert it with
 273 .Xr wctob 3 ,
 274 store the result in
 275 .Fa ch ,
 276 and return 1; otherwise, set
 277 .Va errno
 278 to
 279 .Er ERANGE
 280 and return \-1.
 281 In the C or POSIX locale, this simply reads a byte, but for any other
 282 locale, including UTF-8, this is rarely useful.
 283 .It Fn el_wpush
 284 Push the wide character string
 285 .Fa wcs
 286 back onto the input queue described in
 287 .Xr editline 7 .
 288 If the queue overflows, for example due to a recursive macro,
 289 or if an error occurs, for example because
 290 .Fa wcs
 291 is
 292 .Dv NULL
 293 or memory allocation fails, the function beeps at the user,
 294 but does not report the problem to the caller.
 295 .It Fn el_push
 296 Use the current locale to convert the multibyte string
 297 .Fa mbs
 298 to a wide character string, and pass the result to
 299 .Fn el_wpush .
 300 .It Fn el_parse
 301 Parses the
 302 .Fa argv
 303 array (which is
 304 .Fa argc
 305 elements in size)
 306 to execute builtin
 307 .Nm
 308 commands.
 309 If the command is prefixed with
 310 .Dq prog :
 311 then
 312 .Fn el_parse
 313 will only execute the command if
 314 .Dq prog
 315 matches the
 316 .Fa prog
 317 argument supplied to
 318 .Fn el_init .
 319 The return value is
 320 \-1 if the command is unknown,
 321 0 if there was no error or
 322 .Dq prog
 323 didn't match, or
 324 1 if the command returned an error.
 325 Refer to
 326 .Xr editrc 5
 327 for more information.
 328 .It Fn el_set
 329 Set
 330 .Nm
 331 parameters.
 332 .Fa op
 333 determines which parameter to set, and each operation has its
 334 own parameter list.
 335 Returns 0 on success, \-1 on failure.
 336 .Pp
 337 The following values for
 338 .Fa op
 339 are supported, along with the required argument list:
 340 .Bl -tag -width 4n
 341 .It Dv EL_PROMPT , Fa "char *(*f)(EditLine *)"
 342 Define prompt printing function as
 343 .Fa f ,
 344 which is to return a string that contains the prompt.
 345 .It Dv EL_PROMPT_ESC , Fa "char *(*f)(EditLine *)" , Fa "char c"
 346 Same as
 347 .Dv EL_PROMPT ,
 348 but the
 349 .Fa c
 350 argument indicates the start/stop literal prompt character.
 351 .Pp
 352 If a start/stop literal character is found in the prompt, the
 353 character itself
 354 is not printed, but characters after it are printed directly to the
 355 terminal without affecting the state of the current line.
 356 A subsequent second start/stop literal character ends this behavior.
 357 This is typically used to embed literal escape sequences that change the
 358 color/style of the terminal in the prompt.
 359 Note that the literal escape character cannot be the last character in the
 360 prompt, as the escape sequence is attached to the next character in the prompt.
 361 .Dv 0
 362 unsets it.
 363 .It Dv EL_REFRESH
 364 Re-display the current line on the next terminal line.
 365 .It Dv EL_RPROMPT , Fa "char *(*f)(EditLine *)"
 366 Define right side prompt printing function as
 367 .Fa f ,
 368 which is to return a string that contains the prompt.
 369 .It Dv EL_RPROMPT_ESC , Fa "char *(*f)(EditLine *)" , Fa "char c"
 370 Define the right prompt printing function but with a literal escape character.
 371 .It Dv EL_TERMINAL , Fa "const char *type"
 372 Define terminal type of the tty to be
 373 .Fa type ,
 374 or to
 375 .Ev TERM
 376 if
 377 .Fa type
 378 is
 379 .Dv NULL .
 380 .It Dv EL_EDITOR , Fa "const char *mode"
 381 Set editing mode to
 382 .Fa mode ,
 383 which must be one of
 384 .Dq emacs
 385 or
 386 .Dq vi .
 387 .It Dv EL_SIGNAL , Fa "int flag"
 388 If
 389 .Fa flag
 390 is non-zero,
 391 .Nm
 392 will install its own signal handler for the following signals when
 393 reading command input:
 394 .Dv SIGCONT ,
 395 .Dv SIGHUP ,
 396 .Dv SIGINT ,
 397 .Dv SIGQUIT ,
 398 .Dv SIGSTOP ,
 399 .Dv SIGTERM ,
 400 .Dv SIGTSTP ,
 401 and
 402 .Dv SIGWINCH .
 403 Otherwise, the current signal handlers will be used.
 404 .It Dv EL_BIND , Fa "const char *" , Fa "..." , Dv NULL
 405 Perform the
 406 .Ic bind
 407 builtin command.
 408 Refer to
 409 .Xr editrc 5
 410 for more information.
 411 .It Dv EL_ECHOTC , Fa "const char *" , Fa "..." , Dv NULL
 412 Perform the
 413 .Ic echotc
 414 builtin command.
 415 Refer to
 416 .Xr editrc 5
 417 for more information.
 418 .It Dv EL_SETTC , Fa "const char *" , Fa "..." , Dv NULL
 419 Perform the
 420 .Ic settc
 421 builtin command.
 422 Refer to
 423 .Xr editrc 5
 424 for more information.
 425 .It Dv EL_SETTY , Fa "const char *" , Fa "..." , Dv NULL
 426 Perform the
 427 .Ic setty
 428 builtin command.
 429 Refer to
 430 .Xr editrc 5
 431 for more information.
 432 .It Dv EL_TELLTC , Fa "const char *" , Fa "..." , Dv NULL
 433 Perform the
 434 .Ic telltc
 435 builtin command.
 436 Refer to
 437 .Xr editrc 5
 438 for more information.
 439 .It Dv EL_ADDFN , Fa "const char *name" , Fa "const char *help" , \
 440 Fa "unsigned char (*func)(EditLine *e, int ch)"
 441 Add a user defined function,
 442 .Fn func ,
 443 referred to as
 444 .Fa name
 445 which is invoked when a key which is bound to
 446 .Fa name
 447 is entered.
 448 .Fa help
 449 is a description of
 450 .Fa name .
 451 At invocation time,
 452 .Fa ch
 453 is the key which caused the invocation.
 454 The return value of
 455 .Fn func
 456 should be one of:
 457 .Bl -tag -width "CC_REDISPLAY"
 458 .It Dv CC_NORM
 459 Add a normal character.
 460 .It Dv CC_NEWLINE
 461 End of line was entered.
 462 .It Dv CC_EOF
 463 EOF was entered.
 464 .It Dv CC_ARGHACK
 465 Expecting further command input as arguments, do nothing visually.
 466 .It Dv CC_REFRESH
 467 Refresh display.
 468 .It Dv CC_REFRESH_BEEP
 469 Refresh display, and beep.
 470 .It Dv CC_CURSOR
 471 Cursor moved, so update and perform
 472 .Dv CC_REFRESH .
 473 .It Dv CC_REDISPLAY
 474 Redisplay entire input line.
 475 This is useful if a key binding outputs extra information.
 476 .It Dv CC_ERROR
 477 An error occurred.
 478 Beep, and flush tty.
 479 .It Dv CC_FATAL
 480 Fatal error, reset tty to known state.
 481 .El
 482 .It Dv EL_HIST , Fa "History *(*func)(History *, int op, ...)" , \
 483 Fa "const char *ptr"
 484 Defines which history function to use, which is usually
 485 .Fn history .
 486 .Fa ptr
 487 should be the value returned by
 488 .Fn history_init .
 489 .It Dv EL_EDITMODE , Fa "int flag"
 490 If
 491 .Fa flag
 492 is non-zero,
 493 editing is enabled (the default).
 494 Note that this is only an indication, and does not
 495 affect the operation of
 496 .Nm .
 497 At this time, it is the caller's responsibility to
 498 check this
 499 (using
 500 .Fn el_get )
 501 to determine if editing should be enabled or not.
 502 .It Dv EL_UNBUFFERED , Fa "int flag"
 503 If
 504 .Fa flag
 505 is zero,
 506 unbuffered mode is disabled (the default).
 507 In unbuffered mode,
 508 .Fn el_gets
 509 will return immediately after processing a single character.
 510 .It Dv EL_SAFEREAD , Fa "int flag"
 511 If the
 512 .Fa flag
 513 argument is non-zero, then
 514 .Nm editline
 515 attempts to recover from read errors, ignoring the first interrrupted
 516 error, and trying to reset the input file descriptor to reset non-blocking I/O.
 517 This is disabled by default, and desirable only when
 518 .Nm editline
 519 is used in shell-like applications.
 520 .It Dv EL_GETCFN , Fa "el_rfunc_t f"
 521 Whenever reading a character, use the function
 522 .Bd -ragged -offset indent -compact
 523 .Ft int
 524 .Fo f
 525 .Fa "EditLine *e"
 526 .Fa "wchar_t *wc"
 527 .Fc
 528 .Ed
 529 which stores the character in
 530 .Fa wc
 531 and returns 1 on success, 0 on end of file, or \-1 on I/O or encoding
 532 errors.
 533 Functions internally using it include
 534 .Fn el_wgets ,
 535 .Fn el_wgetc ,
 536 .Fn el_gets ,
 537 and
 538 .Fn el_getc .
 539 Initially, a builtin function is installed, and replacing it
 540 is discouraged because writing such a function is very error prone.
 541 The builtin function can be restored at any time by passing the
 542 special value
 543 .Dv EL_BUILTIN_GETCFN
 544 instead of a function pointer.
 545 .It Dv EL_CLIENTDATA , Fa "void *data"
 546 Register
 547 .Fa data
 548 to be associated with this EditLine structure.
 549 It can be retrieved with the corresponding
 550 .Fn el_get
 551 call.
 552 .It Dv EL_SETFP , Fa "int fd" , Fa "FILE *fp"
 553 Set the current
 554 .Nm editline
 555 file pointer for
 556 .Dq input
 557 .Fa fd
 558 =
 559 .Dv 0 ,
 560 .Dq output
 561 .Fa fd
 562 =
 563 .Dv 1 ,
 564 or
 565 .Dq error
 566 .Fa fd
 567 =
 568 .Dv 2
 569 from
 570 .Fa fp .
 571 .El
 572 .It Fn el_get
 573 Get
 574 .Nm
 575 parameters.
 576 .Fa op
 577 determines which parameter to retrieve into
 578 .Fa result .
 579 Returns 0 if successful, \-1 otherwise.
 580 .Pp
 581 The following values for
 582 .Fa op
 583 are supported, along with actual type of
 584 .Fa result :
 585 .Bl -tag -width 4n
 586 .It Dv EL_PROMPT , Fa "char *(*f)(EditLine *)" , Fa "char *c"
 587 Set
 588 .Fa f
 589 to a pointer to the function that displays the prompt.
 590 If
 591 .Fa c
 592 is not
 593 .Dv NULL ,
 594 set it to the start/stop literal prompt character.
 595 .It Dv EL_RPROMPT , Fa "char *(*f)(EditLine *)" , Fa "char *c"
 596 Set
 597 .Fa f
 598 to a pointer to the function that displays the prompt.
 599 If
 600 .Fa c
 601 is not
 602 .Dv NULL ,
 603 set it to the start/stop literal prompt character.
 604 .It Dv EL_EDITOR , Fa "const char **n"
 605 Set the name of the editor in
 606 .Fa n ,
 607 which will be one of
 608 .Dq emacs
 609 or
 610 .Dq vi .
 611 .It Dv EL_GETTC , Fa "const char *name" , Fa "void *value"
 612 If
 613 .Fa name
 614 is a valid
 615 .Xr termcap 5
 616 capability set
 617 .Fa value
 618 to the current value of that capability.
 619 .It Dv EL_SIGNAL , Fa "int *s"
 620 Set
 621 .Fa s
 622 to non-zero if
 623 .Nm
 624 has installed private signal handlers (see
 625 .Fn el_get
 626 above).
 627 .It Dv EL_EDITMODE , Fa "int *c"
 628 Set
 629 .Fa c
 630 to non-zero if editing is enabled.
 631 .It Dv EL_GETCFN , Fa "el_rfunc_t *f"
 632 Set
 633 .Fa f
 634 to a pointer to the function that reads characters, or to
 635 .Dv EL_BUILTIN_GETCFN
 636 if the builtin function is in use.
 637 .It Dv EL_CLIENTDATA , Fa "void **data"
 638 Set
 639 .Fa data
 640 to the previously registered client data set by an
 641 .Fn el_set
 642 call.
 643 .It Dv EL_UNBUFFERED , Fa "int *c"
 644 Set
 645 .Fa c
 646 to non-zero if unbuffered mode is enabled.
 647 .It Dv EL_SAFEREAD , Fa "int *c"
 648 Set
 649 .Fa c
 650 to non-zero if safe read is set.
 651 .It Dv EL_GETFP , Fa "int fd", Fa "FILE **fp"
 652 Set
 653 .Fa fp
 654 to the current
 655 .Nm editline
 656 file pointer for
 657 .Dq input
 658 .Fa fd
 659 =
 660 .Dv 0 ,
 661 .Dq output
 662 .Fa fd
 663 =
 664 .Dv 1 ,
 665 or
 666 .Dq error
 667 .Fa fd
 668 =
 669 .Dv 2 .
 670 .El
 671 .It Fn el_source
 672 Initialize
 673 .Nm
 674 by reading the contents of
 675 .Fa file .
 676 .Fn el_parse
 677 is called for each line in
 678 .Fa file .
 679 If
 680 .Fa file
 681 is
 682 .Dv NULL ,
 683 try
 684 .Pa $EDITRC
 685 and if that is not set
 686 .Pa $HOME/.editrc .
 687 Refer to
 688 .Xr editrc 5
 689 for details on the format of
 690 .Fa file .
 691 .Fn el_source
 692 returns 0 on success and \-1 on error.
 693 .It Fn el_resize
 694 Must be called if the terminal size changes.
 695 If
 696 .Dv EL_SIGNAL
 697 has been set with
 698 .Fn el_set ,
 699 then this is done automatically.
 700 Otherwise, it's the responsibility of the application to call
 701 .Fn el_resize
 702 on the appropriate occasions.
 703 .It Fn el_cursor
 704 Move the cursor to the right (if positive) or to the left (if negative)
 705 .Fa count
 706 characters.
 707 Returns the resulting offset of the cursor from the beginning of the line.
 708 .It Fn el_line
 709 Return the editing information for the current line in a
 710 .Fa LineInfo
 711 structure, which is defined as follows:
 712 .Bd -literal
 713 typedef struct lineinfo {
 714     const char *buffer;    /* address of buffer */
 715     const char *cursor;    /* address of cursor */
 716     const char *lastchar;  /* address of last character */
 717 } LineInfo;
 718 .Ed
 719 .Pp
 720 .Fa buffer
 721 is not NUL terminated.
 722 This function may be called after
 723 .Fn el_gets
 724 to obtain the
 725 .Fa LineInfo
 726 structure pertaining to line returned by that function,
 727 and from within user defined functions added with
 728 .Dv EL_ADDFN .
 729 .It Fn el_insertstr
 730 Insert
 731 .Fa str
 732 into the line at the cursor.
 733 Returns \-1 if
 734 .Fa str
 735 is empty or won't fit, and 0 otherwise.
 736 .It Fn el_deletestr
 737 Delete
 738 .Fa count
 739 characters before the cursor.
 740 .El
 741 .Sh HISTORY LIST FUNCTIONS
 742 The history functions use a common data structure,
 743 .Fa History ,
 744 which is created by
 745 .Fn history_init
 746 and freed by
 747 .Fn history_end .
 748 .Pp
 749 The following functions are available:
 750 .Bl -tag -width 4n
 751 .It Fn history_init
 752 Initialize the history list, and return a data structure
 753 to be used by all other history list functions, or
 754 .Dv NULL
 755 on failure.
 756 .It Fn history_end
 757 Clean up and finish with
 758 .Fa h ,
 759 assumed to have been created with
 760 .Fn history_init .
 761 .It Fn history
 762 Perform operation
 763 .Fa op
 764 on the history list, with optional arguments as needed by the
 765 operation.
 766 .Fa ev
 767 is changed accordingly to operation.
 768 The following values for
 769 .Fa op
 770 are supported, along with the required argument list:
 771 .Bl -tag -width 4n
 772 .It Dv H_SETSIZE , Fa "int size"
 773 Set size of history to
 774 .Fa size
 775 elements.
 776 .It Dv H_GETSIZE
 777 Get number of events currently in history.
 778 .It Dv H_END
 779 Cleans up and finishes with
 780 .Fa h ,
 781 assumed to be created with
 782 .Fn history_init .
 783 .It Dv H_CLEAR
 784 Clear the history.
 785 .It Dv H_FUNC , Fa "void *ptr" , Fa "history_gfun_t first" , \
 786 Fa "history_gfun_t next" , Fa "history_gfun_t last" , \
 787 Fa "history_gfun_t prev" , Fa "history_gfun_t curr" , \
 788 Fa "history_sfun_t set" , Fa "history_vfun_t clear" , \
 789 Fa "history_efun_t enter" , Fa "history_efun_t add"
 790 Define functions to perform various history operations.
 791 .Fa ptr
 792 is the argument given to a function when it's invoked.
 793 .It Dv H_FIRST
 794 Return the first element in the history.
 795 .It Dv H_LAST
 796 Return the last element in the history.
 797 .It Dv H_PREV
 798 Return the previous element in the history.
 799 It is newer than the current one.
 800 .It Dv H_NEXT
 801 Return the next element in the history.
 802 It is older than the current one.
 803 .It Dv H_CURR
 804 Return the current element in the history.
 805 .It Dv H_SET , Fa "int position"
 806 Set the cursor to point to the requested element.
 807 .It Dv H_ADD , Fa "const char *str"
 808 Append
 809 .Fa str
 810 to the current element of the history, or perform the
 811 .Dv H_ENTER
 812 operation with argument
 813 .Fa str
 814 if there is no current element.
 815 .It Dv H_APPEND , Fa "const char *str"
 816 Append
 817 .Fa str
 818 to the last new element of the history.
 819 .It Dv H_ENTER , Fa "const char *str"
 820 Add
 821 .Fa str
 822 as a new element to the history and, if necessary,
 823 removing the oldest entry to keep the list to the created size.
 824 If
 825 .Dv H_SETUNIQUE
 826 has been called with a non-zero argument, the element
 827 will not be entered into the history if its contents match
 828 the ones of the current history element.
 829 If the element is entered
 830 .Fn history
 831 returns 1; if it is ignored as a duplicate returns 0.
 832 Finally
 833 .Fn history
 834 returns \-1 if an error occurred.
 835 .It Dv H_PREV_STR , Fa "const char *str"
 836 Return the closest previous event that starts with
 837 .Fa str .
 838 .It Dv H_NEXT_STR , Fa "const char *str"
 839 Return the closest next event that starts with
 840 .Fa str .
 841 .It Dv H_PREV_EVENT , Fa "int e"
 842 Return the previous event numbered
 843 .Fa e .
 844 .It Dv H_NEXT_EVENT , Fa "int e"
 845 Return the next event numbered
 846 .Fa e .
 847 .It Dv H_LOAD , Fa "const char *file"
 848 Load the history list stored in
 849 .Fa file .
 850 .It Dv H_SAVE , Fa "const char *file"
 851 Save the history list to
 852 .Fa file .
 853 .It Dv H_SAVE_FP , Fa "FILE *fp"
 854 Save the history list to the opened
 855 .Ft FILE
 856 pointer
 857 .Fa fp .
 858 .It Dv H_NSAVE_FP , Fa "size_t n" , Fa "FILE *fp"
 859 Save the last
 860 .Ft n
 861 history entries to the opened
 862 .Ft FILE
 863 pointer
 864 .Fa fp .
 865 .It Dv H_SETUNIQUE , Fa "int unique"
 866 Set flag that adjacent identical event strings should not be entered
 867 into the history.
 868 .It Dv H_GETUNIQUE
 869 Retrieve the current setting if adjacent identical elements should
 870 be entered into the history.
 871 .It Dv H_DEL , Fa "int e"
 872 Delete the event numbered
 873 .Fa e .
 874 This function is only provided for
 875 .Nm readline
 876 compatibility.
 877 The caller is responsible for free'ing the string in the returned
 878 .Fa HistEvent .
 879 .El
 880 .Pp
 881 .Fn history
 882 returns >= 0 if the operation
 883 .Fa op
 884 succeeds.
 885 Otherwise, \-1 is returned and
 886 .Fa ev
 887 is updated to contain more details about the error.
 888 .El
 889 .Sh TOKENIZATION FUNCTIONS
 890 The tokenization functions use a common data structure,
 891 .Fa Tokenizer ,
 892 which is created by
 893 .Fn tok_init
 894 and freed by
 895 .Fn tok_end .
 896 .Pp
 897 The following functions are available:
 898 .Bl -tag -width 4n
 899 .It Fn tok_init
 900 Initialize the tokenizer, and return a data structure
 901 to be used by all other tokenizer functions.
 902 .Fa IFS
 903 contains the Input Field Separators, which defaults to
 904 .Aq space ,
 905 .Aq tab ,
 906 and
 907 .Aq newline
 908 if
 909 .Dv NULL .
 910 .It Fn tok_end
 911 Clean up and finish with
 912 .Fa t ,
 913 assumed to have been created with
 914 .Fn tok_init .
 915 .It Fn tok_reset
 916 Reset the tokenizer state.
 917 Use after a line has been successfully tokenized
 918 by
 919 .Fn tok_line
 920 or
 921 .Fn tok_str
 922 and before a new line is to be tokenized.
 923 .It Fn tok_line
 924 Tokenize
 925 .Fa li ,
 926 If successful, modify:
 927 .Fa argv
 928 to contain the words,
 929 .Fa argc
 930 to contain the number of words,
 931 .Fa cursorc
 932 (if not
 933 .Dv NULL )
 934 to contain the index of the word containing the cursor,
 935 and
 936 .Fa cursoro
 937 (if not
 938 .Dv NULL )
 939 to contain the offset within
 940 .Fa argv[cursorc]
 941 of the cursor.
 942 .Pp
 943 Returns
 944 0 if successful,
 945 \-1 for an internal error,
 946 1 for an unmatched single quote,
 947 2 for an unmatched double quote,
 948 and
 949 3 for a backslash quoted
 950 .Aq newline .
 951 A positive exit code indicates that another line should be read
 952 and tokenization attempted again.
 953 .
 954 .It Fn tok_str
 955 A simpler form of
 956 .Fn tok_line ;
 957 .Fa str
 958 is a NUL terminated string to tokenize.
 959 .El
 960 .
 961 .\"XXX.Sh EXAMPLES
 962 .\"XXX: provide some examples
 963 .Sh SEE ALSO
 964 .Xr sh 1 ,
 965 .Xr signal 3 ,
 966 .Xr termcap 3 ,
 967 .Xr editrc 5 ,
 968 .Xr termcap 5 ,
 969 .Xr editline 7
 970 .Sh HISTORY
 971 The
 972 .Nm
 973 library first appeared in
 974 .Bx 4.4 .
 975 .Dv CC_REDISPLAY
 976 appeared in
 977 .Nx 1.3 .
 978 .Dv CC_REFRESH_BEEP ,
 979 .Dv EL_EDITMODE
 980 and the readline emulation appeared in
 981 .Nx 1.4 .
 982 .Dv EL_RPROMPT
 983 appeared in
 984 .Nx 1.5 .
 985 .Sh AUTHORS
 986 .An -nosplit
 987 The
 988 .Nm
 989 library was written by
 990 .An Christos Zoulas .
 991 .An Luke Mewburn
 992 wrote this manual and implemented
 993 .Dv CC_REDISPLAY ,
 994 .Dv CC_REFRESH_BEEP ,
 995 .Dv EL_EDITMODE ,
 996 and
 997 .Dv EL_RPROMPT .
 998 .An Jaromir Dolecek
 999 implemented the readline emulation.
1000 .An Johny Mattsson
1001 implemented wide-character support.
1002 .Sh BUGS
1003 At this time, it is the responsibility of the caller to
1004 check the result of the
1005 .Dv EL_EDITMODE
1006 operation of
1007 .Fn el_get
1008 (after an
1009 .Fn el_source
1010 or
1011 .Fn el_parse )
1012 to determine if
1013 .Nm
1014 should be used for further input.
1015 I.e.,
1016 .Dv EL_EDITMODE
1017 is purely an indication of the result of the most recent
1018 .Xr editrc 5
1019 .Ic edit
1020 command.