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