]> git.ipfire.org Git - thirdparty/bash.git/blame - lib/readline/rlprivate.h
Imported from ../bash-3.0.tar.gz.
[thirdparty/bash.git] / lib / readline / rlprivate.h
CommitLineData
bb70624e
JA
1/* rlprivate.h -- functions and variables global to the readline library,
2 but not intended for use by applications. */
3
b80f6443 4/* Copyright (C) 1999-2004 Free Software Foundation, Inc.
bb70624e
JA
5
6 This file is part of the GNU Readline Library, a library for
7 reading lines of text with interactive input and history editing.
8
9 The GNU Readline Library is free software; you can redistribute it
10 and/or modify it under the terms of the GNU General Public License
11 as published by the Free Software Foundation; either version 2, or
12 (at your option) any later version.
13
14 The GNU Readline Library is distributed in the hope that it will be
15 useful, but WITHOUT ANY WARRANTY; without even the implied warranty
16 of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
18
19 The GNU General Public License is often shipped with GNU software, and
20 is generally kept in a file called COPYING or LICENSE. If you do not
21 have a copy of the license, write to the Free Software Foundation,
22 59 Temple Place, Suite 330, Boston, MA 02111 USA. */
23
24#if !defined (_RL_PRIVATE_H_)
25#define _RL_PRIVATE_H_
26
27#include "rlconf.h" /* for VISIBLE_STATS */
28#include "rlstdc.h"
f73dda09 29#include "posixjmp.h" /* defines procenv_t */
bb70624e
JA
30
31/*************************************************************************
32 * *
33 * Global functions undocumented in texinfo manual and not in readline.h *
34 * *
35 *************************************************************************/
36
bb70624e
JA
37/*************************************************************************
38 * *
39 * Global variables undocumented in texinfo manual and not in readline.h *
40 * *
41 *************************************************************************/
42
43/* complete.c */
44extern int rl_complete_with_tilde_expansion;
45#if defined (VISIBLE_STATS)
46extern int rl_visible_stats;
47#endif /* VISIBLE_STATS */
48
49/* readline.c */
50extern int rl_line_buffer_len;
bb70624e 51extern int rl_arg_sign;
bb70624e 52extern int rl_visible_prompt_length;
bb70624e
JA
53extern int readline_echoing_p;
54extern int rl_key_sequence_length;
7117c2d2 55extern int rl_byte_oriented;
bb70624e
JA
56
57/* display.c */
58extern int rl_display_fixed;
59
60/* parens.c */
61extern int rl_blink_matching_paren;
62
63/*************************************************************************
64 * *
65 * Global functions and variables unsed and undocumented *
66 * *
67 *************************************************************************/
68
bb70624e 69/* kill.c */
f73dda09 70extern int rl_set_retained_kills PARAMS((int));
bb70624e 71
bb70624e 72/* terminal.c */
f73dda09 73extern void _rl_set_screen_size PARAMS((int, int));
bb70624e
JA
74
75/* undo.c */
f73dda09 76extern int _rl_fix_last_undo_of_type PARAMS((int, int, int));
bb70624e
JA
77
78/* util.c */
f73dda09 79extern char *_rl_savestring PARAMS((const char *));
bb70624e
JA
80
81/*************************************************************************
82 * *
83 * Functions and variables private to the readline library *
84 * *
85 *************************************************************************/
86
87/* NOTE: Functions and variables prefixed with `_rl_' are
88 pseudo-global: they are global so they can be shared
89 between files in the readline library, but are not intended
90 to be visible to readline callers. */
91
92/*************************************************************************
93 * Undocumented private functions *
94 *************************************************************************/
95
96#if defined(READLINE_CALLBACKS)
97
98/* readline.c */
f73dda09
JA
99extern void readline_internal_setup PARAMS((void));
100extern char *readline_internal_teardown PARAMS((int));
101extern int readline_internal_char PARAMS((void));
bb70624e
JA
102
103#endif /* READLINE_CALLBACKS */
104
105/* bind.c */
bb70624e 106
7117c2d2
JA
107/* complete.c */
108extern char _rl_find_completion_word PARAMS((int *, int *));
109extern void _rl_free_match_list PARAMS((char **));
110
bb70624e 111/* display.c */
f73dda09
JA
112extern char *_rl_strip_prompt PARAMS((char *));
113extern void _rl_move_cursor_relative PARAMS((int, const char *));
114extern void _rl_move_vert PARAMS((int));
115extern void _rl_save_prompt PARAMS((void));
116extern void _rl_restore_prompt PARAMS((void));
117extern char *_rl_make_prompt_for_search PARAMS((int));
118extern void _rl_erase_at_end_of_line PARAMS((int));
119extern void _rl_clear_to_eol PARAMS((int));
120extern void _rl_clear_screen PARAMS((void));
121extern void _rl_update_final PARAMS((void));
122extern void _rl_redisplay_after_sigwinch PARAMS((void));
123extern void _rl_clean_up_for_exit PARAMS((void));
124extern void _rl_erase_entire_line PARAMS((void));
125extern int _rl_current_display_line PARAMS((void));
bb70624e
JA
126
127/* input.c */
f73dda09
JA
128extern int _rl_any_typein PARAMS((void));
129extern int _rl_input_available PARAMS((void));
7117c2d2 130extern int _rl_input_queued PARAMS((int));
f73dda09 131extern void _rl_insert_typein PARAMS((int));
7117c2d2 132extern int _rl_unget_char PARAMS((int));
b80f6443 133extern int _rl_pushed_input_available PARAMS((void));
bb70624e
JA
134
135/* macro.c */
f73dda09
JA
136extern void _rl_with_macro_input PARAMS((char *));
137extern int _rl_next_macro_key PARAMS((void));
138extern void _rl_push_executing_macro PARAMS((void));
139extern void _rl_pop_executing_macro PARAMS((void));
140extern void _rl_add_macro_char PARAMS((int));
141extern void _rl_kill_kbd_macro PARAMS((void));
bb70624e 142
7117c2d2
JA
143/* misc.c */
144extern int _rl_init_argument PARAMS((void));
145extern void _rl_start_using_history PARAMS((void));
146extern int _rl_free_saved_history_line PARAMS((void));
147extern void _rl_set_insert_mode PARAMS((int, int));
148
bb70624e 149/* nls.c */
f73dda09 150extern int _rl_init_eightbit PARAMS((void));
bb70624e
JA
151
152/* parens.c */
f73dda09 153extern void _rl_enable_paren_matching PARAMS((int));
bb70624e
JA
154
155/* readline.c */
f73dda09
JA
156extern void _rl_init_line_state PARAMS((void));
157extern void _rl_set_the_line PARAMS((void));
158extern int _rl_dispatch PARAMS((int, Keymap));
7117c2d2 159extern int _rl_dispatch_subseq PARAMS((int, Keymap, int));
bb70624e
JA
160
161/* rltty.c */
f73dda09
JA
162extern int _rl_disable_tty_signals PARAMS((void));
163extern int _rl_restore_tty_signals PARAMS((void));
bb70624e
JA
164
165/* terminal.c */
f73dda09
JA
166extern void _rl_get_screen_size PARAMS((int, int));
167extern int _rl_init_terminal_io PARAMS((const char *));
bb70624e 168#ifdef _MINIX
f73dda09 169extern void _rl_output_character_function PARAMS((int));
bb70624e 170#else
f73dda09 171extern int _rl_output_character_function PARAMS((int));
bb70624e 172#endif
f73dda09
JA
173extern void _rl_output_some_chars PARAMS((const char *, int));
174extern int _rl_backspace PARAMS((int));
175extern void _rl_enable_meta_key PARAMS((void));
176extern void _rl_control_keypad PARAMS((int));
7117c2d2
JA
177extern void _rl_set_cursor PARAMS((int, int));
178
179/* text.c */
180extern void _rl_fix_point PARAMS((int));
181extern int _rl_replace_text PARAMS((const char *, int, int));
182extern int _rl_insert_char PARAMS((int, int));
183extern int _rl_overwrite_char PARAMS((int, int));
184extern int _rl_overwrite_rubout PARAMS((int, int));
185extern int _rl_rubout_char PARAMS((int, int));
186#if defined (HANDLE_MULTIBYTE)
187extern int _rl_char_search_internal PARAMS((int, int, char *, int));
188#else
189extern int _rl_char_search_internal PARAMS((int, int, int));
190#endif
191extern int _rl_set_mark_at_pos PARAMS((int));
bb70624e
JA
192
193/* util.c */
f73dda09
JA
194extern int _rl_abort_internal PARAMS((void));
195extern char *_rl_strindex PARAMS((const char *, const char *));
196extern int _rl_qsort_string_compare PARAMS((char **, char **));
197extern int (_rl_uppercase_p) PARAMS((int));
198extern int (_rl_lowercase_p) PARAMS((int));
199extern int (_rl_pure_alphabetic) PARAMS((int));
200extern int (_rl_digit_p) PARAMS((int));
201extern int (_rl_to_lower) PARAMS((int));
202extern int (_rl_to_upper) PARAMS((int));
203extern int (_rl_digit_value) PARAMS((int));
bb70624e
JA
204
205/* vi_mode.c */
f73dda09
JA
206extern void _rl_vi_initialize_line PARAMS((void));
207extern void _rl_vi_reset_last PARAMS((void));
208extern void _rl_vi_set_last PARAMS((int, int, int));
209extern int _rl_vi_textmod_command PARAMS((int));
210extern void _rl_vi_done_inserting PARAMS((void));
bb70624e
JA
211
212/*************************************************************************
213 * Undocumented private variables *
214 *************************************************************************/
215
28ef6c31
JA
216/* bind.c */
217extern const char *_rl_possible_control_prefixes[];
218extern const char *_rl_possible_meta_prefixes[];
219
bb70624e
JA
220/* complete.c */
221extern int _rl_complete_show_all;
b80f6443 222extern int _rl_complete_show_unmodified;
bb70624e 223extern int _rl_complete_mark_directories;
7117c2d2 224extern int _rl_complete_mark_symlink_dirs;
bb70624e
JA
225extern int _rl_print_completions_horizontally;
226extern int _rl_completion_case_fold;
f73dda09 227extern int _rl_match_hidden_files;
7117c2d2 228extern int _rl_page_completions;
bb70624e
JA
229
230/* display.c */
231extern int _rl_vis_botlin;
232extern int _rl_last_c_pos;
233extern int _rl_suppress_redisplay;
234extern char *rl_display_prompt;
235
bb70624e 236/* isearch.c */
f73dda09 237extern char *_rl_isearch_terminators;
bb70624e
JA
238
239/* macro.c */
bb70624e
JA
240extern char *_rl_executing_macro;
241
7117c2d2
JA
242/* misc.c */
243extern int _rl_history_preserve_point;
244extern int _rl_history_saved_point;
245
bb70624e
JA
246/* readline.c */
247extern int _rl_horizontal_scroll_mode;
248extern int _rl_mark_modified_lines;
249extern int _rl_bell_preference;
250extern int _rl_meta_flag;
251extern int _rl_convert_meta_chars_to_ascii;
252extern int _rl_output_meta_chars;
253extern char *_rl_comment_begin;
254extern unsigned char _rl_parsing_conditionalized_out;
255extern Keymap _rl_keymap;
256extern FILE *_rl_in_stream;
257extern FILE *_rl_out_stream;
258extern int _rl_last_command_was_kill;
259extern int _rl_eof_char;
260extern procenv_t readline_top_level;
261
262/* terminal.c */
263extern int _rl_enable_keypad;
264extern int _rl_enable_meta;
28ef6c31
JA
265extern char *_rl_term_clreol;
266extern char *_rl_term_clrpag;
267extern char *_rl_term_im;
268extern char *_rl_term_ic;
269extern char *_rl_term_ei;
270extern char *_rl_term_DC;
271extern char *_rl_term_up;
272extern char *_rl_term_dc;
273extern char *_rl_term_cr;
274extern char *_rl_term_IC;
275extern int _rl_screenheight;
276extern int _rl_screenwidth;
277extern int _rl_screenchars;
278extern int _rl_terminal_can_insert;
bb70624e
JA
279extern int _rl_term_autowrap;
280
281/* undo.c */
282extern int _rl_doing_an_undo;
283extern int _rl_undo_group_level;
284
b80f6443
JA
285/* vi_mode.c */
286extern int _rl_vi_last_command;
287
bb70624e 288#endif /* _RL_PRIVATE_H_ */