1 /* Readline.h -- the names of functions callable from within readline. */
3 /* Copyright (C) 1987-2013 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/>.
22 #if !defined (_READLINE_H_)
29 #if defined (READLINE_LIBRARY)
31 # include "rltypedefs.h"
35 # include <readline/rlstdc.h>
36 # include <readline/rltypedefs.h>
37 # include <readline/keymaps.h>
38 # include <readline/tilde.h>
41 /* Hex-encoded Readline version number. */
42 #define RL_READLINE_VERSION 0x0700 /* Readline 7.0 */
43 #define RL_VERSION_MAJOR 7
44 #define RL_VERSION_MINOR 0
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. */
54 enum undo_code
{ UNDO_DELETE
, UNDO_INSERT
, UNDO_BEGIN
, UNDO_END
};
56 /* What an element of THE_UNDO_LIST looks like. */
57 typedef struct undo_list
{
58 struct undo_list
*next
;
59 int start
, end
; /* Where the change took place. */
60 char *text
; /* The text to insert, if undoing a delete. */
61 enum undo_code what
; /* Delete, Insert, Begin, End. */
64 /* The current undo list for RL_LINE_BUFFER. */
65 extern UNDO_LIST
*rl_undo_list
;
67 /* The data structure for mapping textual names to code addresses. */
68 typedef struct _funmap
{
70 rl_command_func_t
*function
;
73 extern FUNMAP
**funmap
;
75 /* **************************************************************** */
77 /* Functions available to bind to key sequences */
79 /* **************************************************************** */
81 /* Bindable commands for numeric arguments. */
82 extern int rl_digit_argument
PARAMS((int, int));
83 extern int rl_universal_argument
PARAMS((int, int));
85 /* Bindable commands for moving the cursor. */
86 extern int rl_forward_byte
PARAMS((int, int));
87 extern int rl_forward_char
PARAMS((int, int));
88 extern int rl_forward
PARAMS((int, int));
89 extern int rl_backward_byte
PARAMS((int, int));
90 extern int rl_backward_char
PARAMS((int, int));
91 extern int rl_backward
PARAMS((int, int));
92 extern int rl_beg_of_line
PARAMS((int, int));
93 extern int rl_end_of_line
PARAMS((int, int));
94 extern int rl_forward_word
PARAMS((int, int));
95 extern int rl_backward_word
PARAMS((int, int));
96 extern int rl_refresh_line
PARAMS((int, int));
97 extern int rl_clear_screen
PARAMS((int, int));
98 extern int rl_skip_csi_sequence
PARAMS((int, int));
99 extern int rl_arrow_keys
PARAMS((int, int));
101 /* Bindable commands for inserting and deleting text. */
102 extern int rl_insert
PARAMS((int, int));
103 extern int rl_quoted_insert
PARAMS((int, int));
104 extern int rl_tab_insert
PARAMS((int, int));
105 extern int rl_newline
PARAMS((int, int));
106 extern int rl_do_lowercase_version
PARAMS((int, int));
107 extern int rl_rubout
PARAMS((int, int));
108 extern int rl_delete
PARAMS((int, int));
109 extern int rl_rubout_or_delete
PARAMS((int, int));
110 extern int rl_delete_horizontal_space
PARAMS((int, int));
111 extern int rl_delete_or_show_completions
PARAMS((int, int));
112 extern int rl_insert_comment
PARAMS((int, int));
114 /* Bindable commands for changing case. */
115 extern int rl_upcase_word
PARAMS((int, int));
116 extern int rl_downcase_word
PARAMS((int, int));
117 extern int rl_capitalize_word
PARAMS((int, int));
119 /* Bindable commands for transposing characters and words. */
120 extern int rl_transpose_words
PARAMS((int, int));
121 extern int rl_transpose_chars
PARAMS((int, int));
123 /* Bindable commands for searching within a line. */
124 extern int rl_char_search
PARAMS((int, int));
125 extern int rl_backward_char_search
PARAMS((int, int));
127 /* Bindable commands for readline's interface to the command history. */
128 extern int rl_beginning_of_history
PARAMS((int, int));
129 extern int rl_end_of_history
PARAMS((int, int));
130 extern int rl_get_next_history
PARAMS((int, int));
131 extern int rl_get_previous_history
PARAMS((int, int));
133 /* Bindable commands for managing the mark and region. */
134 extern int rl_set_mark
PARAMS((int, int));
135 extern int rl_exchange_point_and_mark
PARAMS((int, int));
137 /* Bindable commands to set the editing mode (emacs or vi). */
138 extern int rl_vi_editing_mode
PARAMS((int, int));
139 extern int rl_emacs_editing_mode
PARAMS((int, int));
141 /* Bindable commands to change the insert mode (insert or overwrite) */
142 extern int rl_overwrite_mode
PARAMS((int, int));
144 /* Bindable commands for managing key bindings. */
145 extern int rl_re_read_init_file
PARAMS((int, int));
146 extern int rl_dump_functions
PARAMS((int, int));
147 extern int rl_dump_macros
PARAMS((int, int));
148 extern int rl_dump_variables
PARAMS((int, int));
150 /* Bindable commands for word completion. */
151 extern int rl_complete
PARAMS((int, int));
152 extern int rl_possible_completions
PARAMS((int, int));
153 extern int rl_insert_completions
PARAMS((int, int));
154 extern int rl_old_menu_complete
PARAMS((int, int));
155 extern int rl_menu_complete
PARAMS((int, int));
156 extern int rl_backward_menu_complete
PARAMS((int, int));
158 /* Bindable commands for killing and yanking text, and managing the kill ring. */
159 extern int rl_kill_word
PARAMS((int, int));
160 extern int rl_backward_kill_word
PARAMS((int, int));
161 extern int rl_kill_line
PARAMS((int, int));
162 extern int rl_backward_kill_line
PARAMS((int, int));
163 extern int rl_kill_full_line
PARAMS((int, int));
164 extern int rl_unix_word_rubout
PARAMS((int, int));
165 extern int rl_unix_filename_rubout
PARAMS((int, int));
166 extern int rl_unix_line_discard
PARAMS((int, int));
167 extern int rl_copy_region_to_kill
PARAMS((int, int));
168 extern int rl_kill_region
PARAMS((int, int));
169 extern int rl_copy_forward_word
PARAMS((int, int));
170 extern int rl_copy_backward_word
PARAMS((int, int));
171 extern int rl_yank
PARAMS((int, int));
172 extern int rl_yank_pop
PARAMS((int, int));
173 extern int rl_yank_nth_arg
PARAMS((int, int));
174 extern int rl_yank_last_arg
PARAMS((int, int));
175 extern int rl_bracketed_paste_begin
PARAMS((int, int));
176 /* Not available unless _WIN32 is defined. */
178 extern int rl_paste_from_clipboard
PARAMS((int, int));
181 /* Bindable commands for incremental searching. */
182 extern int rl_reverse_search_history
PARAMS((int, int));
183 extern int rl_forward_search_history
PARAMS((int, int));
185 /* Bindable keyboard macro commands. */
186 extern int rl_start_kbd_macro
PARAMS((int, int));
187 extern int rl_end_kbd_macro
PARAMS((int, int));
188 extern int rl_call_last_kbd_macro
PARAMS((int, int));
189 extern int rl_print_last_kbd_macro
PARAMS((int, int));
191 /* Bindable undo commands. */
192 extern int rl_revert_line
PARAMS((int, int));
193 extern int rl_undo_command
PARAMS((int, int));
195 /* Bindable tilde expansion commands. */
196 extern int rl_tilde_expand
PARAMS((int, int));
198 /* Bindable terminal control commands. */
199 extern int rl_restart_output
PARAMS((int, int));
200 extern int rl_stop_output
PARAMS((int, int));
202 /* Miscellaneous bindable commands. */
203 extern int rl_abort
PARAMS((int, int));
204 extern int rl_tty_status
PARAMS((int, int));
206 /* Bindable commands for incremental and non-incremental history searching. */
207 extern int rl_history_search_forward
PARAMS((int, int));
208 extern int rl_history_search_backward
PARAMS((int, int));
209 extern int rl_history_substr_search_forward
PARAMS((int, int));
210 extern int rl_history_substr_search_backward
PARAMS((int, int));
211 extern int rl_noninc_forward_search
PARAMS((int, int));
212 extern int rl_noninc_reverse_search
PARAMS((int, int));
213 extern int rl_noninc_forward_search_again
PARAMS((int, int));
214 extern int rl_noninc_reverse_search_again
PARAMS((int, int));
216 /* Bindable command used when inserting a matching close character. */
217 extern int rl_insert_close
PARAMS((int, int));
219 /* Not available unless READLINE_CALLBACKS is defined. */
220 extern void rl_callback_handler_install
PARAMS((const char *, rl_vcpfunc_t
*));
221 extern void rl_callback_read_char
PARAMS((void));
222 extern void rl_callback_handler_remove
PARAMS((void));
223 extern void rl_callback_sigcleanup
PARAMS((void));
225 /* Things for vi mode. Not available unless readline is compiled -DVI_MODE. */
226 /* VI-mode bindable commands. */
227 extern int rl_vi_redo
PARAMS((int, int));
228 extern int rl_vi_undo
PARAMS((int, int));
229 extern int rl_vi_yank_arg
PARAMS((int, int));
230 extern int rl_vi_fetch_history
PARAMS((int, int));
231 extern int rl_vi_search_again
PARAMS((int, int));
232 extern int rl_vi_search
PARAMS((int, int));
233 extern int rl_vi_complete
PARAMS((int, int));
234 extern int rl_vi_tilde_expand
PARAMS((int, int));
235 extern int rl_vi_prev_word
PARAMS((int, int));
236 extern int rl_vi_next_word
PARAMS((int, int));
237 extern int rl_vi_end_word
PARAMS((int, int));
238 extern int rl_vi_insert_beg
PARAMS((int, int));
239 extern int rl_vi_append_mode
PARAMS((int, int));
240 extern int rl_vi_append_eol
PARAMS((int, int));
241 extern int rl_vi_eof_maybe
PARAMS((int, int));
242 extern int rl_vi_insertion_mode
PARAMS((int, int));
243 extern int rl_vi_insert_mode
PARAMS((int, int));
244 extern int rl_vi_movement_mode
PARAMS((int, int));
245 extern int rl_vi_arg_digit
PARAMS((int, int));
246 extern int rl_vi_change_case
PARAMS((int, int));
247 extern int rl_vi_put
PARAMS((int, int));
248 extern int rl_vi_column
PARAMS((int, int));
249 extern int rl_vi_delete_to
PARAMS((int, int));
250 extern int rl_vi_change_to
PARAMS((int, int));
251 extern int rl_vi_yank_to
PARAMS((int, int));
252 extern int rl_vi_yank_pop
PARAMS((int, int));
253 extern int rl_vi_rubout
PARAMS((int, int));
254 extern int rl_vi_delete
PARAMS((int, int));
255 extern int rl_vi_back_to_indent
PARAMS((int, int));
256 extern int rl_vi_first_print
PARAMS((int, int));
257 extern int rl_vi_char_search
PARAMS((int, int));
258 extern int rl_vi_match
PARAMS((int, int));
259 extern int rl_vi_change_char
PARAMS((int, int));
260 extern int rl_vi_subst
PARAMS((int, int));
261 extern int rl_vi_overstrike
PARAMS((int, int));
262 extern int rl_vi_overstrike_delete
PARAMS((int, int));
263 extern int rl_vi_replace
PARAMS((int, int));
264 extern int rl_vi_set_mark
PARAMS((int, int));
265 extern int rl_vi_goto_mark
PARAMS((int, int));
267 /* VI-mode utility functions. */
268 extern int rl_vi_check
PARAMS((void));
269 extern int rl_vi_domove
PARAMS((int, int *));
270 extern int rl_vi_bracktype
PARAMS((int));
272 extern void rl_vi_start_inserting
PARAMS((int, int, int));
274 /* VI-mode pseudo-bindable commands, used as utility functions. */
275 extern int rl_vi_fWord
PARAMS((int, int));
276 extern int rl_vi_bWord
PARAMS((int, int));
277 extern int rl_vi_eWord
PARAMS((int, int));
278 extern int rl_vi_fword
PARAMS((int, int));
279 extern int rl_vi_bword
PARAMS((int, int));
280 extern int rl_vi_eword
PARAMS((int, int));
282 /* **************************************************************** */
284 /* Well Published Functions */
286 /* **************************************************************** */
288 /* Readline functions. */
289 /* Read a line of input. Prompt with PROMPT. A NULL PROMPT means none. */
290 extern char *readline
PARAMS((const char *));
292 extern int rl_set_prompt
PARAMS((const char *));
293 extern int rl_expand_prompt
PARAMS((char *));
295 extern int rl_initialize
PARAMS((void));
297 /* Undocumented; unused by readline */
298 extern int rl_discard_argument
PARAMS((void));
300 /* Utility functions to bind keys to readline commands. */
301 extern int rl_add_defun
PARAMS((const char *, rl_command_func_t
*, int));
302 extern int rl_bind_key
PARAMS((int, rl_command_func_t
*));
303 extern int rl_bind_key_in_map
PARAMS((int, rl_command_func_t
*, Keymap
));
304 extern int rl_unbind_key
PARAMS((int));
305 extern int rl_unbind_key_in_map
PARAMS((int, Keymap
));
306 extern int rl_bind_key_if_unbound
PARAMS((int, rl_command_func_t
*));
307 extern int rl_bind_key_if_unbound_in_map
PARAMS((int, rl_command_func_t
*, Keymap
));
308 extern int rl_unbind_function_in_map
PARAMS((rl_command_func_t
*, Keymap
));
309 extern int rl_unbind_command_in_map
PARAMS((const char *, Keymap
));
310 extern int rl_bind_keyseq
PARAMS((const char *, rl_command_func_t
*));
311 extern int rl_bind_keyseq_in_map
PARAMS((const char *, rl_command_func_t
*, Keymap
));
312 extern int rl_bind_keyseq_if_unbound
PARAMS((const char *, rl_command_func_t
*));
313 extern int rl_bind_keyseq_if_unbound_in_map
PARAMS((const char *, rl_command_func_t
*, Keymap
));
314 extern int rl_generic_bind
PARAMS((int, const char *, char *, Keymap
));
316 extern char *rl_variable_value
PARAMS((const char *));
317 extern int rl_variable_bind
PARAMS((const char *, const char *));
319 /* Backwards compatibility, use rl_bind_keyseq_in_map instead. */
320 extern int rl_set_key
PARAMS((const char *, rl_command_func_t
*, Keymap
));
322 /* Backwards compatibility, use rl_generic_bind instead. */
323 extern int rl_macro_bind
PARAMS((const char *, const char *, Keymap
));
325 /* Undocumented in the texinfo manual; not really useful to programs. */
326 extern int rl_translate_keyseq
PARAMS((const char *, char *, int *));
327 extern char *rl_untranslate_keyseq
PARAMS((int));
329 extern rl_command_func_t
*rl_named_function
PARAMS((const char *));
330 extern rl_command_func_t
*rl_function_of_keyseq
PARAMS((const char *, Keymap
, int *));
332 extern void rl_list_funmap_names
PARAMS((void));
333 extern char **rl_invoking_keyseqs_in_map
PARAMS((rl_command_func_t
*, Keymap
));
334 extern char **rl_invoking_keyseqs
PARAMS((rl_command_func_t
*));
336 extern void rl_function_dumper
PARAMS((int));
337 extern void rl_macro_dumper
PARAMS((int));
338 extern void rl_variable_dumper
PARAMS((int));
340 extern int rl_read_init_file
PARAMS((const char *));
341 extern int rl_parse_and_bind
PARAMS((char *));
343 /* Functions for manipulating keymaps. */
344 extern Keymap rl_make_bare_keymap
PARAMS((void));
345 extern Keymap rl_copy_keymap
PARAMS((Keymap
));
346 extern Keymap rl_make_keymap
PARAMS((void));
347 extern void rl_discard_keymap
PARAMS((Keymap
));
348 extern void rl_free_keymap
PARAMS((Keymap
));
350 extern Keymap rl_get_keymap_by_name
PARAMS((const char *));
351 extern char *rl_get_keymap_name
PARAMS((Keymap
));
352 extern void rl_set_keymap
PARAMS((Keymap
));
353 extern Keymap rl_get_keymap
PARAMS((void));
354 /* Undocumented; used internally only. */
355 extern void rl_set_keymap_from_edit_mode
PARAMS((void));
356 extern char *rl_get_keymap_name_from_edit_mode
PARAMS((void));
358 /* Functions for manipulating the funmap, which maps command names to functions. */
359 extern int rl_add_funmap_entry
PARAMS((const char *, rl_command_func_t
*));
360 extern const char **rl_funmap_names
PARAMS((void));
361 /* Undocumented, only used internally -- there is only one funmap, and this
362 function may be called only once. */
363 extern void rl_initialize_funmap
PARAMS((void));
365 /* Utility functions for managing keyboard macros. */
366 extern void rl_push_macro_input
PARAMS((char *));
368 /* Functions for undoing, from undo.c */
369 extern void rl_add_undo
PARAMS((enum undo_code
, int, int, char *));
370 extern void rl_free_undo_list
PARAMS((void));
371 extern int rl_do_undo
PARAMS((void));
372 extern int rl_begin_undo_group
PARAMS((void));
373 extern int rl_end_undo_group
PARAMS((void));
374 extern int rl_modifying
PARAMS((int, int));
376 /* Functions for redisplay. */
377 extern void rl_redisplay
PARAMS((void));
378 extern int rl_on_new_line
PARAMS((void));
379 extern int rl_on_new_line_with_prompt
PARAMS((void));
380 extern int rl_forced_update_display
PARAMS((void));
381 extern int rl_clear_message
PARAMS((void));
382 extern int rl_reset_line_state
PARAMS((void));
383 extern int rl_crlf
PARAMS((void));
385 #if defined (USE_VARARGS) && defined (PREFER_STDARG)
386 extern int rl_message (const char *, ...) __attribute__((__format__ (printf
, 1, 2)));
388 extern int rl_message ();
391 extern int rl_show_char
PARAMS((int));
393 /* Undocumented in texinfo manual. */
394 extern int rl_character_len
PARAMS((int, int));
395 extern void rl_redraw_prompt_last_line
PARAMS((void));
397 /* Save and restore internal prompt redisplay information. */
398 extern void rl_save_prompt
PARAMS((void));
399 extern void rl_restore_prompt
PARAMS((void));
401 /* Modifying text. */
402 extern void rl_replace_line
PARAMS((const char *, int));
403 extern int rl_insert_text
PARAMS((const char *));
404 extern int rl_delete_text
PARAMS((int, int));
405 extern int rl_kill_text
PARAMS((int, int));
406 extern char *rl_copy_text
PARAMS((int, int));
408 /* Terminal and tty mode management. */
409 extern void rl_prep_terminal
PARAMS((int));
410 extern void rl_deprep_terminal
PARAMS((void));
411 extern void rl_tty_set_default_bindings
PARAMS((Keymap
));
412 extern void rl_tty_unset_default_bindings
PARAMS((Keymap
));
414 extern int rl_reset_terminal
PARAMS((const char *));
415 extern void rl_resize_terminal
PARAMS((void));
416 extern void rl_set_screen_size
PARAMS((int, int));
417 extern void rl_get_screen_size
PARAMS((int *, int *));
418 extern void rl_reset_screen_size
PARAMS((void));
420 extern char *rl_get_termcap
PARAMS((const char *));
422 /* Functions for character input. */
423 extern int rl_stuff_char
PARAMS((int));
424 extern int rl_execute_next
PARAMS((int));
425 extern int rl_clear_pending_input
PARAMS((void));
426 extern int rl_read_key
PARAMS((void));
427 extern int rl_getc
PARAMS((FILE *));
428 extern int rl_set_keyboard_input_timeout
PARAMS((int));
430 /* `Public' utility functions . */
431 extern void rl_extend_line_buffer
PARAMS((int));
432 extern int rl_ding
PARAMS((void));
433 extern int rl_alphabetic
PARAMS((int));
434 extern void rl_free
PARAMS((void *));
436 /* Readline signal handling, from signals.c */
437 extern int rl_set_signals
PARAMS((void));
438 extern int rl_clear_signals
PARAMS((void));
439 extern void rl_cleanup_after_signal
PARAMS((void));
440 extern void rl_reset_after_signal
PARAMS((void));
441 extern void rl_free_line_state
PARAMS((void));
443 extern void rl_echo_signal_char
PARAMS((int));
445 extern int rl_set_paren_blink_timeout
PARAMS((int));
447 /* History management functions. */
449 extern void rl_clear_history
PARAMS((void));
452 extern int rl_maybe_save_line
PARAMS((void));
453 extern int rl_maybe_unsave_line
PARAMS((void));
454 extern int rl_maybe_replace_line
PARAMS((void));
456 /* Completion functions. */
457 extern int rl_complete_internal
PARAMS((int));
458 extern void rl_display_match_list
PARAMS((char **, int, int));
460 extern char **rl_completion_matches
PARAMS((const char *, rl_compentry_func_t
*));
461 extern char *rl_username_completion_function
PARAMS((const char *, int));
462 extern char *rl_filename_completion_function
PARAMS((const char *, int));
464 extern int rl_completion_mode
PARAMS((rl_command_func_t
*));
467 /* Backwards compatibility (compat.c). These will go away sometime. */
468 extern void free_undo_list
PARAMS((void));
469 extern int maybe_save_line
PARAMS((void));
470 extern int maybe_unsave_line
PARAMS((void));
471 extern int maybe_replace_line
PARAMS((void));
473 extern int ding
PARAMS((void));
474 extern int alphabetic
PARAMS((int));
475 extern int crlf
PARAMS((void));
477 extern char **completion_matches
PARAMS((char *, rl_compentry_func_t
*));
478 extern char *username_completion_function
PARAMS((const char *, int));
479 extern char *filename_completion_function
PARAMS((const char *, int));
482 /* **************************************************************** */
484 /* Well Published Variables */
486 /* **************************************************************** */
488 /* The version of this incarnation of the readline library. */
489 extern const char *rl_library_version
; /* e.g., "4.2" */
490 extern int rl_readline_version
; /* e.g., 0x0402 */
492 /* True if this is real GNU readline. */
493 extern int rl_gnu_readline_p
;
495 /* Flags word encapsulating the current readline state. */
496 extern int rl_readline_state
;
498 /* Says which editing mode readline is currently using. 1 means emacs mode;
500 extern int rl_editing_mode
;
502 /* Insert or overwrite mode for emacs mode. 1 means insert mode; 0 means
503 overwrite mode. Reset to insert mode on each input line. */
504 extern int rl_insert_mode
;
506 /* The name of the calling program. You should initialize this to
507 whatever was in argv[0]. It is used when parsing conditionals. */
508 extern const char *rl_readline_name
;
510 /* The prompt readline uses. This is set from the argument to
511 readline (), and should not be assigned to directly. */
512 extern char *rl_prompt
;
514 /* The prompt string that is actually displayed by rl_redisplay. Public so
515 applications can more easily supply their own redisplay functions. */
516 extern char *rl_display_prompt
;
518 /* The line buffer that is in use. */
519 extern char *rl_line_buffer
;
521 /* The location of point, and end. */
525 /* The mark, or saved cursor position. */
528 /* Flag to indicate that readline has finished with the current input
529 line and should return it. */
532 /* If set to a character value, that will be the next keystroke read. */
533 extern int rl_pending_input
;
535 /* Non-zero if we called this function from _rl_dispatch(). It's present
536 so functions can find out whether they were called from a key binding
537 or directly from an application. */
538 extern int rl_dispatching
;
540 /* Non-zero if the user typed a numeric argument before executing the
542 extern int rl_explicit_arg
;
544 /* The current value of the numeric argument specified by the user. */
545 extern int rl_numeric_arg
;
547 /* The address of the last command function Readline executed. */
548 extern rl_command_func_t
*rl_last_func
;
550 /* The name of the terminal to use. */
551 extern const char *rl_terminal_name
;
553 /* The input and output streams. */
554 extern FILE *rl_instream
;
555 extern FILE *rl_outstream
;
557 /* If non-zero, Readline gives values of LINES and COLUMNS from the environment
558 greater precedence than values fetched from the kernel when computing the
559 screen dimensions. */
560 extern int rl_prefer_env_winsize
;
562 /* If non-zero, then this is the address of a function to call just
563 before readline_internal () prints the first prompt. */
564 extern rl_hook_func_t
*rl_startup_hook
;
566 /* If non-zero, this is the address of a function to call just before
567 readline_internal_setup () returns and readline_internal starts
568 reading input characters. */
569 extern rl_hook_func_t
*rl_pre_input_hook
;
571 /* The address of a function to call periodically while Readline is
572 awaiting character input, or NULL, for no event handling. */
573 extern rl_hook_func_t
*rl_event_hook
;
575 /* The address of a function to call if a read is interrupted by a signal. */
576 extern rl_hook_func_t
*rl_signal_event_hook
;
578 /* The address of a function to call if Readline needs to know whether or not
579 there is data available from the current input source. */
580 extern rl_hook_func_t
*rl_input_available_hook
;
582 /* The address of the function to call to fetch a character from the current
583 Readline input stream */
584 extern rl_getc_func_t
*rl_getc_function
;
586 extern rl_voidfunc_t
*rl_redisplay_function
;
588 extern rl_vintfunc_t
*rl_prep_term_function
;
589 extern rl_voidfunc_t
*rl_deprep_term_function
;
591 /* Dispatch variables. */
592 extern Keymap rl_executing_keymap
;
593 extern Keymap rl_binding_keymap
;
595 extern int rl_executing_key
;
596 extern char *rl_executing_keyseq
;
597 extern int rl_key_sequence_length
;
599 /* Display variables. */
600 /* If non-zero, readline will erase the entire line, including any prompt,
601 if the only thing typed on an otherwise-blank line is something bound to
603 extern int rl_erase_empty_line
;
605 /* If non-zero, the application has already printed the prompt (rl_prompt)
606 before calling readline, so readline should not output it the first time
607 redisplay is done. */
608 extern int rl_already_prompted
;
610 /* A non-zero value means to read only this many characters rather than
611 up to a character bound to accept-line. */
612 extern int rl_num_chars_to_read
;
614 /* The text of a currently-executing keyboard macro. */
615 extern char *rl_executing_macro
;
617 /* Variables to control readline signal handling. */
618 /* If non-zero, readline will install its own signal handlers for
619 SIGINT, SIGTERM, SIGQUIT, SIGALRM, SIGTSTP, SIGTTIN, and SIGTTOU. */
620 extern int rl_catch_signals
;
622 /* If non-zero, readline will install a signal handler for SIGWINCH
623 that also attempts to call any calling application's SIGWINCH signal
624 handler. Note that the terminal is not cleaned up before the
625 application's signal handler is called; use rl_cleanup_after_signal()
627 extern int rl_catch_sigwinch
;
629 /* If non-zero, the readline SIGWINCH handler will modify LINES and
630 COLUMNS in the environment. */
631 extern int rl_change_environment
;
633 /* Completion variables. */
634 /* Pointer to the generator function for completion_matches ().
635 NULL means to use rl_filename_completion_function (), the default
636 filename completer. */
637 extern rl_compentry_func_t
*rl_completion_entry_function
;
639 /* Optional generator for menu completion. Default is
640 rl_completion_entry_function (rl_filename_completion_function). */
641 extern rl_compentry_func_t
*rl_menu_completion_entry_function
;
643 /* If rl_ignore_some_completions_function is non-NULL it is the address
644 of a function to call after all of the possible matches have been
645 generated, but before the actual completion is done to the input line.
646 The function is called with one argument; a NULL terminated array
647 of (char *). If your function removes any of the elements, they
648 must be free()'ed. */
649 extern rl_compignore_func_t
*rl_ignore_some_completions_function
;
651 /* Pointer to alternative function to create matches.
652 Function is called with TEXT, START, and END.
653 START and END are indices in RL_LINE_BUFFER saying what the boundaries
655 If this function exists and returns NULL then call the value of
656 rl_completion_entry_function to try to match, otherwise use the
657 array of strings returned. */
658 extern rl_completion_func_t
*rl_attempted_completion_function
;
660 /* The basic list of characters that signal a break between words for the
661 completer routine. The initial contents of this variable is what
662 breaks words in the shell, i.e. "n\"\\'`@$>". */
663 extern const char *rl_basic_word_break_characters
;
665 /* The list of characters that signal a break between words for
666 rl_complete_internal. The default list is the contents of
667 rl_basic_word_break_characters. */
668 extern /*const*/ char *rl_completer_word_break_characters
;
670 /* Hook function to allow an application to set the completion word
671 break characters before readline breaks up the line. Allows
672 position-dependent word break characters. */
673 extern rl_cpvfunc_t
*rl_completion_word_break_hook
;
675 /* List of characters which can be used to quote a substring of the line.
676 Completion occurs on the entire substring, and within the substring
677 rl_completer_word_break_characters are treated as any other character,
678 unless they also appear within this list. */
679 extern const char *rl_completer_quote_characters
;
681 /* List of quote characters which cause a word break. */
682 extern const char *rl_basic_quote_characters
;
684 /* List of characters that need to be quoted in filenames by the completer. */
685 extern const char *rl_filename_quote_characters
;
687 /* List of characters that are word break characters, but should be left
688 in TEXT when it is passed to the completion function. The shell uses
689 this to help determine what kind of completing to do. */
690 extern const char *rl_special_prefixes
;
692 /* If non-zero, then this is the address of a function to call when
693 completing on a directory name. The function is called with
694 the address of a string (the current directory name) as an arg. It
695 changes what is displayed when the possible completions are printed
696 or inserted. The directory completion hook should perform
697 any necessary dequoting. This function should return 1 if it modifies
698 the directory name pointer passed as an argument. If the directory
699 completion hook returns 0, it should not modify the directory name
700 pointer passed as an argument. */
701 extern rl_icppfunc_t
*rl_directory_completion_hook
;
703 /* If non-zero, this is the address of a function to call when completing
704 a directory name. This function takes the address of the directory name
705 to be modified as an argument. Unlike rl_directory_completion_hook, it
706 only modifies the directory name used in opendir(2), not what is displayed
707 when the possible completions are printed or inserted. If set, it takes
708 precedence over rl_directory_completion_hook. The directory rewrite
709 hook should perform any necessary dequoting. This function has the same
710 return value properties as the directory_completion_hook.
712 I'm not happy with how this works yet, so it's undocumented. I'm trying
713 it in bash to see how well it goes. */
714 extern rl_icppfunc_t
*rl_directory_rewrite_hook
;
716 /* If non-zero, this is the address of a function for the completer to call
717 before deciding which character to append to a completed name. It should
718 modify the directory name passed as an argument if appropriate, and return
719 non-zero if it modifies the name. This should not worry about dequoting
720 the filename; that has already happened by the time it gets here. */
721 extern rl_icppfunc_t
*rl_filename_stat_hook
;
723 /* If non-zero, this is the address of a function to call when reading
724 directory entries from the filesystem for completion and comparing
725 them to the partial word to be completed. The function should
726 either return its first argument (if no conversion takes place) or
727 newly-allocated memory. This can, for instance, convert filenames
728 between character sets for comparison against what's typed at the
729 keyboard. The returned value is what is added to the list of
730 matches. The second argument is the length of the filename to be
732 extern rl_dequote_func_t
*rl_filename_rewrite_hook
;
734 /* Backwards compatibility with previous versions of readline. */
735 #define rl_symbolic_link_hook rl_directory_completion_hook
737 /* If non-zero, then this is the address of a function to call when
738 completing a word would normally display the list of possible matches.
739 This function is called instead of actually doing the display.
740 It takes three arguments: (char **matches, int num_matches, int max_length)
741 where MATCHES is the array of strings that matched, NUM_MATCHES is the
742 number of strings in that array, and MAX_LENGTH is the length of the
743 longest string in that array. */
744 extern rl_compdisp_func_t
*rl_completion_display_matches_hook
;
746 /* Non-zero means that the results of the matches are to be treated
747 as filenames. This is ALWAYS zero on entry, and can only be changed
748 within a completion entry finder function. */
749 extern int rl_filename_completion_desired
;
751 /* Non-zero means that the results of the matches are to be quoted using
752 double quotes (or an application-specific quoting mechanism) if the
753 filename contains any characters in rl_word_break_chars. This is
754 ALWAYS non-zero on entry, and can only be changed within a completion
755 entry finder function. */
756 extern int rl_filename_quoting_desired
;
758 /* Set to a function to quote a filename in an application-specific fashion.
759 Called with the text to quote, the type of match found (single or multiple)
760 and a pointer to the quoting character to be used, which the function can
762 extern rl_quote_func_t
*rl_filename_quoting_function
;
764 /* Function to call to remove quoting characters from a filename. Called
765 before completion is attempted, so the embedded quotes do not interfere
766 with matching names in the file system. */
767 extern rl_dequote_func_t
*rl_filename_dequoting_function
;
769 /* Function to call to decide whether or not a word break character is
770 quoted. If a character is quoted, it does not break words for the
772 extern rl_linebuf_func_t
*rl_char_is_quoted_p
;
774 /* Non-zero means to suppress normal filename completion after the
775 user-specified completion function has been called. */
776 extern int rl_attempted_completion_over
;
778 /* Set to a character describing the type of completion being attempted by
779 rl_complete_internal; available for use by application completion
781 extern int rl_completion_type
;
783 /* Set to the last key used to invoke one of the completion functions */
784 extern int rl_completion_invoking_key
;
786 /* Up to this many items will be displayed in response to a
787 possible-completions call. After that, we ask the user if she
788 is sure she wants to see them all. The default value is 100. */
789 extern int rl_completion_query_items
;
791 /* Character appended to completed words when at the end of the line. The
792 default is a space. Nothing is added if this is '\0'. */
793 extern int rl_completion_append_character
;
795 /* If set to non-zero by an application completion function,
796 rl_completion_append_character will not be appended. */
797 extern int rl_completion_suppress_append
;
799 /* Set to any quote character readline thinks it finds before any application
800 completion function is called. */
801 extern int rl_completion_quote_character
;
803 /* Set to a non-zero value if readline found quoting anywhere in the word to
804 be completed; set before any application completion function is called. */
805 extern int rl_completion_found_quote
;
807 /* If non-zero, the completion functions don't append any closing quote.
808 This is set to 0 by rl_complete_internal and may be changed by an
809 application-specific completion function. */
810 extern int rl_completion_suppress_quote
;
812 /* If non-zero, readline will sort the completion matches. On by default. */
813 extern int rl_sort_completion_matches
;
815 /* If non-zero, a slash will be appended to completed filenames that are
816 symbolic links to directory names, subject to the value of the
817 mark-directories variable (which is user-settable). This exists so
818 that application completion functions can override the user's preference
819 (set via the mark-symlinked-directories variable) if appropriate.
820 It's set to the value of _rl_complete_mark_symlink_dirs in
821 rl_complete_internal before any application-specific completion
822 function is called, so without that function doing anything, the user's
823 preferences are honored. */
824 extern int rl_completion_mark_symlink_dirs
;
826 /* If non-zero, then disallow duplicates in the matches. */
827 extern int rl_ignore_completion_duplicates
;
829 /* If this is non-zero, completion is (temporarily) inhibited, and the
830 completion character will be inserted as any other. */
831 extern int rl_inhibit_completion
;
833 /* Input error; can be returned by (*rl_getc_function) if readline is reading
834 a top-level command (RL_ISSTATE (RL_STATE_READCMD)). */
837 /* Definitions available for use by readline clients. */
838 #define RL_PROMPT_START_IGNORE '\001'
839 #define RL_PROMPT_END_IGNORE '\002'
841 /* Possible values for do_replace argument to rl_filename_quoting_function,
842 called by rl_complete_internal. */
844 #define SINGLE_MATCH 1
847 /* Possible state values for rl_readline_state */
848 #define RL_STATE_NONE 0x000000 /* no state; before first call */
850 #define RL_STATE_INITIALIZING 0x0000001 /* initializing */
851 #define RL_STATE_INITIALIZED 0x0000002 /* initialization done */
852 #define RL_STATE_TERMPREPPED 0x0000004 /* terminal is prepped */
853 #define RL_STATE_READCMD 0x0000008 /* reading a command key */
854 #define RL_STATE_METANEXT 0x0000010 /* reading input after ESC */
855 #define RL_STATE_DISPATCHING 0x0000020 /* dispatching to a command */
856 #define RL_STATE_MOREINPUT 0x0000040 /* reading more input in a command function */
857 #define RL_STATE_ISEARCH 0x0000080 /* doing incremental search */
858 #define RL_STATE_NSEARCH 0x0000100 /* doing non-inc search */
859 #define RL_STATE_SEARCH 0x0000200 /* doing a history search */
860 #define RL_STATE_NUMERICARG 0x0000400 /* reading numeric argument */
861 #define RL_STATE_MACROINPUT 0x0000800 /* getting input from a macro */
862 #define RL_STATE_MACRODEF 0x0001000 /* defining keyboard macro */
863 #define RL_STATE_OVERWRITE 0x0002000 /* overwrite mode */
864 #define RL_STATE_COMPLETING 0x0004000 /* doing completion */
865 #define RL_STATE_SIGHANDLER 0x0008000 /* in readline sighandler */
866 #define RL_STATE_UNDOING 0x0010000 /* doing an undo */
867 #define RL_STATE_INPUTPENDING 0x0020000 /* rl_execute_next called */
868 #define RL_STATE_TTYCSAVED 0x0040000 /* tty special chars saved */
869 #define RL_STATE_CALLBACK 0x0080000 /* using the callback interface */
870 #define RL_STATE_VIMOTION 0x0100000 /* reading vi motion arg */
871 #define RL_STATE_MULTIKEY 0x0200000 /* reading multiple-key command */
872 #define RL_STATE_VICMDONCE 0x0400000 /* entered vi command mode at least once */
873 #define RL_STATE_REDISPLAYING 0x0800000 /* updating terminal display */
875 #define RL_STATE_DONE 0x1000000 /* done; accepted line */
877 #define RL_SETSTATE(x) (rl_readline_state |= (x))
878 #define RL_UNSETSTATE(x) (rl_readline_state &= ~(x))
879 #define RL_ISSTATE(x) (rl_readline_state & (x))
881 struct readline_state
{
897 rl_command_func_t
*lastfunc
;
913 /* completion state */
914 rl_compentry_func_t
*entryfunc
;
915 rl_compentry_func_t
*menuentryfunc
;
916 rl_compignore_func_t
*ignorefunc
;
917 rl_completion_func_t
*attemptfunc
;
918 char *wordbreakchars
;
924 /* reserved for future expansion, so the struct size doesn't change */
928 extern int rl_save_state
PARAMS((struct readline_state
*));
929 extern int rl_restore_state
PARAMS((struct readline_state
*));
935 #endif /* _READLINE_H_ */