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 Free Software Foundation, Inc.
   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"
  29 #include "posixjmp.h" /* defines procenv_t */
  30
  31 /*************************************************************************
  32  *                                                                       *
  33  * Global functions undocumented in texinfo manual and not in readline.h *
  34  *                                                                       *
  35  *************************************************************************/
  36
  37 /* terminal.c */
  38 extern char *rl_get_termcap __P((const char *));
  39
  40 /*************************************************************************
  41  *                                                                       *
  42  * Global variables undocumented in texinfo manual and not in readline.h *
  43  *                                                                       *
  44  *************************************************************************/
  45
  46 /* complete.c */
  47 extern int rl_complete_with_tilde_expansion;
  48 #if defined (VISIBLE_STATS)
  49 extern int rl_visible_stats;
  50 #endif /* VISIBLE_STATS */
  51
  52 /* readline.c */
  53 extern int rl_line_buffer_len;
  54 extern int rl_arg_sign;
  55 extern int rl_visible_prompt_length;
  56 extern int readline_echoing_p;
  57 extern int rl_key_sequence_length;
  58
  59 /* display.c */
  60 extern int rl_display_fixed;
  61
  62 /* parens.c */
  63 extern int rl_blink_matching_paren;
  64
  65 /*************************************************************************
  66  *                                                                       *
  67  * Global functions and variables unsed and undocumented                 *
  68  *                                                                       *
  69  *************************************************************************/
  70
  71 /* bind.c */
  72 extern char *rl_untranslate_keyseq __P((int));
  73
  74 /* kill.c */
  75 extern int rl_set_retained_kills __P((int));
  76
  77 /* readline.c */
  78 extern int rl_discard_argument __P((void));
  79
  80 /* rltty.c */
  81 extern int rl_stop_output __P((int, int));
  82
  83 /* terminal.c */
  84 extern void _rl_set_screen_size __P((int, int));
  85
  86 /* undo.c */
  87 extern int _rl_fix_last_undo_of_type __P((int, int, int));
  88
  89 /* util.c */
  90 extern char *_rl_savestring __P((const char *));
  91
  92 /*************************************************************************
  93  *                                                                       *
  94  * Functions and variables private to the readline library               *
  95  *                                                                       *
  96  *************************************************************************/
  97
  98 /* NOTE: Functions and variables prefixed with `_rl_' are
  99    pseudo-global: they are global so they can be shared
 100    between files in the readline library, but are not intended
 101    to be visible to readline callers. */
 102
 103 /*************************************************************************
 104  * Undocumented private functions                                        *
 105  *************************************************************************/
 106
 107 #if defined(READLINE_CALLBACKS)
 108
 109 /* readline.c */
 110 extern void readline_internal_setup __P((void));
 111 extern char *readline_internal_teardown __P((int));
 112 extern int readline_internal_char __P((void));
 113
 114 #endif /* READLINE_CALLBACKS */
 115
 116 /* bind.c */
 117 extern void _rl_bind_if_unbound __P((const char *, rl_command_func_t *));
 118
 119 /* display.c */
 120 extern char *_rl_strip_prompt __P((char *));
 121 extern void _rl_move_cursor_relative __P((int, const char *));
 122 extern void _rl_move_vert __P((int));
 123 extern void _rl_save_prompt __P((void));
 124 extern void _rl_restore_prompt __P((void));
 125 extern char *_rl_make_prompt_for_search __P((int));
 126 extern void _rl_erase_at_end_of_line __P((int));
 127 extern void _rl_clear_to_eol __P((int));
 128 extern void _rl_clear_screen __P((void));
 129 extern void _rl_update_final __P((void));
 130 extern void _rl_redisplay_after_sigwinch __P((void));
 131 extern void _rl_clean_up_for_exit __P((void));
 132 extern void _rl_erase_entire_line __P((void));
 133 extern int _rl_current_display_line __P((void));
 134
 135 /* input.c */
 136 extern int _rl_any_typein __P((void));
 137 extern int _rl_input_available __P((void));
 138 extern void _rl_insert_typein __P((int));
 139
 140 /* macro.c */
 141 extern void _rl_with_macro_input __P((char *));
 142 extern int _rl_next_macro_key __P((void));
 143 extern void _rl_push_executing_macro __P((void));
 144 extern void _rl_pop_executing_macro __P((void));
 145 extern void _rl_add_macro_char __P((int));
 146 extern void _rl_kill_kbd_macro __P((void));
 147
 148 /* nls.c */
 149 extern int _rl_init_eightbit __P((void));
 150
 151 /* parens.c */
 152 extern void _rl_enable_paren_matching __P((int));
 153
 154 /* readline.c */
 155 extern void _rl_init_line_state __P((void));
 156 extern void _rl_set_the_line __P((void));
 157 extern int _rl_dispatch __P((int, Keymap));
 158 extern int _rl_init_argument __P((void));
 159 extern void _rl_fix_point __P((int));
 160 extern void _rl_replace_text __P((const char *, int, int));
 161 extern int _rl_char_search_internal __P((int, int, int));
 162 extern int _rl_set_mark_at_pos __P((int));
 163 extern int _rl_free_saved_history_line __P((void));
 164
 165 /* rltty.c */
 166 extern int _rl_disable_tty_signals __P((void));
 167 extern int _rl_restore_tty_signals __P((void));
 168
 169 /* terminal.c */
 170 extern void _rl_get_screen_size __P((int, int));
 171 extern int _rl_init_terminal_io __P((const char *));
 172 #ifdef _MINIX
 173 extern void _rl_output_character_function __P((int));
 174 #else
 175 extern int _rl_output_character_function __P((int));
 176 #endif
 177 extern void _rl_output_some_chars __P((const char *, int));
 178 extern int _rl_backspace __P((int));
 179 extern void _rl_enable_meta_key __P((void));
 180 extern void _rl_control_keypad __P((int));
 181
 182 /* util.c */
 183 extern int rl_alphabetic __P((int));
 184 extern int _rl_abort_internal __P((void));
 185 extern char *_rl_strindex __P((const char *, const char *));
 186 extern char *_rl_strpbrk __P((const char *, const char *));
 187 extern int _rl_qsort_string_compare __P((char **, char **));
 188 extern int (_rl_uppercase_p) __P((int));
 189 extern int (_rl_lowercase_p) __P((int));
 190 extern int (_rl_pure_alphabetic) __P((int));
 191 extern int (_rl_digit_p) __P((int));
 192 extern int (_rl_to_lower) __P((int));
 193 extern int (_rl_to_upper) __P((int));
 194 extern int (_rl_digit_value) __P((int));
 195
 196 /* vi_mode.c */
 197 extern void _rl_vi_initialize_line __P((void));
 198 extern void _rl_vi_reset_last __P((void));
 199 extern void _rl_vi_set_last __P((int, int, int));
 200 extern int _rl_vi_textmod_command __P((int));
 201 extern void _rl_vi_done_inserting __P((void));
 202
 203 /*************************************************************************
 204  * Undocumented private variables                                        *
 205  *************************************************************************/
 206
 207 /* bind.c */
 208 extern const char *_rl_possible_control_prefixes[];
 209 extern const char *_rl_possible_meta_prefixes[];
 210
 211 /* complete.c */
 212 extern int _rl_complete_show_all;
 213 extern int _rl_complete_mark_directories;
 214 extern int _rl_print_completions_horizontally;
 215 extern int _rl_completion_case_fold;
 216
 217 /* display.c */
 218 extern int _rl_vis_botlin;
 219 extern int _rl_last_c_pos;
 220 extern int _rl_suppress_redisplay;
 221 extern char *rl_display_prompt;
 222
 223 /* isearch.c */
 224 extern unsigned char *_rl_isearch_terminators;
 225
 226 /* macro.c */
 227 extern int _rl_defining_kbd_macro;
 228 extern char *_rl_executing_macro;
 229
 230 /* readline.c */
 231 extern int _rl_horizontal_scroll_mode;
 232 extern int _rl_mark_modified_lines;
 233 extern int _rl_bell_preference;
 234 extern int _rl_meta_flag;
 235 extern int _rl_convert_meta_chars_to_ascii;
 236 extern int _rl_output_meta_chars;
 237 extern char *_rl_comment_begin;
 238 extern unsigned char _rl_parsing_conditionalized_out;
 239 extern Keymap _rl_keymap;
 240 extern FILE *_rl_in_stream;
 241 extern FILE *_rl_out_stream;
 242 extern int _rl_last_command_was_kill;
 243 extern int _rl_eof_char;
 244 extern procenv_t readline_top_level;
 245
 246 /* terminal.c */
 247 extern int _rl_enable_keypad;
 248 extern int _rl_enable_meta;
 249 extern char *_rl_term_clreol;
 250 extern char *_rl_term_clrpag;
 251 extern char *_rl_term_im;
 252 extern char *_rl_term_ic;
 253 extern char *_rl_term_ei;
 254 extern char *_rl_term_DC;
 255 extern char *_rl_term_up;
 256 extern char *_rl_term_dc;
 257 extern char *_rl_term_cr;
 258 extern char *_rl_term_IC;
 259 extern int _rl_screenheight;
 260 extern int _rl_screenwidth;
 261 extern int _rl_screenchars;
 262 extern int _rl_terminal_can_insert;
 263 extern int _rl_term_autowrap;
 264
 265 /* undo.c */
 266 extern int _rl_doing_an_undo;
 267 extern int _rl_undo_group_level;
 268
 269 #endif /* _RL_PRIVATE_H_ */