| blob | 222b317c4a8cb1ee93e3f1d66cac992dfe08ed65 |
1 /* Readline.h -- the names of functions callable from within readline. */
3 /* Copyright (C) 1987-2004 Free Software Foundation, Inc.
5 This file is part of the GNU Readline Library, a library for
6 reading lines of text with interactive input and history editing.
8 The GNU Readline Library is free software; you can redistribute it
9 and/or modify it under the terms of the GNU General Public License
10 as published by the Free Software Foundation; either version 2, or
11 (at your option) any later version.
13 The GNU Readline Library is distributed in the hope that it will be
14 useful, but WITHOUT ANY WARRANTY; without even the implied warranty
15 of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 The GNU General Public License is often shipped with GNU software, and
19 is generally kept in a file called COPYING or LICENSE. If you do not
20 have a copy of the license, write to the Free Software Foundation,
21 59 Temple Place, Suite 330, Boston, MA 02111 USA. */
23 #if !defined (_READLINE_H_)
24 #define _READLINE_H_
26 #ifdef __cplusplus
28 #endif
30 #if defined (READLINE_LIBRARY)
35 #else
36 # include <readline/rlstdc.h>
37 # include <readline/rltypedefs.h>
38 # include <readline/keymaps.h>
39 # include <readline/tilde.h>
40 #endif
42 /* Hex-encoded Readline version number. */
44 #define RL_VERSION_MAJOR 5
45 #define RL_VERSION_MINOR 0
47 /* Readline data structures. */
49 /* Maintaining the state of undo. We remember individual deletes and inserts
50 on a chain of things to do. */
52 /* The actions that undo knows how to undo. Notice that UNDO_DELETE means
53 to insert some text, and UNDO_INSERT means to delete some text. I.e.,
54 the code tells undo what to undo, not how to undo it. */
57 /* What an element of THE_UNDO_LIST looks like. */
65 /* The current undo list for RL_LINE_BUFFER. */
68 /* The data structure for mapping textual names to code addresses. */
76 /* **************************************************************** */
77 /* */
78 /* Functions available to bind to key sequences */
79 /* */
80 /* **************************************************************** */
82 /* Bindable commands for numeric arguments. */
86 /* Bindable commands for moving the cursor. */
101 /* Bindable commands for inserting and deleting text. */
114 /* Bindable commands for changing case. */
119 /* Bindable commands for transposing characters and words. */
123 /* Bindable commands for searching within a line. */
127 /* Bindable commands for readline's interface to the command history. */
133 /* Bindable commands for managing the mark and region. */
137 /* Bindable commands to set the editing mode (emacs or vi). */
141 /* Bindable commands to change the insert mode (insert or overwrite) */
144 /* Bindable commands for managing key bindings. */
150 /* Bindable commands for word completion. */
156 /* Bindable commands for killing and yanking text, and managing the kill ring. */
173 /* Not available unless __CYGWIN__ is defined. */
174 #ifdef __CYGWIN__
176 #endif
178 /* Bindable commands for incremental searching. */
182 /* Bindable keyboard macro commands. */
187 /* Bindable undo commands. */
191 /* Bindable tilde expansion commands. */
194 /* Bindable terminal control commands. */
198 /* Miscellaneous bindable commands. */
202 /* Bindable commands for incremental and non-incremental history searching. */
210 /* Bindable command used when inserting a matching close character. */
213 /* Not available unless READLINE_CALLBACKS is defined. */
218 /* Things for vi mode. Not available unless readline is compiled -DVI_MODE. */
219 /* VI-mode bindable commands. */
257 /* VI-mode utility functions. */
264 /* VI-mode pseudo-bindable commands, used as utility functions. */
272 /* **************************************************************** */
273 /* */
274 /* Well Published Functions */
275 /* */
276 /* **************************************************************** */
278 /* Readline functions. */
279 /* Read a line of input. Prompt with PROMPT. A NULL PROMPT means none. */
287 /* Undocumented; unused by readline */
290 /* Utility functions to bind keys to readline commands. */
303 extern int rl_bind_keyseq_if_unbound_in_map PARAMS((const char *, rl_command_func_t *, Keymap));
307 /* Backwards compatibility, use rl_bind_keyseq_in_map instead. */
310 /* Backwards compatibility, use rl_generic_bind instead. */
313 /* Undocumented in the texinfo manual; not really useful to programs. */
331 /* Functions for manipulating keymaps. */
341 /* Undocumented; used internally only. */
345 /* Functions for manipulating the funmap, which maps command names to functions. */
348 /* Undocumented, only used internally -- there is only one funmap, and this
349 function may be called only once. */
352 /* Utility functions for managing keyboard macros. */
355 /* Functions for undoing, from undo.c */
363 /* Functions for redisplay. */
372 #if defined (USE_VARARGS) && defined (PREFER_STDARG)
374 #else
376 #endif
380 /* Undocumented in texinfo manual. */
383 /* Save and restore internal prompt redisplay information. */
387 /* Modifying text. */
394 /* Terminal and tty mode management. */
407 /* Functions for character input. */
415 /* `Public' utility functions . */
420 /* Readline signal handling, from signals.c */
429 /* Undocumented. */
434 /* Completion functions. */
444 #if 0
445 /* Backwards compatibility (compat.c). These will go away sometime. */
458 #endif
460 /* **************************************************************** */
461 /* */
462 /* Well Published Variables */
463 /* */
464 /* **************************************************************** */
466 /* The version of this incarnation of the readline library. */
470 /* True if this is real GNU readline. */
473 /* Flags word encapsulating the current readline state. */
476 /* Says which editing mode readline is currently using. 1 means emacs mode;
477 0 means vi mode. */
480 /* Insert or overwrite mode for emacs mode. 1 means insert mode; 0 means
481 overwrite mode. Reset to insert mode on each input line. */
484 /* The name of the calling program. You should initialize this to
485 whatever was in argv[0]. It is used when parsing conditionals. */
488 /* The prompt readline uses. This is set from the argument to
489 readline (), and should not be assigned to directly. */
492 /* The line buffer that is in use. */
495 /* The location of point, and end. */
499 /* The mark, or saved cursor position. */
502 /* Flag to indicate that readline has finished with the current input
503 line and should return it. */
506 /* If set to a character value, that will be the next keystroke read. */
509 /* Non-zero if we called this function from _rl_dispatch(). It's present
510 so functions can find out whether they were called from a key binding
511 or directly from an application. */
514 /* Non-zero if the user typed a numeric argument before executing the
515 current function. */
518 /* The current value of the numeric argument specified by the user. */
521 /* The address of the last command function Readline executed. */
524 /* The name of the terminal to use. */
527 /* The input and output streams. */
531 /* If non-zero, then this is the address of a function to call just
532 before readline_internal () prints the first prompt. */
535 /* If non-zero, this is the address of a function to call just before
536 readline_internal_setup () returns and readline_internal starts
537 reading input characters. */
540 /* The address of a function to call periodically while Readline is
541 awaiting character input, or NULL, for no event handling. */
544 /* The address of the function to call to fetch a character from the current
545 Readline input stream */
553 /* Dispatch variables. */
557 /* Display variables. */
558 /* If non-zero, readline will erase the entire line, including any prompt,
559 if the only thing typed on an otherwise-blank line is something bound to
560 rl_newline. */
563 /* If non-zero, the application has already printed the prompt (rl_prompt)
564 before calling readline, so readline should not output it the first time
565 redisplay is done. */
568 /* A non-zero value means to read only this many characters rather than
569 up to a character bound to accept-line. */
572 /* The text of a currently-executing keyboard macro. */
575 /* Variables to control readline signal handling. */
576 /* If non-zero, readline will install its own signal handlers for
577 SIGINT, SIGTERM, SIGQUIT, SIGALRM, SIGTSTP, SIGTTIN, and SIGTTOU. */
580 /* If non-zero, readline will install a signal handler for SIGWINCH
581 that also attempts to call any calling application's SIGWINCH signal
582 handler. Note that the terminal is not cleaned up before the
583 application's signal handler is called; use rl_cleanup_after_signal()
584 to do that. */
587 /* Completion variables. */
588 /* Pointer to the generator function for completion_matches ().
589 NULL means to use rl_filename_completion_function (), the default
590 filename completer. */
593 /* If rl_ignore_some_completions_function is non-NULL it is the address
594 of a function to call after all of the possible matches have been
595 generated, but before the actual completion is done to the input line.
596 The function is called with one argument; a NULL terminated array
597 of (char *). If your function removes any of the elements, they
598 must be free()'ed. */
601 /* Pointer to alternative function to create matches.
602 Function is called with TEXT, START, and END.
603 START and END are indices in RL_LINE_BUFFER saying what the boundaries
604 of TEXT are.
605 If this function exists and returns NULL then call the value of
606 rl_completion_entry_function to try to match, otherwise use the
607 array of strings returned. */
610 /* The basic list of characters that signal a break between words for the
611 completer routine. The initial contents of this variable is what
612 breaks words in the shell, i.e. "n\"\\'`@$>". */
615 /* The list of characters that signal a break between words for
616 rl_complete_internal. The default list is the contents of
617 rl_basic_word_break_characters. */
620 /* Hook function to allow an application to set the completion word
621 break characters before readline breaks up the line. Allows
622 position-dependent word break characters. */
625 /* List of characters which can be used to quote a substring of the line.
626 Completion occurs on the entire substring, and within the substring
627 rl_completer_word_break_characters are treated as any other character,
628 unless they also appear within this list. */
631 /* List of quote characters which cause a word break. */
634 /* List of characters that need to be quoted in filenames by the completer. */
637 /* List of characters that are word break characters, but should be left
638 in TEXT when it is passed to the completion function. The shell uses
639 this to help determine what kind of completing to do. */
642 /* If non-zero, then this is the address of a function to call when
643 completing on a directory name. The function is called with
644 the address of a string (the current directory name) as an arg. It
645 changes what is displayed when the possible completions are printed
646 or inserted. */
649 /* If non-zero, this is the address of a function to call when completing
650 a directory name. This function takes the address of the directory name
651 to be modified as an argument. Unlike rl_directory_completion_hook, it
652 only modifies the directory name used in opendir(2), not what is displayed
653 when the possible completions are printed or inserted. It is called
654 before rl_directory_completion_hook. I'm not happy with how this works
655 yet, so it's undocumented. */
658 /* Backwards compatibility with previous versions of readline. */
659 #define rl_symbolic_link_hook rl_directory_completion_hook
661 /* If non-zero, then this is the address of a function to call when
662 completing a word would normally display the list of possible matches.
663 This function is called instead of actually doing the display.
664 It takes three arguments: (char **matches, int num_matches, int max_length)
665 where MATCHES is the array of strings that matched, NUM_MATCHES is the
666 number of strings in that array, and MAX_LENGTH is the length of the
667 longest string in that array. */
670 /* Non-zero means that the results of the matches are to be treated
671 as filenames. This is ALWAYS zero on entry, and can only be changed
672 within a completion entry finder function. */
675 /* Non-zero means that the results of the matches are to be quoted using
676 double quotes (or an application-specific quoting mechanism) if the
677 filename contains any characters in rl_word_break_chars. This is
678 ALWAYS non-zero on entry, and can only be changed within a completion
679 entry finder function. */
682 /* Set to a function to quote a filename in an application-specific fashion.
683 Called with the text to quote, the type of match found (single or multiple)
684 and a pointer to the quoting character to be used, which the function can
685 reset if desired. */
688 /* Function to call to remove quoting characters from a filename. Called
689 before completion is attempted, so the embedded quotes do not interfere
690 with matching names in the file system. */
693 /* Function to call to decide whether or not a word break character is
694 quoted. If a character is quoted, it does not break words for the
695 completer. */
698 /* Non-zero means to suppress normal filename completion after the
699 user-specified completion function has been called. */
702 /* Set to a character describing the type of completion being attempted by
703 rl_complete_internal; available for use by application completion
704 functions. */
707 /* Up to this many items will be displayed in response to a
708 possible-completions call. After that, we ask the user if she
709 is sure she wants to see them all. The default value is 100. */
712 /* Character appended to completed words when at the end of the line. The
713 default is a space. Nothing is added if this is '\0'. */
716 /* If set to non-zero by an application completion function,
717 rl_completion_append_character will not be appended. */
720 /* Set to any quote character readline thinks it finds before any application
721 completion function is called. */
724 /* Set to a non-zero value if readline found quoting anywhere in the word to
725 be completed; set before any application completion function is called. */
728 /* If non-zero, the completion functions don't append any closing quote.
729 This is set to 0 by rl_complete_internal and may be changed by an
730 application-specific completion function. */
733 /* If non-zero, a slash will be appended to completed filenames that are
734 symbolic links to directory names, subject to the value of the
735 mark-directories variable (which is user-settable). This exists so
736 that application completion functions can override the user's preference
737 (set via the mark-symlinked-directories variable) if appropriate.
738 It's set to the value of _rl_complete_mark_symlink_dirs in
739 rl_complete_internal before any application-specific completion
740 function is called, so without that function doing anything, the user's
741 preferences are honored. */
744 /* If non-zero, then disallow duplicates in the matches. */
747 /* If this is non-zero, completion is (temporarily) inhibited, and the
748 completion character will be inserted as any other. */
751 /* Definitions available for use by readline clients. */
755 /* Possible values for do_replace argument to rl_filename_quoting_function,
756 called by rl_complete_internal. */
757 #define NO_MATCH 0
758 #define SINGLE_MATCH 1
759 #define MULT_MATCH 2
761 /* Possible state values for rl_readline_state */
786 #define RL_SETSTATE(x) (rl_readline_state |= (x))
787 #define RL_UNSETSTATE(x) (rl_readline_state &= ~(x))
788 #define RL_ISSTATE(x) (rl_readline_state & (x))
791 /* line state */
800 /* global state */
803 Keymap kmap;
805 /* input state */
815 /* signal state */
819 /* search state */
821 /* completion state */
823 /* options state */
825 /* reserved for future expansion, so the struct size doesn't change */
827 };
832 #ifdef __cplusplus
833 }
834 #endif