rlprivate.h revision 119610 
11590Srgrimes/* rlprivate.h -- functions and variables global to the readline library,
21590Srgrimes		  but not intended for use by applications. */
31590Srgrimes
41590Srgrimes/* Copyright (C) 1999 Free Software Foundation, Inc.
51590Srgrimes
61590Srgrimes   This file is part of the GNU Readline Library, a library for
71590Srgrimes   reading lines of text with interactive input and history editing.
81590Srgrimes
91590Srgrimes   The GNU Readline Library is free software; you can redistribute it
101590Srgrimes   and/or modify it under the terms of the GNU General Public License
111590Srgrimes   as published by the Free Software Foundation; either version 2, or
121590Srgrimes   (at your option) any later version.
131590Srgrimes
141590Srgrimes   The GNU Readline Library is distributed in the hope that it will be
151590Srgrimes   useful, but WITHOUT ANY WARRANTY; without even the implied warranty
161590Srgrimes   of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
171590Srgrimes   GNU General Public License for more details.
181590Srgrimes
191590Srgrimes   The GNU General Public License is often shipped with GNU software, and
201590Srgrimes   is generally kept in a file called COPYING or LICENSE.  If you do not
211590Srgrimes   have a copy of the license, write to the Free Software Foundation,
221590Srgrimes   59 Temple Place, Suite 330, Boston, MA 02111 USA. */
231590Srgrimes
241590Srgrimes#if !defined (_RL_PRIVATE_H_)
251590Srgrimes#define _RL_PRIVATE_H_
261590Srgrimes
271590Srgrimes#include "rlconf.h"	/* for VISIBLE_STATS */
281590Srgrimes#include "rlstdc.h"
291590Srgrimes#include "posixjmp.h"	/* defines procenv_t */
301590Srgrimes
311590Srgrimes/*************************************************************************
321590Srgrimes *									 *
331590Srgrimes * Global functions undocumented in texinfo manual and not in readline.h *
3487696Smarkm *									 *
3587696Smarkm *************************************************************************/
3687696Smarkm
3787696Smarkm/*************************************************************************
381590Srgrimes *									 *
3987696Smarkm * Global variables undocumented in texinfo manual and not in readline.h *
401590Srgrimes *									 *
411590Srgrimes *************************************************************************/
4287696Smarkm
431590Srgrimes/* complete.c */
441590Srgrimesextern int rl_complete_with_tilde_expansion;
4587696Smarkm#if defined (VISIBLE_STATS)
4687696Smarkmextern int rl_visible_stats;
471590Srgrimes#endif /* VISIBLE_STATS */
481590Srgrimes
491590Srgrimes/* readline.c */
501590Srgrimesextern int rl_line_buffer_len;
511590Srgrimesextern int rl_arg_sign;
521590Srgrimesextern int rl_visible_prompt_length;
531590Srgrimesextern int readline_echoing_p;
5423690Speterextern int rl_key_sequence_length;
551590Srgrimesextern int rl_byte_oriented;
561590Srgrimes
571590Srgrimes/* display.c */
581590Srgrimesextern int rl_display_fixed;
591590Srgrimes
601590Srgrimes/* parens.c */
611590Srgrimesextern int rl_blink_matching_paren;
621590Srgrimes
631590Srgrimes/*************************************************************************
641590Srgrimes *									 *
651590Srgrimes * Global functions and variables unsed and undocumented		 *
661590Srgrimes *									 *
671590Srgrimes *************************************************************************/
681590Srgrimes
691590Srgrimes/* kill.c */
701590Srgrimesextern int rl_set_retained_kills PARAMS((int));
7187696Smarkm
7287696Smarkm/* terminal.c */
731590Srgrimesextern void _rl_set_screen_size PARAMS((int, int));
741590Srgrimes
7533792Ssteve/* undo.c */
761590Srgrimesextern int _rl_fix_last_undo_of_type PARAMS((int, int, int));
771590Srgrimes
781590Srgrimes/* util.c */
791590Srgrimesextern char *_rl_savestring PARAMS((const char *));
8033792Ssteve
811590Srgrimes/*************************************************************************
821590Srgrimes *									 *
831590Srgrimes * Functions and variables private to the readline library		 *
841590Srgrimes *									 *
851590Srgrimes *************************************************************************/
861590Srgrimes
871590Srgrimes/* NOTE: Functions and variables prefixed with `_rl_' are
881590Srgrimes   pseudo-global: they are global so they can be shared
891590Srgrimes   between files in the readline library, but are not intended
901590Srgrimes   to be visible to readline callers. */
911590Srgrimes
921590Srgrimes/*************************************************************************
931590Srgrimes * Undocumented private functions					 *
941590Srgrimes *************************************************************************/
951590Srgrimes
961590Srgrimes#if defined(READLINE_CALLBACKS)
971590Srgrimes
981590Srgrimes/* readline.c */
991590Srgrimesextern void readline_internal_setup PARAMS((void));
1001590Srgrimesextern char *readline_internal_teardown PARAMS((int));
1011590Srgrimesextern int readline_internal_char PARAMS((void));
1021590Srgrimes
1031590Srgrimes#endif /* READLINE_CALLBACKS */
1041590Srgrimes
1051590Srgrimes/* bind.c */
1061590Srgrimesextern void _rl_bind_if_unbound PARAMS((const char *, rl_command_func_t *));
1071590Srgrimes
1081590Srgrimes/* complete.c */
1091590Srgrimesextern char _rl_find_completion_word PARAMS((int *, int *));
1101590Srgrimesextern void _rl_free_match_list PARAMS((char **));
1111590Srgrimes
1121590Srgrimes/* display.c */
1131590Srgrimesextern char *_rl_strip_prompt PARAMS((char *));
1141590Srgrimesextern void _rl_move_cursor_relative PARAMS((int, const char *));
1151590Srgrimesextern void _rl_move_vert PARAMS((int));
1161590Srgrimesextern void _rl_save_prompt PARAMS((void));
1171590Srgrimesextern void _rl_restore_prompt PARAMS((void));
11837453Sbdeextern char *_rl_make_prompt_for_search PARAMS((int));
1191590Srgrimesextern void _rl_erase_at_end_of_line PARAMS((int));
1201590Srgrimesextern void _rl_clear_to_eol PARAMS((int));
1211590Srgrimesextern void _rl_clear_screen PARAMS((void));
1221590Srgrimesextern void _rl_update_final PARAMS((void));
1231590Srgrimesextern void _rl_redisplay_after_sigwinch PARAMS((void));
1241590Srgrimesextern void _rl_clean_up_for_exit PARAMS((void));
1251590Srgrimesextern void _rl_erase_entire_line PARAMS((void));
1261590Srgrimesextern int _rl_current_display_line PARAMS((void));
12737453Sbde
1281590Srgrimes/* input.c */
1291590Srgrimesextern int _rl_any_typein PARAMS((void));
1301590Srgrimesextern int _rl_input_available PARAMS((void));
1311590Srgrimesextern int _rl_input_queued PARAMS((int));
1321590Srgrimesextern void _rl_insert_typein PARAMS((int));
1331590Srgrimesextern int _rl_unget_char PARAMS((int));
1341590Srgrimes
1351590Srgrimes/* macro.c */
13637453Sbdeextern void _rl_with_macro_input PARAMS((char *));
1371590Srgrimesextern int _rl_next_macro_key PARAMS((void));
1381590Srgrimesextern void _rl_push_executing_macro PARAMS((void));
1391590Srgrimesextern void _rl_pop_executing_macro PARAMS((void));
1401590Srgrimesextern void _rl_add_macro_char PARAMS((int));
1411590Srgrimesextern void _rl_kill_kbd_macro PARAMS((void));
1421590Srgrimes
1431590Srgrimes/* misc.c */
1441590Srgrimesextern int _rl_init_argument PARAMS((void));
1451590Srgrimesextern void _rl_start_using_history PARAMS((void));
1461590Srgrimesextern int _rl_free_saved_history_line PARAMS((void));
1471590Srgrimesextern void _rl_set_insert_mode PARAMS((int, int));
14837453Sbde
1491590Srgrimes/* nls.c */
1501590Srgrimesextern int _rl_init_eightbit PARAMS((void));
1511590Srgrimes
1521590Srgrimes/* parens.c */
1531590Srgrimesextern void _rl_enable_paren_matching PARAMS((int));
1541590Srgrimes
1551590Srgrimes/* readline.c */
1561590Srgrimesextern void _rl_init_line_state PARAMS((void));
15737453Sbdeextern void _rl_set_the_line PARAMS((void));
1581590Srgrimesextern int _rl_dispatch PARAMS((int, Keymap));
1591590Srgrimesextern int _rl_dispatch_subseq PARAMS((int, Keymap, int));
1601590Srgrimes
1611590Srgrimes/* rltty.c */
1621590Srgrimesextern int _rl_disable_tty_signals PARAMS((void));
1631590Srgrimesextern int _rl_restore_tty_signals PARAMS((void));
1641590Srgrimes
1651590Srgrimes/* terminal.c */
1661590Srgrimesextern void _rl_get_screen_size PARAMS((int, int));
1671590Srgrimesextern int _rl_init_terminal_io PARAMS((const char *));
1681590Srgrimes#ifdef _MINIX
1691590Srgrimesextern void _rl_output_character_function PARAMS((int));
170#else
171extern int _rl_output_character_function PARAMS((int));
172#endif
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));
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));
192
193/* util.c */
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));
204
205/* vi_mode.c */
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));
211
212/*************************************************************************
213 * Undocumented private variables					 *
214 *************************************************************************/
215
216/* bind.c */
217extern const char *_rl_possible_control_prefixes[];
218extern const char *_rl_possible_meta_prefixes[];
219
220/* complete.c */
221extern int _rl_complete_show_all;
222extern int _rl_complete_mark_directories;
223extern int _rl_complete_mark_symlink_dirs;
224extern int _rl_print_completions_horizontally;
225extern int _rl_completion_case_fold;
226extern int _rl_match_hidden_files;
227extern int _rl_page_completions;
228
229/* display.c */
230extern int _rl_vis_botlin;
231extern int _rl_last_c_pos;
232extern int _rl_suppress_redisplay;
233extern char *rl_display_prompt;
234
235/* isearch.c */
236extern char *_rl_isearch_terminators;
237
238/* macro.c */
239extern char *_rl_executing_macro;
240
241/* misc.c */
242extern int _rl_history_preserve_point;
243extern int _rl_history_saved_point;
244
245/* readline.c */
246extern int _rl_horizontal_scroll_mode;
247extern int _rl_mark_modified_lines;
248extern int _rl_bell_preference;
249extern int _rl_meta_flag;
250extern int _rl_convert_meta_chars_to_ascii;
251extern int _rl_output_meta_chars;
252extern char *_rl_comment_begin;
253extern unsigned char _rl_parsing_conditionalized_out;
254extern Keymap _rl_keymap;
255extern FILE *_rl_in_stream;
256extern FILE *_rl_out_stream;
257extern int _rl_last_command_was_kill;
258extern int _rl_eof_char;
259extern procenv_t readline_top_level;
260
261/* terminal.c */
262extern int _rl_enable_keypad;
263extern int _rl_enable_meta;
264extern char *_rl_term_clreol;
265extern char *_rl_term_clrpag;
266extern char *_rl_term_im;
267extern char *_rl_term_ic;
268extern char *_rl_term_ei;
269extern char *_rl_term_DC;
270extern char *_rl_term_up;
271extern char *_rl_term_dc;
272extern char *_rl_term_cr;
273extern char *_rl_term_IC;
274extern int _rl_screenheight;
275extern int _rl_screenwidth;
276extern int _rl_screenchars;
277extern int _rl_terminal_can_insert;
278extern int _rl_term_autowrap;
279
280/* undo.c */
281extern int _rl_doing_an_undo;
282extern int _rl_undo_group_level;
283
284#endif /* _RL_PRIVATE_H_ */
285