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     if (initscr () == NULL) {
 312         puts _("Error initializing terminal.");
 313         exit (1);
 314     }
 315     ci_start_color();
 316     keypad(stdscr, true);
 317     cbreak();
 318     noecho();
 319     typeahead (-1);               /* simulate smooth scrolling */
 320     meta(stdscr, true);
 321 }
 322
 323 /*
 324  * prompts the user to enter a keystroke, and displays the octal value back
 325  * to the user.
 326  */
 327 void mutt_what_key (void)
 328 {
 329   int ch;
 330
 331   mvwprintw(stdscr, LINES - 1, 0, _("Enter keys (^G to abort): "));
 332   do {
 333     ch = getch();
 334     if (ch != ERR && ch != ctrl ('G')) {
 335       mutt_message (_("Char = %s, Octal = %o, Decimal = %d"),
 336                     km_keyname (ch), ch, ch);
 337     }
 338   }
 339   while (ch != ERR && ch != ctrl ('G'));
 340
 341   mutt_flushinp ();
 342 }
 343
 344 int mutt_any_key_to_continue (const char *s)
 345 {
 346   struct termios t;
 347   struct termios old;
 348   int f, ch;
 349
 350   f = open ("/dev/tty", O_RDONLY);
 351   tcgetattr (f, &t);
 352   memcpy ((void *) &old, (void *) &t, sizeof (struct termios)); /* save original state */
 353   t.c_lflag &= ~(ICANON | ECHO);
 354   t.c_cc[VMIN] = 1;
 355   t.c_cc[VTIME] = 0;
 356   tcsetattr (f, TCSADRAIN, &t);
 357   fflush (stdout);
 358   if (s)
 359     fputs (s, stdout);
 360   else
 361     fputs (_("Press any key to continue..."), stdout);
 362   fflush (stdout);
 363   ch = fgetc (stdin);
 364   fflush (stdin);
 365   tcsetattr (f, TCSADRAIN, &old);
 366   close (f);
 367   fputs ("\r\n", stdout);
 368   mutt_clear_error ();
 369   return (ch);
 370 }
 371
 372 int _mutt_enter_fname (const char *prompt, char *buf, ssize_t blen,
 373                        int *redraw, int buffy, int multiple, char ***files,
 374                        int *numfiles)
 375 {
 376   event_t ch;
 377
 378   mvwaddstr(stdscr, LINES - 1, 0, (char *) prompt);
 379   waddstr(stdscr, _(" ('?' for list): "));
 380   if (buf[0])
 381     waddstr (stdscr, buf);
 382   wclrtoeol (stdscr);
 383   mutt_refresh ();
 384
 385   ch = mutt_getch ();
 386   if (ch.ch == -1) {
 387     CLEARLINE(stdscr, LINES - 1);
 388     return (-1);
 389   }
 390   else if (ch.ch == '?') {
 391     mutt_refresh ();
 392     buf[0] = 0;
 393     mutt_select_file (buf, blen, M_SEL_FOLDER | (multiple ? M_SEL_MULTI : 0),
 394                       files, numfiles);
 395     *redraw = REDRAW_FULL;
 396   }
 397   else {
 398     char *pc = p_new(char, m_strlen(prompt) + 3);
 399
 400     sprintf(pc, "%s: ", prompt);
 401     mutt_ungetch (ch.op ? 0 : ch.ch, ch.op ? ch.op : 0);
 402     if (_mutt_get_field
 403         (pc, buf, blen, (buffy ? M_EFILE : M_FILE) | M_CLEAR, multiple, files,
 404          numfiles)
 405         != 0)
 406       buf[0] = 0;
 407     MAYBE_REDRAW (*redraw);
 408     p_delete(&pc);
 409   }
 410
 411   return 0;
 412 }
 413
 414 void mutt_ungetch (int ch, int op)
 415 {
 416   event_t tmp;
 417
 418   tmp.ch = ch;
 419   tmp.op = op;
 420
 421   if (UngetCount >= UngetBufLen)
 422     p_realloc(&KeyEvent, UngetBufLen += 128);
 423
 424   KeyEvent[UngetCount++] = tmp;
 425 }
 426
 427 void mutt_flushinp (void)
 428 {
 429   UngetCount = 0;
 430   flushinp ();
 431 }
 432
 433 /* The argument can take 3 values:
 434  * -1: restore the value of the last call
 435  *  0: make the cursor invisible
 436  *  1: make the cursor visible
 437  */
 438 void mutt_curs_set (int cursor)
 439 {
 440   static int SavedCursor = 1;
 441
 442   if (cursor < 0)
 443     cursor = SavedCursor;
 444   else
 445     SavedCursor = cursor;
 446
 447   if (curs_set (cursor) == ERR) {
 448     if (cursor == 1)            /* cnorm */
 449       curs_set (2);             /* cvvis */
 450   }
 451 }
 452
 453 int mutt_multi_choice (const char *prompt, const char *letters)
 454 {
 455   event_t ch;
 456   int choice;
 457   char *p;
 458
 459   mvwaddstr (stdscr, LINES - 1, 0, prompt);
 460   wclrtoeol (stdscr);
 461   for (;;) {
 462     mutt_refresh ();
 463     ch = mutt_getch ();
 464     if (ch.ch == -1 || CI_is_return (ch.ch)) {
 465       choice = -1;
 466       break;
 467     }
 468     else {
 469       p = strchr (letters, ch.ch);
 470       if (p) {
 471         choice = p - letters + 1;
 472         break;
 473       }
 474       else if (ch.ch <= '9' && ch.ch > '0') {
 475         choice = ch.ch - '0';
 476         if (choice <= m_strlen(letters))
 477           break;
 478       }
 479     }
 480     BEEP ();
 481   }
 482   CLEARLINE(stdscr, LINES - 1);
 483   mutt_refresh ();
 484   return choice;
 485 }
 486
 487 ssize_t mutt_pretty_size(char *s, ssize_t len, ssize_t n)
 488 {
 489     if (n == 0)
 490         return m_strcpy(s, len, "0K");
 491
 492     if (n < 10189)           /* 0.1K - 9.9K */
 493         return snprintf(s, len, "%3.1fK", (n < 103) ? 0.1 : n / 1024.0);
 494
 495     if (n < 1023949)         /* 10K - 999K */
 496         /* 51 is magic which causes 10189/10240 to be rounded up to 10 */
 497         return snprintf(s, len, "%ldK", (n + 51) / 1024);
 498
 499     if (n < 10433332)        /* 1.0M - 9.9M */
 500         return snprintf(s, len, "%3.1fM", n / 1048576.0);
 501
 502     /* (10433332 + 52428) / 1048576 = 10 */
 503     return snprintf (s, len, "%ldM", (n + 52428) / 1048576);
 504 }
 505
 506 /*
 507  * This formats a string, a bit like
 508  * snprintf (dest, destlen, "%-*.*s", min_width, max_width, s),
 509  * except that the widths refer to the number of character cells
 510  * when printed.
 511  */
 512
 513 void mutt_format_string (char *dest, ssize_t destlen,
 514                          int min_width, int max_width,
 515                          int right_justify, char m_pad_char,
 516                          const char *s, ssize_t n, int arboreal)
 517 {
 518   char *p;
 519   wchar_t wc;
 520   int w;
 521   ssize_t k, k2;
 522   char scratch[MB_LEN_MAX];
 523   mbstate_t mbstate1, mbstate2;
 524
 525   p_clear(&mbstate1, 1);
 526   p_clear(&mbstate2, 1);
 527   --destlen;
 528   p = dest;
 529   for (; n && (k = mbrtowc (&wc, s, n, &mbstate1)); s += k, n -= k) {
 530     if (k == -1 || k == -2) {
 531       k = (k == -1) ? 1 : n;
 532       wc = CharsetReplacement;
 533     }
 534     if (arboreal && wc < M_TREE_MAX)
 535       w = 1;                    /* hack */
 536     else {
 537       if (!iswprint(wc))
 538         wc = '?';
 539       w = wcwidth (wc);
 540     }
 541     if (w >= 0) {
 542       if (w > max_width || (k2 = wcrtomb (scratch, wc, &mbstate2)) > destlen)
 543         break;
 544       min_width -= w;
 545       max_width -= w;
 546       m_strncpy(p, destlen, scratch, k2);
 547       p += k2;
 548       destlen -= k2;
 549     }
 550   }
 551   w = destlen < min_width ? destlen : min_width;
 552   if (w <= 0)
 553     *p = '\0';
 554   else if (right_justify) {
 555     p[w] = '\0';
 556     while (--p >= dest)
 557       p[w] = *p;
 558     while (--w >= 0)
 559       dest[w] = m_pad_char;
 560   }
 561   else {
 562     while (--w >= 0)
 563       *p++ = m_pad_char;
 564     *p = '\0';
 565   }
 566 }
 567
 568 /*
 569  * This formats a string rather like
 570  *   snprintf (fmt, sizeof (fmt), "%%%ss", prefix);
 571  *   snprintf (dest, destlen, fmt, s);
 572  * except that the numbers in the conversion specification refer to
 573  * the number of character cells when printed.
 574  */
 575
 576 static void mutt_format_s_x (char *dest, ssize_t destlen,
 577                              const char *prefix, const char *s, int arboreal)
 578 {
 579   int right_justify = 1;
 580   char *p;
 581   int min_width;
 582   int max_width = INT_MAX;
 583
 584   if (*prefix == '-')
 585     ++prefix, right_justify = 0;
 586   min_width = strtol (prefix, &p, 10);
 587   if (*p == '.') {
 588     prefix = p + 1;
 589     max_width = strtol (prefix, &p, 10);
 590     if (p <= prefix)
 591       max_width = INT_MAX;
 592   }
 593
 594   mutt_format_string (dest, destlen, min_width, max_width,
 595                       right_justify, ' ', s, m_strlen(s), arboreal);
 596 }
 597
 598 void mutt_format_s (char *dest, ssize_t destlen,
 599                     const char *prefix, const char *s)
 600 {
 601   mutt_format_s_x (dest, destlen, prefix, s, 0);
 602 }
 603
 604 void mutt_format_s_tree (char *dest, ssize_t destlen,
 605                          const char *prefix, const char *s)
 606 {
 607   mutt_format_s_x (dest, destlen, prefix, s, 1);
 608 }
 609
 610 /*
 611  * mutt_paddstr (n, s) is almost equivalent to
 612  * mutt_format_string (bigbuf, big, n, n, 0, ' ', s, big, 0), waddstr (main_w, bigbuf)
 613  */
 614
 615 void mutt_paddstr(WINDOW *win, int n, const char *s)
 616 {
 617   wchar_t wc;
 618   int w;
 619   ssize_t k;
 620   ssize_t len = m_strlen(s);
 621   mbstate_t mbstate;
 622
 623   p_clear(&mbstate, 1);
 624   for (; len && (k = mbrtowc (&wc, s, len, &mbstate)); s += k, len -= k) {
 625     if (k == -1 || k == -2) {
 626       k = (k == -1) ? 1 : len;
 627       wc = CharsetReplacement;
 628     }
 629     if (!iswprint(wc))
 630       wc = '?';
 631     w = wcwidth (wc);
 632     if (w >= 0) {
 633       if (w > n)
 634         break;
 635       waddnstr(win, (char *) s, k);
 636       n -= w;
 637     }
 638   }
 639   while (n-- > 0)
 640     waddch(win, ' ');
 641 }