lib/widget/listbox.c

   1 /*
   2    Widgets for the Midnight Commander
   3
   4    Copyright (C) 1994-2016
   5    Free Software Foundation, Inc.
   6
   7    Authors:
   8    Radek Doulik, 1994, 1995
   9    Miguel de Icaza, 1994, 1995
  10    Jakub Jelinek, 1995
  11    Andrej Borsenkow, 1996
  12    Norbert Warmuth, 1997
  13    Andrew Borodin <aborodin@vmail.ru>, 2009, 2010, 2013, 2016
  14
  15    This file is part of the Midnight Commander.
  16
  17    The Midnight Commander is free software: you can redistribute it
  18    and/or modify it under the terms of the GNU General Public License as
  19    published by the Free Software Foundation, either version 3 of the License,
  20    or (at your option) any later version.
  21
  22    The Midnight Commander is distributed in the hope that it will be useful,
  23    but WITHOUT ANY WARRANTY; without even the implied warranty of
  24    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25    GNU General Public License for more details.
  26
  27    You should have received a copy of the GNU General Public License
  28    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  29  */
  30
  31 /** \file listbox.c
  32  *  \brief Source: WListbox widget
  33  */
  34
  35 #include <config.h>
  36
  37 #include <stdlib.h>
  38
  39 #include "lib/global.h"
  40
  41 #include "lib/tty/tty.h"
  42 #include "lib/skin.h"
  43 #include "lib/strutil.h"
  44 #include "lib/util.h"           /* Q_() */
  45 #include "lib/keybind.h"        /* global_keymap_t */
  46 #include "lib/widget.h"
  47
  48 /*** global variables ****************************************************************************/
  49
  50 const global_keymap_t *listbox_map = NULL;
  51
  52 /*** file scope macro definitions ****************************************************************/
  53
  54 /* Gives the position of the last item. */
  55 #define LISTBOX_LAST(l) (listbox_is_empty (l) ? 0 : (int) g_queue_get_length ((l)->list) - 1)
  56
  57 /*** file scope type declarations ****************************************************************/
  58
  59 /*** file scope variables ************************************************************************/
  60
  61 /*** file scope functions ************************************************************************/
  62
  63 static int
  64 listbox_entry_cmp (const void *a, const void *b, void *user_data)
  65 {
  66     const WLEntry *ea = (const WLEntry *) a;
  67     const WLEntry *eb = (const WLEntry *) b;
  68
  69     (void) user_data;
  70
  71     return strcmp (ea->text, eb->text);
  72 }
  73
  74 /* --------------------------------------------------------------------------------------------- */
  75
  76 static void
  77 listbox_entry_free (void *data)
  78 {
  79     WLEntry *e = data;
  80
  81     g_free (e->text);
  82     if (e->free_data)
  83         g_free (e->data);
  84     g_free (e);
  85 }
  86
  87 /* --------------------------------------------------------------------------------------------- */
  88
  89 static void
  90 listbox_drawscroll (WListbox * l)
  91 {
  92     Widget *w = WIDGET (l);
  93     int max_line = w->lines - 1;
  94     int line = 0;
  95     int i;
  96     int length;
  97
  98     /* Are we at the top? */
  99     widget_move (w, 0, w->cols);
 100     if (l->top == 0)
 101         tty_print_one_vline (TRUE);
 102     else
 103         tty_print_char ('^');
 104
 105     length = g_queue_get_length (l->list);
 106
 107     /* Are we at the bottom? */
 108     widget_move (w, max_line, w->cols);
 109     if (l->top + w->lines == length || w->lines >= length)
 110         tty_print_one_vline (TRUE);
 111     else
 112         tty_print_char ('v');
 113
 114     /* Now draw the nice relative pointer */
 115     if (!g_queue_is_empty (l->list))
 116         line = 1 + ((l->pos * (w->lines - 2)) / length);
 117
 118     for (i = 1; i < max_line; i++)
 119     {
 120         widget_move (w, i, w->cols);
 121         if (i != line)
 122             tty_print_one_vline (TRUE);
 123         else
 124             tty_print_char ('*');
 125     }
 126 }
 127
 128 /* --------------------------------------------------------------------------------------------- */
 129
 130 static void
 131 listbox_draw (WListbox * l, gboolean focused)
 132 {
 133     Widget *w = WIDGET (l);
 134     const WDialog *h = w->owner;
 135     gboolean disabled;
 136     int normalc, selc;
 137     int length = 0;
 138     GList *le = NULL;
 139     int pos;
 140     int i;
 141     int sel_line = -1;
 142
 143     disabled = widget_get_state (w, WST_DISABLED);
 144     normalc = disabled ? DISABLED_COLOR : h->color[DLG_COLOR_NORMAL];
 145     /* *INDENT-OFF* */
 146     selc = disabled
 147         ? DISABLED_COLOR
 148         : focused
 149             ? h->color[DLG_COLOR_HOT_FOCUS]
 150             : h->color[DLG_COLOR_FOCUS];
 151     /* *INDENT-ON* */
 152
 153     if (l->list != NULL)
 154     {
 155         length = g_queue_get_length (l->list);
 156         le = g_queue_peek_nth_link (l->list, (guint) l->top);
 157     }
 158
 159     /*    pos = (le == NULL) ? 0 : g_list_position (l->list, le); */
 160     pos = (le == NULL) ? 0 : l->top;
 161
 162     for (i = 0; i < w->lines; i++)
 163     {
 164         const char *text = "";
 165
 166         /* Display the entry */
 167         if (pos == l->pos && sel_line == -1)
 168         {
 169             sel_line = i;
 170             tty_setcolor (selc);
 171         }
 172         else
 173             tty_setcolor (normalc);
 174
 175         widget_move (l, i, 1);
 176
 177         if (l->list != NULL && le != NULL && (i == 0 || pos < length))
 178         {
 179             WLEntry *e = LENTRY (le->data);
 180
 181             text = e->text;
 182             le = g_list_next (le);
 183             pos++;
 184         }
 185
 186         tty_print_string (str_fit_to_term (text, w->cols - 2, J_LEFT_FIT));
 187     }
 188
 189     l->cursor_y = sel_line;
 190
 191     if (l->scrollbar && length > w->lines)
 192     {
 193         tty_setcolor (normalc);
 194         listbox_drawscroll (l);
 195     }
 196 }
 197
 198 /* --------------------------------------------------------------------------------------------- */
 199
 200 static int
 201 listbox_check_hotkey (WListbox * l, int key)
 202 {
 203     if (!listbox_is_empty (l))
 204     {
 205         int i;
 206         GList *le;
 207
 208         for (i = 0, le = g_queue_peek_head_link (l->list); le != NULL; i++, le = g_list_next (le))
 209         {
 210             WLEntry *e = LENTRY (le->data);
 211
 212             if (e->hotkey == key)
 213                 return i;
 214         }
 215     }
 216
 217     return (-1);
 218 }
 219
 220 /* --------------------------------------------------------------------------------------------- */
 221
 222 /* Calculates the item displayed at screen row 'y' (y==0 being the widget's 1st row). */
 223 static int
 224 listbox_y_pos (WListbox * l, int y)
 225 {
 226     return MIN (l->top + y, LISTBOX_LAST (l));
 227 }
 228
 229 /* --------------------------------------------------------------------------------------------- */
 230
 231 static void
 232 listbox_fwd (WListbox * l, gboolean wrap)
 233 {
 234     if (!listbox_is_empty (l))
 235     {
 236         if ((guint) l->pos + 1 < g_queue_get_length (l->list))
 237             listbox_select_entry (l, l->pos + 1);
 238         else if (wrap)
 239             listbox_select_first (l);
 240     }
 241 }
 242
 243 /* --------------------------------------------------------------------------------------------- */
 244
 245 static void
 246 listbox_fwd_n (WListbox * l, int n)
 247 {
 248     listbox_select_entry (l, MIN (l->pos + n, LISTBOX_LAST (l)));
 249 }
 250
 251 /* --------------------------------------------------------------------------------------------- */
 252
 253 static void
 254 listbox_back (WListbox * l, gboolean wrap)
 255 {
 256     if (!listbox_is_empty (l))
 257     {
 258         if (l->pos > 0)
 259             listbox_select_entry (l, l->pos - 1);
 260         else if (wrap)
 261             listbox_select_last (l);
 262     }
 263 }
 264
 265 /* --------------------------------------------------------------------------------------------- */
 266
 267 static void
 268 listbox_back_n (WListbox * l, int n)
 269 {
 270     listbox_select_entry (l, MAX (l->pos - n, 0));
 271 }
 272
 273 /* --------------------------------------------------------------------------------------------- */
 274
 275 static cb_ret_t
 276 listbox_execute_cmd (WListbox * l, long command)
 277 {
 278     cb_ret_t ret = MSG_HANDLED;
 279     Widget *w = WIDGET (l);
 280
 281     if (l->list == NULL || g_queue_is_empty (l->list))
 282         return MSG_NOT_HANDLED;
 283
 284     switch (command)
 285     {
 286     case CK_Up:
 287         listbox_back (l, TRUE);
 288         break;
 289     case CK_Down:
 290         listbox_fwd (l, TRUE);
 291         break;
 292     case CK_Top:
 293         listbox_select_first (l);
 294         break;
 295     case CK_Bottom:
 296         listbox_select_last (l);
 297         break;
 298     case CK_PageUp:
 299         listbox_back_n (l, w->lines - 1);
 300         break;
 301     case CK_PageDown:
 302         listbox_fwd_n (l, w->lines - 1);
 303         break;
 304     case CK_Delete:
 305         if (l->deletable)
 306         {
 307             gboolean is_last, is_more;
 308             int length;
 309
 310             length = g_queue_get_length (l->list);
 311
 312             is_last = (l->pos + 1 >= length);
 313             is_more = (l->top + w->lines >= length);
 314
 315             listbox_remove_current (l);
 316             if ((l->top > 0) && (is_last || is_more))
 317                 l->top--;
 318         }
 319         break;
 320     case CK_Clear:
 321         if (l->deletable && mc_global.widget.confirm_history_cleanup
 322             /* TRANSLATORS: no need to translate 'DialogTitle', it's just a context prefix */
 323             && (query_dialog (Q_ ("DialogTitle|History cleanup"),
 324                               _("Do you want clean this history?"),
 325                               D_ERROR, 2, _("&Yes"), _("&No")) == 0))
 326             listbox_remove_list (l);
 327         break;
 328     default:
 329         ret = MSG_NOT_HANDLED;
 330     }
 331
 332     return ret;
 333 }
 334
 335 /* --------------------------------------------------------------------------------------------- */
 336
 337 /* Return MSG_HANDLED if we want a redraw */
 338 static cb_ret_t
 339 listbox_key (WListbox * l, int key)
 340 {
 341     long command;
 342
 343     if (l->list == NULL)
 344         return MSG_NOT_HANDLED;
 345
 346     /* focus on listbox item N by '0'..'9' keys */
 347     if (key >= '0' && key <= '9')
 348     {
 349         listbox_select_entry (l, key - '0');
 350         return MSG_HANDLED;
 351     }
 352
 353     command = keybind_lookup_keymap_command (listbox_map, key);
 354     if (command == CK_IgnoreKey)
 355         return MSG_NOT_HANDLED;
 356     return listbox_execute_cmd (l, command);
 357 }
 358
 359 /* --------------------------------------------------------------------------------------------- */
 360
 361 /* Listbox item adding function */
 362 static inline void
 363 listbox_append_item (WListbox * l, WLEntry * e, listbox_append_t pos)
 364 {
 365     if (l->list == NULL)
 366     {
 367         l->list = g_queue_new ();
 368         pos = LISTBOX_APPEND_AT_END;
 369     }
 370
 371     switch (pos)
 372     {
 373     case LISTBOX_APPEND_AT_END:
 374         g_queue_push_tail (l->list, e);
 375         break;
 376
 377     case LISTBOX_APPEND_BEFORE:
 378         g_queue_insert_before (l->list, g_queue_peek_nth_link (l->list, (guint) l->pos), e);
 379         break;
 380
 381     case LISTBOX_APPEND_AFTER:
 382         g_queue_insert_after (l->list, g_queue_peek_nth_link (l->list, (guint) l->pos), e);
 383         break;
 384
 385     case LISTBOX_APPEND_SORTED:
 386         g_queue_insert_sorted (l->list, e, (GCompareDataFunc) listbox_entry_cmp, NULL);
 387         break;
 388
 389     default:
 390         break;
 391     }
 392 }
 393
 394 /* --------------------------------------------------------------------------------------------- */
 395
 396 /* Call this whenever the user changes the selected item. */
 397 static void
 398 listbox_on_change (WListbox * l)
 399 {
 400     listbox_draw (l, TRUE);
 401     send_message (WIDGET (l)->owner, l, MSG_NOTIFY, l->pos, NULL);
 402 }
 403
 404 /* --------------------------------------------------------------------------------------------- */
 405
 406 static void
 407 listbox_do_action (WListbox * l)
 408 {
 409     int action;
 410
 411     if (listbox_is_empty (l))
 412         return;
 413
 414     if (l->callback != NULL)
 415         action = l->callback (l);
 416     else
 417         action = LISTBOX_DONE;
 418
 419     if (action == LISTBOX_DONE)
 420     {
 421         WDialog *h = WIDGET (l)->owner;
 422
 423         h->ret_value = B_ENTER;
 424         dlg_stop (h);
 425     }
 426 }
 427
 428 /* --------------------------------------------------------------------------------------------- */
 429
 430 static void
 431 listbox_run_hotkey (WListbox * l, int pos)
 432 {
 433     listbox_select_entry (l, pos);
 434     listbox_on_change (l);
 435     listbox_do_action (l);
 436 }
 437
 438 /* --------------------------------------------------------------------------------------------- */
 439
 440 static inline void
 441 listbox_destroy (WListbox * l)
 442 {
 443     listbox_remove_list (l);
 444 }
 445
 446 /* --------------------------------------------------------------------------------------------- */
 447
 448 static cb_ret_t
 449 listbox_callback (Widget * w, Widget * sender, widget_msg_t msg, int parm, void *data)
 450 {
 451     WListbox *l = LISTBOX (w);
 452     cb_ret_t ret_code;
 453
 454     switch (msg)
 455     {
 456     case MSG_INIT:
 457         return MSG_HANDLED;
 458
 459     case MSG_HOTKEY:
 460         {
 461             int pos;
 462
 463             pos = listbox_check_hotkey (l, parm);
 464             if (pos < 0)
 465                 return MSG_NOT_HANDLED;
 466
 467             listbox_run_hotkey (l, pos);
 468
 469             return MSG_HANDLED;
 470         }
 471
 472     case MSG_KEY:
 473         ret_code = listbox_key (l, parm);
 474         if (ret_code != MSG_NOT_HANDLED)
 475             listbox_on_change (l);
 476         return ret_code;
 477
 478     case MSG_ACTION:
 479         return listbox_execute_cmd (l, parm);
 480
 481     case MSG_CURSOR:
 482         widget_move (l, l->cursor_y, 0);
 483         return MSG_HANDLED;
 484
 485     case MSG_FOCUS:
 486     case MSG_UNFOCUS:
 487         l->focused = msg == MSG_FOCUS;
 488         /* fall through */
 489     case MSG_DRAW:
 490         listbox_draw (l, l->focused);
 491         return MSG_HANDLED;
 492
 493     case MSG_DESTROY:
 494         listbox_destroy (l);
 495         return MSG_HANDLED;
 496
 497     case MSG_RESIZE:
 498         return MSG_HANDLED;
 499
 500     default:
 501         return widget_default_callback (w, sender, msg, parm, data);
 502     }
 503 }
 504
 505 /* --------------------------------------------------------------------------------------------- */
 506
 507 static void
 508 listbox_mouse_callback (Widget * w, mouse_msg_t msg, mouse_event_t * event)
 509 {
 510     WListbox *l = LISTBOX (w);
 511     int old_pos;
 512
 513     old_pos = l->pos;
 514
 515     switch (msg)
 516     {
 517     case MSG_MOUSE_DOWN:
 518         dlg_select_widget (l);
 519         listbox_select_entry (l, listbox_y_pos (l, event->y));
 520         break;
 521
 522     case MSG_MOUSE_SCROLL_UP:
 523         listbox_back (l, FALSE);
 524         break;
 525
 526     case MSG_MOUSE_SCROLL_DOWN:
 527         listbox_fwd (l, FALSE);
 528         break;
 529
 530     case MSG_MOUSE_DRAG:
 531         event->result.repeat = TRUE;    /* It'd be functional even without this. */
 532         listbox_select_entry (l, listbox_y_pos (l, event->y));
 533         break;
 534
 535     case MSG_MOUSE_CLICK:
 536         /* We don't call listbox_select_entry() here: MSG_MOUSE_DOWN/DRAG did this already. */
 537         if (event->count == GPM_DOUBLE) /* Double click */
 538             listbox_do_action (l);
 539         break;
 540
 541     default:
 542         break;
 543     }
 544
 545     /* If the selection has changed, we redraw the widget and notify the dialog. */
 546     if (l->pos != old_pos)
 547         listbox_on_change (l);
 548 }
 549
 550 /* --------------------------------------------------------------------------------------------- */
 551 /*** public functions ****************************************************************************/
 552 /* --------------------------------------------------------------------------------------------- */
 553
 554 WListbox *
 555 listbox_new (int y, int x, int height, int width, gboolean deletable, lcback_fn callback)
 556 {
 557     WListbox *l;
 558     Widget *w;
 559
 560     if (height <= 0)
 561         height = 1;
 562
 563     l = g_new (WListbox, 1);
 564     w = WIDGET (l);
 565     widget_init (w, y, x, height, width, listbox_callback, listbox_mouse_callback);
 566
 567     l->list = NULL;
 568     l->top = l->pos = 0;
 569     l->deletable = deletable;
 570     l->callback = callback;
 571     l->allow_duplicates = TRUE;
 572     l->scrollbar = !mc_global.tty.slow_terminal;
 573     l->focused = FALSE;
 574     widget_want_hotkey (w, TRUE);
 575
 576     return l;
 577 }
 578
 579 /* --------------------------------------------------------------------------------------------- */
 580
 581 int
 582 listbox_search_text (WListbox * l, const char *text)
 583 {
 584     if (!listbox_is_empty (l))
 585     {
 586         int i;
 587         GList *le;
 588
 589         for (i = 0, le = g_queue_peek_head_link (l->list); le != NULL; i++, le = g_list_next (le))
 590         {
 591             WLEntry *e = LENTRY (le->data);
 592
 593             if (strcmp (e->text, text) == 0)
 594                 return i;
 595         }
 596     }
 597
 598     return (-1);
 599 }
 600
 601 /* --------------------------------------------------------------------------------------------- */
 602
 603 /* Selects the first entry and scrolls the list to the top */
 604 void
 605 listbox_select_first (WListbox * l)
 606 {
 607     l->pos = l->top = 0;
 608 }
 609
 610 /* --------------------------------------------------------------------------------------------- */
 611
 612 /* Selects the last entry and scrolls the list to the bottom */
 613 void
 614 listbox_select_last (WListbox * l)
 615 {
 616     int lines = WIDGET (l)->lines;
 617     int length = 0;
 618
 619     if (!listbox_is_empty (l))
 620         length = g_queue_get_length (l->list);
 621
 622     l->pos = length > 0 ? length - 1 : 0;
 623     l->top = length > lines ? length - lines : 0;
 624 }
 625
 626 /* --------------------------------------------------------------------------------------------- */
 627
 628 void
 629 listbox_select_entry (WListbox * l, int dest)
 630 {
 631     GList *le;
 632     int pos;
 633     gboolean top_seen = FALSE;
 634
 635     if (listbox_is_empty (l) || dest < 0)
 636         return;
 637
 638     /* Special case */
 639     for (pos = 0, le = g_queue_peek_head_link (l->list); le != NULL; pos++, le = g_list_next (le))
 640     {
 641         if (pos == l->top)
 642             top_seen = TRUE;
 643
 644         if (pos == dest)
 645         {
 646             l->pos = dest;
 647             if (!top_seen)
 648                 l->top = l->pos;
 649             else
 650             {
 651                 int lines = WIDGET (l)->lines;
 652
 653                 if (l->pos - l->top >= lines)
 654                     l->top = l->pos - lines + 1;
 655             }
 656             return;
 657         }
 658     }
 659
 660     /* If we are unable to find it, set decent values */
 661     l->pos = l->top = 0;
 662 }
 663
 664 /* --------------------------------------------------------------------------------------------- */
 665
 666 /* Returns the current string text as well as the associated extra data */
 667 void
 668 listbox_get_current (WListbox * l, char **string, void **extra)
 669 {
 670     WLEntry *e = NULL;
 671     gboolean ok;
 672
 673     if (l != NULL)
 674         e = listbox_get_nth_item (l, l->pos);
 675
 676     ok = (e != NULL);
 677
 678     if (string != NULL)
 679         *string = ok ? e->text : NULL;
 680
 681     if (extra != NULL)
 682         *extra = ok ? e->data : NULL;
 683 }
 684
 685 /* --------------------------------------------------------------------------------------------- */
 686
 687 WLEntry *
 688 listbox_get_nth_item (const WListbox * l, int pos)
 689 {
 690     if (!listbox_is_empty (l) && pos >= 0)
 691     {
 692         GList *item;
 693
 694         item = g_queue_peek_nth_link (l->list, (guint) pos);
 695         if (item != NULL)
 696             return LENTRY (item->data);
 697     }
 698
 699     return NULL;
 700 }
 701
 702 /* --------------------------------------------------------------------------------------------- */
 703
 704 GList *
 705 listbox_get_first_link (const WListbox * l)
 706 {
 707     return (l == NULL || l->list == NULL) ? NULL : g_queue_peek_head_link (l->list);
 708 }
 709
 710 /* --------------------------------------------------------------------------------------------- */
 711
 712 void
 713 listbox_remove_current (WListbox * l)
 714 {
 715     if (!listbox_is_empty (l))
 716     {
 717         GList *current;
 718         int length;
 719
 720         current = g_queue_peek_nth_link (l->list, (guint) l->pos);
 721         listbox_entry_free (LENTRY (current->data));
 722         g_queue_delete_link (l->list, current);
 723
 724         length = g_queue_get_length (l->list);
 725
 726         if (length == 0)
 727             l->top = l->pos = 0;
 728         else if (l->pos >= length)
 729             l->pos = length - 1;
 730     }
 731 }
 732
 733 /* --------------------------------------------------------------------------------------------- */
 734
 735 gboolean
 736 listbox_is_empty (const WListbox * l)
 737 {
 738     return (l == NULL || l->list == NULL || g_queue_is_empty (l->list));
 739 }
 740
 741 /* --------------------------------------------------------------------------------------------- */
 742
 743 void
 744 listbox_set_list (WListbox * l, GList * list)
 745 {
 746     listbox_remove_list (l);
 747
 748     if (l != NULL)
 749     {
 750         GList *ll;
 751
 752         l->list = g_queue_new ();
 753
 754         for (ll = list; ll != NULL; ll = g_list_next (ll))
 755             g_queue_push_tail (l->list, ll->data);
 756
 757         g_list_free (list);
 758     }
 759 }
 760
 761 /* --------------------------------------------------------------------------------------------- */
 762
 763 void
 764 listbox_remove_list (WListbox * l)
 765 {
 766     if (l != NULL)
 767     {
 768         if (l->list != NULL)
 769         {
 770             g_queue_foreach (l->list, (GFunc) listbox_entry_free, NULL);
 771             g_queue_free (l->list);
 772         }
 773
 774         l->list = NULL;
 775         l->pos = l->top = 0;
 776     }
 777 }
 778
 779 /* --------------------------------------------------------------------------------------------- */
 780
 781 char *
 782 listbox_add_item (WListbox * l, listbox_append_t pos, int hotkey, const char *text, void *data,
 783                   gboolean free_data)
 784 {
 785     WLEntry *entry;
 786
 787     if (l == NULL)
 788         return NULL;
 789
 790     if (!l->allow_duplicates && (listbox_search_text (l, text) >= 0))
 791         return NULL;
 792
 793     entry = g_new (WLEntry, 1);
 794     entry->text = g_strdup (text);
 795     entry->data = data;
 796     entry->free_data = free_data;
 797     entry->hotkey = hotkey;
 798
 799     listbox_append_item (l, entry, pos);
 800
 801     return entry->text;
 802 }
 803
 804 /* --------------------------------------------------------------------------------------------- */