1 /* Readline.h -- the names of functions callable from within readline. */
3 /* Copyright (C) 1987, 1989, 1992 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_)
30 #if defined (READLINE_LIBRARY)
35 # include <readline/rlstdc.h>
36 # include <readline/keymaps.h>
37 # include <readline/tilde.h>
40 /* Hex-encoded Readline version number. */
41 #define RL_READLINE_VERSION 0x0402 /* Readline 4.2 */
42 #define RL_VERSION_MAJOR 4
43 #define RL_VERSION_MINOR 2
45 /* Readline data structures. */
47 /* Maintaining the state of undo. We remember individual deletes and inserts
48 on a chain of things to do. */
50 /* The actions that undo knows how to undo. Notice that UNDO_DELETE means
51 to insert some text, and UNDO_INSERT means to delete some text. I.e.,
52 the code tells undo what to undo, not how to undo it. */
53 enum undo_code { UNDO_DELETE, UNDO_INSERT, UNDO_BEGIN, UNDO_END };
55 /* What an element of THE_UNDO_LIST looks like. */
56 typedef struct undo_list {
57 struct undo_list *next;
58 int start, end; /* Where the change took place. */
59 char *text; /* The text to insert, if undoing a delete. */
60 enum undo_code what; /* Delete, Insert, Begin, End. */
63 /* The current undo list for RL_LINE_BUFFER. */
64 extern UNDO_LIST *rl_undo_list;
66 /* The data structure for mapping textual names to code addresses. */
67 typedef struct _funmap {
69 rl_command_func_t *function;
72 extern FUNMAP **funmap;
74 /* **************************************************************** */
76 /* Functions available to bind to key sequences */
78 /* **************************************************************** */
80 /* Bindable commands for numeric arguments. */
81 extern int rl_digit_argument PARAMS((int, int));
82 extern int rl_universal_argument PARAMS((int, int));
84 /* Bindable commands for moving the cursor. */
85 extern int rl_forward PARAMS((int, int));
86 extern int rl_backward PARAMS((int, int));
87 extern int rl_beg_of_line PARAMS((int, int));
88 extern int rl_end_of_line PARAMS((int, int));
89 extern int rl_forward_word PARAMS((int, int));
90 extern int rl_backward_word PARAMS((int, int));
91 extern int rl_refresh_line PARAMS((int, int));
92 extern int rl_clear_screen PARAMS((int, int));
93 extern int rl_arrow_keys PARAMS((int, int));
95 /* Bindable commands for inserting and deleting text. */
96 extern int rl_insert PARAMS((int, int));
97 extern int rl_quoted_insert PARAMS((int, int));
98 extern int rl_tab_insert PARAMS((int, int));
99 extern int rl_newline PARAMS((int, int));
100 extern int rl_do_lowercase_version PARAMS((int, int));
101 extern int rl_rubout PARAMS((int, int));
102 extern int rl_delete PARAMS((int, int));
103 extern int rl_rubout_or_delete PARAMS((int, int));
104 extern int rl_delete_horizontal_space PARAMS((int, int));
105 extern int rl_delete_or_show_completions PARAMS((int, int));
106 extern int rl_insert_comment PARAMS((int, int));
108 /* Bindable commands for changing case. */
109 extern int rl_upcase_word PARAMS((int, int));
110 extern int rl_downcase_word PARAMS((int, int));
111 extern int rl_capitalize_word PARAMS((int, int));
113 /* Bindable commands for transposing characters and words. */
114 extern int rl_transpose_words PARAMS((int, int));
115 extern int rl_transpose_chars PARAMS((int, int));
117 /* Bindable commands for searching within a line. */
118 extern int rl_char_search PARAMS((int, int));
119 extern int rl_backward_char_search PARAMS((int, int));
121 /* Bindable commands for readline's interface to the command history. */
122 extern int rl_beginning_of_history PARAMS((int, int));
123 extern int rl_end_of_history PARAMS((int, int));
124 extern int rl_get_next_history PARAMS((int, int));
125 extern int rl_get_previous_history PARAMS((int, int));
127 /* Bindable commands for managing the mark and region. */
128 extern int rl_set_mark PARAMS((int, int));
129 extern int rl_exchange_point_and_mark PARAMS((int, int));
131 /* Bindable commands to set the editing mode (emacs or vi). */
132 extern int rl_vi_editing_mode PARAMS((int, int));
133 extern int rl_emacs_editing_mode PARAMS((int, int));
135 /* Bindable commands for managing key bindings. */
136 extern int rl_re_read_init_file PARAMS((int, int));
137 extern int rl_dump_functions PARAMS((int, int));
138 extern int rl_dump_macros PARAMS((int, int));
139 extern int rl_dump_variables PARAMS((int, int));
141 /* Bindable commands for word completion. */
142 extern int rl_complete PARAMS((int, int));
143 extern int rl_possible_completions PARAMS((int, int));
144 extern int rl_insert_completions PARAMS((int, int));
145 extern int rl_menu_complete PARAMS((int, int));
147 /* Bindable commands for killing and yanking text, and managing the kill ring. */
148 extern int rl_kill_word PARAMS((int, int));
149 extern int rl_backward_kill_word PARAMS((int, int));
150 extern int rl_kill_line PARAMS((int, int));
151 extern int rl_backward_kill_line PARAMS((int, int));
152 extern int rl_kill_full_line PARAMS((int, int));
153 extern int rl_unix_word_rubout PARAMS((int, int));
154 extern int rl_unix_line_discard PARAMS((int, int));
155 extern int rl_copy_region_to_kill PARAMS((int, int));
156 extern int rl_kill_region PARAMS((int, int));
157 extern int rl_copy_forward_word PARAMS((int, int));
158 extern int rl_copy_backward_word PARAMS((int, int));
159 extern int rl_yank PARAMS((int, int));
160 extern int rl_yank_pop PARAMS((int, int));
161 extern int rl_yank_nth_arg PARAMS((int, int));
162 extern int rl_yank_last_arg PARAMS((int, int));
163 /* Not available unless __CYGWIN__ is defined. */
165 extern int rl_paste_from_clipboard PARAMS((int, int));
168 /* Bindable commands for incremental searching. */
169 extern int rl_reverse_search_history PARAMS((int, int));
170 extern int rl_forward_search_history PARAMS((int, int));
172 /* Bindable keyboard macro commands. */
173 extern int rl_start_kbd_macro PARAMS((int, int));
174 extern int rl_end_kbd_macro PARAMS((int, int));
175 extern int rl_call_last_kbd_macro PARAMS((int, int));
177 /* Bindable undo commands. */
178 extern int rl_revert_line PARAMS((int, int));
179 extern int rl_undo_command PARAMS((int, int));
181 /* Bindable tilde expansion commands. */
182 extern int rl_tilde_expand PARAMS((int, int));
184 /* Bindable terminal control commands. */
185 extern int rl_restart_output PARAMS((int, int));
186 extern int rl_stop_output PARAMS((int, int));
188 /* Miscellaneous bindable commands. */
189 extern int rl_abort PARAMS((int, int));
190 extern int rl_tty_status PARAMS((int, int));
192 /* Bindable commands for incremental and non-incremental history searching. */
193 extern int rl_history_search_forward PARAMS((int, int));
194 extern int rl_history_search_backward PARAMS((int, int));
195 extern int rl_noninc_forward_search PARAMS((int, int));
196 extern int rl_noninc_reverse_search PARAMS((int, int));
197 extern int rl_noninc_forward_search_again PARAMS((int, int));
198 extern int rl_noninc_reverse_search_again PARAMS((int, int));
200 /* Bindable command used when inserting a matching close character. */
201 extern int rl_insert_close PARAMS((int, int));
203 /* Not available unless READLINE_CALLBACKS is defined. */
204 extern void rl_callback_handler_install PARAMS((const char *, rl_vcpfunc_t *));
205 extern void rl_callback_read_char PARAMS((void));
206 extern void rl_callback_handler_remove PARAMS((void));
208 /* Things for vi mode. Not available unless readline is compiled -DVI_MODE. */
209 /* VI-mode bindable commands. */
210 extern int rl_vi_redo PARAMS((int, int));
211 extern int rl_vi_undo PARAMS((int, int));
212 extern int rl_vi_yank_arg PARAMS((int, int));
213 extern int rl_vi_fetch_history PARAMS((int, int));
214 extern int rl_vi_search_again PARAMS((int, int));
215 extern int rl_vi_search PARAMS((int, int));
216 extern int rl_vi_complete PARAMS((int, int));
217 extern int rl_vi_tilde_expand PARAMS((int, int));
218 extern int rl_vi_prev_word PARAMS((int, int));
219 extern int rl_vi_next_word PARAMS((int, int));
220 extern int rl_vi_end_word PARAMS((int, int));
221 extern int rl_vi_insert_beg PARAMS((int, int));
222 extern int rl_vi_append_mode PARAMS((int, int));
223 extern int rl_vi_append_eol PARAMS((int, int));
224 extern int rl_vi_eof_maybe PARAMS((int, int));
225 extern int rl_vi_insertion_mode PARAMS((int, int));
226 extern int rl_vi_movement_mode PARAMS((int, int));
227 extern int rl_vi_arg_digit PARAMS((int, int));
228 extern int rl_vi_change_case PARAMS((int, int));
229 extern int rl_vi_put PARAMS((int, int));
230 extern int rl_vi_column PARAMS((int, int));
231 extern int rl_vi_delete_to PARAMS((int, int));
232 extern int rl_vi_change_to PARAMS((int, int));
233 extern int rl_vi_yank_to PARAMS((int, int));
234 extern int rl_vi_delete PARAMS((int, int));
235 extern int rl_vi_back_to_indent PARAMS((int, int));
236 extern int rl_vi_first_print PARAMS((int, int));
237 extern int rl_vi_char_search PARAMS((int, int));
238 extern int rl_vi_match PARAMS((int, int));
239 extern int rl_vi_change_char PARAMS((int, int));
240 extern int rl_vi_subst PARAMS((int, int));
241 extern int rl_vi_overstrike PARAMS((int, int));
242 extern int rl_vi_overstrike_delete PARAMS((int, int));
243 extern int rl_vi_replace PARAMS((int, int));
244 extern int rl_vi_set_mark PARAMS((int, int));
245 extern int rl_vi_goto_mark PARAMS((int, int));
247 /* VI-mode utility functions. */
248 extern int rl_vi_check PARAMS((void));
249 extern int rl_vi_domove PARAMS((int, int *));
250 extern int rl_vi_bracktype PARAMS((int));
252 /* VI-mode pseudo-bindable commands, used as utility functions. */
253 extern int rl_vi_fWord PARAMS((int, int));
254 extern int rl_vi_bWord PARAMS((int, int));
255 extern int rl_vi_eWord PARAMS((int, int));
256 extern int rl_vi_fword PARAMS((int, int));
257 extern int rl_vi_bword PARAMS((int, int));
258 extern int rl_vi_eword PARAMS((int, int));
260 /* **************************************************************** */
262 /* Well Published Functions */
264 /* **************************************************************** */
266 /* Readline functions. */
267 /* Read a line of input. Prompt with PROMPT. A NULL PROMPT means none. */
268 extern char *readline PARAMS((const char *));
270 extern int rl_set_prompt PARAMS((const char *));
271 extern int rl_expand_prompt PARAMS((char *));
273 extern int rl_initialize PARAMS((void));
275 /* Undocumented; unused by readline */
276 extern int rl_discard_argument PARAMS((void));
278 /* Utility functions to bind keys to readline commands. */
279 extern int rl_add_defun PARAMS((const char *, rl_command_func_t *, int));
280 extern int rl_bind_key PARAMS((int, rl_command_func_t *));
281 extern int rl_bind_key_in_map PARAMS((int, rl_command_func_t *, Keymap));
282 extern int rl_unbind_key PARAMS((int));
283 extern int rl_unbind_key_in_map PARAMS((int, Keymap));
284 extern int rl_unbind_function_in_map PARAMS((rl_command_func_t *, Keymap));
285 extern int rl_unbind_command_in_map PARAMS((const char *, Keymap));
286 extern int rl_set_key PARAMS((const char *, rl_command_func_t *, Keymap));
287 extern int rl_generic_bind PARAMS((int, const char *, char *, Keymap));
288 extern int rl_variable_bind PARAMS((const char *, const char *));
290 /* Backwards compatibility, use rl_generic_bind instead. */
291 extern int rl_macro_bind PARAMS((const char *, const char *, Keymap));
293 /* Undocumented in the texinfo manual; not really useful to programs. */
294 extern int rl_translate_keyseq PARAMS((const char *, char *, int *));
295 extern char *rl_untranslate_keyseq PARAMS((int));
297 extern rl_command_func_t *rl_named_function PARAMS((const char *));
298 extern rl_command_func_t *rl_function_of_keyseq PARAMS((const char *, Keymap, int *));
300 extern void rl_list_funmap_names PARAMS((void));
301 extern char **rl_invoking_keyseqs_in_map PARAMS((rl_command_func_t *, Keymap));
302 extern char **rl_invoking_keyseqs PARAMS((rl_command_func_t *));
304 extern void rl_function_dumper PARAMS((int));
305 extern void rl_macro_dumper PARAMS((int));
306 extern void rl_variable_dumper PARAMS((int));
308 extern int rl_read_init_file PARAMS((const char *));
309 extern int rl_parse_and_bind PARAMS((char *));
311 /* Functions for manipulating keymaps. */
312 extern Keymap rl_make_bare_keymap PARAMS((void));
313 extern Keymap rl_copy_keymap PARAMS((Keymap));
314 extern Keymap rl_make_keymap PARAMS((void));
315 extern void rl_discard_keymap PARAMS((Keymap));
317 extern Keymap rl_get_keymap_by_name PARAMS((const char *));
318 extern char *rl_get_keymap_name PARAMS((Keymap));
319 extern void rl_set_keymap PARAMS((Keymap));
320 extern Keymap rl_get_keymap PARAMS((void));
321 /* Undocumented; used internally only. */
322 extern void rl_set_keymap_from_edit_mode PARAMS((void));
323 extern char *rl_get_keymap_name_from_edit_mode PARAMS((void));
325 /* Functions for manipulating the funmap, which maps command names to functions. */
326 extern int rl_add_funmap_entry PARAMS((const char *, rl_command_func_t *));
327 extern const char **rl_funmap_names PARAMS((void));
328 /* Undocumented, only used internally -- there is only one funmap, and this
329 function may be called only once. */
330 extern void rl_initialize_funmap PARAMS((void));
332 /* Utility functions for managing keyboard macros. */
333 extern void rl_push_macro_input PARAMS((char *));
335 /* Functions for undoing, from undo.c */
336 extern void rl_add_undo PARAMS((enum undo_code, int, int, char *));
337 extern void rl_free_undo_list PARAMS((void));
338 extern int rl_do_undo PARAMS((void));
339 extern int rl_begin_undo_group PARAMS((void));
340 extern int rl_end_undo_group PARAMS((void));
341 extern int rl_modifying PARAMS((int, int));
343 /* Functions for redisplay. */
344 extern void rl_redisplay PARAMS((void));
345 extern int rl_on_new_line PARAMS((void));
346 extern int rl_on_new_line_with_prompt PARAMS((void));
347 extern int rl_forced_update_display PARAMS((void));
348 extern int rl_clear_message PARAMS((void));
349 extern int rl_reset_line_state PARAMS((void));
350 extern int rl_crlf PARAMS((void));
352 #if (defined (__STDC__) || defined (__cplusplus)) && defined (USE_VARARGS) && defined (PREFER_STDARG)
353 extern int rl_message (const char *, ...) __attribute__((__format__ (printf, 1, 2)));
355 extern int rl_message ();
358 extern int rl_show_char PARAMS((int));
360 /* Undocumented in texinfo manual. */
361 extern int rl_character_len PARAMS((int, int));
363 /* Save and restore internal prompt redisplay information. */
364 extern void rl_save_prompt PARAMS((void));
365 extern void rl_restore_prompt PARAMS((void));
367 /* Modifying text. */
368 extern int rl_insert_text PARAMS((const char *));
369 extern int rl_delete_text PARAMS((int, int));
370 extern int rl_kill_text PARAMS((int, int));
371 extern char *rl_copy_text PARAMS((int, int));
373 /* Terminal and tty mode management. */
374 extern void rl_prep_terminal PARAMS((int));
375 extern void rl_deprep_terminal PARAMS((void));
376 extern void rl_tty_set_default_bindings PARAMS((Keymap));
378 extern int rl_reset_terminal PARAMS((const char *));
379 extern void rl_resize_terminal PARAMS((void));
380 extern void rl_set_screen_size PARAMS((int, int));
381 extern void rl_get_screen_size PARAMS((int *, int *));
383 extern char *rl_get_termcap PARAMS((const char *));
385 /* Functions for character input. */
386 extern int rl_stuff_char PARAMS((int));
387 extern int rl_execute_next PARAMS((int));
388 extern int rl_clear_pending_input PARAMS((void));
389 extern int rl_read_key PARAMS((void));
390 extern int rl_getc PARAMS((FILE *));
391 extern int rl_set_keyboard_input_timeout PARAMS((int));
393 /* `Public' utility functions . */
394 extern void rl_extend_line_buffer PARAMS((int));
395 extern int rl_ding PARAMS((void));
396 extern int rl_alphabetic PARAMS((int));
398 /* Readline signal handling, from signals.c */
399 extern int rl_set_signals PARAMS((void));
400 extern int rl_clear_signals PARAMS((void));
401 extern void rl_cleanup_after_signal PARAMS((void));
402 extern void rl_reset_after_signal PARAMS((void));
403 extern void rl_free_line_state PARAMS((void));
405 extern int rl_set_paren_blink_timeout PARAMS((int));
408 extern int rl_maybe_save_line PARAMS((void));
409 extern int rl_maybe_unsave_line PARAMS((void));
410 extern int rl_maybe_replace_line PARAMS((void));
412 /* Completion functions. */
413 extern int rl_complete_internal PARAMS((int));
414 extern void rl_display_match_list PARAMS((char **, int, int));
416 extern char **rl_completion_matches PARAMS((const char *, rl_compentry_func_t *));
417 extern char *rl_username_completion_function PARAMS((const char *, int));
418 extern char *rl_filename_completion_function PARAMS((const char *, int));
421 /* Backwards compatibility (compat.c). These will go away sometime. */
422 extern void free_undo_list PARAMS((void));
423 extern int maybe_save_line PARAMS((void));
424 extern int maybe_unsave_line PARAMS((void));
425 extern int maybe_replace_line PARAMS((void));
427 extern int ding PARAMS((void));
428 extern int alphabetic PARAMS((int));
429 extern int crlf PARAMS((void));
431 extern char **completion_matches PARAMS((char *, rl_compentry_func_t *));
432 extern char *username_completion_function PARAMS((const char *, int));
433 extern char *filename_completion_function PARAMS((const char *, int));
436 /* **************************************************************** */
438 /* Well Published Variables */
440 /* **************************************************************** */
442 /* The version of this incarnation of the readline library. */
443 extern const char *rl_library_version; /* e.g., "4.2" */
444 extern int rl_readline_version; /* e.g., 0x0402 */
446 /* True if this is real GNU readline. */
447 extern int rl_gnu_readline_p;
449 /* Flags word encapsulating the current readline state. */
450 extern int rl_readline_state;
452 /* Says which editing mode readline is currently using. 1 means emacs mode;
454 extern int rl_editing_mode;
456 /* The name of the calling program. You should initialize this to
457 whatever was in argv[0]. It is used when parsing conditionals. */
458 extern const char *rl_readline_name;
460 /* The prompt readline uses. This is set from the argument to
461 readline (), and should not be assigned to directly. */
462 extern char *rl_prompt;
464 /* The line buffer that is in use. */
465 extern char *rl_line_buffer;
467 /* The location of point, and end. */
471 /* The mark, or saved cursor position. */
474 /* Flag to indicate that readline has finished with the current input
475 line and should return it. */
478 /* If set to a character value, that will be the next keystroke read. */
479 extern int rl_pending_input;
481 /* Non-zero if we called this function from _rl_dispatch(). It's present
482 so functions can find out whether they were called from a key binding
483 or directly from an application. */
484 extern int rl_dispatching;
486 /* Non-zero if the user typed a numeric argument before executing the
488 extern int rl_explicit_arg;
490 /* The current value of the numeric argument specified by the user. */
491 extern int rl_numeric_arg;
493 /* The address of the last command function Readline executed. */
494 extern rl_command_func_t *rl_last_func;
496 /* The name of the terminal to use. */
497 extern const char *rl_terminal_name;
499 /* The input and output streams. */
500 extern FILE *rl_instream;
501 extern FILE *rl_outstream;
503 /* If non-zero, then this is the address of a function to call just
504 before readline_internal () prints the first prompt. */
505 extern rl_hook_func_t *rl_startup_hook;
507 /* If non-zero, this is the address of a function to call just before
508 readline_internal_setup () returns and readline_internal starts
509 reading input characters. */
510 extern rl_hook_func_t *rl_pre_input_hook;
512 /* The address of a function to call periodically while Readline is
513 awaiting character input, or NULL, for no event handling. */
514 extern rl_hook_func_t *rl_event_hook;
516 /* The address of the function to call to fetch a character from the current
517 Readline input stream */
518 extern rl_getc_func_t *rl_getc_function;
520 extern rl_voidfunc_t *rl_redisplay_function;
522 extern rl_vintfunc_t *rl_prep_term_function;
523 extern rl_voidfunc_t *rl_deprep_term_function;
525 /* Dispatch variables. */
526 extern Keymap rl_executing_keymap;
527 extern Keymap rl_binding_keymap;
529 /* Display variables. */
530 /* If non-zero, readline will erase the entire line, including any prompt,
531 if the only thing typed on an otherwise-blank line is something bound to
533 extern int rl_erase_empty_line;
535 /* If non-zero, the application has already printed the prompt (rl_prompt)
536 before calling readline, so readline should not output it the first time
537 redisplay is done. */
538 extern int rl_already_prompted;
540 /* A non-zero value means to read only this many characters rather than
541 up to a character bound to accept-line. */
542 extern int rl_num_chars_to_read;
544 /* The text of a currently-executing keyboard macro. */
545 extern char *rl_executing_macro;
547 /* Variables to control readline signal handling. */
548 /* If non-zero, readline will install its own signal handlers for
549 SIGINT, SIGTERM, SIGQUIT, SIGALRM, SIGTSTP, SIGTTIN, and SIGTTOU. */
550 extern int rl_catch_signals;
552 /* If non-zero, readline will install a signal handler for SIGWINCH
553 that also attempts to call any calling application's SIGWINCH signal
554 handler. Note that the terminal is not cleaned up before the
555 application's signal handler is called; use rl_cleanup_after_signal()
557 extern int rl_catch_sigwinch;
559 /* Completion variables. */
560 /* Pointer to the generator function for completion_matches ().
561 NULL means to use rl_filename_completion_function (), the default
562 filename completer. */
563 extern rl_compentry_func_t *rl_completion_entry_function;
565 /* If rl_ignore_some_completions_function is non-NULL it is the address
566 of a function to call after all of the possible matches have been
567 generated, but before the actual completion is done to the input line.
568 The function is called with one argument; a NULL terminated array
569 of (char *). If your function removes any of the elements, they
570 must be free()'ed. */
571 extern rl_compignore_func_t *rl_ignore_some_completions_function;
573 /* Pointer to alternative function to create matches.
574 Function is called with TEXT, START, and END.
575 START and END are indices in RL_LINE_BUFFER saying what the boundaries
577 If this function exists and returns NULL then call the value of
578 rl_completion_entry_function to try to match, otherwise use the
579 array of strings returned. */
580 extern rl_completion_func_t *rl_attempted_completion_function;
582 /* The basic list of characters that signal a break between words for the
583 completer routine. The initial contents of this variable is what
584 breaks words in the shell, i.e. "n\"\\'`@$>". */
585 extern const char *rl_basic_word_break_characters;
587 /* The list of characters that signal a break between words for
588 rl_complete_internal. The default list is the contents of
589 rl_basic_word_break_characters. */
590 extern const char *rl_completer_word_break_characters;
592 /* List of characters which can be used to quote a substring of the line.
593 Completion occurs on the entire substring, and within the substring
594 rl_completer_word_break_characters are treated as any other character,
595 unless they also appear within this list. */
596 extern const char *rl_completer_quote_characters;
598 /* List of quote characters which cause a word break. */
599 extern const char *rl_basic_quote_characters;
601 /* List of characters that need to be quoted in filenames by the completer. */
602 extern const char *rl_filename_quote_characters;
604 /* List of characters that are word break characters, but should be left
605 in TEXT when it is passed to the completion function. The shell uses
606 this to help determine what kind of completing to do. */
607 extern const char *rl_special_prefixes;
609 /* If non-zero, then this is the address of a function to call when
610 completing on a directory name. The function is called with
611 the address of a string (the current directory name) as an arg. It
612 changes what is displayed when the possible completions are printed
614 extern rl_icppfunc_t *rl_directory_completion_hook;
616 /* If non-zero, this is the address of a function to call when completing
617 a directory name. This function takes the address of the directory name
618 to be modified as an argument. Unlike rl_directory_completion_hook, it
619 only modifies the directory name used in opendir(2), not what is displayed
620 when the possible completions are printed or inserted. It is called
621 before rl_directory_completion_hook. I'm not happy with how this works
622 yet, so it's undocumented. */
623 extern rl_icppfunc_t *rl_directory_rewrite_hook;
625 /* Backwards compatibility with previous versions of readline. */
626 #define rl_symbolic_link_hook rl_directory_completion_hook
628 /* If non-zero, then this is the address of a function to call when
629 completing a word would normally display the list of possible matches.
630 This function is called instead of actually doing the display.
631 It takes three arguments: (char **matches, int num_matches, int max_length)
632 where MATCHES is the array of strings that matched, NUM_MATCHES is the
633 number of strings in that array, and MAX_LENGTH is the length of the
634 longest string in that array. */
635 extern rl_compdisp_func_t *rl_completion_display_matches_hook;
637 /* Non-zero means that the results of the matches are to be treated
638 as filenames. This is ALWAYS zero on entry, and can only be changed
639 within a completion entry finder function. */
640 extern int rl_filename_completion_desired;
642 /* Non-zero means that the results of the matches are to be quoted using
643 double quotes (or an application-specific quoting mechanism) if the
644 filename contains any characters in rl_word_break_chars. This is
645 ALWAYS non-zero on entry, and can only be changed within a completion
646 entry finder function. */
647 extern int rl_filename_quoting_desired;
649 /* Set to a function to quote a filename in an application-specific fashion.
650 Called with the text to quote, the type of match found (single or multiple)
651 and a pointer to the quoting character to be used, which the function can
653 extern rl_quote_func_t *rl_filename_quoting_function;
655 /* Function to call to remove quoting characters from a filename. Called
656 before completion is attempted, so the embedded quotes do not interfere
657 with matching names in the file system. */
658 extern rl_dequote_func_t *rl_filename_dequoting_function;
660 /* Function to call to decide whether or not a word break character is
661 quoted. If a character is quoted, it does not break words for the
663 extern rl_linebuf_func_t *rl_char_is_quoted_p;
665 /* Non-zero means to suppress normal filename completion after the
666 user-specified completion function has been called. */
667 extern int rl_attempted_completion_over;
669 /* Set to a character describing the type of completion being attempted by
670 rl_complete_internal; available for use by application completion
672 extern int rl_completion_type;
674 /* Character appended to completed words when at the end of the line. The
675 default is a space. Nothing is added if this is '\0'. */
676 extern int rl_completion_append_character;
678 /* Up to this many items will be displayed in response to a
679 possible-completions call. After that, we ask the user if she
680 is sure she wants to see them all. The default value is 100. */
681 extern int rl_completion_query_items;
683 /* If non-zero, then disallow duplicates in the matches. */
684 extern int rl_ignore_completion_duplicates;
686 /* If this is non-zero, completion is (temporarily) inhibited, and the
687 completion character will be inserted as any other. */
688 extern int rl_inhibit_completion;
690 /* Definitions available for use by readline clients. */
691 #define RL_PROMPT_START_IGNORE '\001'
692 #define RL_PROMPT_END_IGNORE '\002'
694 /* Possible values for do_replace argument to rl_filename_quoting_function,
695 called by rl_complete_internal. */
697 #define SINGLE_MATCH 1
700 /* Possible state values for rl_readline_state */
701 #define RL_STATE_NONE 0x00000 /* no state; before first call */
703 #define RL_STATE_INITIALIZING 0x00001 /* initializing */
704 #define RL_STATE_INITIALIZED 0x00002 /* initialization done */
705 #define RL_STATE_TERMPREPPED 0x00004 /* terminal is prepped */
706 #define RL_STATE_READCMD 0x00008 /* reading a command key */
707 #define RL_STATE_METANEXT 0x00010 /* reading input after ESC */
708 #define RL_STATE_DISPATCHING 0x00020 /* dispatching to a command */
709 #define RL_STATE_MOREINPUT 0x00040 /* reading more input in a command function */
710 #define RL_STATE_ISEARCH 0x00080 /* doing incremental search */
711 #define RL_STATE_NSEARCH 0x00100 /* doing non-inc search */
712 #define RL_STATE_SEARCH 0x00200 /* doing a history search */
713 #define RL_STATE_NUMERICARG 0x00400 /* reading numeric argument */
714 #define RL_STATE_MACROINPUT 0x00800 /* getting input from a macro */
715 #define RL_STATE_MACRODEF 0x01000 /* defining keyboard macro */
716 #define RL_STATE_OVERWRITE 0x02000 /* overwrite mode */
717 #define RL_STATE_COMPLETING 0x04000 /* doing completion */
718 #define RL_STATE_SIGHANDLER 0x08000 /* in readline sighandler */
719 #define RL_STATE_UNDOING 0x10000 /* doing an undo */
720 #define RL_STATE_INPUTPENDING 0x20000 /* rl_execute_next called */
722 #define RL_STATE_DONE 0x80000 /* done; accepted line */
724 #define RL_SETSTATE(x) (rl_readline_state |= (x))
725 #define RL_UNSETSTATE(x) (rl_readline_state &= ~(x))
726 #define RL_ISSTATE(x) (rl_readline_state & (x))
732 #endif /* _READLINE_H_ */