lib/widget/widget-common.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, 2011, 2012, 2013
  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 widget-common.c
  32  *  \brief Source: shared stuff of widgets
  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/color.h"
  44 #include "lib/skin.h"
  45 #include "lib/strutil.h"
  46 #include "lib/widget.h"
  47
  48 /*** global variables ****************************************************************************/
  49
  50 /*** file scope macro definitions ****************************************************************/
  51
  52 /*** file scope type declarations ****************************************************************/
  53
  54 /*** file scope variables ************************************************************************/
  55
  56 /*** file scope functions ************************************************************************/
  57
  58 /* --------------------------------------------------------------------------------------------- */
  59 /*** public functions ****************************************************************************/
  60 /* --------------------------------------------------------------------------------------------- */
  61
  62 struct hotkey_t
  63 parse_hotkey (const char *text)
  64 {
  65     hotkey_t result;
  66     const char *cp, *p;
  67
  68     if (text == NULL)
  69         text = "";
  70
  71     /* search for '&', that is not on the of text */
  72     cp = strchr (text, '&');
  73     if (cp != NULL && cp[1] != '\0')
  74     {
  75         result.start = g_strndup (text, cp - text);
  76
  77         /* skip '&' */
  78         cp++;
  79         p = str_cget_next_char (cp);
  80         result.hotkey = g_strndup (cp, p - cp);
  81
  82         cp = p;
  83         result.end = g_strdup (cp);
  84     }
  85     else
  86     {
  87         result.start = g_strdup (text);
  88         result.hotkey = NULL;
  89         result.end = NULL;
  90     }
  91
  92     return result;
  93 }
  94
  95 /* --------------------------------------------------------------------------------------------- */
  96
  97 void
  98 release_hotkey (const hotkey_t hotkey)
  99 {
 100     g_free (hotkey.start);
 101     g_free (hotkey.hotkey);
 102     g_free (hotkey.end);
 103 }
 104
 105 /* --------------------------------------------------------------------------------------------- */
 106
 107 int
 108 hotkey_width (const hotkey_t hotkey)
 109 {
 110     int result;
 111
 112     result = str_term_width1 (hotkey.start);
 113     result += (hotkey.hotkey != NULL) ? str_term_width1 (hotkey.hotkey) : 0;
 114     result += (hotkey.end != NULL) ? str_term_width1 (hotkey.end) : 0;
 115     return result;
 116 }
 117
 118 /* --------------------------------------------------------------------------------------------- */
 119
 120 void
 121 hotkey_draw (Widget * w, const hotkey_t hotkey, gboolean focused)
 122 {
 123     widget_selectcolor (w, focused, FALSE);
 124     tty_print_string (hotkey.start);
 125
 126     if (hotkey.hotkey != NULL)
 127     {
 128         widget_selectcolor (w, focused, TRUE);
 129         tty_print_string (hotkey.hotkey);
 130         widget_selectcolor (w, focused, FALSE);
 131     }
 132
 133     if (hotkey.end != NULL)
 134         tty_print_string (hotkey.end);
 135 }
 136
 137 /* --------------------------------------------------------------------------------------------- */
 138
 139 void
 140 widget_init (Widget * w, int y, int x, int lines, int cols,
 141              widget_cb_fn callback, mouse_h mouse_handler)
 142 {
 143     w->x = x;
 144     w->y = y;
 145     w->cols = cols;
 146     w->lines = lines;
 147     w->pos_flags = WPOS_KEEP_DEFAULT;
 148     w->callback = callback;
 149     w->mouse = mouse_handler;
 150     w->set_options = widget_default_set_options_callback;
 151     w->owner = NULL;
 152     w->Mouse.callback = NULL;   /* it will be overriden in set_easy_mouse_callback() */
 153     w->Mouse.capture = FALSE;
 154     w->Mouse.forced_capture = FALSE;
 155
 156     /* Almost all widgets want to put the cursor in a suitable place */
 157     w->options = W_WANT_CURSOR;
 158 }
 159
 160 /* --------------------------------------------------------------------------------------------- */
 161
 162 /* Default callback for widgets */
 163 cb_ret_t
 164 widget_default_callback (Widget * w, Widget * sender, widget_msg_t msg, int parm, void *data)
 165 {
 166     (void) w;
 167     (void) sender;
 168     (void) parm;
 169     (void) data;
 170
 171     switch (msg)
 172     {
 173     case MSG_INIT:
 174     case MSG_FOCUS:
 175     case MSG_UNFOCUS:
 176     case MSG_DRAW:
 177     case MSG_DESTROY:
 178     case MSG_CURSOR:
 179     case MSG_IDLE:
 180         return MSG_HANDLED;
 181
 182     default:
 183         return MSG_NOT_HANDLED;
 184     }
 185 }
 186
 187 /* --------------------------------------------------------------------------------------------- */
 188
 189 /**
 190  * Callback for applying new options to widget.
 191  *
 192  * @param w       widget
 193  * @param options options set
 194  * @param enable  TRUE if specified options should be added, FALSE if options should be removed
 195  */
 196 void
 197 widget_default_set_options_callback (Widget * w, widget_options_t options, gboolean enable)
 198 {
 199     if (enable)
 200         w->options |= options;
 201     else
 202         w->options &= ~options;
 203
 204     if (w->owner != NULL && (options & W_DISABLED) != 0)
 205         send_message (w, NULL, MSG_DRAW, 0, NULL);
 206 }
 207
 208 /* --------------------------------------------------------------------------------------------- */
 209
 210 /**
 211  * Apply new options to widget.
 212  *
 213  * @param w       widget
 214  * @param options options set
 215  * @param enable  TRUE if specified options should be added, FALSE if options should be removed
 216  */
 217 void
 218 widget_set_options (Widget * w, widget_options_t options, gboolean enable)
 219 {
 220     w->set_options (w, options, enable);
 221 }
 222
 223 /* --------------------------------------------------------------------------------------------- */
 224
 225 void
 226 widget_set_size (Widget * widget, int y, int x, int lines, int cols)
 227 {
 228     widget->x = x;
 229     widget->y = y;
 230     widget->cols = cols;
 231     widget->lines = lines;
 232     send_message (widget, NULL, MSG_RESIZE, 0, NULL);
 233 }
 234
 235 /* --------------------------------------------------------------------------------------------- */
 236
 237 void
 238 widget_selectcolor (Widget * w, gboolean focused, gboolean hotkey)
 239 {
 240     WDialog *h = w->owner;
 241     int color;
 242
 243     if ((w->options & W_DISABLED) != 0)
 244         color = DISABLED_COLOR;
 245     else if (hotkey)
 246     {
 247         if (focused)
 248             color = h->color[DLG_COLOR_HOT_FOCUS];
 249         else
 250             color = h->color[DLG_COLOR_HOT_NORMAL];
 251     }
 252     else
 253     {
 254         if (focused)
 255             color = h->color[DLG_COLOR_FOCUS];
 256         else
 257             color = h->color[DLG_COLOR_NORMAL];
 258     }
 259
 260     tty_setcolor (color);
 261 }
 262
 263 /* --------------------------------------------------------------------------------------------- */
 264
 265 void
 266 widget_erase (Widget * w)
 267 {
 268     if (w != NULL)
 269         tty_fill_region (w->y, w->x, w->lines, w->cols, ' ');
 270 }
 271
 272 /* --------------------------------------------------------------------------------------------- */
 273 /**
 274   * Check whether widget is active or not.
 275   * @param w the widget
 276   *
 277   * @return TRUE if the widget is active, FALSE otherwise
 278   */
 279
 280 gboolean
 281 widget_is_active (const void *w)
 282 {
 283     return (w == WIDGET (w)->owner->current->data);
 284 }
 285
 286 /* --------------------------------------------------------------------------------------------- */
 287
 288 void
 289 widget_redraw (Widget * w)
 290 {
 291     if (w != NULL)
 292     {
 293         WDialog *h = w->owner;
 294
 295         if (h != NULL && h->state == DLG_ACTIVE)
 296             w->callback (w, NULL, MSG_DRAW, 0, NULL);
 297     }
 298 }
 299
 300 /* --------------------------------------------------------------------------------------------- */
 301 /**
 302   * Replace widget in the dialog.
 303   *
 304   * @param old_w old widget that need to be replaced
 305   * @param new_w new widget that will replace @old_w
 306   */
 307
 308 void
 309 widget_replace (Widget * old_w, Widget * new_w)
 310 {
 311     WDialog *h = old_w->owner;
 312     gboolean should_focus = FALSE;
 313
 314     if (h->widgets == NULL)
 315         return;
 316
 317     if (h->current == NULL)
 318         h->current = h->widgets;
 319
 320     if (old_w == h->current->data)
 321         should_focus = TRUE;
 322
 323     new_w->owner = h;
 324     new_w->id = old_w->id;
 325
 326     if (should_focus)
 327         h->current->data = new_w;
 328     else
 329         g_list_find (h->widgets, old_w)->data = new_w;
 330
 331     send_message (old_w, NULL, MSG_DESTROY, 0, NULL);
 332     send_message (new_w, NULL, MSG_INIT, 0, NULL);
 333
 334     if (should_focus)
 335         dlg_select_widget (new_w);
 336
 337     widget_redraw (new_w);
 338 }
 339
 340 /* --------------------------------------------------------------------------------------------- */
 341 /**
 342   * Check whether two widgets are overlapped or not.
 343   * @param a 1st widget
 344   * @param b 2nd widget
 345   *
 346   * @return TRUE if widgets are overlapped, FALSE otherwise.
 347   */
 348
 349 gboolean
 350 widget_overlapped (const Widget * a, const Widget * b)
 351 {
 352     return !((b->x >= a->x + a->cols)
 353              || (a->x >= b->x + b->cols) || (b->y >= a->y + a->lines) || (a->y >= b->y + b->lines));
 354 }
 355
 356 /* --------------------------------------------------------------------------------------------- */
 357 /* get mouse pointer location within widget */
 358
 359 Gpm_Event
 360 mouse_get_local (const Gpm_Event * global, const Widget * w)
 361 {
 362     Gpm_Event local;
 363
 364     local.buttons = global->buttons;
 365 #ifdef HAVE_LIBGPM
 366     local.modifiers = 0;
 367 #endif
 368     local.x = global->x - w->x;
 369     local.y = global->y - w->y;
 370     local.type = global->type;
 371
 372     return local;
 373 }
 374
 375 /* --------------------------------------------------------------------------------------------- */
 376
 377 gboolean
 378 mouse_global_in_widget (const Gpm_Event * event, const Widget * w)
 379 {
 380     return (event->x > w->x) && (event->y > w->y) && (event->x <= w->x + w->cols)
 381         && (event->y <= w->y + w->lines);
 382 }
 383
 384 /* --------------------------------------------------------------------------------------------- */