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 /* Readline.h -- the names of functions callable from within readline. */
   3
   4 /* Copyright (C) 1987, 1989, 1992 Free Software Foundation, Inc.
   5
   6    This file is part of the GNU Readline Library, a library for
   7    reading lines of text with interactive input and history editing.
   8
   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.
  13
  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.
  18
  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. */
  23
  24 #if !defined (_READLINE_H_)
  25 #define _READLINE_H_
  26
  27 #ifdef __cplusplus
  28 extern "C" {
  29 #endif
  30
  31 #if defined (READLINE_LIBRARY)
  32 #  include "rlstdc.h"
  33 #  include "keymaps.h"
  34 #  include "tilde.h"
  35 #else
  36 #  include <readline/rlstdc.h>
  37 #  include <readline/keymaps.h>
  38 #  include <readline/tilde.h>
  39 #endif
  40
  41 /* Readline data structures. */
  42
  43 /* Maintaining the state of undo.  We remember individual deletes and inserts
  44    on a chain of things to do. */
  45
  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 };
  50
  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. */
  57 } UNDO_LIST;
  58
  59 /* The current undo list for RL_LINE_BUFFER. */
  60 extern UNDO_LIST *rl_undo_list;
  61
  62 /* The data structure for mapping textual names to code addresses. */
  63 typedef struct _funmap {
  64   char *name;
  65   Function *function;
  66 } FUNMAP;
  67
  68 extern FUNMAP **funmap;
  69
  70 /* **************************************************************** */
  71 /*                                                                  */
  72 /*           Functions available to bind to key sequences           */
  73 /*                                                                  */
  74 /* **************************************************************** */
  75
  76 /* Bindable commands for numeric arguments. */
  77 extern int rl_digit_argument __P((int, int));
  78 extern int rl_universal_argument __P((int, int));
  79
  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));
  90
  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));
 103
 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));
 108
 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));
 112
 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));
 116
 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));
 122
 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));
 126
 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));
 130
 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));
 136
 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));
 142
 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 __CYGWIN32__ is defined. */
 160 #ifdef __CYGWIN32__
 161 extern int rl_paste_from_clipboard __P((int, int));
 162 #endif
 163
 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));
 167
 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));
 172
 173 /* Bindable undo commands. */
 174 extern int rl_revert_line __P((int, int));
 175 extern int rl_undo_command __P((int, int));
 176
 177 /* Bindable tilde expansion commands. */
 178 extern int rl_tilde_expand __P((int, int));
 179
 180 /* Bindable terminal control commands. */
 181 extern int rl_restart_output __P((int, int));
 182 extern int rl_stop_output __P((int, int));
 183
 184 /* Miscellaneous bindable commands. */
 185 extern int rl_abort __P((int, int));
 186 extern int rl_tty_status __P((int, int));
 187
 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));
 195
 196 /* Bindable command used when inserting a matching close character. */
 197 extern int rl_insert_close __P((int, int));
 198
 199 /* Not available unless READLINE_CALLBACKS is defined. */
 200 extern void rl_callback_handler_install __P((char *, VFunction *));
 201 extern void rl_callback_read_char __P((void));
 202 extern void rl_callback_handler_remove __P((void));
 203
 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));
 242
 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));
 247
 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));
 255
 256 /* **************************************************************** */
 257 /*                                                                  */
 258 /*                      Well Published Functions                    */
 259 /*                                                                  */
 260 /* **************************************************************** */
 261
 262 /* Readline functions. */
 263 /* Read a line of input.  Prompt with PROMPT.  A NULL PROMPT means none. */
 264 extern char *readline __P((char *));
 265
 266 extern int rl_initialize __P((void));
 267
 268 extern int rl_discard_argument __P((void));
 269
 270 /* Utility functions to bind keys to readline commands. */
 271 extern int rl_add_defun __P((char *, Function *, int));
 272 extern int rl_bind_key __P((int, Function *));
 273 extern int rl_bind_key_in_map __P((int, Function *, Keymap));
 274 extern int rl_unbind_key __P((int));
 275 extern int rl_unbind_key_in_map __P((int, Keymap));
 276 extern int rl_unbind_function_in_map __P((Function *, Keymap));
 277 extern int rl_unbind_command_in_map __P((char *, Keymap));
 278 extern int rl_set_key __P((char *, Function *, Keymap));
 279 extern int rl_generic_bind __P((int, char *, char *, Keymap));
 280 extern int rl_variable_bind __P((char *, char *));
 281
 282 /* Backwards compatibility, use rl_generic_bind instead. */
 283 extern int rl_macro_bind __P((char *, char *, Keymap));
 284
 285 /* Undocumented in the texinfo manual; not really useful to programs. */
 286 extern int rl_translate_keyseq __P((char *, char *, int *));
 287 extern char *rl_untranslate_keyseq __P((int));
 288
 289 extern Function *rl_named_function __P((char *));
 290 extern Function *rl_function_of_keyseq __P((char *, Keymap, int *));
 291
 292 extern void rl_list_funmap_names __P((void));
 293 extern char **rl_invoking_keyseqs_in_map __P((Function *, Keymap));
 294 extern char **rl_invoking_keyseqs __P((Function *));
 295
 296 extern void rl_function_dumper __P((int));
 297 extern void rl_macro_dumper __P((int));
 298 extern void rl_variable_dumper __P((int));
 299
 300 extern int rl_read_init_file __P((char *));
 301 extern int rl_parse_and_bind __P((char *));
 302
 303 /* Functions for manipulating keymaps. */
 304 extern Keymap rl_make_bare_keymap __P((void));
 305 extern Keymap rl_copy_keymap __P((Keymap));
 306 extern Keymap rl_make_keymap __P((void));
 307 extern void rl_discard_keymap __P((Keymap));
 308
 309 extern Keymap rl_get_keymap_by_name __P((char *));
 310 extern char *rl_get_keymap_name __P((Keymap));
 311 extern void rl_set_keymap __P((Keymap));
 312 extern Keymap rl_get_keymap __P((void));
 313 extern void rl_set_keymap_from_edit_mode __P((void));
 314 extern char *rl_get_keymap_name_from_edit_mode __P((void));
 315
 316 /* Functions for manipulating the funmap, which maps command names to functions. */
 317 extern int rl_add_funmap_entry __P((char *, Function *));
 318 extern void rl_initialize_funmap __P((void));
 319 extern char **rl_funmap_names __P((void));
 320
 321 /* Utility functions for managing keyboard macros. */
 322 extern void rl_push_macro_input __P((char *));
 323
 324 /* Functions for undoing, from undo.c */
 325 extern void rl_add_undo __P((enum undo_code, int, int, char *));
 326 extern void free_undo_list __P((void));
 327 extern int rl_do_undo __P((void));
 328 extern int rl_begin_undo_group __P((void));
 329 extern int rl_end_undo_group __P((void));
 330 extern int rl_modifying __P((int, int));
 331
 332 /* Functions for redisplay. */
 333 extern void rl_redisplay __P((void));
 334 extern int rl_on_new_line __P((void));
 335 extern int rl_on_new_line_with_prompt __P((void));
 336 extern int rl_forced_update_display __P((void));
 337 extern int rl_clear_message __P((void));
 338 extern int rl_reset_line_state __P((void));
 339
 340 #if (defined (__STDC__) || defined (__cplusplus)) && defined (USE_VARARGS) && defined (PREFER_STDARG)
 341 extern int rl_message (const char *, ...);
 342 #else
 343 extern int rl_message ();
 344 #endif
 345
 346 /* Undocumented in texinfo manual. */
 347 extern int rl_show_char __P((int));
 348 extern int rl_character_len __P((int, int));
 349 extern int crlf __P((void));
 350
 351 /* Save and restore internal prompt redisplay information. */
 352 extern void rl_save_prompt __P((void));
 353 extern void rl_restore_prompt __P((void));
 354
 355 /* Modifying text. */
 356 extern int rl_insert_text __P((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));
 360
 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 rltty_set_default_bindings __P((Keymap));
 365
 366 extern int rl_reset_terminal __P((char *));
 367 extern void rl_resize_terminal __P((void));
 368
 369 /* `Public' utility functions . */
 370 extern void rl_extend_line_buffer __P((int));
 371 extern int ding __P((void));
 372
 373 /* Functions for character input. */
 374 extern int rl_stuff_char __P((int));
 375 extern int rl_execute_next __P((int));
 376 extern int rl_read_key __P((void));
 377 extern int rl_getc __P((FILE *));
 378
 379 /* Readline signal handling, from signals.c */
 380 extern int rl_set_signals __P((void));
 381 extern int rl_clear_signals __P((void));
 382 extern void rl_cleanup_after_signal __P((void));
 383 extern void rl_reset_after_signal __P((void));
 384 extern void rl_free_line_state __P((void));
 385
 386 /* Undocumented. */
 387 extern int rl_expand_prompt __P((char *));
 388
 389 extern int maybe_save_line __P((void));
 390 extern int maybe_unsave_line __P((void));
 391 extern int maybe_replace_line __P((void));
 392
 393 /* Completion functions. */
 394 extern int rl_complete_internal __P((int));
 395 extern void rl_display_match_list __P((char **, int, int));
 396
 397 extern char **completion_matches __P((char *, CPFunction *));
 398 extern char *username_completion_function __P((char *, int));
 399 extern char *filename_completion_function __P((char *, int));
 400
 401 /* **************************************************************** */
 402 /*                                                                  */
 403 /*                      Well Published Variables                    */
 404 /*                                                                  */
 405 /* **************************************************************** */
 406
 407 /* The version of this incarnation of the readline library. */
 408 extern char *rl_library_version;
 409
 410 /* True if this is real GNU readline. */
 411 extern int rl_gnu_readline_p;
 412
 413 /* The name of the calling program.  You should initialize this to
 414    whatever was in argv[0].  It is used when parsing conditionals. */
 415 extern char *rl_readline_name;
 416
 417 /* The prompt readline uses.  This is set from the argument to
 418    readline (), and should not be assigned to directly. */
 419 extern char *rl_prompt;
 420
 421 /* The line buffer that is in use. */
 422 extern char *rl_line_buffer;
 423
 424 /* The location of point, and end. */
 425 extern int rl_point, rl_end;
 426
 427 /* The mark, or saved cursor position. */
 428 extern int rl_mark;
 429
 430 /* Flag to indicate that readline has finished with the current input
 431    line and should return it. */
 432 extern int rl_done;
 433
 434 /* If set to a character value, that will be the next keystroke read. */
 435 extern int rl_pending_input;
 436
 437 /* Non-zero if we called this function from _rl_dispatch().  It's present
 438    so functions can find out whether they were called from a key binding
 439    or directly from an application. */
 440 extern int rl_dispatching;
 441
 442 /* The name of the terminal to use. */
 443 extern char *rl_terminal_name;
 444
 445 /* The input and output streams. */
 446 extern FILE *rl_instream, *rl_outstream;
 447
 448 /* If non-zero, then this is the address of a function to call just
 449    before readline_internal () prints the first prompt. */
 450 extern Function *rl_startup_hook;
 451
 452 /* If non-zero, this is the address of a function to call just before
 453    readline_internal_setup () returns and readline_internal starts
 454    reading input characters. */
 455 extern Function *rl_pre_input_hook;
 456
 457 /* The address of a function to call periodically while Readline is
 458    awaiting character input, or NULL, for no event handling. */
 459 extern Function *rl_event_hook;
 460
 461 extern Function *rl_getc_function;
 462 extern VFunction *rl_redisplay_function;
 463 extern VFunction *rl_prep_term_function;
 464 extern VFunction *rl_deprep_term_function;
 465
 466 /* Dispatch variables. */
 467 extern Keymap rl_executing_keymap;
 468 extern Keymap rl_binding_keymap;
 469
 470 /* Display variables. */
 471 /* If non-zero, readline will erase the entire line, including any prompt,
 472    if the only thing typed on an otherwise-blank line is something bound to
 473    rl_newline. */
 474 extern int rl_erase_empty_line;
 475
 476 /* If non-zero, the application has already printed the prompt (rl_prompt)
 477    before calling readline, so readline should not output it the first time
 478    redisplay is done. */
 479 extern int rl_already_prompted;
 480
 481 /* A non-zero value means to read only this many characters rather than
 482    up to a character bound to accept-line. */
 483 extern int rl_num_chars_to_read;
 484
 485 /* Variables to control readline signal handling. */
 486 /* If non-zero, readline will install its own signal handlers for
 487    SIGINT, SIGTERM, SIGQUIT, SIGALRM, SIGTSTP, SIGTTIN, and SIGTTOU. */
 488 extern int rl_catch_signals;
 489
 490 /* If non-zero, readline will install a signal handler for SIGWINCH
 491    that also attempts to call any calling application's SIGWINCH signal
 492    handler.  Note that the terminal is not cleaned up before the
 493    application's signal handler is called; use rl_cleanup_after_signal()
 494    to do that. */
 495 extern int rl_catch_sigwinch;
 496
 497 /* Completion variables. */
 498 /* Pointer to the generator function for completion_matches ().
 499    NULL means to use filename_entry_function (), the default filename
 500    completer. */
 501 extern Function *rl_completion_entry_function;
 502
 503 /* If rl_ignore_some_completions_function is non-NULL it is the address
 504    of a function to call after all of the possible matches have been
 505    generated, but before the actual completion is done to the input line.
 506    The function is called with one argument; a NULL terminated array
 507    of (char *).  If your function removes any of the elements, they
 508    must be free()'ed. */
 509 extern Function *rl_ignore_some_completions_function;
 510
 511 /* Pointer to alternative function to create matches.
 512    Function is called with TEXT, START, and END.
 513    START and END are indices in RL_LINE_BUFFER saying what the boundaries
 514    of TEXT are.
 515    If this function exists and returns NULL then call the value of
 516    rl_completion_entry_function to try to match, otherwise use the
 517    array of strings returned. */
 518 extern CPPFunction *rl_attempted_completion_function;
 519
 520 /* The basic list of characters that signal a break between words for the
 521    completer routine.  The initial contents of this variable is what
 522    breaks words in the shell, i.e. "n\"\\'`@$>". */
 523 extern char *rl_basic_word_break_characters;
 524
 525 /* The list of characters that signal a break between words for
 526    rl_complete_internal.  The default list is the contents of
 527    rl_basic_word_break_characters.  */
 528 extern char *rl_completer_word_break_characters;
 529
 530 /* List of characters which can be used to quote a substring of the line.
 531    Completion occurs on the entire substring, and within the substring
 532    rl_completer_word_break_characters are treated as any other character,
 533    unless they also appear within this list. */
 534 extern char *rl_completer_quote_characters;
 535
 536 /* List of quote characters which cause a word break. */
 537 extern char *rl_basic_quote_characters;
 538
 539 /* List of characters that need to be quoted in filenames by the completer. */
 540 extern char *rl_filename_quote_characters;
 541
 542 /* List of characters that are word break characters, but should be left
 543    in TEXT when it is passed to the completion function.  The shell uses
 544    this to help determine what kind of completing to do. */
 545 extern char *rl_special_prefixes;
 546
 547 /* If non-zero, then this is the address of a function to call when
 548    completing on a directory name.  The function is called with
 549    the address of a string (the current directory name) as an arg. */
 550 extern Function *rl_directory_completion_hook;
 551
 552 /* Backwards compatibility with previous versions of readline. */
 553 #define rl_symbolic_link_hook rl_directory_completion_hook
 554
 555 /* If non-zero, then this is the address of a function to call when
 556    completing a word would normally display the list of possible matches.
 557    This function is called instead of actually doing the display.
 558    It takes three arguments: (char **matches, int num_matches, int max_length)
 559    where MATCHES is the array of strings that matched, NUM_MATCHES is the
 560    number of strings in that array, and MAX_LENGTH is the length of the
 561    longest string in that array. */
 562 extern VFunction *rl_completion_display_matches_hook;
 563
 564 /* Non-zero means that the results of the matches are to be treated
 565    as filenames.  This is ALWAYS zero on entry, and can only be changed
 566    within a completion entry finder function. */
 567 extern int rl_filename_completion_desired;
 568
 569 /* Non-zero means that the results of the matches are to be quoted using
 570    double quotes (or an application-specific quoting mechanism) if the
 571    filename contains any characters in rl_word_break_chars.  This is
 572    ALWAYS non-zero on entry, and can only be changed within a completion
 573    entry finder function. */
 574 extern int rl_filename_quoting_desired;
 575
 576 /* Set to a function to quote a filename in an application-specific fashion.
 577    Called with the text to quote, the type of match found (single or multiple)
 578    and a pointer to the quoting character to be used, which the function can
 579    reset if desired. */
 580 extern CPFunction *rl_filename_quoting_function;
 581
 582 /* Function to call to remove quoting characters from a filename.  Called
 583    before completion is attempted, so the embedded quotes do not interfere
 584    with matching names in the file system. */
 585 extern CPFunction *rl_filename_dequoting_function;
 586
 587 /* Function to call to decide whether or not a word break character is
 588    quoted.  If a character is quoted, it does not break words for the
 589    completer. */
 590 extern Function *rl_char_is_quoted_p;
 591
 592 /* Non-zero means to suppress normal filename completion after the
 593    user-specified completion function has been called. */
 594 extern int rl_attempted_completion_over;
 595
 596 /* Set to a character describing the type of completion being attempted by
 597    rl_complete_internal; available for use by application completion
 598    functions. */
 599 extern int rl_completion_type;
 600
 601 /* Character appended to completed words when at the end of the line.  The
 602    default is a space.  Nothing is added if this is '\0'. */
 603 extern int rl_completion_append_character;
 604
 605 /* Up to this many items will be displayed in response to a
 606    possible-completions call.  After that, we ask the user if she
 607    is sure she wants to see them all.  The default value is 100. */
 608 extern int rl_completion_query_items;
 609
 610 /* If non-zero, then disallow duplicates in the matches. */
 611 extern int rl_ignore_completion_duplicates;
 612
 613 /* If this is non-zero, completion is (temporarily) inhibited, and the
 614    completion character will be inserted as any other. */
 615 extern int rl_inhibit_completion;
 616
 617 /* Definitions available for use by readline clients. */
 618 #define RL_PROMPT_START_IGNORE  '\001'
 619 #define RL_PROMPT_END_IGNORE    '\002'
 620
 621 /* Possible values for do_replace argument to rl_filename_quoting_function,
 622    called by rl_complete_internal. */
 623 #define NO_MATCH        0
 624 #define SINGLE_MATCH    1
 625 #define MULT_MATCH      2
 626
 627 #if !defined (savestring)
 628 #define savestring rl_savestring
 629 extern char *savestring __P((char *));  /* XXX backwards compatibility */
 630 #endif
 631
 632 #ifdef __cplusplus
 633 }
 634 #endif
 635
 636 #endif /* _READLINE_H_ */