1/* Readline.h -- the names of functions callable from within readline. */
2
3/* Copyright (C) 1987-2016 Free Software Foundation, Inc.
4
5 This file is part of the GNU Readline Library (Readline), a library
6 for reading lines of text with interactive input and history editing.
7
8 Readline is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
12
13 Readline is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
17
18 You should have received a copy of the GNU General Public License
19 along with Readline. If not, see <http://www.gnu.org/licenses/>.
20*/
21
22#if !defined (_READLINE_H_)
23#define _READLINE_H_
24
25#ifdef __cplusplus
26extern "C" {
27#endif
28
29#if defined (READLINE_LIBRARY)
30# include "rlstdc.h"
31# include "rltypedefs.h"
32# include "keymaps.h"
33# include "tilde.h"
34#else
35# include <stdio.h>
36# include <readline/rlstdc.h>
37# include <readline/rltypedefs.h>
38# include <readline/keymaps.h>
39# include <readline/tilde.h>
40#endif
41
42/* Hex-encoded Readline version number. */
43#define RL_READLINE_VERSION 0x0700 /* Readline 7.0 */
44#define RL_VERSION_MAJOR 7
45#define RL_VERSION_MINOR 0
46
47/* Readline data structures. */
48
49/* Maintaining the state of undo. We remember individual deletes and inserts
50 on a chain of things to do. */
51
52/* The actions that undo knows how to undo. Notice that UNDO_DELETE means
53 to insert some text, and UNDO_INSERT means to delete some text. I.e.,
54 the code tells undo what to undo, not how to undo it. */
55enum undo_code { UNDO_DELETE, UNDO_INSERT, UNDO_BEGIN, UNDO_END };
56
57/* What an element of THE_UNDO_LIST looks like. */
58typedef struct undo_list {
59 struct undo_list *next;
60 int start, end; /* Where the change took place. */
61 char *text; /* The text to insert, if undoing a delete. */
62 enum undo_code what; /* Delete, Insert, Begin, End. */
63} UNDO_LIST;
64
65/* The current undo list for RL_LINE_BUFFER. */
66extern UNDO_LIST *rl_undo_list;
67
68/* The data structure for mapping textual names to code addresses. */
69typedef struct _funmap {
70 const char *name;
71 rl_command_func_t *function;
72} FUNMAP;
73
74extern FUNMAP **funmap;
75
76/* **************************************************************** */
77/* */
78/* Functions available to bind to key sequences */
79/* */
80/* **************************************************************** */
81
82/* Bindable commands for numeric arguments. */
83extern int rl_digit_argument PARAMS((int, int));
84extern int rl_universal_argument PARAMS((int, int));
85
86/* Bindable commands for moving the cursor. */
87extern int rl_forward_byte PARAMS((int, int));
88extern int rl_forward_char PARAMS((int, int));
89extern int rl_forward PARAMS((int, int));
90extern int rl_backward_byte PARAMS((int, int));
91extern int rl_backward_char PARAMS((int, int));
92extern int rl_backward PARAMS((int, int));
93extern int rl_beg_of_line PARAMS((int, int));
94extern int rl_end_of_line PARAMS((int, int));
95extern int rl_forward_word PARAMS((int, int));
96extern int rl_backward_word PARAMS((int, int));
97extern int rl_refresh_line PARAMS((int, int));
98extern int rl_clear_screen PARAMS((int, int));
99extern int rl_skip_csi_sequence PARAMS((int, int));
100extern int rl_arrow_keys PARAMS((int, int));
101
102/* Bindable commands for inserting and deleting text. */
103extern int rl_insert PARAMS((int, int));
104extern int rl_quoted_insert PARAMS((int, int));
105extern int rl_tab_insert PARAMS((int, int));
106extern int rl_newline PARAMS((int, int));
107extern int rl_do_lowercase_version PARAMS((int, int));
108extern int rl_rubout PARAMS((int, int));
109extern int rl_delete PARAMS((int, int));
110extern int rl_rubout_or_delete PARAMS((int, int));
111extern int rl_delete_horizontal_space PARAMS((int, int));
112extern int rl_delete_or_show_completions PARAMS((int, int));
113extern int rl_insert_comment PARAMS((int, int));
114
115/* Bindable commands for changing case. */
116extern int rl_upcase_word PARAMS((int, int));
117extern int rl_downcase_word PARAMS((int, int));
118extern int rl_capitalize_word PARAMS((int, int));
119
120/* Bindable commands for transposing characters and words. */
121extern int rl_transpose_words PARAMS((int, int));
122extern int rl_transpose_chars PARAMS((int, int));
123
124/* Bindable commands for searching within a line. */
125extern int rl_char_search PARAMS((int, int));
126extern int rl_backward_char_search PARAMS((int, int));
127
128/* Bindable commands for readline's interface to the command history. */
129extern int rl_beginning_of_history PARAMS((int, int));
130extern int rl_end_of_history PARAMS((int, int));
131extern int rl_get_next_history PARAMS((int, int));
132extern int rl_get_previous_history PARAMS((int, int));
133
134/* Bindable commands for managing the mark and region. */
135extern int rl_set_mark PARAMS((int, int));
136extern int rl_exchange_point_and_mark PARAMS((int, int));
137
138/* Bindable commands to set the editing mode (emacs or vi). */
139extern int rl_vi_editing_mode PARAMS((int, int));
140extern int rl_emacs_editing_mode PARAMS((int, int));
141
142/* Bindable commands to change the insert mode (insert or overwrite) */
143extern int rl_overwrite_mode PARAMS((int, int));
144
145/* Bindable commands for managing key bindings. */
146extern int rl_re_read_init_file PARAMS((int, int));
147extern int rl_dump_functions PARAMS((int, int));
148extern int rl_dump_macros PARAMS((int, int));
149extern int rl_dump_variables PARAMS((int, int));
150
151/* Bindable commands for word completion. */
152extern int rl_complete PARAMS((int, int));
153extern int rl_possible_completions PARAMS((int, int));
154extern int rl_insert_completions PARAMS((int, int));
155extern int rl_old_menu_complete PARAMS((int, int));
156extern int rl_menu_complete PARAMS((int, int));
157extern int rl_backward_menu_complete PARAMS((int, int));
158
159/* Bindable commands for killing and yanking text, and managing the kill ring. */
160extern int rl_kill_word PARAMS((int, int));
161extern int rl_backward_kill_word PARAMS((int, int));
162extern int rl_kill_line PARAMS((int, int));
163extern int rl_backward_kill_line PARAMS((int, int));
164extern int rl_kill_full_line PARAMS((int, int));
165extern int rl_unix_word_rubout PARAMS((int, int));
166extern int rl_unix_filename_rubout PARAMS((int, int));
167extern int rl_unix_line_discard PARAMS((int, int));
168extern int rl_copy_region_to_kill PARAMS((int, int));
169extern int rl_kill_region PARAMS((int, int));
170extern int rl_copy_forward_word PARAMS((int, int));
171extern int rl_copy_backward_word PARAMS((int, int));
172extern int rl_yank PARAMS((int, int));
173extern int rl_yank_pop PARAMS((int, int));
174extern int rl_yank_nth_arg PARAMS((int, int));
175extern int rl_yank_last_arg PARAMS((int, int));
176extern int rl_bracketed_paste_begin PARAMS((int, int));
177/* Not available unless _WIN32 is defined. */
178#if defined (_WIN32)
179extern int rl_paste_from_clipboard PARAMS((int, int));
180#endif
181
182/* Bindable commands for incremental searching. */
183extern int rl_reverse_search_history PARAMS((int, int));
184extern int rl_forward_search_history PARAMS((int, int));
185
186/* Bindable keyboard macro commands. */
187extern int rl_start_kbd_macro PARAMS((int, int));
188extern int rl_end_kbd_macro PARAMS((int, int));
189extern int rl_call_last_kbd_macro PARAMS((int, int));
190extern int rl_print_last_kbd_macro PARAMS((int, int));
191
192/* Bindable undo commands. */
193extern int rl_revert_line PARAMS((int, int));
194extern int rl_undo_command PARAMS((int, int));
195
196/* Bindable tilde expansion commands. */
197extern int rl_tilde_expand PARAMS((int, int));
198
199/* Bindable terminal control commands. */
200extern int rl_restart_output PARAMS((int, int));
201extern int rl_stop_output PARAMS((int, int));
202
203/* Miscellaneous bindable commands. */
204extern int rl_abort PARAMS((int, int));
205extern int rl_tty_status PARAMS((int, int));
206
207/* Bindable commands for incremental and non-incremental history searching. */
208extern int rl_history_search_forward PARAMS((int, int));
209extern int rl_history_search_backward PARAMS((int, int));
210extern int rl_history_substr_search_forward PARAMS((int, int));
211extern int rl_history_substr_search_backward PARAMS((int, int));
212extern int rl_noninc_forward_search PARAMS((int, int));
213extern int rl_noninc_reverse_search PARAMS((int, int));
214extern int rl_noninc_forward_search_again PARAMS((int, int));
215extern int rl_noninc_reverse_search_again PARAMS((int, int));
216
217/* Bindable command used when inserting a matching close character. */
218extern int rl_insert_close PARAMS((int, int));
219
220/* Not available unless READLINE_CALLBACKS is defined. */
221extern void rl_callback_handler_install PARAMS((const char *, rl_vcpfunc_t *));
222extern void rl_callback_read_char PARAMS((void));
223extern void rl_callback_handler_remove PARAMS((void));
224extern void rl_callback_sigcleanup PARAMS((void));
225
226/* Things for vi mode. Not available unless readline is compiled -DVI_MODE. */
227/* VI-mode bindable commands. */
228extern int rl_vi_redo PARAMS((int, int));
229extern int rl_vi_undo PARAMS((int, int));
230extern int rl_vi_yank_arg PARAMS((int, int));
231extern int rl_vi_fetch_history PARAMS((int, int));
232extern int rl_vi_search_again PARAMS((int, int));
233extern int rl_vi_search PARAMS((int, int));
234extern int rl_vi_complete PARAMS((int, int));
235extern int rl_vi_tilde_expand PARAMS((int, int));
236extern int rl_vi_prev_word PARAMS((int, int));
237extern int rl_vi_next_word PARAMS((int, int));
238extern int rl_vi_end_word PARAMS((int, int));
239extern int rl_vi_insert_beg PARAMS((int, int));
240extern int rl_vi_append_mode PARAMS((int, int));
241extern int rl_vi_append_eol PARAMS((int, int));
242extern int rl_vi_eof_maybe PARAMS((int, int));
243extern int rl_vi_insertion_mode PARAMS((int, int));
244extern int rl_vi_insert_mode PARAMS((int, int));
245extern int rl_vi_movement_mode PARAMS((int, int));
246extern int rl_vi_arg_digit PARAMS((int, int));
247extern int rl_vi_change_case PARAMS((int, int));
248extern int rl_vi_put PARAMS((int, int));
249extern int rl_vi_column PARAMS((int, int));
250extern int rl_vi_delete_to PARAMS((int, int));
251extern int rl_vi_change_to PARAMS((int, int));
252extern int rl_vi_yank_to PARAMS((int, int));
253extern int rl_vi_yank_pop PARAMS((int, int));
254extern int rl_vi_rubout PARAMS((int, int));
255extern int rl_vi_delete PARAMS((int, int));
256extern int rl_vi_back_to_indent PARAMS((int, int));
257extern int rl_vi_unix_word_rubout PARAMS((int, int));
258extern int rl_vi_first_print PARAMS((int, int));
259extern int rl_vi_char_search PARAMS((int, int));
260extern int rl_vi_match PARAMS((int, int));
261extern int rl_vi_change_char PARAMS((int, int));
262extern int rl_vi_subst PARAMS((int, int));
263extern int rl_vi_overstrike PARAMS((int, int));
264extern int rl_vi_overstrike_delete PARAMS((int, int));
265extern int rl_vi_replace PARAMS((int, int));
266extern int rl_vi_set_mark PARAMS((int, int));
267extern int rl_vi_goto_mark PARAMS((int, int));
268
269/* VI-mode utility functions. */
270extern int rl_vi_check PARAMS((void));
271extern int rl_vi_domove PARAMS((int, int *));
272extern int rl_vi_bracktype PARAMS((int));
273
274extern void rl_vi_start_inserting PARAMS((int, int, int));
275
276/* VI-mode pseudo-bindable commands, used as utility functions. */
277extern int rl_vi_fWord PARAMS((int, int));
278extern int rl_vi_bWord PARAMS((int, int));
279extern int rl_vi_eWord PARAMS((int, int));
280extern int rl_vi_fword PARAMS((int, int));
281extern int rl_vi_bword PARAMS((int, int));
282extern int rl_vi_eword PARAMS((int, int));
283
284/* **************************************************************** */
285/* */
286/* Well Published Functions */
287/* */
288/* **************************************************************** */
289
290/* Readline functions. */
291/* Read a line of input. Prompt with PROMPT. A NULL PROMPT means none. */
292extern char *readline PARAMS((const char *));
293
294extern int rl_set_prompt PARAMS((const char *));
295extern int rl_expand_prompt PARAMS((char *));
296
297extern int rl_initialize PARAMS((void));
298
299/* Undocumented; unused by readline */
300extern int rl_discard_argument PARAMS((void));
301
302/* Utility functions to bind keys to readline commands. */
303extern int rl_add_defun PARAMS((const char *, rl_command_func_t *, int));
304extern int rl_bind_key PARAMS((int, rl_command_func_t *));
305extern int rl_bind_key_in_map PARAMS((int, rl_command_func_t *, Keymap));
306extern int rl_unbind_key PARAMS((int));
307extern int rl_unbind_key_in_map PARAMS((int, Keymap));
308extern int rl_bind_key_if_unbound PARAMS((int, rl_command_func_t *));
309extern int rl_bind_key_if_unbound_in_map PARAMS((int, rl_command_func_t *, Keymap));
310extern int rl_unbind_function_in_map PARAMS((rl_command_func_t *, Keymap));
311extern int rl_unbind_command_in_map PARAMS((const char *, Keymap));
312extern int rl_bind_keyseq PARAMS((const char *, rl_command_func_t *));
313extern int rl_bind_keyseq_in_map PARAMS((const char *, rl_command_func_t *, Keymap));
314extern int rl_bind_keyseq_if_unbound PARAMS((const char *, rl_command_func_t *));
315extern int rl_bind_keyseq_if_unbound_in_map PARAMS((const char *, rl_command_func_t *, Keymap));
316extern int rl_generic_bind PARAMS((int, const char *, char *, Keymap));
317
318extern char *rl_variable_value PARAMS((const char *));
319extern int rl_variable_bind PARAMS((const char *, const char *));
320
321/* Backwards compatibility, use rl_bind_keyseq_in_map instead. */
322extern int rl_set_key PARAMS((const char *, rl_command_func_t *, Keymap));
323
324/* Backwards compatibility, use rl_generic_bind instead. */
325extern int rl_macro_bind PARAMS((const char *, const char *, Keymap));
326
327/* Undocumented in the texinfo manual; not really useful to programs. */
328extern int rl_translate_keyseq PARAMS((const char *, char *, int *));
329extern char *rl_untranslate_keyseq PARAMS((int));
330
331extern rl_command_func_t *rl_named_function PARAMS((const char *));
332extern rl_command_func_t *rl_function_of_keyseq PARAMS((const char *, Keymap, int *));
333
334extern void rl_list_funmap_names PARAMS((void));
335extern char **rl_invoking_keyseqs_in_map PARAMS((rl_command_func_t *, Keymap));
336extern char **rl_invoking_keyseqs PARAMS((rl_command_func_t *));
337
338extern void rl_function_dumper PARAMS((int));
339extern void rl_macro_dumper PARAMS((int));
340extern void rl_variable_dumper PARAMS((int));
341
342extern int rl_read_init_file PARAMS((const char *));
343extern int rl_parse_and_bind PARAMS((char *));
344
345/* Functions for manipulating keymaps. */
346extern Keymap rl_make_bare_keymap PARAMS((void));
347extern Keymap rl_copy_keymap PARAMS((Keymap));
348extern Keymap rl_make_keymap PARAMS((void));
349extern void rl_discard_keymap PARAMS((Keymap));
350extern void rl_free_keymap PARAMS((Keymap));
351
352extern Keymap rl_get_keymap_by_name PARAMS((const char *));
353extern char *rl_get_keymap_name PARAMS((Keymap));
354extern void rl_set_keymap PARAMS((Keymap));
355extern Keymap rl_get_keymap PARAMS((void));
356/* Undocumented; used internally only. */
357extern void rl_set_keymap_from_edit_mode PARAMS((void));
358extern char *rl_get_keymap_name_from_edit_mode PARAMS((void));
359
360/* Functions for manipulating the funmap, which maps command names to functions. */
361extern int rl_add_funmap_entry PARAMS((const char *, rl_command_func_t *));
362extern const char **rl_funmap_names PARAMS((void));
363/* Undocumented, only used internally -- there is only one funmap, and this
364 function may be called only once. */
365extern void rl_initialize_funmap PARAMS((void));
366
367/* Utility functions for managing keyboard macros. */
368extern void rl_push_macro_input PARAMS((char *));
369
370/* Functions for undoing, from undo.c */
371extern void rl_add_undo PARAMS((enum undo_code, int, int, char *));
372extern void rl_free_undo_list PARAMS((void));
373extern int rl_do_undo PARAMS((void));
374extern int rl_begin_undo_group PARAMS((void));
375extern int rl_end_undo_group PARAMS((void));
376extern int rl_modifying PARAMS((int, int));
377
378/* Functions for redisplay. */
379extern void rl_redisplay PARAMS((void));
380extern int rl_on_new_line PARAMS((void));
381extern int rl_on_new_line_with_prompt PARAMS((void));
382extern int rl_forced_update_display PARAMS((void));
383extern int rl_clear_visible_line PARAMS((void));
384extern int rl_clear_message PARAMS((void));
385extern int rl_reset_line_state PARAMS((void));
386extern int rl_crlf PARAMS((void));
387
388#if defined (USE_VARARGS) && defined (PREFER_STDARG)
389extern int rl_message (const char *, ...) __rl_attribute__((__format__ (printf, 1, 2)));
390#else
391extern int rl_message ();
392#endif
393
394extern int rl_show_char PARAMS((int));
395
396/* Undocumented in texinfo manual. */
397extern int rl_character_len PARAMS((int, int));
398extern void rl_redraw_prompt_last_line PARAMS((void));
399
400/* Save and restore internal prompt redisplay information. */
401extern void rl_save_prompt PARAMS((void));
402extern void rl_restore_prompt PARAMS((void));
403
404/* Modifying text. */
405extern void rl_replace_line PARAMS((const char *, int));
406extern int rl_insert_text PARAMS((const char *));
407extern int rl_delete_text PARAMS((int, int));
408extern int rl_kill_text PARAMS((int, int));
409extern char *rl_copy_text PARAMS((int, int));
410
411/* Terminal and tty mode management. */
412extern void rl_prep_terminal PARAMS((int));
413extern void rl_deprep_terminal PARAMS((void));
414extern void rl_tty_set_default_bindings PARAMS((Keymap));
415extern void rl_tty_unset_default_bindings PARAMS((Keymap));
416
417extern int rl_reset_terminal PARAMS((const char *));
418extern void rl_resize_terminal PARAMS((void));
419extern void rl_set_screen_size PARAMS((int, int));
420extern void rl_get_screen_size PARAMS((int *, int *));
421extern void rl_reset_screen_size PARAMS((void));
422
423extern char *rl_get_termcap PARAMS((const char *));
424
425/* Functions for character input. */
426extern int rl_stuff_char PARAMS((int));
427extern int rl_execute_next PARAMS((int));
428extern int rl_clear_pending_input PARAMS((void));
429extern int rl_read_key PARAMS((void));
430extern int rl_getc PARAMS((FILE *));
431extern int rl_set_keyboard_input_timeout PARAMS((int));
432
433/* `Public' utility functions . */
434extern void rl_extend_line_buffer PARAMS((int));
435extern int rl_ding PARAMS((void));
436extern int rl_alphabetic PARAMS((int));
437extern void rl_free PARAMS((void *));
438
439/* Readline signal handling, from signals.c */
440extern int rl_set_signals PARAMS((void));
441extern int rl_clear_signals PARAMS((void));
442extern void rl_cleanup_after_signal PARAMS((void));
443extern void rl_reset_after_signal PARAMS((void));
444extern void rl_free_line_state PARAMS((void));
445
446extern int rl_pending_signal PARAMS((void));
447
448extern void rl_echo_signal_char PARAMS((int));
449
450extern int rl_set_paren_blink_timeout PARAMS((int));
451
452/* History management functions. */
453
454extern void rl_clear_history PARAMS((void));
455
456/* Undocumented. */
457extern int rl_maybe_save_line PARAMS((void));
458extern int rl_maybe_unsave_line PARAMS((void));
459extern int rl_maybe_replace_line PARAMS((void));
460
461/* Completion functions. */
462extern int rl_complete_internal PARAMS((int));
463extern void rl_display_match_list PARAMS((char **, int, int));
464
465extern char **rl_completion_matches PARAMS((const char *, rl_compentry_func_t *));
466extern char *rl_username_completion_function PARAMS((const char *, int));
467extern char *rl_filename_completion_function PARAMS((const char *, int));
468
469extern int rl_completion_mode PARAMS((rl_command_func_t *));
470
471#if 0
472/* Backwards compatibility (compat.c). These will go away sometime. */
473extern void free_undo_list PARAMS((void));
474extern int maybe_save_line PARAMS((void));
475extern int maybe_unsave_line PARAMS((void));
476extern int maybe_replace_line PARAMS((void));
477
478extern int ding PARAMS((void));
479extern int alphabetic PARAMS((int));
480extern int crlf PARAMS((void));
481
482extern char **completion_matches PARAMS((char *, rl_compentry_func_t *));
483extern char *username_completion_function PARAMS((const char *, int));
484extern char *filename_completion_function PARAMS((const char *, int));
485#endif
486
487/* **************************************************************** */
488/* */
489/* Well Published Variables */
490/* */
491/* **************************************************************** */
492
493/* The version of this incarnation of the readline library. */
494extern const char *rl_library_version; /* e.g., "4.2" */
495extern int rl_readline_version; /* e.g., 0x0402 */
496
497/* True if this is real GNU readline. */
498extern int rl_gnu_readline_p;
499
500/* Flags word encapsulating the current readline state. */
501extern unsigned long rl_readline_state;
502
503/* Says which editing mode readline is currently using. 1 means emacs mode;
504 0 means vi mode. */
505extern int rl_editing_mode;
506
507/* Insert or overwrite mode for emacs mode. 1 means insert mode; 0 means
508 overwrite mode. Reset to insert mode on each input line. */
509extern int rl_insert_mode;
510
511/* The name of the calling program. You should initialize this to
512 whatever was in argv[0]. It is used when parsing conditionals. */
513extern const char *rl_readline_name;
514
515/* The prompt readline uses. This is set from the argument to
516 readline (), and should not be assigned to directly. */
517extern char *rl_prompt;
518
519/* The prompt string that is actually displayed by rl_redisplay. Public so
520 applications can more easily supply their own redisplay functions. */
521extern char *rl_display_prompt;
522
523/* The line buffer that is in use. */
524extern char *rl_line_buffer;
525
526/* The location of point, and end. */
527extern int rl_point;
528extern int rl_end;
529
530/* The mark, or saved cursor position. */
531extern int rl_mark;
532
533/* Flag to indicate that readline has finished with the current input
534 line and should return it. */
535extern int rl_done;
536
537/* If set to a character value, that will be the next keystroke read. */
538extern int rl_pending_input;
539
540/* Non-zero if we called this function from _rl_dispatch(). It's present
541 so functions can find out whether they were called from a key binding
542 or directly from an application. */
543extern int rl_dispatching;
544
545/* Non-zero if the user typed a numeric argument before executing the
546 current function. */
547extern int rl_explicit_arg;
548
549/* The current value of the numeric argument specified by the user. */
550extern int rl_numeric_arg;
551
552/* The address of the last command function Readline executed. */
553extern rl_command_func_t *rl_last_func;
554
555/* The name of the terminal to use. */
556extern const char *rl_terminal_name;
557
558/* The input and output streams. */
559extern FILE *rl_instream;
560extern FILE *rl_outstream;
561
562/* If non-zero, Readline gives values of LINES and COLUMNS from the environment
563 greater precedence than values fetched from the kernel when computing the
564 screen dimensions. */
565extern int rl_prefer_env_winsize;
566
567/* If non-zero, then this is the address of a function to call just
568 before readline_internal () prints the first prompt. */
569extern rl_hook_func_t *rl_startup_hook;
570
571/* If non-zero, this is the address of a function to call just before
572 readline_internal_setup () returns and readline_internal starts
573 reading input characters. */
574extern rl_hook_func_t *rl_pre_input_hook;
575
576/* The address of a function to call periodically while Readline is
577 awaiting character input, or NULL, for no event handling. */
578extern rl_hook_func_t *rl_event_hook;
579
580/* The address of a function to call if a read is interrupted by a signal. */
581extern rl_hook_func_t *rl_signal_event_hook;
582
583/* The address of a function to call if Readline needs to know whether or not
584 there is data available from the current input source. */
585extern rl_hook_func_t *rl_input_available_hook;
586
587/* The address of the function to call to fetch a character from the current
588 Readline input stream */
589extern rl_getc_func_t *rl_getc_function;
590
591extern rl_voidfunc_t *rl_redisplay_function;
592
593extern rl_vintfunc_t *rl_prep_term_function;
594extern rl_voidfunc_t *rl_deprep_term_function;
595
596/* Dispatch variables. */
597extern Keymap rl_executing_keymap;
598extern Keymap rl_binding_keymap;
599
600extern int rl_executing_key;
601extern char *rl_executing_keyseq;
602extern int rl_key_sequence_length;
603
604/* Display variables. */
605/* If non-zero, readline will erase the entire line, including any prompt,
606 if the only thing typed on an otherwise-blank line is something bound to
607 rl_newline. */
608extern int rl_erase_empty_line;
609
610/* If non-zero, the application has already printed the prompt (rl_prompt)
611 before calling readline, so readline should not output it the first time
612 redisplay is done. */
613extern int rl_already_prompted;
614
615/* A non-zero value means to read only this many characters rather than
616 up to a character bound to accept-line. */
617extern int rl_num_chars_to_read;
618
619/* The text of a currently-executing keyboard macro. */
620extern char *rl_executing_macro;
621
622/* Variables to control readline signal handling. */
623/* If non-zero, readline will install its own signal handlers for
624 SIGINT, SIGTERM, SIGQUIT, SIGALRM, SIGTSTP, SIGTTIN, and SIGTTOU. */
625extern int rl_catch_signals;
626
627/* If non-zero, readline will install a signal handler for SIGWINCH
628 that also attempts to call any calling application's SIGWINCH signal
629 handler. Note that the terminal is not cleaned up before the
630 application's signal handler is called; use rl_cleanup_after_signal()
631 to do that. */
632extern int rl_catch_sigwinch;
633
634/* If non-zero, the readline SIGWINCH handler will modify LINES and
635 COLUMNS in the environment. */
636extern int rl_change_environment;
637
638/* Completion variables. */
639/* Pointer to the generator function for completion_matches ().
640 NULL means to use rl_filename_completion_function (), the default
641 filename completer. */
642extern rl_compentry_func_t *rl_completion_entry_function;
643
644/* Optional generator for menu completion. Default is
645 rl_completion_entry_function (rl_filename_completion_function). */
646extern rl_compentry_func_t *rl_menu_completion_entry_function;
647
648/* If rl_ignore_some_completions_function is non-NULL it is the address
649 of a function to call after all of the possible matches have been
650 generated, but before the actual completion is done to the input line.
651 The function is called with one argument; a NULL terminated array
652 of (char *). If your function removes any of the elements, they
653 must be free()'ed. */
654extern rl_compignore_func_t *rl_ignore_some_completions_function;
655
656/* Pointer to alternative function to create matches.
657 Function is called with TEXT, START, and END.
658 START and END are indices in RL_LINE_BUFFER saying what the boundaries
659 of TEXT are.
660 If this function exists and returns NULL then call the value of
661 rl_completion_entry_function to try to match, otherwise use the
662 array of strings returned. */
663extern rl_completion_func_t *rl_attempted_completion_function;
664
665/* The basic list of characters that signal a break between words for the
666 completer routine. The initial contents of this variable is what
667 breaks words in the shell, i.e. "n\"\\'`@$>". */
668extern const char *rl_basic_word_break_characters;
669
670/* The list of characters that signal a break between words for
671 rl_complete_internal. The default list is the contents of
672 rl_basic_word_break_characters. */
673extern /*const*/ char *rl_completer_word_break_characters;
674
675/* Hook function to allow an application to set the completion word
676 break characters before readline breaks up the line. Allows
677 position-dependent word break characters. */
678extern rl_cpvfunc_t *rl_completion_word_break_hook;
679
680/* List of characters which can be used to quote a substring of the line.
681 Completion occurs on the entire substring, and within the substring
682 rl_completer_word_break_characters are treated as any other character,
683 unless they also appear within this list. */
684extern const char *rl_completer_quote_characters;
685
686/* List of quote characters which cause a word break. */
687extern const char *rl_basic_quote_characters;
688
689/* List of characters that need to be quoted in filenames by the completer. */
690extern const char *rl_filename_quote_characters;
691
692/* List of characters that are word break characters, but should be left
693 in TEXT when it is passed to the completion function. The shell uses
694 this to help determine what kind of completing to do. */
695extern const char *rl_special_prefixes;
696
697/* If non-zero, then this is the address of a function to call when
698 completing on a directory name. The function is called with
699 the address of a string (the current directory name) as an arg. It
700 changes what is displayed when the possible completions are printed
701 or inserted. The directory completion hook should perform
702 any necessary dequoting. This function should return 1 if it modifies
703 the directory name pointer passed as an argument. If the directory
704 completion hook returns 0, it should not modify the directory name
705 pointer passed as an argument. */
706extern rl_icppfunc_t *rl_directory_completion_hook;
707
708/* If non-zero, this is the address of a function to call when completing
709 a directory name. This function takes the address of the directory name
710 to be modified as an argument. Unlike rl_directory_completion_hook, it
711 only modifies the directory name used in opendir(2), not what is displayed
712 when the possible completions are printed or inserted. If set, it takes
713 precedence over rl_directory_completion_hook. The directory rewrite
714 hook should perform any necessary dequoting. This function has the same
715 return value properties as the directory_completion_hook.
716
717 I'm not happy with how this works yet, so it's undocumented. I'm trying
718 it in bash to see how well it goes. */
719extern rl_icppfunc_t *rl_directory_rewrite_hook;
720
721/* If non-zero, this is the address of a function for the completer to call
722 before deciding which character to append to a completed name. It should
723 modify the directory name passed as an argument if appropriate, and return
724 non-zero if it modifies the name. This should not worry about dequoting
725 the filename; that has already happened by the time it gets here. */
726extern rl_icppfunc_t *rl_filename_stat_hook;
727
728/* If non-zero, this is the address of a function to call when reading
729 directory entries from the filesystem for completion and comparing
730 them to the partial word to be completed. The function should
731 either return its first argument (if no conversion takes place) or
732 newly-allocated memory. This can, for instance, convert filenames
733 between character sets for comparison against what's typed at the
734 keyboard. The returned value is what is added to the list of
735 matches. The second argument is the length of the filename to be
736 converted. */
737extern rl_dequote_func_t *rl_filename_rewrite_hook;
738
739/* Backwards compatibility with previous versions of readline. */
740#define rl_symbolic_link_hook rl_directory_completion_hook
741
742/* If non-zero, then this is the address of a function to call when
743 completing a word would normally display the list of possible matches.
744 This function is called instead of actually doing the display.
745 It takes three arguments: (char **matches, int num_matches, int max_length)
746 where MATCHES is the array of strings that matched, NUM_MATCHES is the
747 number of strings in that array, and MAX_LENGTH is the length of the
748 longest string in that array. */
749extern rl_compdisp_func_t *rl_completion_display_matches_hook;
750
751/* Non-zero means that the results of the matches are to be treated
752 as filenames. This is ALWAYS zero on entry, and can only be changed
753 within a completion entry finder function. */
754extern int rl_filename_completion_desired;
755
756/* Non-zero means that the results of the matches are to be quoted using
757 double quotes (or an application-specific quoting mechanism) if the
758 filename contains any characters in rl_word_break_chars. This is
759 ALWAYS non-zero on entry, and can only be changed within a completion
760 entry finder function. */
761extern int rl_filename_quoting_desired;
762
763/* Set to a function to quote a filename in an application-specific fashion.
764 Called with the text to quote, the type of match found (single or multiple)
765 and a pointer to the quoting character to be used, which the function can
766 reset if desired. */
767extern rl_quote_func_t *rl_filename_quoting_function;
768
769/* Function to call to remove quoting characters from a filename. Called
770 before completion is attempted, so the embedded quotes do not interfere
771 with matching names in the file system. */
772extern rl_dequote_func_t *rl_filename_dequoting_function;
773
774/* Function to call to decide whether or not a word break character is
775 quoted. If a character is quoted, it does not break words for the
776 completer. */
777extern rl_linebuf_func_t *rl_char_is_quoted_p;
778
779/* Non-zero means to suppress normal filename completion after the
780 user-specified completion function has been called. */
781extern int rl_attempted_completion_over;
782
783/* Set to a character describing the type of completion being attempted by
784 rl_complete_internal; available for use by application completion
785 functions. */
786extern int rl_completion_type;
787
788/* Set to the last key used to invoke one of the completion functions */
789extern int rl_completion_invoking_key;
790
791/* Up to this many items will be displayed in response to a
792 possible-completions call. After that, we ask the user if she
793 is sure she wants to see them all. The default value is 100. */
794extern int rl_completion_query_items;
795
796/* Character appended to completed words when at the end of the line. The
797 default is a space. Nothing is added if this is '\0'. */
798extern int rl_completion_append_character;
799
800/* If set to non-zero by an application completion function,
801 rl_completion_append_character will not be appended. */
802extern int rl_completion_suppress_append;
803
804/* Set to any quote character readline thinks it finds before any application
805 completion function is called. */
806extern int rl_completion_quote_character;
807
808/* Set to a non-zero value if readline found quoting anywhere in the word to
809 be completed; set before any application completion function is called. */
810extern int rl_completion_found_quote;
811
812/* If non-zero, the completion functions don't append any closing quote.
813 This is set to 0 by rl_complete_internal and may be changed by an
814 application-specific completion function. */
815extern int rl_completion_suppress_quote;
816
817/* If non-zero, readline will sort the completion matches. On by default. */
818extern int rl_sort_completion_matches;
819
820/* If non-zero, a slash will be appended to completed filenames that are
821 symbolic links to directory names, subject to the value of the
822 mark-directories variable (which is user-settable). This exists so
823 that application completion functions can override the user's preference
824 (set via the mark-symlinked-directories variable) if appropriate.
825 It's set to the value of _rl_complete_mark_symlink_dirs in
826 rl_complete_internal before any application-specific completion
827 function is called, so without that function doing anything, the user's
828 preferences are honored. */
829extern int rl_completion_mark_symlink_dirs;
830
831/* If non-zero, then disallow duplicates in the matches. */
832extern int rl_ignore_completion_duplicates;
833
834/* If this is non-zero, completion is (temporarily) inhibited, and the
835 completion character will be inserted as any other. */
836extern int rl_inhibit_completion;
837
838/* Applications can set this to non-zero to have readline's signal handlers
839 installed during the entire duration of reading a complete line, as in
840 readline-6.2. This should be used with care, because it can result in
841 readline receiving signals and not handling them until it's called again
842 via rl_callback_read_char, thereby stealing them from the application.
843 By default, signal handlers are only active while readline is active. */
844extern int rl_persistent_signal_handlers;
845
846/* Input error; can be returned by (*rl_getc_function) if readline is reading
847 a top-level command (RL_ISSTATE (RL_STATE_READCMD)). */
848#define READERR (-2)
849
850/* Definitions available for use by readline clients. */
851#define RL_PROMPT_START_IGNORE '\001'
852#define RL_PROMPT_END_IGNORE '\002'
853
854/* Possible values for do_replace argument to rl_filename_quoting_function,
855 called by rl_complete_internal. */
856#define NO_MATCH 0
857#define SINGLE_MATCH 1
858#define MULT_MATCH 2
859
860/* Possible state values for rl_readline_state */
861#define RL_STATE_NONE 0x000000 /* no state; before first call */
862
863#define RL_STATE_INITIALIZING 0x0000001 /* initializing */
864#define RL_STATE_INITIALIZED 0x0000002 /* initialization done */
865#define RL_STATE_TERMPREPPED 0x0000004 /* terminal is prepped */
866#define RL_STATE_READCMD 0x0000008 /* reading a command key */
867#define RL_STATE_METANEXT 0x0000010 /* reading input after ESC */
868#define RL_STATE_DISPATCHING 0x0000020 /* dispatching to a command */
869#define RL_STATE_MOREINPUT 0x0000040 /* reading more input in a command function */
870#define RL_STATE_ISEARCH 0x0000080 /* doing incremental search */
871#define RL_STATE_NSEARCH 0x0000100 /* doing non-inc search */
872#define RL_STATE_SEARCH 0x0000200 /* doing a history search */
873#define RL_STATE_NUMERICARG 0x0000400 /* reading numeric argument */
874#define RL_STATE_MACROINPUT 0x0000800 /* getting input from a macro */
875#define RL_STATE_MACRODEF 0x0001000 /* defining keyboard macro */
876#define RL_STATE_OVERWRITE 0x0002000 /* overwrite mode */
877#define RL_STATE_COMPLETING 0x0004000 /* doing completion */
878#define RL_STATE_SIGHANDLER 0x0008000 /* in readline sighandler */
879#define RL_STATE_UNDOING 0x0010000 /* doing an undo */
880#define RL_STATE_INPUTPENDING 0x0020000 /* rl_execute_next called */
881#define RL_STATE_TTYCSAVED 0x0040000 /* tty special chars saved */
882#define RL_STATE_CALLBACK 0x0080000 /* using the callback interface */
883#define RL_STATE_VIMOTION 0x0100000 /* reading vi motion arg */
884#define RL_STATE_MULTIKEY 0x0200000 /* reading multiple-key command */
885#define RL_STATE_VICMDONCE 0x0400000 /* entered vi command mode at least once */
886#define RL_STATE_CHARSEARCH 0x0800000 /* vi mode char search */
887#define RL_STATE_REDISPLAYING 0x1000000 /* updating terminal display */
888
889#define RL_STATE_DONE 0x2000000 /* done; accepted line */
890
891#define RL_SETSTATE(x) (rl_readline_state |= (x))
892#define RL_UNSETSTATE(x) (rl_readline_state &= ~(x))
893#define RL_ISSTATE(x) (rl_readline_state & (x))
894
895struct readline_state {
896 /* line state */
897 int point;
898 int end;
899 int mark;
900 int buflen;
901 char *buffer;
902 UNDO_LIST *ul;
903 char *prompt;
904
905 /* global state */
906 int rlstate;
907 int done;
908 Keymap kmap;
909
910 /* input state */
911 rl_command_func_t *lastfunc;
912 int insmode;
913 int edmode;
914 char *kseq;
915 int kseqlen;
916
917 int pendingin;
918 FILE *inf;
919 FILE *outf;
920 char *macro;
921
922 /* signal state */
923 int catchsigs;
924 int catchsigwinch;
925
926 /* search state */
927
928 /* completion state */
929 rl_compentry_func_t *entryfunc;
930 rl_compentry_func_t *menuentryfunc;
931 rl_compignore_func_t *ignorefunc;
932 rl_completion_func_t *attemptfunc;
933 char *wordbreakchars;
934
935 /* options state */
936
937 /* hook state */
938
939 /* reserved for future expansion, so the struct size doesn't change */
940 char reserved[64];
941};
942
943extern int rl_save_state PARAMS((struct readline_state *));
944extern int rl_restore_state PARAMS((struct readline_state *));
945
946#ifdef __cplusplus
947}
948#endif
949
950#endif /* _READLINE_H_ */
951