Warning: That file was not part of the compilation database. It may have many parsing errors.

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

Warning: That file was not part of the compilation database. It may have many parsing errors.