]> git.ipfire.org Git - thirdparty/bash.git/blame - lib/readline/readline.h
projects / thirdparty / bash.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Imported from ../bash-2.05.tar.gz.
[thirdparty/bash.git] / lib / readline / readline.h
CommitLineData
726f6388
JA		 1/* Readline.h -- the names of functions callable from within readline. */
2
3/* Copyright (C) 1987, 1989, 1992 Free Software Foundation, Inc.
4
5 This file is part of the GNU Readline Library, a library for
6 reading lines of text with interactive input and history editing.
7
8 The GNU Readline Library is free software; you can redistribute it
9 and/or modify it under the terms of the GNU General Public License
bb70624e 10 as published by the Free Software Foundation; either version 2, or
726f6388
JA		 11 (at your option) any later version.
12
13 The GNU Readline Library is distributed in the hope that it will be
14 useful, but WITHOUT ANY WARRANTY; without even the implied warranty
15 of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
17
18 The GNU General Public License is often shipped with GNU software, and
19 is generally kept in a file called COPYING or LICENSE. If you do not
20 have a copy of the license, write to the Free Software Foundation,
bb70624e 21 59 Temple Place, Suite 330, Boston, MA 02111 USA. */
726f6388
JA		 22
23#if !defined (_READLINE_H_)
24#define _READLINE_H_
25
b72432fd
JA		 26#ifdef __cplusplus
27extern "C" {
28#endif
29
726f6388 30#if defined (READLINE_LIBRARY)
b72432fd 31# include "rlstdc.h"
726f6388
JA		 32# include "keymaps.h"
33# include "tilde.h"
34#else
b72432fd 35# include <readline/rlstdc.h>
726f6388
JA		 36# include <readline/keymaps.h>
37# include <readline/tilde.h>
38#endif
39
ccc6cda3
JA		 40/* Readline data structures. */
41
42/* Maintaining the state of undo. We remember individual deletes and inserts
43 on a chain of things to do. */
44
45/* The actions that undo knows how to undo. Notice that UNDO_DELETE means
46 to insert some text, and UNDO_INSERT means to delete some text. I.e.,
47 the code tells undo what to undo, not how to undo it. */
48enum undo_code { UNDO_DELETE, UNDO_INSERT, UNDO_BEGIN, UNDO_END };
49
50/* What an element of THE_UNDO_LIST looks like. */
51typedef struct undo_list {
52 struct undo_list *next;
53 int start, end; /* Where the change took place. */
54 char *text; /* The text to insert, if undoing a delete. */
55 enum undo_code what; /* Delete, Insert, Begin, End. */
56} UNDO_LIST;
57
58/* The current undo list for RL_LINE_BUFFER. */
59extern UNDO_LIST *rl_undo_list;
60
61/* The data structure for mapping textual names to code addresses. */
62typedef struct _funmap {
28ef6c31
JA		 63 const char *name;
64 rl_command_func_t *function;
ccc6cda3
JA		 65} FUNMAP;
66
67extern FUNMAP **funmap;
68
b72432fd
JA		 69/* **************************************************************** */
70/* */
71/* Functions available to bind to key sequences */
72/* */
73/* **************************************************************** */
ccc6cda3 74
b72432fd
JA		 75/* Bindable commands for numeric arguments. */
76extern int rl_digit_argument __P((int, int));
77extern int rl_universal_argument __P((int, int));
78
79/* Bindable commands for moving the cursor. */
80extern int rl_forward __P((int, int));
81extern int rl_backward __P((int, int));
82extern int rl_beg_of_line __P((int, int));
83extern int rl_end_of_line __P((int, int));
84extern int rl_forward_word __P((int, int));
85extern int rl_backward_word __P((int, int));
86extern int rl_refresh_line __P((int, int));
87extern int rl_clear_screen __P((int, int));
88extern int rl_arrow_keys __P((int, int));
89
90/* Bindable commands for inserting and deleting text. */
91extern int rl_insert __P((int, int));
92extern int rl_quoted_insert __P((int, int));
93extern int rl_tab_insert __P((int, int));
94extern int rl_newline __P((int, int));
95extern int rl_do_lowercase_version __P((int, int));
96extern int rl_rubout __P((int, int));
97extern int rl_delete __P((int, int));
98extern int rl_rubout_or_delete __P((int, int));
99extern int rl_delete_horizontal_space __P((int, int));
100extern int rl_delete_or_show_completions __P((int, int));
101extern int rl_insert_comment __P((int, int));
102
103/* Bindable commands for changing case. */
104extern int rl_upcase_word __P((int, int));
105extern int rl_downcase_word __P((int, int));
106extern int rl_capitalize_word __P((int, int));
107
108/* Bindable commands for transposing characters and words. */
109extern int rl_transpose_words __P((int, int));
110extern int rl_transpose_chars __P((int, int));
111
112/* Bindable commands for searching within a line. */
113extern int rl_char_search __P((int, int));
114extern int rl_backward_char_search __P((int, int));
115
116/* Bindable commands for readline's interface to the command history. */
117extern int rl_beginning_of_history __P((int, int));
118extern int rl_end_of_history __P((int, int));
119extern int rl_get_next_history __P((int, int));
120extern int rl_get_previous_history __P((int, int));
121
122/* Bindable commands for managing the mark and region. */
123extern int rl_set_mark __P((int, int));
124extern int rl_exchange_point_and_mark __P((int, int));
125
126/* Bindable commands to set the editing mode (emacs or vi). */
127extern int rl_vi_editing_mode __P((int, int));
128extern int rl_emacs_editing_mode __P((int, int));
129
130/* Bindable commands for managing key bindings. */
131extern int rl_re_read_init_file __P((int, int));
132extern int rl_dump_functions __P((int, int));
133extern int rl_dump_macros __P((int, int));
134extern int rl_dump_variables __P((int, int));
135
136/* Bindable commands for word completion. */
137extern int rl_complete __P((int, int));
138extern int rl_possible_completions __P((int, int));
139extern int rl_insert_completions __P((int, int));
140extern int rl_menu_complete __P((int, int));
141
142/* Bindable commands for killing and yanking text, and managing the kill ring. */
143extern int rl_kill_word __P((int, int));
144extern int rl_backward_kill_word __P((int, int));
145extern int rl_kill_line __P((int, int));
146extern int rl_backward_kill_line __P((int, int));
147extern int rl_kill_full_line __P((int, int));
148extern int rl_unix_word_rubout __P((int, int));
149extern int rl_unix_line_discard __P((int, int));
150extern int rl_copy_region_to_kill __P((int, int));
151extern int rl_kill_region __P((int, int));
152extern int rl_copy_forward_word __P((int, int));
153extern int rl_copy_backward_word __P((int, int));
154extern int rl_yank __P((int, int));
155extern int rl_yank_pop __P((int, int));
156extern int rl_yank_nth_arg __P((int, int));
157extern int rl_yank_last_arg __P((int, int));
28ef6c31
JA		 158/* Not available unless __CYGWIN__ is defined. */
159#ifdef __CYGWIN__
b72432fd 160extern int rl_paste_from_clipboard __P((int, int));
cce855bc
JA		 161#endif
162
b72432fd
JA		 163/* Bindable commands for incremental searching. */
164extern int rl_reverse_search_history __P((int, int));
165extern int rl_forward_search_history __P((int, int));
166
167/* Bindable keyboard macro commands. */
168extern int rl_start_kbd_macro __P((int, int));
169extern int rl_end_kbd_macro __P((int, int));
170extern int rl_call_last_kbd_macro __P((int, int));
171
172/* Bindable undo commands. */
173extern int rl_revert_line __P((int, int));
174extern int rl_undo_command __P((int, int));
175
176/* Bindable tilde expansion commands. */
177extern int rl_tilde_expand __P((int, int));
178
179/* Bindable terminal control commands. */
180extern int rl_restart_output __P((int, int));
181extern int rl_stop_output __P((int, int));
182
183/* Miscellaneous bindable commands. */
184extern int rl_abort __P((int, int));
185extern int rl_tty_status __P((int, int));
186
187/* Bindable commands for incremental and non-incremental history searching. */
188extern int rl_history_search_forward __P((int, int));
189extern int rl_history_search_backward __P((int, int));
190extern int rl_noninc_forward_search __P((int, int));
191extern int rl_noninc_reverse_search __P((int, int));
192extern int rl_noninc_forward_search_again __P((int, int));
193extern int rl_noninc_reverse_search_again __P((int, int));
194
bb70624e 195/* Bindable command used when inserting a matching close character. */
b72432fd 196extern int rl_insert_close __P((int, int));
726f6388 197
b72432fd 198/* Not available unless READLINE_CALLBACKS is defined. */
28ef6c31 199extern void rl_callback_handler_install __P((const char *, rl_vcpfunc_t *));
b72432fd
JA		 200extern void rl_callback_read_char __P((void));
201extern void rl_callback_handler_remove __P((void));
726f6388
JA		 202
203/* Things for vi mode. Not available unless readline is compiled -DVI_MODE. */
b72432fd
JA		 204/* VI-mode bindable commands. */
205extern int rl_vi_redo __P((int, int));
206extern int rl_vi_undo __P((int, int));
207extern int rl_vi_yank_arg __P((int, int));
208extern int rl_vi_fetch_history __P((int, int));
209extern int rl_vi_search_again __P((int, int));
210extern int rl_vi_search __P((int, int));
211extern int rl_vi_complete __P((int, int));
212extern int rl_vi_tilde_expand __P((int, int));
213extern int rl_vi_prev_word __P((int, int));
214extern int rl_vi_next_word __P((int, int));
215extern int rl_vi_end_word __P((int, int));
216extern int rl_vi_insert_beg __P((int, int));
217extern int rl_vi_append_mode __P((int, int));
218extern int rl_vi_append_eol __P((int, int));
219extern int rl_vi_eof_maybe __P((int, int));
220extern int rl_vi_insertion_mode __P((int, int));
221extern int rl_vi_movement_mode __P((int, int));
222extern int rl_vi_arg_digit __P((int, int));
223extern int rl_vi_change_case __P((int, int));
224extern int rl_vi_put __P((int, int));
225extern int rl_vi_column __P((int, int));
226extern int rl_vi_delete_to __P((int, int));
227extern int rl_vi_change_to __P((int, int));
228extern int rl_vi_yank_to __P((int, int));
229extern int rl_vi_delete __P((int, int));
230extern int rl_vi_back_to_indent __P((int, int));
231extern int rl_vi_first_print __P((int, int));
232extern int rl_vi_char_search __P((int, int));
233extern int rl_vi_match __P((int, int));
234extern int rl_vi_change_char __P((int, int));
235extern int rl_vi_subst __P((int, int));
236extern int rl_vi_overstrike __P((int, int));
237extern int rl_vi_overstrike_delete __P((int, int));
238extern int rl_vi_replace __P((int, int));
239extern int rl_vi_set_mark __P((int, int));
240extern int rl_vi_goto_mark __P((int, int));
241
242/* VI-mode utility functions. */
243extern int rl_vi_check __P((void));
244extern int rl_vi_domove __P((int, int *));
245extern int rl_vi_bracktype __P((int));
246
247/* VI-mode pseudo-bindable commands, used as utility functions. */
248extern int rl_vi_fWord __P((int, int));
249extern int rl_vi_bWord __P((int, int));
250extern int rl_vi_eWord __P((int, int));
251extern int rl_vi_fword __P((int, int));
252extern int rl_vi_bword __P((int, int));
253extern int rl_vi_eword __P((int, int));
726f6388 254
ccc6cda3
JA		 255/* **************************************************************** */
256/* */
257/* Well Published Functions */
258/* */
259/* **************************************************************** */
726f6388 260
ccc6cda3
JA		 261/* Readline functions. */
262/* Read a line of input. Prompt with PROMPT. A NULL PROMPT means none. */
28ef6c31
JA		 263extern char *readline __P((const char *));
264
265extern int rl_set_prompt __P((const char *));
266extern int rl_expand_prompt __P((char *));
726f6388 267
b72432fd 268extern int rl_initialize __P((void));
ccc6cda3 269
28ef6c31 270/* Undocumented; unused by readline */
b72432fd 271extern int rl_discard_argument __P((void));
ccc6cda3 272
b72432fd 273/* Utility functions to bind keys to readline commands. */
28ef6c31
JA		 274extern int rl_add_defun __P((const char *, rl_command_func_t *, int));
275extern int rl_bind_key __P((int, rl_command_func_t *));
276extern int rl_bind_key_in_map __P((int, rl_command_func_t *, Keymap));
b72432fd
JA		 277extern int rl_unbind_key __P((int));
278extern int rl_unbind_key_in_map __P((int, Keymap));
28ef6c31
JA		 279extern int rl_unbind_function_in_map __P((rl_command_func_t *, Keymap));
280extern int rl_unbind_command_in_map __P((const char *, Keymap));
281extern int rl_set_key __P((const char *, rl_command_func_t *, Keymap));
282extern int rl_generic_bind __P((int, const char *, char *, Keymap));
283extern int rl_variable_bind __P((const char *, const char *));
ccc6cda3 284
b72432fd 285/* Backwards compatibility, use rl_generic_bind instead. */
28ef6c31 286extern int rl_macro_bind __P((const char *, const char *, Keymap));
b72432fd
JA		 287
288/* Undocumented in the texinfo manual; not really useful to programs. */
28ef6c31 289extern int rl_translate_keyseq __P((const char *, char *, int *));
b72432fd
JA		 290extern char *rl_untranslate_keyseq __P((int));
291
28ef6c31
JA		 292extern rl_command_func_t *rl_named_function __P((const char *));
293extern rl_command_func_t *rl_function_of_keyseq __P((const char *, Keymap, int *));
b72432fd
JA		 294
295extern void rl_list_funmap_names __P((void));
28ef6c31
JA		 296extern char **rl_invoking_keyseqs_in_map __P((rl_command_func_t *, Keymap));
297extern char **rl_invoking_keyseqs __P((rl_command_func_t *));
b72432fd
JA		 298
299extern void rl_function_dumper __P((int));
300extern void rl_macro_dumper __P((int));
301extern void rl_variable_dumper __P((int));
302
28ef6c31 303extern int rl_read_init_file __P((const char *));
b72432fd
JA		 304extern int rl_parse_and_bind __P((char *));
305
306/* Functions for manipulating keymaps. */
307extern Keymap rl_make_bare_keymap __P((void));
308extern Keymap rl_copy_keymap __P((Keymap));
309extern Keymap rl_make_keymap __P((void));
310extern void rl_discard_keymap __P((Keymap));
311
28ef6c31 312extern Keymap rl_get_keymap_by_name __P((const char *));
b72432fd
JA		 313extern char *rl_get_keymap_name __P((Keymap));
314extern void rl_set_keymap __P((Keymap));
315extern Keymap rl_get_keymap __P((void));
28ef6c31 316/* Undocumented; used internally only. */
b72432fd
JA		 317extern void rl_set_keymap_from_edit_mode __P((void));
318extern char *rl_get_keymap_name_from_edit_mode __P((void));
319
320/* Functions for manipulating the funmap, which maps command names to functions. */
28ef6c31
JA		 321extern int rl_add_funmap_entry __P((const char *, rl_command_func_t *));
322extern const char **rl_funmap_names __P((void));
323/* Undocumented, only used internally -- there is only one funmap, and this
324 function may be called only once. */
b72432fd 325extern void rl_initialize_funmap __P((void));
b72432fd
JA		 326
327/* Utility functions for managing keyboard macros. */
328extern void rl_push_macro_input __P((char *));
329
330/* Functions for undoing, from undo.c */
331extern void rl_add_undo __P((enum undo_code, int, int, char *));
28ef6c31 332extern void rl_free_undo_list __P((void));
b72432fd
JA		 333extern int rl_do_undo __P((void));
334extern int rl_begin_undo_group __P((void));
335extern int rl_end_undo_group __P((void));
336extern int rl_modifying __P((int, int));
ccc6cda3
JA		 337
338/* Functions for redisplay. */
b72432fd
JA		 339extern void rl_redisplay __P((void));
340extern int rl_on_new_line __P((void));
bb70624e 341extern int rl_on_new_line_with_prompt __P((void));
b72432fd
JA		 342extern int rl_forced_update_display __P((void));
343extern int rl_clear_message __P((void));
344extern int rl_reset_line_state __P((void));
28ef6c31 345extern int rl_crlf __P((void));
ccc6cda3 346
bb70624e 347#if (defined (__STDC__) || defined (__cplusplus)) && defined (USE_VARARGS) && defined (PREFER_STDARG)
ccc6cda3
JA		 348extern int rl_message (const char *, ...);
349#else
350extern int rl_message ();
351#endif
352
b72432fd 353extern int rl_show_char __P((int));
28ef6c31
JA		 354
355/* Undocumented in texinfo manual. */
b72432fd 356extern int rl_character_len __P((int, int));
ccc6cda3 357
b72432fd
JA		 358/* Save and restore internal prompt redisplay information. */
359extern void rl_save_prompt __P((void));
360extern void rl_restore_prompt __P((void));
ccc6cda3 361
b72432fd 362/* Modifying text. */
28ef6c31 363extern int rl_insert_text __P((const char *));
b72432fd
JA		 364extern int rl_delete_text __P((int, int));
365extern int rl_kill_text __P((int, int));
366extern char *rl_copy_text __P((int, int));
367
368/* Terminal and tty mode management. */
369extern void rl_prep_terminal __P((int));
370extern void rl_deprep_terminal __P((void));
28ef6c31 371extern void rl_tty_set_default_bindings __P((Keymap));
b72432fd 372
28ef6c31 373extern int rl_reset_terminal __P((const char *));
b72432fd 374extern void rl_resize_terminal __P((void));
28ef6c31
JA		 375extern void rl_set_screen_size __P((int, int));
376extern void rl_get_screen_size __P((int *, int *));
b72432fd
JA		 377
378/* Functions for character input. */
379extern int rl_stuff_char __P((int));
380extern int rl_execute_next __P((int));
28ef6c31 381extern int rl_clear_pending_input __P((void));
b72432fd
JA		 382extern int rl_read_key __P((void));
383extern int rl_getc __P((FILE *));
28ef6c31
JA		 384extern int rl_set_keyboard_input_timeout __P((int));
385
386/* `Public' utility functions . */
387extern void rl_extend_line_buffer __P((int));
388extern int rl_ding __P((void));
389extern int rl_alphabetic __P((int));
b72432fd
JA		 390
391/* Readline signal handling, from signals.c */
392extern int rl_set_signals __P((void));
393extern int rl_clear_signals __P((void));
394extern void rl_cleanup_after_signal __P((void));
395extern void rl_reset_after_signal __P((void));
396extern void rl_free_line_state __P((void));
397
ccc6cda3 398/* Undocumented. */
28ef6c31 399extern int rl_set_paren_blink_timeout __P((int));
b72432fd 400
28ef6c31
JA		 401/* Undocumented. */
402extern int rl_maybe_save_line __P((void));
403extern int rl_maybe_unsave_line __P((void));
404extern int rl_maybe_replace_line __P((void));
ccc6cda3
JA		 405
406/* Completion functions. */
b72432fd
JA		 407extern int rl_complete_internal __P((int));
408extern void rl_display_match_list __P((char **, int, int));
ccc6cda3 409
28ef6c31
JA		 410extern char **rl_completion_matches __P((const char *, rl_compentry_func_t *));
411extern char *rl_username_completion_function __P((const char *, int));
412extern char *rl_filename_completion_function __P((const char *, int));
413
414#if 0
415/* Backwards compatibility (compat.c). These will go away sometime. */
416extern void free_undo_list __P((void));
417extern int maybe_save_line __P((void));
418extern int maybe_unsave_line __P((void));
419extern int maybe_replace_line __P((void));
420
421extern int ding __P((void));
422extern int alphabetic __P((int));
423extern int crlf __P((void));
424
425extern char **completion_matches __P((char *, rl_compentry_func_t *));
426extern char *username_completion_function __P((const char *, int));
427extern char *filename_completion_function __P((const char *, int));
428#endif
726f6388
JA		 429
430/* **************************************************************** */
431/* */
432/* Well Published Variables */
433/* */
434/* **************************************************************** */
435
ccc6cda3 436/* The version of this incarnation of the readline library. */
28ef6c31 437extern const char *rl_library_version;
ccc6cda3 438
bb70624e
JA		 439/* True if this is real GNU readline. */
440extern int rl_gnu_readline_p;
441
28ef6c31
JA		 442/* Flags word encapsulating the current readline state. */
443extern int rl_readline_state;
444
445/* Says which editing mode readline is currently using. 1 means emacs mode;
446 0 means vi mode. */
447extern int rl_editing_mode;
448
726f6388
JA		 449/* The name of the calling program. You should initialize this to
450 whatever was in argv[0]. It is used when parsing conditionals. */
28ef6c31 451extern const char *rl_readline_name;
726f6388 452
d166f048
JA		 453/* The prompt readline uses. This is set from the argument to
454 readline (), and should not be assigned to directly. */
455extern char *rl_prompt;
456
726f6388
JA		 457/* The line buffer that is in use. */
458extern char *rl_line_buffer;
459
460/* The location of point, and end. */
28ef6c31
JA		 461extern int rl_point;
462extern int rl_end;
726f6388 463
b72432fd 464/* The mark, or saved cursor position. */
ccc6cda3
JA		 465extern int rl_mark;
466
b72432fd
JA		 467/* Flag to indicate that readline has finished with the current input
468 line and should return it. */
ccc6cda3
JA		 469extern int rl_done;
470
b72432fd 471/* If set to a character value, that will be the next keystroke read. */
ccc6cda3
JA		 472extern int rl_pending_input;
473
d166f048
JA		 474/* Non-zero if we called this function from _rl_dispatch(). It's present
475 so functions can find out whether they were called from a key binding
476 or directly from an application. */
e8ce775d 477extern int rl_dispatching;
d166f048 478
28ef6c31
JA		 479/* Non-zero if the user typed a numeric argument before executing the
480 current function. */
481extern int rl_explicit_arg;
482
483/* The current value of the numeric argument specified by the user. */
484extern int rl_numeric_arg;
485
486/* The address of the last command function Readline executed. */
487extern rl_command_func_t *rl_last_func;
488
726f6388 489/* The name of the terminal to use. */
28ef6c31 490extern const char *rl_terminal_name;
726f6388
JA		 491
492/* The input and output streams. */
28ef6c31
JA		 493extern FILE *rl_instream;
494extern FILE *rl_outstream;
726f6388 495
ccc6cda3
JA		 496/* If non-zero, then this is the address of a function to call just
497 before readline_internal () prints the first prompt. */
28ef6c31 498extern rl_hook_func_t *rl_startup_hook;
726f6388 499
b72432fd
JA		 500/* If non-zero, this is the address of a function to call just before
501 readline_internal_setup () returns and readline_internal starts
502 reading input characters. */
28ef6c31 503extern rl_hook_func_t *rl_pre_input_hook;
b72432fd 504
ccc6cda3
JA		 505/* The address of a function to call periodically while Readline is
506 awaiting character input, or NULL, for no event handling. */
28ef6c31 507extern rl_hook_func_t *rl_event_hook;
726f6388 508
28ef6c31
JA		 509/* The address of the function to call to fetch a character from the current
510 Readline input stream */
511extern rl_getc_func_t *rl_getc_function;
512
513extern rl_voidfunc_t *rl_redisplay_function;
514
515extern rl_vintfunc_t *rl_prep_term_function;
516extern rl_voidfunc_t *rl_deprep_term_function;
726f6388 517
ccc6cda3
JA		 518/* Dispatch variables. */
519extern Keymap rl_executing_keymap;
520extern Keymap rl_binding_keymap;
726f6388 521
b72432fd
JA		 522/* Display variables. */
523/* If non-zero, readline will erase the entire line, including any prompt,
524 if the only thing typed on an otherwise-blank line is something bound to
525 rl_newline. */
526extern int rl_erase_empty_line;
527
bb70624e
JA		 528/* If non-zero, the application has already printed the prompt (rl_prompt)
529 before calling readline, so readline should not output it the first time
530 redisplay is done. */
531extern int rl_already_prompted;
532
533/* A non-zero value means to read only this many characters rather than
534 up to a character bound to accept-line. */
535extern int rl_num_chars_to_read;
536
28ef6c31
JA		 537/* The text of a currently-executing keyboard macro. */
538extern char *rl_executing_macro;
539
b72432fd
JA		 540/* Variables to control readline signal handling. */
541/* If non-zero, readline will install its own signal handlers for
542 SIGINT, SIGTERM, SIGQUIT, SIGALRM, SIGTSTP, SIGTTIN, and SIGTTOU. */
543extern int rl_catch_signals;
544
545/* If non-zero, readline will install a signal handler for SIGWINCH
546 that also attempts to call any calling application's SIGWINCH signal
547 handler. Note that the terminal is not cleaned up before the
548 application's signal handler is called; use rl_cleanup_after_signal()
549 to do that. */
550extern int rl_catch_sigwinch;
551
ccc6cda3 552/* Completion variables. */
726f6388
JA		 553/* Pointer to the generator function for completion_matches ().
554 NULL means to use filename_entry_function (), the default filename
555 completer. */
28ef6c31 556extern rl_compentry_func_t *rl_completion_entry_function;
726f6388
JA		 557
558/* If rl_ignore_some_completions_function is non-NULL it is the address
559 of a function to call after all of the possible matches have been
560 generated, but before the actual completion is done to the input line.
561 The function is called with one argument; a NULL terminated array
562 of (char *). If your function removes any of the elements, they
563 must be free()'ed. */
28ef6c31 564extern rl_compignore_func_t *rl_ignore_some_completions_function;
726f6388
JA		 565
566/* Pointer to alternative function to create matches.
567 Function is called with TEXT, START, and END.
568 START and END are indices in RL_LINE_BUFFER saying what the boundaries
569 of TEXT are.
570 If this function exists and returns NULL then call the value of
571 rl_completion_entry_function to try to match, otherwise use the
572 array of strings returned. */
28ef6c31 573extern rl_completion_func_t *rl_attempted_completion_function;
726f6388 574
ccc6cda3
JA		 575/* The basic list of characters that signal a break between words for the
576 completer routine. The initial contents of this variable is what
577 breaks words in the shell, i.e. "n\"\\'`@$>". */
28ef6c31 578extern const char *rl_basic_word_break_characters;
ccc6cda3
JA		 579
580/* The list of characters that signal a break between words for
581 rl_complete_internal. The default list is the contents of
582 rl_basic_word_break_characters. */
28ef6c31 583extern const char *rl_completer_word_break_characters;
ccc6cda3
JA		 584
585/* List of characters which can be used to quote a substring of the line.
586 Completion occurs on the entire substring, and within the substring
587 rl_completer_word_break_characters are treated as any other character,
588 unless they also appear within this list. */
28ef6c31 589extern const char *rl_completer_quote_characters;
ccc6cda3
JA		 590
591/* List of quote characters which cause a word break. */
28ef6c31 592extern const char *rl_basic_quote_characters;
ccc6cda3
JA		 593
594/* List of characters that need to be quoted in filenames by the completer. */
28ef6c31 595extern const char *rl_filename_quote_characters;
ccc6cda3
JA		 596
597/* List of characters that are word break characters, but should be left
598 in TEXT when it is passed to the completion function. The shell uses
599 this to help determine what kind of completing to do. */
28ef6c31 600extern const char *rl_special_prefixes;
726f6388
JA		 601
602/* If non-zero, then this is the address of a function to call when
603 completing on a directory name. The function is called with
28ef6c31
JA		 604 the address of a string (the current directory name) as an arg. It
605 changes what is displayed when the possible completions are printed
606 or inserted. */
607extern rl_icppfunc_t *rl_directory_completion_hook;
608
609/* If non-zero, this is the address of a function to call when completing
610 a directory name. This function takes the address of the directory name
611 to be modified as an argument. Unlike rl_directory_completion_hook, it
612 only modifies the directory name used in opendir(2), not what is displayed
613 when the possible completions are printed or inserted. It is called
614 before rl_directory_completion_hook. I'm not happy with how this works
615 yet, so it's undocumented. */
616extern rl_icppfunc_t *rl_directory_rewrite_hook;
726f6388
JA		 617
618/* Backwards compatibility with previous versions of readline. */
619#define rl_symbolic_link_hook rl_directory_completion_hook
620
b72432fd
JA		 621/* If non-zero, then this is the address of a function to call when
622 completing a word would normally display the list of possible matches.
623 This function is called instead of actually doing the display.
624 It takes three arguments: (char **matches, int num_matches, int max_length)
625 where MATCHES is the array of strings that matched, NUM_MATCHES is the
626 number of strings in that array, and MAX_LENGTH is the length of the
627 longest string in that array. */
28ef6c31 628extern rl_compdisp_func_t *rl_completion_display_matches_hook;
b72432fd 629
726f6388
JA		 630/* Non-zero means that the results of the matches are to be treated
631 as filenames. This is ALWAYS zero on entry, and can only be changed
632 within a completion entry finder function. */
633extern int rl_filename_completion_desired;
634
635/* Non-zero means that the results of the matches are to be quoted using
636 double quotes (or an application-specific quoting mechanism) if the
637 filename contains any characters in rl_word_break_chars. This is
638 ALWAYS non-zero on entry, and can only be changed within a completion
639 entry finder function. */
640extern int rl_filename_quoting_desired;
641
ccc6cda3
JA		 642/* Set to a function to quote a filename in an application-specific fashion.
643 Called with the text to quote, the type of match found (single or multiple)
644 and a pointer to the quoting character to be used, which the function can
645 reset if desired. */
28ef6c31 646extern rl_quote_func_t *rl_filename_quoting_function;
726f6388 647
ccc6cda3
JA		 648/* Function to call to remove quoting characters from a filename. Called
649 before completion is attempted, so the embedded quotes do not interfere
650 with matching names in the file system. */
28ef6c31 651extern rl_dequote_func_t *rl_filename_dequoting_function;
726f6388 652
ccc6cda3
JA		 653/* Function to call to decide whether or not a word break character is
654 quoted. If a character is quoted, it does not break words for the
655 completer. */
28ef6c31 656extern rl_linebuf_func_t *rl_char_is_quoted_p;
726f6388 657
ccc6cda3
JA		 658/* Non-zero means to suppress normal filename completion after the
659 user-specified completion function has been called. */
660extern int rl_attempted_completion_over;
726f6388 661
ccc6cda3
JA		 662/* Set to a character describing the type of completion being attempted by
663 rl_complete_internal; available for use by application completion
664 functions. */
665extern int rl_completion_type;
726f6388 666
ccc6cda3
JA		 667/* Character appended to completed words when at the end of the line. The
668 default is a space. Nothing is added if this is '\0'. */
669extern int rl_completion_append_character;
726f6388 670
d166f048
JA		 671/* Up to this many items will be displayed in response to a
672 possible-completions call. After that, we ask the user if she
673 is sure she wants to see them all. The default value is 100. */
674extern int rl_completion_query_items;
675
676/* If non-zero, then disallow duplicates in the matches. */
677extern int rl_ignore_completion_duplicates;
678
ccc6cda3
JA		 679/* If this is non-zero, completion is (temporarily) inhibited, and the
680 completion character will be inserted as any other. */
681extern int rl_inhibit_completion;
682
726f6388
JA		 683/* Definitions available for use by readline clients. */
684#define RL_PROMPT_START_IGNORE '\001'
685#define RL_PROMPT_END_IGNORE '\002'
686
ccc6cda3
JA		 687/* Possible values for do_replace argument to rl_filename_quoting_function,
688 called by rl_complete_internal. */
689#define NO_MATCH 0
690#define SINGLE_MATCH 1
691#define MULT_MATCH 2
692
28ef6c31
JA		 693/* Possible state values for rl_readline_state */
694#define RL_STATE_NONE 0x00000 /* no state; before first call */
695
696#define RL_STATE_INITIALIZING 0x00001 /* initializing */
697#define RL_STATE_INITIALIZED 0x00002 /* initialization done */
698#define RL_STATE_TERMPREPPED 0x00004 /* terminal is prepped */
699#define RL_STATE_READCMD 0x00008 /* reading a command key */
700#define RL_STATE_METANEXT 0x00010 /* reading input after ESC */
701#define RL_STATE_DISPATCHING 0x00020 /* dispatching to a command */
702#define RL_STATE_MOREINPUT 0x00040 /* reading more input in a command function */
703#define RL_STATE_ISEARCH 0x00080 /* doing incremental search */
704#define RL_STATE_NSEARCH 0x00100 /* doing non-inc search */
705#define RL_STATE_SEARCH 0x00200 /* doing a history search */
706#define RL_STATE_NUMERICARG 0x00400 /* reading numeric argument */
707#define RL_STATE_MACROINPUT 0x00800 /* getting input from a macro */
708#define RL_STATE_MACRODEF 0x01000 /* defining keyboard macro */
709#define RL_STATE_OVERWRITE 0x02000 /* overwrite mode */
710#define RL_STATE_COMPLETING 0x04000 /* doing completion */
711#define RL_STATE_SIGHANDLER 0x08000 /* in readline sighandler */
712#define RL_STATE_UNDOING 0x10000 /* doing an undo */
713#define RL_STATE_INPUTPENDING 0x20000 /* rl_execute_next called */
714
715#define RL_STATE_DONE 0x80000 /* done; accepted line */
716
717#define RL_SETSTATE(x) (rl_readline_state |= (x))
718#define RL_UNSETSTATE(x) (rl_readline_state &= ~(x))
719#define RL_ISSTATE(x) (rl_readline_state & (x))
726f6388 720
b72432fd
JA		 721#ifdef __cplusplus
722}
723#endif
724
726f6388 725#endif /* _READLINE_H_ */
Unnamed repository; edit this file 'description' to name the repository.