lib/readline/readline.h

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