home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-dist / octave-1.1.1p1-src.tgz / tar.out / fsf / octave / readline / readline.h < prev    next >
C/C++ Source or Header  |  1996-09-28  |  10KB  |  247 lines
  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. #include <readline/keymaps.h>
  27.  
  28. /* The functions for manipulating the text of the line within readline.
  29. Most of these functions are bound to keys by default. */
  30. extern int
  31.   rl_tilde_expand (),
  32.   rl_beg_of_line (), rl_backward (), rl_delete (), rl_end_of_line (),
  33.   rl_forward (), ding (), rl_backward (), rl_newline (), rl_kill_line (),
  34.   rl_clear_screen (), rl_get_next_history (), rl_get_previous_history (),
  35.   rl_quoted_insert (), rl_reverse_search_history (), rl_transpose_chars (),
  36.   rl_unix_line_discard (), rl_quoted_insert (), rl_unix_word_rubout (),
  37.   rl_yank (), rl_rubout (), rl_backward_word (), rl_kill_word (),
  38.   rl_forward_word (), rl_tab_insert (), rl_yank_pop (), rl_yank_nth_arg (),
  39.   rl_backward_kill_word (), rl_backward_kill_line (), rl_transpose_words (),
  40.   rl_complete (), rl_possible_completions (), rl_insert_completions (),
  41.   rl_do_lowercase_version (),
  42.   rl_digit_argument (), rl_universal_argument (), rl_abort (),
  43.   rl_undo_command (), rl_revert_line (), rl_beginning_of_history (),
  44.   rl_end_of_history (), rl_forward_search_history (), rl_insert (),
  45.   rl_upcase_word (), rl_downcase_word (), rl_capitalize_word (),
  46.   rl_restart_output (), rl_re_read_init_file (), rl_dump_functions (),
  47.   rl_delete_horizontal_space ();
  48.  
  49. /* Some more functions that we use internally, but across files.
  50.    If they aren't going to be static, they might as well be declared
  51.    here. */
  52. extern int
  53.   maybe_unsave_line (), maybe_save_line (), maybe_replace_line (),
  54.   rl_read_key (), rl_execute_next (), rl_delete_text (),
  55.   rl_insert_text (), rl_begin_undo_group (), rl_end_undo_group (),
  56.   rl_kill_text (), rl_stuff_char (), rl_do_undo (), rl_getc (),
  57.   rl_init_argument (), rl_clean_up_for_exit (),
  58.   numeric (), crlf (), backspace ();
  59.  
  60. extern void
  61.   free_history_entry (), rl_dispatch (), rl_extend_line_buffer (),
  62.   _rl_kill_kbd_macro (), _rl_set_screen_size ();
  63.  
  64. /* #define PAREN_MATCHING */
  65. #if defined (PAREN_MATCHING)
  66. extern int rl_insert_close ();
  67. #endif /* PAREN_MATCHING */
  68.  
  69. /* These are *both* defined even when VI_MODE is not. */
  70. extern int rl_vi_editing_mode (), rl_emacs_editing_mode ();
  71.  
  72. /* Non incremental history searching. */
  73. extern int
  74.   rl_noninc_forward_search (), rl_noninc_reverse_search (),
  75.   rl_noninc_forward_search_again (), rl_noninc_reverse_search_again ();
  76.  
  77. #if defined (VI_MODE)
  78. /* Things for vi mode. */
  79. extern int
  80.   rl_vi_redo (), rl_vi_tilde_expand (),
  81.   rl_vi_movement_mode (), rl_vi_insertion_mode (), rl_vi_arg_digit (),
  82.   rl_vi_prev_word (), rl_vi_next_word (), rl_vi_char_search (),
  83.   rl_vi_eof_maybe (), rl_vi_append_mode (), rl_vi_put (),
  84.   rl_vi_append_eol (), rl_vi_insert_beg (), rl_vi_delete (), rl_vi_comment (),
  85.   rl_vi_first_print (), rl_vi_fword (), rl_vi_fWord (), rl_vi_bword (),
  86.   rl_vi_bWord (), rl_vi_eword (), rl_vi_eWord (), rl_vi_end_word (),
  87.   rl_vi_change_case (), rl_vi_match (), rl_vi_bracktype (),
  88.   rl_vi_change_char (), rl_vi_yank_arg (), rl_vi_search (),
  89.   rl_vi_search_again (),  rl_vi_subst (), rl_vi_overstrike (),
  90.   rl_vi_overstrike_delete (), rl_vi_replace(), rl_vi_column (),
  91.   rl_vi_delete_to (), rl_vi_change_to (), rl_vi_yank_to (),
  92.   rl_vi_complete (), rl_vi_fetch_history ();
  93. #endif /* VI_MODE */
  94.  
  95. /* Keyboard macro commands. */
  96. extern int
  97. rl_start_kbd_macro (), rl_end_kbd_macro (), rl_call_last_kbd_macro ();
  98.  
  99. extern int rl_arrow_keys(), rl_refresh_line ();
  100.  
  101. /* Maintaining the state of undo.  We remember individual deletes and inserts
  102.    on a chain of things to do. */
  103.  
  104. /* The actions that undo knows how to undo.  Notice that UNDO_DELETE means
  105.    to insert some text, and UNDO_INSERT means to delete some text.   I.e.,
  106.    the code tells undo what to undo, not how to undo it. */
  107. enum undo_code { UNDO_DELETE, UNDO_INSERT, UNDO_BEGIN, UNDO_END };
  108.  
  109. /* What an element of THE_UNDO_LIST looks like. */
  110. typedef struct undo_list {
  111.   struct undo_list *next;
  112.   int start, end;        /* Where the change took place. */
  113.   char *text;            /* The text to insert, if undoing a delete. */
  114.   enum undo_code what;        /* Delete, Insert, Begin, End. */
  115. } UNDO_LIST;
  116.  
  117. /* The current undo list for RL_LINE_BUFFER. */
  118. extern UNDO_LIST *rl_undo_list;
  119.  
  120. /* The data structure for mapping textual names to code addresses. */
  121. typedef struct {
  122.   char *name;
  123.   Function *function;
  124. } FUNMAP;
  125.  
  126. extern FUNMAP **funmap;
  127.  
  128. /* **************************************************************** */
  129. /*                                    */
  130. /*            Well Published Variables            */
  131. /*                                    */
  132. /* **************************************************************** */
  133.  
  134. /* The name of the calling program.  You should initialize this to
  135.    whatever was in argv[0].  It is used when parsing conditionals. */
  136. extern char *rl_readline_name;
  137.  
  138. /* The line buffer that is in use. */
  139. extern char *rl_line_buffer;
  140.  
  141. /* The location of point, and end. */
  142. extern int rl_point, rl_end;
  143.  
  144. /* The name of the terminal to use. */
  145. extern char *rl_terminal_name;
  146.  
  147. /* The input and output streams. */
  148. extern FILE *rl_instream, *rl_outstream;
  149.  
  150. /* The basic list of characters that signal a break between words for the
  151.    completer routine.  The initial contents of this variable is what
  152.    breaks words in the shell, i.e. "n\"\\'`@$>". */
  153. extern char *rl_basic_word_break_characters;
  154.  
  155. /* The list of characters that signal a break between words for
  156.    rl_complete_internal.  The default list is the contents of
  157.    rl_basic_word_break_characters.  */
  158. extern char *rl_completer_word_break_characters;
  159.  
  160. /* List of characters that are word break characters, but should be left
  161.    in TEXT when it is passed to the completion function.  The shell uses
  162.    this to help determine what kind of completing to do. */
  163. extern char *rl_special_prefixes;
  164.  
  165. /* Pointer to the generator function for completion_matches ().
  166.    NULL means to use filename_entry_function (), the default filename
  167.    completer. */
  168. extern Function *rl_completion_entry_function;
  169.  
  170. /* If rl_ignore_some_completions_function is non-NULL it is the address
  171.    of a function to call after all of the possible matches have been
  172.    generated, but before the actual completion is done to the input line.
  173.    The function is called with one argument; a NULL terminated array
  174.    of (char *).  If your function removes any of the elements, they
  175.    must be free()'ed. */
  176. extern Function *rl_ignore_some_completions_function;
  177.  
  178. /* Pointer to alternative function to create matches.
  179.    Function is called with TEXT, START, and END.
  180.    START and END are indices in RL_LINE_BUFFER saying what the boundaries
  181.    of TEXT are.
  182.    If this function exists and returns NULL then call the value of
  183.    rl_completion_entry_function to try to match, otherwise use the
  184.    array of strings returned. */
  185. extern CPPFunction *rl_attempted_completion_function;
  186.  
  187. /* If non-zero, then this is the address of a function to call just
  188.    before readline_internal () prints the first prompt. */
  189. extern Function *rl_startup_hook;
  190.  
  191. /* If non-zero, then this is the address of a function to call when
  192.    completing on a directory name.  The function is called with
  193.    the address of a string (the current directory name) as an arg. */
  194. extern Function *rl_symbolic_link_hook;
  195.  
  196. /* The address of a function to call periodically while Readline is
  197.    awaiting character input, or NULL, for no event handling. */
  198. extern Function *rl_event_hook;
  199.  
  200. /* Non-zero means that modified history lines are preceded
  201.    with an asterisk. */
  202. extern int rl_show_star;
  203.  
  204.  
  205. /* **************************************************************** */
  206. /*                                                                  */
  207. /*             Tilde Variables That Can be Externally Set           */
  208. /*                                                                  */
  209. /* **************************************************************** */
  210.  
  211. /* If non-null, this contains the address of a function to call if the
  212.    standard meaning for expanding a tilde fails.  The function is called
  213.    with the text (sans tilde, as in "foo"), and returns a malloc()'ed string
  214.    which is the expansion, or a NULL pointer if there is no expansion. */
  215. extern CPFunction *tilde_expansion_failure_hook;
  216.  
  217. /* When non-null, this is a NULL terminated array of strings which
  218.    are duplicates for a tilde prefix.  Bash uses this to expand
  219.    `=~' and `:~'. */
  220. extern char **tilde_additional_prefixes;
  221.  
  222. /* When non-null, this is a NULL terminated array of strings which match
  223.    the end of a username, instead of just "/".  Bash sets this to
  224.    `/' and `:'. */
  225. extern char **tilde_additional_suffixes;
  226.  
  227. /* **************************************************************** */
  228. /*                                    */
  229. /*            Well Published Functions            */
  230. /*                                    */
  231. /* **************************************************************** */
  232.  
  233. /* Read a line of input.  Prompt with PROMPT.  A NULL PROMPT means none. */
  234. extern char *readline ();
  235.  
  236. /* Return an array of strings which are the result of repeatadly calling
  237.    FUNC with TEXT. */
  238. extern char **completion_matches ();
  239.  
  240. /* rl_add_defun (char *name, Function *function, int key)
  241.    Add NAME to the list of named functions.  Make FUNCTION
  242.    be the function that gets called.
  243.    If KEY is not -1, then bind it. */
  244. extern int rl_add_defun ();
  245.  
  246. #endif /* _READLINE_H_ */
  247.