| 1 | /* Readline.h -- the names of functions callable from within readline. */ |
| 2 | |
| 3 | #include "sysdep.h" |
| 4 | |
| 5 | #if !defined (_READLINE_H_) |
| 6 | #define _READLINE_H_ |
| 7 | |
| 8 | #include "keymaps.h" |
| 9 | |
| 10 | #if !defined (__FUNCTION_DEF) |
| 11 | typedef int Function (); |
| 12 | #define __FUNCTION_DEF |
| 13 | #endif /* __FUNCTION_DEF */ |
| 14 | |
| 15 | /* The functions for manipulating the text of the line within readline. |
| 16 | Most of these functions are bound to keys by default. */ |
| 17 | extern int |
| 18 | rl_beg_of_line (), rl_backward (), rl_delete (), rl_end_of_line (), |
| 19 | rl_forward (), ding (), rl_backward (), rl_newline (), rl_kill_line (), |
| 20 | rl_clear_screen (), rl_get_next_history (), rl_get_previous_history (), |
| 21 | rl_quoted_insert (), rl_reverse_search_history (), rl_transpose_chars (), |
| 22 | rl_unix_line_discard (), rl_quoted_insert (), rl_unix_word_rubout (), |
| 23 | rl_yank (), rl_rubout (), rl_backward_word (), rl_kill_word (), |
| 24 | rl_forward_word (), rl_tab_insert (), rl_yank_pop (), rl_yank_nth_arg (), |
| 25 | rl_backward_kill_word (), rl_backward_kill_line (), rl_transpose_words (), |
| 26 | rl_complete (), rl_possible_completions (), rl_do_lowercase_version (), |
| 27 | rl_digit_argument (), rl_universal_argument (), rl_abort (), |
| 28 | rl_undo_command (), rl_revert_line (), rl_beginning_of_history (), |
| 29 | rl_end_of_history (), rl_forward_search_history (), rl_insert (), |
| 30 | rl_upcase_word (), rl_downcase_word (), rl_capitalize_word (), |
| 31 | rl_restart_output (), rl_re_read_init_file (), rl_dump_functions (); |
| 32 | |
| 33 | /* These are *both* defined even when VI_MODE is not. */ |
| 34 | extern int rl_vi_editing_mode (), rl_emacs_editing_mode (); |
| 35 | |
| 36 | #if defined (VI_MODE) |
| 37 | /* Things for vi mode. */ |
| 38 | extern int |
| 39 | rl_vi_movement_mode (), rl_vi_insertion_mode (), rl_vi_arg_digit (), |
| 40 | rl_vi_prev_word (), rl_vi_next_word (), rl_vi_char_search (), |
| 41 | rl_vi_eof_maybe (), rl_vi_append_mode (), rl_vi_put (), |
| 42 | rl_vi_append_eol (), rl_vi_insert_beg (), rl_vi_delete (), rl_vi_comment (), |
| 43 | rl_vi_first_print (), rl_vi_fword (), rl_vi_fWord (), rl_vi_bword (), |
| 44 | rl_vi_bWord (), rl_vi_eword (), rl_vi_eWord (), rl_vi_end_word (), |
| 45 | rl_vi_change_case (), rl_vi_match (), rl_vi_bracktype (), |
| 46 | rl_vi_change_char (), rl_vi_yank_arg (), rl_vi_search (), |
| 47 | rl_vi_search_again (), rl_vi_dosearch (), rl_vi_subst (), |
| 48 | rl_vi_overstrike (), rl_vi_overstrike_delete (), rl_vi_replace(), |
| 49 | rl_vi_column (), rl_vi_delete_to (), rl_vi_change_to (), rl_vi_yank_to (), |
| 50 | rl_vi_complete (), rl_vi_fetch_history (); |
| 51 | #endif /* VI_MODE */ |
| 52 | |
| 53 | /* Keyboard macro commands. */ |
| 54 | extern int |
| 55 | rl_start_kbd_macro (), rl_end_kbd_macro (), rl_call_last_kbd_macro (); |
| 56 | |
| 57 | extern int rl_arrow_keys(), rl_refresh_line (); |
| 58 | |
| 59 | /* Maintaining the state of undo. We remember individual deletes and inserts |
| 60 | on a chain of things to do. */ |
| 61 | |
| 62 | /* The actions that undo knows how to undo. Notice that UNDO_DELETE means |
| 63 | to insert some text, and UNDO_INSERT means to delete some text. I.e., |
| 64 | the code tells undo what to undo, not how to undo it. */ |
| 65 | enum undo_code { UNDO_DELETE, UNDO_INSERT, UNDO_BEGIN, UNDO_END }; |
| 66 | |
| 67 | /* What an element of THE_UNDO_LIST looks like. */ |
| 68 | typedef struct undo_list { |
| 69 | struct undo_list *next; |
| 70 | int start, end; /* Where the change took place. */ |
| 71 | char *text; /* The text to insert, if undoing a delete. */ |
| 72 | enum undo_code what; /* Delete, Insert, Begin, End. */ |
| 73 | } UNDO_LIST; |
| 74 | |
| 75 | /* The current undo list for RL_LINE_BUFFER. */ |
| 76 | extern UNDO_LIST *rl_undo_list; |
| 77 | |
| 78 | /* The data structure for mapping textual names to code addresses. */ |
| 79 | typedef struct { |
| 80 | char *name; |
| 81 | Function *function; |
| 82 | } FUNMAP; |
| 83 | |
| 84 | extern FUNMAP **funmap; |
| 85 | |
| 86 | /* **************************************************************** */ |
| 87 | /* */ |
| 88 | /* Well Published Variables */ |
| 89 | /* */ |
| 90 | /* **************************************************************** */ |
| 91 | |
| 92 | /* The name of the calling program. You should initialize this to |
| 93 | whatever was in argv[0]. It is used when parsing conditionals. */ |
| 94 | extern char *rl_readline_name; |
| 95 | |
| 96 | /* The line buffer that is in use. */ |
| 97 | extern char *rl_line_buffer; |
| 98 | |
| 99 | /* The location of point, and end. */ |
| 100 | extern int rl_point, rl_end; |
| 101 | |
| 102 | /* The name of the terminal to use. */ |
| 103 | extern char *rl_terminal_name; |
| 104 | |
| 105 | /* The input and output streams. */ |
| 106 | extern FILE *rl_instream, *rl_outstream; |
| 107 | |
| 108 | /* The basic list of characters that signal a break between words for the |
| 109 | completer routine. The initial contents of this variable is what |
| 110 | breaks words in the shell, i.e. "n\"\\'`@$>". */ |
| 111 | extern char *rl_basic_word_break_characters; |
| 112 | |
| 113 | /* The list of characters that signal a break between words for |
| 114 | rl_complete_internal. The default list is the contents of |
| 115 | rl_basic_word_break_characters. */ |
| 116 | extern char *rl_completer_word_break_characters; |
| 117 | |
| 118 | /* List of characters that are word break characters, but should be left |
| 119 | in TEXT when it is passed to the completion function. The shell uses |
| 120 | this to help determine what kind of completing to do. */ |
| 121 | extern char *rl_special_prefixes; |
| 122 | |
| 123 | /* Pointer to the generator function for completion_matches (). |
| 124 | NULL means to use filename_entry_function (), the default filename |
| 125 | completer. */ |
| 126 | extern Function *rl_completion_entry_function; |
| 127 | |
| 128 | /* If rl_ignore_some_completions_function is non-NULL it is the address |
| 129 | of a function to call after all of the possible matches have been |
| 130 | generated, but before the actual completion is done to the input line. |
| 131 | The function is called with one argument; a NULL terminated array |
| 132 | of (char *). If your function removes any of the elements, they |
| 133 | must be free()'ed. */ |
| 134 | extern Function *rl_ignore_some_completions_function; |
| 135 | |
| 136 | /* Pointer to alternative function to create matches. |
| 137 | Function is called with TEXT, START, and END. |
| 138 | START and END are indices in RL_LINE_BUFFER saying what the boundaries |
| 139 | of TEXT are. |
| 140 | If this function exists and returns NULL then call the value of |
| 141 | rl_completion_entry_function to try to match, otherwise use the |
| 142 | array of strings returned. */ |
| 143 | extern Function *rl_attempted_completion_function; |
| 144 | |
| 145 | /* If non-zero, then this is the address of a function to call just |
| 146 | before readline_internal () prints the first prompt. */ |
| 147 | extern Function *rl_startup_hook; |
| 148 | |
| 149 | /* If non-zero, then this is the address of a function to call when |
| 150 | completing on a directory name. The function is called with |
| 151 | the address of a string (the current directory name) as an arg. */ |
| 152 | extern Function *rl_symbolic_link_hook; |
| 153 | |
| 154 | /* Non-zero means that modified history lines are preceded |
| 155 | with an asterisk. */ |
| 156 | extern int rl_show_star; |
| 157 | |
| 158 | |
| 159 | /* **************************************************************** */ |
| 160 | /* */ |
| 161 | /* Tilde Variables That Can be Externally Set */ |
| 162 | /* */ |
| 163 | /* **************************************************************** */ |
| 164 | |
| 165 | /* If non-null, this contains the address of a function to call if the |
| 166 | standard meaning for expanding a tilde fails. The function is called |
| 167 | with the text (sans tilde, as in "foo"), and returns a malloc()'ed string |
| 168 | which is the expansion, or a NULL pointer if there is no expansion. */ |
| 169 | extern Function *tilde_expansion_failure_hook; |
| 170 | |
| 171 | /* When non-null, this is a NULL terminated array of strings which |
| 172 | are duplicates for a tilde prefix. Bash uses this to expand |
| 173 | `=~' and `:~'. */ |
| 174 | extern char **tilde_additional_prefixes; |
| 175 | |
| 176 | /* When non-null, this is a NULL terminated array of strings which match |
| 177 | the end of a username, instead of just "/". Bash sets this to |
| 178 | `/' and `:'. */ |
| 179 | extern char **tilde_additional_suffixes; |
| 180 | |
| 181 | /* **************************************************************** */ |
| 182 | /* */ |
| 183 | /* Well Published Functions */ |
| 184 | /* */ |
| 185 | /* **************************************************************** */ |
| 186 | |
| 187 | /* Read a line of input. Prompt with PROMPT. A NULL PROMPT means none. */ |
| 188 | extern char *readline (); |
| 189 | |
| 190 | /* Return an array of strings which are the result of repeatadly calling |
| 191 | FUNC with TEXT. */ |
| 192 | extern char **completion_matches (); |
| 193 | |
| 194 | /* rl_add_defun (char *name, Function *function, int key) |
| 195 | Add NAME to the list of named functions. Make FUNCTION |
| 196 | be the function that gets called. |
| 197 | If KEY is not -1, then bind it. */ |
| 198 | extern int rl_add_defun (); |
| 199 | |
| 200 | #endif /* _READLINE_H_ */ |