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