1 /* Readline.h -- the names of functions callable from within readline. */
3 /* Copyright (C) 1987, 1989, 1992 Free Software Foundation, Inc.
5 This file is part of the GNU Readline Library, a library for
6 reading lines of text with interactive input and history editing.
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.
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.
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. */
23 #if !defined (_READLINE_H_)
26 #if defined (READLINE_LIBRARY)
30 # include <readline/keymaps.h>
31 # include <readline/tilde.h>
34 /* Readline data structures. */
36 /* Maintaining the state of undo. We remember individual deletes and inserts
37 on a chain of things to do. */
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 };
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. */
52 /* The current undo list for RL_LINE_BUFFER. */
53 extern UNDO_LIST *rl_undo_list;
55 /* The data structure for mapping textual names to code addresses. */
56 typedef struct _funmap {
61 extern FUNMAP **funmap;
63 /* Functions available to bind to key sequences. */
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 (),
77 rl_do_lowercase_version (), rl_kill_full_line (),
78 rl_digit_argument (), rl_universal_argument (), rl_abort (),
79 rl_undo_command (), rl_revert_line (), rl_beginning_of_history (),
80 rl_end_of_history (), rl_forward_search_history (), rl_insert (),
81 rl_upcase_word (), rl_downcase_word (), rl_capitalize_word (),
82 rl_restart_output (), rl_re_read_init_file (),
83 rl_dump_functions (), rl_dump_variables (), rl_dump_macros (),
84 rl_delete_horizontal_space (), rl_history_search_forward (),
85 rl_history_search_backward (), rl_tty_status (), rl_yank_last_arg (),
86 rl_insert_comment (), rl_backward_char_search (),
87 rl_copy_forward_word (), rl_copy_backward_word ();
89 /* Not available unless readline is compiled -DPAREN_MATCHING. */
90 extern int rl_insert_close ();
92 /* Not available unless READLINE_CALLBACKS is defined. */
93 extern void rl_callback_handler_install ();
94 extern void rl_callback_read_char ();
95 extern void rl_callback_handler_remove ();
97 /* Not available unless __CYGWIN32__ is defined. */
99 extern int rl_paste_from_clipboard ();
102 /* These are *both* defined even when VI_MODE is not. */
103 extern int rl_vi_editing_mode (), rl_emacs_editing_mode ();
105 /* Non incremental history searching. */
106 extern int rl_noninc_forward_search ();
107 extern int rl_noninc_reverse_search ();
108 extern int rl_noninc_forward_search_again ();
109 extern int rl_noninc_reverse_search_again ();
111 /* Things for vi mode. Not available unless readline is compiled -DVI_MODE. */
112 extern int rl_vi_check ();
114 rl_vi_undo (), rl_vi_redo (), rl_vi_tilde_expand (),
115 rl_vi_movement_mode (), rl_vi_insertion_mode (), rl_vi_arg_digit (),
116 rl_vi_prev_word (), rl_vi_next_word (), rl_vi_char_search (),
117 rl_vi_eof_maybe (), rl_vi_append_mode (), rl_vi_put (),
118 rl_vi_append_eol (), rl_vi_insert_beg (), rl_vi_delete (),
119 rl_vi_first_print (), rl_vi_fword (), rl_vi_fWord (), rl_vi_bword (),
120 rl_vi_bWord (), rl_vi_eword (), rl_vi_eWord (), rl_vi_end_word (),
121 rl_vi_change_case (), rl_vi_match (), rl_vi_bracktype (),
122 rl_vi_change_char (), rl_vi_yank_arg (), rl_vi_search (),
123 rl_vi_search_again (), rl_vi_subst (), rl_vi_overstrike (),
124 rl_vi_overstrike_delete (), rl_vi_replace(), rl_vi_column (),
125 rl_vi_delete_to (), rl_vi_change_to (), rl_vi_yank_to (),
126 rl_vi_complete (), rl_vi_fetch_history (), rl_vi_set_mark (),
127 rl_vi_goto_mark (), rl_vi_back_to_indent ();
129 /* Keyboard macro commands. */
130 extern int rl_start_kbd_macro (), rl_end_kbd_macro ();
131 extern int rl_call_last_kbd_macro ();
132 extern void rl_push_macro_input ();
134 extern int rl_arrow_keys(), rl_refresh_line ();
136 /* **************************************************************** */
138 /* Well Published Functions */
140 /* **************************************************************** */
142 /* Readline functions. */
143 /* Read a line of input. Prompt with PROMPT. A NULL PROMPT means none. */
144 extern char *readline ();
146 /* These functions are from bind.c. */
147 /* rl_add_defun (char *name, Function *function, int key)
148 Add NAME to the list of named functions. Make FUNCTION
149 be the function that gets called.
150 If KEY is not -1, then bind it. */
151 extern int rl_add_defun ();
153 extern Keymap rl_make_bare_keymap ();
154 extern Keymap rl_copy_keymap ();
155 extern Keymap rl_make_keymap ();
156 extern void rl_discard_keymap ();
157 extern Keymap rl_get_keymap (), rl_get_keymap_by_name ();
158 extern void rl_set_keymap ();
159 extern char *rl_get_keymap_name ();
161 extern int rl_bind_key (), rl_bind_key_in_map ();
162 extern int rl_unbind_key (), rl_unbind_key_in_map ();
163 extern int rl_unbind_function_in_map (), rl_unbind_command_in_map ();
164 extern int rl_set_key ();
165 extern int rl_generic_bind ();
166 extern int rl_parse_and_bind ();
167 /* Backwards compatibility, use rl_generic_bind instead. */
168 extern int rl_macro_bind (), rl_variable_bind ();
170 extern int rl_read_init_file ();
172 extern Function *rl_named_function (), *rl_function_of_keyseq ();
173 extern char **rl_invoking_keyseqs (), **rl_invoking_keyseqs_in_map ();
174 extern void rl_function_dumper ();
175 extern void rl_variable_dumper ();
176 extern void rl_macro_dumper ();
177 extern void rl_list_funmap_names ();
179 /* Undocumented in the texinfo manual; not really useful to programs. */
180 extern int rl_translate_keyseq ();
181 extern void rl_initialize_funmap ();
183 /* Functions for undoing. */
184 extern int rl_begin_undo_group (), rl_end_undo_group ();
185 extern void rl_add_undo (), free_undo_list ();
186 extern int rl_do_undo ();
187 extern int rl_modifying ();
189 /* Functions for redisplay. */
190 extern void rl_redisplay ();
191 extern int rl_forced_update_display ();
192 extern int rl_clear_message ();
193 extern int rl_reset_line_state ();
194 extern int rl_on_new_line ();
196 #if defined (__STDC__) && defined (USE_VARARGS) && defined (PREFER_STDARG)
197 extern int rl_message (const char *, ...);
199 extern int rl_message ();
202 /* Undocumented in texinfo manual. */
203 extern int rl_character_len ();
204 extern int rl_show_char ();
207 /* Modifying text. */
208 extern int rl_insert_text (), rl_delete_text ();
209 extern int rl_kill_text ();
210 extern char *rl_copy_text ();
212 /* `Public' utility functions. */
213 extern int rl_reset_terminal ();
214 extern int rl_stuff_char ();
215 extern int rl_read_key (), rl_getc ();
217 extern int rl_initialize ();
220 extern int rl_expand_prompt ();
221 extern int rl_set_signals (), rl_clear_signals ();
222 extern int maybe_save_line (), maybe_unsave_line (), maybe_replace_line ();
224 /* Completion functions. */
225 /* These functions are from complete.c. */
226 extern int rl_complete_internal ();
228 /* Return an array of strings which are the result of repeatadly calling
230 extern char **completion_matches ();
231 extern char *username_completion_function ();
232 extern char *filename_completion_function ();
234 /* **************************************************************** */
236 /* Well Published Variables */
238 /* **************************************************************** */
240 /* The version of this incarnation of the readline library. */
241 extern char *rl_library_version;
243 /* The name of the calling program. You should initialize this to
244 whatever was in argv[0]. It is used when parsing conditionals. */
245 extern char *rl_readline_name;
247 /* The prompt readline uses. This is set from the argument to
248 readline (), and should not be assigned to directly. */
249 extern char *rl_prompt;
251 /* The line buffer that is in use. */
252 extern char *rl_line_buffer;
254 /* The location of point, and end. */
255 extern int rl_point, rl_end;
261 extern int rl_pending_input;
263 /* Non-zero if we called this function from _rl_dispatch(). It's present
264 so functions can find out whether they were called from a key binding
265 or directly from an application. */
266 extern int rl_dispatching;
268 /* The name of the terminal to use. */
269 extern char *rl_terminal_name;
271 /* The input and output streams. */
272 extern FILE *rl_instream, *rl_outstream;
274 /* If non-zero, then this is the address of a function to call just
275 before readline_internal () prints the first prompt. */
276 extern Function *rl_startup_hook;
278 /* The address of a function to call periodically while Readline is
279 awaiting character input, or NULL, for no event handling. */
280 extern Function *rl_event_hook;
282 extern Function *rl_getc_function;
283 extern VFunction *rl_redisplay_function;
284 extern VFunction *rl_prep_term_function;
285 extern VFunction *rl_deprep_term_function;
287 /* Dispatch variables. */
288 extern Keymap rl_executing_keymap;
289 extern Keymap rl_binding_keymap;
291 /* Completion variables. */
292 /* Pointer to the generator function for completion_matches ().
293 NULL means to use filename_entry_function (), the default filename
295 extern Function *rl_completion_entry_function;
297 /* If rl_ignore_some_completions_function is non-NULL it is the address
298 of a function to call after all of the possible matches have been
299 generated, but before the actual completion is done to the input line.
300 The function is called with one argument; a NULL terminated array
301 of (char *). If your function removes any of the elements, they
302 must be free()'ed. */
303 extern Function *rl_ignore_some_completions_function;
305 /* Pointer to alternative function to create matches.
306 Function is called with TEXT, START, and END.
307 START and END are indices in RL_LINE_BUFFER saying what the boundaries
309 If this function exists and returns NULL then call the value of
310 rl_completion_entry_function to try to match, otherwise use the
311 array of strings returned. */
312 extern CPPFunction *rl_attempted_completion_function;
314 /* The basic list of characters that signal a break between words for the
315 completer routine. The initial contents of this variable is what
316 breaks words in the shell, i.e. "n\"\\'`@$>". */
317 extern char *rl_basic_word_break_characters;
319 /* The list of characters that signal a break between words for
320 rl_complete_internal. The default list is the contents of
321 rl_basic_word_break_characters. */
322 extern char *rl_completer_word_break_characters;
324 /* List of characters which can be used to quote a substring of the line.
325 Completion occurs on the entire substring, and within the substring
326 rl_completer_word_break_characters are treated as any other character,
327 unless they also appear within this list. */
328 extern char *rl_completer_quote_characters;
330 /* List of quote characters which cause a word break. */
331 extern char *rl_basic_quote_characters;
333 /* List of characters that need to be quoted in filenames by the completer. */
334 extern char *rl_filename_quote_characters;
336 /* List of characters that are word break characters, but should be left
337 in TEXT when it is passed to the completion function. The shell uses
338 this to help determine what kind of completing to do. */
339 extern char *rl_special_prefixes;
341 /* If non-zero, then this is the address of a function to call when
342 completing on a directory name. The function is called with
343 the address of a string (the current directory name) as an arg. */
344 extern Function *rl_directory_completion_hook;
346 /* Backwards compatibility with previous versions of readline. */
347 #define rl_symbolic_link_hook rl_directory_completion_hook
349 /* Non-zero means that the results of the matches are to be treated
350 as filenames. This is ALWAYS zero on entry, and can only be changed
351 within a completion entry finder function. */
352 extern int rl_filename_completion_desired;
354 /* Non-zero means that the results of the matches are to be quoted using
355 double quotes (or an application-specific quoting mechanism) if the
356 filename contains any characters in rl_word_break_chars. This is
357 ALWAYS non-zero on entry, and can only be changed within a completion
358 entry finder function. */
359 extern int rl_filename_quoting_desired;
361 /* Set to a function to quote a filename in an application-specific fashion.
362 Called with the text to quote, the type of match found (single or multiple)
363 and a pointer to the quoting character to be used, which the function can
365 extern CPFunction *rl_filename_quoting_function;
367 /* Function to call to remove quoting characters from a filename. Called
368 before completion is attempted, so the embedded quotes do not interfere
369 with matching names in the file system. */
370 extern CPFunction *rl_filename_dequoting_function;
372 /* Function to call to decide whether or not a word break character is
373 quoted. If a character is quoted, it does not break words for the
375 extern Function *rl_char_is_quoted_p;
377 /* Non-zero means to suppress normal filename completion after the
378 user-specified completion function has been called. */
379 extern int rl_attempted_completion_over;
381 /* Set to a character describing the type of completion being attempted by
382 rl_complete_internal; available for use by application completion
384 extern int rl_completion_type;
386 /* Character appended to completed words when at the end of the line. The
387 default is a space. Nothing is added if this is '\0'. */
388 extern int rl_completion_append_character;
390 /* Up to this many items will be displayed in response to a
391 possible-completions call. After that, we ask the user if she
392 is sure she wants to see them all. The default value is 100. */
393 extern int rl_completion_query_items;
395 /* If non-zero, then disallow duplicates in the matches. */
396 extern int rl_ignore_completion_duplicates;
398 /* If this is non-zero, completion is (temporarily) inhibited, and the
399 completion character will be inserted as any other. */
400 extern int rl_inhibit_completion;
402 /* Definitions available for use by readline clients. */
403 #define RL_PROMPT_START_IGNORE '\001'
404 #define RL_PROMPT_END_IGNORE '\002'
406 /* Possible values for do_replace argument to rl_filename_quoting_function,
407 called by rl_complete_internal. */
409 #define SINGLE_MATCH 1
412 #if !defined (savestring)
413 extern char *savestring (); /* XXX backwards compatibility */
416 #endif /* _READLINE_H_ */