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, widget_mouse_cb_fn mouse_callback)
 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_callback = mouse_callback;
 150     w->set_options = widget_default_set_options_callback;
 151     w->owner = NULL;
 152     w->mouse.capture = FALSE;
 153     w->mouse.forced_capture = FALSE;
 154     w->mouse.last_buttons_down = 0;
 155     w->mouse.was_drag = FALSE;
 156
 157     /* Almost all widgets want to put the cursor in a suitable place */
 158     w->options = W_WANT_CURSOR;
 159 }
 160
 161 /* --------------------------------------------------------------------------------------------- */
 162
 163 /* Default callback for widgets */
 164 cb_ret_t
 165 widget_default_callback (Widget * w, Widget * sender, widget_msg_t msg, int parm, void *data)
 166 {
 167     (void) w;
 168     (void) sender;
 169     (void) parm;
 170     (void) data;
 171
 172     switch (msg)
 173     {
 174     case MSG_INIT:
 175     case MSG_FOCUS:
 176     case MSG_UNFOCUS:
 177     case MSG_DRAW:
 178     case MSG_DESTROY:
 179     case MSG_CURSOR:
 180     case MSG_IDLE:
 181         return MSG_HANDLED;
 182
 183     default:
 184         return MSG_NOT_HANDLED;
 185     }
 186 }
 187
 188 /* --------------------------------------------------------------------------------------------- */
 189
 190 /**
 191  * Callback for applying new options to widget.
 192  *
 193  * @param w       widget
 194  * @param options options set
 195  * @param enable  TRUE if specified options should be added, FALSE if options should be removed
 196  */
 197 void
 198 widget_default_set_options_callback (Widget * w, widget_options_t options, gboolean enable)
 199 {
 200     if (enable)
 201         w->options |= options;
 202     else
 203         w->options &= ~options;
 204
 205     if (w->owner != NULL && (options & W_DISABLED) != 0)
 206         send_message (w, NULL, MSG_DRAW, 0, NULL);
 207 }
 208
 209 /* --------------------------------------------------------------------------------------------- */
 210
 211 /**
 212  * Apply new options to widget.
 213  *
 214  * @param w       widget
 215  * @param options options set
 216  * @param enable  TRUE if specified options should be added, FALSE if options should be removed
 217  */
 218 void
 219 widget_set_options (Widget * w, widget_options_t options, gboolean enable)
 220 {
 221     w->set_options (w, options, enable);
 222 }
 223
 224 /* --------------------------------------------------------------------------------------------- */
 225
 226 void
 227 widget_set_size (Widget * widget, int y, int x, int lines, int cols)
 228 {
 229     widget->x = x;
 230     widget->y = y;
 231     widget->cols = cols;
 232     widget->lines = lines;
 233     send_message (widget, NULL, MSG_RESIZE, 0, NULL);
 234 }
 235
 236 /* --------------------------------------------------------------------------------------------- */
 237
 238 void
 239 widget_selectcolor (Widget * w, gboolean focused, gboolean hotkey)
 240 {
 241     WDialog *h = w->owner;
 242     int color;
 243
 244     if ((w->options & W_DISABLED) != 0)
 245         color = DISABLED_COLOR;
 246     else if (hotkey)
 247     {
 248         if (focused)
 249             color = h->color[DLG_COLOR_HOT_FOCUS];
 250         else
 251             color = h->color[DLG_COLOR_HOT_NORMAL];
 252     }
 253     else
 254     {
 255         if (focused)
 256             color = h->color[DLG_COLOR_FOCUS];
 257         else
 258             color = h->color[DLG_COLOR_NORMAL];
 259     }
 260
 261     tty_setcolor (color);
 262 }
 263
 264 /* --------------------------------------------------------------------------------------------- */
 265
 266 void
 267 widget_erase (Widget * w)
 268 {
 269     if (w != NULL)
 270         tty_fill_region (w->y, w->x, w->lines, w->cols, ' ');
 271 }
 272
 273 /* --------------------------------------------------------------------------------------------- */
 274 /**
 275   * Check whether widget is active or not.
 276   * @param w the widget
 277   *
 278   * @return TRUE if the widget is active, FALSE otherwise
 279   */
 280
 281 gboolean
 282 widget_is_active (const void *w)
 283 {
 284     return (w == WIDGET (w)->owner->current->data);
 285 }
 286
 287 /* --------------------------------------------------------------------------------------------- */
 288
 289 void
 290 widget_redraw (Widget * w)
 291 {
 292     if (w != NULL)
 293     {
 294         WDialog *h = w->owner;
 295
 296         if (h != NULL && h->state == DLG_ACTIVE)
 297             w->callback (w, NULL, MSG_DRAW, 0, NULL);
 298     }
 299 }
 300
 301 /* --------------------------------------------------------------------------------------------- */
 302 /**
 303   * Replace widget in the dialog.
 304   *
 305   * @param old_w old widget that need to be replaced
 306   * @param new_w new widget that will replace @old_w
 307   */
 308
 309 void
 310 widget_replace (Widget * old_w, Widget * new_w)
 311 {
 312     WDialog *h = old_w->owner;
 313     gboolean should_focus = FALSE;
 314
 315     if (h->widgets == NULL)
 316         return;
 317
 318     if (h->current == NULL)
 319         h->current = h->widgets;
 320
 321     if (old_w == h->current->data)
 322         should_focus = TRUE;
 323
 324     new_w->owner = h;
 325     new_w->id = old_w->id;
 326
 327     if (should_focus)
 328         h->current->data = new_w;
 329     else
 330         g_list_find (h->widgets, old_w)->data = new_w;
 331
 332     send_message (old_w, NULL, MSG_DESTROY, 0, NULL);
 333     send_message (new_w, NULL, MSG_INIT, 0, NULL);
 334
 335     if (should_focus)
 336         dlg_select_widget (new_w);
 337
 338     widget_redraw (new_w);
 339 }
 340
 341 /* --------------------------------------------------------------------------------------------- */
 342 /**
 343   * Check whether two widgets are overlapped or not.
 344   * @param a 1st widget
 345   * @param b 2nd widget
 346   *
 347   * @return TRUE if widgets are overlapped, FALSE otherwise.
 348   */
 349
 350 gboolean
 351 widget_overlapped (const Widget * a, const Widget * b)
 352 {
 353     return !((b->x >= a->x + a->cols)
 354              || (a->x >= b->x + b->cols) || (b->y >= a->y + a->lines) || (a->y >= b->y + b->lines));
 355 }
 356
 357 /* --------------------------------------------------------------------------------------------- */
 358 /* get mouse pointer location within widget */
 359
 360 Gpm_Event
 361 mouse_get_local (const Gpm_Event * global, const Widget * w)
 362 {
 363     Gpm_Event local;
 364
 365     local.buttons = global->buttons;
 366 #ifdef HAVE_LIBGPM
 367     local.modifiers = 0;
 368 #endif
 369     local.x = global->x - w->x;
 370     local.y = global->y - w->y;
 371     local.type = global->type;
 372
 373     return local;
 374 }
 375
 376 /* --------------------------------------------------------------------------------------------- */
 377
 378 gboolean
 379 mouse_global_in_widget (const Gpm_Event * event, const Widget * w)
 380 {
 381     return (event->x > w->x) && (event->y > w->y) && (event->x <= w->x + w->cols)
 382         && (event->y <= w->y + w->lines);
 383 }
 384
 385 /* --------------------------------------------------------------------------------------------- */