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