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