1 /* rlprivate.h -- functions and variables global to the readline library,
2 but not intended for use by applications. */
4 /* Copyright (C) 1999-2015 Free Software Foundation, Inc.
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.
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.
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.
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/>.
23 #if !defined (_RL_PRIVATE_H_)
24 #define _RL_PRIVATE_H_
26 #include "rlconf.h" /* for VISIBLE_STATS */
28 #include "posixjmp.h" /* defines procenv_t */
30 /*************************************************************************
32 * Convenience definitions *
34 *************************************************************************/
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)
40 #define RL_CHECK_SIGNALS() \
42 if (_rl_caught_signal) _rl_signal_handler (_rl_caught_signal); \
45 #define RL_SIG_RECEIVED() (_rl_caught_signal != 0)
46 #define RL_SIGINT_RECEIVED() (_rl_caught_signal == SIGINT)
47 #define RL_SIGWINCH_RECEIVED() (_rl_caught_signal == SIGWINCH)
49 #define CUSTOM_REDISPLAY_FUNC() (rl_redisplay_function != rl_redisplay)
50 #define CUSTOM_INPUT_FUNC() (rl_getc_function != rl_getc)
52 /*************************************************************************
54 * Global structs undocumented in texinfo manual and not in readline.h *
56 *************************************************************************/
58 #define RL_SEARCH_ISEARCH 0x01 /* incremental search */
59 #define RL_SEARCH_NSEARCH 0x02 /* non-incremental search */
60 #define RL_SEARCH_CSEARCH 0x04 /* intra-line char search */
63 #define SF_REVERSE 0x01
65 #define SF_FAILED 0x04
66 #define SF_CHGKMAP 0x08
68 typedef struct __rl_search_context
74 int search_string_index
;
75 int search_string_size
;
86 char *prev_line_found
;
88 UNDO_LIST
*save_undo_list
;
90 Keymap keymap
; /* used when dispatching commands in search string */
91 Keymap okeymap
; /* original keymap */
98 #if defined (HANDLE_MULTIBYTE)
100 char pmb
[MB_LEN_MAX
];
107 char *search_terminators
;
110 /* Callback data for reading numeric arguments */
111 #define NUM_SAWMINUS 0x01
112 #define NUM_SAWDIGITS 0x02
113 #define NUM_READONE 0x04
115 typedef int _rl_arg_cxt
;
117 /* A context for reading key sequences longer than a single character when
118 using the callback interface. */
119 #define KSEQ_DISPATCHED 0x01
120 #define KSEQ_SUBSEQ 0x02
121 #define KSEQ_RECURSIVE 0x04
123 typedef struct __rl_keyseq_context
127 int subseq_retval
; /* XXX */
133 struct __rl_keyseq_context
*ocxt
;
137 /* vi-mode commands that use result of motion command to define boundaries */
138 #define VIM_DELETE 0x01
139 #define VIM_CHANGE 0x02
140 #define VIM_YANK 0x04
142 /* various states for vi-mode commands that use motion commands. reflects
144 #define VMSTATE_READ 0x01
145 #define VMSTATE_NUMARG 0x02
147 typedef struct __rl_vimotion_context
151 int flags
; /* reserved */
154 int start
, end
; /* rl_point, rl_end */
155 int key
, motion
; /* initial key, motion command */
158 /* fill in more as needed */
159 /* `Generic' callback data and functions */
160 typedef struct __rl_callback_generic_arg
164 /* add here as needed */
165 } _rl_callback_generic_arg
;
167 typedef int _rl_callback_func_t
PARAMS((_rl_callback_generic_arg
*));
169 typedef void _rl_sigcleanup_func_t
PARAMS((int, void *));
171 /*************************************************************************
173 * Global functions undocumented in texinfo manual and not in readline.h *
175 *************************************************************************/
177 /*************************************************************************
179 * Global variables undocumented in texinfo manual and not in readline.h *
181 *************************************************************************/
184 extern int rl_complete_with_tilde_expansion
;
185 #if defined (VISIBLE_STATS)
186 extern int rl_visible_stats
;
187 #endif /* VISIBLE_STATS */
188 #if defined (COLOR_SUPPORT)
189 extern int _rl_colored_stats
;
190 extern int _rl_colored_completion_prefix
;
194 extern int rl_line_buffer_len
;
195 extern int rl_arg_sign
;
196 extern int rl_visible_prompt_length
;
197 extern int rl_byte_oriented
;
200 extern int rl_display_fixed
;
203 extern int rl_blink_matching_paren
;
205 /*************************************************************************
207 * Global functions and variables unused and undocumented *
209 *************************************************************************/
212 extern int rl_set_retained_kills
PARAMS((int));
215 extern void _rl_set_screen_size
PARAMS((int, int));
218 extern int _rl_fix_last_undo_of_type
PARAMS((int, int, int));
221 extern char *_rl_savestring
PARAMS((const char *));
223 /*************************************************************************
225 * Functions and variables private to the readline library *
227 *************************************************************************/
229 /* NOTE: Functions and variables prefixed with `_rl_' are
230 pseudo-global: they are global so they can be shared
231 between files in the readline library, but are not intended
232 to be visible to readline callers. */
234 /*************************************************************************
235 * Undocumented private functions *
236 *************************************************************************/
238 #if defined(READLINE_CALLBACKS)
241 extern void readline_internal_setup
PARAMS((void));
242 extern char *readline_internal_teardown
PARAMS((int));
243 extern int readline_internal_char
PARAMS((void));
245 extern _rl_keyseq_cxt
*_rl_keyseq_cxt_alloc
PARAMS((void));
246 extern void _rl_keyseq_cxt_dispose
PARAMS((_rl_keyseq_cxt
*));
247 extern void _rl_keyseq_chain_dispose
PARAMS((void));
249 extern int _rl_dispatch_callback
PARAMS((_rl_keyseq_cxt
*));
252 extern _rl_callback_generic_arg
*_rl_callback_data_alloc
PARAMS((int));
253 extern void _rl_callback_data_dispose
PARAMS((_rl_callback_generic_arg
*));
255 #endif /* READLINE_CALLBACKS */
258 extern char *_rl_untranslate_macro_value
PARAMS((char *, int));
261 extern void _rl_reset_completion_state
PARAMS((void));
262 extern char _rl_find_completion_word
PARAMS((int *, int *));
263 extern void _rl_free_match_list
PARAMS((char **));
266 extern char *_rl_strip_prompt
PARAMS((char *));
267 extern void _rl_reset_prompt
PARAMS((void));
268 extern void _rl_move_cursor_relative
PARAMS((int, const char *));
269 extern void _rl_move_vert
PARAMS((int));
270 extern void _rl_save_prompt
PARAMS((void));
271 extern void _rl_restore_prompt
PARAMS((void));
272 extern char *_rl_make_prompt_for_search
PARAMS((int));
273 extern void _rl_erase_at_end_of_line
PARAMS((int));
274 extern void _rl_clear_to_eol
PARAMS((int));
275 extern void _rl_clear_screen
PARAMS((void));
276 extern void _rl_update_final
PARAMS((void));
277 extern void _rl_redisplay_after_sigwinch
PARAMS((void));
278 extern void _rl_clean_up_for_exit
PARAMS((void));
279 extern void _rl_erase_entire_line
PARAMS((void));
280 extern int _rl_current_display_line
PARAMS((void));
283 extern int _rl_any_typein
PARAMS((void));
284 extern int _rl_input_available
PARAMS((void));
285 extern int _rl_input_queued
PARAMS((int));
286 extern void _rl_insert_typein
PARAMS((int));
287 extern int _rl_unget_char
PARAMS((int));
288 extern int _rl_pushed_input_available
PARAMS((void));
291 extern _rl_search_cxt
*_rl_scxt_alloc
PARAMS((int, int));
292 extern void _rl_scxt_dispose
PARAMS((_rl_search_cxt
*, int));
294 extern int _rl_isearch_dispatch
PARAMS((_rl_search_cxt
*, int));
295 extern int _rl_isearch_callback
PARAMS((_rl_search_cxt
*));
296 extern int _rl_isearch_cleanup
PARAMS((_rl_search_cxt
*, int));
298 extern int _rl_search_getchar
PARAMS((_rl_search_cxt
*));
301 #define BRACK_PASTE_PREF "\033[200~"
302 #define BRACK_PASTE_SUFF "\033[201~"
304 #define BRACK_PASTE_LAST '~'
305 #define BRACK_PASTE_SLEN 6
307 #define BRACK_PASTE_INIT "\033[?2004h"
308 #define BRACK_PASTE_FINI "\033[?2004l"
311 extern void _rl_with_macro_input
PARAMS((char *));
312 extern int _rl_next_macro_key
PARAMS((void));
313 extern int _rl_prev_macro_key
PARAMS((void));
314 extern void _rl_push_executing_macro
PARAMS((void));
315 extern void _rl_pop_executing_macro
PARAMS((void));
316 extern void _rl_add_macro_char
PARAMS((int));
317 extern void _rl_kill_kbd_macro
PARAMS((void));
320 extern int _rl_arg_overflow
PARAMS((void));
321 extern void _rl_arg_init
PARAMS((void));
322 extern int _rl_arg_getchar
PARAMS((void));
323 extern int _rl_arg_callback
PARAMS((_rl_arg_cxt
));
324 extern void _rl_reset_argument
PARAMS((void));
326 extern void _rl_start_using_history
PARAMS((void));
327 extern int _rl_free_saved_history_line
PARAMS((void));
328 extern void _rl_set_insert_mode
PARAMS((int, int));
330 extern void _rl_revert_all_lines
PARAMS((void));
333 extern int _rl_init_eightbit
PARAMS((void));
336 extern void _rl_enable_paren_matching
PARAMS((int));
339 extern void _rl_init_line_state
PARAMS((void));
340 extern void _rl_set_the_line
PARAMS((void));
341 extern int _rl_dispatch
PARAMS((int, Keymap
));
342 extern int _rl_dispatch_subseq
PARAMS((int, Keymap
, int));
343 extern void _rl_internal_char_cleanup
PARAMS((void));
346 extern int _rl_disable_tty_signals
PARAMS((void));
347 extern int _rl_restore_tty_signals
PARAMS((void));
350 extern int _rl_nsearch_callback
PARAMS((_rl_search_cxt
*));
351 extern int _rl_nsearch_cleanup
PARAMS((_rl_search_cxt
*, int));
354 extern void _rl_signal_handler
PARAMS((int));
356 extern void _rl_block_sigint
PARAMS((void));
357 extern void _rl_release_sigint
PARAMS((void));
358 extern void _rl_block_sigwinch
PARAMS((void));
359 extern void _rl_release_sigwinch
PARAMS((void));
362 extern void _rl_get_screen_size
PARAMS((int, int));
363 extern void _rl_sigwinch_resize_terminal
PARAMS((void));
364 extern int _rl_init_terminal_io
PARAMS((const char *));
366 extern void _rl_output_character_function
PARAMS((int));
368 extern int _rl_output_character_function
PARAMS((int));
370 extern void _rl_output_some_chars
PARAMS((const char *, int));
371 extern int _rl_backspace
PARAMS((int));
372 extern void _rl_enable_meta_key
PARAMS((void));
373 extern void _rl_disable_meta_key
PARAMS((void));
374 extern void _rl_control_keypad
PARAMS((int));
375 extern void _rl_set_cursor
PARAMS((int, int));
378 extern void _rl_fix_point
PARAMS((int));
379 extern int _rl_replace_text
PARAMS((const char *, int, int));
380 extern int _rl_forward_char_internal
PARAMS((int));
381 extern int _rl_insert_char
PARAMS((int, int));
382 extern int _rl_overwrite_char
PARAMS((int, int));
383 extern int _rl_overwrite_rubout
PARAMS((int, int));
384 extern int _rl_rubout_char
PARAMS((int, int));
385 #if defined (HANDLE_MULTIBYTE)
386 extern int _rl_char_search_internal
PARAMS((int, int, char *, int));
388 extern int _rl_char_search_internal
PARAMS((int, int, int));
390 extern int _rl_set_mark_at_pos
PARAMS((int));
393 extern UNDO_LIST
*_rl_copy_undo_entry
PARAMS((UNDO_LIST
*));
394 extern UNDO_LIST
*_rl_copy_undo_list
PARAMS((UNDO_LIST
*));
395 extern void _rl_free_undo_list
PARAMS((UNDO_LIST
*));
398 #if defined (USE_VARARGS) && defined (PREFER_STDARG)
399 extern void _rl_ttymsg (const char *, ...) __attribute__((__format__ (printf
, 1, 2)));
400 extern void _rl_errmsg (const char *, ...) __attribute__((__format__ (printf
, 1, 2)));
401 extern void _rl_trace (const char *, ...) __attribute__((__format__ (printf
, 1, 2)));
403 extern void _rl_ttymsg ();
404 extern void _rl_errmsg ();
405 extern void _rl_trace ();
407 extern void _rl_audit_tty
PARAMS((char *));
409 extern int _rl_tropen
PARAMS((void));
411 extern int _rl_abort_internal
PARAMS((void));
412 extern int _rl_null_function
PARAMS((int, int));
413 extern char *_rl_strindex
PARAMS((const char *, const char *));
414 extern int _rl_qsort_string_compare
PARAMS((char **, char **));
415 extern int (_rl_uppercase_p
) PARAMS((int));
416 extern int (_rl_lowercase_p
) PARAMS((int));
417 extern int (_rl_pure_alphabetic
) PARAMS((int));
418 extern int (_rl_digit_p
) PARAMS((int));
419 extern int (_rl_to_lower
) PARAMS((int));
420 extern int (_rl_to_upper
) PARAMS((int));
421 extern int (_rl_digit_value
) PARAMS((int));
424 extern void _rl_vi_initialize_line
PARAMS((void));
425 extern void _rl_vi_reset_last
PARAMS((void));
426 extern void _rl_vi_set_last
PARAMS((int, int, int));
427 extern int _rl_vi_textmod_command
PARAMS((int));
428 extern int _rl_vi_motion_command
PARAMS((int));
429 extern void _rl_vi_done_inserting
PARAMS((void));
430 extern int _rl_vi_domove_callback
PARAMS((_rl_vimotion_cxt
*));
431 extern int _rl_vi_domove_motion_cleanup
PARAMS((int, _rl_vimotion_cxt
*));
433 /*************************************************************************
434 * Undocumented private variables *
435 *************************************************************************/
438 extern const char * const _rl_possible_control_prefixes
[];
439 extern const char * const _rl_possible_meta_prefixes
[];
442 extern _rl_callback_func_t
*_rl_callback_func
;
443 extern _rl_callback_generic_arg
*_rl_callback_data
;
446 extern int _rl_complete_show_all
;
447 extern int _rl_complete_show_unmodified
;
448 extern int _rl_complete_mark_directories
;
449 extern int _rl_complete_mark_symlink_dirs
;
450 extern int _rl_completion_prefix_display_length
;
451 extern int _rl_completion_columns
;
452 extern int _rl_print_completions_horizontally
;
453 extern int _rl_completion_case_fold
;
454 extern int _rl_completion_case_map
;
455 extern int _rl_match_hidden_files
;
456 extern int _rl_page_completions
;
457 extern int _rl_skip_completed_text
;
458 extern int _rl_menu_complete_prefix_first
;
461 extern int _rl_vis_botlin
;
462 extern int _rl_last_c_pos
;
463 extern int _rl_suppress_redisplay
;
464 extern int _rl_want_redisplay
;
466 extern char *_rl_emacs_mode_str
;
467 extern int _rl_emacs_modestr_len
;
468 extern char *_rl_vi_ins_mode_str
;
469 extern int _rl_vi_ins_modestr_len
;
470 extern char *_rl_vi_cmd_mode_str
;
471 extern int _rl_vi_cmd_modestr_len
;
474 extern char *_rl_isearch_terminators
;
476 extern _rl_search_cxt
*_rl_iscxt
;
479 extern char *_rl_executing_macro
;
482 extern int _rl_history_preserve_point
;
483 extern int _rl_history_saved_point
;
485 extern _rl_arg_cxt _rl_argcxt
;
488 extern int _rl_utf8locale
;
491 extern int _rl_echoing_p
;
492 extern int _rl_horizontal_scroll_mode
;
493 extern int _rl_mark_modified_lines
;
494 extern int _rl_bell_preference
;
495 extern int _rl_meta_flag
;
496 extern int _rl_convert_meta_chars_to_ascii
;
497 extern int _rl_output_meta_chars
;
498 extern int _rl_bind_stty_chars
;
499 extern int _rl_revert_all_at_newline
;
500 extern int _rl_echo_control_chars
;
501 extern int _rl_show_mode_in_prompt
;
502 extern int _rl_enable_bracketed_paste
;
503 extern char *_rl_comment_begin
;
504 extern unsigned char _rl_parsing_conditionalized_out
;
505 extern Keymap _rl_keymap
;
506 extern FILE *_rl_in_stream
;
507 extern FILE *_rl_out_stream
;
508 extern int _rl_last_command_was_kill
;
509 extern int _rl_eof_char
;
510 extern procenv_t _rl_top_level
;
511 extern _rl_keyseq_cxt
*_rl_kscxt
;
512 extern int _rl_keyseq_timeout
;
514 extern int _rl_executing_keyseq_size
;
517 extern _rl_search_cxt
*_rl_nscxt
;
520 extern int _rl_interrupt_immediately
;
521 extern int volatile _rl_caught_signal
;
523 extern _rl_sigcleanup_func_t
*_rl_sigcleanup
;
524 extern void *_rl_sigcleanarg
;
526 extern int _rl_echoctl
;
528 extern int _rl_intr_char
;
529 extern int _rl_quit_char
;
530 extern int _rl_susp_char
;
533 extern int _rl_enable_keypad
;
534 extern int _rl_enable_meta
;
535 extern char *_rl_term_clreol
;
536 extern char *_rl_term_clrpag
;
537 extern char *_rl_term_im
;
538 extern char *_rl_term_ic
;
539 extern char *_rl_term_ei
;
540 extern char *_rl_term_DC
;
541 extern char *_rl_term_up
;
542 extern char *_rl_term_dc
;
543 extern char *_rl_term_cr
;
544 extern char *_rl_term_IC
;
545 extern char *_rl_term_forward_char
;
546 extern int _rl_screenheight
;
547 extern int _rl_screenwidth
;
548 extern int _rl_screenchars
;
549 extern int _rl_terminal_can_insert
;
550 extern int _rl_term_autowrap
;
553 extern int _rl_optimize_typeahead
;
556 extern int _rl_doing_an_undo
;
557 extern int _rl_undo_group_level
;
560 extern int _rl_vi_last_command
;
561 extern int _rl_vi_redoing
;
562 extern _rl_vimotion_cxt
*_rl_vimvcxt
;
564 #endif /* _RL_PRIVATE_H_ */