lib/readline/readline.h

   1 /* Readline.h -- the names of functions callable from within readline. */
   2
   3 /* Copyright (C) 1987-2022 Free Software Foundation, Inc.
   4
   5    This file is part of the GNU Readline Library (Readline), a library
   6    for reading lines of text with interactive input and history editing.
   7
   8    Readline is free software: you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation, either version 3 of the License, or
  11    (at your option) any later version.
  12
  13    Readline is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with Readline.  If not, see <http://www.gnu.org/licenses/>.
  20 */
  21
  22 #if !defined (_READLINE_H_)
  23 #define _READLINE_H_
  24
  25 #ifdef __cplusplus
  26 extern "C" {
  27 #endif
  28
  29 #if defined (READLINE_LIBRARY)
  30 #  include "rlstdc.h"
  31 #  include "rltypedefs.h"
  32 #  include "keymaps.h"
  33 #  include "tilde.h"
  34 #else
  35 #  include <readline/rlstdc.h>
  36 #  include <readline/rltypedefs.h>
  37 #  include <readline/keymaps.h>
  38 #  include <readline/tilde.h>
  39 #endif
  40
  41 /* Hex-encoded Readline version number. */
  42 #define RL_READLINE_VERSION     0x0802          /* Readline 8.2 */
  43 #define RL_VERSION_MAJOR        8
  44 #define RL_VERSION_MINOR        2
  45
  46 /* Readline data structures. */
  47
  48 /* Maintaining the state of undo.  We remember individual deletes and inserts
  49    on a chain of things to do. */
  50
  51 /* The actions that undo knows how to undo.  Notice that UNDO_DELETE means
  52    to insert some text, and UNDO_INSERT means to delete some text.   I.e.,
  53    the code tells undo what to undo, not how to undo it. */
  54 enum undo_code { UNDO_DELETE, UNDO_INSERT, UNDO_BEGIN, UNDO_END };
  55
  56 /* What an element of THE_UNDO_LIST looks like. */
  57 typedef struct undo_list {
  58   struct undo_list *next;
  59   int start, end;               /* Where the change took place. */
  60   char *text;                   /* The text to insert, if undoing a delete. */
  61   enum undo_code what;          /* Delete, Insert, Begin, End. */
  62 } UNDO_LIST;
  63
  64 /* The current undo list for RL_LINE_BUFFER. */
  65 extern UNDO_LIST *rl_undo_list;
  66
  67 /* The data structure for mapping textual names to code addresses. */
  68 typedef struct _funmap {
  69   const char *name;
  70   rl_command_func_t *function;
  71 } FUNMAP;
  72
  73 extern FUNMAP **funmap;
  74
  75 /* **************************************************************** */
  76 /*                                                                  */
  77 /*           Functions available to bind to key sequences           */
  78 /*                                                                  */
  79 /* **************************************************************** */
  80
  81 /* Bindable commands for numeric arguments. */
  82 extern int rl_digit_argument (int, int);
  83 extern int rl_universal_argument (int, int);
  84
  85 /* Bindable commands for moving the cursor. */
  86 extern int rl_forward_byte (int, int);
  87 extern int rl_forward_char (int, int);
  88 extern int rl_forward (int, int);
  89 extern int rl_backward_byte (int, int);
  90 extern int rl_backward_char (int, int);
  91 extern int rl_backward (int, int);
  92 extern int rl_beg_of_line (int, int);
  93 extern int rl_end_of_line (int, int);
  94 extern int rl_forward_word (int, int);
  95 extern int rl_backward_word (int, int);
  96 extern int rl_refresh_line (int, int);
  97 extern int rl_clear_screen (int, int);
  98 extern int rl_clear_display (int, int);
  99 extern int rl_skip_csi_sequence (int, int);
 100 extern int rl_arrow_keys (int, int);
 101
 102 extern int rl_previous_screen_line (int, int);
 103 extern int rl_next_screen_line (int, int);
 104
 105 /* Bindable commands for inserting and deleting text. */
 106 extern int rl_insert (int, int);
 107 extern int rl_quoted_insert (int, int);
 108 extern int rl_tab_insert (int, int);
 109 extern int rl_newline (int, int);
 110 extern int rl_do_lowercase_version (int, int);
 111 extern int rl_rubout (int, int);
 112 extern int rl_delete (int, int);
 113 extern int rl_rubout_or_delete (int, int);
 114 extern int rl_delete_horizontal_space (int, int);
 115 extern int rl_delete_or_show_completions (int, int);
 116 extern int rl_insert_comment (int, int);
 117
 118 /* Bindable commands for changing case. */
 119 extern int rl_upcase_word (int, int);
 120 extern int rl_downcase_word (int, int);
 121 extern int rl_capitalize_word (int, int);
 122
 123 /* Bindable commands for transposing characters and words. */
 124 extern int rl_transpose_words (int, int);
 125 extern int rl_transpose_chars (int, int);
 126
 127 /* Bindable commands for searching within a line. */
 128 extern int rl_char_search (int, int);
 129 extern int rl_backward_char_search (int, int);
 130
 131 /* Bindable commands for readline's interface to the command history. */
 132 extern int rl_beginning_of_history (int, int);
 133 extern int rl_end_of_history (int, int);
 134 extern int rl_get_next_history (int, int);
 135 extern int rl_get_previous_history (int, int);
 136 extern int rl_operate_and_get_next (int, int);
 137 extern int rl_fetch_history (int, int);
 138
 139 /* Bindable commands for managing the mark and region. */
 140 extern int rl_set_mark (int, int);
 141 extern int rl_exchange_point_and_mark (int, int);
 142
 143 /* Bindable commands to set the editing mode (emacs or vi). */
 144 extern int rl_vi_editing_mode (int, int);
 145 extern int rl_emacs_editing_mode (int, int);
 146
 147 /* Bindable commands to change the insert mode (insert or overwrite) */
 148 extern int rl_overwrite_mode (int, int);
 149
 150 /* Bindable commands for managing key bindings. */
 151 extern int rl_re_read_init_file (int, int);
 152 extern int rl_dump_functions (int, int);
 153 extern int rl_dump_macros (int, int);
 154 extern int rl_dump_variables (int, int);
 155
 156 /* Bindable commands for word completion. */
 157 extern int rl_complete (int, int);
 158 extern int rl_possible_completions (int, int);
 159 extern int rl_insert_completions (int, int);
 160 extern int rl_old_menu_complete (int, int);
 161 extern int rl_menu_complete (int, int);
 162 extern int rl_backward_menu_complete (int, int);
 163
 164 /* Bindable commands for killing and yanking text, and managing the kill ring. */
 165 extern int rl_kill_word (int, int);
 166 extern int rl_backward_kill_word (int, int);
 167 extern int rl_kill_line (int, int);
 168 extern int rl_backward_kill_line (int, int);
 169 extern int rl_kill_full_line (int, int);
 170 extern int rl_unix_word_rubout (int, int);
 171 extern int rl_unix_filename_rubout (int, int);
 172 extern int rl_unix_line_discard (int, int);
 173 extern int rl_copy_region_to_kill (int, int);
 174 extern int rl_kill_region (int, int);
 175 extern int rl_copy_forward_word (int, int);
 176 extern int rl_copy_backward_word (int, int);
 177 extern int rl_yank (int, int);
 178 extern int rl_yank_pop (int, int);
 179 extern int rl_yank_nth_arg (int, int);
 180 extern int rl_yank_last_arg (int, int);
 181 extern int rl_bracketed_paste_begin (int, int);
 182 /* Not available unless _WIN32 is defined. */
 183 #if defined (_WIN32)
 184 extern int rl_paste_from_clipboard (int, int);
 185 #endif
 186
 187 /* Bindable commands for incremental searching. */
 188 extern int rl_reverse_search_history (int, int);
 189 extern int rl_forward_search_history (int, int);
 190
 191 /* Bindable keyboard macro commands. */
 192 extern int rl_start_kbd_macro (int, int);
 193 extern int rl_end_kbd_macro (int, int);
 194 extern int rl_call_last_kbd_macro (int, int);
 195 extern int rl_print_last_kbd_macro (int, int);
 196
 197 /* Bindable undo commands. */
 198 extern int rl_revert_line (int, int);
 199 extern int rl_undo_command (int, int);
 200
 201 /* Bindable tilde expansion commands. */
 202 extern int rl_tilde_expand (int, int);
 203
 204 /* Bindable terminal control commands. */
 205 extern int rl_restart_output (int, int);
 206 extern int rl_stop_output (int, int);
 207
 208 /* Miscellaneous bindable commands. */
 209 extern int rl_abort (int, int);
 210 extern int rl_tty_status (int, int);
 211
 212 /* Bindable commands for incremental and non-incremental history searching. */
 213 extern int rl_history_search_forward (int, int);
 214 extern int rl_history_search_backward (int, int);
 215 extern int rl_history_substr_search_forward (int, int);
 216 extern int rl_history_substr_search_backward (int, int);
 217 extern int rl_noninc_forward_search (int, int);
 218 extern int rl_noninc_reverse_search (int, int);
 219 extern int rl_noninc_forward_search_again (int, int);
 220 extern int rl_noninc_reverse_search_again (int, int);
 221
 222 /* Bindable command used when inserting a matching close character. */
 223 extern int rl_insert_close (int, int);
 224
 225 /* Not available unless READLINE_CALLBACKS is defined. */
 226 extern void rl_callback_handler_install (const char *, rl_vcpfunc_t *);
 227 extern void rl_callback_read_char (void);
 228 extern void rl_callback_handler_remove (void);
 229 extern void rl_callback_sigcleanup (void);
 230
 231 /* Things for vi mode. Not available unless readline is compiled -DVI_MODE. */
 232 /* VI-mode bindable commands. */
 233 extern int rl_vi_redo (int, int);
 234 extern int rl_vi_undo (int, int);
 235 extern int rl_vi_yank_arg (int, int);
 236 extern int rl_vi_fetch_history (int, int);
 237 extern int rl_vi_search_again (int, int);
 238 extern int rl_vi_search (int, int);
 239 extern int rl_vi_complete (int, int);
 240 extern int rl_vi_tilde_expand (int, int);
 241 extern int rl_vi_prev_word (int, int);
 242 extern int rl_vi_next_word (int, int);
 243 extern int rl_vi_end_word (int, int);
 244 extern int rl_vi_insert_beg (int, int);
 245 extern int rl_vi_append_mode (int, int);
 246 extern int rl_vi_append_eol (int, int);
 247 extern int rl_vi_eof_maybe (int, int);
 248 extern int rl_vi_insertion_mode (int, int);
 249 extern int rl_vi_insert_mode (int, int);
 250 extern int rl_vi_movement_mode (int, int);
 251 extern int rl_vi_arg_digit (int, int);
 252 extern int rl_vi_change_case (int, int);
 253 extern int rl_vi_put (int, int);
 254 extern int rl_vi_column (int, int);
 255 extern int rl_vi_delete_to (int, int);
 256 extern int rl_vi_change_to (int, int);
 257 extern int rl_vi_yank_to (int, int);
 258 extern int rl_vi_yank_pop (int, int);
 259 extern int rl_vi_rubout (int, int);
 260 extern int rl_vi_delete (int, int);
 261 extern int rl_vi_back_to_indent (int, int);
 262 extern int rl_vi_unix_word_rubout (int, int);
 263 extern int rl_vi_first_print (int, int);
 264 extern int rl_vi_char_search (int, int);
 265 extern int rl_vi_match (int, int);
 266 extern int rl_vi_change_char (int, int);
 267 extern int rl_vi_subst (int, int);
 268 extern int rl_vi_overstrike (int, int);
 269 extern int rl_vi_overstrike_delete (int, int);
 270 extern int rl_vi_replace (int, int);
 271 extern int rl_vi_set_mark (int, int);
 272 extern int rl_vi_goto_mark (int, int);
 273
 274 /* VI-mode utility functions. */
 275 extern int rl_vi_check (void);
 276 extern int rl_vi_domove (int, int *);
 277 extern int rl_vi_bracktype (int);
 278
 279 extern void rl_vi_start_inserting (int, int, int);
 280
 281 /* VI-mode pseudo-bindable commands, used as utility functions. */
 282 extern int rl_vi_fWord (int, int);
 283 extern int rl_vi_bWord (int, int);
 284 extern int rl_vi_eWord (int, int);
 285 extern int rl_vi_fword (int, int);
 286 extern int rl_vi_bword (int, int);
 287 extern int rl_vi_eword (int, int);
 288
 289 /* **************************************************************** */
 290 /*                                                                  */
 291 /*                      Well Published Functions                    */
 292 /*                                                                  */
 293 /* **************************************************************** */
 294
 295 /* Readline functions. */
 296 /* Read a line of input.  Prompt with PROMPT.  A NULL PROMPT means none. */
 297 extern char *readline (const char *);
 298
 299 extern int rl_set_prompt (const char *);
 300 extern int rl_expand_prompt (char *);
 301
 302 extern int rl_initialize (void);
 303
 304 /* Undocumented; unused by readline */
 305 extern int rl_discard_argument (void);
 306
 307 /* Utility functions to bind keys to readline commands. */
 308 extern int rl_add_defun (const char *, rl_command_func_t *, int);
 309 extern int rl_bind_key (int, rl_command_func_t *);
 310 extern int rl_bind_key_in_map (int, rl_command_func_t *, Keymap);
 311 extern int rl_unbind_key (int);
 312 extern int rl_unbind_key_in_map (int, Keymap);
 313 extern int rl_bind_key_if_unbound (int, rl_command_func_t *);
 314 extern int rl_bind_key_if_unbound_in_map (int, rl_command_func_t *, Keymap);
 315 extern int rl_unbind_function_in_map (rl_command_func_t *, Keymap);
 316 extern int rl_unbind_command_in_map (const char *, Keymap);
 317 extern int rl_bind_keyseq (const char *, rl_command_func_t *);
 318 extern int rl_bind_keyseq_in_map (const char *, rl_command_func_t *, Keymap);
 319 extern int rl_bind_keyseq_if_unbound (const char *, rl_command_func_t *);
 320 extern int rl_bind_keyseq_if_unbound_in_map (const char *, rl_command_func_t *, Keymap);
 321 extern int rl_generic_bind (int, const char *, char *, Keymap);
 322
 323 extern char *rl_variable_value (const char *);
 324 extern int rl_variable_bind (const char *, const char *);
 325
 326 /* Backwards compatibility, use rl_bind_keyseq_in_map instead. */
 327 extern int rl_set_key (const char *, rl_command_func_t *, Keymap);
 328
 329 /* Backwards compatibility, use rl_generic_bind instead. */
 330 extern int rl_macro_bind (const char *, const char *, Keymap);
 331
 332 /* Undocumented in the texinfo manual; not really useful to programs. */
 333 extern int rl_translate_keyseq (const char *, char *, int *);
 334 extern char *rl_untranslate_keyseq (int);
 335
 336 extern rl_command_func_t *rl_named_function (const char *);
 337 extern rl_command_func_t *rl_function_of_keyseq (const char *, Keymap, int *);
 338 extern rl_command_func_t *rl_function_of_keyseq_len (const char *, size_t, Keymap, int *);
 339 extern int rl_trim_arg_from_keyseq (const char *, size_t, Keymap);
 340
 341 extern void rl_list_funmap_names (void);
 342 extern char **rl_invoking_keyseqs_in_map (rl_command_func_t *, Keymap);
 343 extern char **rl_invoking_keyseqs (rl_command_func_t *);
 344
 345 extern void rl_function_dumper (int);
 346 extern void rl_macro_dumper (int);
 347 extern void rl_variable_dumper (int);
 348
 349 extern int rl_read_init_file (const char *);
 350 extern int rl_parse_and_bind (char *);
 351
 352 /* Functions for manipulating keymaps. */
 353 extern Keymap rl_make_bare_keymap (void);
 354 extern int rl_empty_keymap (Keymap);
 355 extern Keymap rl_copy_keymap (Keymap);
 356 extern Keymap rl_make_keymap (void);
 357 extern void rl_discard_keymap (Keymap);
 358 extern void rl_free_keymap (Keymap);
 359
 360 extern Keymap rl_get_keymap_by_name (const char *);
 361 extern char *rl_get_keymap_name (Keymap);
 362 extern void rl_set_keymap (Keymap);
 363 extern Keymap rl_get_keymap (void);
 364
 365 extern int rl_set_keymap_name (const char *, Keymap);
 366
 367 /* Undocumented; used internally only. */
 368 extern void rl_set_keymap_from_edit_mode (void);
 369 extern char *rl_get_keymap_name_from_edit_mode (void);
 370
 371 /* Functions for manipulating the funmap, which maps command names to functions. */
 372 extern int rl_add_funmap_entry (const char *, rl_command_func_t *);
 373 extern const char **rl_funmap_names (void);
 374 /* Undocumented, only used internally -- there is only one funmap, and this
 375    function may be called only once. */
 376 extern void rl_initialize_funmap (void);
 377
 378 /* Utility functions for managing keyboard macros. */
 379 extern void rl_push_macro_input (char *);
 380
 381 /* Functions for undoing, from undo.c */
 382 extern void rl_add_undo (enum undo_code, int, int, char *);
 383 extern void rl_free_undo_list (void);
 384 extern int rl_do_undo (void);
 385 extern int rl_begin_undo_group (void);
 386 extern int rl_end_undo_group (void);
 387 extern int rl_modifying (int, int);
 388
 389 /* Functions for redisplay. */
 390 extern void rl_redisplay (void);
 391 extern int rl_on_new_line (void);
 392 extern int rl_on_new_line_with_prompt (void);
 393 extern int rl_forced_update_display (void);
 394 extern int rl_clear_visible_line (void);
 395 extern int rl_clear_message (void);
 396 extern int rl_reset_line_state (void);
 397 extern int rl_crlf (void);
 398
 399 /* Functions to manage the mark and region, especially the notion of an
 400    active mark and an active region. */
 401 extern void rl_keep_mark_active (void);
 402
 403 extern void rl_activate_mark (void);
 404 extern void rl_deactivate_mark (void);
 405 extern int rl_mark_active_p (void);
 406
 407 #if defined (USE_VARARGS) && defined (PREFER_STDARG)
 408 extern int rl_message (const char *, ...)  __attribute__((__format__ (printf, 1, 2)));
 409 #else
 410 extern int rl_message ();
 411 #endif
 412
 413 extern int rl_show_char (int);
 414
 415 /* Undocumented in texinfo manual. */
 416 extern int rl_character_len (int, int);
 417 extern void rl_redraw_prompt_last_line (void);
 418
 419 /* Save and restore internal prompt redisplay information. */
 420 extern void rl_save_prompt (void);
 421 extern void rl_restore_prompt (void);
 422
 423 /* Modifying text. */
 424 extern void rl_replace_line (const char *, int);
 425 extern int rl_insert_text (const char *);
 426 extern int rl_delete_text (int, int);
 427 extern int rl_kill_text (int, int);
 428 extern char *rl_copy_text (int, int);
 429
 430 /* Terminal and tty mode management. */
 431 extern void rl_prep_terminal (int);
 432 extern void rl_deprep_terminal (void);
 433 extern void rl_tty_set_default_bindings (Keymap);
 434 extern void rl_tty_unset_default_bindings (Keymap);
 435
 436 extern int rl_tty_set_echoing (int);
 437 extern int rl_reset_terminal (const char *);
 438 extern void rl_resize_terminal (void);
 439 extern void rl_set_screen_size (int, int);
 440 extern void rl_get_screen_size (int *, int *);
 441 extern void rl_reset_screen_size (void);
 442
 443 extern char *rl_get_termcap (const char *);
 444
 445 /* Functions for character input. */
 446 extern int rl_stuff_char (int);
 447 extern int rl_execute_next (int);
 448 extern int rl_clear_pending_input (void);
 449 extern int rl_read_key (void);
 450 extern int rl_getc (FILE *);
 451 extern int rl_set_keyboard_input_timeout (int);
 452
 453 /* Functions to set and reset timeouts. */
 454 extern int rl_set_timeout (unsigned int, unsigned int);
 455 extern int rl_timeout_remaining (unsigned int *, unsigned int *);
 456
 457 #undef rl_clear_timeout
 458 #define rl_clear_timeout() rl_set_timeout (0, 0)
 459
 460 /* `Public' utility functions . */
 461 extern void rl_extend_line_buffer (int);
 462 extern int rl_ding (void);
 463 extern int rl_alphabetic (int);
 464 extern void rl_free (void *);
 465
 466 /* Readline signal handling, from signals.c */
 467 extern int rl_set_signals (void);
 468 extern int rl_clear_signals (void);
 469 extern void rl_cleanup_after_signal (void);
 470 extern void rl_reset_after_signal (void);
 471 extern void rl_free_line_state (void);
 472
 473 extern int rl_pending_signal (void);
 474 extern void rl_check_signals (void);
 475
 476 extern void rl_echo_signal_char (int);
 477
 478 extern int rl_set_paren_blink_timeout (int);
 479
 480 /* History management functions. */
 481
 482 extern void rl_clear_history (void);
 483
 484 /* Undocumented. */
 485 extern int rl_maybe_save_line (void);
 486 extern int rl_maybe_unsave_line (void);
 487 extern int rl_maybe_replace_line (void);
 488
 489 /* Completion functions. */
 490 extern int rl_complete_internal (int);
 491 extern void rl_display_match_list (char **, int, int);
 492
 493 extern char **rl_completion_matches (const char *, rl_compentry_func_t *);
 494 extern char *rl_username_completion_function (const char *, int);
 495 extern char *rl_filename_completion_function (const char *, int);
 496
 497 extern int rl_completion_mode (rl_command_func_t *);
 498
 499 #if 0
 500 /* Backwards compatibility (compat.c).  These will go away sometime. */
 501 extern void free_undo_list (void);
 502 extern int maybe_save_line (void);
 503 extern int maybe_unsave_line (void);
 504 extern int maybe_replace_line (void);
 505
 506 extern int ding (void);
 507 extern int alphabetic (int);
 508 extern int crlf (void);
 509
 510 extern char **completion_matches (char *, rl_compentry_func_t *);
 511 extern char *username_completion_function (const char *, int);
 512 extern char *filename_completion_function (const char *, int);
 513 #endif
 514
 515 /* **************************************************************** */
 516 /*                                                                  */
 517 /*                      Well Published Variables                    */
 518 /*                                                                  */
 519 /* **************************************************************** */
 520
 521 /* The version of this incarnation of the readline library. */
 522 extern const char *rl_library_version;          /* e.g., "4.2" */
 523 extern int rl_readline_version;                 /* e.g., 0x0402 */
 524
 525 /* True if this is real GNU readline. */
 526 extern int rl_gnu_readline_p;
 527
 528 /* Flags word encapsulating the current readline state. */
 529 extern unsigned long rl_readline_state;
 530
 531 /* Says which editing mode readline is currently using.  1 means emacs mode;
 532    0 means vi mode. */
 533 extern int rl_editing_mode;
 534
 535 /* Insert or overwrite mode for emacs mode.  1 means insert mode; 0 means
 536    overwrite mode.  Reset to insert mode on each input line. */
 537 extern int rl_insert_mode;
 538
 539 /* The name of the calling program.  You should initialize this to
 540    whatever was in argv[0].  It is used when parsing conditionals. */
 541 extern const char *rl_readline_name;
 542
 543 /* The prompt readline uses.  This is set from the argument to
 544    readline (), and should not be assigned to directly. */
 545 extern char *rl_prompt;
 546
 547 /* The prompt string that is actually displayed by rl_redisplay.  Public so
 548    applications can more easily supply their own redisplay functions. */
 549 extern char *rl_display_prompt;
 550
 551 /* The line buffer that is in use. */
 552 extern char *rl_line_buffer;
 553
 554 /* The location of point, and end. */
 555 extern int rl_point;
 556 extern int rl_end;
 557
 558 /* The mark, or saved cursor position. */
 559 extern int rl_mark;
 560
 561 /* Flag to indicate that readline has finished with the current input
 562    line and should return it. */
 563 extern int rl_done;
 564
 565 /* Flag to indicate that readline has read an EOF character or read has
 566    returned 0 or error, and is returning a NULL line as a result. */
 567 extern int rl_eof_found;
 568
 569 /* If set to a character value, that will be the next keystroke read. */
 570 extern int rl_pending_input;
 571
 572 /* Non-zero if we called this function from _rl_dispatch().  It's present
 573    so functions can find out whether they were called from a key binding
 574    or directly from an application. */
 575 extern int rl_dispatching;
 576
 577 /* Non-zero if the user typed a numeric argument before executing the
 578    current function. */
 579 extern int rl_explicit_arg;
 580
 581 /* The current value of the numeric argument specified by the user. */
 582 extern int rl_numeric_arg;
 583
 584 /* The address of the last command function Readline executed. */
 585 extern rl_command_func_t *rl_last_func;
 586
 587 /* The name of the terminal to use. */
 588 extern const char *rl_terminal_name;
 589
 590 /* The input and output streams. */
 591 extern FILE *rl_instream;
 592 extern FILE *rl_outstream;
 593
 594 /* If non-zero, Readline gives values of LINES and COLUMNS from the environment
 595    greater precedence than values fetched from the kernel when computing the
 596    screen dimensions. */
 597 extern int rl_prefer_env_winsize;
 598
 599 /* If non-zero, then this is the address of a function to call just
 600    before readline_internal () prints the first prompt. */
 601 extern rl_hook_func_t *rl_startup_hook;
 602
 603 /* If non-zero, this is the address of a function to call just before
 604    readline_internal_setup () returns and readline_internal starts
 605    reading input characters. */
 606 extern rl_hook_func_t *rl_pre_input_hook;
 607
 608 /* The address of a function to call periodically while Readline is
 609    awaiting character input, or NULL, for no event handling. */
 610 extern rl_hook_func_t *rl_event_hook;
 611
 612 /* The address of a function to call if a read is interrupted by a signal. */
 613 extern rl_hook_func_t *rl_signal_event_hook;
 614
 615 extern rl_hook_func_t *rl_timeout_event_hook;
 616
 617 /* The address of a function to call if Readline needs to know whether or not
 618    there is data available from the current input source. */
 619 extern rl_hook_func_t *rl_input_available_hook;
 620
 621 /* The address of the function to call to fetch a character from the current
 622    Readline input stream */
 623 extern rl_getc_func_t *rl_getc_function;
 624
 625 extern rl_voidfunc_t *rl_redisplay_function;
 626
 627 extern rl_vintfunc_t *rl_prep_term_function;
 628 extern rl_voidfunc_t *rl_deprep_term_function;
 629
 630 /* Dispatch variables. */
 631 extern Keymap rl_executing_keymap;
 632 extern Keymap rl_binding_keymap;
 633
 634 extern int rl_executing_key;
 635 extern char *rl_executing_keyseq;
 636 extern int rl_key_sequence_length;
 637
 638 /* Display variables. */
 639 /* If non-zero, readline will erase the entire line, including any prompt,
 640    if the only thing typed on an otherwise-blank line is something bound to
 641    rl_newline. */
 642 extern int rl_erase_empty_line;
 643
 644 /* If non-zero, the application has already printed the prompt (rl_prompt)
 645    before calling readline, so readline should not output it the first time
 646    redisplay is done. */
 647 extern int rl_already_prompted;
 648
 649 /* A non-zero value means to read only this many characters rather than
 650    up to a character bound to accept-line. */
 651 extern int rl_num_chars_to_read;
 652
 653 /* The text of a currently-executing keyboard macro. */
 654 extern char *rl_executing_macro;
 655
 656 /* Variables to control readline signal handling. */
 657 /* If non-zero, readline will install its own signal handlers for
 658    SIGINT, SIGTERM, SIGQUIT, SIGALRM, SIGTSTP, SIGTTIN, and SIGTTOU. */
 659 extern int rl_catch_signals;
 660
 661 /* If non-zero, readline will install a signal handler for SIGWINCH
 662    that also attempts to call any calling application's SIGWINCH signal
 663    handler.  Note that the terminal is not cleaned up before the
 664    application's signal handler is called; use rl_cleanup_after_signal()
 665    to do that. */
 666 extern int rl_catch_sigwinch;
 667
 668 /* If non-zero, the readline SIGWINCH handler will modify LINES and
 669    COLUMNS in the environment. */
 670 extern int rl_change_environment;
 671
 672 /* Completion variables. */
 673 /* Pointer to the generator function for completion_matches ().
 674    NULL means to use rl_filename_completion_function (), the default
 675    filename completer. */
 676 extern rl_compentry_func_t *rl_completion_entry_function;
 677
 678 /* Optional generator for menu completion.  Default is
 679    rl_completion_entry_function (rl_filename_completion_function). */
 680 extern rl_compentry_func_t *rl_menu_completion_entry_function;
 681
 682 /* If rl_ignore_some_completions_function is non-NULL it is the address
 683    of a function to call after all of the possible matches have been
 684    generated, but before the actual completion is done to the input line.
 685    The function is called with one argument; a NULL terminated array
 686    of (char *).  If your function removes any of the elements, they
 687    must be free()'ed. */
 688 extern rl_compignore_func_t *rl_ignore_some_completions_function;
 689
 690 /* Pointer to alternative function to create matches.
 691    Function is called with TEXT, START, and END.
 692    START and END are indices in RL_LINE_BUFFER saying what the boundaries
 693    of TEXT are.
 694    If this function exists and returns NULL then call the value of
 695    rl_completion_entry_function to try to match, otherwise use the
 696    array of strings returned. */
 697 extern rl_completion_func_t *rl_attempted_completion_function;
 698
 699 /* The basic list of characters that signal a break between words for the
 700    completer routine.  The initial contents of this variable is what
 701    breaks words in the shell, i.e. "n\"\\'`@$>". */
 702 extern const char *rl_basic_word_break_characters;
 703
 704 /* The list of characters that signal a break between words for
 705    rl_complete_internal.  The default list is the contents of
 706    rl_basic_word_break_characters.  */
 707 extern const char *rl_completer_word_break_characters;
 708
 709 /* Hook function to allow an application to set the completion word
 710    break characters before readline breaks up the line.  Allows
 711    position-dependent word break characters. */
 712 extern rl_cpvfunc_t *rl_completion_word_break_hook;
 713
 714 /* List of characters which can be used to quote a substring of the line.
 715    Completion occurs on the entire substring, and within the substring
 716    rl_completer_word_break_characters are treated as any other character,
 717    unless they also appear within this list. */
 718 extern const char *rl_completer_quote_characters;
 719
 720 /* List of quote characters which cause a word break. */
 721 extern const char *rl_basic_quote_characters;
 722
 723 /* List of characters that need to be quoted in filenames by the completer. */
 724 extern const char *rl_filename_quote_characters;
 725
 726 /* List of characters that are word break characters, but should be left
 727    in TEXT when it is passed to the completion function.  The shell uses
 728    this to help determine what kind of completing to do. */
 729 extern const char *rl_special_prefixes;
 730
 731 /* If non-zero, then this is the address of a function to call when
 732    completing on a directory name.  The function is called with
 733    the address of a string (the current directory name) as an arg.  It
 734    changes what is displayed when the possible completions are printed
 735    or inserted.  The directory completion hook should perform
 736    any necessary dequoting.  This function should return 1 if it modifies
 737    the directory name pointer passed as an argument.  If the directory
 738    completion hook returns 0, it should not modify the directory name
 739    pointer passed as an argument. */
 740 extern rl_icppfunc_t *rl_directory_completion_hook;
 741
 742 /* If non-zero, this is the address of a function to call when completing
 743    a directory name.  This function takes the address of the directory name
 744    to be modified as an argument.  Unlike rl_directory_completion_hook, it
 745    only modifies the directory name used in opendir(2), not what is displayed
 746    when the possible completions are printed or inserted.  If set, it takes
 747    precedence over rl_directory_completion_hook.  The directory rewrite
 748    hook should perform any necessary dequoting.  This function has the same
 749    return value properties as the directory_completion_hook.
 750
 751    I'm not happy with how this works yet, so it's undocumented.  I'm trying
 752    it in bash to see how well it goes. */
 753 extern rl_icppfunc_t *rl_directory_rewrite_hook;
 754
 755 /* If non-zero, this is the address of a function for the completer to call
 756    before deciding which character to append to a completed name.  It should
 757    modify the directory name passed as an argument if appropriate, and return
 758    non-zero if it modifies the name.  This should not worry about dequoting
 759    the filename; that has already happened by the time it gets here. */
 760 extern rl_icppfunc_t *rl_filename_stat_hook;
 761
 762 /* If non-zero, this is the address of a function to call when reading
 763    directory entries from the filesystem for completion and comparing
 764    them to the partial word to be completed.  The function should
 765    either return its first argument (if no conversion takes place) or
 766    newly-allocated memory.  This can, for instance, convert filenames
 767    between character sets for comparison against what's typed at the
 768    keyboard.  The returned value is what is added to the list of
 769    matches.  The second argument is the length of the filename to be
 770    converted. */
 771 extern rl_dequote_func_t *rl_filename_rewrite_hook;
 772
 773 /* Backwards compatibility with previous versions of readline. */
 774 #define rl_symbolic_link_hook rl_directory_completion_hook
 775
 776 /* If non-zero, then this is the address of a function to call when
 777    completing a word would normally display the list of possible matches.
 778    This function is called instead of actually doing the display.
 779    It takes three arguments: (char **matches, int num_matches, int max_length)
 780    where MATCHES is the array of strings that matched, NUM_MATCHES is the
 781    number of strings in that array, and MAX_LENGTH is the length of the
 782    longest string in that array. */
 783 extern rl_compdisp_func_t *rl_completion_display_matches_hook;
 784
 785 /* Non-zero means that the results of the matches are to be treated
 786    as filenames.  This is ALWAYS zero on entry, and can only be changed
 787    within a completion entry finder function. */
 788 extern int rl_filename_completion_desired;
 789
 790 /* Non-zero means that the results of the matches are to be quoted using
 791    double quotes (or an application-specific quoting mechanism) if the
 792    filename contains any characters in rl_word_break_chars.  This is
 793    ALWAYS non-zero on entry, and can only be changed within a completion
 794    entry finder function. */
 795 extern int rl_filename_quoting_desired;
 796
 797 /* Set to a function to quote a filename in an application-specific fashion.
 798    Called with the text to quote, the type of match found (single or multiple)
 799    and a pointer to the quoting character to be used, which the function can
 800    reset if desired. */
 801 extern rl_quote_func_t *rl_filename_quoting_function;
 802
 803 /* Function to call to remove quoting characters from a filename.  Called
 804    before completion is attempted, so the embedded quotes do not interfere
 805    with matching names in the file system. */
 806 extern rl_dequote_func_t *rl_filename_dequoting_function;
 807
 808 /* Function to call to decide whether or not a word break character is
 809    quoted.  If a character is quoted, it does not break words for the
 810    completer. */
 811 extern rl_linebuf_func_t *rl_char_is_quoted_p;
 812
 813 /* Non-zero means to suppress normal filename completion after the
 814    user-specified completion function has been called. */
 815 extern int rl_attempted_completion_over;
 816
 817 /* Set to a character describing the type of completion being attempted by
 818    rl_complete_internal; available for use by application completion
 819    functions. */
 820 extern int rl_completion_type;
 821
 822 /* Set to the last key used to invoke one of the completion functions */
 823 extern int rl_completion_invoking_key;
 824
 825 /* Up to this many items will be displayed in response to a
 826    possible-completions call.  After that, we ask the user if she
 827    is sure she wants to see them all.  The default value is 100. */
 828 extern int rl_completion_query_items;
 829
 830 /* Character appended to completed words when at the end of the line.  The
 831    default is a space.  Nothing is added if this is '\0'. */
 832 extern int rl_completion_append_character;
 833
 834 /* If set to non-zero by an application completion function,
 835    rl_completion_append_character will not be appended. */
 836 extern int rl_completion_suppress_append;
 837
 838 /* Set to any quote character readline thinks it finds before any application
 839    completion function is called. */
 840 extern int rl_completion_quote_character;
 841
 842 /* Set to a non-zero value if readline found quoting anywhere in the word to
 843    be completed; set before any application completion function is called. */
 844 extern int rl_completion_found_quote;
 845
 846 /* If non-zero, the completion functions don't append any closing quote.
 847    This is set to 0 by rl_complete_internal and may be changed by an
 848    application-specific completion function. */
 849 extern int rl_completion_suppress_quote;
 850
 851 /* If non-zero, readline will sort the completion matches.  On by default. */
 852 extern int rl_sort_completion_matches;
 853
 854 /* If non-zero, a slash will be appended to completed filenames that are
 855    symbolic links to directory names, subject to the value of the
 856    mark-directories variable (which is user-settable).  This exists so
 857    that application completion functions can override the user's preference
 858    (set via the mark-symlinked-directories variable) if appropriate.
 859    It's set to the value of _rl_complete_mark_symlink_dirs in
 860    rl_complete_internal before any application-specific completion
 861    function is called, so without that function doing anything, the user's
 862    preferences are honored. */
 863 extern int rl_completion_mark_symlink_dirs;
 864
 865 /* If non-zero, then disallow duplicates in the matches. */
 866 extern int rl_ignore_completion_duplicates;
 867
 868 /* If this is non-zero, completion is (temporarily) inhibited, and the
 869    completion character will be inserted as any other. */
 870 extern int rl_inhibit_completion;
 871
 872 /* Applications can set this to non-zero to have readline's signal handlers
 873    installed during the entire duration of reading a complete line, as in
 874    readline-6.2.  This should be used with care, because it can result in
 875    readline receiving signals and not handling them until it's called again
 876    via rl_callback_read_char, thereby stealing them from the application.
 877    By default, signal handlers are only active while readline is active. */
 878 extern int rl_persistent_signal_handlers;
 879
 880 /* Input error; can be returned by (*rl_getc_function) if readline is reading
 881    a top-level command (RL_ISSTATE (RL_STATE_READCMD)). */
 882 #define READERR                 (-2)
 883
 884 /* Definitions available for use by readline clients. */
 885 #define RL_PROMPT_START_IGNORE  '\001'
 886 #define RL_PROMPT_END_IGNORE    '\002'
 887
 888 /* Possible values for do_replace argument to rl_filename_quoting_function,
 889    called by rl_complete_internal. */
 890 #define NO_MATCH        0
 891 #define SINGLE_MATCH    1
 892 #define MULT_MATCH      2
 893
 894 /* Possible state values for rl_readline_state */
 895 #define RL_STATE_NONE           0x000000                /* no state; before first call */
 896
 897 #define RL_STATE_INITIALIZING   0x0000001       /* initializing */
 898 #define RL_STATE_INITIALIZED    0x0000002       /* initialization done */
 899 #define RL_STATE_TERMPREPPED    0x0000004       /* terminal is prepped */
 900 #define RL_STATE_READCMD        0x0000008       /* reading a command key */
 901 #define RL_STATE_METANEXT       0x0000010       /* reading input after ESC */
 902 #define RL_STATE_DISPATCHING    0x0000020       /* dispatching to a command */
 903 #define RL_STATE_MOREINPUT      0x0000040       /* reading more input in a command function */
 904 #define RL_STATE_ISEARCH        0x0000080       /* doing incremental search */
 905 #define RL_STATE_NSEARCH        0x0000100       /* doing non-inc search */
 906 #define RL_STATE_SEARCH         0x0000200       /* doing a history search */
 907 #define RL_STATE_NUMERICARG     0x0000400       /* reading numeric argument */
 908 #define RL_STATE_MACROINPUT     0x0000800       /* getting input from a macro */
 909 #define RL_STATE_MACRODEF       0x0001000       /* defining keyboard macro */
 910 #define RL_STATE_OVERWRITE      0x0002000       /* overwrite mode */
 911 #define RL_STATE_COMPLETING     0x0004000       /* doing completion */
 912 #define RL_STATE_SIGHANDLER     0x0008000       /* in readline sighandler */
 913 #define RL_STATE_UNDOING        0x0010000       /* doing an undo */
 914 #define RL_STATE_INPUTPENDING   0x0020000       /* rl_execute_next called */
 915 #define RL_STATE_TTYCSAVED      0x0040000       /* tty special chars saved */
 916 #define RL_STATE_CALLBACK       0x0080000       /* using the callback interface */
 917 #define RL_STATE_VIMOTION       0x0100000       /* reading vi motion arg */
 918 #define RL_STATE_MULTIKEY       0x0200000       /* reading multiple-key command */
 919 #define RL_STATE_VICMDONCE      0x0400000       /* entered vi command mode at least once */
 920 #define RL_STATE_CHARSEARCH     0x0800000       /* vi mode char search */
 921 #define RL_STATE_REDISPLAYING   0x1000000       /* updating terminal display */
 922
 923 #define RL_STATE_DONE           0x2000000       /* done; accepted line */
 924 #define RL_STATE_TIMEOUT        0x4000000       /* done; timed out */
 925 #define RL_STATE_EOF            0x8000000       /* done; got eof on read */
 926
 927 #define RL_SETSTATE(x)          (rl_readline_state |= (x))
 928 #define RL_UNSETSTATE(x)        (rl_readline_state &= ~(x))
 929 #define RL_ISSTATE(x)           (rl_readline_state & (x))
 930
 931 struct readline_state {
 932   /* line state */
 933   int point;
 934   int end;
 935   int mark;
 936   int buflen;
 937   char *buffer;
 938   UNDO_LIST *ul;
 939   char *prompt;
 940
 941   /* global state */
 942   int rlstate;
 943   int done;
 944   Keymap kmap;
 945
 946   /* input state */
 947   rl_command_func_t *lastfunc;
 948   int insmode;
 949   int edmode;
 950   char *kseq;
 951   int kseqlen;
 952
 953   int pendingin;
 954   FILE *inf;
 955   FILE *outf;
 956   char *macro;
 957
 958   /* signal state */
 959   int catchsigs;
 960   int catchsigwinch;
 961
 962   /* search state */
 963
 964   /* completion state */
 965   rl_compentry_func_t *entryfunc;
 966   rl_compentry_func_t *menuentryfunc;
 967   rl_compignore_func_t *ignorefunc;
 968   rl_completion_func_t *attemptfunc;
 969   const char *wordbreakchars;
 970
 971   /* options state */
 972
 973   /* hook state */
 974
 975   /* reserved for future expansion, so the struct size doesn't change */
 976   char reserved[64];
 977 };
 978
 979 extern int rl_save_state (struct readline_state *);
 980 extern int rl_restore_state (struct readline_state *);
 981
 982 #ifdef __cplusplus
 983 }
 984 #endif
 985
 986 #endif /* _READLINE_H_ */