lib/readline/readline.h

   1 /* Readline.h -- the names of functions callable from within readline. */
   2
   3 /* Copyright (C) 1987, 1989, 1992 Free Software Foundation, Inc.
   4
   5    This file is part of the GNU Readline Library, a library for
   6    reading lines of text with interactive input and history editing.
   7
   8    The GNU Readline Library is free software; you can redistribute it
   9    and/or modify it under the terms of the GNU General Public License
  10    as published by the Free Software Foundation; either version 1, or
  11    (at your option) any later version.
  12
  13    The GNU Readline Library is distributed in the hope that it will be
  14    useful, but WITHOUT ANY WARRANTY; without even the implied warranty
  15    of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    The GNU General Public License is often shipped with GNU software, and
  19    is generally kept in a file called COPYING or LICENSE.  If you do not
  20    have a copy of the license, write to the Free Software Foundation,
  21    675 Mass Ave, Cambridge, MA 02139, USA. */
  22
  23 #if !defined (_READLINE_H_)
  24 #define _READLINE_H_
  25
  26 #if defined (READLINE_LIBRARY)
  27 #  include "keymaps.h"
  28 #  include "tilde.h"
  29 #else
  30 #  include <readline/keymaps.h>
  31 #  include <readline/tilde.h>
  32 #endif
  33
  34 /* Readline data structures. */
  35
  36 /* Maintaining the state of undo.  We remember individual deletes and inserts
  37    on a chain of things to do. */
  38
  39 /* The actions that undo knows how to undo.  Notice that UNDO_DELETE means
  40    to insert some text, and UNDO_INSERT means to delete some text.   I.e.,
  41    the code tells undo what to undo, not how to undo it. */
  42 enum undo_code { UNDO_DELETE, UNDO_INSERT, UNDO_BEGIN, UNDO_END };
  43
  44 /* What an element of THE_UNDO_LIST looks like. */
  45 typedef struct undo_list {
  46   struct undo_list *next;
  47   int start, end;               /* Where the change took place. */
  48   char *text;                   /* The text to insert, if undoing a delete. */
  49   enum undo_code what;          /* Delete, Insert, Begin, End. */
  50 } UNDO_LIST;
  51
  52 /* The current undo list for RL_LINE_BUFFER. */
  53 extern UNDO_LIST *rl_undo_list;
  54
  55 /* The data structure for mapping textual names to code addresses. */
  56 typedef struct _funmap {
  57   char *name;
  58   Function *function;
  59 } FUNMAP;
  60
  61 extern FUNMAP **funmap;
  62
  63 /* Functions available to bind to key sequences. */
  64 extern int
  65   rl_tilde_expand (), rl_set_mark (), rl_exchange_point_and_mark (),
  66   rl_beg_of_line (), rl_backward (), rl_delete (), rl_end_of_line (),
  67   rl_forward (), ding (), rl_newline (), rl_kill_line (),
  68   rl_copy_region_to_kill (), rl_kill_region (), rl_char_search (),
  69   rl_clear_screen (), rl_get_next_history (), rl_get_previous_history (),
  70   rl_quoted_insert (), rl_reverse_search_history (), rl_transpose_chars (),
  71   rl_unix_line_discard (), rl_unix_word_rubout (),
  72   rl_yank (), rl_rubout (), rl_backward_word (), rl_kill_word (),
  73   rl_forward_word (), rl_tab_insert (), rl_yank_pop (), rl_yank_nth_arg (),
  74   rl_backward_kill_word (), rl_backward_kill_line (), rl_transpose_words (),
  75   rl_complete (), rl_possible_completions (), rl_insert_completions (),
  76   rl_do_lowercase_version (), rl_kill_full_line (),
  77   rl_digit_argument (), rl_universal_argument (), rl_abort (),
  78   rl_undo_command (), rl_revert_line (), rl_beginning_of_history (),
  79   rl_end_of_history (), rl_forward_search_history (), rl_insert (),
  80   rl_upcase_word (), rl_downcase_word (), rl_capitalize_word (),
  81   rl_restart_output (), rl_re_read_init_file (),
  82   rl_dump_functions (), rl_dump_variables (), rl_dump_macros (),
  83   rl_delete_horizontal_space (), rl_history_search_forward (),
  84   rl_history_search_backward (), rl_tty_status (), rl_yank_last_arg (),
  85   rl_insert_comment (), rl_backward_char_search (),
  86   rl_copy_forward_word (), rl_copy_backward_word ();
  87
  88 /* Not available unless readline is compiled -DPAREN_MATCHING. */
  89 extern int rl_insert_close ();
  90
  91 /* Not available unless READLINE_CALLBACKS is defined. */
  92 extern void rl_callback_handler_install ();
  93 extern void rl_callback_read_char ();
  94 extern void rl_callback_handler_remove ();
  95
  96 /* These are *both* defined even when VI_MODE is not. */
  97 extern int rl_vi_editing_mode (), rl_emacs_editing_mode ();
  98
  99 /* Non incremental history searching. */
 100 extern int
 101   rl_noninc_forward_search (), rl_noninc_reverse_search (),
 102   rl_noninc_forward_search_again (), rl_noninc_reverse_search_again ();
 103
 104 /* Things for vi mode. Not available unless readline is compiled -DVI_MODE. */
 105 extern int rl_vi_check (), rl_vi_textmod_command ();
 106 extern int
 107   rl_vi_undo (), rl_vi_redo (), rl_vi_tilde_expand (),
 108   rl_vi_movement_mode (), rl_vi_insertion_mode (), rl_vi_arg_digit (),
 109   rl_vi_prev_word (), rl_vi_next_word (), rl_vi_char_search (),
 110   rl_vi_eof_maybe (), rl_vi_append_mode (), rl_vi_put (),
 111   rl_vi_append_eol (), rl_vi_insert_beg (), rl_vi_delete (),
 112   rl_vi_first_print (), rl_vi_fword (), rl_vi_fWord (), rl_vi_bword (),
 113   rl_vi_bWord (), rl_vi_eword (), rl_vi_eWord (), rl_vi_end_word (),
 114   rl_vi_change_case (), rl_vi_match (), rl_vi_bracktype (),
 115   rl_vi_change_char (), rl_vi_yank_arg (), rl_vi_search (),
 116   rl_vi_search_again (),  rl_vi_subst (), rl_vi_overstrike (),
 117   rl_vi_overstrike_delete (), rl_vi_replace(), rl_vi_column (),
 118   rl_vi_delete_to (), rl_vi_change_to (), rl_vi_yank_to (),
 119   rl_vi_complete (), rl_vi_fetch_history (), rl_vi_set_mark (),
 120   rl_vi_goto_mark (), rl_vi_back_to_indent ();
 121
 122 /* Keyboard macro commands. */
 123 extern int rl_start_kbd_macro (), rl_end_kbd_macro ();
 124 extern int rl_call_last_kbd_macro ();
 125 extern void rl_push_macro_input ();
 126
 127 extern int rl_arrow_keys(), rl_refresh_line ();
 128
 129 /* **************************************************************** */
 130 /*                                                                  */
 131 /*                      Well Published Functions                    */
 132 /*                                                                  */
 133 /* **************************************************************** */
 134
 135 /* Readline functions. */
 136 /* Read a line of input.  Prompt with PROMPT.  A NULL PROMPT means none. */
 137 extern char *readline ();
 138
 139 /* These functions are from bind.c. */
 140 /* rl_add_defun (char *name, Function *function, int key)
 141    Add NAME to the list of named functions.  Make FUNCTION
 142    be the function that gets called.
 143    If KEY is not -1, then bind it. */
 144 extern int rl_add_defun ();
 145
 146 extern Keymap rl_make_bare_keymap ();
 147 extern Keymap rl_copy_keymap ();
 148 extern Keymap rl_make_keymap ();
 149 extern void rl_discard_keymap ();
 150 extern Keymap rl_get_keymap (), rl_get_keymap_by_name ();
 151 extern void rl_set_keymap ();
 152 extern char *rl_get_keymap_name ();
 153
 154 extern int rl_bind_key (), rl_bind_key_in_map ();
 155 extern int rl_unbind_key (), rl_unbind_key_in_map ();
 156 extern int rl_set_key ();
 157 extern int rl_generic_bind ();
 158 extern int rl_parse_and_bind ();
 159 /* Backwards compatibility, use rl_generic_bind instead. */
 160 extern int rl_macro_bind (), rl_variable_bind ();
 161
 162 extern int rl_read_init_file ();
 163
 164 extern Function *rl_named_function (), *rl_function_of_keyseq ();
 165 extern char **rl_invoking_keyseqs (), **rl_invoking_keyseqs_in_map ();
 166 extern void rl_function_dumper ();
 167 extern void rl_variable_dumper ();
 168 extern void rl_macro_dumper ();
 169 extern void rl_list_funmap_names ();
 170
 171 /* Undocumented in the texinfo manual; not really useful to programs. */
 172 extern int rl_translate_keyseq ();
 173 extern void rl_initialize_funmap ();
 174
 175 /* Functions for undoing. */
 176 extern int rl_begin_undo_group (), rl_end_undo_group ();
 177 extern void rl_add_undo (), free_undo_list ();
 178 extern int rl_do_undo ();
 179 extern int rl_modifying ();
 180
 181 /* Functions for redisplay. */
 182 extern void rl_redisplay ();
 183 extern int rl_forced_update_display ();
 184 extern int rl_clear_message ();
 185 extern int rl_reset_line_state ();
 186 extern int rl_on_new_line ();
 187
 188 #if defined (__STDC__) && defined (USE_VARARGS) && defined (PREFER_STDARG)
 189 extern int rl_message (const char *, ...);
 190 #else
 191 extern int rl_message ();
 192 #endif
 193
 194 /* Undocumented in texinfo manual. */
 195 extern int rl_character_len ();
 196 extern int rl_show_char ();
 197 extern int crlf ();
 198
 199 /* Modifying text. */
 200 extern int rl_insert_text (), rl_delete_text ();
 201 extern int rl_kill_text ();
 202 extern char *rl_copy_text ();
 203
 204 /* `Public' utility functions. */
 205 extern int rl_reset_terminal ();
 206 extern int rl_stuff_char ();
 207 extern int rl_read_key (), rl_getc ();
 208
 209 extern int rl_initialize ();
 210
 211 /* Undocumented. */
 212 extern int rl_expand_prompt ();
 213 extern int rl_set_signals (), rl_clear_signals ();
 214 extern int maybe_save_line (), maybe_unsave_line (), maybe_replace_line ();
 215
 216 /* Completion functions. */
 217 /* These functions are from complete.c. */
 218 extern int rl_complete_internal ();
 219
 220 /* Return an array of strings which are the result of repeatadly calling
 221    FUNC with TEXT. */
 222 extern char **completion_matches ();
 223 extern char *username_completion_function ();
 224 extern char *filename_completion_function ();
 225
 226 /* **************************************************************** */
 227 /*                                                                  */
 228 /*                      Well Published Variables                    */
 229 /*                                                                  */
 230 /* **************************************************************** */
 231
 232 /* The version of this incarnation of the readline library. */
 233 extern char *rl_library_version;
 234
 235 /* The name of the calling program.  You should initialize this to
 236    whatever was in argv[0].  It is used when parsing conditionals. */
 237 extern char *rl_readline_name;
 238
 239 /* The line buffer that is in use. */
 240 extern char *rl_line_buffer;
 241
 242 /* The location of point, and end. */
 243 extern int rl_point, rl_end;
 244
 245 extern int rl_mark;
 246
 247 extern int rl_done;
 248
 249 extern int rl_pending_input;
 250
 251 /* The name of the terminal to use. */
 252 extern char *rl_terminal_name;
 253
 254 /* The input and output streams. */
 255 extern FILE *rl_instream, *rl_outstream;
 256
 257 /* If non-zero, then this is the address of a function to call just
 258    before readline_internal () prints the first prompt. */
 259 extern Function *rl_startup_hook;
 260
 261 /* The address of a function to call periodically while Readline is
 262    awaiting character input, or NULL, for no event handling. */
 263 extern Function *rl_event_hook;
 264
 265 extern Function *rl_getc_function;
 266 extern VFunction *rl_redisplay_function;
 267 extern VFunction *rl_prep_term_function;
 268 extern VFunction *rl_deprep_term_function;
 269
 270 /* Dispatch variables. */
 271 extern Keymap rl_executing_keymap;
 272 extern Keymap rl_binding_keymap;
 273
 274 /* Completion variables. */
 275 /* Pointer to the generator function for completion_matches ().
 276    NULL means to use filename_entry_function (), the default filename
 277    completer. */
 278 extern Function *rl_completion_entry_function;
 279
 280 /* If rl_ignore_some_completions_function is non-NULL it is the address
 281    of a function to call after all of the possible matches have been
 282    generated, but before the actual completion is done to the input line.
 283    The function is called with one argument; a NULL terminated array
 284    of (char *).  If your function removes any of the elements, they
 285    must be free()'ed. */
 286 extern Function *rl_ignore_some_completions_function;
 287
 288 /* Pointer to alternative function to create matches.
 289    Function is called with TEXT, START, and END.
 290    START and END are indices in RL_LINE_BUFFER saying what the boundaries
 291    of TEXT are.
 292    If this function exists and returns NULL then call the value of
 293    rl_completion_entry_function to try to match, otherwise use the
 294    array of strings returned. */
 295 extern CPPFunction *rl_attempted_completion_function;
 296
 297 /* The basic list of characters that signal a break between words for the
 298    completer routine.  The initial contents of this variable is what
 299    breaks words in the shell, i.e. "n\"\\'`@$>". */
 300 extern char *rl_basic_word_break_characters;
 301
 302 /* The list of characters that signal a break between words for
 303    rl_complete_internal.  The default list is the contents of
 304    rl_basic_word_break_characters.  */
 305 extern char *rl_completer_word_break_characters;
 306
 307 /* List of characters which can be used to quote a substring of the line.
 308    Completion occurs on the entire substring, and within the substring
 309    rl_completer_word_break_characters are treated as any other character,
 310    unless they also appear within this list. */
 311 extern char *rl_completer_quote_characters;
 312
 313 /* List of quote characters which cause a word break. */
 314 extern char *rl_basic_quote_characters;
 315
 316 /* List of characters that need to be quoted in filenames by the completer. */
 317 extern char *rl_filename_quote_characters;
 318
 319 /* List of characters that are word break characters, but should be left
 320    in TEXT when it is passed to the completion function.  The shell uses
 321    this to help determine what kind of completing to do. */
 322 extern char *rl_special_prefixes;
 323
 324 /* If non-zero, then this is the address of a function to call when
 325    completing on a directory name.  The function is called with
 326    the address of a string (the current directory name) as an arg. */
 327 extern Function *rl_directory_completion_hook;
 328
 329 /* Backwards compatibility with previous versions of readline. */
 330 #define rl_symbolic_link_hook rl_directory_completion_hook
 331
 332 /* Non-zero means that the results of the matches are to be treated
 333    as filenames.  This is ALWAYS zero on entry, and can only be changed
 334    within a completion entry finder function. */
 335 extern int rl_filename_completion_desired;
 336
 337 /* Non-zero means that the results of the matches are to be quoted using
 338    double quotes (or an application-specific quoting mechanism) if the
 339    filename contains any characters in rl_word_break_chars.  This is
 340    ALWAYS non-zero on entry, and can only be changed within a completion
 341    entry finder function. */
 342 extern int rl_filename_quoting_desired;
 343
 344 /* Set to a function to quote a filename in an application-specific fashion.
 345    Called with the text to quote, the type of match found (single or multiple)
 346    and a pointer to the quoting character to be used, which the function can
 347    reset if desired. */
 348 extern CPFunction *rl_filename_quoting_function;
 349
 350 /* Function to call to remove quoting characters from a filename.  Called
 351    before completion is attempted, so the embedded quotes do not interfere
 352    with matching names in the file system. */
 353 extern CPFunction *rl_filename_dequoting_function;
 354
 355 /* Function to call to decide whether or not a word break character is
 356    quoted.  If a character is quoted, it does not break words for the
 357    completer. */
 358 extern Function *rl_char_is_quoted_p;
 359
 360 /* Non-zero means to suppress normal filename completion after the
 361    user-specified completion function has been called. */
 362 extern int rl_attempted_completion_over;
 363
 364 /* Set to a character describing the type of completion being attempted by
 365    rl_complete_internal; available for use by application completion
 366    functions. */
 367 extern int rl_completion_type;
 368
 369 /* Character appended to completed words when at the end of the line.  The
 370    default is a space.  Nothing is added if this is '\0'. */
 371 extern int rl_completion_append_character;
 372
 373 /* If this is non-zero, completion is (temporarily) inhibited, and the
 374    completion character will be inserted as any other. */
 375 extern int rl_inhibit_completion;
 376
 377 /* Definitions available for use by readline clients. */
 378 #define RL_PROMPT_START_IGNORE  '\001'
 379 #define RL_PROMPT_END_IGNORE    '\002'
 380
 381 /* Possible values for do_replace argument to rl_filename_quoting_function,
 382    called by rl_complete_internal. */
 383 #define NO_MATCH        0
 384 #define SINGLE_MATCH    1
 385 #define MULT_MATCH      2
 386
 387 #if !defined (savestring)
 388 extern char *savestring ();     /* XXX backwards compatibility */
 389 #endif
 390
 391 #endif /* _READLINE_H_ */