lib/tty/tty-ncurses.c

   1 /*
   2    Interface to the terminal controlling library.
   3    Ncurses wrapper.
   4
   5    Copyright (C) 2005-2019
   6    Free Software Foundation, Inc.
   7
   8    Written by:
   9    Andrew Borodin <aborodin@vmail.ru>, 2009.
  10    Ilia Maslakov <il.smind@gmail.com>, 2009.
  11
  12    This file is part of the Midnight Commander.
  13
  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.
  18
  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.
  23
  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/>.
  26  */
  27
  28 /** \file
  29  *  \brief Source: NCurses-based tty layer of Midnight-commander
  30  */
  31
  32 #include <config.h>
  33
  34 #include <stdlib.h>
  35 #include <stdarg.h>
  36 #include <signal.h>
  37 #ifdef HAVE_SYS_IOCTL_H
  38 #include <sys/ioctl.h>
  39 #endif
  40 #include <termios.h>
  41
  42 #include "lib/global.h"
  43 #include "lib/strutil.h"        /* str_term_form */
  44
  45 #ifndef WANT_TERM_H
  46 #define WANT_TERM_H
  47 #endif
  48
  49 #include "tty-internal.h"       /* mc_tty_normalize_from_utf8() */
  50 #include "tty.h"
  51 #include "color-internal.h"
  52 #include "key.h"
  53 #include "mouse.h"
  54 #include "win.h"
  55
  56 /* include at last !!! */
  57 #ifdef WANT_TERM_H
  58 #ifdef HAVE_NCURSES_TERM_H
  59 #include <ncurses/term.h>
  60 #else
  61 #include <term.h>
  62 #endif /* HAVE_NCURSES_TERM_H */
  63 #endif /* WANT_TERM_H */
  64
  65 /*** global variables ****************************************************************************/
  66
  67 /*** file scope macro definitions ****************************************************************/
  68
  69 #if !defined(CTRL)
  70 #define CTRL(x) ((x) & 0x1f)
  71 #endif
  72
  73 #define yx_in_screen(y, x) \
  74     (y >= 0 && y < LINES && x >= 0 && x < COLS)
  75
  76 /*** global variables ****************************************************************************/
  77
  78 /*** file scope type declarations ****************************************************************/
  79
  80 /*** file scope variables ************************************************************************/
  81
  82 /* ncurses supports cursor positions only within window */
  83 /* We use our own cursor coordinates to support partially visible widgets */
  84 static int mc_curs_row, mc_curs_col;
  85
  86 /*** file scope functions ************************************************************************/
  87 /* --------------------------------------------------------------------------------------------- */
  88
  89 /* --------------------------------------------------------------------------------------------- */
  90
  91 static void
  92 tty_setup_sigwinch (void (*handler) (int))
  93 {
  94 #if (NCURSES_VERSION_MAJOR >= 4) && defined (SIGWINCH)
  95     struct sigaction act, oact;
  96
  97     memset (&act, 0, sizeof (act));
  98     act.sa_handler = handler;
  99     sigemptyset (&act.sa_mask);
 100 #ifdef SA_RESTART
 101     act.sa_flags = SA_RESTART;
 102 #endif /* SA_RESTART */
 103     sigaction (SIGWINCH, &act, &oact);
 104 #endif /* SIGWINCH */
 105 }
 106
 107 /* --------------------------------------------------------------------------------------------- */
 108
 109 static void
 110 sigwinch_handler (int dummy)
 111 {
 112     (void) dummy;
 113
 114     mc_global.tty.winch_flag = 1;
 115 }
 116
 117 /* --------------------------------------------------------------------------------------------- */
 118 /*** public functions ****************************************************************************/
 119 /* --------------------------------------------------------------------------------------------- */
 120
 121 int
 122 mc_tty_normalize_lines_char (const char *ch)
 123 {
 124     char *str2;
 125     int res;
 126
 127     struct mc_tty_lines_struct
 128     {
 129         const char *line;
 130         int line_code;
 131     } const lines_codes[] = {
 132         {"\342\224\230", ACS_LRCORNER}, /* ┌ */
 133         {"\342\224\224", ACS_LLCORNER}, /* └ */
 134         {"\342\224\220", ACS_URCORNER}, /* ┐ */
 135         {"\342\224\214", ACS_ULCORNER}, /* ┘ */
 136         {"\342\224\234", ACS_LTEE},     /* ├ */
 137         {"\342\224\244", ACS_RTEE},     /* ┤ */
 138         {"\342\224\254", ACS_TTEE},     /* ┬ */
 139         {"\342\224\264", ACS_BTEE},     /* ┴ */
 140         {"\342\224\200", ACS_HLINE},    /* ─ */
 141         {"\342\224\202", ACS_VLINE},    /* │ */
 142         {"\342\224\274", ACS_PLUS},     /* ┼ */
 143
 144         {"\342\225\235", ACS_LRCORNER | A_BOLD},        /* ╔ */
 145         {"\342\225\232", ACS_LLCORNER | A_BOLD},        /* ╚ */
 146         {"\342\225\227", ACS_URCORNER | A_BOLD},        /* ╗ */
 147         {"\342\225\224", ACS_ULCORNER | A_BOLD},        /* ╝ */
 148         {"\342\225\237", ACS_LTEE | A_BOLD},    /* ╟ */
 149         {"\342\225\242", ACS_RTEE | A_BOLD},    /* ╢ */
 150         {"\342\225\244", ACS_TTEE | A_BOLD},    /* ╤ */
 151         {"\342\225\247", ACS_BTEE | A_BOLD},    /* ╧ */
 152         {"\342\225\220", ACS_HLINE | A_BOLD},   /* ═ */
 153         {"\342\225\221", ACS_VLINE | A_BOLD},   /* ║ */
 154
 155         {NULL, 0}
 156     };
 157
 158     if (ch == NULL)
 159         return (int) ' ';
 160
 161     for (res = 0; lines_codes[res].line; res++)
 162     {
 163         if (strcmp (ch, lines_codes[res].line) == 0)
 164             return lines_codes[res].line_code;
 165     }
 166
 167     str2 = mc_tty_normalize_from_utf8 (ch);
 168     res = g_utf8_get_char_validated (str2, -1);
 169
 170     if (res < 0)
 171         res = (unsigned char) str2[0];
 172     g_free (str2);
 173
 174     return res;
 175 }
 176
 177 /* --------------------------------------------------------------------------------------------- */
 178
 179 void
 180 tty_init (gboolean mouse_enable, gboolean is_xterm)
 181 {
 182     struct termios mode;
 183
 184     initscr ();
 185
 186 #ifdef HAVE_ESCDELAY
 187     /*
 188      * If ncurses exports the ESCDELAY variable, it should be set to
 189      * a low value, or you'll experience a delay in processing escape
 190      * sequences that are recognized by mc (e.g. Esc-Esc).  On the other
 191      * hand, making ESCDELAY too small can result in some sequences
 192      * (e.g. cursor arrows) being reported as separate keys under heavy
 193      * processor load, and this can be a problem if mc hasn't learned
 194      * them in the "Learn Keys" dialog.  The value is in milliseconds.
 195      */
 196     ESCDELAY = 200;
 197 #endif /* HAVE_ESCDELAY */
 198
 199     tcgetattr (STDIN_FILENO, &mode);
 200     /* use Ctrl-g to generate SIGINT */
 201     mode.c_cc[VINTR] = CTRL ('g');      /* ^g */
 202     /* disable SIGQUIT to allow use Ctrl-\ key */
 203     mode.c_cc[VQUIT] = NULL_VALUE;
 204     tcsetattr (STDIN_FILENO, TCSANOW, &mode);
 205
 206     /* curses remembers the "in-program" modes after this call */
 207     def_prog_mode ();
 208
 209     tty_start_interrupt_key ();
 210
 211     if (!mouse_enable)
 212         use_mouse_p = MOUSE_DISABLED;
 213     tty_init_xterm_support (is_xterm);  /* do it before tty_enter_ca_mode() call */
 214     tty_enter_ca_mode ();
 215     tty_raw_mode ();
 216     noecho ();
 217     keypad (stdscr, TRUE);
 218     nodelay (stdscr, FALSE);
 219
 220     tty_setup_sigwinch (sigwinch_handler);
 221 }
 222
 223 /* --------------------------------------------------------------------------------------------- */
 224
 225 void
 226 tty_shutdown (void)
 227 {
 228     tty_reset_shell_mode ();
 229     tty_noraw_mode ();
 230     tty_keypad (FALSE);
 231     tty_reset_screen ();
 232     tty_exit_ca_mode ();
 233 }
 234
 235 /* --------------------------------------------------------------------------------------------- */
 236
 237 void
 238 tty_enter_ca_mode (void)
 239 {
 240     if (mc_global.tty.xterm_flag && smcup != NULL)
 241     {
 242         fprintf (stdout, /* ESC_STR ")0" */ ESC_STR "7" ESC_STR "[?47h");
 243         fflush (stdout);
 244     }
 245 }
 246
 247 /* --------------------------------------------------------------------------------------------- */
 248
 249 void
 250 tty_exit_ca_mode (void)
 251 {
 252     if (mc_global.tty.xterm_flag && rmcup != NULL)
 253     {
 254         fprintf (stdout, ESC_STR "[?47l" ESC_STR "8" ESC_STR "[m");
 255         fflush (stdout);
 256     }
 257 }
 258
 259 /* --------------------------------------------------------------------------------------------- */
 260
 261 void
 262 tty_change_screen_size (void)
 263 {
 264 #if defined(TIOCGWINSZ) && NCURSES_VERSION_MAJOR >= 4
 265     struct winsize winsz;
 266
 267     winsz.ws_col = winsz.ws_row = 0;
 268
 269 #ifndef NCURSES_VERSION
 270     tty_noraw_mode ();
 271     tty_reset_screen ();
 272 #endif
 273
 274     /* Ioctl on the STDIN_FILENO */
 275     ioctl (fileno (stdout), TIOCGWINSZ, &winsz);
 276     if (winsz.ws_col != 0 && winsz.ws_row != 0)
 277     {
 278 #if defined(NCURSES_VERSION) && defined(HAVE_RESIZETERM)
 279         resizeterm (winsz.ws_row, winsz.ws_col);
 280         clearok (stdscr, TRUE); /* sigwinch's should use a semaphore! */
 281 #else
 282         COLS = winsz.ws_col;
 283         LINES = winsz.ws_row;
 284 #endif
 285     }
 286 #endif /* defined(TIOCGWINSZ) || NCURSES_VERSION_MAJOR >= 4 */
 287
 288 #ifdef ENABLE_SUBSHELL
 289     if (mc_global.tty.use_subshell)
 290         tty_resize (mc_global.tty.subshell_pty);
 291 #endif
 292 }
 293
 294 /* --------------------------------------------------------------------------------------------- */
 295
 296 void
 297 tty_reset_prog_mode (void)
 298 {
 299     reset_prog_mode ();
 300 }
 301
 302 /* --------------------------------------------------------------------------------------------- */
 303
 304 void
 305 tty_reset_shell_mode (void)
 306 {
 307     reset_shell_mode ();
 308 }
 309
 310 /* --------------------------------------------------------------------------------------------- */
 311
 312 void
 313 tty_raw_mode (void)
 314 {
 315     raw ();                     /* FIXME: uneeded? */
 316     cbreak ();
 317 }
 318
 319 /* --------------------------------------------------------------------------------------------- */
 320
 321 void
 322 tty_noraw_mode (void)
 323 {
 324     nocbreak ();                /* FIXME: unneeded? */
 325     noraw ();
 326 }
 327
 328 /* --------------------------------------------------------------------------------------------- */
 329
 330 void
 331 tty_noecho (void)
 332 {
 333     noecho ();
 334 }
 335
 336 /* --------------------------------------------------------------------------------------------- */
 337
 338 int
 339 tty_flush_input (void)
 340 {
 341     return flushinp ();
 342 }
 343
 344 /* --------------------------------------------------------------------------------------------- */
 345
 346 void
 347 tty_keypad (gboolean set)
 348 {
 349     keypad (stdscr, (bool) set);
 350 }
 351
 352 /* --------------------------------------------------------------------------------------------- */
 353
 354 void
 355 tty_nodelay (gboolean set)
 356 {
 357     nodelay (stdscr, (bool) set);
 358 }
 359
 360 /* --------------------------------------------------------------------------------------------- */
 361
 362 int
 363 tty_baudrate (void)
 364 {
 365     return baudrate ();
 366 }
 367
 368 /* --------------------------------------------------------------------------------------------- */
 369
 370 int
 371 tty_lowlevel_getch (void)
 372 {
 373     return getch ();
 374 }
 375
 376 /* --------------------------------------------------------------------------------------------- */
 377
 378 int
 379 tty_reset_screen (void)
 380 {
 381     return endwin ();
 382 }
 383
 384 /* --------------------------------------------------------------------------------------------- */
 385
 386 void
 387 tty_touch_screen (void)
 388 {
 389     touchwin (stdscr);
 390 }
 391
 392 /* --------------------------------------------------------------------------------------------- */
 393
 394 void
 395 tty_gotoyx (int y, int x)
 396 {
 397     mc_curs_row = y;
 398     mc_curs_col = x;
 399
 400     if (y < 0)
 401         y = 0;
 402     if (y >= LINES)
 403         y = LINES - 1;
 404
 405     if (x < 0)
 406         x = 0;
 407     if (x >= COLS)
 408         x = COLS - 1;
 409
 410     move (y, x);
 411 }
 412
 413 /* --------------------------------------------------------------------------------------------- */
 414
 415 void
 416 tty_getyx (int *py, int *px)
 417 {
 418     *py = mc_curs_row;
 419     *px = mc_curs_col;
 420 }
 421
 422 /* --------------------------------------------------------------------------------------------- */
 423
 424 void
 425 tty_draw_hline (int y, int x, int ch, int len)
 426 {
 427     int x1;
 428
 429     if (y < 0 || y >= LINES || x >= COLS)
 430         return;
 431
 432     x1 = x;
 433
 434     if (x < 0)
 435     {
 436         len += x;
 437         if (len <= 0)
 438             return;
 439         x = 0;
 440     }
 441
 442     if ((chtype) ch == ACS_HLINE)
 443         ch = mc_tty_frm[MC_TTY_FRM_HORIZ];
 444
 445     move (y, x);
 446     hline (ch, len);
 447     move (y, x1);
 448
 449     mc_curs_row = y;
 450     mc_curs_col = x1;
 451 }
 452
 453 /* --------------------------------------------------------------------------------------------- */
 454
 455 void
 456 tty_draw_vline (int y, int x, int ch, int len)
 457 {
 458     int y1;
 459
 460     if (x < 0 || x >= COLS || y >= LINES)
 461         return;
 462
 463     y1 = y;
 464
 465     if (y < 0)
 466     {
 467         len += y;
 468         if (len <= 0)
 469             return;
 470         y = 0;
 471     }
 472
 473     if ((chtype) ch == ACS_VLINE)
 474         ch = mc_tty_frm[MC_TTY_FRM_VERT];
 475
 476     move (y, x);
 477     vline (ch, len);
 478     move (y1, x);
 479
 480     mc_curs_row = y1;
 481     mc_curs_col = x;
 482 }
 483
 484 /* --------------------------------------------------------------------------------------------- */
 485
 486 void
 487 tty_fill_region (int y, int x, int rows, int cols, unsigned char ch)
 488 {
 489     int i;
 490
 491     if (y < 0)
 492     {
 493         rows += y;
 494
 495         if (rows <= 0)
 496             return;
 497
 498         y = 0;
 499     }
 500
 501     if (x < 0)
 502     {
 503         cols += x;
 504
 505         if (cols <= 0)
 506             return;
 507
 508         x = 0;
 509     }
 510
 511     if (y + rows > LINES)
 512         rows = LINES - y;
 513     if (x + cols > COLS)
 514         cols = COLS - x;
 515
 516     for (i = 0; i < rows; i++)
 517     {
 518         move (y + i, x);
 519         hline (ch, cols);
 520     }
 521
 522     move (y, x);
 523
 524     mc_curs_row = y;
 525     mc_curs_col = x;
 526 }
 527
 528 /* --------------------------------------------------------------------------------------------- */
 529
 530 void
 531 tty_set_alt_charset (gboolean alt_charset)
 532 {
 533     (void) alt_charset;
 534 }
 535
 536 /* --------------------------------------------------------------------------------------------- */
 537
 538 void
 539 tty_display_8bit (gboolean what)
 540 {
 541     meta (stdscr, (int) what);
 542 }
 543
 544 /* --------------------------------------------------------------------------------------------- */
 545
 546 void
 547 tty_print_char (int c)
 548 {
 549     if (yx_in_screen (mc_curs_row, mc_curs_col))
 550         addch (c);
 551     mc_curs_col++;
 552 }
 553
 554 /* --------------------------------------------------------------------------------------------- */
 555
 556 void
 557 tty_print_anychar (int c)
 558 {
 559     if (mc_global.utf8_display || c > 255)
 560     {
 561         int res;
 562         unsigned char str[UTF8_CHAR_LEN + 1];
 563
 564         res = g_unichar_to_utf8 (c, (char *) str);
 565         if (res == 0)
 566         {
 567             if (yx_in_screen (mc_curs_row, mc_curs_col))
 568                 addch ('.');
 569             mc_curs_col++;
 570         }
 571         else
 572         {
 573             const char *s;
 574
 575             str[res] = '\0';
 576             s = str_term_form ((char *) str);
 577
 578             if (yx_in_screen (mc_curs_row, mc_curs_col))
 579                 addstr (s);
 580
 581             if (g_unichar_iswide (c))
 582                 mc_curs_col += 2;
 583             else if (!g_unichar_iszerowidth (c))
 584                 mc_curs_col++;
 585         }
 586     }
 587     else
 588     {
 589         if (yx_in_screen (mc_curs_row, mc_curs_col))
 590             addch (c);
 591         mc_curs_col++;
 592     }
 593 }
 594
 595 /* --------------------------------------------------------------------------------------------- */
 596
 597 void
 598 tty_print_alt_char (int c, gboolean single)
 599 {
 600     if (yx_in_screen (mc_curs_row, mc_curs_col))
 601     {
 602         if ((chtype) c == ACS_VLINE)
 603             c = mc_tty_frm[single ? MC_TTY_FRM_VERT : MC_TTY_FRM_DVERT];
 604         else if ((chtype) c == ACS_HLINE)
 605             c = mc_tty_frm[single ? MC_TTY_FRM_HORIZ : MC_TTY_FRM_DHORIZ];
 606         else if ((chtype) c == ACS_LTEE)
 607             c = mc_tty_frm[single ? MC_TTY_FRM_LEFTMIDDLE : MC_TTY_FRM_DLEFTMIDDLE];
 608         else if ((chtype) c == ACS_RTEE)
 609             c = mc_tty_frm[single ? MC_TTY_FRM_RIGHTMIDDLE : MC_TTY_FRM_DRIGHTMIDDLE];
 610         else if ((chtype) c == ACS_ULCORNER)
 611             c = mc_tty_frm[single ? MC_TTY_FRM_LEFTTOP : MC_TTY_FRM_DLEFTTOP];
 612         else if ((chtype) c == ACS_LLCORNER)
 613             c = mc_tty_frm[single ? MC_TTY_FRM_LEFTBOTTOM : MC_TTY_FRM_DLEFTBOTTOM];
 614         else if ((chtype) c == ACS_URCORNER)
 615             c = mc_tty_frm[single ? MC_TTY_FRM_RIGHTTOP : MC_TTY_FRM_DRIGHTTOP];
 616         else if ((chtype) c == ACS_LRCORNER)
 617             c = mc_tty_frm[single ? MC_TTY_FRM_RIGHTBOTTOM : MC_TTY_FRM_DRIGHTBOTTOM];
 618         else if ((chtype) c == ACS_PLUS)
 619             c = mc_tty_frm[MC_TTY_FRM_CROSS];
 620
 621         addch (c);
 622     }
 623
 624     mc_curs_col++;
 625 }
 626
 627 /* --------------------------------------------------------------------------------------------- */
 628
 629 void
 630 tty_print_string (const char *s)
 631 {
 632     int len;
 633     int start = 0;
 634
 635     s = str_term_form (s);
 636     len = str_term_width1 (s);
 637
 638     /* line is upper or below the screen or entire line is before or after screen */
 639     if (mc_curs_row < 0 || mc_curs_row >= LINES || mc_curs_col + len <= 0 || mc_curs_col >= COLS)
 640     {
 641         mc_curs_col += len;
 642         return;
 643     }
 644
 645     /* skip invisible left part */
 646     if (mc_curs_col < 0)
 647     {
 648         start = -mc_curs_col;
 649         len += mc_curs_col;
 650         mc_curs_col = 0;
 651     }
 652
 653     mc_curs_col += len;
 654     if (mc_curs_col >= COLS)
 655         len = COLS - (mc_curs_col - len);
 656
 657     addstr (str_term_substring (s, start, len));
 658 }
 659
 660 /* --------------------------------------------------------------------------------------------- */
 661
 662 void
 663 tty_printf (const char *fmt, ...)
 664 {
 665     va_list args;
 666     char buf[BUF_1K];           /* FIXME: is it enough? */
 667
 668     va_start (args, fmt);
 669     g_vsnprintf (buf, sizeof (buf), fmt, args);
 670     va_end (args);
 671     tty_print_string (buf);
 672 }
 673
 674 /* --------------------------------------------------------------------------------------------- */
 675
 676 char *
 677 tty_tgetstr (const char *cap)
 678 {
 679     char *unused = NULL;
 680
 681     return tgetstr ((NCURSES_CONST char *) cap, &unused);
 682 }
 683
 684 /* --------------------------------------------------------------------------------------------- */
 685
 686 void
 687 tty_refresh (void)
 688 {
 689     refresh ();
 690     doupdate ();
 691 }
 692
 693 /* --------------------------------------------------------------------------------------------- */
 694
 695 void
 696 tty_beep (void)
 697 {
 698     beep ();
 699 }
 700
 701 /* --------------------------------------------------------------------------------------------- */