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