lib/tty/tty-ncurses.c

   1 /*
   2    Interface to the terminal controlling library.
   3    Ncurses wrapper.
   4
   5    Copyright (C) 2005, 2006, 2007, 2009 Free Software Foundation, Inc.
   6
   7    Written by:
   8    Andrew Borodin <aborodin@vmail.ru>, 2009.
   9    Ilia Maslakov <il.smind@gmail.com>, 2009.
  10
  11    This file is part of the Midnight Commander.
  12
  13    The Midnight Commander is free software; you can redistribute it
  14    and/or modify it under the terms of the GNU General Public License as
  15    published by the Free Software Foundation; either version 2 of the
  16    License, or (at your option) any later version.
  17
  18    The Midnight Commander is distributed in the hope that it will be
  19    useful, but WITHOUT ANY WARRANTY; without even the implied warranty
  20    of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  21    General Public License for more details.
  22
  23    You should have received a copy of the GNU General Public License
  24    along with this program; if not, write to the Free Software
  25    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
  26    MA 02110-1301, USA.
  27  */
  28
  29 /** \file
  30  *  \brief Source: NCurses-based tty layer of Midnight-commander
  31  */
  32
  33 #include <config.h>
  34
  35 #include <stdlib.h>
  36 #include <stdarg.h>
  37 #include <signal.h>
  38
  39 #include "lib/global.h"
  40 #include "lib/strutil.h"        /* str_term_form */
  41
  42 #ifndef WANT_TERM_H
  43 #define WANT_TERM_H
  44 #endif
  45
  46 #include "tty-internal.h"       /* mc_tty_normalize_from_utf8() */
  47 #include "tty.h"
  48 #include "color-internal.h"
  49 #include "mouse.h"
  50 #include "win.h"
  51
  52 /* include at last !!! */
  53 #ifdef WANT_TERM_H
  54 #ifdef HAVE_NCURSES_TERM_H
  55 #include <ncurses/term.h>
  56 #else
  57 #include <term.h>
  58 #endif /* HAVE_NCURSES_TERM_H */
  59 #endif /* WANT_TERM_H */
  60
  61 /*** global variables ****************************************************************************/
  62
  63 /*** file scope macro definitions ****************************************************************/
  64
  65 #if defined(_AIX) && !defined(CTRL)
  66 #define CTRL(x) ((x) & 0x1f)
  67 #endif
  68
  69 /*** global variables ****************************************************************************/
  70
  71 /*** file scope type declarations ****************************************************************/
  72
  73 /*** file scope variables ************************************************************************/
  74
  75 /*** file scope functions ************************************************************************/
  76 /* --------------------------------------------------------------------------------------------- */
  77
  78 /* --------------------------------------------------------------------------------------------- */
  79
  80 static void
  81 tty_setup_sigwinch (void (*handler) (int))
  82 {
  83 #if (NCURSES_VERSION_MAJOR >= 4) && defined (SIGWINCH)
  84     struct sigaction act, oact;
  85     act.sa_handler = handler;
  86     sigemptyset (&act.sa_mask);
  87     act.sa_flags = 0;
  88 #ifdef SA_RESTART
  89     act.sa_flags |= SA_RESTART;
  90 #endif /* SA_RESTART */
  91     sigaction (SIGWINCH, &act, &oact);
  92 #endif /* SIGWINCH */
  93 }
  94
  95 /* --------------------------------------------------------------------------------------------- */
  96
  97 void
  98 sigwinch_handler (int dummy)
  99 {
 100     (void) dummy;
 101
 102     mc_global.tty.winch_flag = TRUE;
 103 }
 104
 105 /* --------------------------------------------------------------------------------------------- */
 106 /*** public functions ****************************************************************************/
 107 /* --------------------------------------------------------------------------------------------- */
 108
 109 int
 110 mc_tty_normalize_lines_char (const char *ch)
 111 {
 112     char *str2;
 113     int res;
 114
 115     struct mc_tty_lines_struct
 116     {
 117         const char *line;
 118         int line_code;
 119     } const lines_codes[] = {
 120         {"\342\224\230", ACS_LRCORNER}, /* ┌ */
 121         {"\342\224\224", ACS_LLCORNER}, /* └ */
 122         {"\342\224\220", ACS_URCORNER}, /* ┐ */
 123         {"\342\224\214", ACS_ULCORNER}, /* ┘ */
 124         {"\342\224\234", ACS_LTEE},     /* ├ */
 125         {"\342\224\244", ACS_RTEE},     /* ┤ */
 126         {"\342\224\254", ACS_TTEE},     /* ┬ */
 127         {"\342\224\264", ACS_BTEE},     /* ┴ */
 128         {"\342\224\200", ACS_HLINE},    /* ─ */
 129         {"\342\224\202", ACS_VLINE},    /* │ */
 130         {"\342\224\274", ACS_PLUS},     /* ┼ */
 131
 132         {"\342\225\235", ACS_LRCORNER | A_BOLD},        /* ╔ */
 133         {"\342\225\232", ACS_LLCORNER | A_BOLD},        /* ╚ */
 134         {"\342\225\227", ACS_URCORNER | A_BOLD},        /* ╗ */
 135         {"\342\225\224", ACS_ULCORNER | A_BOLD},        /* ╝ */
 136         {"\342\225\237", ACS_LTEE | A_BOLD},    /* ╟ */
 137         {"\342\225\242", ACS_RTEE | A_BOLD},    /* ╢ */
 138         {"\342\225\244", ACS_TTEE | A_BOLD},    /* ╤ */
 139         {"\342\225\247", ACS_BTEE | A_BOLD},    /* ╧ */
 140         {"\342\225\220", ACS_HLINE | A_BOLD},   /* ═ */
 141         {"\342\225\221", ACS_VLINE | A_BOLD},   /* ║ */
 142
 143         {NULL, 0}
 144     };
 145
 146     if (ch == NULL)
 147         return (int) ' ';
 148
 149     for (res = 0; lines_codes[res].line; res++)
 150     {
 151         if (strcmp (ch, lines_codes[res].line) == 0)
 152             return lines_codes[res].line_code;
 153     }
 154
 155     str2 = mc_tty_normalize_from_utf8 (ch);
 156     res = g_utf8_get_char_validated (str2, -1);
 157
 158     if (res < 0)
 159         res = (unsigned char) str2[0];
 160     g_free (str2);
 161
 162     return res;
 163 }
 164
 165 /* --------------------------------------------------------------------------------------------- */
 166
 167 void
 168 tty_init (gboolean mouse_enable, gboolean is_xterm)
 169 {
 170     initscr ();
 171
 172 #ifdef HAVE_ESCDELAY
 173     /*
 174      * If ncurses exports the ESCDELAY variable, it should be set to
 175      * a low value, or you'll experience a delay in processing escape
 176      * sequences that are recognized by mc (e.g. Esc-Esc).  On the other
 177      * hand, making ESCDELAY too small can result in some sequences
 178      * (e.g. cursor arrows) being reported as separate keys under heavy
 179      * processor load, and this can be a problem if mc hasn't learned
 180      * them in the "Learn Keys" dialog.  The value is in milliseconds.
 181      */
 182     ESCDELAY = 200;
 183 #endif /* HAVE_ESCDELAY */
 184
 185     /* use Ctrl-g to generate SIGINT */
 186     cur_term->Nttyb.c_cc[VINTR] = CTRL ('g');   /* ^g */
 187     /* disable SIGQUIT to allow use Ctrl-\ key */
 188     cur_term->Nttyb.c_cc[VQUIT] = NULL_VALUE;
 189     tcsetattr (cur_term->Filedes, TCSANOW, &cur_term->Nttyb);
 190
 191     tty_start_interrupt_key ();
 192
 193     if (!mouse_enable)
 194         use_mouse_p = MOUSE_DISABLED;
 195     tty_init_xterm_support (is_xterm);  /* do it before do_enter_ca_mode() call */
 196     init_mouse ();
 197     do_enter_ca_mode ();
 198     tty_raw_mode ();
 199     noecho ();
 200     keypad (stdscr, TRUE);
 201     nodelay (stdscr, FALSE);
 202
 203     tty_setup_sigwinch (sigwinch_handler);
 204 }
 205
 206 /* --------------------------------------------------------------------------------------------- */
 207
 208 void
 209 tty_shutdown (void)
 210 {
 211     disable_mouse ();
 212     tty_reset_shell_mode ();
 213     tty_noraw_mode ();
 214     tty_keypad (FALSE);
 215     tty_reset_screen ();
 216     do_exit_ca_mode ();
 217 }
 218
 219 /* --------------------------------------------------------------------------------------------- */
 220
 221 void
 222 tty_reset_prog_mode (void)
 223 {
 224     reset_prog_mode ();
 225 }
 226
 227 /* --------------------------------------------------------------------------------------------- */
 228
 229 void
 230 tty_reset_shell_mode (void)
 231 {
 232     reset_shell_mode ();
 233 }
 234
 235 /* --------------------------------------------------------------------------------------------- */
 236
 237 void
 238 tty_raw_mode (void)
 239 {
 240     raw ();                     /* FIXME: uneeded? */
 241     cbreak ();
 242 }
 243
 244 /* --------------------------------------------------------------------------------------------- */
 245
 246 void
 247 tty_noraw_mode (void)
 248 {
 249     nocbreak ();                /* FIXME: unneeded? */
 250     noraw ();
 251 }
 252
 253 /* --------------------------------------------------------------------------------------------- */
 254
 255 void
 256 tty_noecho (void)
 257 {
 258     noecho ();
 259 }
 260
 261 /* --------------------------------------------------------------------------------------------- */
 262
 263 int
 264 tty_flush_input (void)
 265 {
 266     return flushinp ();
 267 }
 268
 269 /* --------------------------------------------------------------------------------------------- */
 270
 271 void
 272 tty_keypad (gboolean set)
 273 {
 274     keypad (stdscr, (bool) set);
 275 }
 276
 277 /* --------------------------------------------------------------------------------------------- */
 278
 279 void
 280 tty_nodelay (gboolean set)
 281 {
 282     nodelay (stdscr, (bool) set);
 283 }
 284
 285 /* --------------------------------------------------------------------------------------------- */
 286
 287 int
 288 tty_baudrate (void)
 289 {
 290     return baudrate ();
 291 }
 292
 293 /* --------------------------------------------------------------------------------------------- */
 294
 295 int
 296 tty_lowlevel_getch (void)
 297 {
 298     return getch ();
 299 }
 300
 301 /* --------------------------------------------------------------------------------------------- */
 302
 303 int
 304 tty_reset_screen (void)
 305 {
 306     return endwin ();
 307 }
 308
 309 /* --------------------------------------------------------------------------------------------- */
 310
 311 void
 312 tty_touch_screen (void)
 313 {
 314     touchwin (stdscr);
 315 }
 316
 317 /* --------------------------------------------------------------------------------------------- */
 318
 319 void
 320 tty_gotoyx (int y, int x)
 321 {
 322     move (y, x);
 323 }
 324
 325 /* --------------------------------------------------------------------------------------------- */
 326
 327 void
 328 tty_getyx (int *py, int *px)
 329 {
 330     getyx (stdscr, *py, *px);
 331 }
 332
 333 /* --------------------------------------------------------------------------------------------- */
 334 /* if x < 0 or y < 0, draw line starting from current position */
 335
 336 void
 337 tty_draw_hline (int y, int x, int ch, int len)
 338 {
 339     if ((chtype) ch == ACS_HLINE)
 340         ch = mc_tty_frm[MC_TTY_FRM_HORIZ];
 341
 342     if ((y >= 0) && (x >= 0))
 343         move (y, x);
 344     hline (ch, len);
 345 }
 346
 347 /* --------------------------------------------------------------------------------------------- */
 348 /* if x < 0 or y < 0, draw line starting from current position */
 349
 350 void
 351 tty_draw_vline (int y, int x, int ch, int len)
 352 {
 353     if ((chtype) ch == ACS_VLINE)
 354         ch = mc_tty_frm[MC_TTY_FRM_VERT];
 355
 356     if ((y >= 0) && (x >= 0))
 357         move (y, x);
 358     vline (ch, len);
 359 }
 360
 361 /* --------------------------------------------------------------------------------------------- */
 362
 363 void
 364 tty_fill_region (int y, int x, int rows, int cols, unsigned char ch)
 365 {
 366     int i;
 367
 368     if (y < 0)
 369     {
 370         rows += y;
 371
 372         if (rows <= 0)
 373             return;
 374
 375         y = 0;
 376     }
 377
 378     if (x < 0)
 379     {
 380         cols += x;
 381
 382         if (cols <= 0)
 383             return;
 384
 385         x = 0;
 386     }
 387
 388     if (y + rows > LINES)
 389         rows = LINES - y;
 390     if (x + cols > COLS)
 391         cols = COLS - x;
 392
 393     for (i = 0; i < rows; i++)
 394     {
 395         move (y + i, x);
 396         hline (ch, cols);
 397     }
 398
 399     move (y, x);
 400 }
 401
 402 /* --------------------------------------------------------------------------------------------- */
 403
 404 void
 405 tty_set_alt_charset (gboolean alt_charset)
 406 {
 407     (void) alt_charset;
 408 }
 409
 410 /* --------------------------------------------------------------------------------------------- */
 411
 412 void
 413 tty_display_8bit (gboolean what)
 414 {
 415     meta (stdscr, (int) what);
 416 }
 417
 418 /* --------------------------------------------------------------------------------------------- */
 419
 420 void
 421 tty_print_char (int c)
 422 {
 423     addch (c);
 424 }
 425
 426 /* --------------------------------------------------------------------------------------------- */
 427
 428 void
 429 tty_print_anychar (int c)
 430 {
 431     unsigned char str[6 + 1];
 432
 433     if (mc_global.utf8_display || c > 255)
 434     {
 435         int res = g_unichar_to_utf8 (c, (char *) str);
 436         if (res == 0)
 437         {
 438             str[0] = '.';
 439             str[1] = '\0';
 440         }
 441         else
 442             str[res] = '\0';
 443         addstr (str_term_form ((char *) str));
 444     }
 445     else
 446         addch (c);
 447
 448 }
 449
 450 /* --------------------------------------------------------------------------------------------- */
 451
 452 void
 453 tty_print_alt_char (int c, gboolean single)
 454 {
 455     if ((chtype) c == ACS_VLINE)
 456         c = mc_tty_frm[single ? MC_TTY_FRM_VERT : MC_TTY_FRM_DVERT];
 457     else if ((chtype) c == ACS_HLINE)
 458         c = mc_tty_frm[single ? MC_TTY_FRM_HORIZ : MC_TTY_FRM_DHORIZ];
 459     else if ((chtype) c == ACS_LTEE)
 460         c = mc_tty_frm[single ? MC_TTY_FRM_LEFTMIDDLE : MC_TTY_FRM_DLEFTMIDDLE];
 461     else if ((chtype) c == ACS_RTEE)
 462         c = mc_tty_frm[single ? MC_TTY_FRM_RIGHTMIDDLE : MC_TTY_FRM_DRIGHTMIDDLE];
 463     else if ((chtype) c == ACS_ULCORNER)
 464         c = mc_tty_frm[single ? MC_TTY_FRM_LEFTTOP : MC_TTY_FRM_DLEFTTOP];
 465     else if ((chtype) c == ACS_LLCORNER)
 466         c = mc_tty_frm[single ? MC_TTY_FRM_LEFTBOTTOM : MC_TTY_FRM_DLEFTBOTTOM];
 467     else if ((chtype) c == ACS_URCORNER)
 468         c = mc_tty_frm[single ? MC_TTY_FRM_RIGHTTOP : MC_TTY_FRM_DRIGHTTOP];
 469     else if ((chtype) c == ACS_LRCORNER)
 470         c = mc_tty_frm[single ? MC_TTY_FRM_RIGHTBOTTOM : MC_TTY_FRM_DRIGHTBOTTOM];
 471     else if ((chtype) c == ACS_PLUS)
 472         c = mc_tty_frm[MC_TTY_FRM_CROSS];
 473
 474     addch (c);
 475 }
 476
 477 /* --------------------------------------------------------------------------------------------- */
 478
 479 void
 480 tty_print_string (const char *s)
 481 {
 482     addstr (str_term_form (s));
 483 }
 484
 485 /* --------------------------------------------------------------------------------------------- */
 486
 487 void
 488 tty_printf (const char *fmt, ...)
 489 {
 490     va_list args;
 491
 492     va_start (args, fmt);
 493     vw_printw (stdscr, fmt, args);
 494     va_end (args);
 495 }
 496
 497 /* --------------------------------------------------------------------------------------------- */
 498
 499 char *
 500 tty_tgetstr (const char *cap)
 501 {
 502     char *unused = NULL;
 503     return tgetstr ((char *) cap, &unused);
 504 }
 505
 506 /* --------------------------------------------------------------------------------------------- */
 507
 508 void
 509 tty_refresh (void)
 510 {
 511     refresh ();
 512     doupdate ();
 513 }
 514
 515 /* --------------------------------------------------------------------------------------------- */
 516
 517 void
 518 tty_beep (void)
 519 {
 520     beep ();
 521 }
 522
 523 /* --------------------------------------------------------------------------------------------- */