readline/readline/rlprivate.h

   1 /* rlprivate.h -- functions and variables global to the readline library,
   2                   but not intended for use by applications. */
   3
   4 /* Copyright (C) 1999-2015 Free Software Foundation, Inc.
   5
   6    This file is part of the GNU Readline Library (Readline), a library
   7    for reading lines of text with interactive input and history editing.
   8
   9    Readline is free software: you can redistribute it and/or modify
  10    it under the terms of the GNU General Public License as published by
  11    the Free Software Foundation, either version 3 of the License, or
  12    (at your option) any later version.
  13
  14    Readline is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with Readline.  If not, see <http://www.gnu.org/licenses/>.
  21 */
  22
  23 #if !defined (_RL_PRIVATE_H_)
  24 #define _RL_PRIVATE_H_
  25
  26 #include "rlconf.h"     /* for VISIBLE_STATS */
  27 #include "rlstdc.h"
  28 #include "posixjmp.h"   /* defines procenv_t */
  29 #include "rlmbutil.h"   /* for HANDLE_MULTIBYTE */
  30
  31 /*************************************************************************
  32  *                                                                       *
  33  * Convenience definitions                                               *
  34  *                                                                       *
  35  *************************************************************************/
  36
  37 #define EMACS_MODE()            (rl_editing_mode == emacs_mode)
  38 #define VI_COMMAND_MODE()       (rl_editing_mode == vi_mode && _rl_keymap == vi_movement_keymap)
  39 #define VI_INSERT_MODE()        (rl_editing_mode == vi_mode && _rl_keymap == vi_insertion_keymap)
  40
  41 #define RL_CHECK_SIGNALS() \
  42         do { \
  43           if (_rl_caught_signal) _rl_signal_handler (_rl_caught_signal); \
  44         } while (0)
  45
  46 #define RL_SIG_RECEIVED() (_rl_caught_signal != 0)
  47 #define RL_SIGINT_RECEIVED() (_rl_caught_signal == SIGINT)
  48 #define RL_SIGWINCH_RECEIVED() (_rl_caught_signal == SIGWINCH)
  49
  50 #define CUSTOM_REDISPLAY_FUNC() (rl_redisplay_function != rl_redisplay)
  51 #define CUSTOM_INPUT_FUNC() (rl_getc_function != rl_getc)
  52
  53 /*************************************************************************
  54  *                                                                       *
  55  * Global structs undocumented in texinfo manual and not in readline.h   *
  56  *                                                                       *
  57  *************************************************************************/
  58 /* search types */
  59 #define RL_SEARCH_ISEARCH       0x01            /* incremental search */
  60 #define RL_SEARCH_NSEARCH       0x02            /* non-incremental search */
  61 #define RL_SEARCH_CSEARCH       0x04            /* intra-line char search */
  62
  63 /* search flags */
  64 #define SF_REVERSE              0x01
  65 #define SF_FOUND                0x02
  66 #define SF_FAILED               0x04
  67 #define SF_CHGKMAP              0x08
  68 #define SF_PATTERN              0x10            /* unused so far */
  69
  70 typedef struct  __rl_search_context
  71 {
  72   int type;
  73   int sflags;
  74
  75   char *search_string;
  76   int search_string_index;
  77   int search_string_size;
  78
  79   char **lines;
  80   char *allocated_line;
  81   int hlen;
  82   int hindex;
  83
  84   int save_point;
  85   int save_mark;
  86   int save_line;
  87   int last_found_line;
  88   char *prev_line_found;
  89
  90   UNDO_LIST *save_undo_list;
  91
  92   Keymap keymap;        /* used when dispatching commands in search string */
  93   Keymap okeymap;       /* original keymap */
  94
  95   int history_pos;
  96   int direction;
  97
  98   int prevc;
  99   int lastc;
 100 #if defined (HANDLE_MULTIBYTE)
 101   char mb[MB_LEN_MAX];
 102   char pmb[MB_LEN_MAX];
 103 #endif
 104
 105   char *sline;
 106   int sline_len;
 107   int sline_index;
 108
 109   char  *search_terminators;
 110 } _rl_search_cxt;
 111
 112 /* Callback data for reading numeric arguments */
 113 #define NUM_SAWMINUS    0x01
 114 #define NUM_SAWDIGITS   0x02
 115 #define NUM_READONE     0x04
 116
 117 typedef int _rl_arg_cxt;
 118
 119 /* A context for reading key sequences longer than a single character when
 120    using the callback interface. */
 121 #define KSEQ_DISPATCHED 0x01
 122 #define KSEQ_SUBSEQ     0x02
 123 #define KSEQ_RECURSIVE  0x04
 124
 125 typedef struct __rl_keyseq_context
 126 {
 127   int flags;
 128   int subseq_arg;
 129   int subseq_retval;            /* XXX */
 130   int okey;
 131
 132   Keymap dmap;
 133   Keymap oldmap;
 134
 135   struct __rl_keyseq_context *ocxt;
 136   int childval;
 137 } _rl_keyseq_cxt;
 138
 139 /* vi-mode commands that use result of motion command to define boundaries */
 140 #define VIM_DELETE      0x01
 141 #define VIM_CHANGE      0x02
 142 #define VIM_YANK        0x04
 143
 144 /* various states for vi-mode commands that use motion commands.  reflects
 145    RL_READLINE_STATE */
 146 #define VMSTATE_READ    0x01
 147 #define VMSTATE_NUMARG  0x02
 148
 149 typedef struct __rl_vimotion_context
 150 {
 151   int op;
 152   int state;
 153   int flags;            /* reserved */
 154   _rl_arg_cxt ncxt;
 155   int numeric_arg;
 156   int start, end;       /* rl_point, rl_end */
 157   int key, motion;      /* initial key, motion command */
 158 } _rl_vimotion_cxt;
 159
 160 /* fill in more as needed */
 161 /* `Generic' callback data and functions */
 162 typedef struct __rl_callback_generic_arg
 163 {
 164   int count;
 165   int i1, i2;
 166   /* add here as needed */
 167 } _rl_callback_generic_arg;
 168
 169 typedef int _rl_callback_func_t PARAMS((_rl_callback_generic_arg *));
 170
 171 typedef void _rl_sigcleanup_func_t PARAMS((int, void *));
 172
 173 /*************************************************************************
 174  *                                                                       *
 175  * Global functions undocumented in texinfo manual and not in readline.h *
 176  *                                                                       *
 177  *************************************************************************/
 178
 179 /*************************************************************************
 180  *                                                                       *
 181  * Global variables undocumented in texinfo manual and not in readline.h *
 182  *                                                                       *
 183  *************************************************************************/
 184
 185 /* complete.c */
 186 extern int rl_complete_with_tilde_expansion;
 187 #if defined (VISIBLE_STATS)
 188 extern int rl_visible_stats;
 189 #endif /* VISIBLE_STATS */
 190 #if defined (COLOR_SUPPORT)
 191 extern int _rl_colored_stats;
 192 extern int _rl_colored_completion_prefix;
 193 #endif
 194
 195 /* readline.c */
 196 extern int rl_line_buffer_len;
 197 extern int rl_arg_sign;
 198 extern int rl_visible_prompt_length;
 199 extern int rl_byte_oriented;
 200
 201 /* display.c */
 202 extern int rl_display_fixed;
 203
 204 /* parens.c */
 205 extern int rl_blink_matching_paren;
 206
 207 /*************************************************************************
 208  *                                                                       *
 209  * Global functions and variables unused and undocumented                *
 210  *                                                                       *
 211  *************************************************************************/
 212
 213 /* kill.c */
 214 extern int rl_set_retained_kills PARAMS((int));
 215
 216 /* terminal.c */
 217 extern void _rl_set_screen_size PARAMS((int, int));
 218
 219 /* undo.c */
 220 extern int _rl_fix_last_undo_of_type PARAMS((int, int, int));
 221
 222 /* util.c */
 223 extern char *_rl_savestring PARAMS((const char *));
 224
 225 /*************************************************************************
 226  *                                                                       *
 227  * Functions and variables private to the readline library               *
 228  *                                                                       *
 229  *************************************************************************/
 230
 231 /* NOTE: Functions and variables prefixed with `_rl_' are
 232    pseudo-global: they are global so they can be shared
 233    between files in the readline library, but are not intended
 234    to be visible to readline callers. */
 235
 236 /*************************************************************************
 237  * Undocumented private functions                                        *
 238  *************************************************************************/
 239
 240 #if defined(READLINE_CALLBACKS)
 241
 242 /* readline.c */
 243 extern void readline_internal_setup PARAMS((void));
 244 extern char *readline_internal_teardown PARAMS((int));
 245 extern int readline_internal_char PARAMS((void));
 246
 247 extern _rl_keyseq_cxt *_rl_keyseq_cxt_alloc PARAMS((void));
 248 extern void _rl_keyseq_cxt_dispose PARAMS((_rl_keyseq_cxt *));
 249 extern void _rl_keyseq_chain_dispose PARAMS((void));
 250
 251 extern int _rl_dispatch_callback PARAMS((_rl_keyseq_cxt *));
 252
 253 /* callback.c */
 254 extern _rl_callback_generic_arg *_rl_callback_data_alloc PARAMS((int));
 255 extern void _rl_callback_data_dispose PARAMS((_rl_callback_generic_arg *));
 256
 257 #endif /* READLINE_CALLBACKS */
 258
 259 /* bind.c */
 260 extern char *_rl_untranslate_macro_value PARAMS((char *, int));
 261
 262 /* complete.c */
 263 extern void _rl_reset_completion_state PARAMS((void));
 264 extern char _rl_find_completion_word PARAMS((int *, int *));
 265 extern void _rl_free_match_list PARAMS((char **));
 266
 267 /* display.c */
 268 extern char *_rl_strip_prompt PARAMS((char *));
 269 extern void _rl_reset_prompt PARAMS((void));
 270 extern void _rl_move_cursor_relative PARAMS((int, const char *));
 271 extern void _rl_move_vert PARAMS((int));
 272 extern void _rl_save_prompt PARAMS((void));
 273 extern void _rl_restore_prompt PARAMS((void));
 274 extern char *_rl_make_prompt_for_search PARAMS((int));
 275 extern void _rl_erase_at_end_of_line PARAMS((int));
 276 extern void _rl_clear_to_eol PARAMS((int));
 277 extern void _rl_clear_screen PARAMS((void));
 278 extern void _rl_update_final PARAMS((void));
 279 extern void _rl_redisplay_after_sigwinch PARAMS((void));
 280 extern void _rl_clean_up_for_exit PARAMS((void));
 281 extern void _rl_erase_entire_line PARAMS((void));
 282 extern int _rl_current_display_line PARAMS((void));
 283
 284 /* input.c */
 285 extern int _rl_any_typein PARAMS((void));
 286 extern int _rl_input_available PARAMS((void));
 287 extern int _rl_input_queued PARAMS((int));
 288 extern void _rl_insert_typein PARAMS((int));
 289 extern int _rl_unget_char PARAMS((int));
 290 extern int _rl_pushed_input_available PARAMS((void));
 291
 292 /* isearch.c */
 293 extern _rl_search_cxt *_rl_scxt_alloc PARAMS((int, int));
 294 extern void _rl_scxt_dispose PARAMS((_rl_search_cxt *, int));
 295
 296 extern int _rl_isearch_dispatch PARAMS((_rl_search_cxt *, int));
 297 extern int _rl_isearch_callback PARAMS((_rl_search_cxt *));
 298 extern int _rl_isearch_cleanup PARAMS((_rl_search_cxt *, int));
 299
 300 extern int _rl_search_getchar PARAMS((_rl_search_cxt *));
 301
 302 /* kill.c */
 303 #define BRACK_PASTE_PREF        "\033[200~"
 304 #define BRACK_PASTE_SUFF        "\033[201~"
 305
 306 #define BRACK_PASTE_LAST        '~'
 307 #define BRACK_PASTE_SLEN        6
 308
 309 #define BRACK_PASTE_INIT        "\033[?2004h"
 310 #define BRACK_PASTE_FINI        "\033[?2004l\r"
 311
 312 extern char *_rl_bracketed_text PARAMS((size_t *));
 313
 314 /* macro.c */
 315 extern void _rl_with_macro_input PARAMS((char *));
 316 extern int _rl_peek_macro_key PARAMS((void));
 317 extern int _rl_next_macro_key PARAMS((void));
 318 extern int _rl_prev_macro_key PARAMS((void));
 319 extern void _rl_push_executing_macro PARAMS((void));
 320 extern void _rl_pop_executing_macro PARAMS((void));
 321 extern void _rl_add_macro_char PARAMS((int));
 322 extern void _rl_kill_kbd_macro PARAMS((void));
 323
 324 /* misc.c */
 325 extern int _rl_arg_overflow PARAMS((void));
 326 extern void _rl_arg_init PARAMS((void));
 327 extern int _rl_arg_getchar PARAMS((void));
 328 extern int _rl_arg_callback PARAMS((_rl_arg_cxt));
 329 extern void _rl_reset_argument PARAMS((void));
 330
 331 extern void _rl_start_using_history PARAMS((void));
 332 extern int _rl_free_saved_history_line PARAMS((void));
 333 extern void _rl_set_insert_mode PARAMS((int, int));
 334
 335 extern void _rl_revert_all_lines PARAMS((void));
 336
 337 /* nls.c */
 338 extern char *_rl_init_locale PARAMS((void));
 339 extern int _rl_init_eightbit PARAMS((void));
 340
 341 /* parens.c */
 342 extern void _rl_enable_paren_matching PARAMS((int));
 343
 344 /* readline.c */
 345 extern void _rl_init_line_state PARAMS((void));
 346 extern void _rl_set_the_line PARAMS((void));
 347 extern int _rl_dispatch PARAMS((int, Keymap));
 348 extern int _rl_dispatch_subseq PARAMS((int, Keymap, int));
 349 extern void _rl_internal_char_cleanup PARAMS((void));
 350
 351 /* rltty.c */
 352 extern int _rl_disable_tty_signals PARAMS((void));
 353 extern int _rl_restore_tty_signals PARAMS((void));
 354
 355 /* search.c */
 356 extern int _rl_nsearch_callback PARAMS((_rl_search_cxt *));
 357 extern int _rl_nsearch_cleanup PARAMS((_rl_search_cxt *, int));
 358
 359 /* signals.c */
 360 extern void _rl_signal_handler PARAMS((int));
 361
 362 extern void _rl_block_sigint PARAMS((void));
 363 extern void _rl_release_sigint PARAMS((void));
 364 extern void _rl_block_sigwinch PARAMS((void));
 365 extern void _rl_release_sigwinch PARAMS((void));
 366
 367 /* terminal.c */
 368 extern void _rl_get_screen_size PARAMS((int, int));
 369 extern void _rl_sigwinch_resize_terminal PARAMS((void));
 370 extern int _rl_init_terminal_io PARAMS((const char *));
 371 #ifdef _MINIX
 372 extern void _rl_output_character_function PARAMS((int));
 373 #else
 374 extern int _rl_output_character_function PARAMS((int));
 375 #endif
 376 extern void _rl_output_some_chars PARAMS((const char *, int));
 377 extern int _rl_backspace PARAMS((int));
 378 extern void _rl_enable_meta_key PARAMS((void));
 379 extern void _rl_disable_meta_key PARAMS((void));
 380 extern void _rl_control_keypad PARAMS((int));
 381 extern void _rl_set_cursor PARAMS((int, int));
 382
 383 /* text.c */
 384 extern void _rl_fix_point PARAMS((int));
 385 extern int _rl_replace_text PARAMS((const char *, int, int));
 386 extern int _rl_forward_char_internal PARAMS((int));
 387 extern int _rl_backward_char_internal PARAMS((int));
 388 extern int _rl_insert_char PARAMS((int, int));
 389 extern int _rl_overwrite_char PARAMS((int, int));
 390 extern int _rl_overwrite_rubout PARAMS((int, int));
 391 extern int _rl_rubout_char PARAMS((int, int));
 392 #if defined (HANDLE_MULTIBYTE)
 393 extern int _rl_char_search_internal PARAMS((int, int, char *, int));
 394 #else
 395 extern int _rl_char_search_internal PARAMS((int, int, int));
 396 #endif
 397 extern int _rl_set_mark_at_pos PARAMS((int));
 398
 399 /* undo.c */
 400 extern UNDO_LIST *_rl_copy_undo_entry PARAMS((UNDO_LIST *));
 401 extern UNDO_LIST *_rl_copy_undo_list PARAMS((UNDO_LIST *));
 402 extern void _rl_free_undo_list PARAMS((UNDO_LIST *));
 403
 404 /* util.c */
 405 #if defined (USE_VARARGS) && defined (PREFER_STDARG)
 406 extern void _rl_ttymsg (const char *, ...)  __attribute__((__format__ (printf, 1, 2)));
 407 extern void _rl_errmsg (const char *, ...)  __attribute__((__format__ (printf, 1, 2)));
 408 extern void _rl_trace (const char *, ...)  __attribute__((__format__ (printf, 1, 2)));
 409 #else
 410 extern void _rl_ttymsg ();
 411 extern void _rl_errmsg ();
 412 extern void _rl_trace ();
 413 #endif
 414 extern void _rl_audit_tty PARAMS((char *));
 415
 416 extern int _rl_tropen PARAMS((void));
 417
 418 extern int _rl_abort_internal PARAMS((void));
 419 extern int _rl_null_function PARAMS((int, int));
 420 extern char *_rl_strindex PARAMS((const char *, const char *));
 421 extern int _rl_qsort_string_compare PARAMS((char **, char **));
 422 extern int (_rl_uppercase_p) PARAMS((int));
 423 extern int (_rl_lowercase_p) PARAMS((int));
 424 extern int (_rl_pure_alphabetic) PARAMS((int));
 425 extern int (_rl_digit_p) PARAMS((int));
 426 extern int (_rl_to_lower) PARAMS((int));
 427 extern int (_rl_to_upper) PARAMS((int));
 428 extern int (_rl_digit_value) PARAMS((int));
 429
 430 /* vi_mode.c */
 431 extern void _rl_vi_initialize_line PARAMS((void));
 432 extern void _rl_vi_reset_last PARAMS((void));
 433 extern void _rl_vi_set_last PARAMS((int, int, int));
 434 extern int _rl_vi_textmod_command PARAMS((int));
 435 extern int _rl_vi_motion_command PARAMS((int));
 436 extern void _rl_vi_done_inserting PARAMS((void));
 437 extern int _rl_vi_domove_callback PARAMS((_rl_vimotion_cxt *));
 438 extern int _rl_vi_domove_motion_cleanup PARAMS((int, _rl_vimotion_cxt *));
 439
 440 /*************************************************************************
 441  * Undocumented private variables                                        *
 442  *************************************************************************/
 443
 444 /* bind.c */
 445 extern const char * const _rl_possible_control_prefixes[];
 446 extern const char * const _rl_possible_meta_prefixes[];
 447
 448 /* callback.c */
 449 extern _rl_callback_func_t *_rl_callback_func;
 450 extern _rl_callback_generic_arg *_rl_callback_data;
 451
 452 /* complete.c */
 453 extern int _rl_complete_show_all;
 454 extern int _rl_complete_show_unmodified;
 455 extern int _rl_complete_mark_directories;
 456 extern int _rl_complete_mark_symlink_dirs;
 457 extern int _rl_completion_prefix_display_length;
 458 extern int _rl_completion_columns;
 459 extern int _rl_print_completions_horizontally;
 460 extern int _rl_completion_case_fold;
 461 extern int _rl_completion_case_map;
 462 extern int _rl_match_hidden_files;
 463 extern int _rl_page_completions;
 464 extern int _rl_skip_completed_text;
 465 extern int _rl_menu_complete_prefix_first;
 466
 467 /* display.c */
 468 extern int _rl_vis_botlin;
 469 extern int _rl_last_c_pos;
 470 extern int _rl_suppress_redisplay;
 471 extern int _rl_want_redisplay;
 472
 473 extern char *_rl_emacs_mode_str;
 474 extern int _rl_emacs_modestr_len;
 475 extern char *_rl_vi_ins_mode_str;
 476 extern int _rl_vi_ins_modestr_len;
 477 extern char *_rl_vi_cmd_mode_str;
 478 extern int _rl_vi_cmd_modestr_len;
 479
 480 /* isearch.c */
 481 extern char *_rl_isearch_terminators;
 482
 483 extern _rl_search_cxt *_rl_iscxt;
 484
 485 /* macro.c */
 486 extern char *_rl_executing_macro;
 487
 488 /* misc.c */
 489 extern int _rl_history_preserve_point;
 490 extern int _rl_history_saved_point;
 491
 492 extern _rl_arg_cxt _rl_argcxt;
 493
 494 /* nls.c */
 495 extern int _rl_utf8locale;
 496
 497 /* readline.c */
 498 extern int _rl_echoing_p;
 499 extern int _rl_horizontal_scroll_mode;
 500 extern int _rl_mark_modified_lines;
 501 extern int _rl_bell_preference;
 502 extern int _rl_meta_flag;
 503 extern int _rl_convert_meta_chars_to_ascii;
 504 extern int _rl_output_meta_chars;
 505 extern int _rl_bind_stty_chars;
 506 extern int _rl_revert_all_at_newline;
 507 extern int _rl_echo_control_chars;
 508 extern int _rl_show_mode_in_prompt;
 509 extern int _rl_enable_bracketed_paste;
 510 extern char *_rl_comment_begin;
 511 extern unsigned char _rl_parsing_conditionalized_out;
 512 extern Keymap _rl_keymap;
 513 extern FILE *_rl_in_stream;
 514 extern FILE *_rl_out_stream;
 515 extern int _rl_last_command_was_kill;
 516 extern int _rl_eof_char;
 517 extern int _rl_eof_found;
 518 extern procenv_t _rl_top_level;
 519 extern _rl_keyseq_cxt *_rl_kscxt;
 520 extern int _rl_keyseq_timeout;
 521
 522 extern int _rl_executing_keyseq_size;
 523
 524 /* search.c */
 525 extern _rl_search_cxt *_rl_nscxt;
 526
 527 /* signals.c */
 528 extern int _rl_interrupt_immediately;
 529 extern int volatile _rl_caught_signal;
 530
 531 extern _rl_sigcleanup_func_t *_rl_sigcleanup;
 532 extern void *_rl_sigcleanarg;
 533
 534 extern int _rl_echoctl;
 535
 536 extern int _rl_intr_char;
 537 extern int _rl_quit_char;
 538 extern int _rl_susp_char;
 539
 540 /* terminal.c */
 541 extern int _rl_enable_keypad;
 542 extern int _rl_enable_meta;
 543 extern char *_rl_term_clreol;
 544 extern char *_rl_term_clrpag;
 545 extern char *_rl_term_clrscroll;
 546 extern char *_rl_term_im;
 547 extern char *_rl_term_ic;
 548 extern char *_rl_term_ei;
 549 extern char *_rl_term_DC;
 550 extern char *_rl_term_up;
 551 extern char *_rl_term_dc;
 552 extern char *_rl_term_cr;
 553 extern char *_rl_term_IC;
 554 extern char *_rl_term_forward_char;
 555 extern int _rl_screenheight;
 556 extern int _rl_screenwidth;
 557 extern int _rl_screenchars;
 558 extern int _rl_terminal_can_insert;
 559 extern int _rl_term_autowrap;
 560
 561 /* text.c */
 562 extern int _rl_optimize_typeahead;
 563
 564 /* undo.c */
 565 extern int _rl_doing_an_undo;
 566 extern int _rl_undo_group_level;
 567
 568 /* vi_mode.c */
 569 extern int _rl_vi_last_command;
 570 extern int _rl_vi_redoing;
 571 extern _rl_vimotion_cxt *_rl_vimvcxt;
 572
 573 #endif /* _RL_PRIVATE_H_ */