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 = TRUE;
 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     init_mouse ();
 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     tty_reset_shell_mode ();
 223     tty_noraw_mode ();
 224     tty_keypad (FALSE);
 225     tty_reset_screen ();
 226     do_exit_ca_mode ();
 227 }
 228
 229 /* --------------------------------------------------------------------------------------------- */
 230
 231 void
 232 tty_change_screen_size (void)
 233 {
 234 #if defined(TIOCGWINSZ) && NCURSES_VERSION_MAJOR >= 4
 235     struct winsize winsz;
 236
 237     winsz.ws_col = winsz.ws_row = 0;
 238
 239 #ifndef NCURSES_VERSION
 240     tty_noraw_mode ();
 241     tty_reset_screen ();
 242 #endif
 243
 244     /* Ioctl on the STDIN_FILENO */
 245     ioctl (fileno (stdout), TIOCGWINSZ, &winsz);
 246     if (winsz.ws_col != 0 && winsz.ws_row != 0)
 247     {
 248 #if defined(NCURSES_VERSION) && defined(HAVE_RESIZETERM)
 249         resizeterm (winsz.ws_row, winsz.ws_col);
 250         clearok (stdscr, TRUE); /* sigwinch's should use a semaphore! */
 251 #else
 252         COLS = winsz.ws_col;
 253         LINES = winsz.ws_row;
 254 #endif
 255     }
 256 #endif /* defined(TIOCGWINSZ) || NCURSES_VERSION_MAJOR >= 4 */
 257 }
 258
 259 /* --------------------------------------------------------------------------------------------- */
 260
 261 void
 262 tty_reset_prog_mode (void)
 263 {
 264     reset_prog_mode ();
 265 }
 266
 267 /* --------------------------------------------------------------------------------------------- */
 268
 269 void
 270 tty_reset_shell_mode (void)
 271 {
 272     reset_shell_mode ();
 273 }
 274
 275 /* --------------------------------------------------------------------------------------------- */
 276
 277 void
 278 tty_raw_mode (void)
 279 {
 280     raw ();                     /* FIXME: uneeded? */
 281     cbreak ();
 282 }
 283
 284 /* --------------------------------------------------------------------------------------------- */
 285
 286 void
 287 tty_noraw_mode (void)
 288 {
 289     nocbreak ();                /* FIXME: unneeded? */
 290     noraw ();
 291 }
 292
 293 /* --------------------------------------------------------------------------------------------- */
 294
 295 void
 296 tty_noecho (void)
 297 {
 298     noecho ();
 299 }
 300
 301 /* --------------------------------------------------------------------------------------------- */
 302
 303 int
 304 tty_flush_input (void)
 305 {
 306     return flushinp ();
 307 }
 308
 309 /* --------------------------------------------------------------------------------------------- */
 310
 311 void
 312 tty_keypad (gboolean set)
 313 {
 314     keypad (stdscr, (bool) set);
 315 }
 316
 317 /* --------------------------------------------------------------------------------------------- */
 318
 319 void
 320 tty_nodelay (gboolean set)
 321 {
 322     nodelay (stdscr, (bool) set);
 323 }
 324
 325 /* --------------------------------------------------------------------------------------------- */
 326
 327 int
 328 tty_baudrate (void)
 329 {
 330     return baudrate ();
 331 }
 332
 333 /* --------------------------------------------------------------------------------------------- */
 334
 335 int
 336 tty_lowlevel_getch (void)
 337 {
 338     return getch ();
 339 }
 340
 341 /* --------------------------------------------------------------------------------------------- */
 342
 343 int
 344 tty_reset_screen (void)
 345 {
 346     return endwin ();
 347 }
 348
 349 /* --------------------------------------------------------------------------------------------- */
 350
 351 void
 352 tty_touch_screen (void)
 353 {
 354     touchwin (stdscr);
 355 }
 356
 357 /* --------------------------------------------------------------------------------------------- */
 358
 359 void
 360 tty_gotoyx (int y, int x)
 361 {
 362     mc_curs_row = y;
 363     mc_curs_col = x;
 364
 365     if (y < 0)
 366         y = 0;
 367     if (y >= LINES)
 368         y = LINES - 1;
 369
 370     if (x < 0)
 371         x = 0;
 372     if (x >= COLS)
 373         x = COLS - 1;
 374
 375     move (y, x);
 376 }
 377
 378 /* --------------------------------------------------------------------------------------------- */
 379
 380 void
 381 tty_getyx (int *py, int *px)
 382 {
 383     *py = mc_curs_row;
 384     *px = mc_curs_col;
 385 }
 386
 387 /* --------------------------------------------------------------------------------------------- */
 388
 389 void
 390 tty_draw_hline (int y, int x, int ch, int len)
 391 {
 392     int x1;
 393
 394     if (y < 0 || y >= LINES || x >= COLS)
 395         return;
 396
 397     x1 = x;
 398
 399     if (x < 0)
 400     {
 401         len += x;
 402         if (len <= 0)
 403             return;
 404         x = 0;
 405     }
 406
 407     if ((chtype) ch == ACS_HLINE)
 408         ch = mc_tty_frm[MC_TTY_FRM_HORIZ];
 409
 410     move (y, x);
 411     hline (ch, len);
 412     move (y, x1);
 413
 414     mc_curs_row = y;
 415     mc_curs_col = x1;
 416 }
 417
 418 /* --------------------------------------------------------------------------------------------- */
 419
 420 void
 421 tty_draw_vline (int y, int x, int ch, int len)
 422 {
 423     int y1;
 424
 425     if (x < 0 || x >= COLS || y >= LINES)
 426         return;
 427
 428     y1 = y;
 429
 430     if (y < 0)
 431     {
 432         len += y;
 433         if (len <= 0)
 434             return;
 435         y = 0;
 436     }
 437
 438     if ((chtype) ch == ACS_VLINE)
 439         ch = mc_tty_frm[MC_TTY_FRM_VERT];
 440
 441     move (y, x);
 442     vline (ch, len);
 443     move (y1, x);
 444
 445     mc_curs_row = y1;
 446     mc_curs_col = x;
 447 }
 448
 449 /* --------------------------------------------------------------------------------------------- */
 450
 451 void
 452 tty_fill_region (int y, int x, int rows, int cols, unsigned char ch)
 453 {
 454     int i;
 455
 456     if (y < 0)
 457     {
 458         rows += y;
 459
 460         if (rows <= 0)
 461             return;
 462
 463         y = 0;
 464     }
 465
 466     if (x < 0)
 467     {
 468         cols += x;
 469
 470         if (cols <= 0)
 471             return;
 472
 473         x = 0;
 474     }
 475
 476     if (y + rows > LINES)
 477         rows = LINES - y;
 478     if (x + cols > COLS)
 479         cols = COLS - x;
 480
 481     for (i = 0; i < rows; i++)
 482     {
 483         move (y + i, x);
 484         hline (ch, cols);
 485     }
 486
 487     move (y, x);
 488
 489     mc_curs_row = y;
 490     mc_curs_col = x;
 491 }
 492
 493 /* --------------------------------------------------------------------------------------------- */
 494
 495 void
 496 tty_set_alt_charset (gboolean alt_charset)
 497 {
 498     (void) alt_charset;
 499 }
 500
 501 /* --------------------------------------------------------------------------------------------- */
 502
 503 void
 504 tty_display_8bit (gboolean what)
 505 {
 506     meta (stdscr, (int) what);
 507 }
 508
 509 /* --------------------------------------------------------------------------------------------- */
 510
 511 void
 512 tty_print_char (int c)
 513 {
 514     if (yx_in_screen (mc_curs_row, mc_curs_col))
 515         addch (c);
 516     mc_curs_col++;
 517 }
 518
 519 /* --------------------------------------------------------------------------------------------- */
 520
 521 void
 522 tty_print_anychar (int c)
 523 {
 524     unsigned char str[6 + 1];
 525
 526     if (mc_global.utf8_display || c > 255)
 527     {
 528         int res;
 529
 530         res = g_unichar_to_utf8 (c, (char *) str);
 531         if (res == 0)
 532         {
 533             if (yx_in_screen (mc_curs_row, mc_curs_col))
 534                 addch ('.');
 535             mc_curs_col++;
 536         }
 537         else
 538         {
 539             const char *s;
 540
 541             str[res] = '\0';
 542             s = str_term_form ((char *) str);
 543
 544             if (yx_in_screen (mc_curs_row, mc_curs_col))
 545                 addstr (s);
 546
 547             if (g_unichar_iswide (c))
 548                 mc_curs_col += 2;
 549             else if (!g_unichar_iszerowidth (c))
 550                 mc_curs_col++;
 551         }
 552     }
 553     else
 554     {
 555         if (yx_in_screen (mc_curs_row, mc_curs_col))
 556             addch (c);
 557         mc_curs_col++;
 558     }
 559 }
 560
 561 /* --------------------------------------------------------------------------------------------- */
 562
 563 void
 564 tty_print_alt_char (int c, gboolean single)
 565 {
 566     if (yx_in_screen (mc_curs_row, mc_curs_col))
 567     {
 568         if ((chtype) c == ACS_VLINE)
 569             c = mc_tty_frm[single ? MC_TTY_FRM_VERT : MC_TTY_FRM_DVERT];
 570         else if ((chtype) c == ACS_HLINE)
 571             c = mc_tty_frm[single ? MC_TTY_FRM_HORIZ : MC_TTY_FRM_DHORIZ];
 572         else if ((chtype) c == ACS_LTEE)
 573             c = mc_tty_frm[single ? MC_TTY_FRM_LEFTMIDDLE : MC_TTY_FRM_DLEFTMIDDLE];
 574         else if ((chtype) c == ACS_RTEE)
 575             c = mc_tty_frm[single ? MC_TTY_FRM_RIGHTMIDDLE : MC_TTY_FRM_DRIGHTMIDDLE];
 576         else if ((chtype) c == ACS_ULCORNER)
 577             c = mc_tty_frm[single ? MC_TTY_FRM_LEFTTOP : MC_TTY_FRM_DLEFTTOP];
 578         else if ((chtype) c == ACS_LLCORNER)
 579             c = mc_tty_frm[single ? MC_TTY_FRM_LEFTBOTTOM : MC_TTY_FRM_DLEFTBOTTOM];
 580         else if ((chtype) c == ACS_URCORNER)
 581             c = mc_tty_frm[single ? MC_TTY_FRM_RIGHTTOP : MC_TTY_FRM_DRIGHTTOP];
 582         else if ((chtype) c == ACS_LRCORNER)
 583             c = mc_tty_frm[single ? MC_TTY_FRM_RIGHTBOTTOM : MC_TTY_FRM_DRIGHTBOTTOM];
 584         else if ((chtype) c == ACS_PLUS)
 585             c = mc_tty_frm[MC_TTY_FRM_CROSS];
 586
 587         addch (c);
 588     }
 589
 590     mc_curs_col++;
 591 }
 592
 593 /* --------------------------------------------------------------------------------------------- */
 594
 595 void
 596 tty_print_string (const char *s)
 597 {
 598     int len;
 599     int start = 0;
 600
 601     s = str_term_form (s);
 602     len = str_term_width1 (s);
 603
 604     /* line is upper or below the screen or entire line is before or after scrren */
 605     if (mc_curs_row < 0 || mc_curs_row >= LINES || mc_curs_col + len <= 0 || mc_curs_col >= COLS)
 606     {
 607         mc_curs_col += len;
 608         return;
 609     }
 610
 611     /* skip invisible left part */
 612     if (mc_curs_col < 0)
 613     {
 614         start = -mc_curs_col;
 615         len += mc_curs_col;
 616         mc_curs_col = 0;
 617     }
 618
 619     mc_curs_col += len;
 620     if (mc_curs_col >= COLS)
 621         len = COLS - (mc_curs_col - len);
 622
 623     addstr (str_term_substring (s, start, len));
 624 }
 625
 626 /* --------------------------------------------------------------------------------------------- */
 627
 628 void
 629 tty_printf (const char *fmt, ...)
 630 {
 631     va_list args;
 632     char buf[BUF_1K];           /* FIXME: is it enough? */
 633
 634     va_start (args, fmt);
 635     g_vsnprintf (buf, sizeof (buf), fmt, args);
 636     va_end (args);
 637     tty_print_string (buf);
 638 }
 639
 640 /* --------------------------------------------------------------------------------------------- */
 641
 642 char *
 643 tty_tgetstr (const char *cap)
 644 {
 645     char *unused = NULL;
 646     return tgetstr ((char *) cap, &unused);
 647 }
 648
 649 /* --------------------------------------------------------------------------------------------- */
 650
 651 void
 652 tty_refresh (void)
 653 {
 654     refresh ();
 655     doupdate ();
 656 }
 657
 658 /* --------------------------------------------------------------------------------------------- */
 659
 660 void
 661 tty_beep (void)
 662 {
 663     beep ();
 664 }
 665
 666 /* --------------------------------------------------------------------------------------------- */