lib/widget/listbox.c

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