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