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