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