2 Interface to the terminal controlling library.
5 Copyright (C) 2005, 2006, 2007, 2009, 2010, 2011
6 The Free Software Foundation, Inc.
9 Andrew Borodin <aborodin@vmail.ru>, 2009
10 Egmont Koblinger <egmont@gmail.com>, 2010
12 This file is part of the Midnight Commander.
14 The Midnight Commander is free software: you can redistribute it
15 and/or modify it under the terms of the GNU General Public License as
16 published by the Free Software Foundation, either version 3 of the License,
17 or (at your option) any later version.
19 The Midnight Commander is distributed in the hope that it will be useful,
20 but WITHOUT ANY WARRANTY; without even the implied warranty of
21 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 GNU General Public License for more details.
24 You should have received a copy of the GNU General Public License
25 along with this program. If not, see <http://www.gnu.org/licenses/>.
29 * \brief Source: S-Lang-based tty layer of Midnight Commander
37 #include <sys/types.h> /* size_t */
39 #ifdef HAVE_SYS_IOCTL_H
40 #include <sys/ioctl.h>
44 #include "lib/global.h"
45 #include "lib/strutil.h" /* str_term_form */
46 #include "lib/util.h" /* is_printable() */
48 #include "tty-internal.h" /* mc_tty_normalize_from_utf8() */
51 #include "color-slang.h"
52 #include "color-internal.h"
53 #include "mouse.h" /* Gpm_Event is required in key.h */
54 #include "key.h" /* define_sequence */
58 /*** global variables ****************************************************************************/
60 extern int reset_hp_softkeys
;
62 /*** file scope macro definitions ****************************************************************/
64 #ifndef SLTT_MAX_SCREEN_COLS
65 #define SLTT_MAX_SCREEN_COLS 512
68 #ifndef SLTT_MAX_SCREEN_ROWS
69 #define SLTT_MAX_SCREEN_ROWS 512
72 /*** file scope type declarations ****************************************************************/
74 /*** file scope variables ************************************************************************/
76 /* Various saved termios settings that we control here */
77 static struct termios boot_mode
;
78 static struct termios new_mode
;
80 /* Controls whether we should wait for input in tty_lowlevel_getch */
81 static gboolean no_slang_delay
;
83 /* This table describes which capabilities we want and which values we
103 { KEY_F (10), "k;" },
104 { KEY_F (11), "F1" },
105 { KEY_F (12), "F2" },
106 { KEY_F (13), "F3" },
107 { KEY_F (14), "F4" },
108 { KEY_F (15), "F5" },
109 { KEY_F (16), "F6" },
110 { KEY_F (17), "F7" },
111 { KEY_F (18), "F8" },
112 { KEY_F (19), "F9" },
113 { KEY_F (20), "FA" },
122 { KEY_BACKSPACE
, "kb" },
129 /* --------------------------------------------------------------------------------------------- */
130 /*** file scope functions ************************************************************************/
131 /* --------------------------------------------------------------------------------------------- */
134 tty_setup_sigwinch (void (*handler
) (int))
136 (void) SLsignal (SIGWINCH
, handler
);
139 /* --------------------------------------------------------------------------------------------- */
142 sigwinch_handler (int dummy
)
146 mc_global
.tty
.winch_flag
= 1;
147 (void) SLsignal (SIGWINCH
, sigwinch_handler
);
150 /* --------------------------------------------------------------------------------------------- */
152 /* HP Terminals have capabilities (pfkey, pfloc, pfx) to program function keys.
153 elm 2.4pl15 invoked with the -K option utilizes these softkeys and the
154 consequence is that function keys don't work in MC sometimes...
155 Unfortunately I don't now the one and only escape sequence to turn off.
156 softkeys (elm uses three different capabilities to turn on softkeys and two.
157 capabilities to turn them off)..
158 Among other things elm uses the pair we already use in slang_keypad. That's.
159 the reason why I call slang_reset_softkeys from slang_keypad. In lack of
160 something better the softkeys are programmed to their defaults from the
161 termcap/terminfo database.
162 The escape sequence to program the softkeys is taken from elm and it is.
163 hardcoded because neither slang nor ncurses 4.1 know how to 'printf' this.
168 slang_reset_softkeys (void)
171 static const char display
[] = " ";
174 for (key
= 1; key
< 9; key
++)
178 g_snprintf (tmp
, sizeof (tmp
), "k%d", key
);
179 send
= (char *) SLtt_tgetstr (tmp
);
182 g_snprintf (tmp
, sizeof (tmp
), ESC_STR
"&f%dk%dd%dL%s%s", key
,
183 (int) (sizeof (display
) - 1), (int) strlen (send
), display
, send
);
184 SLtt_write_string (tmp
);
189 /* --------------------------------------------------------------------------------------------- */
192 do_define_key (int code
, const char *strcap
)
196 seq
= (char *) SLtt_tgetstr ((char *) strcap
);
198 define_sequence (code
, seq
, MCKEY_NOACTION
);
201 /* --------------------------------------------------------------------------------------------- */
204 load_terminfo_keys (void)
208 for (i
= 0; key_table
[i
].key_code
; i
++)
209 do_define_key (key_table
[i
].key_code
, key_table
[i
].key_name
);
212 /* --------------------------------------------------------------------------------------------- */
213 /*** public functions ****************************************************************************/
214 /* --------------------------------------------------------------------------------------------- */
217 mc_tty_normalize_lines_char (const char *str
)
222 struct mc_tty_lines_struct
226 } const lines_codes
[] = {
227 {"\342\224\214", SLSMG_ULCORN_CHAR
},
228 {"\342\224\220", SLSMG_URCORN_CHAR
},
229 {"\342\224\224", SLSMG_LLCORN_CHAR
},
230 {"\342\224\230", SLSMG_LRCORN_CHAR
},
231 {"\342\224\234", SLSMG_LTEE_CHAR
},
232 {"\342\224\244", SLSMG_RTEE_CHAR
},
233 {"\342\224\254", SLSMG_UTEE_CHAR
},
234 {"\342\224\264", SLSMG_DTEE_CHAR
},
235 {"\342\224\200", SLSMG_HLINE_CHAR
},
236 {"\342\224\202", SLSMG_VLINE_CHAR
},
237 {"\342\224\274", SLSMG_PLUS_CHAR
},
245 for (res
= 0; lines_codes
[res
].line
; res
++)
247 if (strcmp (str
, lines_codes
[res
].line
) == 0)
248 return lines_codes
[res
].line_code
;
251 str2
= mc_tty_normalize_from_utf8 (str
);
252 res
= g_utf8_get_char_validated (str2
, -1);
255 res
= (unsigned char) str2
[0];
261 /* --------------------------------------------------------------------------------------------- */
264 tty_init (gboolean mouse_enable
, gboolean is_xterm
)
266 SLtt_Ignore_Beep
= 1;
268 SLutf8_enable (-1); /* has to be called first before any of the other functions. */
269 SLtt_get_terminfo ();
271 * If the terminal in not in terminfo but begins with a well-known
272 * string such as "linux" or "xterm" S-Lang will go on, but the
273 * terminal size and several other variables won't be initialized
274 * (as of S-Lang 1.4.4). Detect it and abort. Also detect extremely
275 * small, large and negative screen dimensions.
277 if ((COLS
< 10) || (LINES
< 5)
278 || (COLS
> SLTT_MAX_SCREEN_COLS
) || (LINES
> SLTT_MAX_SCREEN_ROWS
))
281 _("Screen size %dx%d is not supported.\n"
282 "Check the TERM environment variable.\n"), COLS
, LINES
);
286 tcgetattr (fileno (stdin
), &boot_mode
);
287 /* 255 = ignore abort char; XCTRL('g') for abort char = ^g */
288 SLang_init_tty (XCTRL ('g'), 1, 0);
290 if (mc_global
.tty
.ugly_line_drawing
)
291 SLtt_Has_Alt_Charset
= 0;
293 /* If SLang uses fileno(stderr) for terminal input MC will hang
294 if we call SLang_getkey between calls to open_error_pipe and
295 close_error_pipe, e.g. when we do a growing view of an gzipped
297 if (SLang_TT_Read_FD
== fileno (stderr
))
298 SLang_TT_Read_FD
= fileno (stdin
);
300 if (tcgetattr (SLang_TT_Read_FD
, &new_mode
) == 0)
303 new_mode
.c_cc
[VDSUSP
] = NULL_VALUE
; /* to ignore ^Y */
306 new_mode
.c_cc
[VLNEXT
] = NULL_VALUE
; /* to ignore ^V */
308 tcsetattr (SLang_TT_Read_FD
, TCSADRAIN
, &new_mode
);
311 tty_reset_prog_mode ();
312 load_terminfo_keys ();
314 SLtt_Blink_Mode
= tty_use_256colors ()? 1 : 0;
316 tty_start_interrupt_key ();
318 /* It's the small part from the previous init_key() */
319 init_key_input_fd ();
321 /* For 8-bit locales, NCurses handles 154 (0x9A) symbol properly, while S-Lang
322 * requires SLsmg_Display_Eight_Bit >= 154 (OR manual filtering if xterm display
323 * detected - but checking TERM would fail under screen, OR running xterm
324 * with allowC1Printable).
326 tty_display_8bit (FALSE
);
330 use_mouse_p
= MOUSE_DISABLED
;
331 tty_init_xterm_support (is_xterm
); /* do it before do_enter_ca_mode() call */
336 tty_setup_sigwinch (sigwinch_handler
);
339 /* --------------------------------------------------------------------------------------------- */
347 disable_bracketed_paste ();
348 tty_reset_shell_mode ();
355 /* Load the op capability to reset the colors to those that were
356 * active when the program was started up
358 op_cap
= SLtt_tgetstr ((char *) "op");
361 fputs (op_cap
, stdout
);
366 /* --------------------------------------------------------------------------------------------- */
369 tty_change_screen_size (void)
371 SLtt_get_screen_size ();
374 #ifdef ENABLE_SUBSHELL
375 if (mc_global
.tty
.use_subshell
)
376 tty_resize (mc_global
.tty
.subshell_pty
);
380 /* --------------------------------------------------------------------------------------------- */
381 /* Done each time we come back from done mode */
384 tty_reset_prog_mode (void)
386 tcsetattr (SLang_TT_Read_FD
, TCSANOW
, &new_mode
);
388 SLsmg_touch_lines (0, LINES
);
391 /* --------------------------------------------------------------------------------------------- */
392 /* Called each time we want to shutdown slang screen manager */
395 tty_reset_shell_mode (void)
397 tcsetattr (SLang_TT_Read_FD
, TCSANOW
, &boot_mode
);
400 /* --------------------------------------------------------------------------------------------- */
405 tcsetattr (SLang_TT_Read_FD
, TCSANOW
, &new_mode
);
408 /* --------------------------------------------------------------------------------------------- */
411 tty_noraw_mode (void)
415 /* --------------------------------------------------------------------------------------------- */
422 /* --------------------------------------------------------------------------------------------- */
425 tty_flush_input (void)
430 /* --------------------------------------------------------------------------------------------- */
433 tty_keypad (gboolean set
)
437 keypad_string
= (char *) SLtt_tgetstr ((char *) (set
? "ks" : "ke"));
438 if (keypad_string
!= NULL
)
439 SLtt_write_string (keypad_string
);
440 if (set
&& reset_hp_softkeys
)
441 slang_reset_softkeys ();
444 /* --------------------------------------------------------------------------------------------- */
447 tty_nodelay (gboolean set
)
449 no_slang_delay
= set
;
452 /* --------------------------------------------------------------------------------------------- */
457 return SLang_TT_Baud_Rate
;
460 /* --------------------------------------------------------------------------------------------- */
463 tty_lowlevel_getch (void)
467 if (no_slang_delay
&& (SLang_input_pending (0) == 0))
471 if (c
== SLANG_GETKEY_ERROR
)
474 "SLang_getkey returned SLANG_GETKEY_ERROR\n"
475 "Assuming EOF on stdin and exiting\n");
482 /* --------------------------------------------------------------------------------------------- */
485 tty_reset_screen (void)
491 /* --------------------------------------------------------------------------------------------- */
494 tty_touch_screen (void)
496 SLsmg_touch_lines (0, LINES
);
499 /* --------------------------------------------------------------------------------------------- */
502 tty_gotoyx (int y
, int x
)
507 /* --------------------------------------------------------------------------------------------- */
510 tty_getyx (int *py
, int *px
)
512 *py
= SLsmg_get_row ();
513 *px
= SLsmg_get_column ();
516 /* --------------------------------------------------------------------------------------------- */
519 tty_draw_hline (int y
, int x
, int ch
, int len
)
523 if (y
< 0 || y
>= LINES
|| x
>= COLS
)
537 ch
= mc_tty_frm
[MC_TTY_FRM_HORIZ
];
544 SLsmg_draw_hline (len
);
549 SLsmg_gotorc (y
, x1
);
552 /* --------------------------------------------------------------------------------------------- */
555 tty_draw_vline (int y
, int x
, int ch
, int len
)
559 if (x
< 0 || x
>= COLS
|| y
>= LINES
)
573 ch
= mc_tty_frm
[MC_TTY_FRM_VERT
];
580 SLsmg_draw_vline (len
);
587 SLsmg_gotorc (y
+ pos
, x
);
593 SLsmg_gotorc (y1
, x
);
596 /* --------------------------------------------------------------------------------------------- */
599 tty_fill_region (int y
, int x
, int rows
, int cols
, unsigned char ch
)
601 SLsmg_fill_region (y
, x
, rows
, cols
, ch
);
604 /* --------------------------------------------------------------------------------------------- */
607 tty_set_alt_charset (gboolean alt_charset
)
609 SLsmg_set_char_set ((int) alt_charset
);
612 /* --------------------------------------------------------------------------------------------- */
615 tty_display_8bit (gboolean what
)
617 SLsmg_Display_Eight_Bit
= what
? 128 : 160;
620 /* --------------------------------------------------------------------------------------------- */
623 tty_print_char (int c
)
625 SLsmg_write_char ((SLwchar_Type
) ((unsigned int) c
));
628 /* --------------------------------------------------------------------------------------------- */
631 tty_print_alt_char (int c
, gboolean single
)
633 #define DRAW(x, y) (x == y) \
634 ? SLsmg_draw_object (SLsmg_get_row(), SLsmg_get_column(), x) \
635 : SLsmg_write_char ((unsigned int) y)
639 DRAW (c
, mc_tty_frm
[single
? MC_TTY_FRM_VERT
: MC_TTY_FRM_DVERT
]);
642 DRAW (c
, mc_tty_frm
[single
? MC_TTY_FRM_HORIZ
: MC_TTY_FRM_DHORIZ
]);
645 DRAW (c
, mc_tty_frm
[single
? MC_TTY_FRM_LEFTMIDDLE
: MC_TTY_FRM_DLEFTMIDDLE
]);
648 DRAW (c
, mc_tty_frm
[single
? MC_TTY_FRM_RIGHTMIDDLE
: MC_TTY_FRM_DRIGHTMIDDLE
]);
651 DRAW (c
, mc_tty_frm
[single
? MC_TTY_FRM_LEFTTOP
: MC_TTY_FRM_DLEFTTOP
]);
654 DRAW (c
, mc_tty_frm
[single
? MC_TTY_FRM_LEFTBOTTOM
: MC_TTY_FRM_DLEFTBOTTOM
]);
657 DRAW (c
, mc_tty_frm
[single
? MC_TTY_FRM_RIGHTTOP
: MC_TTY_FRM_DRIGHTTOP
]);
660 DRAW (c
, mc_tty_frm
[single
? MC_TTY_FRM_RIGHTBOTTOM
: MC_TTY_FRM_DRIGHTBOTTOM
]);
663 DRAW (c
, mc_tty_frm
[MC_TTY_FRM_CROSS
]);
666 SLsmg_write_char ((unsigned int) c
);
671 /* --------------------------------------------------------------------------------------------- */
674 tty_print_anychar (int c
)
678 char str
[UTF8_CHAR_LEN
+ 1];
681 res
= g_unichar_to_utf8 (c
, str
);
691 SLsmg_write_string ((char *) str_term_form (str
));
695 if (!is_printable (c
))
697 SLsmg_write_char ((SLwchar_Type
) ((unsigned int) c
));
701 /* --------------------------------------------------------------------------------------------- */
704 tty_print_string (const char *s
)
706 SLsmg_write_string ((char *) str_term_form (s
));
709 /* --------------------------------------------------------------------------------------------- */
712 tty_printf (const char *fmt
, ...)
716 va_start (args
, fmt
);
717 SLsmg_vprintf ((char *) fmt
, args
);
721 /* --------------------------------------------------------------------------------------------- */
724 tty_tgetstr (const char *cap
)
726 return SLtt_tgetstr ((char *) cap
);
729 /* --------------------------------------------------------------------------------------------- */
737 /* --------------------------------------------------------------------------------------------- */
745 /* --------------------------------------------------------------------------------------------- */