Imported from ../bash-2.0.tar.gz.
[platform/upstream/bash.git] / lib / readline / readline.h
index b397177..4f7d498 100644 (file)
 #  include <readline/tilde.h>
 #endif
 
-/* The functions for manipulating the text of the line within readline.
-Most of these functions are bound to keys by default. */
+/* 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. */
+extern UNDO_LIST *rl_undo_list;
+
+/* The data structure for mapping textual names to code addresses. */
+typedef struct _funmap {
+  char *name;
+  Function *function;
+} FUNMAP;
+
+extern FUNMAP **funmap;
+
+/* Functions available to bind to key sequences. */
 extern int
-  rl_tilde_expand (),
+  rl_tilde_expand (), rl_set_mark (), rl_exchange_point_and_mark (),
   rl_beg_of_line (), rl_backward (), rl_delete (), rl_end_of_line (),
-  rl_forward (), ding (), rl_backward (), rl_newline (), rl_kill_line (),
+  rl_forward (), ding (), rl_newline (), rl_kill_line (),
+  rl_copy_region_to_kill (), rl_kill_region (), rl_char_search (),
   rl_clear_screen (), rl_get_next_history (), rl_get_previous_history (),
   rl_quoted_insert (), rl_reverse_search_history (), rl_transpose_chars (),
-  rl_unix_line_discard (), rl_quoted_insert (), rl_unix_word_rubout (),
+  rl_unix_line_discard (), rl_unix_word_rubout (),
   rl_yank (), rl_rubout (), rl_backward_word (), rl_kill_word (),
   rl_forward_word (), rl_tab_insert (), rl_yank_pop (), rl_yank_nth_arg (),
   rl_backward_kill_word (), rl_backward_kill_line (), rl_transpose_words (),
@@ -49,28 +78,21 @@ extern int
   rl_undo_command (), rl_revert_line (), rl_beginning_of_history (),
   rl_end_of_history (), rl_forward_search_history (), rl_insert (),
   rl_upcase_word (), rl_downcase_word (), rl_capitalize_word (),
-  rl_restart_output (), rl_re_read_init_file (), rl_dump_functions (),
+  rl_restart_output (), rl_re_read_init_file (),
+  rl_dump_functions (), rl_dump_variables (), rl_dump_macros (),
   rl_delete_horizontal_space (), rl_history_search_forward (),
-  rl_history_search_backward (), rl_tty_status (), rl_yank_last_arg ();
-
-/* `Public' utility functions. */
-extern int rl_insert_text (), rl_delete_text (), rl_kill_text ();
-extern int rl_complete_internal ();
-extern int rl_expand_prompt ();
-extern int rl_initialize ();
-extern int rl_set_signals (), rl_clear_signals ();
-extern int rl_init_argument (), rl_digit_argument ();
-extern int rl_read_key (), rl_getc (), rl_stuff_char ();
-extern int maybe_save_line (), maybe_unsave_line (), maybe_replace_line ();
-extern int rl_modifying ();
-
-extern int rl_begin_undo_group (), rl_end_undo_group ();
-extern void rl_add_undo (), free_undo_list ();
-extern int rl_do_undo ();
+  rl_history_search_backward (), rl_tty_status (), rl_yank_last_arg (),
+  rl_insert_comment (), rl_backward_char_search (),
+  rl_copy_forward_word (), rl_copy_backward_word ();
 
 /* Not available unless readline is compiled -DPAREN_MATCHING. */
 extern int rl_insert_close ();
 
+/* Not available unless READLINE_CALLBACKS is defined. */
+extern void rl_callback_handler_install ();
+extern void rl_callback_read_char ();
+extern void rl_callback_handler_remove ();
+
 /* These are *both* defined even when VI_MODE is not. */
 extern int rl_vi_editing_mode (), rl_emacs_editing_mode ();
 
@@ -82,11 +104,11 @@ extern int
 /* Things for vi mode. Not available unless readline is compiled -DVI_MODE. */
 extern int rl_vi_check (), rl_vi_textmod_command ();
 extern int
-  rl_vi_redo (), rl_vi_tilde_expand (),
+  rl_vi_undo (), rl_vi_redo (), rl_vi_tilde_expand (),
   rl_vi_movement_mode (), rl_vi_insertion_mode (), rl_vi_arg_digit (),
   rl_vi_prev_word (), rl_vi_next_word (), rl_vi_char_search (),
   rl_vi_eof_maybe (), rl_vi_append_mode (), rl_vi_put (),
-  rl_vi_append_eol (), rl_vi_insert_beg (), rl_vi_delete (), rl_vi_comment (),
+  rl_vi_append_eol (), rl_vi_insert_beg (), rl_vi_delete (),
   rl_vi_first_print (), rl_vi_fword (), rl_vi_fWord (), rl_vi_bword (),
   rl_vi_bWord (), rl_vi_eword (), rl_vi_eWord (), rl_vi_end_word (),
   rl_vi_change_case (), rl_vi_match (), rl_vi_bracktype (),
@@ -94,40 +116,112 @@ extern int
   rl_vi_search_again (),  rl_vi_subst (), rl_vi_overstrike (),
   rl_vi_overstrike_delete (), rl_vi_replace(), rl_vi_column (),
   rl_vi_delete_to (), rl_vi_change_to (), rl_vi_yank_to (),
-  rl_vi_complete (), rl_vi_fetch_history ();
+  rl_vi_complete (), rl_vi_fetch_history (), rl_vi_set_mark (),
+  rl_vi_goto_mark (), rl_vi_back_to_indent ();
 
 /* Keyboard macro commands. */
 extern int rl_start_kbd_macro (), rl_end_kbd_macro ();
 extern int rl_call_last_kbd_macro ();
+extern void rl_push_macro_input ();
 
 extern int rl_arrow_keys(), rl_refresh_line ();
 
-/* Maintaining the state of undo.  We remember individual deletes and inserts
-   on a chain of things to do. */
+/* **************************************************************** */
+/*                                                                 */
+/*                     Well Published Functions                    */
+/*                                                                 */
+/* **************************************************************** */
 
-/* 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 };
+/* Readline functions. */
+/* Read a line of input.  Prompt with PROMPT.  A NULL PROMPT means none. */
+extern char *readline ();
 
-/* 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;
+/* These functions are from bind.c. */
+/* rl_add_defun (char *name, Function *function, int key)
+   Add NAME to the list of named functions.  Make FUNCTION
+   be the function that gets called.
+   If KEY is not -1, then bind it. */
+extern int rl_add_defun ();
 
-/* The current undo list for RL_LINE_BUFFER. */
-extern UNDO_LIST *rl_undo_list;
+extern Keymap rl_make_bare_keymap ();
+extern Keymap rl_copy_keymap ();
+extern Keymap rl_make_keymap ();
+extern void rl_discard_keymap ();
+extern Keymap rl_get_keymap (), rl_get_keymap_by_name ();
+extern void rl_set_keymap ();
+extern char *rl_get_keymap_name ();
 
-/* The data structure for mapping textual names to code addresses. */
-typedef struct {
-  char *name;
-  Function *function;
-} FUNMAP;
+extern int rl_bind_key (), rl_bind_key_in_map ();
+extern int rl_unbind_key (), rl_unbind_key_in_map ();
+extern int rl_set_key ();
+extern int rl_generic_bind ();
+extern int rl_parse_and_bind ();
+/* Backwards compatibility, use rl_generic_bind instead. */
+extern int rl_macro_bind (), rl_variable_bind ();
 
-extern FUNMAP **funmap;
+extern int rl_read_init_file ();
+
+extern Function *rl_named_function (), *rl_function_of_keyseq ();
+extern char **rl_invoking_keyseqs (), **rl_invoking_keyseqs_in_map ();
+extern void rl_function_dumper ();
+extern void rl_variable_dumper ();
+extern void rl_macro_dumper ();
+extern void rl_list_funmap_names ();
+
+/* Undocumented in the texinfo manual; not really useful to programs. */
+extern int rl_translate_keyseq ();
+extern void rl_initialize_funmap ();
+
+/* Functions for undoing. */
+extern int rl_begin_undo_group (), rl_end_undo_group ();
+extern void rl_add_undo (), free_undo_list ();
+extern int rl_do_undo ();
+extern int rl_modifying ();
+
+/* Functions for redisplay. */
+extern void rl_redisplay ();
+extern int rl_forced_update_display ();
+extern int rl_clear_message ();
+extern int rl_reset_line_state ();
+extern int rl_on_new_line ();
+
+#if defined (__STDC__) && defined (USE_VARARGS) && defined (PREFER_STDARG)
+extern int rl_message (const char *, ...);
+#else
+extern int rl_message ();
+#endif
+
+/* Undocumented in texinfo manual. */
+extern int rl_character_len ();
+extern int rl_show_char ();
+extern int crlf ();
+
+/* Modifying text. */
+extern int rl_insert_text (), rl_delete_text ();
+extern int rl_kill_text ();
+extern char *rl_copy_text ();
+
+/* `Public' utility functions. */
+extern int rl_reset_terminal ();
+extern int rl_stuff_char ();
+extern int rl_read_key (), rl_getc ();
+
+extern int rl_initialize ();
+
+/* Undocumented. */
+extern int rl_expand_prompt ();
+extern int rl_set_signals (), rl_clear_signals ();
+extern int maybe_save_line (), maybe_unsave_line (), maybe_replace_line ();
+
+/* Completion functions. */
+/* These functions are from complete.c. */
+extern int rl_complete_internal ();
+
+/* Return an array of strings which are the result of repeatadly calling
+   FUNC with TEXT. */
+extern char **completion_matches ();
+extern char *username_completion_function ();
+extern char *filename_completion_function ();
 
 /* **************************************************************** */
 /*                                                                 */
@@ -135,6 +229,9 @@ extern FUNMAP **funmap;
 /*                                                                 */
 /* **************************************************************** */
 
+/* The version of this incarnation of the readline library. */
+extern char *rl_library_version;
+
 /* The name of the calling program.  You should initialize this to
    whatever was in argv[0].  It is used when parsing conditionals. */
 extern char *rl_readline_name;
@@ -145,33 +242,36 @@ extern char *rl_line_buffer;
 /* The location of point, and end. */
 extern int rl_point, rl_end;
 
+extern int rl_mark;
+
+extern int rl_done;
+
+extern int rl_pending_input;
+
 /* The name of the terminal to use. */
 extern char *rl_terminal_name;
 
 /* The input and output streams. */
 extern FILE *rl_instream, *rl_outstream;
 
-/* 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\"\\'`@$>". */
-extern char *rl_basic_word_break_characters;
+/* If non-zero, then this is the address of a function to call just
+   before readline_internal () prints the first prompt. */
+extern Function *rl_startup_hook;
 
-/* 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.  */
-extern char *rl_completer_word_break_characters;
+/* The address of a function to call periodically while Readline is
+   awaiting character input, or NULL, for no event handling. */
+extern Function *rl_event_hook;
 
-/* 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. */
-extern char *rl_completer_quote_characters;
+extern Function *rl_getc_function;
+extern VFunction *rl_redisplay_function;
+extern VFunction *rl_prep_term_function;
+extern VFunction *rl_deprep_term_function;
 
-/* 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. */
-extern char *rl_special_prefixes;
+/* Dispatch variables. */
+extern Keymap rl_executing_keymap;
+extern Keymap rl_binding_keymap;
 
+/* Completion variables. */
 /* Pointer to the generator function for completion_matches ().
    NULL means to use filename_entry_function (), the default filename
    completer. */
@@ -194,9 +294,32 @@ extern Function *rl_ignore_some_completions_function;
    array of strings returned. */
 extern CPPFunction *rl_attempted_completion_function;
 
-/* If non-zero, then this is the address of a function to call just
-   before readline_internal () prints the first prompt. */
-extern Function *rl_startup_hook;
+/* 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\"\\'`@$>". */
+extern 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.  */
+extern 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. */
+extern char *rl_completer_quote_characters;
+
+/* List of quote characters which cause a word break. */
+extern char *rl_basic_quote_characters;
+
+/* List of characters that need to be quoted in filenames by the completer. */
+extern 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. */
+extern 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
@@ -206,14 +329,6 @@ extern Function *rl_directory_completion_hook;
 /* Backwards compatibility with previous versions of readline. */
 #define rl_symbolic_link_hook rl_directory_completion_hook
 
-/* The address of a function to call periodically while Readline is
-   awaiting character input, or NULL, for no event handling. */
-extern Function *rl_event_hook;
-
-/* Non-zero means that modified history lines are preceded
-   with an asterisk. */
-extern int rl_show_star;
-
 /* 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. */
@@ -226,62 +341,49 @@ extern int rl_filename_completion_desired;
    entry finder function. */
 extern int rl_filename_quoting_desired;
 
-/* Non-zero means to suppress normal filename completion after the
-   user-specified completion function has been called. */
-extern int rl_attempted_completion_over;
-
-/* **************************************************************** */
-/*                                                                 */
-/*                     Well Published Functions                    */
-/*                                                                 */
-/* **************************************************************** */
+/* 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. */
+extern CPFunction *rl_filename_quoting_function;
 
-/* Read a line of input.  Prompt with PROMPT.  A NULL PROMPT means none. */
-extern char *readline ();
+/* 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. */
+extern CPFunction *rl_filename_dequoting_function;
 
-/* These functions are from complete.c. */
-/* Return an array of strings which are the result of repeatadly calling
-   FUNC with TEXT. */
-extern char **completion_matches ();
-extern char *username_completion_function ();
-extern char *filename_completion_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. */
+extern Function *rl_char_is_quoted_p;
 
-/* These functions are from bind.c. */
-/* rl_add_defun (char *name, Function *function, int key)
-   Add NAME to the list of named functions.  Make FUNCTION
-   be the function that gets called.
-   If KEY is not -1, then bind it. */
-extern int rl_add_defun ();
-extern int rl_bind_key (), rl_bind_key_in_map ();
-extern int rl_unbind_key (), rl_unbind_key_in_map ();
-extern int rl_set_key ();
-extern int rl_macro_bind (), rl_generic_bind (), rl_variable_bind ();
-extern int rl_translate_keyseq ();
-extern Function *rl_named_function (), *rl_function_of_keyseq ();
-extern int rl_parse_and_bind ();
-extern Keymap rl_get_keymap (), rl_get_keymap_by_name ();
-extern void rl_set_keymap ();
-extern char **rl_invoking_keyseqs (), **rl_invoking_keyseqs_in_map ();
-extern void rl_function_dumper ();
-extern int rl_read_init_file ();
+/* Non-zero means to suppress normal filename completion after the
+   user-specified completion function has been called. */
+extern int rl_attempted_completion_over;
 
-/* Functions in funmap.c */
-extern void rl_list_funmap_names ();
-extern void rl_initialize_funmap ();
+/* Set to a character describing the type of completion being attempted by
+   rl_complete_internal; available for use by application completion
+   functions. */
+extern int rl_completion_type;
 
-/* Functions in display.c */
-extern void rl_redisplay ();
-extern int rl_message (), rl_clear_message ();
-extern int rl_reset_line_state ();
-extern int rl_character_len ();
-extern int rl_show_char ();
-extern int crlf (), rl_on_new_line ();
-extern int rl_forced_update_display ();
+/* Character appended to completed words when at the end of the line.  The
+   default is a space.  Nothing is added if this is '\0'. */
+extern int rl_completion_append_character;
 
+/* If this is non-zero, completion is (temporarily) inhibited, and the
+   completion character will be inserted as any other. */
+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
+
 #if !defined (savestring)
 extern char *savestring ();    /* XXX backwards compatibility */
 #endif