lib/tty/tty-ncurses.c

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