lib-ui/curs_lib.c

   1 /*
   2  * Copyright notice from original mutt:
   3  * Copyright (C) 1996-2002 Michael R. Elkins <me@mutt.org>
   4  * Copyright (C) 2004 g10 Code GmbH
   5  *
   6  * Parts were written/modified by:
   7  * Nico Golde <nico@ngolde.de>
   8  *
   9  * This file is part of mutt-ng, see http://www.muttng.org/.
  10  * It's licensed under the GNU General Public License,
  11  * please see the file GPL in the top level source directory.
  12  */
  13
  14 #include <lib-ui/lib-ui.h>
  15
  16 #include <langinfo.h>
  17 #include <termios.h>
  18
  19 #include <lib-lua/lib-lua.h>
  20 #include <lib-sys/unix.h>
  21 #include <lib-sys/mutt_signal.h>
  22
  23 #include "menu.h"
  24 #include "enter.h"
  25
  26 #include "mutt.h"
  27 #include "pager.h"
  28 #include "charset.h"
  29
  30 /* not possible to unget more than one char under some curses libs, and it
  31  * is impossible to unget function keys in SLang, so roll our own input
  32  * buffering routines.
  33  */
  34 ssize_t UngetCount = 0;
  35 static ssize_t UngetBufLen = 0;
  36 static event_t *KeyEvent;
  37
  38 event_t mutt_getch (void)
  39 {
  40   int ch;
  41   event_t err = { -1, OP_NULL }, ret;
  42
  43   if (!option (OPTUNBUFFEREDINPUT) && UngetCount)
  44     return (KeyEvent[--UngetCount]);
  45
  46   SigInt = 0;
  47
  48   mutt_allow_interrupt (1);
  49   ch = getch();
  50   mutt_allow_interrupt (0);
  51
  52   if (SigInt)
  53     mutt_query_exit ();
  54
  55   if (ch == ERR)
  56     return err;
  57
  58   ret.ch = ch;
  59   ret.op = 0;
  60   return (ch == ctrl ('G') ? err : ret);
  61 }
  62
  63 #ifndef waddnwstr
  64 int waddwch(WINDOW *win, wchar_t wc)
  65 {
  66     char buf[MB_LEN_MAX * 2];
  67     mbstate_t mbstate;
  68     ssize_t n1, n2;
  69
  70     p_clear(&mbstate, 1);
  71     if ((n1 = wcrtomb(buf, wc, &mbstate)) == -1
  72     ||  (n2 = wcrtomb(buf + n1, 0, &mbstate)) == -1)
  73         return -1;                  /* ERR */
  74     return waddstr(win, buf);
  75 }
  76 #endif
  77
  78
  79 int _mutt_get_field ( const char *field, char *buf, ssize_t buflen,
  80                      int complete, int multiple, char ***files, int *numfiles)
  81 {
  82   int ret;
  83   int x, y;
  84
  85   ENTER_STATE *es = mutt_new_enter_state ();
  86
  87   do {
  88     CLEARLINE(stdscr, LINES - 1);
  89     waddstr (stdscr, field);
  90     mutt_refresh ();
  91     getyx (stdscr, y, x);
  92     ret = _mutt_enter_string(buf, buflen, y, x, complete, multiple, files,
  93                              numfiles, es);
  94   } while (ret == 1);
  95   CLEARLINE(stdscr, LINES - 1);
  96   mutt_free_enter_state (&es);
  97
  98   return (ret);
  99 }
 100
 101 int mutt_get_field_unbuffered (char *msg, char *buf, ssize_t buflen, int flags)
 102 {
 103   int rc;
 104
 105   set_option (OPTUNBUFFEREDINPUT);
 106   rc = mutt_get_field (msg, buf, buflen, flags);
 107   unset_option (OPTUNBUFFEREDINPUT);
 108
 109   return (rc);
 110 }
 111
 112 void mutt_clear_error (void)
 113 {
 114   Errorbuf[0] = 0;
 115   if (!option (OPTNOCURSES))
 116     CLEARLINE(stdscr, LINES - 1);
 117 }
 118
 119 void mutt_edit_file(const char *data)
 120 {
 121   char cmd[LONG_STRING];
 122
 123   mutt_endwin (NULL);
 124   m_quotefile_fmt(cmd, sizeof (cmd), mod_core.editor, data);
 125   if (mutt_system (cmd) == -1)
 126     mutt_error (_("Error running \"%s\"!"), cmd);
 127   keypad (stdscr, TRUE);
 128   clearok (stdscr, TRUE);
 129 }
 130
 131 int mutt_yesorno (const char *msg, int def)
 132 {
 133   event_t ch;
 134   const char *yes = _("yes");
 135   const char *no = _("no");
 136   char *answer_string;
 137   ssize_t answer_string_len;
 138   char *expr;
 139   regex_t reyes;
 140   regex_t reno;
 141   int reyes_ok;
 142   int reno_ok;
 143   char answer[2];
 144
 145   answer[1] = 0;
 146
 147   reyes_ok = (expr = nl_langinfo (YESEXPR)) && expr[0] == '^' &&
 148     !regcomp (&reyes, expr, REG_NOSUB | REG_EXTENDED);
 149   reno_ok = (expr = nl_langinfo (NOEXPR)) && expr[0] == '^' &&
 150     !regcomp (&reno, expr, REG_NOSUB | REG_EXTENDED);
 151
 152   CLEARLINE(stdscr, LINES - 1);
 153
 154   /*
 155    * In order to prevent the default answer to the question to wrapped
 156    * around the screen in the even the question is wider than the screen,
 157    * ensure there is enough room for the answer and truncate the question
 158    * to fit.
 159    */
 160   answer_string = p_new(char, getmaxx(stdscr) + 1);
 161   snprintf (answer_string, getmaxx(stdscr) + 1, " ([%s]/%s): ", def == M_YES ? yes : no,
 162             def == M_YES ? no : yes);
 163   answer_string_len = m_strlen(answer_string);
 164   wprintw (stdscr, "%.*s%s", getmaxx(stdscr) - answer_string_len, msg, answer_string);
 165   p_delete(&answer_string);
 166
 167   for (;;) {
 168     mutt_refresh ();
 169     ch = mutt_getch ();
 170     if (CI_is_return (ch.ch))
 171       break;
 172     if (ch.ch == -1) {
 173       def = -1;
 174       break;
 175     }
 176
 177     answer[0] = ch.ch;
 178     if (reyes_ok ? (regexec (&reyes, answer, 0, 0, 0) == 0) : tolower (ch.ch) == *yes)
 179     {
 180       def = M_YES;
 181       break;
 182     }
 183     else if (
 184               reno_ok ? (regexec (&reno, answer, 0, 0, 0) == 0) :
 185               (tolower (ch.ch) == *no)) {
 186       def = M_NO;
 187       break;
 188     } else {
 189       BEEP ();
 190     }
 191   }
 192
 193   if (reyes_ok)
 194     regfree (&reyes);
 195   if (reno_ok)
 196     regfree (&reno);
 197
 198   if (def != -1) {
 199     waddstr (stdscr, (char *) (def == M_YES ? yes : no));
 200     mutt_refresh ();
 201   }
 202   CLEARLINE(stdscr, LINES - 1);
 203   return (def);
 204 }
 205
 206 /* this function is called when the user presses the abort key */
 207 void mutt_query_exit (void)
 208 {
 209   mutt_flushinp ();
 210   curs_set (1);
 211   if (Timeout)
 212     wtimeout (stdscr, -1);               /* restore blocking operation */
 213   if (mutt_yesorno (_("Exit Madmutt?"), M_YES) == M_YES) {
 214     mutt_endwin (NULL);
 215     mutt_exit(1);
 216   }
 217   mutt_clear_error ();
 218   mutt_curs_set (-1);
 219   SigInt = 0;
 220 }
 221
 222 void mutt_curses_error (const char *fmt, ...)
 223 {
 224   char TmpErrorbuf[STRING];
 225   va_list ap;
 226
 227   va_start (ap, fmt);
 228   vsnprintf (Errorbuf, sizeof (Errorbuf), fmt, ap);
 229   va_end (ap);
 230
 231   mutt_format_string (TmpErrorbuf, sizeof (TmpErrorbuf),
 232                       0, getmaxy(stdscr) - 2, 0, 0, Errorbuf, sizeof (Errorbuf), 0);
 233   snprintf (Errorbuf, sizeof (Errorbuf), "%s", TmpErrorbuf);    /* overkill */
 234
 235   if (!option (OPTKEEPQUIET)) {
 236     BEEP ();
 237     SETCOLOR(stdscr, MT_COLOR_ERROR);
 238     mvwaddstr (stdscr, LINES - 1, 0, Errorbuf);
 239     wclrtoeol (stdscr);
 240     SETCOLOR(stdscr, MT_COLOR_NORMAL);
 241     mutt_refresh ();
 242   }
 243
 244   set_option (OPTMSGERR);
 245 }
 246
 247 void mutt_progress_bar (progress_t* progress, long pos) {
 248   char posstr[STRING];
 249
 250   if (!pos) {
 251     if (!NetInc)
 252       mutt_message (progress->msg);
 253     else {
 254       if (progress->size)
 255         mutt_pretty_size (progress->sizestr, sizeof (progress->sizestr),
 256                           progress->size);
 257       progress->pos = 0;
 258     }
 259   }
 260
 261   if (!NetInc)
 262     return;
 263
 264   if (pos >= progress->pos + (NetInc << 10)) {
 265     progress->pos = pos;
 266     pos = pos / (NetInc << 10) * (NetInc << 10);
 267     mutt_pretty_size (posstr, sizeof (posstr), pos);
 268     if (progress->size)
 269       mutt_message ("%s %s/%s", progress->msg, posstr, progress->sizestr);
 270     else
 271       mutt_message ("%s %s", progress->msg, posstr);
 272   }
 273 }
 274
 275 void mutt_curses_message (const char *fmt, ...)
 276 {
 277   char TmpErrorbuf[STRING];
 278   va_list ap;
 279
 280   va_start (ap, fmt);
 281   vsnprintf (Errorbuf, sizeof (Errorbuf), fmt, ap);
 282   va_end (ap);
 283
 284   mutt_format_string (TmpErrorbuf, sizeof (TmpErrorbuf),
 285                       0, getmaxx(stdscr) - 2, 0, 0, Errorbuf, sizeof (Errorbuf), 0);
 286   snprintf (Errorbuf, sizeof (Errorbuf), "%s", TmpErrorbuf);    /* overkill */
 287
 288   if (!option (OPTKEEPQUIET)) {
 289     SETCOLOR(stdscr, MT_COLOR_MESSAGE);
 290     mvwaddstr (stdscr, LINES - 1, 0, Errorbuf);
 291     wclrtoeol (stdscr);
 292     SETCOLOR(stdscr, MT_COLOR_NORMAL);
 293     mutt_refresh ();
 294   }
 295
 296   unset_option (OPTMSGERR);
 297 }
 298
 299 void mutt_show_error (void)
 300 {
 301   if (option (OPTKEEPQUIET))
 302     return;
 303
 304   SETCOLOR(stdscr, option (OPTMSGERR) ? MT_COLOR_ERROR : MT_COLOR_MESSAGE);
 305   CLEARLINE(stdscr, LINES - 1);
 306   waddstr (stdscr, Errorbuf);
 307   SETCOLOR(stdscr, MT_COLOR_NORMAL);
 308 }
 309
 310 void curses_initialize(void)
 311 {
 312     if (initscr () == NULL) {
 313         puts _("Error initializing terminal.");
 314         exit (1);
 315     }
 316     ci_start_color();
 317     keypad(stdscr, true);
 318     cbreak();
 319     noecho();
 320     typeahead (-1);               /* simulate smooth scrolling */
 321     meta(stdscr, true);
 322 }
 323
 324 /*
 325  * prompts the user to enter a keystroke, and displays the octal value back
 326  * to the user.
 327  */
 328 void mutt_what_key (void)
 329 {
 330   int ch;
 331
 332   mvwprintw(stdscr, LINES - 1, 0, _("Enter keys (^G to abort): "));
 333   do {
 334     ch = getch();
 335     if (ch != ERR && ch != ctrl ('G')) {
 336       mutt_message (_("Char = %s, Octal = %o, Decimal = %d"),
 337                     km_keyname (ch), ch, ch);
 338     }
 339   }
 340   while (ch != ERR && ch != ctrl ('G'));
 341
 342   mutt_flushinp ();
 343 }
 344
 345 int mutt_any_key_to_continue (const char *s)
 346 {
 347   struct termios t;
 348   struct termios old;
 349   int f, ch;
 350
 351   f = open ("/dev/tty", O_RDONLY);
 352   tcgetattr (f, &t);
 353   memcpy ((void *) &old, (void *) &t, sizeof (struct termios)); /* save original state */
 354   t.c_lflag &= ~(ICANON | ECHO);
 355   t.c_cc[VMIN] = 1;
 356   t.c_cc[VTIME] = 0;
 357   tcsetattr (f, TCSADRAIN, &t);
 358   fflush (stdout);
 359   if (s)
 360     fputs (s, stdout);
 361   else
 362     fputs (_("Press any key to continue..."), stdout);
 363   fflush (stdout);
 364   ch = fgetc (stdin);
 365   fflush (stdin);
 366   tcsetattr (f, TCSADRAIN, &old);
 367   close (f);
 368   fputs ("\r\n", stdout);
 369   mutt_clear_error ();
 370   return (ch);
 371 }
 372
 373 int _mutt_enter_fname (const char *prompt, char *buf, ssize_t blen,
 374                        int *redraw, int buffy, int multiple, char ***files,
 375                        int *numfiles)
 376 {
 377   event_t ch;
 378
 379   mvwaddstr(stdscr, LINES - 1, 0, (char *) prompt);
 380   waddstr(stdscr, _(" ('?' for list): "));
 381   if (buf[0])
 382     waddstr (stdscr, buf);
 383   wclrtoeol (stdscr);
 384   mutt_refresh ();
 385
 386   ch = mutt_getch ();
 387   if (ch.ch == -1) {
 388     CLEARLINE(stdscr, LINES - 1);
 389     return (-1);
 390   }
 391   else if (ch.ch == '?') {
 392     mutt_refresh ();
 393     buf[0] = 0;
 394     mutt_select_file (buf, blen, M_SEL_FOLDER | (multiple ? M_SEL_MULTI : 0),
 395                       files, numfiles);
 396     *redraw = REDRAW_FULL;
 397   }
 398   else {
 399     char *pc = p_new(char, m_strlen(prompt) + 3);
 400
 401     sprintf(pc, "%s: ", prompt);
 402     mutt_ungetch (ch.op ? 0 : ch.ch, ch.op ? ch.op : 0);
 403     if (_mutt_get_field
 404         (pc, buf, blen, (buffy ? M_EFILE : M_FILE) | M_CLEAR, multiple, files,
 405          numfiles)
 406         != 0)
 407       buf[0] = 0;
 408     MAYBE_REDRAW (*redraw);
 409     p_delete(&pc);
 410   }
 411
 412   return 0;
 413 }
 414
 415 void mutt_ungetch (int ch, int op)
 416 {
 417   event_t tmp;
 418
 419   tmp.ch = ch;
 420   tmp.op = op;
 421
 422   if (UngetCount >= UngetBufLen)
 423     p_realloc(&KeyEvent, UngetBufLen += 128);
 424
 425   KeyEvent[UngetCount++] = tmp;
 426 }
 427
 428 void mutt_flushinp (void)
 429 {
 430   UngetCount = 0;
 431   flushinp ();
 432 }
 433
 434 /* The argument can take 3 values:
 435  * -1: restore the value of the last call
 436  *  0: make the cursor invisible
 437  *  1: make the cursor visible
 438  */
 439 void mutt_curs_set (int cursor)
 440 {
 441   static int SavedCursor = 1;
 442
 443   if (cursor < 0)
 444     cursor = SavedCursor;
 445   else
 446     SavedCursor = cursor;
 447
 448   if (curs_set (cursor) == ERR) {
 449     if (cursor == 1)            /* cnorm */
 450       curs_set (2);             /* cvvis */
 451   }
 452 }
 453
 454 int mutt_multi_choice (const char *prompt, const char *letters)
 455 {
 456   event_t ch;
 457   int choice;
 458   char *p;
 459
 460   mvwaddstr (stdscr, LINES - 1, 0, prompt);
 461   wclrtoeol (stdscr);
 462   for (;;) {
 463     mutt_refresh ();
 464     ch = mutt_getch ();
 465     if (ch.ch == -1 || CI_is_return (ch.ch)) {
 466       choice = -1;
 467       break;
 468     }
 469     else {
 470       p = strchr (letters, ch.ch);
 471       if (p) {
 472         choice = p - letters + 1;
 473         break;
 474       }
 475       else if (ch.ch <= '9' && ch.ch > '0') {
 476         choice = ch.ch - '0';
 477         if (choice <= m_strlen(letters))
 478           break;
 479       }
 480     }
 481     BEEP ();
 482   }
 483   CLEARLINE(stdscr, LINES - 1);
 484   mutt_refresh ();
 485   return choice;
 486 }
 487
 488 ssize_t mutt_pretty_size(char *s, ssize_t len, ssize_t n)
 489 {
 490     if (n == 0)
 491         return m_strcpy(s, len, "0K");
 492
 493     if (n < 10189)           /* 0.1K - 9.9K */
 494         return snprintf(s, len, "%3.1fK", (n < 103) ? 0.1 : n / 1024.0);
 495
 496     if (n < 1023949)         /* 10K - 999K */
 497         /* 51 is magic which causes 10189/10240 to be rounded up to 10 */
 498         return snprintf(s, len, "%ldK", (n + 51) / 1024);
 499
 500     if (n < 10433332)        /* 1.0M - 9.9M */
 501         return snprintf(s, len, "%3.1fM", n / 1048576.0);
 502
 503     /* (10433332 + 52428) / 1048576 = 10 */
 504     return snprintf (s, len, "%ldM", (n + 52428) / 1048576);
 505 }
 506
 507 /*
 508  * This formats a string, a bit like
 509  * snprintf (dest, destlen, "%-*.*s", min_width, max_width, s),
 510  * except that the widths refer to the number of character cells
 511  * when printed.
 512  */
 513
 514 void mutt_format_string (char *dest, ssize_t destlen,
 515                          int min_width, int max_width,
 516                          int right_justify, char m_pad_char,
 517                          const char *s, ssize_t n, int arboreal)
 518 {
 519   char *p;
 520   wchar_t wc;
 521   int w;
 522   ssize_t k, k2;
 523   char scratch[MB_LEN_MAX];
 524   mbstate_t mbstate1, mbstate2;
 525
 526   p_clear(&mbstate1, 1);
 527   p_clear(&mbstate2, 1);
 528   --destlen;
 529   p = dest;
 530   for (; n && (k = mbrtowc (&wc, s, n, &mbstate1)); s += k, n -= k) {
 531     if (k == -1 || k == -2) {
 532       k = (k == -1) ? 1 : n;
 533       wc = CharsetReplacement;
 534     }
 535     if (arboreal && wc < M_TREE_MAX)
 536       w = 1;                    /* hack */
 537     else {
 538       if (!iswprint(wc))
 539         wc = '?';
 540       w = wcwidth (wc);
 541     }
 542     if (w >= 0) {
 543       if (w > max_width || (k2 = wcrtomb (scratch, wc, &mbstate2)) > destlen)
 544         break;
 545       min_width -= w;
 546       max_width -= w;
 547       m_strncpy(p, destlen, scratch, k2);
 548       p += k2;
 549       destlen -= k2;
 550     }
 551   }
 552   w = destlen < min_width ? destlen : min_width;
 553   if (w <= 0)
 554     *p = '\0';
 555   else if (right_justify) {
 556     p[w] = '\0';
 557     while (--p >= dest)
 558       p[w] = *p;
 559     while (--w >= 0)
 560       dest[w] = m_pad_char;
 561   }
 562   else {
 563     while (--w >= 0)
 564       *p++ = m_pad_char;
 565     *p = '\0';
 566   }
 567 }
 568
 569 /*
 570  * This formats a string rather like
 571  *   snprintf (fmt, sizeof (fmt), "%%%ss", prefix);
 572  *   snprintf (dest, destlen, fmt, s);
 573  * except that the numbers in the conversion specification refer to
 574  * the number of character cells when printed.
 575  */
 576
 577 static void mutt_format_s_x (char *dest, ssize_t destlen,
 578                              const char *prefix, const char *s, int arboreal)
 579 {
 580   int right_justify = 1;
 581   char *p;
 582   int min_width;
 583   int max_width = INT_MAX;
 584
 585   if (*prefix == '-')
 586     ++prefix, right_justify = 0;
 587   min_width = strtol (prefix, &p, 10);
 588   if (*p == '.') {
 589     prefix = p + 1;
 590     max_width = strtol (prefix, &p, 10);
 591     if (p <= prefix)
 592       max_width = INT_MAX;
 593   }
 594
 595   mutt_format_string (dest, destlen, min_width, max_width,
 596                       right_justify, ' ', s, m_strlen(s), arboreal);
 597 }
 598
 599 void mutt_format_s (char *dest, ssize_t destlen,
 600                     const char *prefix, const char *s)
 601 {
 602   mutt_format_s_x (dest, destlen, prefix, s, 0);
 603 }
 604
 605 void mutt_format_s_tree (char *dest, ssize_t destlen,
 606                          const char *prefix, const char *s)
 607 {
 608   mutt_format_s_x (dest, destlen, prefix, s, 1);
 609 }
 610
 611 /*
 612  * mutt_paddstr (n, s) is almost equivalent to
 613  * mutt_format_string (bigbuf, big, n, n, 0, ' ', s, big, 0), waddstr (main_w, bigbuf)
 614  */
 615
 616 void mutt_paddstr(WINDOW *win, int n, const char *s)
 617 {
 618   wchar_t wc;
 619   int w;
 620   ssize_t k;
 621   ssize_t len = m_strlen(s);
 622   mbstate_t mbstate;
 623
 624   p_clear(&mbstate, 1);
 625   for (; len && (k = mbrtowc (&wc, s, len, &mbstate)); s += k, len -= k) {
 626     if (k == -1 || k == -2) {
 627       k = (k == -1) ? 1 : len;
 628       wc = CharsetReplacement;
 629     }
 630     if (!iswprint(wc))
 631       wc = '?';
 632     w = wcwidth (wc);
 633     if (w >= 0) {
 634       if (w > n)
 635         break;
 636       waddnstr(win, (char *) s, k);
 637       n -= w;
 638     }
 639   }
 640   while (n-- > 0)
 641     waddch(win, ' ');
 642 }