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