2 /* Readline.h -- the names of functions callable from within readline. */
4 /* Copyright (C) 1987, 1989, 1992 Free Software Foundation, Inc.
6 This file is part of the GNU Readline Library, a library for
7 reading lines of text with interactive input and history editing.
9 The GNU Readline Library is free software; you can redistribute it
10 and/or modify it under the terms of the GNU General Public License
11 as published by the Free Software Foundation; either version 2, or
12 (at your option) any later version.
14 The GNU Readline Library is distributed in the hope that it will be
15 useful, but WITHOUT ANY WARRANTY; without even the implied warranty
16 of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 The GNU General Public License is often shipped with GNU software, and
20 is generally kept in a file called COPYING or LICENSE. If you do not
21 have a copy of the license, write to the Free Software Foundation,
22 59 Temple Place, Suite 330, Boston, MA 02111 USA. */
24 #if !defined (_READLINE_H_)
31 #if defined (READLINE_LIBRARY)
36 # include <readline/rlstdc.h>
37 # include <readline/keymaps.h>
38 # include <readline/tilde.h>
41 /* Readline data structures. */
43 /* Maintaining the state of undo. We remember individual deletes and inserts
44 on a chain of things to do. */
46 /* The actions that undo knows how to undo. Notice that UNDO_DELETE means
47 to insert some text, and UNDO_INSERT means to delete some text. I.e.,
48 the code tells undo what to undo, not how to undo it. */
49 enum undo_code { UNDO_DELETE, UNDO_INSERT, UNDO_BEGIN, UNDO_END };
51 /* What an element of THE_UNDO_LIST looks like. */
52 typedef struct undo_list {
53 struct undo_list *next;
54 int start, end; /* Where the change took place. */
55 char *text; /* The text to insert, if undoing a delete. */
56 enum undo_code what; /* Delete, Insert, Begin, End. */
59 /* The current undo list for RL_LINE_BUFFER. */
60 extern UNDO_LIST *rl_undo_list;
62 /* The data structure for mapping textual names to code addresses. */
63 typedef struct _funmap {
65 rl_command_func_t *function;
68 extern FUNMAP **funmap;
70 /* **************************************************************** */
72 /* Functions available to bind to key sequences */
74 /* **************************************************************** */
76 /* Bindable commands for numeric arguments. */
77 extern int rl_digit_argument __P((int, int));
78 extern int rl_universal_argument __P((int, int));
80 /* Bindable commands for moving the cursor. */
81 extern int rl_forward __P((int, int));
82 extern int rl_backward __P((int, int));
83 extern int rl_beg_of_line __P((int, int));
84 extern int rl_end_of_line __P((int, int));
85 extern int rl_forward_word __P((int, int));
86 extern int rl_backward_word __P((int, int));
87 extern int rl_refresh_line __P((int, int));
88 extern int rl_clear_screen __P((int, int));
89 extern int rl_arrow_keys __P((int, int));
91 /* Bindable commands for inserting and deleting text. */
92 extern int rl_insert __P((int, int));
93 extern int rl_quoted_insert __P((int, int));
94 extern int rl_tab_insert __P((int, int));
95 extern int rl_newline __P((int, int));
96 extern int rl_do_lowercase_version __P((int, int));
97 extern int rl_rubout __P((int, int));
98 extern int rl_delete __P((int, int));
99 extern int rl_rubout_or_delete __P((int, int));
100 extern int rl_delete_horizontal_space __P((int, int));
101 extern int rl_delete_or_show_completions __P((int, int));
102 extern int rl_insert_comment __P((int, int));
104 /* Bindable commands for changing case. */
105 extern int rl_upcase_word __P((int, int));
106 extern int rl_downcase_word __P((int, int));
107 extern int rl_capitalize_word __P((int, int));
109 /* Bindable commands for transposing characters and words. */
110 extern int rl_transpose_words __P((int, int));
111 extern int rl_transpose_chars __P((int, int));
113 /* Bindable commands for searching within a line. */
114 extern int rl_char_search __P((int, int));
115 extern int rl_backward_char_search __P((int, int));
117 /* Bindable commands for readline's interface to the command history. */
118 extern int rl_beginning_of_history __P((int, int));
119 extern int rl_end_of_history __P((int, int));
120 extern int rl_get_next_history __P((int, int));
121 extern int rl_get_previous_history __P((int, int));
123 /* Bindable commands for managing the mark and region. */
124 extern int rl_set_mark __P((int, int));
125 extern int rl_exchange_point_and_mark __P((int, int));
127 /* Bindable commands to set the editing mode (emacs or vi). */
128 extern int rl_vi_editing_mode __P((int, int));
129 extern int rl_emacs_editing_mode __P((int, int));
131 /* Bindable commands for managing key bindings. */
132 extern int rl_re_read_init_file __P((int, int));
133 extern int rl_dump_functions __P((int, int));
134 extern int rl_dump_macros __P((int, int));
135 extern int rl_dump_variables __P((int, int));
137 /* Bindable commands for word completion. */
138 extern int rl_complete __P((int, int));
139 extern int rl_possible_completions __P((int, int));
140 extern int rl_insert_completions __P((int, int));
141 extern int rl_menu_complete __P((int, int));
143 /* Bindable commands for killing and yanking text, and managing the kill ring. */
144 extern int rl_kill_word __P((int, int));
145 extern int rl_backward_kill_word __P((int, int));
146 extern int rl_kill_line __P((int, int));
147 extern int rl_backward_kill_line __P((int, int));
148 extern int rl_kill_full_line __P((int, int));
149 extern int rl_unix_word_rubout __P((int, int));
150 extern int rl_unix_line_discard __P((int, int));
151 extern int rl_copy_region_to_kill __P((int, int));
152 extern int rl_kill_region __P((int, int));
153 extern int rl_copy_forward_word __P((int, int));
154 extern int rl_copy_backward_word __P((int, int));
155 extern int rl_yank __P((int, int));
156 extern int rl_yank_pop __P((int, int));
157 extern int rl_yank_nth_arg __P((int, int));
158 extern int rl_yank_last_arg __P((int, int));
159 /* Not available unless __CYGWIN__ is defined. */
161 extern int rl_paste_from_clipboard __P((int, int));
164 /* Bindable commands for incremental searching. */
165 extern int rl_reverse_search_history __P((int, int));
166 extern int rl_forward_search_history __P((int, int));
168 /* Bindable keyboard macro commands. */
169 extern int rl_start_kbd_macro __P((int, int));
170 extern int rl_end_kbd_macro __P((int, int));
171 extern int rl_call_last_kbd_macro __P((int, int));
173 /* Bindable undo commands. */
174 extern int rl_revert_line __P((int, int));
175 extern int rl_undo_command __P((int, int));
177 /* Bindable tilde expansion commands. */
178 extern int rl_tilde_expand __P((int, int));
180 /* Bindable terminal control commands. */
181 extern int rl_restart_output __P((int, int));
182 extern int rl_stop_output __P((int, int));
184 /* Miscellaneous bindable commands. */
185 extern int rl_abort __P((int, int));
186 extern int rl_tty_status __P((int, int));
188 /* Bindable commands for incremental and non-incremental history searching. */
189 extern int rl_history_search_forward __P((int, int));
190 extern int rl_history_search_backward __P((int, int));
191 extern int rl_noninc_forward_search __P((int, int));
192 extern int rl_noninc_reverse_search __P((int, int));
193 extern int rl_noninc_forward_search_again __P((int, int));
194 extern int rl_noninc_reverse_search_again __P((int, int));
196 /* Bindable command used when inserting a matching close character. */
197 extern int rl_insert_close __P((int, int));
199 /* Not available unless READLINE_CALLBACKS is defined. */
200 extern void rl_callback_handler_install __P((const char *, rl_vcpfunc_t *));
201 extern void rl_callback_read_char __P((void));
202 extern void rl_callback_handler_remove __P((void));
204 /* Things for vi mode. Not available unless readline is compiled -DVI_MODE. */
205 /* VI-mode bindable commands. */
206 extern int rl_vi_redo __P((int, int));
207 extern int rl_vi_undo __P((int, int));
208 extern int rl_vi_yank_arg __P((int, int));
209 extern int rl_vi_fetch_history __P((int, int));
210 extern int rl_vi_search_again __P((int, int));
211 extern int rl_vi_search __P((int, int));
212 extern int rl_vi_complete __P((int, int));
213 extern int rl_vi_tilde_expand __P((int, int));
214 extern int rl_vi_prev_word __P((int, int));
215 extern int rl_vi_next_word __P((int, int));
216 extern int rl_vi_end_word __P((int, int));
217 extern int rl_vi_insert_beg __P((int, int));
218 extern int rl_vi_append_mode __P((int, int));
219 extern int rl_vi_append_eol __P((int, int));
220 extern int rl_vi_eof_maybe __P((int, int));
221 extern int rl_vi_insertion_mode __P((int, int));
222 extern int rl_vi_movement_mode __P((int, int));
223 extern int rl_vi_arg_digit __P((int, int));
224 extern int rl_vi_change_case __P((int, int));
225 extern int rl_vi_put __P((int, int));
226 extern int rl_vi_column __P((int, int));
227 extern int rl_vi_delete_to __P((int, int));
228 extern int rl_vi_change_to __P((int, int));
229 extern int rl_vi_yank_to __P((int, int));
230 extern int rl_vi_delete __P((int, int));
231 extern int rl_vi_back_to_indent __P((int, int));
232 extern int rl_vi_first_print __P((int, int));
233 extern int rl_vi_char_search __P((int, int));
234 extern int rl_vi_match __P((int, int));
235 extern int rl_vi_change_char __P((int, int));
236 extern int rl_vi_subst __P((int, int));
237 extern int rl_vi_overstrike __P((int, int));
238 extern int rl_vi_overstrike_delete __P((int, int));
239 extern int rl_vi_replace __P((int, int));
240 extern int rl_vi_set_mark __P((int, int));
241 extern int rl_vi_goto_mark __P((int, int));
243 /* VI-mode utility functions. */
244 extern int rl_vi_check __P((void));
245 extern int rl_vi_domove __P((int, int *));
246 extern int rl_vi_bracktype __P((int));
248 /* VI-mode pseudo-bindable commands, used as utility functions. */
249 extern int rl_vi_fWord __P((int, int));
250 extern int rl_vi_bWord __P((int, int));
251 extern int rl_vi_eWord __P((int, int));
252 extern int rl_vi_fword __P((int, int));
253 extern int rl_vi_bword __P((int, int));
254 extern int rl_vi_eword __P((int, int));
256 /* **************************************************************** */
258 /* Well Published Functions */
260 /* **************************************************************** */
262 /* Readline functions. */
263 /* Read a line of input. Prompt with PROMPT. A NULL PROMPT means none. */
264 extern char *readline __P((const char *));
266 extern int rl_set_prompt __P((const char *));
267 extern int rl_expand_prompt __P((char *));
269 extern int rl_initialize __P((void));
271 /* Undocumented; unused by readline */
272 extern int rl_discard_argument __P((void));
274 /* Utility functions to bind keys to readline commands. */
275 extern int rl_add_defun __P((const char *, rl_command_func_t *, int));
276 extern int rl_bind_key __P((int, rl_command_func_t *));
277 extern int rl_bind_key_in_map __P((int, rl_command_func_t *, Keymap));
278 extern int rl_unbind_key __P((int));
279 extern int rl_unbind_key_in_map __P((int, Keymap));
280 extern int rl_unbind_function_in_map __P((rl_command_func_t *, Keymap));
281 extern int rl_unbind_command_in_map __P((const char *, Keymap));
282 extern int rl_set_key __P((const char *, rl_command_func_t *, Keymap));
283 extern int rl_generic_bind __P((int, const char *, char *, Keymap));
284 extern int rl_variable_bind __P((const char *, const char *));
286 /* Backwards compatibility, use rl_generic_bind instead. */
287 extern int rl_macro_bind __P((const char *, const char *, Keymap));
289 /* Undocumented in the texinfo manual; not really useful to programs. */
290 extern int rl_translate_keyseq __P((const char *, char *, int *));
291 extern char *rl_untranslate_keyseq __P((int));
293 extern rl_command_func_t *rl_named_function __P((const char *));
294 extern rl_command_func_t *rl_function_of_keyseq __P((const char *, Keymap, int *));
296 extern void rl_list_funmap_names __P((void));
297 extern char **rl_invoking_keyseqs_in_map __P((rl_command_func_t *, Keymap));
298 extern char **rl_invoking_keyseqs __P((rl_command_func_t *));
300 extern void rl_function_dumper __P((int));
301 extern void rl_macro_dumper __P((int));
302 extern void rl_variable_dumper __P((int));
304 extern int rl_read_init_file __P((const char *));
305 extern int rl_parse_and_bind __P((char *));
307 /* Functions for manipulating keymaps. */
308 extern char *rl_get_keymap_name __P((Keymap));
309 /* Undocumented; used internally only. */
310 extern void rl_set_keymap_from_edit_mode __P((void));
311 extern char *rl_get_keymap_name_from_edit_mode __P((void));
313 /* Functions for manipulating the funmap, which maps command names to functions. */
314 extern int rl_add_funmap_entry __P((const char *, rl_command_func_t *));
315 extern const char **rl_funmap_names __P((void));
316 /* Undocumented, only used internally -- there is only one funmap, and this
317 function may be called only once. */
318 extern void rl_initialize_funmap __P((void));
320 /* Utility functions for managing keyboard macros. */
321 extern void rl_push_macro_input __P((char *));
323 /* Functions for undoing, from undo.c */
324 extern void rl_add_undo __P((enum undo_code, int, int, char *));
325 extern void rl_free_undo_list __P((void));
326 extern int rl_do_undo __P((void));
327 extern int rl_begin_undo_group __P((void));
328 extern int rl_end_undo_group __P((void));
329 extern int rl_modifying __P((int, int));
331 /* Functions for redisplay. */
332 extern void rl_redisplay __P((void));
333 extern int rl_on_new_line __P((void));
334 extern int rl_on_new_line_with_prompt __P((void));
335 extern int rl_forced_update_display __P((void));
336 extern int rl_clear_message __P((void));
337 extern int rl_reset_line_state __P((void));
338 extern int rl_crlf __P((void));
340 #if (defined (__STDC__) || defined (__cplusplus)) && defined (USE_VARARGS) && defined (PREFER_STDARG)
341 extern int rl_message (const char *, ...);
343 extern int rl_message ();
346 extern int rl_show_char __P((int));
348 /* Undocumented in texinfo manual. */
349 extern int rl_character_len __P((int, int));
351 /* Save and restore internal prompt redisplay information. */
352 extern void rl_save_prompt __P((void));
353 extern void rl_restore_prompt __P((void));
355 /* Modifying text. */
356 extern int rl_insert_text __P((const char *));
357 extern int rl_delete_text __P((int, int));
358 extern int rl_kill_text __P((int, int));
359 extern char *rl_copy_text __P((int, int));
361 /* Terminal and tty mode management. */
362 extern void rl_prep_terminal __P((int));
363 extern void rl_deprep_terminal __P((void));
364 extern void rl_tty_set_default_bindings __P((Keymap));
366 extern int rl_reset_terminal __P((const char *));
367 extern void rl_resize_terminal __P((void));
368 extern void rl_set_screen_size __P((int, int));
369 extern void rl_get_screen_size __P((int *, int *));
371 /* Functions for character input. */
372 extern int rl_stuff_char __P((int));
373 extern int rl_execute_next __P((int));
374 extern int rl_clear_pending_input __P((void));
375 extern int rl_read_key __P((void));
376 extern int rl_getc __P((FILE *));
377 extern int rl_set_keyboard_input_timeout __P((int));
379 /* `Public' utility functions . */
380 extern void rl_extend_line_buffer __P((int));
381 extern int rl_ding __P((void));
382 extern int rl_alphabetic __P((int));
384 /* Readline signal handling, from signals.c */
385 extern int rl_set_signals __P((void));
386 extern int rl_clear_signals __P((void));
387 extern void rl_cleanup_after_signal __P((void));
388 extern void rl_reset_after_signal __P((void));
389 extern void rl_free_line_state __P((void));
392 extern int rl_set_paren_blink_timeout __P((int));
395 extern int rl_maybe_save_line __P((void));
396 extern int rl_maybe_unsave_line __P((void));
397 extern int rl_maybe_replace_line __P((void));
399 /* Completion functions. */
400 extern int rl_complete_internal __P((int));
401 extern void rl_display_match_list __P((char **, int, int));
403 extern char **rl_completion_matches __P((const char *, rl_compentry_func_t *));
404 extern char *rl_username_completion_function __P((const char *, int));
405 extern char *rl_filename_completion_function __P((const char *, int));
407 /* Backwards compatibility (compat.c). These will go away sometime. */
408 extern void free_undo_list __P((void));
409 extern int maybe_save_line __P((void));
410 extern int maybe_unsave_line __P((void));
411 extern int maybe_replace_line __P((void));
413 extern int ding __P((void));
414 extern int alphabetic __P((int));
415 extern int crlf __P((void));
417 extern char **completion_matches __P((char *, rl_compentry_func_t *));
418 extern char *username_completion_function __P((const char *, int));
419 extern char *filename_completion_function __P((const char *, int));
421 /* **************************************************************** */
423 /* Well Published Variables */
425 /* **************************************************************** */
427 /* The version of this incarnation of the readline library. */
428 extern const char *rl_library_version;
430 /* True if this is real GNU readline. */
431 extern int rl_gnu_readline_p;
433 /* Flags word encapsulating the current readline state. */
434 extern int rl_readline_state;
436 /* Says which editing mode readline is currently using. 1 means emacs mode;
438 extern int rl_editing_mode;
440 /* The name of the calling program. You should initialize this to
441 whatever was in argv[0]. It is used when parsing conditionals. */
442 extern const char *rl_readline_name;
444 /* The prompt readline uses. This is set from the argument to
445 readline (), and should not be assigned to directly. */
446 extern char *rl_prompt;
448 /* The line buffer that is in use. */
449 extern char *rl_line_buffer;
451 /* The location of point, and end. */
455 /* The mark, or saved cursor position. */
458 /* Flag to indicate that readline has finished with the current input
459 line and should return it. */
462 /* If set to a character value, that will be the next keystroke read. */
463 extern int rl_pending_input;
465 /* Non-zero if we called this function from _rl_dispatch(). It's present
466 so functions can find out whether they were called from a key binding
467 or directly from an application. */
468 extern int rl_dispatching;
470 /* Non-zero if the user typed a numeric argument before executing the
472 extern int rl_explicit_arg;
474 /* The current value of the numeric argument specified by the user. */
475 extern int rl_numeric_arg;
477 /* The address of the last command function Readline executed. */
478 extern rl_command_func_t *rl_last_func;
480 /* The name of the terminal to use. */
481 extern const char *rl_terminal_name;
483 /* The input and output streams. */
484 extern FILE *rl_instream;
485 extern FILE *rl_outstream;
487 /* If non-zero, then this is the address of a function to call just
488 before readline_internal () prints the first prompt. */
489 extern rl_hook_func_t *rl_startup_hook;
491 /* If non-zero, this is the address of a function to call just before
492 readline_internal_setup () returns and readline_internal starts
493 reading input characters. */
494 extern rl_hook_func_t *rl_pre_input_hook;
496 /* The address of a function to call periodically while Readline is
497 awaiting character input, or NULL, for no event handling. */
498 extern rl_hook_func_t *rl_event_hook;
500 /* The address of the function to call to fetch a character from the current
501 Readline input stream */
502 extern rl_getc_func_t *rl_getc_function;
504 extern rl_voidfunc_t *rl_redisplay_function;
506 extern rl_vintfunc_t *rl_prep_term_function;
507 extern rl_voidfunc_t *rl_deprep_term_function;
509 /* Dispatch variables. */
510 extern Keymap rl_executing_keymap;
511 extern Keymap rl_binding_keymap;
513 /* Display variables. */
514 /* If non-zero, readline will erase the entire line, including any prompt,
515 if the only thing typed on an otherwise-blank line is something bound to
517 extern int rl_erase_empty_line;
519 /* If non-zero, the application has already printed the prompt (rl_prompt)
520 before calling readline, so readline should not output it the first time
521 redisplay is done. */
522 extern int rl_already_prompted;
524 /* A non-zero value means to read only this many characters rather than
525 up to a character bound to accept-line. */
526 extern int rl_num_chars_to_read;
528 /* The text of a currently-executing keyboard macro. */
529 extern char *rl_executing_macro;
531 /* Variables to control readline signal handling. */
532 /* If non-zero, readline will install its own signal handlers for
533 SIGINT, SIGTERM, SIGQUIT, SIGALRM, SIGTSTP, SIGTTIN, and SIGTTOU. */
534 extern int rl_catch_signals;
536 /* If non-zero, readline will install a signal handler for SIGWINCH
537 that also attempts to call any calling application's SIGWINCH signal
538 handler. Note that the terminal is not cleaned up before the
539 application's signal handler is called; use rl_cleanup_after_signal()
541 extern int rl_catch_sigwinch;
543 /* Completion variables. */
544 /* Pointer to the generator function for completion_matches ().
545 NULL means to use filename_entry_function (), the default filename
547 extern rl_compentry_func_t *rl_completion_entry_function;
549 /* If rl_ignore_some_completions_function is non-NULL it is the address
550 of a function to call after all of the possible matches have been
551 generated, but before the actual completion is done to the input line.
552 The function is called with one argument; a NULL terminated array
553 of (char *). If your function removes any of the elements, they
554 must be free()'ed. */
555 extern rl_compignore_func_t *rl_ignore_some_completions_function;
557 /* Pointer to alternative function to create matches.
558 Function is called with TEXT, START, and END.
559 START and END are indices in RL_LINE_BUFFER saying what the boundaries
561 If this function exists and returns NULL then call the value of
562 rl_completion_entry_function to try to match, otherwise use the
563 array of strings returned. */
564 extern rl_completion_func_t *rl_attempted_completion_function;
566 /* The basic list of characters that signal a break between words for the
567 completer routine. The initial contents of this variable is what
568 breaks words in the shell, i.e. "n\"\\'`@$>". */
569 extern const char *rl_basic_word_break_characters;
571 /* The list of characters that signal a break between words for
572 rl_complete_internal. The default list is the contents of
573 rl_basic_word_break_characters. */
574 extern const char *rl_completer_word_break_characters;
576 /* List of characters which can be used to quote a substring of the line.
577 Completion occurs on the entire substring, and within the substring
578 rl_completer_word_break_characters are treated as any other character,
579 unless they also appear within this list. */
580 extern const char *rl_completer_quote_characters;
582 /* List of quote characters which cause a word break. */
583 extern const char *rl_basic_quote_characters;
585 /* List of characters that need to be quoted in filenames by the completer. */
586 extern const char *rl_filename_quote_characters;
588 /* List of characters that are word break characters, but should be left
589 in TEXT when it is passed to the completion function. The shell uses
590 this to help determine what kind of completing to do. */
591 extern const char *rl_special_prefixes;
593 /* If non-zero, then this is the address of a function to call when
594 completing on a directory name. The function is called with
595 the address of a string (the current directory name) as an arg. It
596 changes what is displayed when the possible completions are printed
598 extern rl_icppfunc_t *rl_directory_completion_hook;
600 /* If non-zero, this is the address of a function to call when completing
601 a directory name. This function takes the address of the directory name
602 to be modified as an argument. Unlike rl_directory_completion_hook, it
603 only modifies the directory name used in opendir(2), not what is displayed
604 when the possible completions are printed or inserted. It is called
605 before rl_directory_completion_hook. I'm not happy with how this works
606 yet, so it's undocumented. */
607 extern rl_icppfunc_t *rl_directory_rewrite_hook;
609 /* Backwards compatibility with previous versions of readline. */
610 #define rl_symbolic_link_hook rl_directory_completion_hook
612 /* If non-zero, then this is the address of a function to call when
613 completing a word would normally display the list of possible matches.
614 This function is called instead of actually doing the display.
615 It takes three arguments: (char **matches, int num_matches, int max_length)
616 where MATCHES is the array of strings that matched, NUM_MATCHES is the
617 number of strings in that array, and MAX_LENGTH is the length of the
618 longest string in that array. */
619 extern rl_compdisp_func_t *rl_completion_display_matches_hook;
621 /* Non-zero means that the results of the matches are to be treated
622 as filenames. This is ALWAYS zero on entry, and can only be changed
623 within a completion entry finder function. */
624 extern int rl_filename_completion_desired;
626 /* Non-zero means that the results of the matches are to be quoted using
627 double quotes (or an application-specific quoting mechanism) if the
628 filename contains any characters in rl_word_break_chars. This is
629 ALWAYS non-zero on entry, and can only be changed within a completion
630 entry finder function. */
631 extern int rl_filename_quoting_desired;
633 /* Set to a function to quote a filename in an application-specific fashion.
634 Called with the text to quote, the type of match found (single or multiple)
635 and a pointer to the quoting character to be used, which the function can
637 extern rl_quote_func_t *rl_filename_quoting_function;
639 /* Function to call to remove quoting characters from a filename. Called
640 before completion is attempted, so the embedded quotes do not interfere
641 with matching names in the file system. */
642 extern rl_dequote_func_t *rl_filename_dequoting_function;
644 /* Function to call to decide whether or not a word break character is
645 quoted. If a character is quoted, it does not break words for the
647 extern rl_linebuf_func_t *rl_char_is_quoted_p;
649 /* Non-zero means to suppress normal filename completion after the
650 user-specified completion function has been called. */
651 extern int rl_attempted_completion_over;
653 /* Set to a character describing the type of completion being attempted by
654 rl_complete_internal; available for use by application completion
656 extern int rl_completion_type;
658 /* Character appended to completed words when at the end of the line. The
659 default is a space. Nothing is added if this is '\0'. */
660 extern int rl_completion_append_character;
662 /* Up to this many items will be displayed in response to a
663 possible-completions call. After that, we ask the user if she
664 is sure she wants to see them all. The default value is 100. */
665 extern int rl_completion_query_items;
667 /* If non-zero, then disallow duplicates in the matches. */
668 extern int rl_ignore_completion_duplicates;
670 /* If this is non-zero, completion is (temporarily) inhibited, and the
671 completion character will be inserted as any other. */
672 extern int rl_inhibit_completion;
674 /* Definitions available for use by readline clients. */
675 #define RL_PROMPT_START_IGNORE '\001'
676 #define RL_PROMPT_END_IGNORE '\002'
678 /* Possible values for do_replace argument to rl_filename_quoting_function,
679 called by rl_complete_internal. */
681 #define SINGLE_MATCH 1
684 /* Possible state values for rl_readline_state */
685 #define RL_STATE_NONE 0x00000 /* no state; before first call */
687 #define RL_STATE_INITIALIZING 0x00001 /* initializing */
688 #define RL_STATE_INITIALIZED 0x00002 /* initialization done */
689 #define RL_STATE_TERMPREPPED 0x00004 /* terminal is prepped */
690 #define RL_STATE_READCMD 0x00008 /* reading a command key */
691 #define RL_STATE_METANEXT 0x00010 /* reading input after ESC */
692 #define RL_STATE_DISPATCHING 0x00020 /* dispatching to a command */
693 #define RL_STATE_MOREINPUT 0x00040 /* reading more input in a command function */
694 #define RL_STATE_ISEARCH 0x00080 /* doing incremental search */
695 #define RL_STATE_NSEARCH 0x00100 /* doing non-inc search */
696 #define RL_STATE_SEARCH 0x00200 /* doing a history search */
697 #define RL_STATE_NUMERICARG 0x00400 /* reading numeric argument */
698 #define RL_STATE_MACROINPUT 0x00800 /* getting input from a macro */
699 #define RL_STATE_MACRODEF 0x01000 /* defining keyboard macro */
700 #define RL_STATE_OVERWRITE 0x02000 /* overwrite mode */
701 #define RL_STATE_COMPLETING 0x04000 /* doing completion */
702 #define RL_STATE_SIGHANDLER 0x08000 /* in readline sighandler */
703 #define RL_STATE_UNDOING 0x10000 /* doing an undo */
704 #define RL_STATE_INPUTPENDING 0x20000 /* rl_execute_next called */
706 #define RL_STATE_DONE 0x80000 /* done; accepted line */
708 #define RL_SETSTATE(x) (rl_readline_state |= (x))
709 #define RL_UNSETSTATE(x) (rl_readline_state &= ~(x))
710 #define RL_ISSTATE(x) (rl_readline_state & (x))
712 #if !defined (savestring)
713 #define savestring rl_savestring
714 extern char *savestring __P((char *)); /* XXX backwards compatibility */
721 #endif /* _READLINE_H_ */