1 /* rlprivate.h -- functions and variables global to the readline library,
2 but not intended for use by applications. */
4 /* Copyright (C) 1999-2009 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 /*************************************************************************
47 * Global structs undocumented in texinfo manual and not in readline.h *
49 *************************************************************************/
51 #define RL_SEARCH_ISEARCH 0x01 /* incremental search */
52 #define RL_SEARCH_NSEARCH 0x02 /* non-incremental search */
53 #define RL_SEARCH_CSEARCH 0x04 /* intra-line char search */
56 #define SF_REVERSE 0x01
58 #define SF_FAILED 0x04
60 typedef struct __rl_search_context
66 int search_string_index;
67 int search_string_size;
78 char *prev_line_found;
80 UNDO_LIST *save_undo_list;
86 #if defined (HANDLE_MULTIBYTE)
94 char *search_terminators;
97 /* Callback data for reading numeric arguments */
98 #define NUM_SAWMINUS 0x01
99 #define NUM_SAWDIGITS 0x02
100 #define NUM_READONE 0x04
102 typedef int _rl_arg_cxt;
104 /* A context for reading key sequences longer than a single character when
105 using the callback interface. */
106 #define KSEQ_DISPATCHED 0x01
107 #define KSEQ_SUBSEQ 0x02
108 #define KSEQ_RECURSIVE 0x04
110 typedef struct __rl_keyseq_context
114 int subseq_retval; /* XXX */
119 struct __rl_keyseq_context *ocxt;
123 /* fill in more as needed */
124 /* `Generic' callback data and functions */
125 typedef struct __rl_callback_generic_arg
129 /* add here as needed */
130 } _rl_callback_generic_arg;
132 typedef int _rl_callback_func_t PARAMS((_rl_callback_generic_arg *));
134 /*************************************************************************
136 * Global functions undocumented in texinfo manual and not in readline.h *
138 *************************************************************************/
140 /*************************************************************************
142 * Global variables undocumented in texinfo manual and not in readline.h *
144 *************************************************************************/
147 extern int rl_complete_with_tilde_expansion;
148 #if defined (VISIBLE_STATS)
149 extern int rl_visible_stats;
150 #endif /* VISIBLE_STATS */
153 extern int rl_line_buffer_len;
154 extern int rl_arg_sign;
155 extern int rl_visible_prompt_length;
156 extern int rl_key_sequence_length;
157 extern int rl_byte_oriented;
160 extern int rl_display_fixed;
163 extern int rl_blink_matching_paren;
165 /*************************************************************************
167 * Global functions and variables unsed and undocumented *
169 *************************************************************************/
172 extern int rl_set_retained_kills PARAMS((int));
175 extern void _rl_set_screen_size PARAMS((int, int));
178 extern int _rl_fix_last_undo_of_type PARAMS((int, int, int));
181 extern char *_rl_savestring PARAMS((const char *));
183 /*************************************************************************
185 * Functions and variables private to the readline library *
187 *************************************************************************/
189 /* NOTE: Functions and variables prefixed with `_rl_' are
190 pseudo-global: they are global so they can be shared
191 between files in the readline library, but are not intended
192 to be visible to readline callers. */
194 /*************************************************************************
195 * Undocumented private functions *
196 *************************************************************************/
198 #if defined(READLINE_CALLBACKS)
201 extern void readline_internal_setup PARAMS((void));
202 extern char *readline_internal_teardown PARAMS((int));
203 extern int readline_internal_char PARAMS((void));
205 extern _rl_keyseq_cxt *_rl_keyseq_cxt_alloc PARAMS((void));
206 extern void _rl_keyseq_cxt_dispose PARAMS((_rl_keyseq_cxt *));
207 extern void _rl_keyseq_chain_dispose PARAMS((void));
209 extern int _rl_dispatch_callback PARAMS((_rl_keyseq_cxt *));
212 extern _rl_callback_generic_arg *_rl_callback_data_alloc PARAMS((int));
213 extern void _rl_callback_data_dispose PARAMS((_rl_callback_generic_arg *));
215 #endif /* READLINE_CALLBACKS */
220 extern void _rl_reset_completion_state PARAMS((void));
221 extern char _rl_find_completion_word PARAMS((int *, int *));
222 extern void _rl_free_match_list PARAMS((char **));
225 extern char *_rl_strip_prompt PARAMS((char *));
226 extern void _rl_move_cursor_relative PARAMS((int, const char *));
227 extern void _rl_move_vert PARAMS((int));
228 extern void _rl_save_prompt PARAMS((void));
229 extern void _rl_restore_prompt PARAMS((void));
230 extern char *_rl_make_prompt_for_search PARAMS((int));
231 extern void _rl_erase_at_end_of_line PARAMS((int));
232 extern void _rl_clear_to_eol PARAMS((int));
233 extern void _rl_clear_screen PARAMS((void));
234 extern void _rl_update_final PARAMS((void));
235 extern void _rl_redisplay_after_sigwinch PARAMS((void));
236 extern void _rl_clean_up_for_exit PARAMS((void));
237 extern void _rl_erase_entire_line PARAMS((void));
238 extern int _rl_current_display_line PARAMS((void));
241 extern int _rl_any_typein PARAMS((void));
242 extern int _rl_input_available PARAMS((void));
243 extern int _rl_input_queued PARAMS((int));
244 extern void _rl_insert_typein PARAMS((int));
245 extern int _rl_unget_char PARAMS((int));
246 extern int _rl_pushed_input_available PARAMS((void));
249 extern _rl_search_cxt *_rl_scxt_alloc PARAMS((int, int));
250 extern void _rl_scxt_dispose PARAMS((_rl_search_cxt *, int));
252 extern int _rl_isearch_dispatch PARAMS((_rl_search_cxt *, int));
253 extern int _rl_isearch_callback PARAMS((_rl_search_cxt *));
255 extern int _rl_search_getchar PARAMS((_rl_search_cxt *));
258 extern void _rl_with_macro_input PARAMS((char *));
259 extern int _rl_next_macro_key PARAMS((void));
260 extern void _rl_push_executing_macro PARAMS((void));
261 extern void _rl_pop_executing_macro PARAMS((void));
262 extern void _rl_add_macro_char PARAMS((int));
263 extern void _rl_kill_kbd_macro PARAMS((void));
266 extern int _rl_arg_overflow PARAMS((void));
267 extern void _rl_arg_init PARAMS((void));
268 extern int _rl_arg_getchar PARAMS((void));
269 extern int _rl_arg_callback PARAMS((_rl_arg_cxt));
270 extern void _rl_reset_argument PARAMS((void));
272 extern void _rl_start_using_history PARAMS((void));
273 extern int _rl_free_saved_history_line PARAMS((void));
274 extern void _rl_set_insert_mode PARAMS((int, int));
276 extern void _rl_revert_all_lines PARAMS((void));
279 extern int _rl_init_eightbit PARAMS((void));
282 extern void _rl_enable_paren_matching PARAMS((int));
285 extern void _rl_init_line_state PARAMS((void));
286 extern void _rl_set_the_line PARAMS((void));
287 extern int _rl_dispatch PARAMS((int, Keymap));
288 extern int _rl_dispatch_subseq PARAMS((int, Keymap, int));
289 extern void _rl_internal_char_cleanup PARAMS((void));
292 extern int _rl_disable_tty_signals PARAMS((void));
293 extern int _rl_restore_tty_signals PARAMS((void));
296 extern int _rl_nsearch_callback PARAMS((_rl_search_cxt *));
299 extern void _rl_signal_handler PARAMS((int));
301 extern void _rl_block_sigint PARAMS((void));
302 extern void _rl_release_sigint PARAMS((void));
305 extern void _rl_get_screen_size PARAMS((int, int));
306 extern int _rl_init_terminal_io PARAMS((const char *));
308 extern void _rl_output_character_function PARAMS((int));
310 extern int _rl_output_character_function PARAMS((int));
312 extern void _rl_output_some_chars PARAMS((const char *, int));
313 extern int _rl_backspace PARAMS((int));
314 extern void _rl_enable_meta_key PARAMS((void));
315 extern void _rl_control_keypad PARAMS((int));
316 extern void _rl_set_cursor PARAMS((int, int));
319 extern void _rl_fix_point PARAMS((int));
320 extern int _rl_replace_text PARAMS((const char *, int, int));
321 extern int _rl_insert_char PARAMS((int, int));
322 extern int _rl_overwrite_char PARAMS((int, int));
323 extern int _rl_overwrite_rubout PARAMS((int, int));
324 extern int _rl_rubout_char PARAMS((int, int));
325 #if defined (HANDLE_MULTIBYTE)
326 extern int _rl_char_search_internal PARAMS((int, int, char *, int));
328 extern int _rl_char_search_internal PARAMS((int, int, int));
330 extern int _rl_set_mark_at_pos PARAMS((int));
333 extern UNDO_LIST *_rl_copy_undo_entry PARAMS((UNDO_LIST *));
334 extern UNDO_LIST *_rl_copy_undo_list PARAMS((UNDO_LIST *));
337 #if defined (USE_VARARGS) && defined (PREFER_STDARG)
338 extern void _rl_ttymsg (const char *, ...) __attribute__((__format__ (printf, 1, 2)));
339 extern void _rl_errmsg (const char *, ...) __attribute__((__format__ (printf, 1, 2)));
340 extern void _rl_trace (const char *, ...) __attribute__((__format__ (printf, 1, 2)));
342 extern void _rl_ttymsg ();
343 extern void _rl_errmsg ();
344 extern void _rl_trace ();
347 extern int _rl_tropen PARAMS((void));
349 extern int _rl_abort_internal PARAMS((void));
350 extern char *_rl_strindex PARAMS((const char *, const char *));
351 extern int _rl_qsort_string_compare PARAMS((char **, char **));
352 extern int (_rl_uppercase_p) PARAMS((int));
353 extern int (_rl_lowercase_p) PARAMS((int));
354 extern int (_rl_pure_alphabetic) PARAMS((int));
355 extern int (_rl_digit_p) PARAMS((int));
356 extern int (_rl_to_lower) PARAMS((int));
357 extern int (_rl_to_upper) PARAMS((int));
358 extern int (_rl_digit_value) PARAMS((int));
361 extern void _rl_vi_initialize_line PARAMS((void));
362 extern void _rl_vi_reset_last PARAMS((void));
363 extern void _rl_vi_set_last PARAMS((int, int, int));
364 extern int _rl_vi_textmod_command PARAMS((int));
365 extern void _rl_vi_done_inserting PARAMS((void));
367 /*************************************************************************
368 * Undocumented private variables *
369 *************************************************************************/
372 extern const char * const _rl_possible_control_prefixes[];
373 extern const char * const _rl_possible_meta_prefixes[];
376 extern _rl_callback_func_t *_rl_callback_func;
377 extern _rl_callback_generic_arg *_rl_callback_data;
380 extern int _rl_complete_show_all;
381 extern int _rl_complete_show_unmodified;
382 extern int _rl_complete_mark_directories;
383 extern int _rl_complete_mark_symlink_dirs;
384 extern int _rl_completion_prefix_display_length;
385 extern int _rl_print_completions_horizontally;
386 extern int _rl_completion_case_fold;
387 extern int _rl_match_hidden_files;
388 extern int _rl_page_completions;
391 extern int _rl_vis_botlin;
392 extern int _rl_last_c_pos;
393 extern int _rl_suppress_redisplay;
394 extern int _rl_want_redisplay;
397 extern char *_rl_isearch_terminators;
399 extern _rl_search_cxt *_rl_iscxt;
402 extern char *_rl_executing_macro;
405 extern int _rl_history_preserve_point;
406 extern int _rl_history_saved_point;
408 extern _rl_arg_cxt _rl_argcxt;
411 extern int _rl_echoing_p;
412 extern int _rl_horizontal_scroll_mode;
413 extern int _rl_mark_modified_lines;
414 extern int _rl_bell_preference;
415 extern int _rl_meta_flag;
416 extern int _rl_convert_meta_chars_to_ascii;
417 extern int _rl_output_meta_chars;
418 extern int _rl_bind_stty_chars;
419 extern int _rl_revert_all_at_newline;
420 extern char *_rl_comment_begin;
421 extern unsigned char _rl_parsing_conditionalized_out;
422 extern Keymap _rl_keymap;
423 extern FILE *_rl_in_stream;
424 extern FILE *_rl_out_stream;
425 extern int _rl_last_command_was_kill;
426 extern int _rl_eof_char;
427 extern procenv_t _rl_top_level;
428 extern _rl_keyseq_cxt *_rl_kscxt;
431 extern _rl_search_cxt *_rl_nscxt;
434 extern int _rl_interrupt_immediately;
435 extern int volatile _rl_caught_signal;
437 extern int _rl_echoctl;
439 extern int _rl_intr_char;
440 extern int _rl_quit_char;
441 extern int _rl_susp_char;
444 extern int _rl_enable_keypad;
445 extern int _rl_enable_meta;
446 extern char *_rl_term_clreol;
447 extern char *_rl_term_clrpag;
448 extern char *_rl_term_im;
449 extern char *_rl_term_ic;
450 extern char *_rl_term_ei;
451 extern char *_rl_term_DC;
452 extern char *_rl_term_up;
453 extern char *_rl_term_dc;
454 extern char *_rl_term_cr;
455 extern char *_rl_term_IC;
456 extern char *_rl_term_forward_char;
457 extern int _rl_screenheight;
458 extern int _rl_screenwidth;
459 extern int _rl_screenchars;
460 extern int _rl_terminal_can_insert;
461 extern int _rl_term_autowrap;
464 extern int _rl_doing_an_undo;
465 extern int _rl_undo_group_level;
468 extern int _rl_vi_last_command;
470 #endif /* _RL_PRIVATE_H_ */