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. */
25 #if !defined (_READLINE_H_)
32 #if defined (READLINE_LIBRARY)
37 # include <readline/rlstdc.h>
38 # include <readline/keymaps.h>
39 # include <readline/tilde.h>
42 /* Readline data structures. */
44 /* Maintaining the state of undo. We remember individual deletes and inserts
45 on a chain of things to do. */
47 /* The actions that undo knows how to undo. Notice that UNDO_DELETE means
48 to insert some text, and UNDO_INSERT means to delete some text. I.e.,
49 the code tells undo what to undo, not how to undo it. */
50 enum undo_code { UNDO_DELETE, UNDO_INSERT, UNDO_BEGIN, UNDO_END };
52 /* What an element of THE_UNDO_LIST looks like. */
53 typedef struct undo_list {
54 struct undo_list *next;
55 int start, end; /* Where the change took place. */
56 char *text; /* The text to insert, if undoing a delete. */
57 enum undo_code what; /* Delete, Insert, Begin, End. */
60 /* The current undo list for RL_LINE_BUFFER. */
61 extern UNDO_LIST *rl_undo_list;
63 /* The data structure for mapping textual names to code addresses. */
64 typedef struct _funmap {
69 extern FUNMAP **funmap;
71 /* **************************************************************** */
73 /* Functions available to bind to key sequences */
75 /* **************************************************************** */
77 /* Bindable commands for numeric arguments. */
78 extern int rl_digit_argument __P((int, int));
79 extern int rl_universal_argument __P((int, int));
81 /* Bindable commands for moving the cursor. */
82 extern int rl_forward __P((int, int));
83 extern int rl_backward __P((int, int));
84 extern int rl_beg_of_line __P((int, int));
85 extern int rl_end_of_line __P((int, int));
86 extern int rl_forward_word __P((int, int));
87 extern int rl_backward_word __P((int, int));
88 extern int rl_refresh_line __P((int, int));
89 extern int rl_clear_screen __P((int, int));
90 extern int rl_arrow_keys __P((int, int));
92 /* Bindable commands for inserting and deleting text. */
93 extern int rl_insert __P((int, int));
94 extern int rl_quoted_insert __P((int, int));
95 extern int rl_tab_insert __P((int, int));
96 extern int rl_newline __P((int, int));
97 extern int rl_do_lowercase_version __P((int, int));
98 extern int rl_rubout __P((int, int));
99 extern int rl_delete __P((int, int));
100 extern int rl_rubout_or_delete __P((int, int));
101 extern int rl_delete_horizontal_space __P((int, int));
102 extern int rl_delete_or_show_completions __P((int, int));
103 extern int rl_insert_comment __P((int, int));
105 /* Bindable commands for changing case. */
106 extern int rl_upcase_word __P((int, int));
107 extern int rl_downcase_word __P((int, int));
108 extern int rl_capitalize_word __P((int, int));
110 /* Bindable commands for transposing characters and words. */
111 extern int rl_transpose_words __P((int, int));
112 extern int rl_transpose_chars __P((int, int));
114 /* Bindable commands for searching within a line. */
115 extern int rl_char_search __P((int, int));
116 extern int rl_backward_char_search __P((int, int));
118 /* Bindable commands for readline's interface to the command history. */
119 extern int rl_beginning_of_history __P((int, int));
120 extern int rl_end_of_history __P((int, int));
121 extern int rl_get_next_history __P((int, int));
122 extern int rl_get_previous_history __P((int, int));
124 /* Bindable commands for managing the mark and region. */
125 extern int rl_set_mark __P((int, int));
126 extern int rl_exchange_point_and_mark __P((int, int));
128 /* Bindable commands to set the editing mode (emacs or vi). */
129 extern int rl_vi_editing_mode __P((int, int));
130 extern int rl_emacs_editing_mode __P((int, int));
132 /* Bindable commands for managing key bindings. */
133 extern int rl_re_read_init_file __P((int, int));
134 extern int rl_dump_functions __P((int, int));
135 extern int rl_dump_macros __P((int, int));
136 extern int rl_dump_variables __P((int, int));
138 /* Bindable commands for word completion. */
139 extern int rl_complete __P((int, int));
140 extern int rl_possible_completions __P((int, int));
141 extern int rl_insert_completions __P((int, int));
142 extern int rl_menu_complete __P((int, int));
144 /* Bindable commands for killing and yanking text, and managing the kill ring. */
145 extern int rl_kill_word __P((int, int));
146 extern int rl_backward_kill_word __P((int, int));
147 extern int rl_kill_line __P((int, int));
148 extern int rl_backward_kill_line __P((int, int));
149 extern int rl_kill_full_line __P((int, int));
150 extern int rl_unix_word_rubout __P((int, int));
151 extern int rl_unix_line_discard __P((int, int));
152 extern int rl_copy_region_to_kill __P((int, int));
153 extern int rl_kill_region __P((int, int));
154 extern int rl_copy_forward_word __P((int, int));
155 extern int rl_copy_backward_word __P((int, int));
156 extern int rl_yank __P((int, int));
157 extern int rl_yank_pop __P((int, int));
158 extern int rl_yank_nth_arg __P((int, int));
159 extern int rl_yank_last_arg __P((int, int));
160 /* Not available unless __CYGWIN32__ is defined. */
162 extern int rl_paste_from_clipboard __P((int, int));
165 /* Bindable commands for incremental searching. */
166 extern int rl_reverse_search_history __P((int, int));
167 extern int rl_forward_search_history __P((int, int));
169 /* Bindable keyboard macro commands. */
170 extern int rl_start_kbd_macro __P((int, int));
171 extern int rl_end_kbd_macro __P((int, int));
172 extern int rl_call_last_kbd_macro __P((int, int));
174 /* Bindable undo commands. */
175 extern int rl_revert_line __P((int, int));
176 extern int rl_undo_command __P((int, int));
178 /* Bindable tilde expansion commands. */
179 extern int rl_tilde_expand __P((int, int));
181 /* Bindable terminal control commands. */
182 extern int rl_restart_output __P((int, int));
183 extern int rl_stop_output __P((int, int));
185 /* Miscellaneous bindable commands. */
186 extern int rl_abort __P((int, int));
187 extern int rl_tty_status __P((int, int));
189 /* Bindable commands for incremental and non-incremental history searching. */
190 extern int rl_history_search_forward __P((int, int));
191 extern int rl_history_search_backward __P((int, int));
192 extern int rl_noninc_forward_search __P((int, int));
193 extern int rl_noninc_reverse_search __P((int, int));
194 extern int rl_noninc_forward_search_again __P((int, int));
195 extern int rl_noninc_reverse_search_again __P((int, int));
197 /* Not available unless readline is compiled -DPAREN_MATCHING. */
198 extern int rl_insert_close __P((int, int));
200 /* Not available unless READLINE_CALLBACKS is defined. */
201 extern void rl_callback_handler_install __P((char *, VFunction *));
202 extern void rl_callback_read_char __P((void));
203 extern void rl_callback_handler_remove __P((void));
205 /* Things for vi mode. Not available unless readline is compiled -DVI_MODE. */
206 /* VI-mode bindable commands. */
207 extern int rl_vi_redo __P((int, int));
208 extern int rl_vi_undo __P((int, int));
209 extern int rl_vi_yank_arg __P((int, int));
210 extern int rl_vi_fetch_history __P((int, int));
211 extern int rl_vi_search_again __P((int, int));
212 extern int rl_vi_search __P((int, int));
213 extern int rl_vi_complete __P((int, int));
214 extern int rl_vi_tilde_expand __P((int, int));
215 extern int rl_vi_prev_word __P((int, int));
216 extern int rl_vi_next_word __P((int, int));
217 extern int rl_vi_end_word __P((int, int));
218 extern int rl_vi_insert_beg __P((int, int));
219 extern int rl_vi_append_mode __P((int, int));
220 extern int rl_vi_append_eol __P((int, int));
221 extern int rl_vi_eof_maybe __P((int, int));
222 extern int rl_vi_insertion_mode __P((int, int));
223 extern int rl_vi_movement_mode __P((int, int));
224 extern int rl_vi_arg_digit __P((int, int));
225 extern int rl_vi_change_case __P((int, int));
226 extern int rl_vi_put __P((int, int));
227 extern int rl_vi_column __P((int, int));
228 extern int rl_vi_delete_to __P((int, int));
229 extern int rl_vi_change_to __P((int, int));
230 extern int rl_vi_yank_to __P((int, int));
231 extern int rl_vi_delete __P((int, int));
232 extern int rl_vi_back_to_indent __P((int, int));
233 extern int rl_vi_first_print __P((int, int));
234 extern int rl_vi_char_search __P((int, int));
235 extern int rl_vi_match __P((int, int));
236 extern int rl_vi_change_char __P((int, int));
237 extern int rl_vi_subst __P((int, int));
238 extern int rl_vi_overstrike __P((int, int));
239 extern int rl_vi_overstrike_delete __P((int, int));
240 extern int rl_vi_replace __P((int, int));
241 extern int rl_vi_set_mark __P((int, int));
242 extern int rl_vi_goto_mark __P((int, int));
244 /* VI-mode utility functions. */
245 extern int rl_vi_check __P((void));
246 extern int rl_vi_domove __P((int, int *));
247 extern int rl_vi_bracktype __P((int));
249 /* VI-mode pseudo-bindable commands, used as utility functions. */
250 extern int rl_vi_fWord __P((int, int));
251 extern int rl_vi_bWord __P((int, int));
252 extern int rl_vi_eWord __P((int, int));
253 extern int rl_vi_fword __P((int, int));
254 extern int rl_vi_bword __P((int, int));
255 extern int rl_vi_eword __P((int, int));
257 /* **************************************************************** */
259 /* Well Published Functions */
261 /* **************************************************************** */
263 /* Readline functions. */
264 /* Read a line of input. Prompt with PROMPT. A NULL PROMPT means none. */
265 extern char *readline __P((char *));
267 extern int rl_initialize __P((void));
269 extern int rl_discard_argument __P((void));
271 /* Utility functions to bind keys to readline commands. */
272 extern int rl_add_defun __P((char *, Function *, int));
273 extern int rl_bind_key __P((int, Function *));
274 extern int rl_bind_key_in_map __P((int, Function *, Keymap));
275 extern int rl_unbind_key __P((int));
276 extern int rl_unbind_key_in_map __P((int, Keymap));
277 extern int rl_unbind_function_in_map __P((Function *, Keymap));
278 extern int rl_unbind_command_in_map __P((char *, Keymap));
279 extern int rl_set_key __P((char *, Function *, Keymap));
280 extern int rl_generic_bind __P((int, char *, char *, Keymap));
281 extern int rl_variable_bind __P((char *, char *));
283 /* Backwards compatibility, use rl_generic_bind instead. */
284 extern int rl_macro_bind __P((char *, char *, Keymap));
286 /* Undocumented in the texinfo manual; not really useful to programs. */
287 extern int rl_translate_keyseq __P((char *, char *, int *));
288 extern char *rl_untranslate_keyseq __P((int));
290 extern Function *rl_named_function __P((char *));
291 extern Function *rl_function_of_keyseq __P((char *, Keymap, int *));
293 extern void rl_list_funmap_names __P((void));
294 extern char **rl_invoking_keyseqs_in_map __P((Function *, Keymap));
295 extern char **rl_invoking_keyseqs __P((Function *));
297 extern void rl_function_dumper __P((int));
298 extern void rl_macro_dumper __P((int));
299 extern void rl_variable_dumper __P((int));
301 extern int rl_read_init_file __P((char *));
302 extern int rl_parse_and_bind __P((char *));
304 /* Functions for manipulating keymaps. */
305 extern char *rl_get_keymap_name __P((Keymap));
306 extern void rl_set_keymap_from_edit_mode __P((void));
307 extern char *rl_get_keymap_name_from_edit_mode __P((void));
309 /* Functions for manipulating the funmap, which maps command names to functions. */
310 extern int rl_add_funmap_entry __P((char *, Function *));
311 extern void rl_initialize_funmap __P((void));
312 extern char **rl_funmap_names __P((void));
314 /* Utility functions for managing keyboard macros. */
315 extern void rl_push_macro_input __P((char *));
317 /* Functions for undoing, from undo.c */
318 extern void rl_add_undo __P((enum undo_code, int, int, char *));
319 extern void free_undo_list __P((void));
320 extern int rl_do_undo __P((void));
321 extern int rl_begin_undo_group __P((void));
322 extern int rl_end_undo_group __P((void));
323 extern int rl_modifying __P((int, int));
325 /* Functions for redisplay. */
326 extern void rl_redisplay __P((void));
327 extern int rl_on_new_line __P((void));
328 extern int rl_forced_update_display __P((void));
329 extern int rl_clear_message __P((void));
330 extern int rl_reset_line_state __P((void));
332 #if defined (__STDC__) && defined (USE_VARARGS) && defined (PREFER_STDARG)
333 extern int rl_message (const char *, ...);
335 extern int rl_message ();
338 /* Undocumented in texinfo manual. */
339 extern int rl_show_char __P((int));
340 extern int rl_character_len __P((int, int));
341 extern int crlf __P((void));
343 /* Save and restore internal prompt redisplay information. */
344 extern void rl_save_prompt __P((void));
345 extern void rl_restore_prompt __P((void));
347 /* Modifying text. */
348 extern int rl_insert_text __P((char *));
349 extern int rl_delete_text __P((int, int));
350 extern int rl_kill_text __P((int, int));
351 extern char *rl_copy_text __P((int, int));
353 /* Terminal and tty mode management. */
354 extern void rl_prep_terminal __P((int));
355 extern void rl_deprep_terminal __P((void));
356 extern void rltty_set_default_bindings __P((Keymap));
358 extern int rl_reset_terminal __P((char *));
359 extern void rl_resize_terminal __P((void));
361 /* `Public' utility functions . */
362 extern void rl_extend_line_buffer __P((int));
363 extern int ding __P((void));
365 /* Functions for character input. */
366 extern int rl_stuff_char __P((int));
367 extern int rl_execute_next __P((int));
368 extern int rl_read_key __P((void));
369 extern int rl_getc __P((FILE *));
371 /* Readline signal handling, from signals.c */
372 extern int rl_set_signals __P((void));
373 extern int rl_clear_signals __P((void));
374 extern void rl_cleanup_after_signal __P((void));
375 extern void rl_reset_after_signal __P((void));
376 extern void rl_free_line_state __P((void));
379 extern int rl_expand_prompt __P((char *));
381 extern int maybe_save_line __P((void));
382 extern int maybe_unsave_line __P((void));
383 extern int maybe_replace_line __P((void));
385 /* Completion functions. */
386 extern int rl_complete_internal __P((int));
387 extern void rl_display_match_list __P((char **, int, int));
389 extern char **completion_matches __P((char *, CPFunction *));
390 extern char *username_completion_function __P((char *, int));
391 extern char *filename_completion_function __P((char *, int));
393 /* **************************************************************** */
395 /* Well Published Variables */
397 /* **************************************************************** */
399 /* The version of this incarnation of the readline library. */
400 extern char *rl_library_version;
402 /* The name of the calling program. You should initialize this to
403 whatever was in argv[0]. It is used when parsing conditionals. */
404 extern char *rl_readline_name;
406 /* The prompt readline uses. This is set from the argument to
407 readline (), and should not be assigned to directly. */
408 extern char *rl_prompt;
410 /* The line buffer that is in use. */
411 extern char *rl_line_buffer;
413 /* The location of point, and end. */
414 extern int rl_point, rl_end;
416 /* The mark, or saved cursor position. */
419 /* Flag to indicate that readline has finished with the current input
420 line and should return it. */
423 /* If set to a character value, that will be the next keystroke read. */
424 extern int rl_pending_input;
426 /* Non-zero if we called this function from _rl_dispatch(). It's present
427 so functions can find out whether they were called from a key binding
428 or directly from an application. */
429 extern int rl_dispatching;
431 /* The name of the terminal to use. */
432 extern char *rl_terminal_name;
434 /* The input and output streams. */
435 extern FILE *rl_instream, *rl_outstream;
437 /* If non-zero, then this is the address of a function to call just
438 before readline_internal () prints the first prompt. */
439 extern Function *rl_startup_hook;
441 /* If non-zero, this is the address of a function to call just before
442 readline_internal_setup () returns and readline_internal starts
443 reading input characters. */
444 extern Function *rl_pre_input_hook;
446 /* The address of a function to call periodically while Readline is
447 awaiting character input, or NULL, for no event handling. */
448 extern Function *rl_event_hook;
450 extern Function *rl_getc_function;
451 extern VFunction *rl_redisplay_function;
452 extern VFunction *rl_prep_term_function;
453 extern VFunction *rl_deprep_term_function;
455 /* Dispatch variables. */
456 extern Keymap rl_executing_keymap;
457 extern Keymap rl_binding_keymap;
459 /* Display variables. */
460 /* If non-zero, readline will erase the entire line, including any prompt,
461 if the only thing typed on an otherwise-blank line is something bound to
463 extern int rl_erase_empty_line;
465 /* Variables to control readline signal handling. */
466 /* If non-zero, readline will install its own signal handlers for
467 SIGINT, SIGTERM, SIGQUIT, SIGALRM, SIGTSTP, SIGTTIN, and SIGTTOU. */
468 extern int rl_catch_signals;
470 /* If non-zero, readline will install a signal handler for SIGWINCH
471 that also attempts to call any calling application's SIGWINCH signal
472 handler. Note that the terminal is not cleaned up before the
473 application's signal handler is called; use rl_cleanup_after_signal()
475 extern int rl_catch_sigwinch;
477 /* Completion variables. */
478 /* Pointer to the generator function for completion_matches ().
479 NULL means to use filename_entry_function (), the default filename
481 extern Function *rl_completion_entry_function;
483 /* If rl_ignore_some_completions_function is non-NULL it is the address
484 of a function to call after all of the possible matches have been
485 generated, but before the actual completion is done to the input line.
486 The function is called with one argument; a NULL terminated array
487 of (char *). If your function removes any of the elements, they
488 must be free()'ed. */
489 extern Function *rl_ignore_some_completions_function;
491 /* Pointer to alternative function to create matches.
492 Function is called with TEXT, START, and END.
493 START and END are indices in RL_LINE_BUFFER saying what the boundaries
495 If this function exists and returns NULL then call the value of
496 rl_completion_entry_function to try to match, otherwise use the
497 array of strings returned. */
498 extern CPPFunction *rl_attempted_completion_function;
500 /* The basic list of characters that signal a break between words for the
501 completer routine. The initial contents of this variable is what
502 breaks words in the shell, i.e. "n\"\\'`@$>". */
503 extern char *rl_basic_word_break_characters;
505 /* The list of characters that signal a break between words for
506 rl_complete_internal. The default list is the contents of
507 rl_basic_word_break_characters. */
508 extern char *rl_completer_word_break_characters;
510 /* List of characters which can be used to quote a substring of the line.
511 Completion occurs on the entire substring, and within the substring
512 rl_completer_word_break_characters are treated as any other character,
513 unless they also appear within this list. */
514 extern char *rl_completer_quote_characters;
516 /* List of quote characters which cause a word break. */
517 extern char *rl_basic_quote_characters;
519 /* List of characters that need to be quoted in filenames by the completer. */
520 extern char *rl_filename_quote_characters;
522 /* List of characters that are word break characters, but should be left
523 in TEXT when it is passed to the completion function. The shell uses
524 this to help determine what kind of completing to do. */
525 extern char *rl_special_prefixes;
527 /* If non-zero, then this is the address of a function to call when
528 completing on a directory name. The function is called with
529 the address of a string (the current directory name) as an arg. */
530 extern Function *rl_directory_completion_hook;
532 /* Backwards compatibility with previous versions of readline. */
533 #define rl_symbolic_link_hook rl_directory_completion_hook
535 /* If non-zero, then this is the address of a function to call when
536 completing a word would normally display the list of possible matches.
537 This function is called instead of actually doing the display.
538 It takes three arguments: (char **matches, int num_matches, int max_length)
539 where MATCHES is the array of strings that matched, NUM_MATCHES is the
540 number of strings in that array, and MAX_LENGTH is the length of the
541 longest string in that array. */
542 extern VFunction *rl_completion_display_matches_hook;
544 /* Non-zero means that the results of the matches are to be treated
545 as filenames. This is ALWAYS zero on entry, and can only be changed
546 within a completion entry finder function. */
547 extern int rl_filename_completion_desired;
549 /* Non-zero means that the results of the matches are to be quoted using
550 double quotes (or an application-specific quoting mechanism) if the
551 filename contains any characters in rl_word_break_chars. This is
552 ALWAYS non-zero on entry, and can only be changed within a completion
553 entry finder function. */
554 extern int rl_filename_quoting_desired;
556 /* Set to a function to quote a filename in an application-specific fashion.
557 Called with the text to quote, the type of match found (single or multiple)
558 and a pointer to the quoting character to be used, which the function can
560 extern CPFunction *rl_filename_quoting_function;
562 /* Function to call to remove quoting characters from a filename. Called
563 before completion is attempted, so the embedded quotes do not interfere
564 with matching names in the file system. */
565 extern CPFunction *rl_filename_dequoting_function;
567 /* Function to call to decide whether or not a word break character is
568 quoted. If a character is quoted, it does not break words for the
570 extern Function *rl_char_is_quoted_p;
572 /* Non-zero means to suppress normal filename completion after the
573 user-specified completion function has been called. */
574 extern int rl_attempted_completion_over;
576 /* Set to a character describing the type of completion being attempted by
577 rl_complete_internal; available for use by application completion
579 extern int rl_completion_type;
581 /* Character appended to completed words when at the end of the line. The
582 default is a space. Nothing is added if this is '\0'. */
583 extern int rl_completion_append_character;
585 /* Up to this many items will be displayed in response to a
586 possible-completions call. After that, we ask the user if she
587 is sure she wants to see them all. The default value is 100. */
588 extern int rl_completion_query_items;
590 /* If non-zero, then disallow duplicates in the matches. */
591 extern int rl_ignore_completion_duplicates;
593 /* If this is non-zero, completion is (temporarily) inhibited, and the
594 completion character will be inserted as any other. */
595 extern int rl_inhibit_completion;
597 /* Definitions available for use by readline clients. */
598 #define RL_PROMPT_START_IGNORE '\001'
599 #define RL_PROMPT_END_IGNORE '\002'
601 /* Possible values for do_replace argument to rl_filename_quoting_function,
602 called by rl_complete_internal. */
604 #define SINGLE_MATCH 1
607 #if !defined (savestring)
608 #define savestring rl_savestring
609 extern char *savestring (); /* XXX backwards compatibility */
616 #endif /* _READLINE_H_ */