contrib/libreadline/readline.h

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