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