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