1/* $FreeBSD: head/contrib/libreadline/readline.h 75446 2001-04-12 17:18:46Z ache $ */
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
--- 5 unchanged lines hidden (view full) ---
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,
22 59 Temple Place, Suite 330, Boston, MA 02111 USA. */
23
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. */
--- 20 unchanged lines hidden (view full) ---
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 __CYGWIN__ is defined. */
160#ifdef __CYGWIN__
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
196/* Bindable command used when inserting a matching close character. */
197extern int rl_insert_close __P((int, int));
198
199/* Not available unless READLINE_CALLBACKS is defined. */
200extern void rl_callback_handler_install __P((const char *, rl_vcpfunc_t *));
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((const char *));
265
266extern int rl_set_prompt __P((const char *));
267extern int rl_expand_prompt __P((char *));
268
269extern int rl_initialize __P((void));
270
271/* Undocumented; unused by readline */
272extern int rl_discard_argument __P((void));
273
274/* Utility functions to bind keys to readline commands. */
275extern int rl_add_defun __P((const char *, rl_command_func_t *, int));
276extern int rl_bind_key __P((int, rl_command_func_t *));
277extern int rl_bind_key_in_map __P((int, rl_command_func_t *, Keymap));
278extern int rl_unbind_key __P((int));
279extern int rl_unbind_key_in_map __P((int, Keymap));
280extern int rl_unbind_function_in_map __P((rl_command_func_t *, Keymap));
281extern int rl_unbind_command_in_map __P((const char *, Keymap));
282extern int rl_set_key __P((const char *, rl_command_func_t *, Keymap));
283extern int rl_generic_bind __P((int, const char *, char *, Keymap));
284extern int rl_variable_bind __P((const char *, const char *));
285
286/* Backwards compatibility, use rl_generic_bind instead. */
287extern int rl_macro_bind __P((const char *, const char *, Keymap));
288
289/* Undocumented in the texinfo manual; not really useful to programs. */
290extern int rl_translate_keyseq __P((const char *, char *, int *));
291extern char *rl_untranslate_keyseq __P((int));
292
293extern rl_command_func_t *rl_named_function __P((const char *));
294extern rl_command_func_t *rl_function_of_keyseq __P((const char *, Keymap, int *));
295
296extern void rl_list_funmap_names __P((void));
297extern char **rl_invoking_keyseqs_in_map __P((rl_command_func_t *, Keymap));
298extern char **rl_invoking_keyseqs __P((rl_command_func_t *));
299
300extern void rl_function_dumper __P((int));
301extern void rl_macro_dumper __P((int));
302extern void rl_variable_dumper __P((int));
303
304extern int rl_read_init_file __P((const char *));
305extern int rl_parse_and_bind __P((char *));
306
307/* Functions for manipulating keymaps. */
308extern char *rl_get_keymap_name __P((Keymap));
309/* Undocumented; used internally only. */
310extern void rl_set_keymap_from_edit_mode __P((void));
311extern char *rl_get_keymap_name_from_edit_mode __P((void));
312
313/* Functions for manipulating the funmap, which maps command names to functions. */
314extern int rl_add_funmap_entry __P((const char *, rl_command_func_t *));
315extern const char **rl_funmap_names __P((void));
316/* Undocumented, only used internally -- there is only one funmap, and this
317 function may be called only once. */
318extern void rl_initialize_funmap __P((void));
319
320/* Utility functions for managing keyboard macros. */
321extern void rl_push_macro_input __P((char *));
322
323/* Functions for undoing, from undo.c */
324extern void rl_add_undo __P((enum undo_code, int, int, char *));
325extern void rl_free_undo_list __P((void));
326extern int rl_do_undo __P((void));
327extern int rl_begin_undo_group __P((void));
328extern int rl_end_undo_group __P((void));
329extern int rl_modifying __P((int, int));
330
331/* Functions for redisplay. */
332extern void rl_redisplay __P((void));
333extern int rl_on_new_line __P((void));
334extern int rl_on_new_line_with_prompt __P((void));
335extern int rl_forced_update_display __P((void));
336extern int rl_clear_message __P((void));
337extern int rl_reset_line_state __P((void));
338extern int rl_crlf __P((void));
339
340#if (defined (__STDC__) || defined (__cplusplus)) && defined (USE_VARARGS) && defined (PREFER_STDARG)
341extern int rl_message (const char *, ...);
342#else
343extern int rl_message ();
344#endif
345
346extern int rl_show_char __P((int));
347
348/* Undocumented in texinfo manual. */
349extern int rl_character_len __P((int, int));
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((const 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 rl_tty_set_default_bindings __P((Keymap));
365
366extern int rl_reset_terminal __P((const char *));
367extern void rl_resize_terminal __P((void));
368extern void rl_set_screen_size __P((int, int));
369extern void rl_get_screen_size __P((int *, int *));
370
371/* Functions for character input. */
372extern int rl_stuff_char __P((int));
373extern int rl_execute_next __P((int));
374extern int rl_clear_pending_input __P((void));
375extern int rl_read_key __P((void));
376extern int rl_getc __P((FILE *));
377extern int rl_set_keyboard_input_timeout __P((int));
378
379/* `Public' utility functions . */
380extern void rl_extend_line_buffer __P((int));
381extern int rl_ding __P((void));
382extern int rl_alphabetic __P((int));
383
384/* Readline signal handling, from signals.c */
385extern int rl_set_signals __P((void));
386extern int rl_clear_signals __P((void));
387extern void rl_cleanup_after_signal __P((void));
388extern void rl_reset_after_signal __P((void));
389extern void rl_free_line_state __P((void));
390
391/* Undocumented. */
392extern int rl_set_paren_blink_timeout __P((int));
393
394/* Undocumented. */
395extern int rl_maybe_save_line __P((void));
396extern int rl_maybe_unsave_line __P((void));
397extern int rl_maybe_replace_line __P((void));
398
399/* Completion functions. */
400extern int rl_complete_internal __P((int));
401extern void rl_display_match_list __P((char **, int, int));
402
403extern char **rl_completion_matches __P((const char *, rl_compentry_func_t *));
404extern char *rl_username_completion_function __P((const char *, int));
405extern char *rl_filename_completion_function __P((const char *, int));
406
407/* Backwards compatibility (compat.c). These will go away sometime. */
408extern void free_undo_list __P((void));
409extern int maybe_save_line __P((void));
410extern int maybe_unsave_line __P((void));
411extern int maybe_replace_line __P((void));
412
413extern int ding __P((void));
414extern int alphabetic __P((int));
415extern int crlf __P((void));
416
417extern char **completion_matches __P((char *, rl_compentry_func_t *));
418extern char *username_completion_function __P((const char *, int));
419extern char *filename_completion_function __P((const char *, int));
420
421/* **************************************************************** */
422/* */
423/* Well Published Variables */
424/* */
425/* **************************************************************** */
426
427/* The version of this incarnation of the readline library. */
428extern const char *rl_library_version;
429
430/* True if this is real GNU readline. */
431extern int rl_gnu_readline_p;
432
433/* Flags word encapsulating the current readline state. */
434extern int rl_readline_state;
435
436/* Says which editing mode readline is currently using. 1 means emacs mode;
437 0 means vi mode. */
438extern int rl_editing_mode;
439
440/* The name of the calling program. You should initialize this to
441 whatever was in argv[0]. It is used when parsing conditionals. */
442extern const char *rl_readline_name;
443
444/* The prompt readline uses. This is set from the argument to
445 readline (), and should not be assigned to directly. */
446extern char *rl_prompt;
447
--- 89 unchanged lines hidden (view full) ---
537 that also attempts to call any calling application's SIGWINCH signal
538 handler. Note that the terminal is not cleaned up before the
539 application's signal handler is called; use rl_cleanup_after_signal()
540 to do that. */
541extern int rl_catch_sigwinch;
542
543/* Completion variables. */
544/* Pointer to the generator function for completion_matches ().
545 NULL means to use filename_entry_function (), the default filename
546 completer. */
547extern rl_compentry_func_t *rl_completion_entry_function;
548
549/* If rl_ignore_some_completions_function is non-NULL it is the address
550 of a function to call after all of the possible matches have been
551 generated, but before the actual completion is done to the input line.
552 The function is called with one argument; a NULL terminated array
553 of (char *). If your function removes any of the elements, they
554 must be free()'ed. */
--- 99 unchanged lines hidden (view full) ---
654 rl_complete_internal; available for use by application completion
655 functions. */
656extern int rl_completion_type;
657
658/* Character appended to completed words when at the end of the line. The
659 default is a space. Nothing is added if this is '\0'. */
660extern int rl_completion_append_character;
661
662/* Up to this many items will be displayed in response to a
663 possible-completions call. After that, we ask the user if she
664 is sure she wants to see them all. The default value is 100. */
665extern int rl_completion_query_items;
666
667/* If non-zero, then disallow duplicates in the matches. */
668extern int rl_ignore_completion_duplicates;
669
670/* If this is non-zero, completion is (temporarily) inhibited, and the
671 completion character will be inserted as any other. */
672extern int rl_inhibit_completion;
673
674/* Definitions available for use by readline clients. */
675#define RL_PROMPT_START_IGNORE '\001'
676#define RL_PROMPT_END_IGNORE '\002'
677
678/* Possible values for do_replace argument to rl_filename_quoting_function,
679 called by rl_complete_internal. */
680#define NO_MATCH 0
681#define SINGLE_MATCH 1
--- 22 unchanged lines hidden (view full) ---
704#define RL_STATE_INPUTPENDING 0x20000 /* rl_execute_next called */
705
706#define RL_STATE_DONE 0x80000 /* done; accepted line */
707
708#define RL_SETSTATE(x) (rl_readline_state |= (x))
709#define RL_UNSETSTATE(x) (rl_readline_state &= ~(x))
710#define RL_ISSTATE(x) (rl_readline_state & (x))
711
712#if !defined (savestring)
713#define savestring rl_savestring
714extern char *savestring __P((char *)); /* XXX backwards compatibility */
715#endif
716
717#ifdef __cplusplus
718}
719#endif
720
721#endif /* _READLINE_H_ */
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
--- 5 unchanged lines hidden (view full) ---
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,
22 59 Temple Place, Suite 330, Boston, MA 02111 USA. */
23
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. */
--- 20 unchanged lines hidden (view full) ---
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 __CYGWIN__ is defined. */
160#ifdef __CYGWIN__
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
196/* Bindable command used when inserting a matching close character. */
197extern int rl_insert_close __P((int, int));
198
199/* Not available unless READLINE_CALLBACKS is defined. */
200extern void rl_callback_handler_install __P((const char *, rl_vcpfunc_t *));
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((const char *));
265
266extern int rl_set_prompt __P((const char *));
267extern int rl_expand_prompt __P((char *));
268
269extern int rl_initialize __P((void));
270
271/* Undocumented; unused by readline */
272extern int rl_discard_argument __P((void));
273
274/* Utility functions to bind keys to readline commands. */
275extern int rl_add_defun __P((const char *, rl_command_func_t *, int));
276extern int rl_bind_key __P((int, rl_command_func_t *));
277extern int rl_bind_key_in_map __P((int, rl_command_func_t *, Keymap));
278extern int rl_unbind_key __P((int));
279extern int rl_unbind_key_in_map __P((int, Keymap));
280extern int rl_unbind_function_in_map __P((rl_command_func_t *, Keymap));
281extern int rl_unbind_command_in_map __P((const char *, Keymap));
282extern int rl_set_key __P((const char *, rl_command_func_t *, Keymap));
283extern int rl_generic_bind __P((int, const char *, char *, Keymap));
284extern int rl_variable_bind __P((const char *, const char *));
285
286/* Backwards compatibility, use rl_generic_bind instead. */
287extern int rl_macro_bind __P((const char *, const char *, Keymap));
288
289/* Undocumented in the texinfo manual; not really useful to programs. */
290extern int rl_translate_keyseq __P((const char *, char *, int *));
291extern char *rl_untranslate_keyseq __P((int));
292
293extern rl_command_func_t *rl_named_function __P((const char *));
294extern rl_command_func_t *rl_function_of_keyseq __P((const char *, Keymap, int *));
295
296extern void rl_list_funmap_names __P((void));
297extern char **rl_invoking_keyseqs_in_map __P((rl_command_func_t *, Keymap));
298extern char **rl_invoking_keyseqs __P((rl_command_func_t *));
299
300extern void rl_function_dumper __P((int));
301extern void rl_macro_dumper __P((int));
302extern void rl_variable_dumper __P((int));
303
304extern int rl_read_init_file __P((const char *));
305extern int rl_parse_and_bind __P((char *));
306
307/* Functions for manipulating keymaps. */
308extern char *rl_get_keymap_name __P((Keymap));
309/* Undocumented; used internally only. */
310extern void rl_set_keymap_from_edit_mode __P((void));
311extern char *rl_get_keymap_name_from_edit_mode __P((void));
312
313/* Functions for manipulating the funmap, which maps command names to functions. */
314extern int rl_add_funmap_entry __P((const char *, rl_command_func_t *));
315extern const char **rl_funmap_names __P((void));
316/* Undocumented, only used internally -- there is only one funmap, and this
317 function may be called only once. */
318extern void rl_initialize_funmap __P((void));
319
320/* Utility functions for managing keyboard macros. */
321extern void rl_push_macro_input __P((char *));
322
323/* Functions for undoing, from undo.c */
324extern void rl_add_undo __P((enum undo_code, int, int, char *));
325extern void rl_free_undo_list __P((void));
326extern int rl_do_undo __P((void));
327extern int rl_begin_undo_group __P((void));
328extern int rl_end_undo_group __P((void));
329extern int rl_modifying __P((int, int));
330
331/* Functions for redisplay. */
332extern void rl_redisplay __P((void));
333extern int rl_on_new_line __P((void));
334extern int rl_on_new_line_with_prompt __P((void));
335extern int rl_forced_update_display __P((void));
336extern int rl_clear_message __P((void));
337extern int rl_reset_line_state __P((void));
338extern int rl_crlf __P((void));
339
340#if (defined (__STDC__) || defined (__cplusplus)) && defined (USE_VARARGS) && defined (PREFER_STDARG)
341extern int rl_message (const char *, ...);
342#else
343extern int rl_message ();
344#endif
345
346extern int rl_show_char __P((int));
347
348/* Undocumented in texinfo manual. */
349extern int rl_character_len __P((int, int));
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((const 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 rl_tty_set_default_bindings __P((Keymap));
365
366extern int rl_reset_terminal __P((const char *));
367extern void rl_resize_terminal __P((void));
368extern void rl_set_screen_size __P((int, int));
369extern void rl_get_screen_size __P((int *, int *));
370
371/* Functions for character input. */
372extern int rl_stuff_char __P((int));
373extern int rl_execute_next __P((int));
374extern int rl_clear_pending_input __P((void));
375extern int rl_read_key __P((void));
376extern int rl_getc __P((FILE *));
377extern int rl_set_keyboard_input_timeout __P((int));
378
379/* `Public' utility functions . */
380extern void rl_extend_line_buffer __P((int));
381extern int rl_ding __P((void));
382extern int rl_alphabetic __P((int));
383
384/* Readline signal handling, from signals.c */
385extern int rl_set_signals __P((void));
386extern int rl_clear_signals __P((void));
387extern void rl_cleanup_after_signal __P((void));
388extern void rl_reset_after_signal __P((void));
389extern void rl_free_line_state __P((void));
390
391/* Undocumented. */
392extern int rl_set_paren_blink_timeout __P((int));
393
394/* Undocumented. */
395extern int rl_maybe_save_line __P((void));
396extern int rl_maybe_unsave_line __P((void));
397extern int rl_maybe_replace_line __P((void));
398
399/* Completion functions. */
400extern int rl_complete_internal __P((int));
401extern void rl_display_match_list __P((char **, int, int));
402
403extern char **rl_completion_matches __P((const char *, rl_compentry_func_t *));
404extern char *rl_username_completion_function __P((const char *, int));
405extern char *rl_filename_completion_function __P((const char *, int));
406
407/* Backwards compatibility (compat.c). These will go away sometime. */
408extern void free_undo_list __P((void));
409extern int maybe_save_line __P((void));
410extern int maybe_unsave_line __P((void));
411extern int maybe_replace_line __P((void));
412
413extern int ding __P((void));
414extern int alphabetic __P((int));
415extern int crlf __P((void));
416
417extern char **completion_matches __P((char *, rl_compentry_func_t *));
418extern char *username_completion_function __P((const char *, int));
419extern char *filename_completion_function __P((const char *, int));
420
421/* **************************************************************** */
422/* */
423/* Well Published Variables */
424/* */
425/* **************************************************************** */
426
427/* The version of this incarnation of the readline library. */
428extern const char *rl_library_version;
429
430/* True if this is real GNU readline. */
431extern int rl_gnu_readline_p;
432
433/* Flags word encapsulating the current readline state. */
434extern int rl_readline_state;
435
436/* Says which editing mode readline is currently using. 1 means emacs mode;
437 0 means vi mode. */
438extern int rl_editing_mode;
439
440/* The name of the calling program. You should initialize this to
441 whatever was in argv[0]. It is used when parsing conditionals. */
442extern const char *rl_readline_name;
443
444/* The prompt readline uses. This is set from the argument to
445 readline (), and should not be assigned to directly. */
446extern char *rl_prompt;
447
--- 89 unchanged lines hidden (view full) ---
537 that also attempts to call any calling application's SIGWINCH signal
538 handler. Note that the terminal is not cleaned up before the
539 application's signal handler is called; use rl_cleanup_after_signal()
540 to do that. */
541extern int rl_catch_sigwinch;
542
543/* Completion variables. */
544/* Pointer to the generator function for completion_matches ().
545 NULL means to use filename_entry_function (), the default filename
546 completer. */
547extern rl_compentry_func_t *rl_completion_entry_function;
548
549/* If rl_ignore_some_completions_function is non-NULL it is the address
550 of a function to call after all of the possible matches have been
551 generated, but before the actual completion is done to the input line.
552 The function is called with one argument; a NULL terminated array
553 of (char *). If your function removes any of the elements, they
554 must be free()'ed. */
--- 99 unchanged lines hidden (view full) ---
654 rl_complete_internal; available for use by application completion
655 functions. */
656extern int rl_completion_type;
657
658/* Character appended to completed words when at the end of the line. The
659 default is a space. Nothing is added if this is '\0'. */
660extern int rl_completion_append_character;
661
662/* Up to this many items will be displayed in response to a
663 possible-completions call. After that, we ask the user if she
664 is sure she wants to see them all. The default value is 100. */
665extern int rl_completion_query_items;
666
667/* If non-zero, then disallow duplicates in the matches. */
668extern int rl_ignore_completion_duplicates;
669
670/* If this is non-zero, completion is (temporarily) inhibited, and the
671 completion character will be inserted as any other. */
672extern int rl_inhibit_completion;
673
674/* Definitions available for use by readline clients. */
675#define RL_PROMPT_START_IGNORE '\001'
676#define RL_PROMPT_END_IGNORE '\002'
677
678/* Possible values for do_replace argument to rl_filename_quoting_function,
679 called by rl_complete_internal. */
680#define NO_MATCH 0
681#define SINGLE_MATCH 1
--- 22 unchanged lines hidden (view full) ---
704#define RL_STATE_INPUTPENDING 0x20000 /* rl_execute_next called */
705
706#define RL_STATE_DONE 0x80000 /* done; accepted line */
707
708#define RL_SETSTATE(x) (rl_readline_state |= (x))
709#define RL_UNSETSTATE(x) (rl_readline_state &= ~(x))
710#define RL_ISSTATE(x) (rl_readline_state & (x))
711
712#if !defined (savestring)
713#define savestring rl_savestring
714extern char *savestring __P((char *)); /* XXX backwards compatibility */
715#endif
716
717#ifdef __cplusplus
718}
719#endif
720
721#endif /* _READLINE_H_ */