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