readline/readline.h

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