contrib/readline-5.0/readline.h

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