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