| 1 | /* Readline.h -- the names of functions callable from within readline. */ |
| 2 | |
| 3 | /* Copyright (C) 1987, 1989, 1992 Free Software Foundation, Inc. |
| 4 | |
| 5 | This file is part of the GNU Readline Library, a library for |
| 6 | reading lines of text with interactive input and history editing. |
| 7 | |
| 8 | The GNU Readline Library is free software; you can redistribute it |
| 9 | and/or modify it under the terms of the GNU General Public License |
| 10 | as published by the Free Software Foundation; either version 1, or |
| 11 | (at your option) any later version. |
| 12 | |
| 13 | The GNU Readline Library is distributed in the hope that it will be |
| 14 | useful, but WITHOUT ANY WARRANTY; without even the implied warranty |
| 15 | of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 16 | GNU General Public License for more details. |
| 17 | |
| 18 | The GNU General Public License is often shipped with GNU software, and |
| 19 | is generally kept in a file called COPYING or LICENSE. If you do not |
| 20 | have a copy of the license, write to the Free Software Foundation, |
| 21 | 675 Mass Ave, Cambridge, MA 02139, USA. */ |
| 22 | |
| 23 | #if !defined (_READLINE_H_) |
| 24 | #define _READLINE_H_ |
| 25 | |
| 26 | #ifdef __cplusplus |
| 27 | extern "C" { |
| 28 | #endif |
| 29 | |
| 30 | #if defined (READLINE_LIBRARY) |
| 31 | # include "rlstdc.h" |
| 32 | # include "keymaps.h" |
| 33 | # include "tilde.h" |
| 34 | #else |
| 35 | # include <readline/rlstdc.h> |
| 36 | # include <readline/keymaps.h> |
| 37 | # include <readline/tilde.h> |
| 38 | #endif |
| 39 | |
| 40 | /* Readline data structures. */ |
| 41 | |
| 42 | /* Maintaining the state of undo. We remember individual deletes and inserts |
| 43 | on a chain of things to do. */ |
| 44 | |
| 45 | /* The actions that undo knows how to undo. Notice that UNDO_DELETE means |
| 46 | to insert some text, and UNDO_INSERT means to delete some text. I.e., |
| 47 | the code tells undo what to undo, not how to undo it. */ |
| 48 | enum undo_code { UNDO_DELETE, UNDO_INSERT, UNDO_BEGIN, UNDO_END }; |
| 49 | |
| 50 | /* What an element of THE_UNDO_LIST looks like. */ |
| 51 | typedef struct undo_list { |
| 52 | struct undo_list *next; |
| 53 | int start, end; /* Where the change took place. */ |
| 54 | char *text; /* The text to insert, if undoing a delete. */ |
| 55 | enum undo_code what; /* Delete, Insert, Begin, End. */ |
| 56 | } UNDO_LIST; |
| 57 | |
| 58 | /* The current undo list for RL_LINE_BUFFER. */ |
| 59 | extern UNDO_LIST *rl_undo_list; |
| 60 | |
| 61 | /* The data structure for mapping textual names to code addresses. */ |
| 62 | typedef struct _funmap { |
| 63 | char *name; |
| 64 | Function *function; |
| 65 | } FUNMAP; |
| 66 | |
| 67 | extern FUNMAP **funmap; |
| 68 | |
| 69 | /* **************************************************************** */ |
| 70 | /* */ |
| 71 | /* Functions available to bind to key sequences */ |
| 72 | /* */ |
| 73 | /* **************************************************************** */ |
| 74 | |
| 75 | /* Bindable commands for numeric arguments. */ |
| 76 | extern int rl_digit_argument __P((int, int)); |
| 77 | extern int rl_universal_argument __P((int, int)); |
| 78 | |
| 79 | /* Bindable commands for moving the cursor. */ |
| 80 | extern int rl_forward __P((int, int)); |
| 81 | extern int rl_backward __P((int, int)); |
| 82 | extern int rl_beg_of_line __P((int, int)); |
| 83 | extern int rl_end_of_line __P((int, int)); |
| 84 | extern int rl_forward_word __P((int, int)); |
| 85 | extern int rl_backward_word __P((int, int)); |
| 86 | extern int rl_refresh_line __P((int, int)); |
| 87 | extern int rl_clear_screen __P((int, int)); |
| 88 | extern int rl_arrow_keys __P((int, int)); |
| 89 | |
| 90 | /* Bindable commands for inserting and deleting text. */ |
| 91 | extern int rl_insert __P((int, int)); |
| 92 | extern int rl_quoted_insert __P((int, int)); |
| 93 | extern int rl_tab_insert __P((int, int)); |
| 94 | extern int rl_newline __P((int, int)); |
| 95 | extern int rl_do_lowercase_version __P((int, int)); |
| 96 | extern int rl_rubout __P((int, int)); |
| 97 | extern int rl_delete __P((int, int)); |
| 98 | extern int rl_rubout_or_delete __P((int, int)); |
| 99 | extern int rl_delete_horizontal_space __P((int, int)); |
| 100 | extern int rl_delete_or_show_completions __P((int, int)); |
| 101 | extern int rl_insert_comment __P((int, int)); |
| 102 | |
| 103 | /* Bindable commands for changing case. */ |
| 104 | extern int rl_upcase_word __P((int, int)); |
| 105 | extern int rl_downcase_word __P((int, int)); |
| 106 | extern int rl_capitalize_word __P((int, int)); |
| 107 | |
| 108 | /* Bindable commands for transposing characters and words. */ |
| 109 | extern int rl_transpose_words __P((int, int)); |
| 110 | extern int rl_transpose_chars __P((int, int)); |
| 111 | |
| 112 | /* Bindable commands for searching within a line. */ |
| 113 | extern int rl_char_search __P((int, int)); |
| 114 | extern int rl_backward_char_search __P((int, int)); |
| 115 | |
| 116 | /* Bindable commands for readline's interface to the command history. */ |
| 117 | extern int rl_beginning_of_history __P((int, int)); |
| 118 | extern int rl_end_of_history __P((int, int)); |
| 119 | extern int rl_get_next_history __P((int, int)); |
| 120 | extern int rl_get_previous_history __P((int, int)); |
| 121 | |
| 122 | /* Bindable commands for managing the mark and region. */ |
| 123 | extern int rl_set_mark __P((int, int)); |
| 124 | extern int rl_exchange_point_and_mark __P((int, int)); |
| 125 | |
| 126 | /* Bindable commands to set the editing mode (emacs or vi). */ |
| 127 | extern int rl_vi_editing_mode __P((int, int)); |
| 128 | extern int rl_emacs_editing_mode __P((int, int)); |
| 129 | |
| 130 | /* Bindable commands for managing key bindings. */ |
| 131 | extern int rl_re_read_init_file __P((int, int)); |
| 132 | extern int rl_dump_functions __P((int, int)); |
| 133 | extern int rl_dump_macros __P((int, int)); |
| 134 | extern int rl_dump_variables __P((int, int)); |
| 135 | |
| 136 | /* Bindable commands for word completion. */ |
| 137 | extern int rl_complete __P((int, int)); |
| 138 | extern int rl_possible_completions __P((int, int)); |
| 139 | extern int rl_insert_completions __P((int, int)); |
| 140 | extern int rl_menu_complete __P((int, int)); |
| 141 | |
| 142 | /* Bindable commands for killing and yanking text, and managing the kill ring. */ |
| 143 | extern int rl_kill_word __P((int, int)); |
| 144 | extern int rl_backward_kill_word __P((int, int)); |
| 145 | extern int rl_kill_line __P((int, int)); |
| 146 | extern int rl_backward_kill_line __P((int, int)); |
| 147 | extern int rl_kill_full_line __P((int, int)); |
| 148 | extern int rl_unix_word_rubout __P((int, int)); |
| 149 | extern int rl_unix_line_discard __P((int, int)); |
| 150 | extern int rl_copy_region_to_kill __P((int, int)); |
| 151 | extern int rl_kill_region __P((int, int)); |
| 152 | extern int rl_copy_forward_word __P((int, int)); |
| 153 | extern int rl_copy_backward_word __P((int, int)); |
| 154 | extern int rl_yank __P((int, int)); |
| 155 | extern int rl_yank_pop __P((int, int)); |
| 156 | extern int rl_yank_nth_arg __P((int, int)); |
| 157 | extern int rl_yank_last_arg __P((int, int)); |
| 158 | /* Not available unless __CYGWIN32__ is defined. */ |
| 159 | #ifdef __CYGWIN32__ |
| 160 | extern int rl_paste_from_clipboard __P((int, int)); |
| 161 | #endif |
| 162 | |
| 163 | /* Bindable commands for incremental searching. */ |
| 164 | extern int rl_reverse_search_history __P((int, int)); |
| 165 | extern int rl_forward_search_history __P((int, int)); |
| 166 | |
| 167 | /* Bindable keyboard macro commands. */ |
| 168 | extern int rl_start_kbd_macro __P((int, int)); |
| 169 | extern int rl_end_kbd_macro __P((int, int)); |
| 170 | extern int rl_call_last_kbd_macro __P((int, int)); |
| 171 | |
| 172 | /* Bindable undo commands. */ |
| 173 | extern int rl_revert_line __P((int, int)); |
| 174 | extern int rl_undo_command __P((int, int)); |
| 175 | |
| 176 | /* Bindable tilde expansion commands. */ |
| 177 | extern int rl_tilde_expand __P((int, int)); |
| 178 | |
| 179 | /* Bindable terminal control commands. */ |
| 180 | extern int rl_restart_output __P((int, int)); |
| 181 | extern int rl_stop_output __P((int, int)); |
| 182 | |
| 183 | /* Miscellaneous bindable commands. */ |
| 184 | extern int rl_abort __P((int, int)); |
| 185 | extern int rl_tty_status __P((int, int)); |
| 186 | |
| 187 | /* Bindable commands for incremental and non-incremental history searching. */ |
| 188 | extern int rl_history_search_forward __P((int, int)); |
| 189 | extern int rl_history_search_backward __P((int, int)); |
| 190 | extern int rl_noninc_forward_search __P((int, int)); |
| 191 | extern int rl_noninc_reverse_search __P((int, int)); |
| 192 | extern int rl_noninc_forward_search_again __P((int, int)); |
| 193 | extern int rl_noninc_reverse_search_again __P((int, int)); |
| 194 | |
| 195 | /* Not available unless readline is compiled -DPAREN_MATCHING. */ |
| 196 | extern int rl_insert_close __P((int, int)); |
| 197 | |
| 198 | /* Not available unless READLINE_CALLBACKS is defined. */ |
| 199 | extern void rl_callback_handler_install __P((char *, VFunction *)); |
| 200 | extern void rl_callback_read_char __P((void)); |
| 201 | extern void rl_callback_handler_remove __P((void)); |
| 202 | |
| 203 | /* Things for vi mode. Not available unless readline is compiled -DVI_MODE. */ |
| 204 | /* VI-mode bindable commands. */ |
| 205 | extern int rl_vi_redo __P((int, int)); |
| 206 | extern int rl_vi_undo __P((int, int)); |
| 207 | extern int rl_vi_yank_arg __P((int, int)); |
| 208 | extern int rl_vi_fetch_history __P((int, int)); |
| 209 | extern int rl_vi_search_again __P((int, int)); |
| 210 | extern int rl_vi_search __P((int, int)); |
| 211 | extern int rl_vi_complete __P((int, int)); |
| 212 | extern int rl_vi_tilde_expand __P((int, int)); |
| 213 | extern int rl_vi_prev_word __P((int, int)); |
| 214 | extern int rl_vi_next_word __P((int, int)); |
| 215 | extern int rl_vi_end_word __P((int, int)); |
| 216 | extern int rl_vi_insert_beg __P((int, int)); |
| 217 | extern int rl_vi_append_mode __P((int, int)); |
| 218 | extern int rl_vi_append_eol __P((int, int)); |
| 219 | extern int rl_vi_eof_maybe __P((int, int)); |
| 220 | extern int rl_vi_insertion_mode __P((int, int)); |
| 221 | extern int rl_vi_movement_mode __P((int, int)); |
| 222 | extern int rl_vi_arg_digit __P((int, int)); |
| 223 | extern int rl_vi_change_case __P((int, int)); |
| 224 | extern int rl_vi_put __P((int, int)); |
| 225 | extern int rl_vi_column __P((int, int)); |
| 226 | extern int rl_vi_delete_to __P((int, int)); |
| 227 | extern int rl_vi_change_to __P((int, int)); |
| 228 | extern int rl_vi_yank_to __P((int, int)); |
| 229 | extern int rl_vi_delete __P((int, int)); |
| 230 | extern int rl_vi_back_to_indent __P((int, int)); |
| 231 | extern int rl_vi_first_print __P((int, int)); |
| 232 | extern int rl_vi_char_search __P((int, int)); |
| 233 | extern int rl_vi_match __P((int, int)); |
| 234 | extern int rl_vi_change_char __P((int, int)); |
| 235 | extern int rl_vi_subst __P((int, int)); |
| 236 | extern int rl_vi_overstrike __P((int, int)); |
| 237 | extern int rl_vi_overstrike_delete __P((int, int)); |
| 238 | extern int rl_vi_replace __P((int, int)); |
| 239 | extern int rl_vi_set_mark __P((int, int)); |
| 240 | extern int rl_vi_goto_mark __P((int, int)); |
| 241 | |
| 242 | /* VI-mode utility functions. */ |
| 243 | extern int rl_vi_check __P((void)); |
| 244 | extern int rl_vi_domove __P((int, int *)); |
| 245 | extern int rl_vi_bracktype __P((int)); |
| 246 | |
| 247 | /* VI-mode pseudo-bindable commands, used as utility functions. */ |
| 248 | extern int rl_vi_fWord __P((int, int)); |
| 249 | extern int rl_vi_bWord __P((int, int)); |
| 250 | extern int rl_vi_eWord __P((int, int)); |
| 251 | extern int rl_vi_fword __P((int, int)); |
| 252 | extern int rl_vi_bword __P((int, int)); |
| 253 | extern int rl_vi_eword __P((int, int)); |
| 254 | |
| 255 | /* **************************************************************** */ |
| 256 | /* */ |
| 257 | /* Well Published Functions */ |
| 258 | /* */ |
| 259 | /* **************************************************************** */ |
| 260 | |
| 261 | /* Readline functions. */ |
| 262 | /* Read a line of input. Prompt with PROMPT. A NULL PROMPT means none. */ |
| 263 | extern char *readline __P((char *)); |
| 264 | |
| 265 | extern int rl_initialize __P((void)); |
| 266 | |
| 267 | extern int rl_discard_argument __P((void)); |
| 268 | |
| 269 | /* Utility functions to bind keys to readline commands. */ |
| 270 | extern int rl_add_defun __P((char *, Function *, int)); |
| 271 | extern int rl_bind_key __P((int, Function *)); |
| 272 | extern int rl_bind_key_in_map __P((int, Function *, Keymap)); |
| 273 | extern int rl_unbind_key __P((int)); |
| 274 | extern int rl_unbind_key_in_map __P((int, Keymap)); |
| 275 | extern int rl_unbind_function_in_map __P((Function *, Keymap)); |
| 276 | extern int rl_unbind_command_in_map __P((char *, Keymap)); |
| 277 | extern int rl_set_key __P((char *, Function *, Keymap)); |
| 278 | extern int rl_generic_bind __P((int, char *, char *, Keymap)); |
| 279 | extern int rl_variable_bind __P((char *, char *)); |
| 280 | |
| 281 | /* Backwards compatibility, use rl_generic_bind instead. */ |
| 282 | extern int rl_macro_bind __P((char *, char *, Keymap)); |
| 283 | |
| 284 | /* Undocumented in the texinfo manual; not really useful to programs. */ |
| 285 | extern int rl_translate_keyseq __P((char *, char *, int *)); |
| 286 | extern char *rl_untranslate_keyseq __P((int)); |
| 287 | |
| 288 | extern Function *rl_named_function __P((char *)); |
| 289 | extern Function *rl_function_of_keyseq __P((char *, Keymap, int *)); |
| 290 | |
| 291 | extern void rl_list_funmap_names __P((void)); |
| 292 | extern char **rl_invoking_keyseqs_in_map __P((Function *, Keymap)); |
| 293 | extern char **rl_invoking_keyseqs __P((Function *)); |
| 294 | |
| 295 | extern void rl_function_dumper __P((int)); |
| 296 | extern void rl_macro_dumper __P((int)); |
| 297 | extern void rl_variable_dumper __P((int)); |
| 298 | |
| 299 | extern int rl_read_init_file __P((char *)); |
| 300 | extern int rl_parse_and_bind __P((char *)); |
| 301 | |
| 302 | /* Functions for manipulating keymaps. */ |
| 303 | extern Keymap rl_make_bare_keymap __P((void)); |
| 304 | extern Keymap rl_copy_keymap __P((Keymap)); |
| 305 | extern Keymap rl_make_keymap __P((void)); |
| 306 | extern void rl_discard_keymap __P((Keymap)); |
| 307 | |
| 308 | extern Keymap rl_get_keymap_by_name __P((char *)); |
| 309 | extern char *rl_get_keymap_name __P((Keymap)); |
| 310 | extern void rl_set_keymap __P((Keymap)); |
| 311 | extern Keymap rl_get_keymap __P((void)); |
| 312 | extern void rl_set_keymap_from_edit_mode __P((void)); |
| 313 | extern char *rl_get_keymap_name_from_edit_mode __P((void)); |
| 314 | |
| 315 | /* Functions for manipulating the funmap, which maps command names to functions. */ |
| 316 | extern int rl_add_funmap_entry __P((char *, Function *)); |
| 317 | extern void rl_initialize_funmap __P((void)); |
| 318 | extern char **rl_funmap_names __P((void)); |
| 319 | |
| 320 | /* Utility functions for managing keyboard macros. */ |
| 321 | extern void rl_push_macro_input __P((char *)); |
| 322 | |
| 323 | /* Functions for undoing, from undo.c */ |
| 324 | extern void rl_add_undo __P((enum undo_code, int, int, char *)); |
| 325 | extern void free_undo_list __P((void)); |
| 326 | extern int rl_do_undo __P((void)); |
| 327 | extern int rl_begin_undo_group __P((void)); |
| 328 | extern int rl_end_undo_group __P((void)); |
| 329 | extern int rl_modifying __P((int, int)); |
| 330 | |
| 331 | /* Functions for redisplay. */ |
| 332 | extern void rl_redisplay __P((void)); |
| 333 | extern int rl_on_new_line __P((void)); |
| 334 | extern int rl_forced_update_display __P((void)); |
| 335 | extern int rl_clear_message __P((void)); |
| 336 | extern int rl_reset_line_state __P((void)); |
| 337 | |
| 338 | #if defined (__STDC__) && defined (USE_VARARGS) && defined (PREFER_STDARG) |
| 339 | extern int rl_message (const char *, ...); |
| 340 | #else |
| 341 | extern int rl_message (); |
| 342 | #endif |
| 343 | |
| 344 | /* Undocumented in texinfo manual. */ |
| 345 | extern int rl_show_char __P((int)); |
| 346 | extern int rl_character_len __P((int, int)); |
| 347 | extern int crlf __P((void)); |
| 348 | |
| 349 | /* Save and restore internal prompt redisplay information. */ |
| 350 | extern void rl_save_prompt __P((void)); |
| 351 | extern void rl_restore_prompt __P((void)); |
| 352 | |
| 353 | /* Modifying text. */ |
| 354 | extern int rl_insert_text __P((char *)); |
| 355 | extern int rl_delete_text __P((int, int)); |
| 356 | extern int rl_kill_text __P((int, int)); |
| 357 | extern char *rl_copy_text __P((int, int)); |
| 358 | |
| 359 | /* Terminal and tty mode management. */ |
| 360 | extern void rl_prep_terminal __P((int)); |
| 361 | extern void rl_deprep_terminal __P((void)); |
| 362 | extern void rltty_set_default_bindings __P((Keymap)); |
| 363 | |
| 364 | extern int rl_reset_terminal __P((char *)); |
| 365 | extern void rl_resize_terminal __P((void)); |
| 366 | |
| 367 | /* `Public' utility functions . */ |
| 368 | extern void rl_extend_line_buffer __P((int)); |
| 369 | extern int ding __P((void)); |
| 370 | |
| 371 | /* Functions for character input. */ |
| 372 | extern int rl_stuff_char __P((int)); |
| 373 | extern int rl_execute_next __P((int)); |
| 374 | extern int rl_read_key __P((void)); |
| 375 | extern int rl_getc __P((FILE *)); |
| 376 | |
| 377 | /* Readline signal handling, from signals.c */ |
| 378 | extern int rl_set_signals __P((void)); |
| 379 | extern int rl_clear_signals __P((void)); |
| 380 | extern void rl_cleanup_after_signal __P((void)); |
| 381 | extern void rl_reset_after_signal __P((void)); |
| 382 | extern void rl_free_line_state __P((void)); |
| 383 | |
| 384 | /* Undocumented. */ |
| 385 | extern int rl_expand_prompt __P((char *)); |
| 386 | |
| 387 | extern int maybe_save_line __P((void)); |
| 388 | extern int maybe_unsave_line __P((void)); |
| 389 | extern int maybe_replace_line __P((void)); |
| 390 | |
| 391 | /* Completion functions. */ |
| 392 | extern int rl_complete_internal __P((int)); |
| 393 | extern void rl_display_match_list __P((char **, int, int)); |
| 394 | |
| 395 | extern char **completion_matches __P((char *, CPFunction *)); |
| 396 | extern char *username_completion_function __P((char *, int)); |
| 397 | extern char *filename_completion_function __P((char *, int)); |
| 398 | |
| 399 | /* **************************************************************** */ |
| 400 | /* */ |
| 401 | /* Well Published Variables */ |
| 402 | /* */ |
| 403 | /* **************************************************************** */ |
| 404 | |
| 405 | /* The version of this incarnation of the readline library. */ |
| 406 | extern char *rl_library_version; |
| 407 | |
| 408 | /* The name of the calling program. You should initialize this to |
| 409 | whatever was in argv[0]. It is used when parsing conditionals. */ |
| 410 | extern char *rl_readline_name; |
| 411 | |
| 412 | /* The prompt readline uses. This is set from the argument to |
| 413 | readline (), and should not be assigned to directly. */ |
| 414 | extern char *rl_prompt; |
| 415 | |
| 416 | /* The line buffer that is in use. */ |
| 417 | extern char *rl_line_buffer; |
| 418 | |
| 419 | /* The location of point, and end. */ |
| 420 | extern int rl_point, rl_end; |
| 421 | |
| 422 | /* The mark, or saved cursor position. */ |
| 423 | extern int rl_mark; |
| 424 | |
| 425 | /* Flag to indicate that readline has finished with the current input |
| 426 | line and should return it. */ |
| 427 | extern int rl_done; |
| 428 | |
| 429 | /* If set to a character value, that will be the next keystroke read. */ |
| 430 | extern int rl_pending_input; |
| 431 | |
| 432 | /* Non-zero if we called this function from _rl_dispatch(). It's present |
| 433 | so functions can find out whether they were called from a key binding |
| 434 | or directly from an application. */ |
| 435 | extern int rl_dispatching; |
| 436 | |
| 437 | /* The name of the terminal to use. */ |
| 438 | extern char *rl_terminal_name; |
| 439 | |
| 440 | /* The input and output streams. */ |
| 441 | extern FILE *rl_instream, *rl_outstream; |
| 442 | |
| 443 | /* If non-zero, then this is the address of a function to call just |
| 444 | before readline_internal () prints the first prompt. */ |
| 445 | extern Function *rl_startup_hook; |
| 446 | |
| 447 | /* If non-zero, this is the address of a function to call just before |
| 448 | readline_internal_setup () returns and readline_internal starts |
| 449 | reading input characters. */ |
| 450 | extern Function *rl_pre_input_hook; |
| 451 | |
| 452 | /* The address of a function to call periodically while Readline is |
| 453 | awaiting character input, or NULL, for no event handling. */ |
| 454 | extern Function *rl_event_hook; |
| 455 | |
| 456 | extern Function *rl_getc_function; |
| 457 | extern VFunction *rl_redisplay_function; |
| 458 | extern VFunction *rl_prep_term_function; |
| 459 | extern VFunction *rl_deprep_term_function; |
| 460 | |
| 461 | /* Dispatch variables. */ |
| 462 | extern Keymap rl_executing_keymap; |
| 463 | extern Keymap rl_binding_keymap; |
| 464 | |
| 465 | /* Display variables. */ |
| 466 | /* If non-zero, readline will erase the entire line, including any prompt, |
| 467 | if the only thing typed on an otherwise-blank line is something bound to |
| 468 | rl_newline. */ |
| 469 | extern int rl_erase_empty_line; |
| 470 | |
| 471 | /* Variables to control readline signal handling. */ |
| 472 | /* If non-zero, readline will install its own signal handlers for |
| 473 | SIGINT, SIGTERM, SIGQUIT, SIGALRM, SIGTSTP, SIGTTIN, and SIGTTOU. */ |
| 474 | extern int rl_catch_signals; |
| 475 | |
| 476 | /* If non-zero, readline will install a signal handler for SIGWINCH |
| 477 | that also attempts to call any calling application's SIGWINCH signal |
| 478 | handler. Note that the terminal is not cleaned up before the |
| 479 | application's signal handler is called; use rl_cleanup_after_signal() |
| 480 | to do that. */ |
| 481 | extern int rl_catch_sigwinch; |
| 482 | |
| 483 | /* Completion variables. */ |
| 484 | /* Pointer to the generator function for completion_matches (). |
| 485 | NULL means to use filename_entry_function (), the default filename |
| 486 | completer. */ |
| 487 | extern Function *rl_completion_entry_function; |
| 488 | |
| 489 | /* If rl_ignore_some_completions_function is non-NULL it is the address |
| 490 | of a function to call after all of the possible matches have been |
| 491 | generated, but before the actual completion is done to the input line. |
| 492 | The function is called with one argument; a NULL terminated array |
| 493 | of (char *). If your function removes any of the elements, they |
| 494 | must be free()'ed. */ |
| 495 | extern Function *rl_ignore_some_completions_function; |
| 496 | |
| 497 | /* Pointer to alternative function to create matches. |
| 498 | Function is called with TEXT, START, and END. |
| 499 | START and END are indices in RL_LINE_BUFFER saying what the boundaries |
| 500 | of TEXT are. |
| 501 | If this function exists and returns NULL then call the value of |
| 502 | rl_completion_entry_function to try to match, otherwise use the |
| 503 | array of strings returned. */ |
| 504 | extern CPPFunction *rl_attempted_completion_function; |
| 505 | |
| 506 | /* The basic list of characters that signal a break between words for the |
| 507 | completer routine. The initial contents of this variable is what |
| 508 | breaks words in the shell, i.e. "n\"\\'`@$>". */ |
| 509 | extern char *rl_basic_word_break_characters; |
| 510 | |
| 511 | /* The list of characters that signal a break between words for |
| 512 | rl_complete_internal. The default list is the contents of |
| 513 | rl_basic_word_break_characters. */ |
| 514 | extern char *rl_completer_word_break_characters; |
| 515 | |
| 516 | /* List of characters which can be used to quote a substring of the line. |
| 517 | Completion occurs on the entire substring, and within the substring |
| 518 | rl_completer_word_break_characters are treated as any other character, |
| 519 | unless they also appear within this list. */ |
| 520 | extern char *rl_completer_quote_characters; |
| 521 | |
| 522 | /* List of quote characters which cause a word break. */ |
| 523 | extern char *rl_basic_quote_characters; |
| 524 | |
| 525 | /* List of characters that need to be quoted in filenames by the completer. */ |
| 526 | extern char *rl_filename_quote_characters; |
| 527 | |
| 528 | /* List of characters that are word break characters, but should be left |
| 529 | in TEXT when it is passed to the completion function. The shell uses |
| 530 | this to help determine what kind of completing to do. */ |
| 531 | extern char *rl_special_prefixes; |
| 532 | |
| 533 | /* If non-zero, then this is the address of a function to call when |
| 534 | completing on a directory name. The function is called with |
| 535 | the address of a string (the current directory name) as an arg. */ |
| 536 | extern Function *rl_directory_completion_hook; |
| 537 | |
| 538 | /* Backwards compatibility with previous versions of readline. */ |
| 539 | #define rl_symbolic_link_hook rl_directory_completion_hook |
| 540 | |
| 541 | /* If non-zero, then this is the address of a function to call when |
| 542 | completing a word would normally display the list of possible matches. |
| 543 | This function is called instead of actually doing the display. |
| 544 | It takes three arguments: (char **matches, int num_matches, int max_length) |
| 545 | where MATCHES is the array of strings that matched, NUM_MATCHES is the |
| 546 | number of strings in that array, and MAX_LENGTH is the length of the |
| 547 | longest string in that array. */ |
| 548 | extern VFunction *rl_completion_display_matches_hook; |
| 549 | |
| 550 | /* Non-zero means that the results of the matches are to be treated |
| 551 | as filenames. This is ALWAYS zero on entry, and can only be changed |
| 552 | within a completion entry finder function. */ |
| 553 | extern int rl_filename_completion_desired; |
| 554 | |
| 555 | /* Non-zero means that the results of the matches are to be quoted using |
| 556 | double quotes (or an application-specific quoting mechanism) if the |
| 557 | filename contains any characters in rl_word_break_chars. This is |
| 558 | ALWAYS non-zero on entry, and can only be changed within a completion |
| 559 | entry finder function. */ |
| 560 | extern int rl_filename_quoting_desired; |
| 561 | |
| 562 | /* Set to a function to quote a filename in an application-specific fashion. |
| 563 | Called with the text to quote, the type of match found (single or multiple) |
| 564 | and a pointer to the quoting character to be used, which the function can |
| 565 | reset if desired. */ |
| 566 | extern CPFunction *rl_filename_quoting_function; |
| 567 | |
| 568 | /* Function to call to remove quoting characters from a filename. Called |
| 569 | before completion is attempted, so the embedded quotes do not interfere |
| 570 | with matching names in the file system. */ |
| 571 | extern CPFunction *rl_filename_dequoting_function; |
| 572 | |
| 573 | /* Function to call to decide whether or not a word break character is |
| 574 | quoted. If a character is quoted, it does not break words for the |
| 575 | completer. */ |
| 576 | extern Function *rl_char_is_quoted_p; |
| 577 | |
| 578 | /* Non-zero means to suppress normal filename completion after the |
| 579 | user-specified completion function has been called. */ |
| 580 | extern int rl_attempted_completion_over; |
| 581 | |
| 582 | /* Set to a character describing the type of completion being attempted by |
| 583 | rl_complete_internal; available for use by application completion |
| 584 | functions. */ |
| 585 | extern int rl_completion_type; |
| 586 | |
| 587 | /* Character appended to completed words when at the end of the line. The |
| 588 | default is a space. Nothing is added if this is '\0'. */ |
| 589 | extern int rl_completion_append_character; |
| 590 | |
| 591 | /* Up to this many items will be displayed in response to a |
| 592 | possible-completions call. After that, we ask the user if she |
| 593 | is sure she wants to see them all. The default value is 100. */ |
| 594 | extern int rl_completion_query_items; |
| 595 | |
| 596 | /* If non-zero, then disallow duplicates in the matches. */ |
| 597 | extern int rl_ignore_completion_duplicates; |
| 598 | |
| 599 | /* If this is non-zero, completion is (temporarily) inhibited, and the |
| 600 | completion character will be inserted as any other. */ |
| 601 | extern int rl_inhibit_completion; |
| 602 | |
| 603 | /* Definitions available for use by readline clients. */ |
| 604 | #define RL_PROMPT_START_IGNORE '\001' |
| 605 | #define RL_PROMPT_END_IGNORE '\002' |
| 606 | |
| 607 | /* Possible values for do_replace argument to rl_filename_quoting_function, |
| 608 | called by rl_complete_internal. */ |
| 609 | #define NO_MATCH 0 |
| 610 | #define SINGLE_MATCH 1 |
| 611 | #define MULT_MATCH 2 |
| 612 | |
| 613 | #if !defined (savestring) |
| 614 | extern char *savestring (); /* XXX backwards compatibility */ |
| 615 | #endif |
| 616 | |
| 617 | #ifdef __cplusplus |
| 618 | } |
| 619 | #endif |
| 620 | |
| 621 | #endif /* _READLINE_H_ */ |