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