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