]> git.ipfire.org Git - thirdparty/bash.git/blobdiff - lib/readline/readline.h
Imported from ../bash-2.05.tar.gz.
[thirdparty/bash.git] / lib / readline / readline.h
index 97c62fd153490f0e5ce791029ef7c0a6697a1723..d362df1618002c6d3cb24838f3e768ef763d5d29 100644 (file)
@@ -60,8 +60,8 @@ extern UNDO_LIST *rl_undo_list;
 
 /* The data structure for mapping textual names to code addresses. */
 typedef struct _funmap {
-  char *name;
-  Function *function;
+  const char *name;
+  rl_command_func_t *function;
 } FUNMAP;
 
 extern FUNMAP **funmap;
@@ -155,8 +155,8 @@ extern int rl_yank __P((int, int));
 extern int rl_yank_pop __P((int, int));
 extern int rl_yank_nth_arg __P((int, int));
 extern int rl_yank_last_arg __P((int, int));
-/* Not available unless __CYGWIN32__ is defined. */
-#ifdef __CYGWIN32__
+/* Not available unless __CYGWIN__ is defined. */
+#ifdef __CYGWIN__
 extern int rl_paste_from_clipboard __P((int, int));
 #endif
 
@@ -196,7 +196,7 @@ extern int rl_noninc_reverse_search_again __P((int, int));
 extern int rl_insert_close __P((int, int));
 
 /* Not available unless READLINE_CALLBACKS is defined. */
-extern void rl_callback_handler_install __P((char *, VFunction *));
+extern void rl_callback_handler_install __P((const char *, rl_vcpfunc_t *));
 extern void rl_callback_read_char __P((void));
 extern void rl_callback_handler_remove __P((void));
 
@@ -260,43 +260,47 @@ extern int rl_vi_eword __P((int, int));
 
 /* Readline functions. */
 /* Read a line of input.  Prompt with PROMPT.  A NULL PROMPT means none. */
-extern char *readline __P((char *));
+extern char *readline __P((const char *));
+
+extern int rl_set_prompt __P((const char *));
+extern int rl_expand_prompt __P((char *));
 
 extern int rl_initialize __P((void));
 
+/* Undocumented; unused by readline */
 extern int rl_discard_argument __P((void));
 
 /* Utility functions to bind keys to readline commands. */
-extern int rl_add_defun __P((char *, Function *, int));
-extern int rl_bind_key __P((int, Function *));
-extern int rl_bind_key_in_map __P((int, Function *, Keymap));
+extern int rl_add_defun __P((const char *, rl_command_func_t *, int));
+extern int rl_bind_key __P((int, rl_command_func_t *));
+extern int rl_bind_key_in_map __P((int, rl_command_func_t *, Keymap));
 extern int rl_unbind_key __P((int));
 extern int rl_unbind_key_in_map __P((int, Keymap));
-extern int rl_unbind_function_in_map __P((Function *, Keymap));
-extern int rl_unbind_command_in_map __P((char *, Keymap));
-extern int rl_set_key __P((char *, Function *, Keymap));
-extern int rl_generic_bind __P((int, char *, char *, Keymap));
-extern int rl_variable_bind __P((char *, char *));
+extern int rl_unbind_function_in_map __P((rl_command_func_t *, Keymap));
+extern int rl_unbind_command_in_map __P((const char *, Keymap));
+extern int rl_set_key __P((const char *, rl_command_func_t *, Keymap));
+extern int rl_generic_bind __P((int, const char *, char *, Keymap));
+extern int rl_variable_bind __P((const char *, const char *));
 
 /* Backwards compatibility, use rl_generic_bind instead. */
-extern int rl_macro_bind __P((char *, char *, Keymap));
+extern int rl_macro_bind __P((const char *, const char *, Keymap));
 
 /* Undocumented in the texinfo manual; not really useful to programs. */
-extern int rl_translate_keyseq __P((char *, char *, int *));
+extern int rl_translate_keyseq __P((const char *, char *, int *));
 extern char *rl_untranslate_keyseq __P((int));
 
-extern Function *rl_named_function __P((char *));
-extern Function *rl_function_of_keyseq __P((char *, Keymap, int *));
+extern rl_command_func_t *rl_named_function __P((const char *));
+extern rl_command_func_t *rl_function_of_keyseq __P((const char *, Keymap, int *));
 
 extern void rl_list_funmap_names __P((void));
-extern char **rl_invoking_keyseqs_in_map __P((Function *, Keymap));
-extern char **rl_invoking_keyseqs __P((Function *));
+extern char **rl_invoking_keyseqs_in_map __P((rl_command_func_t *, Keymap));
+extern char **rl_invoking_keyseqs __P((rl_command_func_t *));
  
 extern void rl_function_dumper __P((int));
 extern void rl_macro_dumper __P((int));
 extern void rl_variable_dumper __P((int));
 
-extern int rl_read_init_file __P((char *));
+extern int rl_read_init_file __P((const char *));
 extern int rl_parse_and_bind __P((char *));
 
 /* Functions for manipulating keymaps. */
@@ -305,24 +309,27 @@ extern Keymap rl_copy_keymap __P((Keymap));
 extern Keymap rl_make_keymap __P((void));
 extern void rl_discard_keymap __P((Keymap));
 
-extern Keymap rl_get_keymap_by_name __P((char *));
+extern Keymap rl_get_keymap_by_name __P((const char *));
 extern char *rl_get_keymap_name __P((Keymap));
 extern void rl_set_keymap __P((Keymap));
 extern Keymap rl_get_keymap __P((void));
+/* Undocumented; used internally only. */
 extern void rl_set_keymap_from_edit_mode __P((void));
 extern char *rl_get_keymap_name_from_edit_mode __P((void));
 
 /* Functions for manipulating the funmap, which maps command names to functions. */
-extern int rl_add_funmap_entry __P((char *, Function *));
+extern int rl_add_funmap_entry __P((const char *, rl_command_func_t *));
+extern const char **rl_funmap_names __P((void));
+/* Undocumented, only used internally -- there is only one funmap, and this
+   function may be called only once. */
 extern void rl_initialize_funmap __P((void));
-extern char **rl_funmap_names __P((void));
 
 /* Utility functions for managing keyboard macros. */
 extern void rl_push_macro_input __P((char *));
 
 /* Functions for undoing, from undo.c */
 extern void rl_add_undo __P((enum undo_code, int, int, char *));
-extern void free_undo_list __P((void));
+extern void rl_free_undo_list __P((void));
 extern int rl_do_undo __P((void));
 extern int rl_begin_undo_group __P((void));
 extern int rl_end_undo_group __P((void));
@@ -335,6 +342,7 @@ extern int rl_on_new_line_with_prompt __P((void));
 extern int rl_forced_update_display __P((void));
 extern int rl_clear_message __P((void));
 extern int rl_reset_line_state __P((void));
+extern int rl_crlf __P((void));
 
 #if (defined (__STDC__) || defined (__cplusplus)) && defined (USE_VARARGS) && defined (PREFER_STDARG)
 extern int rl_message (const char *, ...);
@@ -342,17 +350,17 @@ extern int rl_message (const char *, ...);
 extern int rl_message ();
 #endif
 
-/* Undocumented in texinfo manual. */
 extern int rl_show_char __P((int));
+
+/* Undocumented in texinfo manual. */
 extern int rl_character_len __P((int, int));
-extern int crlf __P((void));
 
 /* Save and restore internal prompt redisplay information. */
 extern void rl_save_prompt __P((void));
 extern void rl_restore_prompt __P((void));
 
 /* Modifying text. */
-extern int rl_insert_text __P((char *));
+extern int rl_insert_text __P((const char *));
 extern int rl_delete_text __P((int, int));
 extern int rl_kill_text __P((int, int));
 extern char *rl_copy_text __P((int, int));
@@ -360,20 +368,25 @@ extern char *rl_copy_text __P((int, int));
 /* Terminal and tty mode management. */
 extern void rl_prep_terminal __P((int));
 extern void rl_deprep_terminal __P((void));
-extern void rltty_set_default_bindings __P((Keymap));
+extern void rl_tty_set_default_bindings __P((Keymap));
 
-extern int rl_reset_terminal __P((char *));
+extern int rl_reset_terminal __P((const char *));
 extern void rl_resize_terminal __P((void));
-
-/* `Public' utility functions . */
-extern void rl_extend_line_buffer __P((int));
-extern int ding __P((void));
+extern void rl_set_screen_size __P((int, int));
+extern void rl_get_screen_size __P((int *, int *));
 
 /* Functions for character input. */
 extern int rl_stuff_char __P((int));
 extern int rl_execute_next __P((int));
+extern int rl_clear_pending_input __P((void));
 extern int rl_read_key __P((void));
 extern int rl_getc __P((FILE *));
+extern int rl_set_keyboard_input_timeout __P((int));
+
+/* `Public' utility functions . */
+extern void rl_extend_line_buffer __P((int));
+extern int rl_ding __P((void));
+extern int rl_alphabetic __P((int));
 
 /* Readline signal handling, from signals.c */
 extern int rl_set_signals __P((void));
@@ -383,19 +396,36 @@ extern void rl_reset_after_signal __P((void));
 extern void rl_free_line_state __P((void));
  
 /* Undocumented. */
-extern int rl_expand_prompt __P((char *));
+extern int rl_set_paren_blink_timeout __P((int));
 
-extern int maybe_save_line __P((void));
-extern int maybe_unsave_line __P((void));
-extern int maybe_replace_line __P((void));
+/* Undocumented. */
+extern int rl_maybe_save_line __P((void));
+extern int rl_maybe_unsave_line __P((void));
+extern int rl_maybe_replace_line __P((void));
 
 /* Completion functions. */
 extern int rl_complete_internal __P((int));
 extern void rl_display_match_list __P((char **, int, int));
 
-extern char **completion_matches __P((char *, CPFunction *));
-extern char *username_completion_function __P((char *, int));
-extern char *filename_completion_function __P((char *, int));
+extern char **rl_completion_matches __P((const char *, rl_compentry_func_t *));
+extern char *rl_username_completion_function __P((const char *, int));
+extern char *rl_filename_completion_function __P((const char *, int));
+
+#if 0
+/* Backwards compatibility (compat.c).  These will go away sometime. */
+extern void free_undo_list __P((void));
+extern int maybe_save_line __P((void));
+extern int maybe_unsave_line __P((void));
+extern int maybe_replace_line __P((void));
+
+extern int ding __P((void));
+extern int alphabetic __P((int));
+extern int crlf __P((void));
+
+extern char **completion_matches __P((char *, rl_compentry_func_t *));
+extern char *username_completion_function __P((const char *, int));
+extern char *filename_completion_function __P((const char *, int));
+#endif
 
 /* **************************************************************** */
 /*                                                                 */
@@ -404,14 +434,21 @@ extern char *filename_completion_function __P((char *, int));
 /* **************************************************************** */
 
 /* The version of this incarnation of the readline library. */
-extern char *rl_library_version;
+extern const char *rl_library_version;
 
 /* True if this is real GNU readline. */
 extern int rl_gnu_readline_p;
 
+/* Flags word encapsulating the current readline state. */
+extern int rl_readline_state;
+
+/* Says which editing mode readline is currently using.  1 means emacs mode;
+   0 means vi mode. */
+extern int rl_editing_mode;
+
 /* 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;
+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. */
@@ -421,7 +458,8 @@ extern char *rl_prompt;
 extern char *rl_line_buffer;
 
 /* The location of point, and end. */
-extern int rl_point, rl_end;
+extern int rl_point;
+extern int rl_end;
 
 /* The mark, or saved cursor position. */
 extern int rl_mark;
@@ -438,29 +476,44 @@ extern int rl_pending_input;
    or directly from an application. */
 extern int rl_dispatching;
 
+/* Non-zero if the user typed a numeric argument before executing the
+   current function. */
+extern int rl_explicit_arg;
+
+/* The current value of the numeric argument specified by the user. */
+extern int rl_numeric_arg;
+
+/* The address of the last command function Readline executed. */
+extern rl_command_func_t *rl_last_func;
+
 /* The name of the terminal to use. */
-extern char *rl_terminal_name;
+extern const char *rl_terminal_name;
 
 /* The input and output streams. */
-extern FILE *rl_instream, *rl_outstream;
+extern FILE *rl_instream;
+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. */
-extern Function *rl_startup_hook;
+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. */
-extern Function *rl_pre_input_hook;
+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. */
-extern Function *rl_event_hook;
+extern rl_hook_func_t *rl_event_hook;
 
-extern Function *rl_getc_function;
-extern VFunction *rl_redisplay_function;
-extern VFunction *rl_prep_term_function;
-extern VFunction *rl_deprep_term_function;
+/* The address of the function to call to fetch a character from the current
+   Readline input stream */
+extern rl_getc_func_t *rl_getc_function;
+
+extern rl_voidfunc_t *rl_redisplay_function;
+
+extern rl_vintfunc_t *rl_prep_term_function;
+extern rl_voidfunc_t *rl_deprep_term_function;
 
 /* Dispatch variables. */
 extern Keymap rl_executing_keymap;
@@ -481,6 +534,9 @@ extern int rl_already_prompted;
    up to a character bound to accept-line. */
 extern int rl_num_chars_to_read;
 
+/* The text of a currently-executing keyboard macro. */
+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. */
@@ -497,7 +553,7 @@ extern int rl_catch_sigwinch;
 /* Pointer to the generator function for completion_matches ().
    NULL means to use filename_entry_function (), the default filename
    completer. */
-extern Function *rl_completion_entry_function;
+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
@@ -505,7 +561,7 @@ extern Function *rl_completion_entry_function;
    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. */
-extern Function *rl_ignore_some_completions_function;
+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.
@@ -514,39 +570,50 @@ extern Function *rl_ignore_some_completions_function;
    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. */
-extern CPPFunction *rl_attempted_completion_function;
+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\"\\'`@$>". */
-extern char *rl_basic_word_break_characters;
+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.  */
-extern char *rl_completer_word_break_characters;
+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. */
-extern char *rl_completer_quote_characters;
+extern const char *rl_completer_quote_characters;
 
 /* List of quote characters which cause a word break. */
-extern char *rl_basic_quote_characters;
+extern const char *rl_basic_quote_characters;
 
 /* List of characters that need to be quoted in filenames by the completer. */
-extern char *rl_filename_quote_characters;
+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. */
-extern char *rl_special_prefixes;
+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. */
-extern Function *rl_directory_completion_hook;
+   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. */
+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. */
+extern rl_icppfunc_t *rl_directory_rewrite_hook;
 
 /* Backwards compatibility with previous versions of readline. */
 #define rl_symbolic_link_hook rl_directory_completion_hook
@@ -558,7 +625,7 @@ extern Function *rl_directory_completion_hook;
    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. */
-extern VFunction *rl_completion_display_matches_hook;
+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
@@ -576,17 +643,17 @@ extern int rl_filename_quoting_desired;
    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;
+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. */
-extern CPFunction *rl_filename_dequoting_function;
+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. */
-extern Function *rl_char_is_quoted_p;
+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. */
@@ -623,9 +690,33 @@ extern int rl_inhibit_completion;
 #define SINGLE_MATCH    1
 #define MULT_MATCH      2
 
-#if !defined (savestring)
-extern char *savestring __P((char *)); /* XXX backwards compatibility */
-#endif
+/* 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))
 
 #ifdef __cplusplus
 }