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