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->owner = NULL;
 151     w->mouse.forced_capture = FALSE;
 152     w->mouse.capture = FALSE;
 153     w->mouse.last_msg = MSG_MOUSE_NONE;
 154     w->mouse.last_buttons_down = 0;
 155
 156     w->options = WOP_DEFAULT;
 157     w->state = WST_DEFAULT;
 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_ENABLE:
 177     case MSG_DISABLE:
 178     case MSG_DRAW:
 179     case MSG_DESTROY:
 180     case MSG_CURSOR:
 181     case MSG_IDLE:
 182         return MSG_HANDLED;
 183
 184     default:
 185         return MSG_NOT_HANDLED;
 186     }
 187 }
 188
 189 /* --------------------------------------------------------------------------------------------- */
 190
 191 /**
 192  * Apply new options to widget.
 193  *
 194  * @param w       widget
 195  * @param options widget option flags to modify. Several flags per call can be modified.
 196  * @param enable  TRUE if specified options should be added, FALSE if options should be removed
 197  */
 198 void
 199 widget_set_options (Widget * w, widget_options_t options, gboolean enable)
 200 {
 201     if (enable)
 202         w->options |= options;
 203     else
 204         w->options &= ~options;
 205 }
 206
 207 /* --------------------------------------------------------------------------------------------- */
 208
 209 /**
 210  * Modify state of widget.
 211  *
 212  * @param w      widget
 213  * @param state  widget state flag to modify
 214  * @param enable specifies whether to turn the flag on (TRUE) or off (FALSE).
 215  *               Only one flag per call can be modified.
 216  * @return       TRUE if set was handled successfully, FALSE otherwise
 217  */
 218 gboolean
 219 widget_set_state (Widget * w, widget_state_t state, gboolean enable)
 220 {
 221     gboolean ret = TRUE;
 222
 223     if (enable)
 224         w->state |= state;
 225     else
 226         w->state &= ~state;
 227
 228     if (enable)
 229     {
 230         /* exclusive bits */
 231         if ((state & WST_CONSTRUCT) != 0)
 232             w->state &= ~(WST_ACTIVE | WST_SUSPENDED | WST_CLOSED);
 233         else if ((state & WST_ACTIVE) != 0)
 234             w->state &= ~(WST_CONSTRUCT | WST_SUSPENDED | WST_CLOSED);
 235         else if ((state & WST_SUSPENDED) != 0)
 236             w->state &= ~(WST_CONSTRUCT | WST_ACTIVE | WST_CLOSED);
 237         else if ((state & WST_CLOSED) != 0)
 238             w->state &= ~(WST_CONSTRUCT | WST_ACTIVE | WST_SUSPENDED);
 239     }
 240
 241     if (w->owner == NULL)
 242         return FALSE;
 243
 244     switch (state)
 245     {
 246     case WST_DISABLED:
 247         if (send_message (w, NULL, enable ? MSG_DISABLE : MSG_ENABLE, 0, NULL) != MSG_HANDLED)
 248             ret = FALSE;
 249         if (ret)
 250             send_message (w, NULL, MSG_DRAW, 0, NULL);
 251         break;
 252
 253     default:
 254         break;
 255     }
 256
 257     return ret;
 258 }
 259
 260 /* --------------------------------------------------------------------------------------------- */
 261
 262 void
 263 widget_set_size (Widget * widget, int y, int x, int lines, int cols)
 264 {
 265     widget->x = x;
 266     widget->y = y;
 267     widget->cols = cols;
 268     widget->lines = lines;
 269     send_message (widget, NULL, MSG_RESIZE, 0, NULL);
 270 }
 271
 272 /* --------------------------------------------------------------------------------------------- */
 273
 274 void
 275 widget_selectcolor (Widget * w, gboolean focused, gboolean hotkey)
 276 {
 277     WDialog *h = w->owner;
 278     int color;
 279
 280     if (widget_get_state (w, WST_DISABLED))
 281         color = DISABLED_COLOR;
 282     else if (hotkey)
 283     {
 284         if (focused)
 285             color = h->color[DLG_COLOR_HOT_FOCUS];
 286         else
 287             color = h->color[DLG_COLOR_HOT_NORMAL];
 288     }
 289     else
 290     {
 291         if (focused)
 292             color = h->color[DLG_COLOR_FOCUS];
 293         else
 294             color = h->color[DLG_COLOR_NORMAL];
 295     }
 296
 297     tty_setcolor (color);
 298 }
 299
 300 /* --------------------------------------------------------------------------------------------- */
 301
 302 void
 303 widget_erase (Widget * w)
 304 {
 305     if (w != NULL)
 306         tty_fill_region (w->y, w->x, w->lines, w->cols, ' ');
 307 }
 308
 309 /* --------------------------------------------------------------------------------------------- */
 310 /**
 311   * Check whether widget is active or not.
 312   * @param w the widget
 313   *
 314   * @return TRUE if the widget is active, FALSE otherwise
 315   */
 316
 317 gboolean
 318 widget_is_active (const void *w)
 319 {
 320     return (w == CONST_WIDGET (w)->owner->current->data);
 321 }
 322
 323 /* --------------------------------------------------------------------------------------------- */
 324
 325 void
 326 widget_redraw (Widget * w)
 327 {
 328     if (w != NULL)
 329     {
 330         WDialog *h = w->owner;
 331
 332         if (h != NULL && widget_get_state (WIDGET (h), WST_ACTIVE))
 333             w->callback (w, NULL, MSG_DRAW, 0, NULL);
 334     }
 335 }
 336
 337 /* --------------------------------------------------------------------------------------------- */
 338 /**
 339   * Replace widget in the dialog.
 340   *
 341   * @param old_w old widget that need to be replaced
 342   * @param new_w new widget that will replace @old_w
 343   */
 344
 345 void
 346 widget_replace (Widget * old_w, Widget * new_w)
 347 {
 348     WDialog *h = old_w->owner;
 349     gboolean should_focus = FALSE;
 350
 351     if (h->widgets == NULL)
 352         return;
 353
 354     if (h->current == NULL)
 355         h->current = h->widgets;
 356
 357     if (old_w == h->current->data)
 358         should_focus = TRUE;
 359
 360     new_w->owner = h;
 361     new_w->id = old_w->id;
 362
 363     if (should_focus)
 364         h->current->data = new_w;
 365     else
 366         g_list_find (h->widgets, old_w)->data = new_w;
 367
 368     send_message (old_w, NULL, MSG_DESTROY, 0, NULL);
 369     send_message (new_w, NULL, MSG_INIT, 0, NULL);
 370
 371     if (should_focus)
 372         dlg_select_widget (new_w);
 373
 374     widget_redraw (new_w);
 375 }
 376
 377 /* --------------------------------------------------------------------------------------------- */
 378 /**
 379   * Check whether two widgets are overlapped or not.
 380   * @param a 1st widget
 381   * @param b 2nd widget
 382   *
 383   * @return TRUE if widgets are overlapped, FALSE otherwise.
 384   */
 385
 386 gboolean
 387 widget_overlapped (const Widget * a, const Widget * b)
 388 {
 389     return !((b->x >= a->x + a->cols)
 390              || (a->x >= b->x + b->cols) || (b->y >= a->y + a->lines) || (a->y >= b->y + b->lines));
 391 }
 392
 393 /* --------------------------------------------------------------------------------------------- */
 394 /* get mouse pointer location within widget */
 395
 396 Gpm_Event
 397 mouse_get_local (const Gpm_Event * global, const Widget * w)
 398 {
 399     Gpm_Event local;
 400
 401     local.buttons = global->buttons;
 402 #ifdef HAVE_LIBGPM
 403     local.clicks = 0;
 404     local.margin = 0;
 405     local.modifiers = 0;
 406     local.vc = 0;
 407 #endif
 408     local.x = global->x - w->x;
 409     local.y = global->y - w->y;
 410     local.type = global->type;
 411
 412     return local;
 413 }
 414
 415 /* --------------------------------------------------------------------------------------------- */
 416
 417 gboolean
 418 mouse_global_in_widget (const Gpm_Event * event, const Widget * w)
 419 {
 420     return (event->x > w->x) && (event->y > w->y) && (event->x <= w->x + w->cols)
 421         && (event->y <= w->y + w->lines);
 422 }
 423
 424 /* --------------------------------------------------------------------------------------------- */