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 extern int rl_byte_oriented;
  56
  57 /* display.c */
  58 extern int rl_display_fixed;
  59
  60 /* parens.c */
  61 extern int rl_blink_matching_paren;
  62
  63 /*************************************************************************
  64  *                                                                       *
  65  * Global functions and variables unsed and undocumented                 *
  66  *                                                                       *
  67  *************************************************************************/
  68
  69 /* kill.c */
  70 extern int rl_set_retained_kills PARAMS((int));
  71
  72 /* terminal.c */
  73 extern void _rl_set_screen_size PARAMS((int, int));
  74
  75 /* undo.c */
  76 extern int _rl_fix_last_undo_of_type PARAMS((int, int, int));
  77
  78 /* util.c */
  79 extern char *_rl_savestring PARAMS((const char *));
  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 */
  99 extern void readline_internal_setup PARAMS((void));
 100 extern char *readline_internal_teardown PARAMS((int));
 101 extern int readline_internal_char PARAMS((void));
 102
 103 #endif /* READLINE_CALLBACKS */
 104
 105 /* bind.c */
 106 extern void _rl_bind_if_unbound PARAMS((const char *, rl_command_func_t *));
 107
 108 /* complete.c */
 109 extern char _rl_find_completion_word PARAMS((int *, int *));
 110 extern void _rl_free_match_list PARAMS((char **));
 111
 112 /* display.c */
 113 extern char *_rl_strip_prompt PARAMS((char *));
 114 extern void _rl_move_cursor_relative PARAMS((int, const char *));
 115 extern void _rl_move_vert PARAMS((int));
 116 extern void _rl_save_prompt PARAMS((void));
 117 extern void _rl_restore_prompt PARAMS((void));
 118 extern char *_rl_make_prompt_for_search PARAMS((int));
 119 extern void _rl_erase_at_end_of_line PARAMS((int));
 120 extern void _rl_clear_to_eol PARAMS((int));
 121 extern void _rl_clear_screen PARAMS((void));
 122 extern void _rl_update_final PARAMS((void));
 123 extern void _rl_redisplay_after_sigwinch PARAMS((void));
 124 extern void _rl_clean_up_for_exit PARAMS((void));
 125 extern void _rl_erase_entire_line PARAMS((void));
 126 extern int _rl_current_display_line PARAMS((void));
 127
 128 /* input.c */
 129 extern int _rl_any_typein PARAMS((void));
 130 extern int _rl_input_available PARAMS((void));
 131 extern int _rl_input_queued PARAMS((int));
 132 extern void _rl_insert_typein PARAMS((int));
 133 extern int _rl_unget_char PARAMS((int));
 134
 135 /* macro.c */
 136 extern void _rl_with_macro_input PARAMS((char *));
 137 extern int _rl_next_macro_key PARAMS((void));
 138 extern void _rl_push_executing_macro PARAMS((void));
 139 extern void _rl_pop_executing_macro PARAMS((void));
 140 extern void _rl_add_macro_char PARAMS((int));
 141 extern void _rl_kill_kbd_macro PARAMS((void));
 142
 143 /* misc.c */
 144 extern int _rl_init_argument PARAMS((void));
 145 extern void _rl_start_using_history PARAMS((void));
 146 extern int _rl_free_saved_history_line PARAMS((void));
 147 extern void _rl_set_insert_mode PARAMS((int, int));
 148
 149 /* nls.c */
 150 extern int _rl_init_eightbit PARAMS((void));
 151
 152 /* parens.c */
 153 extern void _rl_enable_paren_matching PARAMS((int));
 154
 155 /* readline.c */
 156 extern void _rl_init_line_state PARAMS((void));
 157 extern void _rl_set_the_line PARAMS((void));
 158 extern int _rl_dispatch PARAMS((int, Keymap));
 159 extern int _rl_dispatch_subseq PARAMS((int, Keymap, int));
 160
 161 /* rltty.c */
 162 extern int _rl_disable_tty_signals PARAMS((void));
 163 extern int _rl_restore_tty_signals PARAMS((void));
 164
 165 /* terminal.c */
 166 extern void _rl_get_screen_size PARAMS((int, int));
 167 extern int _rl_init_terminal_io PARAMS((const char *));
 168 #ifdef _MINIX
 169 extern void _rl_output_character_function PARAMS((int));
 170 #else
 171 extern int _rl_output_character_function PARAMS((int));
 172 #endif
 173 extern void _rl_output_some_chars PARAMS((const char *, int));
 174 extern int _rl_backspace PARAMS((int));
 175 extern void _rl_enable_meta_key PARAMS((void));
 176 extern void _rl_control_keypad PARAMS((int));
 177 extern void _rl_set_cursor PARAMS((int, int));
 178
 179 /* text.c */
 180 extern void _rl_fix_point PARAMS((int));
 181 extern int _rl_replace_text PARAMS((const char *, int, int));
 182 extern int _rl_insert_char PARAMS((int, int));
 183 extern int _rl_overwrite_char PARAMS((int, int));
 184 extern int _rl_overwrite_rubout PARAMS((int, int));
 185 extern int _rl_rubout_char PARAMS((int, int));
 186 #if defined (HANDLE_MULTIBYTE)
 187 extern int _rl_char_search_internal PARAMS((int, int, char *, int));
 188 #else
 189 extern int _rl_char_search_internal PARAMS((int, int, int));
 190 #endif
 191 extern int _rl_set_mark_at_pos PARAMS((int));
 192
 193 /* util.c */
 194 extern int _rl_abort_internal PARAMS((void));
 195 extern char *_rl_strindex PARAMS((const char *, const char *));
 196 extern int _rl_qsort_string_compare PARAMS((char **, char **));
 197 extern int (_rl_uppercase_p) PARAMS((int));
 198 extern int (_rl_lowercase_p) PARAMS((int));
 199 extern int (_rl_pure_alphabetic) PARAMS((int));
 200 extern int (_rl_digit_p) PARAMS((int));
 201 extern int (_rl_to_lower) PARAMS((int));
 202 extern int (_rl_to_upper) PARAMS((int));
 203 extern int (_rl_digit_value) PARAMS((int));
 204
 205 /* vi_mode.c */
 206 extern void _rl_vi_initialize_line PARAMS((void));
 207 extern void _rl_vi_reset_last PARAMS((void));
 208 extern void _rl_vi_set_last PARAMS((int, int, int));
 209 extern int _rl_vi_textmod_command PARAMS((int));
 210 extern void _rl_vi_done_inserting PARAMS((void));
 211
 212 /*************************************************************************
 213  * Undocumented private variables                                        *
 214  *************************************************************************/
 215
 216 /* bind.c */
 217 extern const char *_rl_possible_control_prefixes[];
 218 extern const char *_rl_possible_meta_prefixes[];
 219
 220 /* complete.c */
 221 extern int _rl_complete_show_all;
 222 extern int _rl_complete_mark_directories;
 223 extern int _rl_complete_mark_symlink_dirs;
 224 extern int _rl_print_completions_horizontally;
 225 extern int _rl_completion_case_fold;
 226 extern int _rl_match_hidden_files;
 227 extern int _rl_page_completions;
 228
 229 /* display.c */
 230 extern int _rl_vis_botlin;
 231 extern int _rl_last_c_pos;
 232 extern int _rl_suppress_redisplay;
 233 extern char *rl_display_prompt;
 234
 235 /* isearch.c */
 236 extern char *_rl_isearch_terminators;
 237
 238 /* macro.c */
 239 extern char *_rl_executing_macro;
 240
 241 /* misc.c */
 242 extern int _rl_history_preserve_point;
 243 extern int _rl_history_saved_point;
 244
 245 /* readline.c */
 246 extern int _rl_horizontal_scroll_mode;
 247 extern int _rl_mark_modified_lines;
 248 extern int _rl_bell_preference;
 249 extern int _rl_meta_flag;
 250 extern int _rl_convert_meta_chars_to_ascii;
 251 extern int _rl_output_meta_chars;
 252 extern char *_rl_comment_begin;
 253 extern unsigned char _rl_parsing_conditionalized_out;
 254 extern Keymap _rl_keymap;
 255 extern FILE *_rl_in_stream;
 256 extern FILE *_rl_out_stream;
 257 extern int _rl_last_command_was_kill;
 258 extern int _rl_eof_char;
 259 extern procenv_t readline_top_level;
 260
 261 /* terminal.c */
 262 extern int _rl_enable_keypad;
 263 extern int _rl_enable_meta;
 264 extern char *_rl_term_clreol;
 265 extern char *_rl_term_clrpag;
 266 extern char *_rl_term_im;
 267 extern char *_rl_term_ic;
 268 extern char *_rl_term_ei;
 269 extern char *_rl_term_DC;
 270 extern char *_rl_term_up;
 271 extern char *_rl_term_dc;
 272 extern char *_rl_term_cr;
 273 extern char *_rl_term_IC;
 274 extern int _rl_screenheight;
 275 extern int _rl_screenwidth;
 276 extern int _rl_screenchars;
 277 extern int _rl_terminal_can_insert;
 278 extern int _rl_term_autowrap;
 279
 280 /* undo.c */
 281 extern int _rl_doing_an_undo;
 282 extern int _rl_undo_group_level;
 283
 284 #endif /* _RL_PRIVATE_H_ */