1 /* terminal.c -- controlling the terminal with termcap. */
3 /* Copyright (C) 1996-2009 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. */
54 #if defined (GWINSZ_IN_SYS_IOCTL) && !defined (TIOCGWINSZ)
55 # include <sys/ioctl.h>
56 #endif /* GWINSZ_IN_SYS_IOCTL && !TIOCGWINSZ */
65 /* Some standard library routines. */
69 #include "rlprivate.h"
73 #if defined (__MINGW32__)
77 static void _win_get_screensize
PARAMS((int *, int *));
81 static void _emx_get_screensize
PARAMS((int *, int *));
84 #if defined (__MINGW32__)
89 #define CUSTOM_REDISPLAY_FUNC() (rl_redisplay_function != rl_redisplay)
90 #define CUSTOM_INPUT_FUNC() (rl_getc_function != rl_getc)
92 /* If the calling application sets this to a non-zero value, readline will
93 use the $LINES and $COLUMNS environment variables to set its idea of the
94 window size before interrogating the kernel. */
95 int rl_prefer_env_winsize
= 0;
97 /* **************************************************************** */
99 /* Terminal and Termcap */
101 /* **************************************************************** */
104 static char *term_buffer
= (char *)NULL
;
105 static char *term_string_buffer
= (char *)NULL
;
106 #endif /* !__MSDOS__ */
108 static int tcap_initialized
;
110 #if !defined (__linux__) && !defined (NCURSES_VERSION)
111 # if defined (__EMX__) || defined (NEED_EXTERN_PC)
113 # endif /* __EMX__ || NEED_EXTERN_PC */
115 #endif /* !__linux__ && !NCURSES_VERSION */
117 /* Some strings to control terminal actions. These are output by tputs (). */
118 char *_rl_term_clreol
;
119 char *_rl_term_clrpag
;
121 char *_rl_term_backspace
;
125 /* Non-zero if we determine that the terminal can do character insertion. */
126 int _rl_terminal_can_insert
= 0;
128 /* How to insert characters. */
135 /* How to delete characters. */
139 char *_rl_term_forward_char
;
141 /* How to go up a line. */
144 /* A visible bell; char if the terminal can be made to flash the screen. */
145 static char *_rl_visible_bell
;
147 /* Non-zero means the terminal can auto-wrap lines. */
148 int _rl_term_autowrap
= -1;
150 /* Non-zero means that this terminal has a meta key. */
151 static int term_has_meta
;
153 /* The sequences to write to turn on and off the meta key, if this
155 static char *_rl_term_mm
;
156 static char *_rl_term_mo
;
158 /* The key sequences output by the arrow keys, if this terminal has any. */
159 static char *_rl_term_ku
;
160 static char *_rl_term_kd
;
161 static char *_rl_term_kr
;
162 static char *_rl_term_kl
;
164 /* How to initialize and reset the arrow keys, if this terminal has any. */
165 static char *_rl_term_ks
;
166 static char *_rl_term_ke
;
168 /* The key sequences sent by the Home and End keys, if any. */
169 static char *_rl_term_kh
;
170 static char *_rl_term_kH
;
171 static char *_rl_term_at7
; /* @7 */
174 static char *_rl_term_kD
;
177 static char *_rl_term_kI
;
180 static char *_rl_term_vs
; /* very visible */
181 static char *_rl_term_ve
; /* normal */
183 static void bind_termcap_arrow_keys
PARAMS((Keymap
));
185 /* Variables that hold the screen dimensions, used by the display code. */
186 int _rl_screenwidth
, _rl_screenheight
, _rl_screenchars
;
188 /* Non-zero means the user wants to enable the keypad. */
189 int _rl_enable_keypad
;
191 /* Non-zero means the user wants to enable a meta key. */
192 int _rl_enable_meta
= 1;
194 #if defined (__EMX__)
196 _emx_get_screensize (swp
, shp
)
210 #if defined (__MINGW32__)
212 _win_get_screensize (swp
, shp
)
216 CONSOLE_SCREEN_BUFFER_INFO scr
;
218 hConOut
= GetStdHandle (STD_OUTPUT_HANDLE
);
219 if (hConOut
!= INVALID_HANDLE_VALUE
)
221 if (GetConsoleScreenBufferInfo (hConOut
, &scr
))
224 *shp
= scr
.srWindow
.Bottom
- scr
.srWindow
.Top
+ 1;
230 /* Get readline's idea of the screen size. TTY is a file descriptor open
231 to the terminal. If IGNORE_ENV is true, we do not pay attention to the
232 values of $LINES and $COLUMNS. The tests for TERM_STRING_BUFFER being
233 non-null serve to check whether or not we have initialized termcap. */
235 _rl_get_screen_size (tty
, ignore_env
)
239 #if defined (TIOCGWINSZ)
240 struct winsize window_size
;
241 #endif /* TIOCGWINSZ */
245 #if defined (TIOCGWINSZ)
246 if (ioctl (tty
, TIOCGWINSZ
, &window_size
) == 0)
248 wc
= (int) window_size
.ws_col
;
249 wr
= (int) window_size
.ws_row
;
251 #endif /* TIOCGWINSZ */
253 /* For MinGW, we get the console size from the Windows API. */
254 #if defined (__MINGW32__)
255 HANDLE hConOut
= GetStdHandle (STD_OUTPUT_HANDLE
);
256 if (hConOut
!= INVALID_HANDLE_VALUE
)
258 CONSOLE_SCREEN_BUFFER_INFO scr
;
259 if (GetConsoleScreenBufferInfo (hConOut
, &scr
))
262 wr
= scr
.srWindow
.Bottom
- scr
.srWindow
.Top
+ 1;
267 #if defined (__EMX__)
268 _emx_get_screensize (&wc
, &wr
);
269 #elif defined (__MINGW32__)
270 _win_get_screensize (&wc
, &wr
);
273 if (ignore_env
|| rl_prefer_env_winsize
== 0)
275 _rl_screenwidth
= wc
;
276 _rl_screenheight
= wr
;
279 _rl_screenwidth
= _rl_screenheight
= -1;
281 /* Environment variable COLUMNS overrides setting of "co" if IGNORE_ENV
282 is unset. If we prefer the environment, check it first before
283 assigning the value returned by the kernel. */
284 if (_rl_screenwidth
<= 0)
286 if (ignore_env
== 0 && (ss
= sh_get_env_value ("COLUMNS")))
287 _rl_screenwidth
= atoi (ss
);
289 if (_rl_screenwidth
<= 0)
290 _rl_screenwidth
= wc
;
292 #if defined (__DJGPP__)
293 if (_rl_screenwidth
<= 0)
294 _rl_screenwidth
= ScreenCols ();
296 if (_rl_screenwidth
<= 0 && term_string_buffer
)
297 _rl_screenwidth
= tgetnum ("co");
301 /* Environment variable LINES overrides setting of "li" if IGNORE_ENV
303 if (_rl_screenheight
<= 0)
305 if (ignore_env
== 0 && (ss
= sh_get_env_value ("LINES")))
306 _rl_screenheight
= atoi (ss
);
308 if (_rl_screenheight
<= 0)
309 _rl_screenheight
= wr
;
311 #if defined (__DJGPP__)
312 if (_rl_screenheight
<= 0)
313 _rl_screenheight
= ScreenRows ();
315 if (_rl_screenheight
<= 0 && term_string_buffer
)
316 _rl_screenheight
= tgetnum ("li");
320 /* If all else fails, default to 80x24 terminal. */
321 if (_rl_screenwidth
<= 1)
322 _rl_screenwidth
= 80;
324 if (_rl_screenheight
<= 0)
325 _rl_screenheight
= 24;
327 /* If we're being compiled as part of bash, set the environment
328 variables $LINES and $COLUMNS to new values. Otherwise, just
329 do a pair of putenv () or setenv () calls. */
330 sh_set_lines_and_columns (_rl_screenheight
, _rl_screenwidth
);
332 if (_rl_term_autowrap
== 0)
335 _rl_screenchars
= _rl_screenwidth
* _rl_screenheight
;
339 _rl_set_screen_size (rows
, cols
)
342 if (_rl_term_autowrap
== -1)
343 _rl_init_terminal_io (rl_terminal_name
);
346 _rl_screenheight
= rows
;
349 _rl_screenwidth
= cols
;
350 if (_rl_term_autowrap
== 0)
354 if (rows
> 0 || cols
> 0)
355 _rl_screenchars
= _rl_screenwidth
* _rl_screenheight
;
359 rl_set_screen_size (rows
, cols
)
362 _rl_set_screen_size (rows
, cols
);
366 rl_get_screen_size (rows
, cols
)
370 *rows
= _rl_screenheight
;
372 *cols
= _rl_screenwidth
;
376 rl_reset_screen_size ()
378 _rl_get_screen_size (fileno (rl_instream
), 0);
382 rl_resize_terminal ()
384 _rl_get_screen_size (fileno (rl_instream
), 1);
387 if (CUSTOM_REDISPLAY_FUNC ())
388 rl_forced_update_display ();
389 else if (RL_ISSTATE(RL_STATE_REDISPLAYING
) == 0)
390 _rl_redisplay_after_sigwinch ();
395 const char * const tc_var
;
399 /* This should be kept sorted, just in case we decide to change the
400 search algorithm to something smarter. */
401 static const struct _tc_string tc_strings
[] =
403 { "@7", &_rl_term_at7
},
404 { "DC", &_rl_term_DC
},
405 { "IC", &_rl_term_IC
},
406 { "ce", &_rl_term_clreol
},
407 { "cl", &_rl_term_clrpag
},
408 { "cr", &_rl_term_cr
},
409 { "dc", &_rl_term_dc
},
410 { "ei", &_rl_term_ei
},
411 { "ic", &_rl_term_ic
},
412 { "im", &_rl_term_im
},
413 { "kD", &_rl_term_kD
}, /* delete */
414 { "kH", &_rl_term_kH
}, /* home down ?? */
415 { "kI", &_rl_term_kI
}, /* insert */
416 { "kd", &_rl_term_kd
},
417 { "ke", &_rl_term_ke
}, /* end keypad mode */
418 { "kh", &_rl_term_kh
}, /* home */
419 { "kl", &_rl_term_kl
},
420 { "kr", &_rl_term_kr
},
421 { "ks", &_rl_term_ks
}, /* start keypad mode */
422 { "ku", &_rl_term_ku
},
423 { "le", &_rl_term_backspace
},
424 { "mm", &_rl_term_mm
},
425 { "mo", &_rl_term_mo
},
426 { "nd", &_rl_term_forward_char
},
427 { "pc", &_rl_term_pc
},
428 { "up", &_rl_term_up
},
429 { "vb", &_rl_visible_bell
},
430 { "vs", &_rl_term_vs
},
431 { "ve", &_rl_term_ve
},
434 #define NUM_TC_STRINGS (sizeof (tc_strings) / sizeof (struct _tc_string))
436 /* Read the desired terminal capability strings into BP. The capabilities
437 are described in the TC_STRINGS table. */
439 get_term_capabilities (bp
)
442 #if !defined (__DJGPP__) /* XXX - doesn't DJGPP have a termcap library? */
445 for (i
= 0; i
< NUM_TC_STRINGS
; i
++)
446 *(tc_strings
[i
].tc_value
) = tgetstr ((char *)tc_strings
[i
].tc_var
, bp
);
448 tcap_initialized
= 1;
452 _rl_init_terminal_io (terminal_name
)
453 const char *terminal_name
;
457 int tty
, tgetent_ret
;
459 term
= terminal_name
? terminal_name
: sh_get_env_value ("TERM");
460 _rl_term_clrpag
= _rl_term_cr
= _rl_term_clreol
= (char *)NULL
;
461 tty
= rl_instream
? fileno (rl_instream
) : 0;
467 _rl_term_im
= _rl_term_ei
= _rl_term_ic
= _rl_term_IC
= (char *)NULL
;
468 _rl_term_up
= _rl_term_dc
= _rl_term_DC
= _rl_visible_bell
= (char *)NULL
;
469 _rl_term_ku
= _rl_term_kd
= _rl_term_kl
= _rl_term_kr
= (char *)NULL
;
470 _rl_term_mm
= _rl_term_mo
= (char *)NULL
;
471 _rl_terminal_can_insert
= term_has_meta
= _rl_term_autowrap
= 0;
473 _rl_term_clreol
= _rl_term_clrpag
= _rl_term_backspace
= (char *)NULL
;
474 _rl_term_goto
= _rl_term_pc
= _rl_term_ip
= (char *)NULL
;
475 _rl_term_ks
= _rl_term_ke
=_rl_term_vs
= _rl_term_ve
= (char *)NULL
;
476 _rl_term_kh
= _rl_term_kH
= _rl_term_at7
= _rl_term_kI
= (char *)NULL
;
477 #if defined(HACK_TERMCAP_MOTION)
478 _rl_term_forward_char
= (char *)NULL
;
481 _rl_get_screen_size (tty
, 0);
482 #else /* !__MSDOS__ */
483 /* I've separated this out for later work on not calling tgetent at all
484 if the calling application has supplied a custom redisplay function,
485 (and possibly if the application has supplied a custom input function). */
486 if (CUSTOM_REDISPLAY_FUNC())
492 if (term_string_buffer
== 0)
493 term_string_buffer
= (char *)xmalloc(2032);
495 if (term_buffer
== 0)
496 term_buffer
= (char *)xmalloc(4080);
498 buffer
= term_string_buffer
;
500 tgetent_ret
= tgetent (term_buffer
, term
);
503 if (tgetent_ret
<= 0)
505 FREE (term_string_buffer
);
507 buffer
= term_buffer
= term_string_buffer
= (char *)NULL
;
509 _rl_term_autowrap
= 0; /* used by _rl_get_screen_size */
511 /* Allow calling application to set default height and width, using
512 rl_set_screen_size */
513 if (_rl_screenwidth
<= 0 || _rl_screenheight
<= 0)
515 #if defined (__EMX__)
516 _emx_get_screensize (&_rl_screenwidth
, &_rl_screenheight
);
519 _rl_get_screen_size (tty
, 0);
520 #endif /* !__EMX__ */
524 if (_rl_screenwidth
<= 0 || _rl_screenheight
<= 0)
526 _rl_screenwidth
= 79;
527 _rl_screenheight
= 24;
530 /* Everything below here is used by the redisplay code (tputs). */
531 _rl_screenchars
= _rl_screenwidth
* _rl_screenheight
;
533 _rl_term_im
= _rl_term_ei
= _rl_term_ic
= _rl_term_IC
= (char *)NULL
;
534 _rl_term_up
= _rl_term_dc
= _rl_term_DC
= _rl_visible_bell
= (char *)NULL
;
535 _rl_term_ku
= _rl_term_kd
= _rl_term_kl
= _rl_term_kr
= (char *)NULL
;
536 _rl_term_kh
= _rl_term_kH
= _rl_term_kI
= _rl_term_kD
= (char *)NULL
;
537 _rl_term_ks
= _rl_term_ke
= _rl_term_at7
= (char *)NULL
;
538 _rl_term_mm
= _rl_term_mo
= (char *)NULL
;
539 _rl_term_ve
= _rl_term_vs
= (char *)NULL
;
540 _rl_term_forward_char
= (char *)NULL
;
541 _rl_terminal_can_insert
= term_has_meta
= 0;
543 /* Reasonable defaults for tgoto(). Readline currently only uses
544 tgoto if _rl_term_IC or _rl_term_DC is defined, but just in case we
545 change that later... */
547 BC
= _rl_term_backspace
= "\b";
553 get_term_capabilities (&buffer
);
555 /* Set up the variables that the termcap library expects the application
557 PC
= _rl_term_pc
? *_rl_term_pc
: 0;
558 BC
= _rl_term_backspace
;
564 _rl_term_autowrap
= tgetflag ("am") && tgetflag ("xn");
566 /* Allow calling application to set default height and width, using
567 rl_set_screen_size */
568 if (_rl_screenwidth
<= 0 || _rl_screenheight
<= 0)
569 _rl_get_screen_size (tty
, 0);
571 /* "An application program can assume that the terminal can do
572 character insertion if *any one of* the capabilities `IC',
573 `im', `ic' or `ip' is provided." But we can't do anything if
574 only `ip' is provided, so... */
575 _rl_terminal_can_insert
= (_rl_term_IC
|| _rl_term_im
|| _rl_term_ic
);
577 /* Check to see if this terminal has a meta key and clear the capability
578 variables if there is none. */
579 term_has_meta
= tgetflag ("km") != 0;
580 if (term_has_meta
== 0)
581 _rl_term_mm
= _rl_term_mo
= (char *)NULL
;
583 #endif /* !__MSDOS__ */
585 /* Attempt to find and bind the arrow keys. Do not override already
586 bound keys in an overzealous attempt, however. */
588 bind_termcap_arrow_keys (emacs_standard_keymap
);
590 #if defined (VI_MODE)
591 bind_termcap_arrow_keys (vi_movement_keymap
);
592 bind_termcap_arrow_keys (vi_insertion_keymap
);
598 /* Bind the arrow key sequences from the termcap description in MAP. */
600 bind_termcap_arrow_keys (map
)
605 xkeymap
= _rl_keymap
;
608 rl_bind_keyseq_if_unbound (_rl_term_ku
, rl_get_previous_history
);
609 rl_bind_keyseq_if_unbound (_rl_term_kd
, rl_get_next_history
);
610 rl_bind_keyseq_if_unbound (_rl_term_kr
, rl_forward_char
);
611 rl_bind_keyseq_if_unbound (_rl_term_kl
, rl_backward_char
);
613 rl_bind_keyseq_if_unbound (_rl_term_kh
, rl_beg_of_line
); /* Home */
614 rl_bind_keyseq_if_unbound (_rl_term_at7
, rl_end_of_line
); /* End */
616 rl_bind_keyseq_if_unbound (_rl_term_kD
, rl_delete
);
618 _rl_keymap
= xkeymap
;
627 if (tcap_initialized
== 0)
628 return ((char *)NULL
);
629 for (i
= 0; i
< NUM_TC_STRINGS
; i
++)
631 if (tc_strings
[i
].tc_var
[0] == cap
[0] && strcmp (tc_strings
[i
].tc_var
, cap
) == 0)
632 return *(tc_strings
[i
].tc_value
);
634 return ((char *)NULL
);
637 /* Re-initialize the terminal considering that the TERM/TERMCAP variable
640 rl_reset_terminal (terminal_name
)
641 const char *terminal_name
;
643 _rl_screenwidth
= _rl_screenheight
= 0;
644 _rl_init_terminal_io (terminal_name
);
648 /* A function for the use of tputs () */
651 _rl_output_character_function (c
)
654 putc (c
, _rl_out_stream
);
658 _rl_output_character_function (c
)
661 return putc (c
, _rl_out_stream
);
665 /* Write COUNT characters from STRING to the output stream. */
667 _rl_output_some_chars (string
, count
)
671 fwrite (string
, 1, count
, _rl_out_stream
);
674 /* Move the cursor back. */
676 _rl_backspace (count
)
682 if (_rl_term_backspace
)
683 for (i
= 0; i
< count
; i
++)
684 tputs (_rl_term_backspace
, 1, _rl_output_character_function
);
687 for (i
= 0; i
< count
; i
++)
688 putc ('\b', _rl_out_stream
);
692 /* Move to the start of the next line. */
696 #if defined (NEW_TTY_DRIVER) || defined (__MINT__)
698 tputs (_rl_term_cr
, 1, _rl_output_character_function
);
699 #endif /* NEW_TTY_DRIVER || __MINT__ */
700 putc ('\n', _rl_out_stream
);
704 /* Ring the terminal bell. */
710 switch (_rl_bell_preference
)
720 if (_rl_visible_bell
)
722 tputs (_rl_visible_bell
, 1, _rl_output_character_function
);
728 fprintf (stderr
, "\007");
737 /* **************************************************************** */
739 /* Controlling the Meta Key and Keypad */
741 /* **************************************************************** */
744 _rl_enable_meta_key ()
746 #if !defined (__DJGPP__)
747 if (term_has_meta
&& _rl_term_mm
)
748 tputs (_rl_term_mm
, 1, _rl_output_character_function
);
753 _rl_control_keypad (on
)
756 #if !defined (__DJGPP__)
757 if (on
&& _rl_term_ks
)
758 tputs (_rl_term_ks
, 1, _rl_output_character_function
);
759 else if (!on
&& _rl_term_ke
)
760 tputs (_rl_term_ke
, 1, _rl_output_character_function
);
764 /* **************************************************************** */
766 /* Controlling the Cursor */
768 /* **************************************************************** */
770 /* Set the cursor appropriately depending on IM, which is one of the
771 insert modes (insert or overwrite). Insert mode gets the normal
772 cursor. Overwrite mode gets a very visible cursor. Only does
773 anything if we have both capabilities. */
775 _rl_set_cursor (im
, force
)
779 if (_rl_term_ve
&& _rl_term_vs
)
781 if (force
|| im
!= rl_insert_mode
)
783 if (im
== RL_IM_OVERWRITE
)
784 tputs (_rl_term_vs
, 1, _rl_output_character_function
);
786 tputs (_rl_term_ve
, 1, _rl_output_character_function
);