path: root/MSVC/readline/readline.h

/* Readline.h -- the names of functions callable from within readline. */

/* Copyright (C) 1987, 1989, 1992 Free Software Foundation, Inc.

   This file is part of the GNU Readline Library, a library for
   reading lines of text with interactive input and history editing.

   The GNU Readline Library is free software; you can redistribute it
   and/or modify it under the terms of the GNU General Public License
   as published by the Free Software Foundation; either version 2, or
   (at your option) any later version.

   The GNU Readline Library is distributed in the hope that it will be
   useful, but WITHOUT ANY WARRANTY; without even the implied warranty
   of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   The GNU General Public License is often shipped with GNU software, and
   is generally kept in a file called COPYING or LICENSE.  If you do not
   have a copy of the license, write to the Free Software Foundation,
   59 Temple Place, Suite 330, Boston, MA 02111 USA. */

#if !defined (_READLINE_H_)
#define _READLINE_H_

#ifdef __cplusplus
extern "C" {
#endif

#if defined (READLINE_LIBRARY)
#  include "rlstdc.h"
#  include "rltypedefs.h"
#  include "keymaps.h"
#  include "tilde.h"
#else
#  include <readline/rlstdc.h>
#  include <readline/rltypedefs.h>
#  include <readline/keymaps.h>
#  include <readline/tilde.h>
#endif

/* Hex-encoded Readline version number. */
#define RL_READLINE_VERSION	0x0403		/* Readline 4.3 */
#define RL_VERSION_MAJOR	4
#define RL_VERSION_MINOR	3

#include "rldynlink.h"		/* for export / import macros  */

/* Readline data structures. */

/* Maintaining the state of undo.  We remember individual deletes and inserts
   on a chain of things to do. */

/* The actions that undo knows how to undo.  Notice that UNDO_DELETE means
   to insert some text, and UNDO_INSERT means to delete some text.   I.e.,
   the code tells undo what to undo, not how to undo it. */
enum undo_code { UNDO_DELETE, UNDO_INSERT, UNDO_BEGIN, UNDO_END };

/* What an element of THE_UNDO_LIST looks like. */
typedef struct undo_list {
  struct undo_list *next;
  int start, end;		/* Where the change took place. */
  char *text;			/* The text to insert, if undoing a delete. */
  enum undo_code what;		/* Delete, Insert, Begin, End. */
} UNDO_LIST;

/* The current undo list for RL_LINE_BUFFER. */
RL_EXTERN UNDO_LIST *rl_undo_list;

/* The data structure for mapping textual names to code addresses. */
typedef struct _funmap {
  const char *name;
  rl_command_func_t *function;
} FUNMAP;

RL_EXTERN FUNMAP **funmap;

/* **************************************************************** */
/*								    */
/*	     Functions available to bind to key sequences	    */
/*								    */
/* **************************************************************** */

/* Bindable commands for numeric arguments. */
RL_EXTERN int rl_digit_argument PARAMS((int, int));
RL_EXTERN int rl_universal_argument PARAMS((int, int));

/* Bindable commands for moving the cursor. */
RL_EXTERN int rl_forward_byte PARAMS((int, int));
RL_EXTERN int rl_forward_char PARAMS((int, int));
RL_EXTERN int rl_forward PARAMS((int, int));
RL_EXTERN int rl_backward_byte PARAMS((int, int));
RL_EXTERN int rl_backward_char PARAMS((int, int));
RL_EXTERN int rl_backward PARAMS((int, int));
RL_EXTERN int rl_beg_of_line PARAMS((int, int));
RL_EXTERN int rl_end_of_line PARAMS((int, int));
RL_EXTERN int rl_forward_word PARAMS((int, int));
RL_EXTERN int rl_backward_word PARAMS((int, int));
RL_EXTERN int rl_refresh_line PARAMS((int, int));
RL_EXTERN int rl_clear_screen PARAMS((int, int));
RL_EXTERN int rl_arrow_keys PARAMS((int, int));

/* Bindable commands for inserting and deleting text. */
RL_EXTERN int rl_insert PARAMS((int, int));
RL_EXTERN int rl_quoted_insert PARAMS((int, int));
RL_EXTERN int rl_tab_insert PARAMS((int, int));
RL_EXTERN int rl_newline PARAMS((int, int));
RL_EXTERN int rl_do_lowercase_version PARAMS((int, int));
RL_EXTERN int rl_rubout PARAMS((int, int));
RL_EXTERN int rl_delete PARAMS((int, int));
RL_EXTERN int rl_rubout_or_delete PARAMS((int, int));
RL_EXTERN int rl_delete_horizontal_space PARAMS((int, int));
RL_EXTERN int rl_delete_or_show_completions PARAMS((int, int));
RL_EXTERN int rl_insert_comment PARAMS((int, int));

/* Bindable commands for changing case. */
RL_EXTERN int rl_upcase_word PARAMS((int, int));
RL_EXTERN int rl_downcase_word PARAMS((int, int));
RL_EXTERN int rl_capitalize_word PARAMS((int, int));

/* Bindable commands for transposing characters and words. */
RL_EXTERN int rl_transpose_words PARAMS((int, int));
RL_EXTERN int rl_transpose_chars PARAMS((int, int));

/* Bindable commands for searching within a line. */
RL_EXTERN int rl_char_search PARAMS((int, int));
RL_EXTERN int rl_backward_char_search PARAMS((int, int));

/* Bindable commands for readline's interface to the command history. */
RL_EXTERN int rl_beginning_of_history PARAMS((int, int));
RL_EXTERN int rl_end_of_history PARAMS((int, int));
RL_EXTERN int rl_get_next_history PARAMS((int, int));
RL_EXTERN int rl_get_previous_history PARAMS((int, int));

/* Bindable commands for managing the mark and region. */
RL_EXTERN int rl_set_mark PARAMS((int, int));
RL_EXTERN int rl_exchange_point_and_mark PARAMS((int, int));

/* Bindable commands to set the editing mode (emacs or vi). */
RL_EXTERN int rl_vi_editing_mode PARAMS((int, int));
RL_EXTERN int rl_emacs_editing_mode PARAMS((int, int));

/* Bindable commands to change the insert mode (insert or overwrite) */
RL_EXTERN int rl_overwrite_mode PARAMS((int, int));

/* Bindable commands for managing key bindings. */
RL_EXTERN int rl_re_read_init_file PARAMS((int, int));
RL_EXTERN int rl_dump_functions PARAMS((int, int));
RL_EXTERN int rl_dump_macros PARAMS((int, int));
RL_EXTERN int rl_dump_variables PARAMS((int, int));

/* Bindable commands for word completion. */
RL_EXTERN int rl_complete PARAMS((int, int));
RL_EXTERN int rl_possible_completions PARAMS((int, int));
RL_EXTERN int rl_insert_completions PARAMS((int, int));
RL_EXTERN int rl_menu_complete PARAMS((int, int));

/* Bindable commands for killing and yanking text, and managing the kill ring. */
RL_EXTERN int rl_kill_word PARAMS((int, int));
RL_EXTERN int rl_backward_kill_word PARAMS((int, int));
RL_EXTERN int rl_kill_line PARAMS((int, int));
RL_EXTERN int rl_backward_kill_line PARAMS((int, int));
RL_EXTERN int rl_kill_full_line PARAMS((int, int));
RL_EXTERN int rl_unix_word_rubout PARAMS((int, int));
RL_EXTERN int rl_unix_line_discard PARAMS((int, int));
RL_EXTERN int rl_copy_region_to_kill PARAMS((int, int));
RL_EXTERN int rl_kill_region PARAMS((int, int));
RL_EXTERN int rl_copy_forward_word PARAMS((int, int));
RL_EXTERN int rl_copy_backward_word PARAMS((int, int));
RL_EXTERN int rl_yank PARAMS((int, int));
RL_EXTERN int rl_yank_pop PARAMS((int, int));
RL_EXTERN int rl_yank_nth_arg PARAMS((int, int));
RL_EXTERN int rl_yank_last_arg PARAMS((int, int));
/* Not available unless __CYGWIN__ is defined. */
#if defined __CYGWIN__ || defined _WIN32
RL_EXTERN int rl_paste_from_clipboard PARAMS((int, int));
#endif

/* Bindable commands for incremental searching. */
RL_EXTERN int rl_reverse_search_history PARAMS((int, int));
RL_EXTERN int rl_forward_search_history PARAMS((int, int));

/* Bindable keyboard macro commands. */
RL_EXTERN int rl_start_kbd_macro PARAMS((int, int));
RL_EXTERN int rl_end_kbd_macro PARAMS((int, int));
RL_EXTERN int rl_call_last_kbd_macro PARAMS((int, int));

/* Bindable undo commands. */
RL_EXTERN int rl_revert_line PARAMS((int, int));
RL_EXTERN int rl_undo_command PARAMS((int, int));

/* Bindable tilde expansion commands. */
RL_EXTERN int rl_tilde_expand PARAMS((int, int));

/* Bindable terminal control commands. */
RL_EXTERN int rl_restart_output PARAMS((int, int));
RL_EXTERN int rl_stop_output PARAMS((int, int));

/* Miscellaneous bindable commands. */
RL_EXTERN int rl_abort PARAMS((int, int));
RL_EXTERN int rl_tty_status PARAMS((int, int));

/* Bindable commands for incremental and non-incremental history searching. */
RL_EXTERN int rl_history_search_forward PARAMS((int, int));
RL_EXTERN int rl_history_search_backward PARAMS((int, int));
RL_EXTERN int rl_noninc_forward_search PARAMS((int, int));
RL_EXTERN int rl_noninc_reverse_search PARAMS((int, int));
RL_EXTERN int rl_noninc_forward_search_again PARAMS((int, int));
RL_EXTERN int rl_noninc_reverse_search_again PARAMS((int, int));

/* Bindable command used when inserting a matching close character. */
RL_EXTERN int rl_insert_close PARAMS((int, int));

/* Not available unless READLINE_CALLBACKS is defined. */
RL_EXTERN void rl_callback_handler_install PARAMS((const char *, rl_vcpfunc_t *));
RL_EXTERN void rl_callback_read_char PARAMS((void));
RL_EXTERN void rl_callback_handler_remove PARAMS((void));

/* Things for vi mode. Not available unless readline is compiled -DVI_MODE. */
/* VI-mode bindable commands. */
RL_EXTERN int rl_vi_redo PARAMS((int, int));
RL_EXTERN int rl_vi_undo PARAMS((int, int));
RL_EXTERN int rl_vi_yank_arg PARAMS((int, int));
RL_EXTERN int rl_vi_fetch_history PARAMS((int, int));
RL_EXTERN int rl_vi_search_again PARAMS((int, int));
RL_EXTERN int rl_vi_search PARAMS((int, int));
RL_EXTERN int rl_vi_complete PARAMS((int, int));
RL_EXTERN int rl_vi_tilde_expand PARAMS((int, int));
RL_EXTERN int rl_vi_prev_word PARAMS((int, int));
RL_EXTERN int rl_vi_next_word PARAMS((int, int));
RL_EXTERN int rl_vi_end_word PARAMS((int, int));
RL_EXTERN int rl_vi_insert_beg PARAMS((int, int));
RL_EXTERN int rl_vi_append_mode PARAMS((int, int));
RL_EXTERN int rl_vi_append_eol PARAMS((int, int));
RL_EXTERN int rl_vi_eof_maybe PARAMS((int, int));
RL_EXTERN int rl_vi_insertion_mode PARAMS((int, int));
RL_EXTERN int rl_vi_movement_mode PARAMS((int, int));
RL_EXTERN int rl_vi_arg_digit PARAMS((int, int));
RL_EXTERN int rl_vi_change_case PARAMS((int, int));
RL_EXTERN int rl_vi_put PARAMS((int, int));
RL_EXTERN int rl_vi_column PARAMS((int, int));
RL_EXTERN int rl_vi_delete_to PARAMS((int, int));
RL_EXTERN int rl_vi_change_to PARAMS((int, int));
RL_EXTERN int rl_vi_yank_to PARAMS((int, int));
RL_EXTERN int rl_vi_delete PARAMS((int, int));
RL_EXTERN int rl_vi_back_to_indent PARAMS((int, int));
RL_EXTERN int rl_vi_first_print PARAMS((int, int));
RL_EXTERN int rl_vi_char_search PARAMS((int, int));
RL_EXTERN int rl_vi_match PARAMS((int, int));
RL_EXTERN int rl_vi_change_char PARAMS((int, int));
RL_EXTERN int rl_vi_subst PARAMS((int, int));
RL_EXTERN int rl_vi_overstrike PARAMS((int, int));
RL_EXTERN int rl_vi_overstrike_delete PARAMS((int, int));
RL_EXTERN int rl_vi_replace PARAMS((int, int));
RL_EXTERN int rl_vi_set_mark PARAMS((int, int));
RL_EXTERN int rl_vi_goto_mark PARAMS((int, int));

/* VI-mode utility functions. */
RL_EXTERN int rl_vi_check PARAMS((void));
RL_EXTERN int rl_vi_domove PARAMS((int, int *));
RL_EXTERN int rl_vi_bracktype PARAMS((int));

/* VI-mode pseudo-bindable commands, used as utility functions. */
RL_EXTERN int rl_vi_fWord PARAMS((int, int));
RL_EXTERN int rl_vi_bWord PARAMS((int, int));
RL_EXTERN int rl_vi_eWord PARAMS((int, int));
RL_EXTERN int rl_vi_fword PARAMS((int, int));
RL_EXTERN int rl_vi_bword PARAMS((int, int));
RL_EXTERN int rl_vi_eword PARAMS((int, int));

/* **************************************************************** */
/*								    */
/*			Well Published Functions		    */
/*								    */
/* **************************************************************** */

/* Readline functions. */
/* Read a line of input.  Prompt with PROMPT.  A NULL PROMPT means none. */
RL_EXTERN char *readline PARAMS((const char *));

RL_EXTERN int rl_set_prompt PARAMS((const char *));
RL_EXTERN int rl_expand_prompt PARAMS((char *));

RL_EXTERN int rl_initialize PARAMS((void));

/* Undocumented; unused by readline */
RL_EXTERN int rl_discard_argument PARAMS((void));

/* Utility functions to bind keys to readline commands. */
RL_EXTERN int rl_add_defun PARAMS((const char *, rl_command_func_t *, int));
RL_EXTERN int rl_bind_key PARAMS((int, rl_command_func_t *));
RL_EXTERN int rl_bind_key_in_map PARAMS((int, rl_command_func_t *, Keymap));
RL_EXTERN int rl_unbind_key PARAMS((int));
RL_EXTERN int rl_unbind_key_in_map PARAMS((int, Keymap));
RL_EXTERN int rl_unbind_function_in_map PARAMS((rl_command_func_t *, Keymap));
RL_EXTERN int rl_unbind_command_in_map PARAMS((const char *, Keymap));
RL_EXTERN int rl_set_key PARAMS((const char *, rl_command_func_t *, Keymap));
RL_EXTERN int rl_generic_bind PARAMS((int, const char *, char *, Keymap));
RL_EXTERN int rl_variable_bind PARAMS((const char *, const char *));

/* Backwards compatibility, use rl_generic_bind instead. */
RL_EXTERN int rl_macro_bind PARAMS((const char *, const char *, Keymap));

/* Undocumented in the texinfo manual; not really useful to programs. */
RL_EXTERN int rl_translate_keyseq PARAMS((const char *, char *, int *));
RL_EXTERN char *rl_untranslate_keyseq PARAMS((int));

RL_EXTERN rl_command_func_t *rl_named_function PARAMS((const char *));
RL_EXTERN rl_command_func_t *rl_function_of_keyseq PARAMS((const char *, Keymap, int *));

RL_EXTERN void rl_list_funmap_names PARAMS((void));
RL_EXTERN char **rl_invoking_keyseqs_in_map PARAMS((rl_command_func_t *, Keymap));
RL_EXTERN char **rl_invoking_keyseqs PARAMS((rl_command_func_t *));
 
RL_EXTERN void rl_function_dumper PARAMS((int));
RL_EXTERN void rl_macro_dumper PARAMS((int));
RL_EXTERN void rl_variable_dumper PARAMS((int));

RL_EXTERN int rl_read_init_file PARAMS((const char *));
RL_EXTERN int rl_parse_and_bind PARAMS((char *));

/* Functions for manipulating keymaps. */
RL_EXTERN Keymap rl_make_bare_keymap PARAMS((void));
RL_EXTERN Keymap rl_copy_keymap PARAMS((Keymap));
RL_EXTERN Keymap rl_make_keymap PARAMS((void));
RL_EXTERN void rl_discard_keymap PARAMS((Keymap));

RL_EXTERN Keymap rl_get_keymap_by_name PARAMS((const char *));
RL_EXTERN char *rl_get_keymap_name PARAMS((Keymap));
RL_EXTERN void rl_set_keymap PARAMS((Keymap));
RL_EXTERN Keymap rl_get_keymap PARAMS((void));
/* Undocumented; used internally only. */
RL_EXTERN void rl_set_keymap_from_edit_mode PARAMS((void));
RL_EXTERN char *rl_get_keymap_name_from_edit_mode PARAMS((void));

/* Functions for manipulating the funmap, which maps command names to functions. */
RL_EXTERN int rl_add_funmap_entry PARAMS((const char *, rl_command_func_t *));
RL_EXTERN const char **rl_funmap_names PARAMS((void));
/* Undocumented, only used internally -- there is only one funmap, and this
   function may be called only once. */
RL_EXTERN void rl_initialize_funmap PARAMS((void));

/* Utility functions for managing keyboard macros. */
RL_EXTERN void rl_push_macro_input PARAMS((char *));

/* Functions for undoing, from undo.c */
RL_EXTERN void rl_add_undo PARAMS((enum undo_code, int, int, char *));
RL_EXTERN void rl_free_undo_list PARAMS((void));
RL_EXTERN int rl_do_undo PARAMS((void));
RL_EXTERN int rl_begin_undo_group PARAMS((void));
RL_EXTERN int rl_end_undo_group PARAMS((void));
RL_EXTERN int rl_modifying PARAMS((int, int));

/* Functions for redisplay. */
RL_EXTERN void rl_redisplay PARAMS((void));
RL_EXTERN int rl_on_new_line PARAMS((void));
RL_EXTERN int rl_on_new_line_with_prompt PARAMS((void));
RL_EXTERN int rl_forced_update_display PARAMS((void));
RL_EXTERN int rl_clear_message PARAMS((void));
RL_EXTERN int rl_reset_line_state PARAMS((void));
RL_EXTERN int rl_crlf PARAMS((void));

#if (defined (__STDC__) || defined (__cplusplus)) && defined (USE_VARARGS) && defined (PREFER_STDARG)
RL_EXTERN int rl_message (const char *, ...)  __attribute__((__format__ (printf, 1, 2)));
#else
RL_EXTERN int rl_message ();
#endif

RL_EXTERN int rl_show_char PARAMS((int));

/* Undocumented in texinfo manual. */
RL_EXTERN int rl_character_len PARAMS((int, int));

/* Save and restore internal prompt redisplay information. */
RL_EXTERN void rl_save_prompt PARAMS((void));
RL_EXTERN void rl_restore_prompt PARAMS((void));

/* Modifying text. */
RL_EXTERN void rl_replace_line PARAMS((const char *, int));
RL_EXTERN int rl_insert_text PARAMS((const char *));
RL_EXTERN int rl_delete_text PARAMS((int, int));
RL_EXTERN int rl_kill_text PARAMS((int, int));
RL_EXTERN char *rl_copy_text PARAMS((int, int));

/* Terminal and tty mode management. */
RL_EXTERN void rl_prep_terminal PARAMS((int));
RL_EXTERN void rl_deprep_terminal PARAMS((void));
RL_EXTERN void rl_tty_set_default_bindings PARAMS((Keymap));

RL_EXTERN int rl_reset_terminal PARAMS((const char *));
RL_EXTERN void rl_resize_terminal PARAMS((void));
RL_EXTERN void rl_set_screen_size PARAMS((int, int));
RL_EXTERN void rl_get_screen_size PARAMS((int *, int *));

RL_EXTERN char *rl_get_termcap PARAMS((const char *));

/* Functions for character input. */
RL_EXTERN int rl_stuff_char PARAMS((int));
RL_EXTERN int rl_execute_next PARAMS((int));
RL_EXTERN int rl_clear_pending_input PARAMS((void));
RL_EXTERN int rl_read_key PARAMS((void));
RL_EXTERN int rl_getc PARAMS((FILE *));
RL_EXTERN int rl_set_keyboard_input_timeout PARAMS((int));

/* `Public' utility functions . */
RL_EXTERN void rl_extend_line_buffer PARAMS((int));
RL_EXTERN int rl_ding PARAMS((void));
RL_EXTERN int rl_alphabetic PARAMS((int));

/* Readline signal handling, from signals.c */
RL_EXTERN int rl_set_signals PARAMS((void));
RL_EXTERN int rl_clear_signals PARAMS((void));
RL_EXTERN void rl_cleanup_after_signal PARAMS((void));
RL_EXTERN void rl_reset_after_signal PARAMS((void));
RL_EXTERN void rl_free_line_state PARAMS((void));
 
RL_EXTERN int rl_set_paren_blink_timeout PARAMS((int));

/* Undocumented. */
RL_EXTERN int rl_maybe_save_line PARAMS((void));
RL_EXTERN int rl_maybe_unsave_line PARAMS((void));
RL_EXTERN int rl_maybe_replace_line PARAMS((void));

/* Completion functions. */
RL_EXTERN int rl_complete_internal PARAMS((int));
RL_EXTERN void rl_display_match_list PARAMS((char **, int, int));

RL_EXTERN char **rl_completion_matches PARAMS((const char *, rl_compentry_func_t *));
RL_EXTERN char *rl_username_completion_function PARAMS((const char *, int));
RL_EXTERN char *rl_filename_completion_function PARAMS((const char *, int));

RL_EXTERN int rl_completion_mode PARAMS((rl_command_func_t *));

#if 0
/* Backwards compatibility (compat.c).  These will go away sometime. */
RL_EXTERN void free_undo_list PARAMS((void));
RL_EXTERN int maybe_save_line PARAMS((void));
RL_EXTERN int maybe_unsave_line PARAMS((void));
RL_EXTERN int maybe_replace_line PARAMS((void));

RL_EXTERN int ding PARAMS((void));
RL_EXTERN int alphabetic PARAMS((int));
RL_EXTERN int crlf PARAMS((void));

RL_EXTERN char **completion_matches PARAMS((char *, rl_compentry_func_t *));
RL_EXTERN char *username_completion_function PARAMS((const char *, int));
RL_EXTERN char *filename_completion_function PARAMS((const char *, int));
#endif

/* **************************************************************** */
/*								    */
/*			Well Published Variables		    */
/*								    */
/* **************************************************************** */

/* The version of this incarnation of the readline library. */
RL_EXTERN const char *rl_library_version;		/* e.g., "4.2" */
RL_EXTERN int rl_readline_version;			/* e.g., 0x0402 */

/* True if this is real GNU readline. */
RL_EXTERN int rl_gnu_readline_p;

/* Flags word encapsulating the current readline state. */
RL_EXTERN int rl_readline_state;

/* Says which editing mode readline is currently using.  1 means emacs mode;
   0 means vi mode. */
RL_EXTERN int rl_editing_mode;

/* Insert or overwrite mode for emacs mode.  1 means insert mode; 0 means
   overwrite mode.  Reset to insert mode on each input line. */
RL_EXTERN int rl_insert_mode;

/* The name of the calling program.  You should initialize this to
   whatever was in argv[0].  It is used when parsing conditionals. */
RL_EXTERN const char *rl_readline_name;

/* The prompt readline uses.  This is set from the argument to
   readline (), and should not be assigned to directly. */
RL_EXTERN char *rl_prompt;

/* The line buffer that is in use. */
RL_EXTERN char *rl_line_buffer;

/* The location of point, and end. */
RL_EXTERN int rl_point;
RL_EXTERN int rl_end;

/* The mark, or saved cursor position. */
RL_EXTERN int rl_mark;

/* Flag to indicate that readline has finished with the current input
   line and should return it. */
RL_EXTERN int rl_done;

/* If set to a character value, that will be the next keystroke read. */
RL_EXTERN int rl_pending_input;

/* Non-zero if we called this function from _rl_dispatch().  It's present
   so functions can find out whether they were called from a key binding
   or directly from an application. */
RL_EXTERN int rl_dispatching;

/* Non-zero if the user typed a numeric argument before executing the
   current function. */
RL_EXTERN int rl_explicit_arg;

/* The current value of the numeric argument specified by the user. */
RL_EXTERN int rl_numeric_arg;

/* The address of the last command function Readline executed. */
RL_EXTERN rl_command_func_t *rl_last_func;

/* The name of the terminal to use. */
RL_EXTERN const char *rl_terminal_name;

/* The input and output streams. */
RL_EXTERN FILE *rl_instream;
RL_EXTERN FILE *rl_outstream;

/* If non-zero, then this is the address of a function to call just
   before readline_internal () prints the first prompt. */
RL_EXTERN rl_hook_func_t *rl_startup_hook;

/* If non-zero, this is the address of a function to call just before
   readline_internal_setup () returns and readline_internal starts
   reading input characters. */
RL_EXTERN rl_hook_func_t *rl_pre_input_hook;
      
/* The address of a function to call periodically while Readline is
   awaiting character input, or NULL, for no event handling. */
RL_EXTERN rl_hook_func_t *rl_event_hook;

/* The address of the function to call to fetch a character from the current
   Readline input stream */
RL_EXTERN rl_getc_func_t *rl_getc_function;

RL_EXTERN rl_voidfunc_t *rl_redisplay_function;

RL_EXTERN rl_vintfunc_t *rl_prep_term_function;
RL_EXTERN rl_voidfunc_t *rl_deprep_term_function;

/* Dispatch variables. */
RL_EXTERN Keymap rl_executing_keymap;
RL_EXTERN Keymap rl_binding_keymap;

/* Display variables. */
/* If non-zero, readline will erase the entire line, including any prompt,
   if the only thing typed on an otherwise-blank line is something bound to
   rl_newline. */
RL_EXTERN int rl_erase_empty_line;

/* If non-zero, the application has already printed the prompt (rl_prompt)
   before calling readline, so readline should not output it the first time
   redisplay is done. */
RL_EXTERN int rl_already_prompted;

/* A non-zero value means to read only this many characters rather than
   up to a character bound to accept-line. */
RL_EXTERN int rl_num_chars_to_read;

/* The text of a currently-executing keyboard macro. */
RL_EXTERN char *rl_executing_macro;

/* Variables to control readline signal handling. */
/* If non-zero, readline will install its own signal handlers for
   SIGINT, SIGTERM, SIGQUIT, SIGALRM, SIGTSTP, SIGTTIN, and SIGTTOU. */
RL_EXTERN int rl_catch_signals;

/* If non-zero, readline will install a signal handler for SIGWINCH
   that also attempts to call any calling application's SIGWINCH signal
   handler.  Note that the terminal is not cleaned up before the
   application's signal handler is called; use rl_cleanup_after_signal()
   to do that. */
RL_EXTERN int rl_catch_sigwinch;

/* Completion variables. */
/* Pointer to the generator function for completion_matches ().
   NULL means to use rl_filename_completion_function (), the default
   filename completer. */
RL_EXTERN rl_compentry_func_t *rl_completion_entry_function;

/* If rl_ignore_some_completions_function is non-NULL it is the address
   of a function to call after all of the possible matches have been
   generated, but before the actual completion is done to the input line.
   The function is called with one argument; a NULL terminated array
   of (char *).  If your function removes any of the elements, they
   must be free()'ed. */
RL_EXTERN rl_compignore_func_t *rl_ignore_some_completions_function;

/* Pointer to alternative function to create matches.
   Function is called with TEXT, START, and END.
   START and END are indices in RL_LINE_BUFFER saying what the boundaries
   of TEXT are.
   If this function exists and returns NULL then call the value of
   rl_completion_entry_function to try to match, otherwise use the
   array of strings returned. */
RL_EXTERN rl_completion_func_t *rl_attempted_completion_function;

/* The basic list of characters that signal a break between words for the
   completer routine.  The initial contents of this variable is what
   breaks words in the shell, i.e. "n\"\\'`@$>". */
RL_EXTERN const char *rl_basic_word_break_characters;

/* The list of characters that signal a break between words for
   rl_complete_internal.  The default list is the contents of
   rl_basic_word_break_characters.  */
RL_EXTERN const char *rl_completer_word_break_characters;

/* List of characters which can be used to quote a substring of the line.
   Completion occurs on the entire substring, and within the substring   
   rl_completer_word_break_characters are treated as any other character,
   unless they also appear within this list. */
RL_EXTERN const char *rl_completer_quote_characters;

/* List of quote characters which cause a word break. */
RL_EXTERN const char *rl_basic_quote_characters;

/* List of characters that need to be quoted in filenames by the completer. */
RL_EXTERN const char *rl_filename_quote_characters;

/* List of characters that are word break characters, but should be left
   in TEXT when it is passed to the completion function.  The shell uses
   this to help determine what kind of completing to do. */
RL_EXTERN const char *rl_special_prefixes;

/* If non-zero, then this is the address of a function to call when
   completing on a directory name.  The function is called with
   the address of a string (the current directory name) as an arg.  It
   changes what is displayed when the possible completions are printed
   or inserted. */
RL_EXTERN rl_icppfunc_t *rl_directory_completion_hook;

/* If non-zero, this is the address of a function to call when completing
   a directory name.  This function takes the address of the directory name
   to be modified as an argument.  Unlike rl_directory_completion_hook, it
   only modifies the directory name used in opendir(2), not what is displayed
   when the possible completions are printed or inserted.  It is called
   before rl_directory_completion_hook.  I'm not happy with how this works
   yet, so it's undocumented. */
RL_EXTERN rl_icppfunc_t *rl_directory_rewrite_hook;

/* Backwards compatibility with previous versions of readline. */
#define rl_symbolic_link_hook rl_directory_completion_hook

/* If non-zero, then this is the address of a function to call when
   completing a word would normally display the list of possible matches.
   This function is called instead of actually doing the display.
   It takes three arguments: (char **matches, int num_matches, int max_length)
   where MATCHES is the array of strings that matched, NUM_MATCHES is the
   number of strings in that array, and MAX_LENGTH is the length of the
   longest string in that array. */
RL_EXTERN rl_compdisp_func_t *rl_completion_display_matches_hook;

/* Non-zero means that the results of the matches are to be treated
   as filenames.  This is ALWAYS zero on entry, and can only be changed
   within a completion entry finder function. */
RL_EXTERN int rl_filename_completion_desired;

/* Non-zero means that the results of the matches are to be quoted using
   double quotes (or an application-specific quoting mechanism) if the
   filename contains any characters in rl_word_break_chars.  This is
   ALWAYS non-zero on entry, and can only be changed within a completion
   entry finder function. */
RL_EXTERN int rl_filename_quoting_desired;

/* Set to a function to quote a filename in an application-specific fashion.
   Called with the text to quote, the type of match found (single or multiple)
   and a pointer to the quoting character to be used, which the function can
   reset if desired. */
RL_EXTERN rl_quote_func_t *rl_filename_quoting_function;

/* Function to call to remove quoting characters from a filename.  Called
   before completion is attempted, so the embedded quotes do not interfere
   with matching names in the file system. */
RL_EXTERN rl_dequote_func_t *rl_filename_dequoting_function;

/* Function to call to decide whether or not a word break character is
   quoted.  If a character is quoted, it does not break words for the
   completer. */
RL_EXTERN rl_linebuf_func_t *rl_char_is_quoted_p;

/* Non-zero means to suppress normal filename completion after the
   user-specified completion function has been called. */
RL_EXTERN int rl_attempted_completion_over;

/* Set to a character describing the type of completion being attempted by
   rl_complete_internal; available for use by application completion
   functions. */
RL_EXTERN int rl_completion_type;

/* Character appended to completed words when at the end of the line.  The
   default is a space.  Nothing is added if this is '\0'. */
RL_EXTERN int rl_completion_append_character;

/* If set to non-zero by an application completion function,
   rl_completion_append_character will not be appended. */
RL_EXTERN int rl_completion_suppress_append;

/* Up to this many items will be displayed in response to a
   possible-completions call.  After that, we ask the user if she
   is sure she wants to see them all.  The default value is 100. */
RL_EXTERN int rl_completion_query_items;

/* If non-zero, a slash will be appended to completed filenames that are
   symbolic links to directory names, subject to the value of the
   mark-directories variable (which is user-settable).  This exists so
   that application completion functions can override the user's preference
   (set via the mark-symlinked-directories variable) if appropriate.
   It's set to the value of _rl_complete_mark_symlink_dirs in
   rl_complete_internal before any application-specific completion
   function is called, so without that function doing anything, the user's
   preferences are honored. */
RL_EXTERN int rl_completion_mark_symlink_dirs;

/* If non-zero, then disallow duplicates in the matches. */
RL_EXTERN int rl_ignore_completion_duplicates;

/* If this is non-zero, completion is (temporarily) inhibited, and the
   completion character will be inserted as any other. */
RL_EXTERN int rl_inhibit_completion;

/* Definitions available for use by readline clients. */
#define RL_PROMPT_START_IGNORE	'\001'
#define RL_PROMPT_END_IGNORE	'\002'

/* Possible values for do_replace argument to rl_filename_quoting_function,
   called by rl_complete_internal. */
#define NO_MATCH        0
#define SINGLE_MATCH    1
#define MULT_MATCH      2

/* Possible state values for rl_readline_state */
#define RL_STATE_NONE		0x00000		/* no state; before first call */

#define RL_STATE_INITIALIZING	0x00001		/* initializing */
#define RL_STATE_INITIALIZED	0x00002		/* initialization done */
#define RL_STATE_TERMPREPPED	0x00004		/* terminal is prepped */
#define RL_STATE_READCMD	0x00008		/* reading a command key */
#define RL_STATE_METANEXT	0x00010		/* reading input after ESC */
#define RL_STATE_DISPATCHING	0x00020		/* dispatching to a command */
#define RL_STATE_MOREINPUT	0x00040		/* reading more input in a command function */
#define RL_STATE_ISEARCH	0x00080		/* doing incremental search */
#define RL_STATE_NSEARCH	0x00100		/* doing non-inc search */
#define RL_STATE_SEARCH		0x00200		/* doing a history search */
#define RL_STATE_NUMERICARG	0x00400		/* reading numeric argument */
#define RL_STATE_MACROINPUT	0x00800		/* getting input from a macro */
#define RL_STATE_MACRODEF	0x01000		/* defining keyboard macro */
#define RL_STATE_OVERWRITE	0x02000		/* overwrite mode */
#define RL_STATE_COMPLETING	0x04000		/* doing completion */
#define RL_STATE_SIGHANDLER	0x08000		/* in readline sighandler */
#define RL_STATE_UNDOING	0x10000		/* doing an undo */
#define RL_STATE_INPUTPENDING	0x20000		/* rl_execute_next called */

#define RL_STATE_DONE		0x80000		/* done; accepted line */

#define RL_SETSTATE(x)		(rl_readline_state |= (x))
#define RL_UNSETSTATE(x)	(rl_readline_state &= ~(x))
#define RL_ISSTATE(x)		(rl_readline_state & (x))

struct readline_state {
  /* line state */
  int point;
  int end;
  int mark;
  char *buffer;
  int buflen;
  UNDO_LIST *ul;
  char *prompt;

  /* global state */
  int rlstate;
  int done;
  Keymap kmap;

  /* input state */
  rl_command_func_t *lastfunc;
  int insmode;
  int edmode;
  int kseqlen;
  FILE *inf;
  FILE *outf;
  int pendingin;
  char *macro;

  /* signal state */
  int catchsigs;
  int catchsigwinch;

  /* reserved for future expansion, so the struct size doesn't change */
  char reserved[64];
};

RL_EXTERN int rl_save_state PARAMS((struct readline_state *));
RL_EXTERN int rl_restore_state PARAMS((struct readline_state *));

#ifdef _MSC_VER
#define __attribute__(x)
#endif

#ifdef __cplusplus
}
#endif

#endif /* _READLINE_H_ */