contrib/libreadline/readline.h

   1 /* $FreeBSD: src/contrib/libreadline/readline.h,v 1.9.2.2 2000/07/06 23:04:24 ache Exp $ */
   2 /* $DragonFly: src/contrib/libreadline/Attic/readline.h,v 1.2 2003/06/17 04:24:03 dillon Exp $ */
   3 /* Readline.h -- the names of functions callable from within readline. */
   4
   5 /* Copyright (C) 1987, 1989, 1992 Free Software Foundation, Inc.
   6
   7    This file is part of the GNU Readline Library, a library for
   8    reading lines of text with interactive input and history editing.
   9
  10    The GNU Readline Library is free software; you can redistribute it
  11    and/or modify it under the terms of the GNU General Public License
  12    as published by the Free Software Foundation; either version 2, or
  13    (at your option) any later version.
  14
  15    The GNU Readline Library is distributed in the hope that it will be
  16    useful, but WITHOUT ANY WARRANTY; without even the implied warranty
  17    of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18    GNU General Public License for more details.
  19
  20    The GNU General Public License is often shipped with GNU software, and
  21    is generally kept in a file called COPYING or LICENSE.  If you do not
  22    have a copy of the license, write to the Free Software Foundation,
  23    59 Temple Place, Suite 330, Boston, MA 02111 USA. */
  24
  25 #if !defined (_READLINE_H_)
  26 #define _READLINE_H_
  27
  28 #ifdef __cplusplus
  29 extern "C" {
  30 #endif
  31
  32 #if defined (READLINE_LIBRARY)
  33 #  include "rlstdc.h"
  34 #  include "keymaps.h"
  35 #  include "tilde.h"
  36 #else
  37 #  include <readline/rlstdc.h>
  38 #  include <readline/keymaps.h>
  39 #  include <readline/tilde.h>
  40 #endif
  41
  42 /* Readline data structures. */
  43
  44 /* Maintaining the state of undo.  We remember individual deletes and inserts
  45    on a chain of things to do. */
  46
  47 /* The actions that undo knows how to undo.  Notice that UNDO_DELETE means
  48    to insert some text, and UNDO_INSERT means to delete some text.   I.e.,
  49    the code tells undo what to undo, not how to undo it. */
  50 enum undo_code { UNDO_DELETE, UNDO_INSERT, UNDO_BEGIN, UNDO_END };
  51
  52 /* What an element of THE_UNDO_LIST looks like. */
  53 typedef struct undo_list {
  54   struct undo_list *next;
  55   int start, end;               /* Where the change took place. */
  56   char *text;                   /* The text to insert, if undoing a delete. */
  57   enum undo_code what;          /* Delete, Insert, Begin, End. */
  58 } UNDO_LIST;
  59
  60 /* The current undo list for RL_LINE_BUFFER. */
  61 extern UNDO_LIST *rl_undo_list;
  62
  63 /* The data structure for mapping textual names to code addresses. */
  64 typedef struct _funmap {
  65   char *name;
  66   Function *function;
  67 } FUNMAP;
  68
  69 extern FUNMAP **funmap;
  70
  71 /* **************************************************************** */
  72 /*                                                                  */
  73 /*           Functions available to bind to key sequences           */
  74 /*                                                                  */
  75 /* **************************************************************** */
  76
  77 /* Bindable commands for numeric arguments. */
  78 extern int rl_digit_argument __P((int, int));
  79 extern int rl_universal_argument __P((int, int));
  80
  81 /* Bindable commands for moving the cursor. */
  82 extern int rl_forward __P((int, int));
  83 extern int rl_backward __P((int, int));
  84 extern int rl_beg_of_line __P((int, int));
  85 extern int rl_end_of_line __P((int, int));
  86 extern int rl_forward_word __P((int, int));
  87 extern int rl_backward_word __P((int, int));
  88 extern int rl_refresh_line __P((int, int));
  89 extern int rl_clear_screen __P((int, int));
  90 extern int rl_arrow_keys __P((int, int));
  91
  92 /* Bindable commands for inserting and deleting text. */
  93 extern int rl_insert __P((int, int));
  94 extern int rl_quoted_insert __P((int, int));
  95 extern int rl_tab_insert __P((int, int));
  96 extern int rl_newline __P((int, int));
  97 extern int rl_do_lowercase_version __P((int, int));
  98 extern int rl_rubout __P((int, int));
  99 extern int rl_delete __P((int, int));
 100 extern int rl_rubout_or_delete __P((int, int));
 101 extern int rl_delete_horizontal_space __P((int, int));
 102 extern int rl_delete_or_show_completions __P((int, int));
 103 extern int rl_insert_comment __P((int, int));
 104
 105 /* Bindable commands for changing case. */
 106 extern int rl_upcase_word __P((int, int));
 107 extern int rl_downcase_word __P((int, int));
 108 extern int rl_capitalize_word __P((int, int));
 109
 110 /* Bindable commands for transposing characters and words. */
 111 extern int rl_transpose_words __P((int, int));
 112 extern int rl_transpose_chars __P((int, int));
 113
 114 /* Bindable commands for searching within a line. */
 115 extern int rl_char_search __P((int, int));
 116 extern int rl_backward_char_search __P((int, int));
 117
 118 /* Bindable commands for readline's interface to the command history. */
 119 extern int rl_beginning_of_history __P((int, int));
 120 extern int rl_end_of_history __P((int, int));
 121 extern int rl_get_next_history __P((int, int));
 122 extern int rl_get_previous_history __P((int, int));
 123
 124 /* Bindable commands for managing the mark and region. */
 125 extern int rl_set_mark __P((int, int));
 126 extern int rl_exchange_point_and_mark __P((int, int));
 127
 128 /* Bindable commands to set the editing mode (emacs or vi). */
 129 extern int rl_vi_editing_mode __P((int, int));
 130 extern int rl_emacs_editing_mode __P((int, int));
 131
 132 /* Bindable commands for managing key bindings. */
 133 extern int rl_re_read_init_file __P((int, int));
 134 extern int rl_dump_functions __P((int, int));
 135 extern int rl_dump_macros __P((int, int));
 136 extern int rl_dump_variables __P((int, int));
 137
 138 /* Bindable commands for word completion. */
 139 extern int rl_complete __P((int, int));
 140 extern int rl_possible_completions __P((int, int));
 141 extern int rl_insert_completions __P((int, int));
 142 extern int rl_menu_complete __P((int, int));
 143
 144 /* Bindable commands for killing and yanking text, and managing the kill ring. */
 145 extern int rl_kill_word __P((int, int));
 146 extern int rl_backward_kill_word __P((int, int));
 147 extern int rl_kill_line __P((int, int));
 148 extern int rl_backward_kill_line __P((int, int));
 149 extern int rl_kill_full_line __P((int, int));
 150 extern int rl_unix_word_rubout __P((int, int));
 151 extern int rl_unix_line_discard __P((int, int));
 152 extern int rl_copy_region_to_kill __P((int, int));
 153 extern int rl_kill_region __P((int, int));
 154 extern int rl_copy_forward_word __P((int, int));
 155 extern int rl_copy_backward_word __P((int, int));
 156 extern int rl_yank __P((int, int));
 157 extern int rl_yank_pop __P((int, int));
 158 extern int rl_yank_nth_arg __P((int, int));
 159 extern int rl_yank_last_arg __P((int, int));
 160 /* Not available unless __CYGWIN32__ is defined. */
 161 #ifdef __CYGWIN32__
 162 extern int rl_paste_from_clipboard __P((int, int));
 163 #endif
 164
 165 /* Bindable commands for incremental searching. */
 166 extern int rl_reverse_search_history __P((int, int));
 167 extern int rl_forward_search_history __P((int, int));
 168
 169 /* Bindable keyboard macro commands. */
 170 extern int rl_start_kbd_macro __P((int, int));
 171 extern int rl_end_kbd_macro __P((int, int));
 172 extern int rl_call_last_kbd_macro __P((int, int));
 173
 174 /* Bindable undo commands. */
 175 extern int rl_revert_line __P((int, int));
 176 extern int rl_undo_command __P((int, int));
 177
 178 /* Bindable tilde expansion commands. */
 179 extern int rl_tilde_expand __P((int, int));
 180
 181 /* Bindable terminal control commands. */
 182 extern int rl_restart_output __P((int, int));
 183 extern int rl_stop_output __P((int, int));
 184
 185 /* Miscellaneous bindable commands. */
 186 extern int rl_abort __P((int, int));
 187 extern int rl_tty_status __P((int, int));
 188
 189 /* Bindable commands for incremental and non-incremental history searching. */
 190 extern int rl_history_search_forward __P((int, int));
 191 extern int rl_history_search_backward __P((int, int));
 192 extern int rl_noninc_forward_search __P((int, int));
 193 extern int rl_noninc_reverse_search __P((int, int));
 194 extern int rl_noninc_forward_search_again __P((int, int));
 195 extern int rl_noninc_reverse_search_again __P((int, int));
 196
 197 /* Bindable command used when inserting a matching close character. */
 198 extern int rl_insert_close __P((int, int));
 199
 200 /* Not available unless READLINE_CALLBACKS is defined. */
 201 extern void rl_callback_handler_install __P((char *, VFunction *));
 202 extern void rl_callback_read_char __P((void));
 203 extern void rl_callback_handler_remove __P((void));
 204
 205 /* Things for vi mode. Not available unless readline is compiled -DVI_MODE. */
 206 /* VI-mode bindable commands. */
 207 extern int rl_vi_redo __P((int, int));
 208 extern int rl_vi_undo __P((int, int));
 209 extern int rl_vi_yank_arg __P((int, int));
 210 extern int rl_vi_fetch_history __P((int, int));
 211 extern int rl_vi_search_again __P((int, int));
 212 extern int rl_vi_search __P((int, int));
 213 extern int rl_vi_complete __P((int, int));
 214 extern int rl_vi_tilde_expand __P((int, int));
 215 extern int rl_vi_prev_word __P((int, int));
 216 extern int rl_vi_next_word __P((int, int));
 217 extern int rl_vi_end_word __P((int, int));
 218 extern int rl_vi_insert_beg __P((int, int));
 219 extern int rl_vi_append_mode __P((int, int));
 220 extern int rl_vi_append_eol __P((int, int));
 221 extern int rl_vi_eof_maybe __P((int, int));
 222 extern int rl_vi_insertion_mode __P((int, int));
 223 extern int rl_vi_movement_mode __P((int, int));
 224 extern int rl_vi_arg_digit __P((int, int));
 225 extern int rl_vi_change_case __P((int, int));
 226 extern int rl_vi_put __P((int, int));
 227 extern int rl_vi_column __P((int, int));
 228 extern int rl_vi_delete_to __P((int, int));
 229 extern int rl_vi_change_to __P((int, int));
 230 extern int rl_vi_yank_to __P((int, int));
 231 extern int rl_vi_delete __P((int, int));
 232 extern int rl_vi_back_to_indent __P((int, int));
 233 extern int rl_vi_first_print __P((int, int));
 234 extern int rl_vi_char_search __P((int, int));
 235 extern int rl_vi_match __P((int, int));
 236 extern int rl_vi_change_char __P((int, int));
 237 extern int rl_vi_subst __P((int, int));
 238 extern int rl_vi_overstrike __P((int, int));
 239 extern int rl_vi_overstrike_delete __P((int, int));
 240 extern int rl_vi_replace __P((int, int));
 241 extern int rl_vi_set_mark __P((int, int));
 242 extern int rl_vi_goto_mark __P((int, int));
 243
 244 /* VI-mode utility functions. */
 245 extern int rl_vi_check __P((void));
 246 extern int rl_vi_domove __P((int, int *));
 247 extern int rl_vi_bracktype __P((int));
 248
 249 /* VI-mode pseudo-bindable commands, used as utility functions. */
 250 extern int rl_vi_fWord __P((int, int));
 251 extern int rl_vi_bWord __P((int, int));
 252 extern int rl_vi_eWord __P((int, int));
 253 extern int rl_vi_fword __P((int, int));
 254 extern int rl_vi_bword __P((int, int));
 255 extern int rl_vi_eword __P((int, int));
 256
 257 /* **************************************************************** */
 258 /*                                                                  */
 259 /*                      Well Published Functions                    */
 260 /*                                                                  */
 261 /* **************************************************************** */
 262
 263 /* Readline functions. */
 264 /* Read a line of input.  Prompt with PROMPT.  A NULL PROMPT means none. */
 265 extern char *readline __P((char *));
 266
 267 extern int rl_initialize __P((void));
 268
 269 extern int rl_discard_argument __P((void));
 270
 271 /* Utility functions to bind keys to readline commands. */
 272 extern int rl_add_defun __P((char *, Function *, int));
 273 extern int rl_bind_key __P((int, Function *));
 274 extern int rl_bind_key_in_map __P((int, Function *, Keymap));
 275 extern int rl_unbind_key __P((int));
 276 extern int rl_unbind_key_in_map __P((int, Keymap));
 277 extern int rl_unbind_function_in_map __P((Function *, Keymap));
 278 extern int rl_unbind_command_in_map __P((char *, Keymap));
 279 extern int rl_set_key __P((char *, Function *, Keymap));
 280 extern int rl_generic_bind __P((int, char *, char *, Keymap));
 281 extern int rl_variable_bind __P((char *, char *));
 282
 283 /* Backwards compatibility, use rl_generic_bind instead. */
 284 extern int rl_macro_bind __P((char *, char *, Keymap));
 285
 286 /* Undocumented in the texinfo manual; not really useful to programs. */
 287 extern int rl_translate_keyseq __P((char *, char *, int *));
 288 extern char *rl_untranslate_keyseq __P((int));
 289
 290 extern Function *rl_named_function __P((char *));
 291 extern Function *rl_function_of_keyseq __P((char *, Keymap, int *));
 292
 293 extern void rl_list_funmap_names __P((void));
 294 extern char **rl_invoking_keyseqs_in_map __P((Function *, Keymap));
 295 extern char **rl_invoking_keyseqs __P((Function *));
 296
 297 extern void rl_function_dumper __P((int));
 298 extern void rl_macro_dumper __P((int));
 299 extern void rl_variable_dumper __P((int));
 300
 301 extern int rl_read_init_file __P((char *));
 302 extern int rl_parse_and_bind __P((char *));
 303
 304 /* Functions for manipulating keymaps. */
 305 extern Keymap rl_make_bare_keymap __P((void));
 306 extern Keymap rl_copy_keymap __P((Keymap));
 307 extern Keymap rl_make_keymap __P((void));
 308 extern void rl_discard_keymap __P((Keymap));
 309
 310 extern Keymap rl_get_keymap_by_name __P((char *));
 311 extern char *rl_get_keymap_name __P((Keymap));
 312 extern void rl_set_keymap __P((Keymap));
 313 extern Keymap rl_get_keymap __P((void));
 314 extern void rl_set_keymap_from_edit_mode __P((void));
 315 extern char *rl_get_keymap_name_from_edit_mode __P((void));
 316
 317 /* Functions for manipulating the funmap, which maps command names to functions. */
 318 extern int rl_add_funmap_entry __P((char *, Function *));
 319 extern void rl_initialize_funmap __P((void));
 320 extern char **rl_funmap_names __P((void));
 321
 322 /* Utility functions for managing keyboard macros. */
 323 extern void rl_push_macro_input __P((char *));
 324
 325 /* Functions for undoing, from undo.c */
 326 extern void rl_add_undo __P((enum undo_code, int, int, char *));
 327 extern void free_undo_list __P((void));
 328 extern int rl_do_undo __P((void));
 329 extern int rl_begin_undo_group __P((void));
 330 extern int rl_end_undo_group __P((void));
 331 extern int rl_modifying __P((int, int));
 332
 333 /* Functions for redisplay. */
 334 extern void rl_redisplay __P((void));
 335 extern int rl_on_new_line __P((void));
 336 extern int rl_on_new_line_with_prompt __P((void));
 337 extern int rl_forced_update_display __P((void));
 338 extern int rl_clear_message __P((void));
 339 extern int rl_reset_line_state __P((void));
 340
 341 #if (defined (__STDC__) || defined (__cplusplus)) && defined (USE_VARARGS) && defined (PREFER_STDARG)
 342 extern int rl_message (const char *, ...);
 343 #else
 344 extern int rl_message ();
 345 #endif
 346
 347 /* Undocumented in texinfo manual. */
 348 extern int rl_show_char __P((int));
 349 extern int rl_character_len __P((int, int));
 350 extern int crlf __P((void));
 351
 352 /* Save and restore internal prompt redisplay information. */
 353 extern void rl_save_prompt __P((void));
 354 extern void rl_restore_prompt __P((void));
 355
 356 /* Modifying text. */
 357 extern int rl_insert_text __P((char *));
 358 extern int rl_delete_text __P((int, int));
 359 extern int rl_kill_text __P((int, int));
 360 extern char *rl_copy_text __P((int, int));
 361
 362 /* Terminal and tty mode management. */
 363 extern void rl_prep_terminal __P((int));
 364 extern void rl_deprep_terminal __P((void));
 365 extern void rltty_set_default_bindings __P((Keymap));
 366
 367 extern int rl_reset_terminal __P((char *));
 368 extern void rl_resize_terminal __P((void));
 369
 370 /* `Public' utility functions . */
 371 extern void rl_extend_line_buffer __P((int));
 372 extern int ding __P((void));
 373
 374 /* Functions for character input. */
 375 extern int rl_stuff_char __P((int));
 376 extern int rl_execute_next __P((int));
 377 extern int rl_read_key __P((void));
 378 extern int rl_getc __P((FILE *));
 379
 380 /* Readline signal handling, from signals.c */
 381 extern int rl_set_signals __P((void));
 382 extern int rl_clear_signals __P((void));
 383 extern void rl_cleanup_after_signal __P((void));
 384 extern void rl_reset_after_signal __P((void));
 385 extern void rl_free_line_state __P((void));
 386
 387 /* Undocumented. */
 388 extern int rl_expand_prompt __P((char *));
 389
 390 extern int maybe_save_line __P((void));
 391 extern int maybe_unsave_line __P((void));
 392 extern int maybe_replace_line __P((void));
 393
 394 /* Completion functions. */
 395 extern int rl_complete_internal __P((int));
 396 extern void rl_display_match_list __P((char **, int, int));
 397
 398 extern char **completion_matches __P((char *, CPFunction *));
 399 extern char *username_completion_function __P((char *, int));
 400 extern char *filename_completion_function __P((char *, int));
 401
 402 /* **************************************************************** */
 403 /*                                                                  */
 404 /*                      Well Published Variables                    */
 405 /*                                                                  */
 406 /* **************************************************************** */
 407
 408 /* The version of this incarnation of the readline library. */
 409 extern char *rl_library_version;
 410
 411 /* True if this is real GNU readline. */
 412 extern int rl_gnu_readline_p;
 413
 414 /* The name of the calling program.  You should initialize this to
 415    whatever was in argv[0].  It is used when parsing conditionals. */
 416 extern char *rl_readline_name;
 417
 418 /* The prompt readline uses.  This is set from the argument to
 419    readline (), and should not be assigned to directly. */
 420 extern char *rl_prompt;
 421
 422 /* The line buffer that is in use. */
 423 extern char *rl_line_buffer;
 424
 425 /* The location of point, and end. */
 426 extern int rl_point, rl_end;
 427
 428 /* The mark, or saved cursor position. */
 429 extern int rl_mark;
 430
 431 /* Flag to indicate that readline has finished with the current input
 432    line and should return it. */
 433 extern int rl_done;
 434
 435 /* If set to a character value, that will be the next keystroke read. */
 436 extern int rl_pending_input;
 437
 438 /* Non-zero if we called this function from _rl_dispatch().  It's present
 439    so functions can find out whether they were called from a key binding
 440    or directly from an application. */
 441 extern int rl_dispatching;
 442
 443 /* The name of the terminal to use. */
 444 extern char *rl_terminal_name;
 445
 446 /* The input and output streams. */
 447 extern FILE *rl_instream, *rl_outstream;
 448
 449 /* If non-zero, then this is the address of a function to call just
 450    before readline_internal () prints the first prompt. */
 451 extern Function *rl_startup_hook;
 452
 453 /* If non-zero, this is the address of a function to call just before
 454    readline_internal_setup () returns and readline_internal starts
 455    reading input characters. */
 456 extern Function *rl_pre_input_hook;
 457
 458 /* The address of a function to call periodically while Readline is
 459    awaiting character input, or NULL, for no event handling. */
 460 extern Function *rl_event_hook;
 461
 462 extern Function *rl_getc_function;
 463 extern VFunction *rl_redisplay_function;
 464 extern VFunction *rl_prep_term_function;
 465 extern VFunction *rl_deprep_term_function;
 466
 467 /* Dispatch variables. */
 468 extern Keymap rl_executing_keymap;
 469 extern Keymap rl_binding_keymap;
 470
 471 /* Display variables. */
 472 /* If non-zero, readline will erase the entire line, including any prompt,
 473    if the only thing typed on an otherwise-blank line is something bound to
 474    rl_newline. */
 475 extern int rl_erase_empty_line;
 476
 477 /* If non-zero, the application has already printed the prompt (rl_prompt)
 478    before calling readline, so readline should not output it the first time
 479    redisplay is done. */
 480 extern int rl_already_prompted;
 481
 482 /* A non-zero value means to read only this many characters rather than
 483    up to a character bound to accept-line. */
 484 extern int rl_num_chars_to_read;
 485
 486 /* Variables to control readline signal handling. */
 487 /* If non-zero, readline will install its own signal handlers for
 488    SIGINT, SIGTERM, SIGQUIT, SIGALRM, SIGTSTP, SIGTTIN, and SIGTTOU. */
 489 extern int rl_catch_signals;
 490
 491 /* If non-zero, readline will install a signal handler for SIGWINCH
 492    that also attempts to call any calling application's SIGWINCH signal
 493    handler.  Note that the terminal is not cleaned up before the
 494    application's signal handler is called; use rl_cleanup_after_signal()
 495    to do that. */
 496 extern int rl_catch_sigwinch;
 497
 498 /* Completion variables. */
 499 /* Pointer to the generator function for completion_matches ().
 500    NULL means to use filename_entry_function (), the default filename
 501    completer. */
 502 extern Function *rl_completion_entry_function;
 503
 504 /* If rl_ignore_some_completions_function is non-NULL it is the address
 505    of a function to call after all of the possible matches have been
 506    generated, but before the actual completion is done to the input line.
 507    The function is called with one argument; a NULL terminated array
 508    of (char *).  If your function removes any of the elements, they
 509    must be free()'ed. */
 510 extern Function *rl_ignore_some_completions_function;
 511
 512 /* Pointer to alternative function to create matches.
 513    Function is called with TEXT, START, and END.
 514    START and END are indices in RL_LINE_BUFFER saying what the boundaries
 515    of TEXT are.
 516    If this function exists and returns NULL then call the value of
 517    rl_completion_entry_function to try to match, otherwise use the
 518    array of strings returned. */
 519 extern CPPFunction *rl_attempted_completion_function;
 520
 521 /* The basic list of characters that signal a break between words for the
 522    completer routine.  The initial contents of this variable is what
 523    breaks words in the shell, i.e. "n\"\\'`@$>". */
 524 extern char *rl_basic_word_break_characters;
 525
 526 /* The list of characters that signal a break between words for
 527    rl_complete_internal.  The default list is the contents of
 528    rl_basic_word_break_characters.  */
 529 extern char *rl_completer_word_break_characters;
 530
 531 /* List of characters which can be used to quote a substring of the line.
 532    Completion occurs on the entire substring, and within the substring
 533    rl_completer_word_break_characters are treated as any other character,
 534    unless they also appear within this list. */
 535 extern char *rl_completer_quote_characters;
 536
 537 /* List of quote characters which cause a word break. */
 538 extern char *rl_basic_quote_characters;
 539
 540 /* List of characters that need to be quoted in filenames by the completer. */
 541 extern char *rl_filename_quote_characters;
 542
 543 /* List of characters that are word break characters, but should be left
 544    in TEXT when it is passed to the completion function.  The shell uses
 545    this to help determine what kind of completing to do. */
 546 extern char *rl_special_prefixes;
 547
 548 /* If non-zero, then this is the address of a function to call when
 549    completing on a directory name.  The function is called with
 550    the address of a string (the current directory name) as an arg. */
 551 extern Function *rl_directory_completion_hook;
 552
 553 /* Backwards compatibility with previous versions of readline. */
 554 #define rl_symbolic_link_hook rl_directory_completion_hook
 555
 556 /* If non-zero, then this is the address of a function to call when
 557    completing a word would normally display the list of possible matches.
 558    This function is called instead of actually doing the display.
 559    It takes three arguments: (char **matches, int num_matches, int max_length)
 560    where MATCHES is the array of strings that matched, NUM_MATCHES is the
 561    number of strings in that array, and MAX_LENGTH is the length of the
 562    longest string in that array. */
 563 extern VFunction *rl_completion_display_matches_hook;
 564
 565 /* Non-zero means that the results of the matches are to be treated
 566    as filenames.  This is ALWAYS zero on entry, and can only be changed
 567    within a completion entry finder function. */
 568 extern int rl_filename_completion_desired;
 569
 570 /* Non-zero means that the results of the matches are to be quoted using
 571    double quotes (or an application-specific quoting mechanism) if the
 572    filename contains any characters in rl_word_break_chars.  This is
 573    ALWAYS non-zero on entry, and can only be changed within a completion
 574    entry finder function. */
 575 extern int rl_filename_quoting_desired;
 576
 577 /* Set to a function to quote a filename in an application-specific fashion.
 578    Called with the text to quote, the type of match found (single or multiple)
 579    and a pointer to the quoting character to be used, which the function can
 580    reset if desired. */
 581 extern CPFunction *rl_filename_quoting_function;
 582
 583 /* Function to call to remove quoting characters from a filename.  Called
 584    before completion is attempted, so the embedded quotes do not interfere
 585    with matching names in the file system. */
 586 extern CPFunction *rl_filename_dequoting_function;
 587
 588 /* Function to call to decide whether or not a word break character is
 589    quoted.  If a character is quoted, it does not break words for the
 590    completer. */
 591 extern Function *rl_char_is_quoted_p;
 592
 593 /* Non-zero means to suppress normal filename completion after the
 594    user-specified completion function has been called. */
 595 extern int rl_attempted_completion_over;
 596
 597 /* Set to a character describing the type of completion being attempted by
 598    rl_complete_internal; available for use by application completion
 599    functions. */
 600 extern int rl_completion_type;
 601
 602 /* Character appended to completed words when at the end of the line.  The
 603    default is a space.  Nothing is added if this is '\0'. */
 604 extern int rl_completion_append_character;
 605
 606 /* Up to this many items will be displayed in response to a
 607    possible-completions call.  After that, we ask the user if she
 608    is sure she wants to see them all.  The default value is 100. */
 609 extern int rl_completion_query_items;
 610
 611 /* If non-zero, then disallow duplicates in the matches. */
 612 extern int rl_ignore_completion_duplicates;
 613
 614 /* If this is non-zero, completion is (temporarily) inhibited, and the
 615    completion character will be inserted as any other. */
 616 extern int rl_inhibit_completion;
 617
 618 /* Definitions available for use by readline clients. */
 619 #define RL_PROMPT_START_IGNORE  '\001'
 620 #define RL_PROMPT_END_IGNORE    '\002'
 621
 622 /* Possible values for do_replace argument to rl_filename_quoting_function,
 623    called by rl_complete_internal. */
 624 #define NO_MATCH        0
 625 #define SINGLE_MATCH    1
 626 #define MULT_MATCH      2
 627
 628 #if !defined (savestring)
 629 #define savestring rl_savestring
 630 extern char *savestring __P((char *));  /* XXX backwards compatibility */
 631 #endif
 632
 633 #ifdef __cplusplus
 634 }
 635 #endif
 636
 637 #endif /* _READLINE_H_ */