1 /* terminal.c -- controlling the terminal with termcap. */
3 /* Copyright (C) 1996-2015 Free Software Foundation, Inc.
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.
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.
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.
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/>.
22 #define READLINE_LIBRARY
24 #if defined (HAVE_CONFIG_H)
28 #include <sys/types.h>
29 #include "posixstat.h"
31 #if defined (HAVE_SYS_FILE_H)
32 # include <sys/file.h>
33 #endif /* HAVE_SYS_FILE_H */
35 #if defined (HAVE_UNISTD_H)
37 #endif /* HAVE_UNISTD_H */
39 #if defined (HAVE_STDLIB_H)
42 # include "ansi_stdlib.h"
43 #endif /* HAVE_STDLIB_H */
45 #if defined (HAVE_LOCALE_H)
51 /* System-specific feature definitions and include files. */
59 #if defined (HAVE_SYS_IOCTL_H)
60 # include <sys/ioctl.h> /* include for declaration of ioctl */
64 /* Some standard library routines. */
68 #include "rlprivate.h"
72 #if defined (__MINGW32__)
76 static void _win_get_screensize
PARAMS((int *, int *));
80 static void _emx_get_screensize
PARAMS((int *, int *));
83 /* If the calling application sets this to a non-zero value, readline will
84 use the $LINES and $COLUMNS environment variables to set its idea of the
85 window size before interrogating the kernel. */
86 int rl_prefer_env_winsize
= 0;
88 /* If this is non-zero, readline will set LINES and COLUMNS in the
89 environment when it handles SIGWINCH. */
90 int rl_change_environment
= 1;
92 /* **************************************************************** */
94 /* Terminal and Termcap */
96 /* **************************************************************** */
99 static char *term_buffer
= (char *)NULL
;
100 static char *term_string_buffer
= (char *)NULL
;
103 static int tcap_initialized
;
105 #if !defined (__linux__) && !defined (NCURSES_VERSION)
106 # if defined (__EMX__) || defined (NEED_EXTERN_PC)
108 # endif /* __EMX__ || NEED_EXTERN_PC */
110 #endif /* !__linux__ && !NCURSES_VERSION */
112 /* Some strings to control terminal actions. These are output by tputs (). */
113 char *_rl_term_clreol
;
114 char *_rl_term_clrpag
;
116 char *_rl_term_backspace
;
120 /* Non-zero if we determine that the terminal can do character insertion. */
121 int _rl_terminal_can_insert
= 0;
123 /* How to insert characters. */
130 /* How to delete characters. */
134 char *_rl_term_forward_char
;
136 /* How to go up a line. */
139 /* A visible bell; char if the terminal can be made to flash the screen. */
140 static char *_rl_visible_bell
;
142 /* Non-zero means the terminal can auto-wrap lines. */
143 int _rl_term_autowrap
= -1;
145 /* Non-zero means that this terminal has a meta key. */
146 static int term_has_meta
;
148 /* The sequences to write to turn on and off the meta key, if this
150 static char *_rl_term_mm
;
151 static char *_rl_term_mo
;
153 /* The key sequences output by the arrow keys, if this terminal has any. */
154 static char *_rl_term_ku
;
155 static char *_rl_term_kd
;
156 static char *_rl_term_kr
;
157 static char *_rl_term_kl
;
159 /* How to initialize and reset the arrow keys, if this terminal has any. */
160 static char *_rl_term_ks
;
161 static char *_rl_term_ke
;
163 /* The key sequences sent by the Home and End keys, if any. */
164 static char *_rl_term_kh
;
165 static char *_rl_term_kH
;
166 static char *_rl_term_at7
; /* @7 */
169 static char *_rl_term_kD
;
172 static char *_rl_term_kI
;
175 static char *_rl_term_vs
; /* very visible */
176 static char *_rl_term_ve
; /* normal */
178 static void bind_termcap_arrow_keys
PARAMS((Keymap
));
180 /* Variables that hold the screen dimensions, used by the display code. */
181 int _rl_screenwidth
, _rl_screenheight
, _rl_screenchars
;
183 /* Non-zero means the user wants to enable the keypad. */
184 int _rl_enable_keypad
;
186 /* Non-zero means the user wants to enable a meta key. */
187 int _rl_enable_meta
= 1;
189 #if defined (__EMX__)
191 _emx_get_screensize (swp
, shp
)
205 #if defined (__MINGW32__)
207 _win_get_screensize (swp
, shp
)
211 CONSOLE_SCREEN_BUFFER_INFO scr
;
213 hConOut
= GetStdHandle (STD_OUTPUT_HANDLE
);
214 if (hConOut
!= INVALID_HANDLE_VALUE
)
216 if (GetConsoleScreenBufferInfo (hConOut
, &scr
))
219 *shp
= scr
.srWindow
.Bottom
- scr
.srWindow
.Top
+ 1;
225 /* Get readline's idea of the screen size. TTY is a file descriptor open
226 to the terminal. If IGNORE_ENV is true, we do not pay attention to the
227 values of $LINES and $COLUMNS. The tests for TERM_STRING_BUFFER being
228 non-null serve to check whether or not we have initialized termcap. */
230 _rl_get_screen_size (tty
, ignore_env
)
234 #if defined (TIOCGWINSZ)
235 struct winsize window_size
;
236 #endif /* TIOCGWINSZ */
240 #if defined (TIOCGWINSZ)
241 if (ioctl (tty
, TIOCGWINSZ
, &window_size
) == 0)
243 wc
= (int) window_size
.ws_col
;
244 wr
= (int) window_size
.ws_row
;
246 #endif /* TIOCGWINSZ */
248 #if defined (__EMX__)
249 _emx_get_screensize (&wc
, &wr
);
250 #elif defined (__MINGW32__)
251 _win_get_screensize (&wc
, &wr
);
254 if (ignore_env
|| rl_prefer_env_winsize
== 0)
256 _rl_screenwidth
= wc
;
257 _rl_screenheight
= wr
;
260 _rl_screenwidth
= _rl_screenheight
= -1;
262 /* Environment variable COLUMNS overrides setting of "co" if IGNORE_ENV
263 is unset. If we prefer the environment, check it first before
264 assigning the value returned by the kernel. */
265 if (_rl_screenwidth
<= 0)
267 if (ignore_env
== 0 && (ss
= sh_get_env_value ("COLUMNS")))
268 _rl_screenwidth
= atoi (ss
);
270 if (_rl_screenwidth
<= 0)
271 _rl_screenwidth
= wc
;
273 #if defined (__DJGPP__)
274 if (_rl_screenwidth
<= 0)
275 _rl_screenwidth
= ScreenCols ();
277 if (_rl_screenwidth
<= 0 && term_string_buffer
)
278 _rl_screenwidth
= tgetnum ("co");
282 /* Environment variable LINES overrides setting of "li" if IGNORE_ENV
284 if (_rl_screenheight
<= 0)
286 if (ignore_env
== 0 && (ss
= sh_get_env_value ("LINES")))
287 _rl_screenheight
= atoi (ss
);
289 if (_rl_screenheight
<= 0)
290 _rl_screenheight
= wr
;
292 #if defined (__DJGPP__)
293 if (_rl_screenheight
<= 0)
294 _rl_screenheight
= ScreenRows ();
296 if (_rl_screenheight
<= 0 && term_string_buffer
)
297 _rl_screenheight
= tgetnum ("li");
301 /* If all else fails, default to 80x24 terminal. */
302 if (_rl_screenwidth
<= 1)
303 _rl_screenwidth
= 80;
305 if (_rl_screenheight
<= 0)
306 _rl_screenheight
= 24;
308 /* If we're being compiled as part of bash, set the environment
309 variables $LINES and $COLUMNS to new values. Otherwise, just
310 do a pair of putenv () or setenv () calls. */
311 if (rl_change_environment
)
312 sh_set_lines_and_columns (_rl_screenheight
, _rl_screenwidth
);
314 if (_rl_term_autowrap
== 0)
317 _rl_screenchars
= _rl_screenwidth
* _rl_screenheight
;
321 _rl_set_screen_size (rows
, cols
)
324 if (_rl_term_autowrap
== -1)
325 _rl_init_terminal_io (rl_terminal_name
);
328 _rl_screenheight
= rows
;
331 _rl_screenwidth
= cols
;
332 if (_rl_term_autowrap
== 0)
336 if (rows
> 0 || cols
> 0)
337 _rl_screenchars
= _rl_screenwidth
* _rl_screenheight
;
341 rl_set_screen_size (rows
, cols
)
344 _rl_set_screen_size (rows
, cols
);
348 rl_get_screen_size (rows
, cols
)
352 *rows
= _rl_screenheight
;
354 *cols
= _rl_screenwidth
;
358 rl_reset_screen_size ()
360 _rl_get_screen_size (fileno (rl_instream
), 0);
364 _rl_sigwinch_resize_terminal ()
366 _rl_get_screen_size (fileno (rl_instream
), 1);
370 rl_resize_terminal ()
372 _rl_get_screen_size (fileno (rl_instream
), 1);
375 if (CUSTOM_REDISPLAY_FUNC ())
376 rl_forced_update_display ();
377 else if (RL_ISSTATE(RL_STATE_REDISPLAYING
) == 0)
378 _rl_redisplay_after_sigwinch ();
383 const char * const tc_var
;
387 /* This should be kept sorted, just in case we decide to change the
388 search algorithm to something smarter. */
389 static const struct _tc_string tc_strings
[] =
391 { "@7", &_rl_term_at7
},
392 { "DC", &_rl_term_DC
},
393 { "IC", &_rl_term_IC
},
394 { "ce", &_rl_term_clreol
},
395 { "cl", &_rl_term_clrpag
},
396 { "cr", &_rl_term_cr
},
397 { "dc", &_rl_term_dc
},
398 { "ei", &_rl_term_ei
},
399 { "ic", &_rl_term_ic
},
400 { "im", &_rl_term_im
},
401 { "kD", &_rl_term_kD
}, /* delete */
402 { "kH", &_rl_term_kH
}, /* home down ?? */
403 { "kI", &_rl_term_kI
}, /* insert */
404 { "kd", &_rl_term_kd
},
405 { "ke", &_rl_term_ke
}, /* end keypad mode */
406 { "kh", &_rl_term_kh
}, /* home */
407 { "kl", &_rl_term_kl
},
408 { "kr", &_rl_term_kr
},
409 { "ks", &_rl_term_ks
}, /* start keypad mode */
410 { "ku", &_rl_term_ku
},
411 { "le", &_rl_term_backspace
},
412 { "mm", &_rl_term_mm
},
413 { "mo", &_rl_term_mo
},
414 { "nd", &_rl_term_forward_char
},
415 { "pc", &_rl_term_pc
},
416 { "up", &_rl_term_up
},
417 { "vb", &_rl_visible_bell
},
418 { "vs", &_rl_term_vs
},
419 { "ve", &_rl_term_ve
},
422 #define NUM_TC_STRINGS (sizeof (tc_strings) / sizeof (struct _tc_string))
424 /* Read the desired terminal capability strings into BP. The capabilities
425 are described in the TC_STRINGS table. */
427 get_term_capabilities (bp
)
430 #if !defined (__DJGPP__) /* XXX - doesn't DJGPP have a termcap library? */
433 for (i
= 0; i
< NUM_TC_STRINGS
; i
++)
434 *(tc_strings
[i
].tc_value
) = tgetstr ((char *)tc_strings
[i
].tc_var
, bp
);
436 tcap_initialized
= 1;
440 _rl_init_terminal_io (terminal_name
)
441 const char *terminal_name
;
445 int tty
, tgetent_ret
;
447 term
= terminal_name
? terminal_name
: sh_get_env_value ("TERM");
448 _rl_term_clrpag
= _rl_term_cr
= _rl_term_clreol
= (char *)NULL
;
449 tty
= rl_instream
? fileno (rl_instream
) : 0;
455 _rl_term_im
= _rl_term_ei
= _rl_term_ic
= _rl_term_IC
= (char *)NULL
;
456 _rl_term_up
= _rl_term_dc
= _rl_term_DC
= _rl_visible_bell
= (char *)NULL
;
457 _rl_term_ku
= _rl_term_kd
= _rl_term_kl
= _rl_term_kr
= (char *)NULL
;
458 _rl_term_mm
= _rl_term_mo
= (char *)NULL
;
459 _rl_terminal_can_insert
= term_has_meta
= _rl_term_autowrap
= 0;
461 _rl_term_clreol
= _rl_term_clrpag
= _rl_term_backspace
= (char *)NULL
;
462 _rl_term_goto
= _rl_term_pc
= _rl_term_ip
= (char *)NULL
;
463 _rl_term_ks
= _rl_term_ke
=_rl_term_vs
= _rl_term_ve
= (char *)NULL
;
464 _rl_term_kh
= _rl_term_kH
= _rl_term_at7
= _rl_term_kI
= (char *)NULL
;
465 #if defined(HACK_TERMCAP_MOTION)
466 _rl_term_forward_char
= (char *)NULL
;
469 _rl_get_screen_size (tty
, 0);
470 #else /* !__MSDOS__ */
471 /* I've separated this out for later work on not calling tgetent at all
472 if the calling application has supplied a custom redisplay function,
473 (and possibly if the application has supplied a custom input function). */
474 if (CUSTOM_REDISPLAY_FUNC())
480 if (term_string_buffer
== 0)
481 term_string_buffer
= (char *)xmalloc(2032);
483 if (term_buffer
== 0)
484 term_buffer
= (char *)xmalloc(4080);
486 buffer
= term_string_buffer
;
488 tgetent_ret
= tgetent (term_buffer
, term
);
491 if (tgetent_ret
<= 0)
493 FREE (term_string_buffer
);
495 buffer
= term_buffer
= term_string_buffer
= (char *)NULL
;
497 _rl_term_autowrap
= 0; /* used by _rl_get_screen_size */
499 /* Allow calling application to set default height and width, using
500 rl_set_screen_size */
501 if (_rl_screenwidth
<= 0 || _rl_screenheight
<= 0)
503 #if defined (__EMX__)
504 _emx_get_screensize (&_rl_screenwidth
, &_rl_screenheight
);
507 _rl_get_screen_size (tty
, 0);
508 #endif /* !__EMX__ */
512 if (_rl_screenwidth
<= 0 || _rl_screenheight
<= 0)
514 _rl_screenwidth
= 79;
515 _rl_screenheight
= 24;
518 /* Everything below here is used by the redisplay code (tputs). */
519 _rl_screenchars
= _rl_screenwidth
* _rl_screenheight
;
521 _rl_term_im
= _rl_term_ei
= _rl_term_ic
= _rl_term_IC
= (char *)NULL
;
522 _rl_term_up
= _rl_term_dc
= _rl_term_DC
= _rl_visible_bell
= (char *)NULL
;
523 _rl_term_ku
= _rl_term_kd
= _rl_term_kl
= _rl_term_kr
= (char *)NULL
;
524 _rl_term_kh
= _rl_term_kH
= _rl_term_kI
= _rl_term_kD
= (char *)NULL
;
525 _rl_term_ks
= _rl_term_ke
= _rl_term_at7
= (char *)NULL
;
526 _rl_term_mm
= _rl_term_mo
= (char *)NULL
;
527 _rl_term_ve
= _rl_term_vs
= (char *)NULL
;
528 _rl_term_forward_char
= (char *)NULL
;
529 _rl_terminal_can_insert
= term_has_meta
= 0;
531 /* Reasonable defaults for tgoto(). Readline currently only uses
532 tgoto if _rl_term_IC or _rl_term_DC is defined, but just in case we
533 change that later... */
535 BC
= _rl_term_backspace
= "\b";
541 get_term_capabilities (&buffer
);
543 /* Set up the variables that the termcap library expects the application
545 PC
= _rl_term_pc
? *_rl_term_pc
: 0;
546 BC
= _rl_term_backspace
;
552 _rl_term_autowrap
= tgetflag ("am") && tgetflag ("xn");
554 /* Allow calling application to set default height and width, using
555 rl_set_screen_size */
556 if (_rl_screenwidth
<= 0 || _rl_screenheight
<= 0)
557 _rl_get_screen_size (tty
, 0);
559 /* "An application program can assume that the terminal can do
560 character insertion if *any one of* the capabilities `IC',
561 `im', `ic' or `ip' is provided." But we can't do anything if
562 only `ip' is provided, so... */
563 _rl_terminal_can_insert
= (_rl_term_IC
|| _rl_term_im
|| _rl_term_ic
);
565 /* Check to see if this terminal has a meta key and clear the capability
566 variables if there is none. */
567 term_has_meta
= tgetflag ("km") != 0;
568 if (term_has_meta
== 0)
569 _rl_term_mm
= _rl_term_mo
= (char *)NULL
;
570 #endif /* !__MSDOS__ */
572 /* Attempt to find and bind the arrow keys. Do not override already
573 bound keys in an overzealous attempt, however. */
575 bind_termcap_arrow_keys (emacs_standard_keymap
);
577 #if defined (VI_MODE)
578 bind_termcap_arrow_keys (vi_movement_keymap
);
579 bind_termcap_arrow_keys (vi_insertion_keymap
);
585 /* Bind the arrow key sequences from the termcap description in MAP. */
587 bind_termcap_arrow_keys (map
)
592 xkeymap
= _rl_keymap
;
595 rl_bind_keyseq_if_unbound (_rl_term_ku
, rl_get_previous_history
);
596 rl_bind_keyseq_if_unbound (_rl_term_kd
, rl_get_next_history
);
597 rl_bind_keyseq_if_unbound (_rl_term_kr
, rl_forward_char
);
598 rl_bind_keyseq_if_unbound (_rl_term_kl
, rl_backward_char
);
600 rl_bind_keyseq_if_unbound (_rl_term_kh
, rl_beg_of_line
); /* Home */
601 rl_bind_keyseq_if_unbound (_rl_term_at7
, rl_end_of_line
); /* End */
603 rl_bind_keyseq_if_unbound (_rl_term_kD
, rl_delete
);
605 _rl_keymap
= xkeymap
;
614 if (tcap_initialized
== 0)
615 return ((char *)NULL
);
616 for (i
= 0; i
< NUM_TC_STRINGS
; i
++)
618 if (tc_strings
[i
].tc_var
[0] == cap
[0] && strcmp (tc_strings
[i
].tc_var
, cap
) == 0)
619 return *(tc_strings
[i
].tc_value
);
621 return ((char *)NULL
);
624 /* Re-initialize the terminal considering that the TERM/TERMCAP variable
627 rl_reset_terminal (terminal_name
)
628 const char *terminal_name
;
630 _rl_screenwidth
= _rl_screenheight
= 0;
631 _rl_init_terminal_io (terminal_name
);
635 /* A function for the use of tputs () */
638 _rl_output_character_function (c
)
641 putc (c
, _rl_out_stream
);
645 _rl_output_character_function (c
)
648 return putc (c
, _rl_out_stream
);
652 /* Write COUNT characters from STRING to the output stream. */
654 _rl_output_some_chars (string
, count
)
658 fwrite (string
, 1, count
, _rl_out_stream
);
661 /* Move the cursor back. */
663 _rl_backspace (count
)
669 if (_rl_term_backspace
)
670 for (i
= 0; i
< count
; i
++)
671 tputs (_rl_term_backspace
, 1, _rl_output_character_function
);
674 for (i
= 0; i
< count
; i
++)
675 putc ('\b', _rl_out_stream
);
679 /* Move to the start of the next line. */
683 #if defined (NEW_TTY_DRIVER) || defined (__MINT__)
685 tputs (_rl_term_cr
, 1, _rl_output_character_function
);
686 #endif /* NEW_TTY_DRIVER || __MINT__ */
687 putc ('\n', _rl_out_stream
);
691 /* Ring the terminal bell. */
697 switch (_rl_bell_preference
)
703 if (_rl_visible_bell
)
708 tputs (_rl_visible_bell
, 1, _rl_output_character_function
);
714 fprintf (stderr
, "\007");
723 /* **************************************************************** */
725 /* Controlling the Meta Key and Keypad */
727 /* **************************************************************** */
729 static int enabled_meta
= 0; /* flag indicating we enabled meta mode */
732 _rl_enable_meta_key ()
734 #if !defined (__DJGPP__)
735 if (term_has_meta
&& _rl_term_mm
)
737 tputs (_rl_term_mm
, 1, _rl_output_character_function
);
744 _rl_disable_meta_key ()
746 #if !defined (__DJGPP__)
747 if (term_has_meta
&& _rl_term_mo
&& enabled_meta
)
749 tputs (_rl_term_mo
, 1, _rl_output_character_function
);
756 _rl_control_keypad (on
)
759 #if !defined (__DJGPP__)
760 if (on
&& _rl_term_ks
)
761 tputs (_rl_term_ks
, 1, _rl_output_character_function
);
762 else if (!on
&& _rl_term_ke
)
763 tputs (_rl_term_ke
, 1, _rl_output_character_function
);
767 /* **************************************************************** */
769 /* Controlling the Cursor */
771 /* **************************************************************** */
773 /* Set the cursor appropriately depending on IM, which is one of the
774 insert modes (insert or overwrite). Insert mode gets the normal
775 cursor. Overwrite mode gets a very visible cursor. Only does
776 anything if we have both capabilities. */
778 _rl_set_cursor (im
, force
)
782 if (_rl_term_ve
&& _rl_term_vs
)
784 if (force
|| im
!= rl_insert_mode
)
786 if (im
== RL_IM_OVERWRITE
)
787 tputs (_rl_term_vs
, 1, _rl_output_character_function
);
789 tputs (_rl_term_ve
, 1, _rl_output_character_function
);