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