The world's most popular open source database
mysql/src/5.1-dbg/include/readline/readline.h
Go to the documentation of this file.00001 /* Readline.h -- the names of functions callable from within readline. */ 00002 00003 /* Copyright (C) 1987-2004 Free Software Foundation, Inc. 00004 00005 This file is part of the GNU Readline Library, a library for 00006 reading lines of text with interactive input and history editing. 00007 00008 The GNU Readline Library is free software; you can redistribute it 00009 and/or modify it under the terms of the GNU General Public License 00010 as published by the Free Software Foundation; either version 2, or 00011 (at your option) any later version. 00012 00013 The GNU Readline Library is distributed in the hope that it will be 00014 useful, but WITHOUT ANY WARRANTY; without even the implied warranty 00015 of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 00016 GNU General Public License for more details. 00017 00018 The GNU General Public License is often shipped with GNU software, and 00019 is generally kept in a file called COPYING or LICENSE. If you do not 00020 have a copy of the license, write to the Free Software Foundation, 00021 59 Temple Place, Suite 330, Boston, MA 02111 USA. */ 00022 00023 #if !defined (_READLINE_H_) 00024 #define _READLINE_H_ 00025 00026 #ifdef __cplusplus 00027 extern "C" { 00028 #endif 00029 00030 #if defined (READLINE_LIBRARY) 00031 # include "rlstdc.h" 00032 # include "rltypedefs.h" 00033 # include "keymaps.h" 00034 # include "tilde.h" 00035 #else 00036 # include <readline/rlstdc.h> 00037 # include <readline/rltypedefs.h> 00038 # include <readline/keymaps.h> 00039 # include <readline/tilde.h> 00040 #endif 00041 00042 /* Hex-encoded Readline version number. */ 00043 #define RL_READLINE_VERSION 0x0500 /* Readline 5.0 */ 00044 #define RL_VERSION_MAJOR 5 00045 #define RL_VERSION_MINOR 0 00046 00047 /* Readline data structures. */ 00048 00049 /* Maintaining the state of undo. We remember individual deletes and inserts 00050 on a chain of things to do. */ 00051 00052 /* The actions that undo knows how to undo. Notice that UNDO_DELETE means 00053 to insert some text, and UNDO_INSERT means to delete some text. I.e., 00054 the code tells undo what to undo, not how to undo it. */ 00055 enum undo_code { UNDO_DELETE, UNDO_INSERT, UNDO_BEGIN, UNDO_END }; 00056 00057 /* What an element of THE_UNDO_LIST looks like. */ 00058 typedef struct undo_list { 00059 struct undo_list *next; 00060 int start, end; /* Where the change took place. */ 00061 char *text; /* The text to insert, if undoing a delete. */ 00062 enum undo_code what; /* Delete, Insert, Begin, End. */ 00063 } UNDO_LIST; 00064 00065 /* The current undo list for RL_LINE_BUFFER. */ 00066 extern UNDO_LIST *rl_undo_list; 00067 00068 /* The data structure for mapping textual names to code addresses. */ 00069 typedef struct _funmap { 00070 const char *name; 00071 rl_command_func_t *function; 00072 } FUNMAP; 00073 00074 extern FUNMAP **funmap; 00075 00076 /* **************************************************************** */ 00077 /* */ 00078 /* Functions available to bind to key sequences */ 00079 /* */ 00080 /* **************************************************************** */ 00081 00082 /* Bindable commands for numeric arguments. */ 00083 extern int rl_digit_argument PARAMS((int, int)); 00084 extern int rl_universal_argument PARAMS((int, int)); 00085 00086 /* Bindable commands for moving the cursor. */ 00087 extern int rl_forward_byte PARAMS((int, int)); 00088 extern int rl_forward_char PARAMS((int, int)); 00089 extern int rl_forward PARAMS((int, int)); 00090 extern int rl_backward_byte PARAMS((int, int)); 00091 extern int rl_backward_char PARAMS((int, int)); 00092 extern int rl_backward PARAMS((int, int)); 00093 extern int rl_beg_of_line PARAMS((int, int)); 00094 extern int rl_end_of_line PARAMS((int, int)); 00095 extern int rl_forward_word PARAMS((int, int)); 00096 extern int rl_backward_word PARAMS((int, int)); 00097 extern int rl_refresh_line PARAMS((int, int)); 00098 extern int rl_clear_screen PARAMS((int, int)); 00099 extern int rl_arrow_keys PARAMS((int, int)); 00100 00101 /* Bindable commands for inserting and deleting text. */ 00102 extern int rl_insert PARAMS((int, int)); 00103 extern int rl_quoted_insert PARAMS((int, int)); 00104 extern int rl_tab_insert PARAMS((int, int)); 00105 extern int rl_newline PARAMS((int, int)); 00106 extern int rl_do_lowercase_version PARAMS((int, int)); 00107 extern int rl_rubout PARAMS((int, int)); 00108 extern int rl_delete PARAMS((int, int)); 00109 extern int rl_rubout_or_delete PARAMS((int, int)); 00110 extern int rl_delete_horizontal_space PARAMS((int, int)); 00111 extern int rl_delete_or_show_completions PARAMS((int, int)); 00112 extern int rl_insert_comment PARAMS((int, int)); 00113 00114 /* Bindable commands for changing case. */ 00115 extern int rl_upcase_word PARAMS((int, int)); 00116 extern int rl_downcase_word PARAMS((int, int)); 00117 extern int rl_capitalize_word PARAMS((int, int)); 00118 00119 /* Bindable commands for transposing characters and words. */ 00120 extern int rl_transpose_words PARAMS((int, int)); 00121 extern int rl_transpose_chars PARAMS((int, int)); 00122 00123 /* Bindable commands for searching within a line. */ 00124 extern int rl_char_search PARAMS((int, int)); 00125 extern int rl_backward_char_search PARAMS((int, int)); 00126 00127 /* Bindable commands for readline's interface to the command history. */ 00128 extern int rl_beginning_of_history PARAMS((int, int)); 00129 extern int rl_end_of_history PARAMS((int, int)); 00130 extern int rl_get_next_history PARAMS((int, int)); 00131 extern int rl_get_previous_history PARAMS((int, int)); 00132 00133 /* Bindable commands for managing the mark and region. */ 00134 extern int rl_set_mark PARAMS((int, int)); 00135 extern int rl_exchange_point_and_mark PARAMS((int, int)); 00136 00137 /* Bindable commands to set the editing mode (emacs or vi). */ 00138 extern int rl_vi_editing_mode PARAMS((int, int)); 00139 extern int rl_emacs_editing_mode PARAMS((int, int)); 00140 00141 /* Bindable commands to change the insert mode (insert or overwrite) */ 00142 extern int rl_overwrite_mode PARAMS((int, int)); 00143 00144 /* Bindable commands for managing key bindings. */ 00145 extern int rl_re_read_init_file PARAMS((int, int)); 00146 extern int rl_dump_functions PARAMS((int, int)); 00147 extern int rl_dump_macros PARAMS((int, int)); 00148 extern int rl_dump_variables PARAMS((int, int)); 00149 00150 /* Bindable commands for word completion. */ 00151 extern int rl_complete PARAMS((int, int)); 00152 extern int rl_possible_completions PARAMS((int, int)); 00153 extern int rl_insert_completions PARAMS((int, int)); 00154 extern int rl_menu_complete PARAMS((int, int)); 00155 00156 /* Bindable commands for killing and yanking text, and managing the kill ring. */ 00157 extern int rl_kill_word PARAMS((int, int)); 00158 extern int rl_backward_kill_word PARAMS((int, int)); 00159 extern int rl_kill_line PARAMS((int, int)); 00160 extern int rl_backward_kill_line PARAMS((int, int)); 00161 extern int rl_kill_full_line PARAMS((int, int)); 00162 extern int rl_unix_word_rubout PARAMS((int, int)); 00163 extern int rl_unix_filename_rubout PARAMS((int, int)); 00164 extern int rl_unix_line_discard PARAMS((int, int)); 00165 extern int rl_copy_region_to_kill PARAMS((int, int)); 00166 extern int rl_kill_region PARAMS((int, int)); 00167 extern int rl_copy_forward_word PARAMS((int, int)); 00168 extern int rl_copy_backward_word PARAMS((int, int)); 00169 extern int rl_yank PARAMS((int, int)); 00170 extern int rl_yank_pop PARAMS((int, int)); 00171 extern int rl_yank_nth_arg PARAMS((int, int)); 00172 extern int rl_yank_last_arg PARAMS((int, int)); 00173 /* Not available unless __CYGWIN__ is defined. */ 00174 #ifdef __CYGWIN__ 00175 extern int rl_paste_from_clipboard PARAMS((int, int)); 00176 #endif 00177 00178 /* Bindable commands for incremental searching. */ 00179 extern int rl_reverse_search_history PARAMS((int, int)); 00180 extern int rl_forward_search_history PARAMS((int, int)); 00181 00182 /* Bindable keyboard macro commands. */ 00183 extern int rl_start_kbd_macro PARAMS((int, int)); 00184 extern int rl_end_kbd_macro PARAMS((int, int)); 00185 extern int rl_call_last_kbd_macro PARAMS((int, int)); 00186 00187 /* Bindable undo commands. */ 00188 extern int rl_revert_line PARAMS((int, int)); 00189 extern int rl_undo_command PARAMS((int, int)); 00190 00191 /* Bindable tilde expansion commands. */ 00192 extern int rl_tilde_expand PARAMS((int, int)); 00193 00194 /* Bindable terminal control commands. */ 00195 extern int rl_restart_output PARAMS((int, int)); 00196 extern int rl_stop_output PARAMS((int, int)); 00197 00198 /* Miscellaneous bindable commands. */ 00199 extern int rl_abort PARAMS((int, int)); 00200 extern int rl_tty_status PARAMS((int, int)); 00201 00202 /* Bindable commands for incremental and non-incremental history searching. */ 00203 extern int rl_history_search_forward PARAMS((int, int)); 00204 extern int rl_history_search_backward PARAMS((int, int)); 00205 extern int rl_noninc_forward_search PARAMS((int, int)); 00206 extern int rl_noninc_reverse_search PARAMS((int, int)); 00207 extern int rl_noninc_forward_search_again PARAMS((int, int)); 00208 extern int rl_noninc_reverse_search_again PARAMS((int, int)); 00209 00210 /* Bindable command used when inserting a matching close character. */ 00211 extern int rl_insert_close PARAMS((int, int)); 00212 00213 /* Not available unless READLINE_CALLBACKS is defined. */ 00214 extern void rl_callback_handler_install PARAMS((const char *, rl_vcpfunc_t *)); 00215 extern void rl_callback_read_char PARAMS((void)); 00216 extern void rl_callback_handler_remove PARAMS((void)); 00217 00218 /* Things for vi mode. Not available unless readline is compiled -DVI_MODE. */ 00219 /* VI-mode bindable commands. */ 00220 extern int rl_vi_redo PARAMS((int, int)); 00221 extern int rl_vi_undo PARAMS((int, int)); 00222 extern int rl_vi_yank_arg PARAMS((int, int)); 00223 extern int rl_vi_fetch_history PARAMS((int, int)); 00224 extern int rl_vi_search_again PARAMS((int, int)); 00225 extern int rl_vi_search PARAMS((int, int)); 00226 extern int rl_vi_complete PARAMS((int, int)); 00227 extern int rl_vi_tilde_expand PARAMS((int, int)); 00228 extern int rl_vi_prev_word PARAMS((int, int)); 00229 extern int rl_vi_next_word PARAMS((int, int)); 00230 extern int rl_vi_end_word PARAMS((int, int)); 00231 extern int rl_vi_insert_beg PARAMS((int, int)); 00232 extern int rl_vi_append_mode PARAMS((int, int)); 00233 extern int rl_vi_append_eol PARAMS((int, int)); 00234 extern int rl_vi_eof_maybe PARAMS((int, int)); 00235 extern int rl_vi_insertion_mode PARAMS((int, int)); 00236 extern int rl_vi_movement_mode PARAMS((int, int)); 00237 extern int rl_vi_arg_digit PARAMS((int, int)); 00238 extern int rl_vi_change_case PARAMS((int, int)); 00239 extern int rl_vi_put PARAMS((int, int)); 00240 extern int rl_vi_column PARAMS((int, int)); 00241 extern int rl_vi_delete_to PARAMS((int, int)); 00242 extern int rl_vi_change_to PARAMS((int, int)); 00243 extern int rl_vi_yank_to PARAMS((int, int)); 00244 extern int rl_vi_delete PARAMS((int, int)); 00245 extern int rl_vi_back_to_indent PARAMS((int, int)); 00246 extern int rl_vi_first_print PARAMS((int, int)); 00247 extern int rl_vi_char_search PARAMS((int, int)); 00248 extern int rl_vi_match PARAMS((int, int)); 00249 extern int rl_vi_change_char PARAMS((int, int)); 00250 extern int rl_vi_subst PARAMS((int, int)); 00251 extern int rl_vi_overstrike PARAMS((int, int)); 00252 extern int rl_vi_overstrike_delete PARAMS((int, int)); 00253 extern int rl_vi_replace PARAMS((int, int)); 00254 extern int rl_vi_set_mark PARAMS((int, int)); 00255 extern int rl_vi_goto_mark PARAMS((int, int)); 00256 00257 /* VI-mode utility functions. */ 00258 extern int rl_vi_check PARAMS((void)); 00259 extern int rl_vi_domove PARAMS((int, int *)); 00260 extern int rl_vi_bracktype PARAMS((int)); 00261 00262 extern void rl_vi_start_inserting PARAMS((int, int, int)); 00263 00264 /* VI-mode pseudo-bindable commands, used as utility functions. */ 00265 extern int rl_vi_fWord PARAMS((int, int)); 00266 extern int rl_vi_bWord PARAMS((int, int)); 00267 extern int rl_vi_eWord PARAMS((int, int)); 00268 extern int rl_vi_fword PARAMS((int, int)); 00269 extern int rl_vi_bword PARAMS((int, int)); 00270 extern int rl_vi_eword PARAMS((int, int)); 00271 00272 /* **************************************************************** */ 00273 /* */ 00274 /* Well Published Functions */ 00275 /* */ 00276 /* **************************************************************** */ 00277 00278 /* Readline functions. */ 00279 /* Read a line of input. Prompt with PROMPT. A NULL PROMPT means none. */ 00280 extern char *readline PARAMS((const char *)); 00281 00282 extern int rl_set_prompt PARAMS((const char *)); 00283 extern int rl_expand_prompt PARAMS((char *)); 00284 00285 extern int rl_initialize PARAMS((void)); 00286 00287 /* Undocumented; unused by readline */ 00288 extern int rl_discard_argument PARAMS((void)); 00289 00290 /* Utility functions to bind keys to readline commands. */ 00291 extern int rl_add_defun PARAMS((const char *, rl_command_func_t *, int)); 00292 extern int rl_bind_key PARAMS((int, rl_command_func_t *)); 00293 extern int rl_bind_key_in_map PARAMS((int, rl_command_func_t *, Keymap)); 00294 extern int rl_unbind_key PARAMS((int)); 00295 extern int rl_unbind_key_in_map PARAMS((int, Keymap)); 00296 extern int rl_bind_key_if_unbound PARAMS((int, rl_command_func_t *)); 00297 extern int rl_bind_key_if_unbound_in_map PARAMS((int, rl_command_func_t *, Keymap)); 00298 extern int rl_unbind_function_in_map PARAMS((rl_command_func_t *, Keymap)); 00299 extern int rl_unbind_command_in_map PARAMS((const char *, Keymap)); 00300 extern int rl_bind_keyseq PARAMS((const char *, rl_command_func_t *)); 00301 extern int rl_bind_keyseq_in_map PARAMS((const char *, rl_command_func_t *, Keymap)); 00302 extern int rl_bind_keyseq_if_unbound PARAMS((const char *, rl_command_func_t *)); 00303 extern int rl_bind_keyseq_if_unbound_in_map PARAMS((const char *, rl_command_func_t *, Keymap)); 00304 extern int rl_generic_bind PARAMS((int, const char *, char *, Keymap)); 00305 extern int rl_variable_bind PARAMS((const char *, const char *)); 00306 00307 /* Backwards compatibility, use rl_bind_keyseq_in_map instead. */ 00308 extern int rl_set_key PARAMS((const char *, rl_command_func_t *, Keymap)); 00309 00310 /* Backwards compatibility, use rl_generic_bind instead. */ 00311 extern int rl_macro_bind PARAMS((const char *, const char *, Keymap)); 00312 00313 /* Undocumented in the texinfo manual; not really useful to programs. */ 00314 extern int rl_translate_keyseq PARAMS((const char *, char *, int *)); 00315 extern char *rl_untranslate_keyseq PARAMS((int)); 00316 00317 extern rl_command_func_t *rl_named_function PARAMS((const char *)); 00318 extern rl_command_func_t *rl_function_of_keyseq PARAMS((const char *, Keymap, int *)); 00319 00320 extern void rl_list_funmap_names PARAMS((void)); 00321 extern char **rl_invoking_keyseqs_in_map PARAMS((rl_command_func_t *, Keymap)); 00322 extern char **rl_invoking_keyseqs PARAMS((rl_command_func_t *)); 00323 00324 extern void rl_function_dumper PARAMS((int)); 00325 extern void rl_macro_dumper PARAMS((int)); 00326 extern void rl_variable_dumper PARAMS((int)); 00327 00328 extern int rl_read_init_file PARAMS((const char *)); 00329 extern int rl_parse_and_bind PARAMS((char *)); 00330 00331 /* Functions for manipulating keymaps. */ 00332 extern Keymap rl_make_bare_keymap PARAMS((void)); 00333 extern Keymap rl_copy_keymap PARAMS((Keymap)); 00334 extern Keymap rl_make_keymap PARAMS((void)); 00335 extern void rl_discard_keymap PARAMS((Keymap)); 00336 00337 extern Keymap rl_get_keymap_by_name PARAMS((const char *)); 00338 extern char *rl_get_keymap_name PARAMS((Keymap)); 00339 extern void rl_set_keymap PARAMS((Keymap)); 00340 extern Keymap rl_get_keymap PARAMS((void)); 00341 /* Undocumented; used internally only. */ 00342 extern void rl_set_keymap_from_edit_mode PARAMS((void)); 00343 extern char *rl_get_keymap_name_from_edit_mode PARAMS((void)); 00344 00345 /* Functions for manipulating the funmap, which maps command names to functions. */ 00346 extern int rl_add_funmap_entry PARAMS((const char *, rl_command_func_t *)); 00347 extern const char **rl_funmap_names PARAMS((void)); 00348 /* Undocumented, only used internally -- there is only one funmap, and this 00349 function may be called only once. */ 00350 extern void rl_initialize_funmap PARAMS((void)); 00351 00352 /* Utility functions for managing keyboard macros. */ 00353 extern void rl_push_macro_input PARAMS((char *)); 00354 00355 /* Functions for undoing, from undo.c */ 00356 extern void rl_add_undo PARAMS((enum undo_code, int, int, char *)); 00357 extern void rl_free_undo_list PARAMS((void)); 00358 extern int rl_do_undo PARAMS((void)); 00359 extern int rl_begin_undo_group PARAMS((void)); 00360 extern int rl_end_undo_group PARAMS((void)); 00361 extern int rl_modifying PARAMS((int, int)); 00362 00363 /* Functions for redisplay. */ 00364 extern void rl_redisplay PARAMS((void)); 00365 extern int rl_on_new_line PARAMS((void)); 00366 extern int rl_on_new_line_with_prompt PARAMS((void)); 00367 extern int rl_forced_update_display PARAMS((void)); 00368 extern int rl_clear_message PARAMS((void)); 00369 extern int rl_reset_line_state PARAMS((void)); 00370 extern int rl_crlf PARAMS((void)); 00371 00372 #if defined (USE_VARARGS) && defined (PREFER_STDARG) 00373 extern int rl_message (const char *, ...) __attribute__((__format__ (printf, 1, 2))); 00374 #else 00375 extern int rl_message (); 00376 #endif 00377 00378 extern int rl_show_char PARAMS((int)); 00379 00380 /* Undocumented in texinfo manual. */ 00381 extern int rl_character_len PARAMS((int, int)); 00382 00383 /* Save and restore internal prompt redisplay information. */ 00384 extern void rl_save_prompt PARAMS((void)); 00385 extern void rl_restore_prompt PARAMS((void)); 00386 00387 /* Modifying text. */ 00388 extern void rl_replace_line PARAMS((const char *, int)); 00389 extern int rl_insert_text PARAMS((const char *)); 00390 extern int rl_delete_text PARAMS((int, int)); 00391 extern int rl_kill_text PARAMS((int, int)); 00392 extern char *rl_copy_text PARAMS((int, int)); 00393 00394 /* Terminal and tty mode management. */ 00395 extern void rl_prep_terminal PARAMS((int)); 00396 extern void rl_deprep_terminal PARAMS((void)); 00397 extern void rl_tty_set_default_bindings PARAMS((Keymap)); 00398 extern void rl_tty_unset_default_bindings PARAMS((Keymap)); 00399 00400 extern int rl_reset_terminal PARAMS((const char *)); 00401 extern void rl_resize_terminal PARAMS((void)); 00402 extern void rl_set_screen_size PARAMS((int, int)); 00403 extern void rl_get_screen_size PARAMS((int *, int *)); 00404 00405 extern char *rl_get_termcap PARAMS((const char *)); 00406 00407 /* Functions for character input. */ 00408 extern int rl_stuff_char PARAMS((int)); 00409 extern int rl_execute_next PARAMS((int)); 00410 extern int rl_clear_pending_input PARAMS((void)); 00411 extern int rl_read_key PARAMS((void)); 00412 extern int rl_getc PARAMS((FILE *)); 00413 extern int rl_set_keyboard_input_timeout PARAMS((int)); 00414 00415 /* `Public' utility functions . */ 00416 extern void rl_extend_line_buffer PARAMS((int)); 00417 extern int rl_ding PARAMS((void)); 00418 extern int rl_alphabetic PARAMS((int)); 00419 00420 /* Readline signal handling, from signals.c */ 00421 extern int rl_set_signals PARAMS((void)); 00422 extern int rl_clear_signals PARAMS((void)); 00423 extern void rl_cleanup_after_signal PARAMS((void)); 00424 extern void rl_reset_after_signal PARAMS((void)); 00425 extern void rl_free_line_state PARAMS((void)); 00426 00427 extern int rl_set_paren_blink_timeout PARAMS((int)); 00428 00429 /* Undocumented. */ 00430 extern int rl_maybe_save_line PARAMS((void)); 00431 extern int rl_maybe_unsave_line PARAMS((void)); 00432 extern int rl_maybe_replace_line PARAMS((void)); 00433 00434 /* Completion functions. */ 00435 extern int rl_complete_internal PARAMS((int)); 00436 extern void rl_display_match_list PARAMS((char **, int, int)); 00437 00438 extern char **rl_completion_matches PARAMS((const char *, rl_compentry_func_t *)); 00439 extern char *rl_username_completion_function PARAMS((const char *, int)); 00440 extern char *rl_filename_completion_function PARAMS((const char *, int)); 00441 00442 extern int rl_completion_mode PARAMS((rl_command_func_t *)); 00443 00444 #if 0 00445 /* Backwards compatibility (compat.c). These will go away sometime. */ 00446 extern void free_undo_list PARAMS((void)); 00447 extern int maybe_save_line PARAMS((void)); 00448 extern int maybe_unsave_line PARAMS((void)); 00449 extern int maybe_replace_line PARAMS((void)); 00450 00451 extern int ding PARAMS((void)); 00452 extern int alphabetic PARAMS((int)); 00453 extern int crlf PARAMS((void)); 00454 00455 extern char **completion_matches PARAMS((char *, rl_compentry_func_t *)); 00456 extern char *username_completion_function PARAMS((const char *, int)); 00457 extern char *filename_completion_function PARAMS((const char *, int)); 00458 #endif 00459 00460 /* **************************************************************** */ 00461 /* */ 00462 /* Well Published Variables */ 00463 /* */ 00464 /* **************************************************************** */ 00465 00466 /* The version of this incarnation of the readline library. */ 00467 extern const char *rl_library_version; /* e.g., "4.2" */ 00468 extern int rl_readline_version; /* e.g., 0x0402 */ 00469 00470 /* True if this is real GNU readline. */ 00471 extern int rl_gnu_readline_p; 00472 00473 /* Flags word encapsulating the current readline state. */ 00474 extern int rl_readline_state; 00475 00476 /* Says which editing mode readline is currently using. 1 means emacs mode; 00477 0 means vi mode. */ 00478 extern int rl_editing_mode; 00479 00480 /* Insert or overwrite mode for emacs mode. 1 means insert mode; 0 means 00481 overwrite mode. Reset to insert mode on each input line. */ 00482 extern int rl_insert_mode; 00483 00484 /* The name of the calling program. You should initialize this to 00485 whatever was in argv[0]. It is used when parsing conditionals. */ 00486 extern const char *rl_readline_name; 00487 00488 /* The prompt readline uses. This is set from the argument to 00489 readline (), and should not be assigned to directly. */ 00490 extern char *rl_prompt; 00491 00492 /* The line buffer that is in use. */ 00493 extern char *rl_line_buffer; 00494 00495 /* The location of point, and end. */ 00496 extern int rl_point; 00497 extern int rl_end; 00498 00499 /* The mark, or saved cursor position. */ 00500 extern int rl_mark; 00501 00502 /* Flag to indicate that readline has finished with the current input 00503 line and should return it. */ 00504 extern int rl_done; 00505 00506 /* If set to a character value, that will be the next keystroke read. */ 00507 extern int rl_pending_input; 00508 00509 /* Non-zero if we called this function from _rl_dispatch(). It's present 00510 so functions can find out whether they were called from a key binding 00511 or directly from an application. */ 00512 extern int rl_dispatching; 00513 00514 /* Non-zero if the user typed a numeric argument before executing the 00515 current function. */ 00516 extern int rl_explicit_arg; 00517 00518 /* The current value of the numeric argument specified by the user. */ 00519 extern int rl_numeric_arg; 00520 00521 /* The address of the last command function Readline executed. */ 00522 extern rl_command_func_t *rl_last_func; 00523 00524 /* The name of the terminal to use. */ 00525 extern const char *rl_terminal_name; 00526 00527 /* The input and output streams. */ 00528 extern FILE *rl_instream; 00529 extern FILE *rl_outstream; 00530 00531 /* If non-zero, then this is the address of a function to call just 00532 before readline_internal () prints the first prompt. */ 00533 extern rl_hook_func_t *rl_startup_hook; 00534 00535 /* If non-zero, this is the address of a function to call just before 00536 readline_internal_setup () returns and readline_internal starts 00537 reading input characters. */ 00538 extern rl_hook_func_t *rl_pre_input_hook; 00539 00540 /* The address of a function to call periodically while Readline is 00541 awaiting character input, or NULL, for no event handling. */ 00542 extern rl_hook_func_t *rl_event_hook; 00543 00544 /* The address of the function to call to fetch a character from the current 00545 Readline input stream */ 00546 extern rl_getc_func_t *rl_getc_function; 00547 00548 extern rl_voidfunc_t *rl_redisplay_function; 00549 00550 extern rl_vintfunc_t *rl_prep_term_function; 00551 extern rl_voidfunc_t *rl_deprep_term_function; 00552 00553 /* Dispatch variables. */ 00554 extern Keymap rl_executing_keymap; 00555 extern Keymap rl_binding_keymap; 00556 00557 /* Display variables. */ 00558 /* If non-zero, readline will erase the entire line, including any prompt, 00559 if the only thing typed on an otherwise-blank line is something bound to 00560 rl_newline. */ 00561 extern int rl_erase_empty_line; 00562 00563 /* If non-zero, the application has already printed the prompt (rl_prompt) 00564 before calling readline, so readline should not output it the first time 00565 redisplay is done. */ 00566 extern int rl_already_prompted; 00567 00568 /* A non-zero value means to read only this many characters rather than 00569 up to a character bound to accept-line. */ 00570 extern int rl_num_chars_to_read; 00571 00572 /* The text of a currently-executing keyboard macro. */ 00573 extern char *rl_executing_macro; 00574 00575 /* Variables to control readline signal handling. */ 00576 /* If non-zero, readline will install its own signal handlers for 00577 SIGINT, SIGTERM, SIGQUIT, SIGALRM, SIGTSTP, SIGTTIN, and SIGTTOU. */ 00578 extern int rl_catch_signals; 00579 00580 /* If non-zero, readline will install a signal handler for SIGWINCH 00581 that also attempts to call any calling application's SIGWINCH signal 00582 handler. Note that the terminal is not cleaned up before the 00583 application's signal handler is called; use rl_cleanup_after_signal() 00584 to do that. */ 00585 extern int rl_catch_sigwinch; 00586 00587 /* Completion variables. */ 00588 /* Pointer to the generator function for completion_matches (). 00589 NULL means to use rl_filename_completion_function (), the default 00590 filename completer. */ 00591 extern rl_compentry_func_t *rl_completion_entry_function; 00592 00593 /* If rl_ignore_some_completions_function is non-NULL it is the address 00594 of a function to call after all of the possible matches have been 00595 generated, but before the actual completion is done to the input line. 00596 The function is called with one argument; a NULL terminated array 00597 of (char *). If your function removes any of the elements, they 00598 must be free()'ed. */ 00599 extern rl_compignore_func_t *rl_ignore_some_completions_function; 00600 00601 /* Pointer to alternative function to create matches. 00602 Function is called with TEXT, START, and END. 00603 START and END are indices in RL_LINE_BUFFER saying what the boundaries 00604 of TEXT are. 00605 If this function exists and returns NULL then call the value of 00606 rl_completion_entry_function to try to match, otherwise use the 00607 array of strings returned. */ 00608 extern rl_completion_func_t *rl_attempted_completion_function; 00609 00610 /* The basic list of characters that signal a break between words for the 00611 completer routine. The initial contents of this variable is what 00612 breaks words in the shell, i.e. "n\"\\'`@$>". */ 00613 extern const char *rl_basic_word_break_characters; 00614 00615 /* The list of characters that signal a break between words for 00616 rl_complete_internal. The default list is the contents of 00617 rl_basic_word_break_characters. */ 00618 extern /*const*/ char *rl_completer_word_break_characters; 00619 00620 /* Hook function to allow an application to set the completion word 00621 break characters before readline breaks up the line. Allows 00622 position-dependent word break characters. */ 00623 extern rl_cpvfunc_t *rl_completion_word_break_hook; 00624 00625 /* List of characters which can be used to quote a substring of the line. 00626 Completion occurs on the entire substring, and within the substring 00627 rl_completer_word_break_characters are treated as any other character, 00628 unless they also appear within this list. */ 00629 extern const char *rl_completer_quote_characters; 00630 00631 /* List of quote characters which cause a word break. */ 00632 extern const char *rl_basic_quote_characters; 00633 00634 /* List of characters that need to be quoted in filenames by the completer. */ 00635 extern const char *rl_filename_quote_characters; 00636 00637 /* List of characters that are word break characters, but should be left 00638 in TEXT when it is passed to the completion function. The shell uses 00639 this to help determine what kind of completing to do. */ 00640 extern const char *rl_special_prefixes; 00641 00642 /* If non-zero, then this is the address of a function to call when 00643 completing on a directory name. The function is called with 00644 the address of a string (the current directory name) as an arg. It 00645 changes what is displayed when the possible completions are printed 00646 or inserted. */ 00647 extern rl_icppfunc_t *rl_directory_completion_hook; 00648 00649 /* If non-zero, this is the address of a function to call when completing 00650 a directory name. This function takes the address of the directory name 00651 to be modified as an argument. Unlike rl_directory_completion_hook, it 00652 only modifies the directory name used in opendir(2), not what is displayed 00653 when the possible completions are printed or inserted. It is called 00654 before rl_directory_completion_hook. I'm not happy with how this works 00655 yet, so it's undocumented. */ 00656 extern rl_icppfunc_t *rl_directory_rewrite_hook; 00657 00658 /* Backwards compatibility with previous versions of readline. */ 00659 #define rl_symbolic_link_hook rl_directory_completion_hook 00660 00661 /* If non-zero, then this is the address of a function to call when 00662 completing a word would normally display the list of possible matches. 00663 This function is called instead of actually doing the display. 00664 It takes three arguments: (char **matches, int num_matches, int max_length) 00665 where MATCHES is the array of strings that matched, NUM_MATCHES is the 00666 number of strings in that array, and MAX_LENGTH is the length of the 00667 longest string in that array. */ 00668 extern rl_compdisp_func_t *rl_completion_display_matches_hook; 00669 00670 /* Non-zero means that the results of the matches are to be treated 00671 as filenames. This is ALWAYS zero on entry, and can only be changed 00672 within a completion entry finder function. */ 00673 extern int rl_filename_completion_desired; 00674 00675 /* Non-zero means that the results of the matches are to be quoted using 00676 double quotes (or an application-specific quoting mechanism) if the 00677 filename contains any characters in rl_word_break_chars. This is 00678 ALWAYS non-zero on entry, and can only be changed within a completion 00679 entry finder function. */ 00680 extern int rl_filename_quoting_desired; 00681 00682 /* Set to a function to quote a filename in an application-specific fashion. 00683 Called with the text to quote, the type of match found (single or multiple) 00684 and a pointer to the quoting character to be used, which the function can 00685 reset if desired. */ 00686 extern rl_quote_func_t *rl_filename_quoting_function; 00687 00688 /* Function to call to remove quoting characters from a filename. Called 00689 before completion is attempted, so the embedded quotes do not interfere 00690 with matching names in the file system. */ 00691 extern rl_dequote_func_t *rl_filename_dequoting_function; 00692 00693 /* Function to call to decide whether or not a word break character is 00694 quoted. If a character is quoted, it does not break words for the 00695 completer. */ 00696 extern rl_linebuf_func_t *rl_char_is_quoted_p; 00697 00698 /* Non-zero means to suppress normal filename completion after the 00699 user-specified completion function has been called. */ 00700 extern int rl_attempted_completion_over; 00701 00702 /* Set to a character describing the type of completion being attempted by 00703 rl_complete_internal; available for use by application completion 00704 functions. */ 00705 extern int rl_completion_type; 00706 00707 /* Up to this many items will be displayed in response to a 00708 possible-completions call. After that, we ask the user if she 00709 is sure she wants to see them all. The default value is 100. */ 00710 extern int rl_completion_query_items; 00711 00712 /* Character appended to completed words when at the end of the line. The 00713 default is a space. Nothing is added if this is '\0'. */ 00714 extern int rl_completion_append_character; 00715 00716 /* If set to non-zero by an application completion function, 00717 rl_completion_append_character will not be appended. */ 00718 extern int rl_completion_suppress_append; 00719 00720 /* Set to any quote character readline thinks it finds before any application 00721 completion function is called. */ 00722 extern int rl_completion_quote_character; 00723 00724 /* Set to a non-zero value if readline found quoting anywhere in the word to 00725 be completed; set before any application completion function is called. */ 00726 extern int rl_completion_found_quote; 00727 00728 /* If non-zero, the completion functions don't append any closing quote. 00729 This is set to 0 by rl_complete_internal and may be changed by an 00730 application-specific completion function. */ 00731 extern int rl_completion_suppress_quote; 00732 00733 /* If non-zero, a slash will be appended to completed filenames that are 00734 symbolic links to directory names, subject to the value of the 00735 mark-directories variable (which is user-settable). This exists so 00736 that application completion functions can override the user's preference 00737 (set via the mark-symlinked-directories variable) if appropriate. 00738 It's set to the value of _rl_complete_mark_symlink_dirs in 00739 rl_complete_internal before any application-specific completion 00740 function is called, so without that function doing anything, the user's 00741 preferences are honored. */ 00742 extern int rl_completion_mark_symlink_dirs; 00743 00744 /* If non-zero, then disallow duplicates in the matches. */ 00745 extern int rl_ignore_completion_duplicates; 00746 00747 /* If this is non-zero, completion is (temporarily) inhibited, and the 00748 completion character will be inserted as any other. */ 00749 extern int rl_inhibit_completion; 00750 00751 /* Definitions available for use by readline clients. */ 00752 #define RL_PROMPT_START_IGNORE '\001' 00753 #define RL_PROMPT_END_IGNORE '\002' 00754 00755 /* Possible values for do_replace argument to rl_filename_quoting_function, 00756 called by rl_complete_internal. */ 00757 #define NO_MATCH 0 00758 #define SINGLE_MATCH 1 00759 #define MULT_MATCH 2 00760 00761 /* Possible state values for rl_readline_state */ 00762 #define RL_STATE_NONE 0x00000 /* no state; before first call */ 00763 00764 #define RL_STATE_INITIALIZING 0x00001 /* initializing */ 00765 #define RL_STATE_INITIALIZED 0x00002 /* initialization done */ 00766 #define RL_STATE_TERMPREPPED 0x00004 /* terminal is prepped */ 00767 #define RL_STATE_READCMD 0x00008 /* reading a command key */ 00768 #define RL_STATE_METANEXT 0x00010 /* reading input after ESC */ 00769 #define RL_STATE_DISPATCHING 0x00020 /* dispatching to a command */ 00770 #define RL_STATE_MOREINPUT 0x00040 /* reading more input in a command function */ 00771 #define RL_STATE_ISEARCH 0x00080 /* doing incremental search */ 00772 #define RL_STATE_NSEARCH 0x00100 /* doing non-inc search */ 00773 #define RL_STATE_SEARCH 0x00200 /* doing a history search */ 00774 #define RL_STATE_NUMERICARG 0x00400 /* reading numeric argument */ 00775 #define RL_STATE_MACROINPUT 0x00800 /* getting input from a macro */ 00776 #define RL_STATE_MACRODEF 0x01000 /* defining keyboard macro */ 00777 #define RL_STATE_OVERWRITE 0x02000 /* overwrite mode */ 00778 #define RL_STATE_COMPLETING 0x04000 /* doing completion */ 00779 #define RL_STATE_SIGHANDLER 0x08000 /* in readline sighandler */ 00780 #define RL_STATE_UNDOING 0x10000 /* doing an undo */ 00781 #define RL_STATE_INPUTPENDING 0x20000 /* rl_execute_next called */ 00782 #define RL_STATE_TTYCSAVED 0x40000 /* tty special chars saved */ 00783 00784 #define RL_STATE_DONE 0x80000 /* done; accepted line */ 00785 00786 #define RL_SETSTATE(x) (rl_readline_state |= (x)) 00787 #define RL_UNSETSTATE(x) (rl_readline_state &= ~(x)) 00788 #define RL_ISSTATE(x) (rl_readline_state & (x)) 00789 00790 struct readline_state { 00791 /* line state */ 00792 int point; 00793 int end; 00794 int mark; 00795 char *buffer; 00796 int buflen; 00797 UNDO_LIST *ul; 00798 char *prompt; 00799 00800 /* global state */ 00801 int rlstate; 00802 int done; 00803 Keymap kmap; 00804 00805 /* input state */ 00806 rl_command_func_t *lastfunc; 00807 int insmode; 00808 int edmode; 00809 int kseqlen; 00810 FILE *inf; 00811 FILE *outf; 00812 int pendingin; 00813 char *macro; 00814 00815 /* signal state */ 00816 int catchsigs; 00817 int catchsigwinch; 00818 00819 /* search state */ 00820 00821 /* completion state */ 00822 00823 /* options state */ 00824 00825 /* reserved for future expansion, so the struct size doesn't change */ 00826 char reserved[64]; 00827 }; 00828 00829 extern int rl_save_state PARAMS((struct readline_state *)); 00830 extern int rl_restore_state PARAMS((struct readline_state *)); 00831 00832 #ifdef __cplusplus 00833 } 00834 #endif 00835 00836 #endif /* _READLINE_H_ */
Generated on Sat Sep 9 00:49:44 2006 for MySQL 5.1 by
1.4.7
© 1995-2008 MySQL AB, 2008- Sun Microsystems, Inc.