]> git.ipfire.org Git - thirdparty/readline.git/blob - rlprivate.h
Readline-8.2 patch 6: fix for callback signal handling when a signal arrives before...
[thirdparty/readline.git] / rlprivate.h
1 /* rlprivate.h -- functions and variables global to the readline library,
2 but not intended for use by applications. */
3
4 /* Copyright (C) 1999-2022 Free Software Foundation, Inc.
5
6 This file is part of the GNU Readline Library (Readline), a library
7 for reading lines of text with interactive input and history editing.
8
9 Readline is free software: you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation, either version 3 of the License, or
12 (at your option) any later version.
13
14 Readline is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
18
19 You should have received a copy of the GNU General Public License
20 along with Readline. If not, see <http://www.gnu.org/licenses/>.
21 */
22
23 #if !defined (_RL_PRIVATE_H_)
24 #define _RL_PRIVATE_H_
25
26 #include "rlconf.h" /* for VISIBLE_STATS */
27 #include "rlstdc.h"
28 #include "posixjmp.h" /* defines procenv_t */
29 #include "rlmbutil.h" /* for HANDLE_MULTIBYTE */
30
31 /*************************************************************************
32 * *
33 * Convenience definitions *
34 * *
35 *************************************************************************/
36
37 #define EMACS_MODE() (rl_editing_mode == emacs_mode)
38 #define VI_COMMAND_MODE() (rl_editing_mode == vi_mode && _rl_keymap == vi_movement_keymap)
39 #define VI_INSERT_MODE() (rl_editing_mode == vi_mode && _rl_keymap == vi_insertion_keymap)
40
41 #define RL_CHECK_SIGNALS() \
42 do { \
43 if (_rl_caught_signal) _rl_signal_handler (_rl_caught_signal); \
44 } while (0)
45
46 #define RL_SIG_RECEIVED() (_rl_caught_signal != 0)
47 #define RL_SIGINT_RECEIVED() (_rl_caught_signal == SIGINT)
48 #define RL_SIGWINCH_RECEIVED() (_rl_caught_signal == SIGWINCH)
49
50 #define CUSTOM_REDISPLAY_FUNC() (rl_redisplay_function != rl_redisplay)
51 #define CUSTOM_INPUT_FUNC() (rl_getc_function != rl_getc)
52
53 /*************************************************************************
54 * *
55 * Global structs undocumented in texinfo manual and not in readline.h *
56 * *
57 *************************************************************************/
58 /* search types */
59 #define RL_SEARCH_ISEARCH 0x01 /* incremental search */
60 #define RL_SEARCH_NSEARCH 0x02 /* non-incremental search */
61 #define RL_SEARCH_CSEARCH 0x04 /* intra-line char search */
62
63 /* search flags */
64 #define SF_REVERSE 0x01
65 #define SF_FOUND 0x02
66 #define SF_FAILED 0x04
67 #define SF_CHGKMAP 0x08
68 #define SF_PATTERN 0x10
69 #define SF_NOCASE 0x20 /* unused so far */
70
71 typedef struct __rl_search_context
72 {
73 int type;
74 int sflags;
75
76 char *search_string;
77 int search_string_index;
78 int search_string_size;
79
80 char **lines;
81 char *allocated_line;
82 int hlen;
83 int hindex;
84
85 int save_point;
86 int save_mark;
87 int save_line;
88 int last_found_line;
89 char *prev_line_found;
90
91 UNDO_LIST *save_undo_list;
92
93 Keymap keymap; /* used when dispatching commands in search string */
94 Keymap okeymap; /* original keymap */
95
96 int history_pos;
97 int direction;
98
99 int prevc;
100 int lastc;
101 #if defined (HANDLE_MULTIBYTE)
102 char mb[MB_LEN_MAX];
103 char pmb[MB_LEN_MAX];
104 #endif
105
106 char *sline;
107 int sline_len;
108 int sline_index;
109
110 char *search_terminators;
111 } _rl_search_cxt;
112
113 struct _rl_cmd {
114 Keymap map;
115 int count;
116 int key;
117 rl_command_func_t *func;
118 };
119 extern struct _rl_cmd _rl_pending_command;
120 extern struct _rl_cmd *_rl_command_to_execute;
121
122 /* Callback data for reading numeric arguments */
123 #define NUM_SAWMINUS 0x01
124 #define NUM_SAWDIGITS 0x02
125 #define NUM_READONE 0x04
126
127 typedef int _rl_arg_cxt;
128
129 /* A context for reading key sequences longer than a single character when
130 using the callback interface. */
131 #define KSEQ_DISPATCHED 0x01
132 #define KSEQ_SUBSEQ 0x02
133 #define KSEQ_RECURSIVE 0x04
134
135 typedef struct __rl_keyseq_context
136 {
137 int flags;
138 int subseq_arg;
139 int subseq_retval; /* XXX */
140 int okey;
141
142 Keymap dmap;
143 Keymap oldmap;
144
145 struct __rl_keyseq_context *ocxt;
146 int childval;
147 } _rl_keyseq_cxt;
148
149 /* vi-mode commands that use result of motion command to define boundaries */
150 #define VIM_DELETE 0x01
151 #define VIM_CHANGE 0x02
152 #define VIM_YANK 0x04
153
154 /* various states for vi-mode commands that use motion commands. reflects
155 RL_READLINE_STATE */
156 #define VMSTATE_READ 0x01
157 #define VMSTATE_NUMARG 0x02
158
159 typedef struct __rl_vimotion_context
160 {
161 int op;
162 int state;
163 int flags; /* reserved */
164 _rl_arg_cxt ncxt;
165 int numeric_arg;
166 int start, end; /* rl_point, rl_end */
167 int key, motion; /* initial key, motion command */
168 } _rl_vimotion_cxt;
169
170 /* fill in more as needed */
171 /* `Generic' callback data and functions */
172 typedef struct __rl_callback_generic_arg
173 {
174 int count;
175 int i1, i2;
176 /* add here as needed */
177 } _rl_callback_generic_arg;
178
179 typedef int _rl_callback_func_t (_rl_callback_generic_arg *);
180
181 typedef void _rl_sigcleanup_func_t (int, void *);
182
183 /*************************************************************************
184 * *
185 * Global functions undocumented in texinfo manual and not in readline.h *
186 * *
187 *************************************************************************/
188
189 /*************************************************************************
190 * *
191 * Global variables undocumented in texinfo manual and not in readline.h *
192 * *
193 *************************************************************************/
194
195 /* complete.c */
196 extern int rl_complete_with_tilde_expansion;
197 #if defined (VISIBLE_STATS)
198 extern int rl_visible_stats;
199 #endif /* VISIBLE_STATS */
200 #if defined (COLOR_SUPPORT)
201 extern int _rl_colored_stats;
202 extern int _rl_colored_completion_prefix;
203 #endif
204
205 /* readline.c */
206 extern int rl_line_buffer_len;
207 extern int rl_arg_sign;
208 extern int rl_visible_prompt_length;
209 extern int rl_byte_oriented;
210
211 /* display.c */
212 extern int rl_display_fixed;
213
214 /* parens.c */
215 extern int rl_blink_matching_paren;
216
217 /*************************************************************************
218 * *
219 * Global functions and variables unused and undocumented *
220 * *
221 *************************************************************************/
222
223 /* kill.c */
224 extern int rl_set_retained_kills (int);
225
226 /* terminal.c */
227 extern void _rl_set_screen_size (int, int);
228
229 /* undo.c */
230 extern int _rl_fix_last_undo_of_type (int, int, int);
231
232 /* util.c */
233 extern char *_rl_savestring (const char *);
234
235 /*************************************************************************
236 * *
237 * Functions and variables private to the readline library *
238 * *
239 *************************************************************************/
240
241 /* NOTE: Functions and variables prefixed with `_rl_' are
242 pseudo-global: they are global so they can be shared
243 between files in the readline library, but are not intended
244 to be visible to readline callers. */
245
246 /*************************************************************************
247 * Undocumented private functions *
248 *************************************************************************/
249
250 #if defined(READLINE_CALLBACKS)
251
252 /* readline.c */
253 extern void readline_internal_setup (void);
254 extern char *readline_internal_teardown (int);
255 extern int readline_internal_char (void);
256
257 extern _rl_keyseq_cxt *_rl_keyseq_cxt_alloc (void);
258 extern void _rl_keyseq_cxt_dispose (_rl_keyseq_cxt *);
259 extern void _rl_keyseq_chain_dispose (void);
260
261 extern int _rl_dispatch_callback (_rl_keyseq_cxt *);
262
263 /* callback.c */
264 extern _rl_callback_generic_arg *_rl_callback_data_alloc (int);
265 extern void _rl_callback_data_dispose (_rl_callback_generic_arg *);
266
267 #endif /* READLINE_CALLBACKS */
268
269 /* bind.c */
270 extern char *_rl_untranslate_macro_value (char *, int);
271
272 /* complete.c */
273 extern void _rl_reset_completion_state (void);
274 extern char _rl_find_completion_word (int *, int *);
275 extern void _rl_free_match_list (char **);
276
277 /* display.c */
278 extern char *_rl_strip_prompt (char *);
279 extern void _rl_reset_prompt (void);
280 extern void _rl_move_vert (int);
281 extern void _rl_save_prompt (void);
282 extern void _rl_restore_prompt (void);
283 extern char *_rl_make_prompt_for_search (int);
284 extern void _rl_erase_at_end_of_line (int);
285 extern void _rl_clear_to_eol (int);
286 extern void _rl_clear_screen (int);
287 extern void _rl_update_final (void);
288 extern void _rl_optimize_redisplay (void);
289 extern void _rl_redisplay_after_sigwinch (void);
290 extern void _rl_clean_up_for_exit (void);
291 extern void _rl_erase_entire_line (void);
292 extern int _rl_current_display_line (void);
293 extern void _rl_refresh_line (void);
294
295 /* input.c */
296 extern int _rl_any_typein (void);
297 extern int _rl_input_available (void);
298 extern int _rl_nchars_available (void);
299 extern int _rl_input_queued (int);
300 extern void _rl_insert_typein (int);
301 extern int _rl_unget_char (int);
302 extern int _rl_pushed_input_available (void);
303
304 extern int _rl_timeout_init (void);
305 extern int _rl_timeout_handle_sigalrm (void);
306 #if defined (_POSIXSELECT_H_)
307 /* use as a sentinel for fd_set, struct timeval, and sigset_t definitions */
308 extern int _rl_timeout_select (int, fd_set *, fd_set *, fd_set *, const struct timeval *, const sigset_t *);
309 #endif
310
311 /* isearch.c */
312 extern _rl_search_cxt *_rl_scxt_alloc (int, int);
313 extern void _rl_scxt_dispose (_rl_search_cxt *, int);
314
315 extern int _rl_isearch_dispatch (_rl_search_cxt *, int);
316 extern int _rl_isearch_callback (_rl_search_cxt *);
317 extern int _rl_isearch_cleanup (_rl_search_cxt *, int);
318
319 extern int _rl_search_getchar (_rl_search_cxt *);
320
321 /* kill.c */
322 #ifndef BRACKETED_PASTE_DEFAULT
323 # define BRACKETED_PASTE_DEFAULT 1 /* XXX - for now */
324 #endif
325
326 #define BRACK_PASTE_PREF "\033[200~"
327 #define BRACK_PASTE_SUFF "\033[201~"
328
329 #define BRACK_PASTE_LAST '~'
330 #define BRACK_PASTE_SLEN 6
331
332 #define BRACK_PASTE_INIT "\033[?2004h"
333 #define BRACK_PASTE_FINI "\033[?2004l\r"
334
335 extern int _rl_read_bracketed_paste_prefix (int);
336 extern char *_rl_bracketed_text (size_t *);
337 extern int _rl_bracketed_read_key (void);
338 extern int _rl_bracketed_read_mbstring (char *, int);
339
340 /* macro.c */
341 extern void _rl_with_macro_input (char *);
342 extern int _rl_peek_macro_key (void);
343 extern int _rl_next_macro_key (void);
344 extern int _rl_prev_macro_key (void);
345 extern void _rl_push_executing_macro (void);
346 extern void _rl_pop_executing_macro (void);
347 extern void _rl_add_macro_char (int);
348 extern void _rl_kill_kbd_macro (void);
349
350 /* misc.c */
351 extern int _rl_arg_overflow (void);
352 extern void _rl_arg_init (void);
353 extern int _rl_arg_getchar (void);
354 extern int _rl_arg_callback (_rl_arg_cxt);
355 extern void _rl_reset_argument (void);
356
357 extern void _rl_start_using_history (void);
358 extern int _rl_free_saved_history_line (void);
359 extern void _rl_set_insert_mode (int, int);
360
361 extern void _rl_revert_previous_lines (void);
362 extern void _rl_revert_all_lines (void);
363
364 /* nls.c */
365 extern char *_rl_init_locale (void);
366 extern int _rl_init_eightbit (void);
367 extern void _rl_reset_locale (void);
368
369 /* parens.c */
370 extern void _rl_enable_paren_matching (int);
371
372 /* readline.c */
373 extern void _rl_init_line_state (void);
374 extern void _rl_set_the_line (void);
375 extern int _rl_dispatch (int, Keymap);
376 extern int _rl_dispatch_subseq (int, Keymap, int);
377 extern void _rl_internal_char_cleanup (void);
378
379 extern void _rl_init_executing_keyseq (void);
380 extern void _rl_term_executing_keyseq (void);
381 extern void _rl_end_executing_keyseq (void);
382 extern void _rl_add_executing_keyseq (int);
383 extern void _rl_del_executing_keyseq (void);
384
385 extern rl_command_func_t *_rl_executing_func;
386
387 /* rltty.c */
388 extern int _rl_disable_tty_signals (void);
389 extern int _rl_restore_tty_signals (void);
390
391 /* search.c */
392 extern int _rl_nsearch_callback (_rl_search_cxt *);
393 extern int _rl_nsearch_cleanup (_rl_search_cxt *, int);
394
395 /* signals.c */
396 extern void _rl_signal_handler (int);
397
398 extern void _rl_block_sigint (void);
399 extern void _rl_release_sigint (void);
400 extern void _rl_block_sigwinch (void);
401 extern void _rl_release_sigwinch (void);
402
403 /* terminal.c */
404 extern void _rl_get_screen_size (int, int);
405 extern void _rl_sigwinch_resize_terminal (void);
406 extern int _rl_init_terminal_io (const char *);
407 #ifdef _MINIX
408 extern void _rl_output_character_function (int);
409 #else
410 extern int _rl_output_character_function (int);
411 #endif
412 extern void _rl_cr (void);
413 extern void _rl_output_some_chars (const char *, int);
414 extern int _rl_backspace (int);
415 extern void _rl_enable_meta_key (void);
416 extern void _rl_disable_meta_key (void);
417 extern void _rl_control_keypad (int);
418 extern void _rl_set_cursor (int, int);
419 extern void _rl_standout_on (void);
420 extern void _rl_standout_off (void);
421 extern int _rl_reset_region_color (int, const char *);
422 extern void _rl_region_color_on (void);
423 extern void _rl_region_color_off (void);
424
425 /* text.c */
426 extern void _rl_fix_point (int);
427 extern void _rl_fix_mark (void);
428 extern int _rl_replace_text (const char *, int, int);
429 extern int _rl_forward_char_internal (int);
430 extern int _rl_backward_char_internal (int);
431 extern int _rl_insert_char (int, int);
432 extern int _rl_overwrite_char (int, int);
433 extern int _rl_overwrite_rubout (int, int);
434 extern int _rl_rubout_char (int, int);
435 #if defined (HANDLE_MULTIBYTE)
436 extern int _rl_char_search_internal (int, int, char *, int);
437 #else
438 extern int _rl_char_search_internal (int, int, int);
439 #endif
440 extern int _rl_set_mark_at_pos (int);
441
442 /* undo.c */
443 extern UNDO_LIST *_rl_copy_undo_entry (UNDO_LIST *);
444 extern UNDO_LIST *_rl_copy_undo_list (UNDO_LIST *);
445 extern void _rl_free_undo_list (UNDO_LIST *);
446
447 /* util.c */
448 #if defined (USE_VARARGS) && defined (PREFER_STDARG)
449 extern void _rl_ttymsg (const char *, ...) __attribute__((__format__ (printf, 1, 2)));
450 extern void _rl_errmsg (const char *, ...) __attribute__((__format__ (printf, 1, 2)));
451 extern void _rl_trace (const char *, ...) __attribute__((__format__ (printf, 1, 2)));
452 #else
453 extern void _rl_ttymsg ();
454 extern void _rl_errmsg ();
455 extern void _rl_trace ();
456 #endif
457 extern void _rl_audit_tty (char *);
458
459 extern int _rl_tropen (void);
460
461 extern int _rl_abort_internal (void);
462 extern int _rl_null_function (int, int);
463 extern char *_rl_strindex (const char *, const char *);
464 extern int _rl_qsort_string_compare (char **, char **);
465 extern int (_rl_uppercase_p) (int);
466 extern int (_rl_lowercase_p) (int);
467 extern int (_rl_pure_alphabetic) (int);
468 extern int (_rl_digit_p) (int);
469 extern int (_rl_to_lower) (int);
470 extern int (_rl_to_upper) (int);
471 extern int (_rl_digit_value) (int);
472
473 /* vi_mode.c */
474 extern void _rl_vi_initialize_line (void);
475 extern void _rl_vi_reset_last (void);
476 extern void _rl_vi_set_last (int, int, int);
477 extern int _rl_vi_textmod_command (int);
478 extern int _rl_vi_motion_command (int);
479 extern void _rl_vi_done_inserting (void);
480 extern int _rl_vi_domove_callback (_rl_vimotion_cxt *);
481 extern int _rl_vi_domove_motion_cleanup (int, _rl_vimotion_cxt *);
482
483 /* Use HS_HISTORY_VERSION as the sentinel to see if we've included history.h
484 and so can use HIST_ENTRY */
485 #if defined (HS_HISTORY_VERSION)
486 extern void _rl_free_history_entry (HIST_ENTRY *);
487 #endif
488
489 /*************************************************************************
490 * Undocumented private variables *
491 *************************************************************************/
492
493 /* bind.c */
494 extern const char * const _rl_possible_control_prefixes[];
495 extern const char * const _rl_possible_meta_prefixes[];
496
497 /* callback.c */
498 extern _rl_callback_func_t *_rl_callback_func;
499 extern _rl_callback_generic_arg *_rl_callback_data;
500
501 /* complete.c */
502 extern int _rl_complete_show_all;
503 extern int _rl_complete_show_unmodified;
504 extern int _rl_complete_mark_directories;
505 extern int _rl_complete_mark_symlink_dirs;
506 extern int _rl_completion_prefix_display_length;
507 extern int _rl_completion_columns;
508 extern int _rl_print_completions_horizontally;
509 extern int _rl_completion_case_fold;
510 extern int _rl_completion_case_map;
511 extern int _rl_match_hidden_files;
512 extern int _rl_page_completions;
513 extern int _rl_skip_completed_text;
514 extern int _rl_menu_complete_prefix_first;
515
516 /* display.c */
517 extern int _rl_vis_botlin;
518 extern int _rl_last_c_pos;
519 extern int _rl_suppress_redisplay;
520 extern int _rl_want_redisplay;
521
522 extern char *_rl_emacs_mode_str;
523 extern int _rl_emacs_modestr_len;
524 extern char *_rl_vi_ins_mode_str;
525 extern int _rl_vi_ins_modestr_len;
526 extern char *_rl_vi_cmd_mode_str;
527 extern int _rl_vi_cmd_modestr_len;
528
529 /* isearch.c */
530 extern char *_rl_isearch_terminators;
531
532 extern _rl_search_cxt *_rl_iscxt;
533
534 /* macro.c */
535 extern char *_rl_executing_macro;
536
537 /* misc.c */
538 extern int _rl_history_preserve_point;
539 extern int _rl_history_saved_point;
540
541 extern _rl_arg_cxt _rl_argcxt;
542
543 /* nls.c */
544 extern int _rl_utf8locale;
545
546 /* readline.c */
547 extern int _rl_echoing_p;
548 extern int _rl_horizontal_scroll_mode;
549 extern int _rl_mark_modified_lines;
550 extern int _rl_bell_preference;
551 extern int _rl_meta_flag;
552 extern int _rl_convert_meta_chars_to_ascii;
553 extern int _rl_output_meta_chars;
554 extern int _rl_bind_stty_chars;
555 extern int _rl_revert_all_at_newline;
556 extern int _rl_echo_control_chars;
557 extern int _rl_show_mode_in_prompt;
558 extern int _rl_enable_bracketed_paste;
559 extern int _rl_enable_active_region;
560 extern char *_rl_active_region_start_color;
561 extern char *_rl_active_region_end_color;
562 extern char *_rl_comment_begin;
563 extern unsigned char _rl_parsing_conditionalized_out;
564 extern Keymap _rl_keymap;
565 extern FILE *_rl_in_stream;
566 extern FILE *_rl_out_stream;
567 extern int _rl_last_command_was_kill;
568 extern int _rl_eof_char;
569 extern procenv_t _rl_top_level;
570 extern _rl_keyseq_cxt *_rl_kscxt;
571 extern int _rl_keyseq_timeout;
572
573 extern int _rl_executing_keyseq_size;
574
575 extern rl_hook_func_t *_rl_internal_startup_hook;
576
577 /* search.c */
578 extern _rl_search_cxt *_rl_nscxt;
579 extern int _rl_history_search_pos;
580
581 /* signals.c */
582 extern int volatile _rl_caught_signal;
583
584 extern _rl_sigcleanup_func_t *_rl_sigcleanup;
585 extern void *_rl_sigcleanarg;
586
587 extern int _rl_echoctl;
588
589 extern int _rl_intr_char;
590 extern int _rl_quit_char;
591 extern int _rl_susp_char;
592
593 /* terminal.c */
594 extern int _rl_enable_keypad;
595 extern int _rl_enable_meta;
596 extern char *_rl_term_clreol;
597 extern char *_rl_term_clrpag;
598 extern char *_rl_term_clrscroll;
599 extern char *_rl_term_im;
600 extern char *_rl_term_ic;
601 extern char *_rl_term_ei;
602 extern char *_rl_term_DC;
603 extern char *_rl_term_up;
604 extern char *_rl_term_dc;
605 extern char *_rl_term_cr;
606 extern char *_rl_term_IC;
607 extern char *_rl_term_forward_char;
608 extern int _rl_screenheight;
609 extern int _rl_screenwidth;
610 extern int _rl_screenchars;
611 extern int _rl_terminal_can_insert;
612 extern int _rl_term_autowrap;
613
614 /* text.c */
615 extern int _rl_optimize_typeahead;
616 extern int _rl_keep_mark_active;
617
618 /* undo.c */
619 extern int _rl_doing_an_undo;
620 extern int _rl_undo_group_level;
621
622 /* vi_mode.c */
623 extern int _rl_vi_last_command;
624 extern int _rl_vi_redoing;
625 extern _rl_vimotion_cxt *_rl_vimvcxt;
626
627 /* Use HS_HISTORY_VERSION as the sentinel to see if we've included history.h
628 and so can use HIST_ENTRY */
629 #if defined (HS_HISTORY_VERSION)
630 extern HIST_ENTRY *_rl_saved_line_for_history;
631 #endif
632
633 #endif /* _RL_PRIVATE_H_ */