lib/tty/tty-ncurses.c

   1 /*
   2    Interface to the terminal controlling library.
   3    Ncurses wrapper.
   4
   5    Copyright (C) 2005-2016
   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 coordibates 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     initscr ();
 184
 185 #ifdef HAVE_ESCDELAY
 186     /*
 187      * If ncurses exports the ESCDELAY variable, it should be set to
 188      * a low value, or you'll experience a delay in processing escape
 189      * sequences that are recognized by mc (e.g. Esc-Esc).  On the other
 190      * hand, making ESCDELAY too small can result in some sequences
 191      * (e.g. cursor arrows) being reported as separate keys under heavy
 192      * processor load, and this can be a problem if mc hasn't learned
 193      * them in the "Learn Keys" dialog.  The value is in milliseconds.
 194      */
 195     ESCDELAY = 200;
 196 #endif /* HAVE_ESCDELAY */
 197
 198     tcgetattr (STDIN_FILENO, &mode);
 199     /* use Ctrl-g to generate SIGINT */
 200     mode.c_cc[VINTR] = CTRL ('g');      /* ^g */
 201     /* disable SIGQUIT to allow use Ctrl-\ key */
 202     mode.c_cc[VQUIT] = NULL_VALUE;
 203     tcsetattr (STDIN_FILENO, TCSANOW, &mode);
 204
 205     tty_start_interrupt_key ();
 206
 207     if (!mouse_enable)
 208         use_mouse_p = MOUSE_DISABLED;
 209     tty_init_xterm_support (is_xterm);  /* do it before tty_enter_ca_mode() call */
 210     tty_enter_ca_mode ();
 211     tty_raw_mode ();
 212     noecho ();
 213     keypad (stdscr, TRUE);
 214     nodelay (stdscr, FALSE);
 215
 216     tty_setup_sigwinch (sigwinch_handler);
 217 }
 218
 219 /* --------------------------------------------------------------------------------------------- */
 220
 221 void
 222 tty_shutdown (void)
 223 {
 224     tty_reset_shell_mode ();
 225     tty_noraw_mode ();
 226     tty_keypad (FALSE);
 227     tty_reset_screen ();
 228     tty_exit_ca_mode ();
 229 }
 230
 231 /* --------------------------------------------------------------------------------------------- */
 232
 233 void
 234 tty_enter_ca_mode (void)
 235 {
 236     if (mc_global.tty.xterm_flag && smcup != NULL)
 237     {
 238         fprintf (stdout, /* ESC_STR ")0" */ ESC_STR "7" ESC_STR "[?47h");
 239         fflush (stdout);
 240     }
 241 }
 242
 243 /* --------------------------------------------------------------------------------------------- */
 244
 245 void
 246 tty_exit_ca_mode (void)
 247 {
 248     if (mc_global.tty.xterm_flag && rmcup != NULL)
 249     {
 250         fprintf (stdout, ESC_STR "[?47l" ESC_STR "8" ESC_STR "[m");
 251         fflush (stdout);
 252     }
 253 }
 254
 255 /* --------------------------------------------------------------------------------------------- */
 256
 257 void
 258 tty_change_screen_size (void)
 259 {
 260 #if defined(TIOCGWINSZ) && NCURSES_VERSION_MAJOR >= 4
 261     struct winsize winsz;
 262
 263     winsz.ws_col = winsz.ws_row = 0;
 264
 265 #ifndef NCURSES_VERSION
 266     tty_noraw_mode ();
 267     tty_reset_screen ();
 268 #endif
 269
 270     /* Ioctl on the STDIN_FILENO */
 271     ioctl (fileno (stdout), TIOCGWINSZ, &winsz);
 272     if (winsz.ws_col != 0 && winsz.ws_row != 0)
 273     {
 274 #if defined(NCURSES_VERSION) && defined(HAVE_RESIZETERM)
 275         resizeterm (winsz.ws_row, winsz.ws_col);
 276         clearok (stdscr, TRUE); /* sigwinch's should use a semaphore! */
 277 #else
 278         COLS = winsz.ws_col;
 279         LINES = winsz.ws_row;
 280 #endif
 281     }
 282 #endif /* defined(TIOCGWINSZ) || NCURSES_VERSION_MAJOR >= 4 */
 283
 284 #ifdef ENABLE_SUBSHELL
 285     if (mc_global.tty.use_subshell)
 286         tty_resize (mc_global.tty.subshell_pty);
 287 #endif
 288 }
 289
 290 /* --------------------------------------------------------------------------------------------- */
 291
 292 void
 293 tty_reset_prog_mode (void)
 294 {
 295     reset_prog_mode ();
 296 }
 297
 298 /* --------------------------------------------------------------------------------------------- */
 299
 300 void
 301 tty_reset_shell_mode (void)
 302 {
 303     reset_shell_mode ();
 304 }
 305
 306 /* --------------------------------------------------------------------------------------------- */
 307
 308 void
 309 tty_raw_mode (void)
 310 {
 311     raw ();                     /* FIXME: uneeded? */
 312     cbreak ();
 313 }
 314
 315 /* --------------------------------------------------------------------------------------------- */
 316
 317 void
 318 tty_noraw_mode (void)
 319 {
 320     nocbreak ();                /* FIXME: unneeded? */
 321     noraw ();
 322 }
 323
 324 /* --------------------------------------------------------------------------------------------- */
 325
 326 void
 327 tty_noecho (void)
 328 {
 329     noecho ();
 330 }
 331
 332 /* --------------------------------------------------------------------------------------------- */
 333
 334 int
 335 tty_flush_input (void)
 336 {
 337     return flushinp ();
 338 }
 339
 340 /* --------------------------------------------------------------------------------------------- */
 341
 342 void
 343 tty_keypad (gboolean set)
 344 {
 345     keypad (stdscr, (bool) set);
 346 }
 347
 348 /* --------------------------------------------------------------------------------------------- */
 349
 350 void
 351 tty_nodelay (gboolean set)
 352 {
 353     nodelay (stdscr, (bool) set);
 354 }
 355
 356 /* --------------------------------------------------------------------------------------------- */
 357
 358 int
 359 tty_baudrate (void)
 360 {
 361     return baudrate ();
 362 }
 363
 364 /* --------------------------------------------------------------------------------------------- */
 365
 366 int
 367 tty_lowlevel_getch (void)
 368 {
 369     return getch ();
 370 }
 371
 372 /* --------------------------------------------------------------------------------------------- */
 373
 374 int
 375 tty_reset_screen (void)
 376 {
 377     return endwin ();
 378 }
 379
 380 /* --------------------------------------------------------------------------------------------- */
 381
 382 void
 383 tty_touch_screen (void)
 384 {
 385     touchwin (stdscr);
 386 }
 387
 388 /* --------------------------------------------------------------------------------------------- */
 389
 390 void
 391 tty_gotoyx (int y, int x)
 392 {
 393     mc_curs_row = y;
 394     mc_curs_col = x;
 395
 396     if (y < 0)
 397         y = 0;
 398     if (y >= LINES)
 399         y = LINES - 1;
 400
 401     if (x < 0)
 402         x = 0;
 403     if (x >= COLS)
 404         x = COLS - 1;
 405
 406     move (y, x);
 407 }
 408
 409 /* --------------------------------------------------------------------------------------------- */
 410
 411 void
 412 tty_getyx (int *py, int *px)
 413 {
 414     *py = mc_curs_row;
 415     *px = mc_curs_col;
 416 }
 417
 418 /* --------------------------------------------------------------------------------------------- */
 419
 420 void
 421 tty_draw_hline (int y, int x, int ch, int len)
 422 {
 423     int x1;
 424
 425     if (y < 0 || y >= LINES || x >= COLS)
 426         return;
 427
 428     x1 = x;
 429
 430     if (x < 0)
 431     {
 432         len += x;
 433         if (len <= 0)
 434             return;
 435         x = 0;
 436     }
 437
 438     if ((chtype) ch == ACS_HLINE)
 439         ch = mc_tty_frm[MC_TTY_FRM_HORIZ];
 440
 441     move (y, x);
 442     hline (ch, len);
 443     move (y, x1);
 444
 445     mc_curs_row = y;
 446     mc_curs_col = x1;
 447 }
 448
 449 /* --------------------------------------------------------------------------------------------- */
 450
 451 void
 452 tty_draw_vline (int y, int x, int ch, int len)
 453 {
 454     int y1;
 455
 456     if (x < 0 || x >= COLS || y >= LINES)
 457         return;
 458
 459     y1 = y;
 460
 461     if (y < 0)
 462     {
 463         len += y;
 464         if (len <= 0)
 465             return;
 466         y = 0;
 467     }
 468
 469     if ((chtype) ch == ACS_VLINE)
 470         ch = mc_tty_frm[MC_TTY_FRM_VERT];
 471
 472     move (y, x);
 473     vline (ch, len);
 474     move (y1, x);
 475
 476     mc_curs_row = y1;
 477     mc_curs_col = x;
 478 }
 479
 480 /* --------------------------------------------------------------------------------------------- */
 481
 482 void
 483 tty_fill_region (int y, int x, int rows, int cols, unsigned char ch)
 484 {
 485     int i;
 486
 487     if (y < 0)
 488     {
 489         rows += y;
 490
 491         if (rows <= 0)
 492             return;
 493
 494         y = 0;
 495     }
 496
 497     if (x < 0)
 498     {
 499         cols += x;
 500
 501         if (cols <= 0)
 502             return;
 503
 504         x = 0;
 505     }
 506
 507     if (y + rows > LINES)
 508         rows = LINES - y;
 509     if (x + cols > COLS)
 510         cols = COLS - x;
 511
 512     for (i = 0; i < rows; i++)
 513     {
 514         move (y + i, x);
 515         hline (ch, cols);
 516     }
 517
 518     move (y, x);
 519
 520     mc_curs_row = y;
 521     mc_curs_col = x;
 522 }
 523
 524 /* --------------------------------------------------------------------------------------------- */
 525
 526 void
 527 tty_set_alt_charset (gboolean alt_charset)
 528 {
 529     (void) alt_charset;
 530 }
 531
 532 /* --------------------------------------------------------------------------------------------- */
 533
 534 void
 535 tty_display_8bit (gboolean what)
 536 {
 537     meta (stdscr, (int) what);
 538 }
 539
 540 /* --------------------------------------------------------------------------------------------- */
 541
 542 void
 543 tty_print_char (int c)
 544 {
 545     if (yx_in_screen (mc_curs_row, mc_curs_col))
 546         addch (c);
 547     mc_curs_col++;
 548 }
 549
 550 /* --------------------------------------------------------------------------------------------- */
 551
 552 void
 553 tty_print_anychar (int c)
 554 {
 555     if (mc_global.utf8_display || c > 255)
 556     {
 557         int res;
 558         unsigned char str[UTF8_CHAR_LEN + 1];
 559
 560         res = g_unichar_to_utf8 (c, (char *) str);
 561         if (res == 0)
 562         {
 563             if (yx_in_screen (mc_curs_row, mc_curs_col))
 564                 addch ('.');
 565             mc_curs_col++;
 566         }
 567         else
 568         {
 569             const char *s;
 570
 571             str[res] = '\0';
 572             s = str_term_form ((char *) str);
 573
 574             if (yx_in_screen (mc_curs_row, mc_curs_col))
 575                 addstr (s);
 576
 577             if (g_unichar_iswide (c))
 578                 mc_curs_col += 2;
 579             else if (!g_unichar_iszerowidth (c))
 580                 mc_curs_col++;
 581         }
 582     }
 583     else
 584     {
 585         if (yx_in_screen (mc_curs_row, mc_curs_col))
 586             addch (c);
 587         mc_curs_col++;
 588     }
 589 }
 590
 591 /* --------------------------------------------------------------------------------------------- */
 592
 593 void
 594 tty_print_alt_char (int c, gboolean single)
 595 {
 596     if (yx_in_screen (mc_curs_row, mc_curs_col))
 597     {
 598         if ((chtype) c == ACS_VLINE)
 599             c = mc_tty_frm[single ? MC_TTY_FRM_VERT : MC_TTY_FRM_DVERT];
 600         else if ((chtype) c == ACS_HLINE)
 601             c = mc_tty_frm[single ? MC_TTY_FRM_HORIZ : MC_TTY_FRM_DHORIZ];
 602         else if ((chtype) c == ACS_LTEE)
 603             c = mc_tty_frm[single ? MC_TTY_FRM_LEFTMIDDLE : MC_TTY_FRM_DLEFTMIDDLE];
 604         else if ((chtype) c == ACS_RTEE)
 605             c = mc_tty_frm[single ? MC_TTY_FRM_RIGHTMIDDLE : MC_TTY_FRM_DRIGHTMIDDLE];
 606         else if ((chtype) c == ACS_ULCORNER)
 607             c = mc_tty_frm[single ? MC_TTY_FRM_LEFTTOP : MC_TTY_FRM_DLEFTTOP];
 608         else if ((chtype) c == ACS_LLCORNER)
 609             c = mc_tty_frm[single ? MC_TTY_FRM_LEFTBOTTOM : MC_TTY_FRM_DLEFTBOTTOM];
 610         else if ((chtype) c == ACS_URCORNER)
 611             c = mc_tty_frm[single ? MC_TTY_FRM_RIGHTTOP : MC_TTY_FRM_DRIGHTTOP];
 612         else if ((chtype) c == ACS_LRCORNER)
 613             c = mc_tty_frm[single ? MC_TTY_FRM_RIGHTBOTTOM : MC_TTY_FRM_DRIGHTBOTTOM];
 614         else if ((chtype) c == ACS_PLUS)
 615             c = mc_tty_frm[MC_TTY_FRM_CROSS];
 616
 617         addch (c);
 618     }
 619
 620     mc_curs_col++;
 621 }
 622
 623 /* --------------------------------------------------------------------------------------------- */
 624
 625 void
 626 tty_print_string (const char *s)
 627 {
 628     int len;
 629     int start = 0;
 630
 631     s = str_term_form (s);
 632     len = str_term_width1 (s);
 633
 634     /* line is upper or below the screen or entire line is before or after screen */
 635     if (mc_curs_row < 0 || mc_curs_row >= LINES || mc_curs_col + len <= 0 || mc_curs_col >= COLS)
 636     {
 637         mc_curs_col += len;
 638         return;
 639     }
 640
 641     /* skip invisible left part */
 642     if (mc_curs_col < 0)
 643     {
 644         start = -mc_curs_col;
 645         len += mc_curs_col;
 646         mc_curs_col = 0;
 647     }
 648
 649     mc_curs_col += len;
 650     if (mc_curs_col >= COLS)
 651         len = COLS - (mc_curs_col - len);
 652
 653     addstr (str_term_substring (s, start, len));
 654 }
 655
 656 /* --------------------------------------------------------------------------------------------- */
 657
 658 void
 659 tty_printf (const char *fmt, ...)
 660 {
 661     va_list args;
 662     char buf[BUF_1K];           /* FIXME: is it enough? */
 663
 664     va_start (args, fmt);
 665     g_vsnprintf (buf, sizeof (buf), fmt, args);
 666     va_end (args);
 667     tty_print_string (buf);
 668 }
 669
 670 /* --------------------------------------------------------------------------------------------- */
 671
 672 char *
 673 tty_tgetstr (const char *cap)
 674 {
 675     char *unused = NULL;
 676
 677     return tgetstr ((NCURSES_CONST char *) cap, &unused);
 678 }
 679
 680 /* --------------------------------------------------------------------------------------------- */
 681
 682 void
 683 tty_refresh (void)
 684 {
 685     refresh ();
 686     doupdate ();
 687 }
 688
 689 /* --------------------------------------------------------------------------------------------- */
 690
 691 void
 692 tty_beep (void)
 693 {
 694     beep ();
 695 }
 696
 697 /* --------------------------------------------------------------------------------------------- */