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