lib/widget/buttonbar.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 buttonbar.c
  32  *  \brief Source: WButtonBar widget
  33  */
  34
  35 #include <config.h>
  36
  37 #include <stdlib.h>
  38 #include <string.h>
  39
  40 #include "lib/global.h"
  41
  42 #include "lib/tty/tty.h"
  43 #include "lib/tty/key.h"        /* XCTRL and ALT macros  */
  44 #include "lib/skin.h"
  45 #include "lib/strutil.h"
  46 #include "lib/util.h"
  47 #include "lib/keybind.h"        /* global_keymap_t */
  48 #include "lib/widget.h"
  49
  50 /*** global variables ****************************************************************************/
  51
  52 /*** file scope macro definitions ****************************************************************/
  53
  54 /*** file scope type declarations ****************************************************************/
  55
  56 /*** file scope variables ************************************************************************/
  57
  58 /*** file scope functions ************************************************************************/
  59 /* --------------------------------------------------------------------------------------------- */
  60
  61 /* calculate positions of buttons; width is never less than 7 */
  62 static void
  63 buttonbar_init_button_positions (WButtonBar * bb)
  64 {
  65     int i;
  66     int pos = 0;
  67
  68     if (COLS < BUTTONBAR_LABELS_NUM * 7)
  69     {
  70         for (i = 0; i < BUTTONBAR_LABELS_NUM; i++)
  71         {
  72             if (pos + 7 <= COLS)
  73                 pos += 7;
  74
  75             bb->labels[i].end_coord = pos;
  76         }
  77     }
  78     else
  79     {
  80         /* Distribute the extra width in a way that the middle vertical line
  81            (between F5 and F6) aligns with the two panels. The extra width
  82            is distributed in this order: F10, F5, F9, F4, ..., F6, F1. */
  83         int dv, md;
  84
  85         dv = COLS / BUTTONBAR_LABELS_NUM;
  86         md = COLS % BUTTONBAR_LABELS_NUM;
  87
  88         for (i = 0; i < BUTTONBAR_LABELS_NUM / 2; i++)
  89         {
  90             pos += dv;
  91             if (BUTTONBAR_LABELS_NUM / 2 - 1 - i < md / 2)
  92                 pos++;
  93
  94             bb->labels[i].end_coord = pos;
  95         }
  96
  97         for (; i < BUTTONBAR_LABELS_NUM; i++)
  98         {
  99             pos += dv;
 100             if (BUTTONBAR_LABELS_NUM - 1 - i < (md + 1) / 2)
 101                 pos++;
 102
 103             bb->labels[i].end_coord = pos;
 104         }
 105     }
 106 }
 107
 108 /* --------------------------------------------------------------------------------------------- */
 109
 110 /* return width of one button */
 111 static int
 112 buttonbar_get_button_width (const WButtonBar * bb, int i)
 113 {
 114     if (i == 0)
 115         return bb->labels[0].end_coord;
 116     return bb->labels[i].end_coord - bb->labels[i - 1].end_coord;
 117 }
 118
 119 /* --------------------------------------------------------------------------------------------- */
 120
 121 static int
 122 buttonbar_get_button_by_x_coord (const WButtonBar * bb, int x)
 123 {
 124     int i;
 125
 126     for (i = 0; i < BUTTONBAR_LABELS_NUM; i++)
 127         if (bb->labels[i].end_coord > x)
 128             return i;
 129
 130     return (-1);
 131 }
 132
 133 /* --------------------------------------------------------------------------------------------- */
 134
 135 static void
 136 set_label_text (WButtonBar * bb, int idx, const char *text)
 137 {
 138     g_free (bb->labels[idx - 1].text);
 139     bb->labels[idx - 1].text = g_strdup (text);
 140 }
 141
 142 /* --------------------------------------------------------------------------------------------- */
 143
 144 /* returns TRUE if a function has been called, FALSE otherwise. */
 145 static gboolean
 146 buttonbar_call (WButtonBar * bb, int i)
 147 {
 148     cb_ret_t ret = MSG_NOT_HANDLED;
 149     Widget *w = WIDGET (bb);
 150     Widget *target;
 151
 152     target = (bb->labels[i].receiver != NULL) ? bb->labels[i].receiver : WIDGET (w->owner);
 153
 154     if ((bb != NULL) && (bb->labels[i].command != CK_IgnoreKey))
 155         ret = send_message (target, w, MSG_ACTION, bb->labels[i].command, NULL);
 156     return ret;
 157 }
 158
 159 /* --------------------------------------------------------------------------------------------- */
 160
 161 static cb_ret_t
 162 buttonbar_callback (Widget * w, Widget * sender, widget_msg_t msg, int parm, void *data)
 163 {
 164     WButtonBar *bb = BUTTONBAR (w);
 165     int i;
 166
 167     switch (msg)
 168     {
 169     case MSG_FOCUS:
 170         return MSG_NOT_HANDLED;
 171
 172     case MSG_HOTKEY:
 173         for (i = 0; i < BUTTONBAR_LABELS_NUM; i++)
 174             if (parm == KEY_F (i + 1) && buttonbar_call (bb, i))
 175                 return MSG_HANDLED;
 176         return MSG_NOT_HANDLED;
 177
 178     case MSG_DRAW:
 179         if (bb->visible)
 180         {
 181             buttonbar_init_button_positions (bb);
 182             widget_move (w, 0, 0);
 183             tty_setcolor (DEFAULT_COLOR);
 184             tty_printf ("%-*s", w->cols, "");
 185             widget_move (w, 0, 0);
 186
 187             for (i = 0; i < BUTTONBAR_LABELS_NUM; i++)
 188             {
 189                 int width;
 190                 const char *text;
 191
 192                 width = buttonbar_get_button_width (bb, i);
 193                 if (width <= 0)
 194                     break;
 195
 196                 tty_setcolor (BUTTONBAR_HOTKEY_COLOR);
 197                 tty_printf ("%2d", i + 1);
 198
 199                 tty_setcolor (BUTTONBAR_BUTTON_COLOR);
 200                 text = (bb->labels[i].text != NULL) ? bb->labels[i].text : "";
 201                 tty_print_string (str_fit_to_term (text, width - 2, J_LEFT_FIT));
 202             }
 203         }
 204         return MSG_HANDLED;
 205
 206     case MSG_DESTROY:
 207         for (i = 0; i < BUTTONBAR_LABELS_NUM; i++)
 208             g_free (bb->labels[i].text);
 209         return MSG_HANDLED;
 210
 211     default:
 212         return widget_default_callback (w, sender, msg, parm, data);
 213     }
 214 }
 215
 216 /* --------------------------------------------------------------------------------------------- */
 217
 218 static void
 219 buttonbar_mouse_callback (Widget * w, mouse_msg_t msg, mouse_event_t * event)
 220 {
 221     switch (msg)
 222     {
 223     case MSG_MOUSE_CLICK:
 224         {
 225             WButtonBar *bb = BUTTONBAR (w);
 226             int button;
 227
 228             button = buttonbar_get_button_by_x_coord (bb, event->x);
 229             if (button >= 0)
 230                 buttonbar_call (bb, button);
 231             break;
 232         }
 233
 234     default:
 235         break;
 236     }
 237 }
 238
 239 /* --------------------------------------------------------------------------------------------- */
 240 /*** public functions ****************************************************************************/
 241 /* --------------------------------------------------------------------------------------------- */
 242
 243 WButtonBar *
 244 buttonbar_new (gboolean visible)
 245 {
 246     WButtonBar *bb;
 247     Widget *w;
 248
 249     bb = g_new0 (WButtonBar, 1);
 250     w = WIDGET (bb);
 251     widget_init (w, LINES - 1, 0, 1, COLS, buttonbar_callback, buttonbar_mouse_callback);
 252
 253     w->pos_flags = WPOS_KEEP_HORZ | WPOS_KEEP_BOTTOM;
 254     bb->visible = visible;
 255     widget_want_hotkey (w, TRUE);
 256     widget_want_cursor (w, FALSE);
 257
 258     return bb;
 259 }
 260
 261 /* --------------------------------------------------------------------------------------------- */
 262
 263 void
 264 buttonbar_set_label (WButtonBar * bb, int idx, const char *text,
 265                      const global_keymap_t * keymap, const Widget * receiver)
 266 {
 267     if ((bb != NULL) && (idx >= 1) && (idx <= BUTTONBAR_LABELS_NUM))
 268     {
 269         long command = CK_IgnoreKey;
 270
 271         if (keymap != NULL)
 272             command = keybind_lookup_keymap_command (keymap, KEY_F (idx));
 273
 274         if ((text == NULL) || (text[0] == '\0'))
 275             set_label_text (bb, idx, "");
 276         else
 277             set_label_text (bb, idx, text);
 278
 279         bb->labels[idx - 1].command = command;
 280         bb->labels[idx - 1].receiver = WIDGET (receiver);
 281     }
 282 }
 283
 284 /* --------------------------------------------------------------------------------------------- */
 285
 286 /* Find ButtonBar widget in the dialog */
 287 WButtonBar *
 288 find_buttonbar (const WDialog * h)
 289 {
 290     return BUTTONBAR (find_widget_type (h, buttonbar_callback));
 291 }