lib/widget/widget-common.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 widget-common.c
  33  *  \brief Source: shared stuff of widgets
  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/color.h"
  45 #include "lib/skin.h"
  46 #include "lib/strutil.h"
  47 #include "lib/widget.h"
  48
  49 /*** global variables ****************************************************************************/
  50
  51 /*** file scope macro definitions ****************************************************************/
  52
  53 /*** file scope type declarations ****************************************************************/
  54
  55 /*** file scope variables ************************************************************************/
  56
  57 /*** file scope functions ************************************************************************/
  58
  59 /* --------------------------------------------------------------------------------------------- */
  60 /*** public functions ****************************************************************************/
  61 /* --------------------------------------------------------------------------------------------- */
  62
  63 struct hotkey_t
  64 parse_hotkey (const char *text)
  65 {
  66     hotkey_t result;
  67     const char *cp, *p;
  68
  69     if (text == NULL)
  70         text = "";
  71
  72     /* search for '&', that is not on the of text */
  73     cp = strchr (text, '&');
  74     if (cp != NULL && cp[1] != '\0')
  75     {
  76         result.start = g_strndup (text, cp - text);
  77
  78         /* skip '&' */
  79         cp++;
  80         p = str_cget_next_char (cp);
  81         result.hotkey = g_strndup (cp, p - cp);
  82
  83         cp = p;
  84         result.end = g_strdup (cp);
  85     }
  86     else
  87     {
  88         result.start = g_strdup (text);
  89         result.hotkey = NULL;
  90         result.end = NULL;
  91     }
  92
  93     return result;
  94 }
  95
  96 /* --------------------------------------------------------------------------------------------- */
  97
  98 void
  99 release_hotkey (const hotkey_t hotkey)
 100 {
 101     g_free (hotkey.start);
 102     g_free (hotkey.hotkey);
 103     g_free (hotkey.end);
 104 }
 105
 106 /* --------------------------------------------------------------------------------------------- */
 107
 108 int
 109 hotkey_width (const hotkey_t hotkey)
 110 {
 111     int result;
 112
 113     result = str_term_width1 (hotkey.start);
 114     result += (hotkey.hotkey != NULL) ? str_term_width1 (hotkey.hotkey) : 0;
 115     result += (hotkey.end != NULL) ? str_term_width1 (hotkey.end) : 0;
 116     return result;
 117 }
 118
 119 /* --------------------------------------------------------------------------------------------- */
 120
 121 void
 122 hotkey_draw (Widget * w, const hotkey_t hotkey, gboolean focused)
 123 {
 124     widget_selectcolor (w, focused, FALSE);
 125     tty_print_string (hotkey.start);
 126
 127     if (hotkey.hotkey != NULL)
 128     {
 129         widget_selectcolor (w, focused, TRUE);
 130         tty_print_string (hotkey.hotkey);
 131         widget_selectcolor (w, focused, FALSE);
 132     }
 133
 134     if (hotkey.end != NULL)
 135         tty_print_string (hotkey.end);
 136 }
 137
 138 /* --------------------------------------------------------------------------------------------- */
 139
 140 void
 141 init_widget (Widget * w, int y, int x, int lines, int cols,
 142              widget_cb_fn callback, mouse_h mouse_handler)
 143 {
 144     w->x = x;
 145     w->y = y;
 146     w->cols = cols;
 147     w->lines = lines;
 148     w->callback = callback;
 149     w->mouse = mouse_handler;
 150     w->set_options = widget_default_set_options_callback;
 151     w->owner = NULL;
 152
 153     /* Almost all widgets want to put the cursor in a suitable place */
 154     w->options = W_WANT_CURSOR;
 155 }
 156
 157 /* --------------------------------------------------------------------------------------------- */
 158
 159 /* Default callback for widgets */
 160 cb_ret_t
 161 widget_default_callback (Widget * sender, widget_msg_t msg, int parm, void *data)
 162 {
 163     (void) sender;
 164     (void) parm;
 165     (void) data;
 166
 167     switch (msg)
 168     {
 169     case WIDGET_INIT:
 170     case WIDGET_FOCUS:
 171     case WIDGET_UNFOCUS:
 172     case WIDGET_DRAW:
 173     case WIDGET_DESTROY:
 174     case WIDGET_CURSOR:
 175     case WIDGET_IDLE:
 176         return MSG_HANDLED;
 177
 178     default:
 179         return MSG_NOT_HANDLED;
 180     }
 181 }
 182
 183 /* --------------------------------------------------------------------------------------------- */
 184
 185 /**
 186  * Callback for applying new options to widget.
 187  *
 188  * @param w       widget
 189  * @param options options set
 190  * @param enable  TRUE if specified options should be added, FALSE if options should be removed
 191  */
 192 void
 193 widget_default_set_options_callback (Widget *w, widget_options_t options, gboolean enable)
 194 {
 195     if (enable)
 196         w->options |= options;
 197     else
 198         w->options &= ~options;
 199
 200     if (w->owner != NULL && (options & W_DISABLED) != 0)
 201         send_message (w, NULL, WIDGET_DRAW, 0, NULL);
 202 }
 203
 204 /* --------------------------------------------------------------------------------------------- */
 205
 206 /**
 207  * Apply new options to widget.
 208  *
 209  * @param w       widget
 210  * @param options options set
 211  * @param enable  TRUE if specified options should be added, FALSE if options should be removed
 212  */
 213 void
 214 widget_set_options (Widget *w, widget_options_t options, gboolean enable)
 215 {
 216     w->set_options (w, options, enable);
 217 }
 218
 219 /* --------------------------------------------------------------------------------------------- */
 220
 221 void
 222 widget_set_size (Widget * widget, int y, int x, int lines, int cols)
 223 {
 224     widget->x = x;
 225     widget->y = y;
 226     widget->cols = cols;
 227     widget->lines = lines;
 228     send_message (widget, NULL, WIDGET_RESIZED, 0, NULL);
 229 }
 230
 231 /* --------------------------------------------------------------------------------------------- */
 232
 233 void
 234 widget_selectcolor (Widget * w, gboolean focused, gboolean hotkey)
 235 {
 236     WDialog *h = w->owner;
 237     int color;
 238
 239     if ((w->options & W_DISABLED) != 0)
 240         color = DISABLED_COLOR;
 241     else if (hotkey)
 242     {
 243         if (focused)
 244             color = h->color[DLG_COLOR_HOT_FOCUS];
 245         else
 246             color = h->color[DLG_COLOR_HOT_NORMAL];
 247     }
 248     else
 249     {
 250         if (focused)
 251             color = h->color[DLG_COLOR_FOCUS];
 252         else
 253             color = h->color[DLG_COLOR_NORMAL];
 254     }
 255
 256     tty_setcolor (color);
 257 }
 258
 259 /* --------------------------------------------------------------------------------------------- */
 260
 261 void
 262 widget_erase (Widget * w)
 263 {
 264     if (w != NULL)
 265         tty_fill_region (w->y, w->x, w->lines, w->cols, ' ');
 266 }
 267
 268 /* --------------------------------------------------------------------------------------------- */
 269
 270 /* get mouse pointer location within widget */
 271 Gpm_Event
 272 mouse_get_local (const Gpm_Event * global, const Widget * w)
 273 {
 274     Gpm_Event local;
 275
 276     local.buttons = global->buttons;
 277     local.x = global->x - w->x;
 278     local.y = global->y - w->y;
 279     local.type = global->type;
 280
 281     return local;
 282 }
 283
 284 /* --------------------------------------------------------------------------------------------- */
 285
 286 gboolean
 287 mouse_global_in_widget (const Gpm_Event * event, const Widget * w)
 288 {
 289     return (event->x > w->x) && (event->y > w->y) && (event->x <= w->x + w->cols)
 290         && (event->y <= w->y + w->lines);
 291 }
 292
 293 /* --------------------------------------------------------------------------------------------- */