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   return (def);
 203 }
 204
 205 /* this function is called when the user presses the abort key */
 206 void mutt_query_exit (void)
 207 {
 208   mutt_flushinp ();
 209   curs_set (1);
 210   if (Timeout)
 211     wtimeout (stdscr, -1);               /* restore blocking operation */
 212   if (mutt_yesorno (_("Exit Madmutt?"), M_YES) == M_YES) {
 213     mutt_endwin (NULL);
 214     mutt_exit(1);
 215   }
 216   mutt_clear_error ();
 217   mutt_curs_set (-1);
 218   SigInt = 0;
 219 }
 220
 221 void mutt_curses_error (const char *fmt, ...)
 222 {
 223   char TmpErrorbuf[STRING];
 224   va_list ap;
 225
 226   va_start (ap, fmt);
 227   vsnprintf (Errorbuf, sizeof (Errorbuf), fmt, ap);
 228   va_end (ap);
 229
 230   mutt_format_string (TmpErrorbuf, sizeof (TmpErrorbuf),
 231                       0, getmaxy(stdscr) - 2, 0, 0, Errorbuf, sizeof (Errorbuf), 0);
 232   snprintf (Errorbuf, sizeof (Errorbuf), "%s", TmpErrorbuf);    /* overkill */
 233
 234   if (!option (OPTKEEPQUIET)) {
 235     BEEP ();
 236     SETCOLOR(stdscr, MT_COLOR_ERROR);
 237     mvwaddstr (stdscr, LINES - 1, 0, Errorbuf);
 238     wclrtoeol (stdscr);
 239     SETCOLOR(stdscr, MT_COLOR_NORMAL);
 240     mutt_refresh ();
 241   }
 242
 243   set_option (OPTMSGERR);
 244 }
 245
 246 void mutt_progress_bar (progress_t* progress, long pos) {
 247   char posstr[STRING];
 248
 249   if (!pos) {
 250     if (!NetInc)
 251       mutt_message (progress->msg);
 252     else {
 253       if (progress->size)
 254         mutt_pretty_size (progress->sizestr, sizeof (progress->sizestr),
 255                           progress->size);
 256       progress->pos = 0;
 257     }
 258   }
 259
 260   if (!NetInc)
 261     return;
 262
 263   if (pos >= progress->pos + (NetInc << 10)) {
 264     progress->pos = pos;
 265     pos = pos / (NetInc << 10) * (NetInc << 10);
 266     mutt_pretty_size (posstr, sizeof (posstr), pos);
 267     if (progress->size)
 268       mutt_message ("%s %s/%s", progress->msg, posstr, progress->sizestr);
 269     else
 270       mutt_message ("%s %s", progress->msg, posstr);
 271   }
 272 }
 273
 274 void mutt_curses_message (const char *fmt, ...)
 275 {
 276   char TmpErrorbuf[STRING];
 277   va_list ap;
 278
 279   va_start (ap, fmt);
 280   vsnprintf (Errorbuf, sizeof (Errorbuf), fmt, ap);
 281   va_end (ap);
 282
 283   mutt_format_string (TmpErrorbuf, sizeof (TmpErrorbuf),
 284                       0, getmaxx(stdscr) - 2, 0, 0, Errorbuf, sizeof (Errorbuf), 0);
 285   snprintf (Errorbuf, sizeof (Errorbuf), "%s", TmpErrorbuf);    /* overkill */
 286
 287   if (!option (OPTKEEPQUIET)) {
 288     SETCOLOR(stdscr, MT_COLOR_MESSAGE);
 289     mvwaddstr (stdscr, LINES - 1, 0, Errorbuf);
 290     wclrtoeol (stdscr);
 291     SETCOLOR(stdscr, MT_COLOR_NORMAL);
 292     mutt_refresh ();
 293   }
 294
 295   unset_option (OPTMSGERR);
 296 }
 297
 298 void mutt_show_error (void)
 299 {
 300   if (option (OPTKEEPQUIET))
 301     return;
 302
 303   SETCOLOR(stdscr, option (OPTMSGERR) ? MT_COLOR_ERROR : MT_COLOR_MESSAGE);
 304   CLEARLINE(stdscr, LINES - 1);
 305   waddstr (stdscr, Errorbuf);
 306   SETCOLOR(stdscr, MT_COLOR_NORMAL);
 307 }
 308
 309 void curses_initialize(void)
 310 {
 311     ci_start_color();
 312     keypad(stdscr, true);
 313     cbreak();
 314     noecho();
 315     typeahead (-1);               /* simulate smooth scrolling */
 316     meta(stdscr, true);
 317 }
 318
 319 /*
 320  * prompts the user to enter a keystroke, and displays the octal value back
 321  * to the user.
 322  */
 323 void mutt_what_key (void)
 324 {
 325   int ch;
 326
 327   mvwprintw(stdscr, LINES - 1, 0, _("Enter keys (^G to abort): "));
 328   do {
 329     ch = getch();
 330     if (ch != ERR && ch != ctrl ('G')) {
 331       mutt_message (_("Char = %s, Octal = %o, Decimal = %d"),
 332                     km_keyname (ch), ch, ch);
 333     }
 334   }
 335   while (ch != ERR && ch != ctrl ('G'));
 336
 337   mutt_flushinp ();
 338 }
 339
 340 int mutt_any_key_to_continue (const char *s)
 341 {
 342   struct termios t;
 343   struct termios old;
 344   int f, ch;
 345
 346   f = open ("/dev/tty", O_RDONLY);
 347   tcgetattr (f, &t);
 348   memcpy ((void *) &old, (void *) &t, sizeof (struct termios)); /* save original state */
 349   t.c_lflag &= ~(ICANON | ECHO);
 350   t.c_cc[VMIN] = 1;
 351   t.c_cc[VTIME] = 0;
 352   tcsetattr (f, TCSADRAIN, &t);
 353   fflush (stdout);
 354   if (s)
 355     fputs (s, stdout);
 356   else
 357     fputs (_("Press any key to continue..."), stdout);
 358   fflush (stdout);
 359   ch = fgetc (stdin);
 360   fflush (stdin);
 361   tcsetattr (f, TCSADRAIN, &old);
 362   close (f);
 363   fputs ("\r\n", stdout);
 364   mutt_clear_error ();
 365   return (ch);
 366 }
 367
 368 int _mutt_enter_fname (const char *prompt, char *buf, ssize_t blen,
 369                        int *redraw, int buffy, int multiple, char ***files,
 370                        int *numfiles)
 371 {
 372   event_t ch;
 373
 374   mvwaddstr(stdscr, LINES - 1, 0, (char *) prompt);
 375   waddstr(stdscr, _(" ('?' for list): "));
 376   if (buf[0])
 377     waddstr (stdscr, buf);
 378   wclrtoeol (stdscr);
 379   mutt_refresh ();
 380
 381   ch = mutt_getch ();
 382   if (ch.ch == -1) {
 383     CLEARLINE(stdscr, LINES - 1);
 384     return (-1);
 385   }
 386   else if (ch.ch == '?') {
 387     mutt_refresh ();
 388     buf[0] = 0;
 389     mutt_select_file (buf, blen, M_SEL_FOLDER | (multiple ? M_SEL_MULTI : 0),
 390                       files, numfiles);
 391     *redraw = REDRAW_FULL;
 392   }
 393   else {
 394     char *pc = p_new(char, m_strlen(prompt) + 3);
 395
 396     sprintf(pc, "%s: ", prompt);
 397     mutt_ungetch (ch.op ? 0 : ch.ch, ch.op ? ch.op : 0);
 398     if (_mutt_get_field
 399         (pc, buf, blen, (buffy ? M_EFILE : M_FILE) | M_CLEAR, multiple, files,
 400          numfiles)
 401         != 0)
 402       buf[0] = 0;
 403     MAYBE_REDRAW (*redraw);
 404     p_delete(&pc);
 405   }
 406
 407   return 0;
 408 }
 409
 410 void mutt_ungetch (int ch, int op)
 411 {
 412   event_t tmp;
 413
 414   tmp.ch = ch;
 415   tmp.op = op;
 416
 417   if (UngetCount >= UngetBufLen)
 418     p_realloc(&KeyEvent, UngetBufLen += 128);
 419
 420   KeyEvent[UngetCount++] = tmp;
 421 }
 422
 423 void mutt_flushinp (void)
 424 {
 425   UngetCount = 0;
 426   flushinp ();
 427 }
 428
 429 /* The argument can take 3 values:
 430  * -1: restore the value of the last call
 431  *  0: make the cursor invisible
 432  *  1: make the cursor visible
 433  */
 434 void mutt_curs_set (int cursor)
 435 {
 436   static int SavedCursor = 1;
 437
 438   if (cursor < 0)
 439     cursor = SavedCursor;
 440   else
 441     SavedCursor = cursor;
 442
 443   if (curs_set (cursor) == ERR) {
 444     if (cursor == 1)            /* cnorm */
 445       curs_set (2);             /* cvvis */
 446   }
 447 }
 448
 449 int mutt_multi_choice (const char *prompt, const char *letters)
 450 {
 451   event_t ch;
 452   int choice;
 453   char *p;
 454
 455   mvwaddstr (stdscr, LINES - 1, 0, prompt);
 456   wclrtoeol (stdscr);
 457   for (;;) {
 458     mutt_refresh ();
 459     ch = mutt_getch ();
 460     if (ch.ch == -1 || CI_is_return (ch.ch)) {
 461       choice = -1;
 462       break;
 463     }
 464     else {
 465       p = strchr (letters, ch.ch);
 466       if (p) {
 467         choice = p - letters + 1;
 468         break;
 469       }
 470       else if (ch.ch <= '9' && ch.ch > '0') {
 471         choice = ch.ch - '0';
 472         if (choice <= m_strlen(letters))
 473           break;
 474       }
 475     }
 476     BEEP ();
 477   }
 478   CLEARLINE(stdscr, LINES - 1);
 479   mutt_refresh ();
 480   return choice;
 481 }
 482
 483 ssize_t mutt_pretty_size(char *s, ssize_t len, ssize_t n)
 484 {
 485     if (n == 0)
 486         return m_strcpy(s, len, "0K");
 487
 488     if (n < 10189)           /* 0.1K - 9.9K */
 489         return snprintf(s, len, "%3.1fK", (n < 103) ? 0.1 : n / 1024.0);
 490
 491     if (n < 1023949)         /* 10K - 999K */
 492         /* 51 is magic which causes 10189/10240 to be rounded up to 10 */
 493         return snprintf(s, len, "%ldK", (n + 51) / 1024);
 494
 495     if (n < 10433332)        /* 1.0M - 9.9M */
 496         return snprintf(s, len, "%3.1fM", n / 1048576.0);
 497
 498     /* (10433332 + 52428) / 1048576 = 10 */
 499     return snprintf (s, len, "%ldM", (n + 52428) / 1048576);
 500 }
 501
 502 /*
 503  * This formats a string, a bit like
 504  * snprintf (dest, destlen, "%-*.*s", min_width, max_width, s),
 505  * except that the widths refer to the number of character cells
 506  * when printed.
 507  */
 508
 509 void mutt_format_string (char *dest, ssize_t destlen,
 510                          int min_width, int max_width,
 511                          int right_justify, char m_pad_char,
 512                          const char *s, ssize_t n, int arboreal)
 513 {
 514   char *p;
 515   wchar_t wc;
 516   int w;
 517   ssize_t k, k2;
 518   char scratch[MB_LEN_MAX];
 519   mbstate_t mbstate1, mbstate2;
 520
 521   p_clear(&mbstate1, 1);
 522   p_clear(&mbstate2, 1);
 523   --destlen;
 524   p = dest;
 525   for (; n && (k = mbrtowc (&wc, s, n, &mbstate1)); s += k, n -= k) {
 526     if (k == -1 || k == -2) {
 527       k = (k == -1) ? 1 : n;
 528       wc = CharsetReplacement;
 529     }
 530     if (arboreal && wc < M_TREE_MAX)
 531       w = 1;                    /* hack */
 532     else {
 533       if (!iswprint(wc))
 534         wc = '?';
 535       w = wcwidth (wc);
 536     }
 537     if (w >= 0) {
 538       if (w > max_width || (k2 = wcrtomb (scratch, wc, &mbstate2)) > destlen)
 539         break;
 540       min_width -= w;
 541       max_width -= w;
 542       m_strncpy(p, destlen, scratch, k2);
 543       p += k2;
 544       destlen -= k2;
 545     }
 546   }
 547   w = destlen < min_width ? destlen : min_width;
 548   if (w <= 0)
 549     *p = '\0';
 550   else if (right_justify) {
 551     p[w] = '\0';
 552     while (--p >= dest)
 553       p[w] = *p;
 554     while (--w >= 0)
 555       dest[w] = m_pad_char;
 556   }
 557   else {
 558     while (--w >= 0)
 559       *p++ = m_pad_char;
 560     *p = '\0';
 561   }
 562 }
 563
 564 /*
 565  * This formats a string rather like
 566  *   snprintf (fmt, sizeof (fmt), "%%%ss", prefix);
 567  *   snprintf (dest, destlen, fmt, s);
 568  * except that the numbers in the conversion specification refer to
 569  * the number of character cells when printed.
 570  */
 571
 572 static void mutt_format_s_x (char *dest, ssize_t destlen,
 573                              const char *prefix, const char *s, int arboreal)
 574 {
 575   int right_justify = 1;
 576   char *p;
 577   int min_width;
 578   int max_width = INT_MAX;
 579
 580   if (*prefix == '-')
 581     ++prefix, right_justify = 0;
 582   min_width = strtol (prefix, &p, 10);
 583   if (*p == '.') {
 584     prefix = p + 1;
 585     max_width = strtol (prefix, &p, 10);
 586     if (p <= prefix)
 587       max_width = INT_MAX;
 588   }
 589
 590   mutt_format_string (dest, destlen, min_width, max_width,
 591                       right_justify, ' ', s, m_strlen(s), arboreal);
 592 }
 593
 594 void mutt_format_s (char *dest, ssize_t destlen,
 595                     const char *prefix, const char *s)
 596 {
 597   mutt_format_s_x (dest, destlen, prefix, s, 0);
 598 }
 599
 600 void mutt_format_s_tree (char *dest, ssize_t destlen,
 601                          const char *prefix, const char *s)
 602 {
 603   mutt_format_s_x (dest, destlen, prefix, s, 1);
 604 }
 605
 606 /*
 607  * mutt_paddstr (n, s) is almost equivalent to
 608  * mutt_format_string (bigbuf, big, n, n, 0, ' ', s, big, 0), waddstr (main_w, bigbuf)
 609  */
 610
 611 void mutt_paddstr(WINDOW *win, int n, const char *s)
 612 {
 613   wchar_t wc;
 614   int w;
 615   ssize_t k;
 616   ssize_t len = m_strlen(s);
 617   mbstate_t mbstate;
 618
 619   p_clear(&mbstate, 1);
 620   for (; len && (k = mbrtowc (&wc, s, len, &mbstate)); s += k, len -= k) {
 621     if (k == -1 || k == -2) {
 622       k = (k == -1) ? 1 : len;
 623       wc = CharsetReplacement;
 624     }
 625     if (!iswprint(wc))
 626       wc = '?';
 627     w = wcwidth (wc);
 628     if (w >= 0) {
 629       if (w > n)
 630         break;
 631       waddnstr(win, (char *) s, k);
 632       n -= w;
 633     }
 634   }
 635   while (n-- > 0)
 636     waddch(win, ' ');
 637 }