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) (g_queue_is_empty ((l)->list) ? 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     const gboolean disabled = (w->options & W_DISABLED) != 0;
 136     const int normalc = disabled ? DISABLED_COLOR : h->color[DLG_COLOR_NORMAL];
 137     /* *INDENT-OFF* */
 138     int selc = disabled
 139         ? DISABLED_COLOR
 140         : focused
 141             ? h->color[DLG_COLOR_HOT_FOCUS]
 142             : h->color[DLG_COLOR_FOCUS];
 143     /* *INDENT-ON* */
 144
 145     int length = 0;
 146     GList *le = NULL;
 147     int pos;
 148     int i;
 149     int sel_line = -1;
 150
 151     if (l->list != NULL)
 152     {
 153         length = g_queue_get_length (l->list);
 154         le = g_queue_peek_nth_link (l->list, (guint) l->top);
 155     }
 156
 157     /*    pos = (le == NULL) ? 0 : g_list_position (l->list, le); */
 158     pos = (le == NULL) ? 0 : l->top;
 159
 160     for (i = 0; i < w->lines; i++)
 161     {
 162         const char *text = "";
 163
 164         /* Display the entry */
 165         if (pos == l->pos && sel_line == -1)
 166         {
 167             sel_line = i;
 168             tty_setcolor (selc);
 169         }
 170         else
 171             tty_setcolor (normalc);
 172
 173         widget_move (l, i, 1);
 174
 175         if (l->list != NULL && le != NULL && (i == 0 || pos < length))
 176         {
 177             WLEntry *e = LENTRY (le->data);
 178
 179             text = e->text;
 180             le = g_list_next (le);
 181             pos++;
 182         }
 183
 184         tty_print_string (str_fit_to_term (text, w->cols - 2, J_LEFT_FIT));
 185     }
 186
 187     l->cursor_y = sel_line;
 188
 189     if (l->scrollbar && length > w->lines)
 190     {
 191         tty_setcolor (normalc);
 192         listbox_drawscroll (l);
 193     }
 194 }
 195
 196 /* --------------------------------------------------------------------------------------------- */
 197
 198 static int
 199 listbox_check_hotkey (WListbox * l, int key)
 200 {
 201     if (!listbox_is_empty (l))
 202     {
 203         int i;
 204         GList *le;
 205
 206         for (i = 0, le = g_queue_peek_head_link (l->list); le != NULL; i++, le = g_list_next (le))
 207         {
 208             WLEntry *e = LENTRY (le->data);
 209
 210             if (e->hotkey == key)
 211                 return i;
 212         }
 213     }
 214
 215     return (-1);
 216 }
 217
 218 /* --------------------------------------------------------------------------------------------- */
 219
 220 /* Calculates the item displayed at screen row 'y' (y==0 being the widget's 1st row). */
 221 static int
 222 listbox_y_pos (WListbox * l, int y)
 223 {
 224     return min (l->top + y, LISTBOX_LAST (l));
 225 }
 226
 227 /* --------------------------------------------------------------------------------------------- */
 228
 229 static void
 230 listbox_fwd (WListbox * l, gboolean wrap)
 231 {
 232     if ((guint) l->pos + 1 < g_queue_get_length (l->list))
 233         listbox_select_entry (l, l->pos + 1);
 234     else if (wrap)
 235         listbox_select_first (l);
 236 }
 237
 238 /* --------------------------------------------------------------------------------------------- */
 239
 240 static void
 241 listbox_fwd_n (WListbox * l, int n)
 242 {
 243     listbox_select_entry (l, min (l->pos + n, LISTBOX_LAST (l)));
 244 }
 245
 246 /* --------------------------------------------------------------------------------------------- */
 247
 248 static void
 249 listbox_back (WListbox * l, gboolean wrap)
 250 {
 251     if (l->pos > 0)
 252         listbox_select_entry (l, l->pos - 1);
 253     else if (wrap)
 254         listbox_select_last (l);
 255 }
 256
 257 /* --------------------------------------------------------------------------------------------- */
 258
 259 static void
 260 listbox_back_n (WListbox * l, int n)
 261 {
 262     listbox_select_entry (l, max (l->pos - n, 0));
 263 }
 264
 265 /* --------------------------------------------------------------------------------------------- */
 266
 267 static cb_ret_t
 268 listbox_execute_cmd (WListbox * l, long command)
 269 {
 270     cb_ret_t ret = MSG_HANDLED;
 271     Widget *w = WIDGET (l);
 272
 273     if (l->list == NULL || g_queue_is_empty (l->list))
 274         return MSG_NOT_HANDLED;
 275
 276     switch (command)
 277     {
 278     case CK_Up:
 279         listbox_back (l, TRUE);
 280         break;
 281     case CK_Down:
 282         listbox_fwd (l, TRUE);
 283         break;
 284     case CK_Top:
 285         listbox_select_first (l);
 286         break;
 287     case CK_Bottom:
 288         listbox_select_last (l);
 289         break;
 290     case CK_PageUp:
 291         listbox_back_n (l, w->lines - 1);
 292         break;
 293     case CK_PageDown:
 294         listbox_fwd_n (l, w->lines - 1);
 295         break;
 296     case CK_Delete:
 297         if (l->deletable)
 298         {
 299             gboolean is_last, is_more;
 300             int length;
 301
 302             length = g_queue_get_length (l->list);
 303
 304             is_last = (l->pos + 1 >= length);
 305             is_more = (l->top + w->lines >= length);
 306
 307             listbox_remove_current (l);
 308             if ((l->top > 0) && (is_last || is_more))
 309                 l->top--;
 310         }
 311         break;
 312     case CK_Clear:
 313         if (l->deletable && mc_global.widget.confirm_history_cleanup
 314             /* TRANSLATORS: no need to translate 'DialogTitle', it's just a context prefix */
 315             && (query_dialog (Q_ ("DialogTitle|History cleanup"),
 316                               _("Do you want clean this history?"),
 317                               D_ERROR, 2, _("&Yes"), _("&No")) == 0))
 318             listbox_remove_list (l);
 319         break;
 320     default:
 321         ret = MSG_NOT_HANDLED;
 322     }
 323
 324     return ret;
 325 }
 326
 327 /* --------------------------------------------------------------------------------------------- */
 328
 329 /* Return MSG_HANDLED if we want a redraw */
 330 static cb_ret_t
 331 listbox_key (WListbox * l, int key)
 332 {
 333     long command;
 334
 335     if (l->list == NULL)
 336         return MSG_NOT_HANDLED;
 337
 338     /* focus on listbox item N by '0'..'9' keys */
 339     if (key >= '0' && key <= '9')
 340     {
 341         listbox_select_entry (l, key - '0');
 342         return MSG_HANDLED;
 343     }
 344
 345     command = keybind_lookup_keymap_command (listbox_map, key);
 346     if (command == CK_IgnoreKey)
 347         return MSG_NOT_HANDLED;
 348     return listbox_execute_cmd (l, command);
 349 }
 350
 351 /* --------------------------------------------------------------------------------------------- */
 352
 353 /* Listbox item adding function */
 354 static inline void
 355 listbox_append_item (WListbox * l, WLEntry * e, listbox_append_t pos)
 356 {
 357     if (l->list == NULL)
 358     {
 359         l->list = g_queue_new ();
 360         pos = LISTBOX_APPEND_AT_END;
 361     }
 362
 363     switch (pos)
 364     {
 365     case LISTBOX_APPEND_AT_END:
 366         g_queue_push_tail (l->list, e);
 367         break;
 368
 369     case LISTBOX_APPEND_BEFORE:
 370         g_queue_insert_before (l->list, g_queue_peek_nth_link (l->list, (guint) l->pos), e);
 371         break;
 372
 373     case LISTBOX_APPEND_AFTER:
 374         g_queue_insert_after (l->list, g_queue_peek_nth_link (l->list, (guint) l->pos), e);
 375         break;
 376
 377     case LISTBOX_APPEND_SORTED:
 378         g_queue_insert_sorted (l->list, e, (GCompareDataFunc) listbox_entry_cmp, NULL);
 379         break;
 380
 381     default:
 382         break;
 383     }
 384 }
 385
 386 /* --------------------------------------------------------------------------------------------- */
 387
 388 /* Call this whenever the user changes the selected item. */
 389 static void
 390 listbox_on_change (WListbox * l)
 391 {
 392     listbox_draw (l, TRUE);
 393     send_message (WIDGET (l)->owner, l, MSG_NOTIFY, l->pos, NULL);
 394 }
 395
 396 /* --------------------------------------------------------------------------------------------- */
 397
 398 static void
 399 listbox_do_action (WListbox * l)
 400 {
 401     int action;
 402
 403     if (l->callback != NULL)
 404         action = l->callback (l);
 405     else
 406         action = LISTBOX_DONE;
 407
 408     if (action == LISTBOX_DONE)
 409     {
 410         WDialog *h = WIDGET (l)->owner;
 411
 412         h->ret_value = B_ENTER;
 413         dlg_stop (h);
 414     }
 415 }
 416
 417 /* --------------------------------------------------------------------------------------------- */
 418
 419 static void
 420 listbox_run_hotkey (WListbox * l, int pos)
 421 {
 422     listbox_select_entry (l, pos);
 423     listbox_on_change (l);
 424     listbox_do_action (l);
 425 }
 426
 427 /* --------------------------------------------------------------------------------------------- */
 428
 429 static inline void
 430 listbox_destroy (WListbox * l)
 431 {
 432     listbox_remove_list (l);
 433 }
 434
 435 /* --------------------------------------------------------------------------------------------- */
 436
 437 static cb_ret_t
 438 listbox_callback (Widget * w, Widget * sender, widget_msg_t msg, int parm, void *data)
 439 {
 440     WListbox *l = LISTBOX (w);
 441     cb_ret_t ret_code;
 442
 443     switch (msg)
 444     {
 445     case MSG_INIT:
 446         return MSG_HANDLED;
 447
 448     case MSG_HOTKEY:
 449         {
 450             int pos;
 451
 452             pos = listbox_check_hotkey (l, parm);
 453             if (pos < 0)
 454                 return MSG_NOT_HANDLED;
 455
 456             listbox_run_hotkey (l, pos);
 457
 458             return MSG_HANDLED;
 459         }
 460
 461     case MSG_KEY:
 462         ret_code = listbox_key (l, parm);
 463         if (ret_code != MSG_NOT_HANDLED)
 464             listbox_on_change (l);
 465         return ret_code;
 466
 467     case MSG_ACTION:
 468         return listbox_execute_cmd (l, parm);
 469
 470     case MSG_CURSOR:
 471         widget_move (l, l->cursor_y, 0);
 472         return MSG_HANDLED;
 473
 474     case MSG_FOCUS:
 475     case MSG_UNFOCUS:
 476         l->focused = msg == MSG_FOCUS;
 477         /* fall through */
 478     case MSG_DRAW:
 479         listbox_draw (l, l->focused);
 480         return MSG_HANDLED;
 481
 482     case MSG_DESTROY:
 483         listbox_destroy (l);
 484         return MSG_HANDLED;
 485
 486     case MSG_RESIZE:
 487         return MSG_HANDLED;
 488
 489     default:
 490         return widget_default_callback (w, sender, msg, parm, data);
 491     }
 492 }
 493
 494 /* --------------------------------------------------------------------------------------------- */
 495
 496 static void
 497 listbox_mouse_callback (Widget * w, mouse_msg_t msg, mouse_event_t * event)
 498 {
 499     WListbox *l = LISTBOX (w);
 500     int old_pos;
 501
 502     old_pos = l->pos;
 503
 504     switch (msg)
 505     {
 506     case MSG_MOUSE_DOWN:
 507         dlg_select_widget (l);
 508         listbox_select_entry (l, listbox_y_pos (l, event->y));
 509         break;
 510
 511     case MSG_MOUSE_SCROLL_UP:
 512         listbox_back (l, FALSE);
 513         break;
 514
 515     case MSG_MOUSE_SCROLL_DOWN:
 516         listbox_fwd (l, FALSE);
 517         break;
 518
 519     case MSG_MOUSE_DRAG:
 520         event->result.repeat = TRUE;    /* It'd be functional even without this. */
 521         listbox_select_entry (l, listbox_y_pos (l, event->y));
 522         break;
 523
 524     case MSG_MOUSE_CLICK:
 525         /* We don't call listbox_select_entry() here: MSG_MOUSE_DOWN/DRAG did this already. */
 526         if (event->count == GPM_DOUBLE) /* Double click */
 527             listbox_do_action (l);
 528         break;
 529
 530     default:
 531         break;
 532     }
 533
 534     /* If the selection has changed, we redraw the widget and notify the dialog. */
 535     if (l->pos != old_pos)
 536         listbox_on_change (l);
 537 }
 538
 539 /* --------------------------------------------------------------------------------------------- */
 540 /*** public functions ****************************************************************************/
 541 /* --------------------------------------------------------------------------------------------- */
 542
 543 WListbox *
 544 listbox_new (int y, int x, int height, int width, gboolean deletable, lcback_fn callback)
 545 {
 546     WListbox *l;
 547     Widget *w;
 548
 549     if (height <= 0)
 550         height = 1;
 551
 552     l = g_new (WListbox, 1);
 553     w = WIDGET (l);
 554     widget_init (w, y, x, height, width, listbox_callback, NULL);
 555     set_easy_mouse_callback (w, listbox_mouse_callback);
 556
 557     l->list = NULL;
 558     l->top = l->pos = 0;
 559     l->deletable = deletable;
 560     l->callback = callback;
 561     l->allow_duplicates = TRUE;
 562     l->scrollbar = !mc_global.tty.slow_terminal;
 563     l->focused = FALSE;
 564     widget_want_hotkey (w, TRUE);
 565     widget_want_cursor (w, FALSE);
 566
 567     return l;
 568 }
 569
 570 /* --------------------------------------------------------------------------------------------- */
 571
 572 int
 573 listbox_search_text (WListbox * l, const char *text)
 574 {
 575     if (!listbox_is_empty (l))
 576     {
 577         int i;
 578         GList *le;
 579
 580         for (i = 0, le = g_queue_peek_head_link (l->list); le != NULL; i++, le = g_list_next (le))
 581         {
 582             WLEntry *e = LENTRY (le->data);
 583
 584             if (strcmp (e->text, text) == 0)
 585                 return i;
 586         }
 587     }
 588
 589     return (-1);
 590 }
 591
 592 /* --------------------------------------------------------------------------------------------- */
 593
 594 /* Selects the first entry and scrolls the list to the top */
 595 void
 596 listbox_select_first (WListbox * l)
 597 {
 598     l->pos = l->top = 0;
 599 }
 600
 601 /* --------------------------------------------------------------------------------------------- */
 602
 603 /* Selects the last entry and scrolls the list to the bottom */
 604 void
 605 listbox_select_last (WListbox * l)
 606 {
 607     int lines = WIDGET (l)->lines;
 608     int length = 0;
 609
 610     if (!listbox_is_empty (l))
 611         length = g_queue_get_length (l->list);
 612
 613     l->pos = length > 0 ? length - 1 : 0;
 614     l->top = length > lines ? length - lines : 0;
 615 }
 616
 617 /* --------------------------------------------------------------------------------------------- */
 618
 619 void
 620 listbox_select_entry (WListbox * l, int dest)
 621 {
 622     GList *le;
 623     int pos;
 624     gboolean top_seen = FALSE;
 625
 626     if (listbox_is_empty (l) || dest < 0)
 627         return;
 628
 629     /* Special case */
 630     for (pos = 0, le = g_queue_peek_head_link (l->list); le != NULL; pos++, le = g_list_next (le))
 631     {
 632         if (pos == l->top)
 633             top_seen = TRUE;
 634
 635         if (pos == dest)
 636         {
 637             l->pos = dest;
 638             if (!top_seen)
 639                 l->top = l->pos;
 640             else
 641             {
 642                 int lines = WIDGET (l)->lines;
 643
 644                 if (l->pos - l->top >= lines)
 645                     l->top = l->pos - lines + 1;
 646             }
 647             return;
 648         }
 649     }
 650
 651     /* If we are unable to find it, set decent values */
 652     l->pos = l->top = 0;
 653 }
 654
 655 /* --------------------------------------------------------------------------------------------- */
 656
 657 /* Returns the current string text as well as the associated extra data */
 658 void
 659 listbox_get_current (WListbox * l, char **string, void **extra)
 660 {
 661     WLEntry *e = NULL;
 662     gboolean ok;
 663
 664     if (l != NULL)
 665         e = listbox_get_nth_item (l, l->pos);
 666
 667     ok = (e != NULL);
 668
 669     if (string != NULL)
 670         *string = ok ? e->text : NULL;
 671
 672     if (extra != NULL)
 673         *extra = ok ? e->data : NULL;
 674 }
 675
 676 /* --------------------------------------------------------------------------------------------- */
 677
 678 WLEntry *
 679 listbox_get_nth_item (const WListbox * l, int pos)
 680 {
 681     if (!listbox_is_empty (l) && pos >= 0)
 682     {
 683         GList *item;
 684
 685         item = g_queue_peek_nth_link (l->list, (guint) pos);
 686         if (item != NULL)
 687             return LENTRY (item->data);
 688     }
 689
 690     return NULL;
 691 }
 692
 693 /* --------------------------------------------------------------------------------------------- */
 694
 695 GList *
 696 listbox_get_first_link (const WListbox * l)
 697 {
 698     return (l == NULL || l->list == NULL) ? NULL : g_queue_peek_head_link (l->list);
 699 }
 700
 701 /* --------------------------------------------------------------------------------------------- */
 702
 703 void
 704 listbox_remove_current (WListbox * l)
 705 {
 706     if (!listbox_is_empty (l))
 707     {
 708         GList *current;
 709         int length;
 710
 711         current = g_queue_peek_nth_link (l->list, (guint) l->pos);
 712         listbox_entry_free (LENTRY (current->data));
 713         g_queue_delete_link (l->list, current);
 714
 715         length = g_queue_get_length (l->list);
 716
 717         if (length == 0)
 718             l->top = l->pos = 0;
 719         else if (l->pos >= length)
 720             l->pos = length - 1;
 721     }
 722 }
 723
 724 /* --------------------------------------------------------------------------------------------- */
 725
 726 gboolean
 727 listbox_is_empty (const WListbox * l)
 728 {
 729     return (l == NULL || l->list == NULL || g_queue_is_empty (l->list));
 730 }
 731
 732 /* --------------------------------------------------------------------------------------------- */
 733
 734 void
 735 listbox_set_list (WListbox * l, GList * list)
 736 {
 737     listbox_remove_list (l);
 738
 739     if (l != NULL)
 740     {
 741         GList *ll;
 742
 743         l->list = g_queue_new ();
 744
 745         for (ll = list; ll != NULL; ll = g_list_next (ll))
 746             g_queue_push_tail (l->list, ll->data);
 747
 748         g_list_free (list);
 749     }
 750 }
 751
 752 /* --------------------------------------------------------------------------------------------- */
 753
 754 void
 755 listbox_remove_list (WListbox * l)
 756 {
 757     if (l != NULL)
 758     {
 759         if (l->list != NULL)
 760         {
 761             g_queue_foreach (l->list, (GFunc) listbox_entry_free, NULL);
 762             g_queue_free (l->list);
 763         }
 764
 765         l->list = NULL;
 766         l->pos = l->top = 0;
 767     }
 768 }
 769
 770 /* --------------------------------------------------------------------------------------------- */
 771
 772 char *
 773 listbox_add_item (WListbox * l, listbox_append_t pos, int hotkey, const char *text, void *data,
 774                   gboolean free_data)
 775 {
 776     WLEntry *entry;
 777
 778     if (l == NULL)
 779         return NULL;
 780
 781     if (!l->allow_duplicates && (listbox_search_text (l, text) >= 0))
 782         return NULL;
 783
 784     entry = g_new (WLEntry, 1);
 785     entry->text = g_strdup (text);
 786     entry->data = data;
 787     entry->free_data = free_data;
 788     entry->hotkey = hotkey;
 789
 790     listbox_append_item (l, entry, pos);
 791
 792     return entry->text;
 793 }
 794
 795 /* --------------------------------------------------------------------------------------------- */