lib/readline/readline.h

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