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