| blob | 97727460b46b1e222d010bc05dce79734351c83d |
1 /* Readline.h -- the names of functions callable from within readline. */
3 /* Copyright (C) 1987-2011 Free Software Foundation, Inc.
5 This file is part of the GNU Readline Library (Readline), a library
6 for reading lines of text with interactive input and history editing.
8 Readline is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 Readline is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with Readline. If not, see <http://www.gnu.org/licenses/>.
20 */
22 #if !defined (_READLINE_H_)
23 #define _READLINE_H_
25 #ifdef __cplusplus
27 #endif
29 #if defined (READLINE_LIBRARY)
34 #else
35 # include <readline/rlstdc.h>
36 # include <readline/rltypedefs.h>
37 # include <readline/keymaps.h>
38 # include <readline/tilde.h>
39 #endif
41 /* Hex-encoded Readline version number. */
43 #define RL_VERSION_MAJOR 6
44 #define RL_VERSION_MINOR 2
46 /* Readline data structures. */
48 /* Maintaining the state of undo. We remember individual deletes and inserts
49 on a chain of things to do. */
51 /* The actions that undo knows how to undo. Notice that UNDO_DELETE means
52 to insert some text, and UNDO_INSERT means to delete some text. I.e.,
53 the code tells undo what to undo, not how to undo it. */
56 /* What an element of THE_UNDO_LIST looks like. */
64 /* The current undo list for RL_LINE_BUFFER. */
67 /* The data structure for mapping textual names to code addresses. */
75 /* **************************************************************** */
76 /* */
77 /* Functions available to bind to key sequences */
78 /* */
79 /* **************************************************************** */
81 /* Bindable commands for numeric arguments. */
85 /* 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. */
158 /* Bindable commands for killing and yanking text, and managing the kill ring. */
175 /* Not available unless _WIN32 is defined. */
176 #ifdef _WIN32
178 #endif
180 /* Bindable commands for incremental searching. */
184 /* Bindable keyboard macro commands. */
189 /* Bindable undo commands. */
193 /* Bindable tilde expansion commands. */
196 /* Bindable terminal control commands. */
200 /* Miscellaneous bindable commands. */
204 /* Bindable commands for incremental and non-incremental history searching. */
212 /* Bindable command used when inserting a matching close character. */
215 /* Not available unless READLINE_CALLBACKS is defined. */
220 /* Things for vi mode. Not available unless readline is compiled -DVI_MODE. */
221 /* VI-mode bindable commands. */
261 /* VI-mode utility functions. */
268 /* VI-mode pseudo-bindable commands, used as utility functions. */
276 /* **************************************************************** */
277 /* */
278 /* Well Published Functions */
279 /* */
280 /* **************************************************************** */
282 /* Readline functions. */
283 /* Read a line of input. Prompt with PROMPT. A NULL PROMPT means none. */
291 /* Undocumented; unused by readline */
294 /* Utility functions to bind keys to readline commands. */
307 extern int rl_bind_keyseq_if_unbound_in_map PARAMS((const char *, rl_command_func_t *, Keymap));
313 /* Backwards compatibility, use rl_bind_keyseq_in_map instead. */
316 /* Backwards compatibility, use rl_generic_bind instead. */
319 /* Undocumented in the texinfo manual; not really useful to programs. */
337 /* Functions for manipulating keymaps. */
347 /* Undocumented; used internally only. */
351 /* Functions for manipulating the funmap, which maps command names to functions. */
354 /* Undocumented, only used internally -- there is only one funmap, and this
355 function may be called only once. */
358 /* Utility functions for managing keyboard macros. */
361 /* Functions for undoing, from undo.c */
369 /* Functions for redisplay. */
378 #if defined (USE_VARARGS) && defined (PREFER_STDARG)
380 #else
382 #endif
386 /* Undocumented in texinfo manual. */
389 /* Save and restore internal prompt redisplay information. */
393 /* Modifying text. */
400 /* Terminal and tty mode management. */
414 /* Functions for character input. */
422 /* `Public' utility functions . */
428 /* Readline signal handling, from signals.c */
439 /* Undocumented. */
444 /* Completion functions. */
454 #if 0
455 /* Backwards compatibility (compat.c). These will go away sometime. */
468 #endif
470 /* **************************************************************** */
471 /* */
472 /* Well Published Variables */
473 /* */
474 /* **************************************************************** */
476 /* The version of this incarnation of the readline library. */
480 /* True if this is real GNU readline. */
483 /* Flags word encapsulating the current readline state. */
486 /* Says which editing mode readline is currently using. 1 means emacs mode;
487 0 means vi mode. */
490 /* Insert or overwrite mode for emacs mode. 1 means insert mode; 0 means
491 overwrite mode. Reset to insert mode on each input line. */
494 /* The name of the calling program. You should initialize this to
495 whatever was in argv[0]. It is used when parsing conditionals. */
498 /* The prompt readline uses. This is set from the argument to
499 readline (), and should not be assigned to directly. */
502 /* The prompt string that is actually displayed by rl_redisplay. Public so
503 applications can more easily supply their own redisplay functions. */
506 /* The line buffer that is in use. */
509 /* The location of point, and end. */
513 /* The mark, or saved cursor position. */
516 /* Flag to indicate that readline has finished with the current input
517 line and should return it. */
520 /* If set to a character value, that will be the next keystroke read. */
523 /* Non-zero if we called this function from _rl_dispatch(). It's present
524 so functions can find out whether they were called from a key binding
525 or directly from an application. */
528 /* Non-zero if the user typed a numeric argument before executing the
529 current function. */
532 /* The current value of the numeric argument specified by the user. */
535 /* The address of the last command function Readline executed. */
538 /* The name of the terminal to use. */
541 /* The input and output streams. */
545 /* If non-zero, Readline gives values of LINES and COLUMNS from the environment
546 greater precedence than values fetched from the kernel when computing the
547 screen dimensions. */
550 /* If non-zero, then this is the address of a function to call just
551 before readline_internal () prints the first prompt. */
554 /* If non-zero, this is the address of a function to call just before
555 readline_internal_setup () returns and readline_internal starts
556 reading input characters. */
559 /* The address of a function to call periodically while Readline is
560 awaiting character input, or NULL, for no event handling. */
563 /* The address of the function to call to fetch a character from the current
564 Readline input stream */
572 /* Dispatch variables. */
576 /* Display variables. */
577 /* If non-zero, readline will erase the entire line, including any prompt,
578 if the only thing typed on an otherwise-blank line is something bound to
579 rl_newline. */
582 /* If non-zero, the application has already printed the prompt (rl_prompt)
583 before calling readline, so readline should not output it the first time
584 redisplay is done. */
587 /* A non-zero value means to read only this many characters rather than
588 up to a character bound to accept-line. */
591 /* The text of a currently-executing keyboard macro. */
594 /* Variables to control readline signal handling. */
595 /* If non-zero, readline will install its own signal handlers for
596 SIGINT, SIGTERM, SIGQUIT, SIGALRM, SIGTSTP, SIGTTIN, and SIGTTOU. */
599 /* If non-zero, readline will install a signal handler for SIGWINCH
600 that also attempts to call any calling application's SIGWINCH signal
601 handler. Note that the terminal is not cleaned up before the
602 application's signal handler is called; use rl_cleanup_after_signal()
603 to do that. */
606 /* Completion variables. */
607 /* Pointer to the generator function for completion_matches ().
608 NULL means to use rl_filename_completion_function (), the default
609 filename completer. */
612 /* Optional generator for menu completion. Default is
613 rl_completion_entry_function (rl_filename_completion_function). */
616 /* If rl_ignore_some_completions_function is non-NULL it is the address
617 of a function to call after all of the possible matches have been
618 generated, but before the actual completion is done to the input line.
619 The function is called with one argument; a NULL terminated array
620 of (char *). If your function removes any of the elements, they
621 must be free()'ed. */
624 /* Pointer to alternative function to create matches.
625 Function is called with TEXT, START, and END.
626 START and END are indices in RL_LINE_BUFFER saying what the boundaries
627 of TEXT are.
628 If this function exists and returns NULL then call the value of
629 rl_completion_entry_function to try to match, otherwise use the
630 array of strings returned. */
633 /* The basic list of characters that signal a break between words for the
634 completer routine. The initial contents of this variable is what
635 breaks words in the shell, i.e. "n\"\\'`@$>". */
638 /* The list of characters that signal a break between words for
639 rl_complete_internal. The default list is the contents of
640 rl_basic_word_break_characters. */
643 /* Hook function to allow an application to set the completion word
644 break characters before readline breaks up the line. Allows
645 position-dependent word break characters. */
648 /* List of characters which can be used to quote a substring of the line.
649 Completion occurs on the entire substring, and within the substring
650 rl_completer_word_break_characters are treated as any other character,
651 unless they also appear within this list. */
654 /* List of quote characters which cause a word break. */
657 /* List of characters that need to be quoted in filenames by the completer. */
660 /* List of characters that are word break characters, but should be left
661 in TEXT when it is passed to the completion function. The shell uses
662 this to help determine what kind of completing to do. */
665 /* If non-zero, then this is the address of a function to call when
666 completing on a directory name. The function is called with
667 the address of a string (the current directory name) as an arg. It
668 changes what is displayed when the possible completions are printed
669 or inserted. The directory completion hook should perform
670 any necessary dequoting. This function should return 1 if it modifies
671 the directory name pointer passed as an argument. If the directory
672 completion hook returns 0, it should not modify the directory name
673 pointer passed as an argument. */
676 /* If non-zero, this is the address of a function to call when completing
677 a directory name. This function takes the address of the directory name
678 to be modified as an argument. Unlike rl_directory_completion_hook, it
679 only modifies the directory name used in opendir(2), not what is displayed
680 when the possible completions are printed or inserted. If set, it takes
681 precedence over rl_directory_completion_hook. The directory rewrite
682 hook should perform any necessary dequoting. This function has the same
683 return value properties as the directory_completion_hook.
685 I'm not happy with how this works yet, so it's undocumented. I'm trying
686 it in bash to see how well it goes. */
689 /* If non-zero, this is the address of a function to call when reading
690 directory entries from the filesystem for completion and comparing
691 them to the partial word to be completed. The function should
692 either return its first argument (if no conversion takes place) or
693 newly-allocated memory. This can, for instance, convert filenames
694 between character sets for comparison against what's typed at the
695 keyboard. The returned value is what is added to the list of
696 matches. The second argument is the length of the filename to be
697 converted. */
700 /* Backwards compatibility with previous versions of readline. */
701 #define rl_symbolic_link_hook rl_directory_completion_hook
703 /* If non-zero, then this is the address of a function to call when
704 completing a word would normally display the list of possible matches.
705 This function is called instead of actually doing the display.
706 It takes three arguments: (char **matches, int num_matches, int max_length)
707 where MATCHES is the array of strings that matched, NUM_MATCHES is the
708 number of strings in that array, and MAX_LENGTH is the length of the
709 longest string in that array. */
712 /* Non-zero means that the results of the matches are to be treated
713 as filenames. This is ALWAYS zero on entry, and can only be changed
714 within a completion entry finder function. */
717 /* Non-zero means that the results of the matches are to be quoted using
718 double quotes (or an application-specific quoting mechanism) if the
719 filename contains any characters in rl_word_break_chars. This is
720 ALWAYS non-zero on entry, and can only be changed within a completion
721 entry finder function. */
724 /* Set to a function to quote a filename in an application-specific fashion.
725 Called with the text to quote, the type of match found (single or multiple)
726 and a pointer to the quoting character to be used, which the function can
727 reset if desired. */
730 /* Function to call to remove quoting characters from a filename. Called
731 before completion is attempted, so the embedded quotes do not interfere
732 with matching names in the file system. */
735 /* Function to call to decide whether or not a word break character is
736 quoted. If a character is quoted, it does not break words for the
737 completer. */
740 /* Non-zero means to suppress normal filename completion after the
741 user-specified completion function has been called. */
744 /* Set to a character describing the type of completion being attempted by
745 rl_complete_internal; available for use by application completion
746 functions. */
749 /* Set to the last key used to invoke one of the completion functions */
752 /* Up to this many items will be displayed in response to a
753 possible-completions call. After that, we ask the user if she
754 is sure she wants to see them all. The default value is 100. */
757 /* Character appended to completed words when at the end of the line. The
758 default is a space. Nothing is added if this is '\0'. */
761 /* If set to non-zero by an application completion function,
762 rl_completion_append_character will not be appended. */
765 /* Set to any quote character readline thinks it finds before any application
766 completion function is called. */
769 /* Set to a non-zero value if readline found quoting anywhere in the word to
770 be completed; set before any application completion function is called. */
773 /* If non-zero, the completion functions don't append any closing quote.
774 This is set to 0 by rl_complete_internal and may be changed by an
775 application-specific completion function. */
778 /* If non-zero, readline will sort the completion matches. On by default. */
781 /* If non-zero, a slash will be appended to completed filenames that are
782 symbolic links to directory names, subject to the value of the
783 mark-directories variable (which is user-settable). This exists so
784 that application completion functions can override the user's preference
785 (set via the mark-symlinked-directories variable) if appropriate.
786 It's set to the value of _rl_complete_mark_symlink_dirs in
787 rl_complete_internal before any application-specific completion
788 function is called, so without that function doing anything, the user's
789 preferences are honored. */
792 /* If non-zero, then disallow duplicates in the matches. */
795 /* If this is non-zero, completion is (temporarily) inhibited, and the
796 completion character will be inserted as any other. */
799 /* Input error; can be returned by (*rl_getc_function) if readline is reading
800 a top-level command (RL_ISSTATE (RL_STATE_READCMD)). */
801 #define READERR (-2)
803 /* Definitions available for use by readline clients. */
807 /* Possible values for do_replace argument to rl_filename_quoting_function,
808 called by rl_complete_internal. */
809 #define NO_MATCH 0
810 #define SINGLE_MATCH 1
811 #define MULT_MATCH 2
813 /* Possible state values for rl_readline_state */
843 #define RL_SETSTATE(x) (rl_readline_state |= (x))
844 #define RL_UNSETSTATE(x) (rl_readline_state &= ~(x))
845 #define RL_ISSTATE(x) (rl_readline_state & (x))
848 /* line state */
857 /* global state */
860 Keymap kmap;
862 /* input state */
872 /* signal state */
876 /* search state */
878 /* completion state */
880 /* options state */
882 /* reserved for future expansion, so the struct size doesn't change */
884 };
889 #ifdef __cplusplus
890 }
891 #endif