lib/widget/group.c

   1 /*
   2    Widget group features module for the Midnight Commander
   3
   4    Copyright (C) 2020
   5    The Free Software Foundation, Inc.
   6
   7    Written by:
   8    Andrew Borodin <aborodin@vmail.ru>, 2020
   9
  10    This file is part of the Midnight Commander.
  11
  12    The Midnight Commander is free software: you can redistribute it
  13    and/or modify it under the terms of the GNU General Public License as
  14    published by the Free Software Foundation, either version 3 of the License,
  15    or (at your option) any later version.
  16
  17    The Midnight Commander is distributed in the hope that it will be useful,
  18    but WITHOUT ANY WARRANTY; without even the implied warranty of
  19    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20    GNU General Public License for more details.
  21
  22    You should have received a copy of the GNU General Public License
  23    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  24  */
  25
  26 /** \file group.c
  27  *  \brief Source: widget group features module
  28  */
  29
  30 #include <config.h>
  31
  32 #include <assert.h>
  33 #include <stdlib.h>
  34 #include <string.h>
  35
  36 #include "lib/global.h"
  37
  38 #include "lib/widget.h"
  39
  40 /*** global variables ****************************************************************************/
  41
  42 /*** file scope macro definitions ****************************************************************/
  43
  44 /*** file scope type declarations ****************************************************************/
  45
  46 /*** file scope variables ************************************************************************/
  47
  48 /* --------------------------------------------------------------------------------------------- */
  49 /*** file scope functions ************************************************************************/
  50 /* --------------------------------------------------------------------------------------------- */
  51
  52 static GList *
  53 group_get_next_or_prev_of (GList * list, gboolean next)
  54 {
  55     GList *l = NULL;
  56
  57     if (list != NULL)
  58     {
  59         WGroup *owner = WIDGET (list->data)->owner;
  60
  61         if (owner != NULL)
  62         {
  63             if (next)
  64             {
  65                 l = g_list_next (list);
  66                 if (l == NULL)
  67                     l = owner->widgets;
  68             }
  69             else
  70             {
  71                 l = g_list_previous (list);
  72                 if (l == NULL)
  73                     l = g_list_last (owner->widgets);
  74             }
  75         }
  76     }
  77
  78     return l;
  79 }
  80
  81 /* --------------------------------------------------------------------------------------------- */
  82
  83 static void
  84 group_select_next_or_prev (WGroup * g, gboolean next)
  85 {
  86     if (g->widgets != NULL && g->current != NULL)
  87     {
  88         GList *l = g->current;
  89         Widget *w;
  90
  91         do
  92         {
  93             l = group_get_next_or_prev_of (l, next);
  94             w = WIDGET (l->data);
  95         }
  96         while ((widget_get_state (w, WST_DISABLED) || !widget_get_options (w, WOP_SELECTABLE))
  97                && l != g->current);
  98
  99         widget_select (l->data);
 100     }
 101 }
 102
 103 /* --------------------------------------------------------------------------------------------- */
 104 /*** public functions ****************************************************************************/
 105 /* --------------------------------------------------------------------------------------------- */
 106
 107 /**
 108  * Insert widget to group before specified widget with specified positioning.
 109  * Make the inserted widget current.
 110  *
 111  * @param g WGroup object
 112  * @param w widget to be added
 113  * @pos positioning flags
 114  * @param before add @w before this widget
 115  *
 116  * @return widget ID
 117  */
 118
 119 unsigned long
 120 group_add_widget_autopos (WGroup * g, void *w, widget_pos_flags_t pos_flags, const void *before)
 121 {
 122     Widget *wg = WIDGET (g);
 123     Widget *ww = WIDGET (w);
 124     GList *new_current;
 125
 126     /* Don't accept NULL widget. This shouldn't happen */
 127     assert (ww != NULL);
 128
 129     if ((pos_flags & WPOS_CENTER_HORZ) != 0)
 130         ww->x = (wg->cols - ww->cols) / 2;
 131     ww->x += wg->x;
 132
 133     if ((pos_flags & WPOS_CENTER_VERT) != 0)
 134         ww->y = (wg->lines - ww->lines) / 2;
 135     ww->y += wg->y;
 136
 137     ww->owner = g;
 138     ww->pos_flags = pos_flags;
 139     ww->id = g->widget_id++;
 140
 141     if (g->widgets == NULL || before == NULL)
 142     {
 143         g->widgets = g_list_append (g->widgets, ww);
 144         new_current = g_list_last (g->widgets);
 145     }
 146     else
 147     {
 148         GList *b;
 149
 150         b = g_list_find (g->widgets, before);
 151
 152         /* don't accept widget not from group. This shouldn't happen */
 153         assert (b != NULL);
 154
 155         b = g_list_next (b);
 156         g->widgets = g_list_insert_before (g->widgets, b, ww);
 157         if (b != NULL)
 158             new_current = g_list_previous (b);
 159         else
 160             new_current = g_list_last (g->widgets);
 161     }
 162
 163     /* widget has been added at runtime */
 164     if (widget_get_state (wg, WST_ACTIVE))
 165     {
 166         send_message (ww, NULL, MSG_INIT, 0, NULL);
 167         widget_select (ww);
 168     }
 169     else
 170         g->current = new_current;
 171
 172     return ww->id;
 173 }
 174
 175 /* --------------------------------------------------------------------------------------------- */
 176
 177 /**
 178  * Delete widget from group.
 179  *
 180  * @param w Widget object
 181  */
 182 void
 183 group_del_widget (void *w)
 184 {
 185     WGroup *g;
 186     GList *d;
 187
 188     /* Don't accept NULL widget. This shouldn't happen */
 189     assert (w != NULL);
 190
 191     g = WIDGET (w)->owner;
 192
 193     d = g_list_find (g->widgets, w);
 194     if (d == g->current)
 195         group_set_current_widget_next (g);
 196
 197     g->widgets = g_list_remove_link (g->widgets, d);
 198     if (g->widgets == NULL)
 199         g->current = NULL;
 200
 201     /* widget has been deleted at runtime */
 202     if (widget_get_state (WIDGET (g), WST_ACTIVE))
 203     {
 204         dlg_draw (DIALOG (g));          /* FIXME */
 205         group_select_current_widget (g);
 206     }
 207 }
 208
 209 /* --------------------------------------------------------------------------------------------- */
 210
 211 /**
 212  * Switch current widget to widget after current in group.
 213  *
 214  * @param g WGroup object
 215  */
 216
 217 void
 218 group_set_current_widget_next (WGroup * g)
 219 {
 220     g->current = group_get_next_or_prev_of (g->current, TRUE);
 221 }
 222
 223 /* --------------------------------------------------------------------------------------------- */
 224 /**
 225  * Switch current widget to widget before current in group.
 226  *
 227  * @param g WGroup object
 228  */
 229
 230 void
 231 group_set_current_widget_prev (WGroup * g)
 232 {
 233     g->current = group_get_next_or_prev_of (g->current, FALSE);
 234 }
 235
 236 /* --------------------------------------------------------------------------------------------- */
 237 /**
 238  * Get widget that is after specified widget in group.
 239  *
 240  * @param w widget holder
 241  *
 242  * @return widget that is after "w" or NULL if "w" is NULL or widget doesn't have owner
 243  */
 244
 245 GList *
 246 group_get_widget_next_of (GList * w)
 247 {
 248     return group_get_next_or_prev_of (w, TRUE);
 249 }
 250
 251 /* --------------------------------------------------------------------------------------------- */
 252 /**
 253  * Get widget that is before specified widget in group.
 254  *
 255  * @param w widget holder
 256  *
 257  * @return widget that is before "w" or NULL if "w" is NULL or widget doesn't have owner
 258  */
 259
 260 GList *
 261 group_get_widget_prev_of (GList * w)
 262 {
 263     return group_get_next_or_prev_of (w, FALSE);
 264 }
 265
 266 /* --------------------------------------------------------------------------------------------- */
 267 /**
 268  * Try to select next widget in the Z order.
 269  *
 270  * @param g WGroup object
 271  */
 272
 273 void
 274 group_select_next_widget (WGroup * g)
 275 {
 276     group_select_next_or_prev (g, TRUE);
 277 }
 278
 279 /* --------------------------------------------------------------------------------------------- */
 280 /**
 281  * Try to select previous widget in the Z order.
 282  *
 283  * @param g WGroup object
 284  */
 285
 286 void
 287 group_select_prev_widget (WGroup * g)
 288 {
 289     group_select_next_or_prev (g, FALSE);
 290 }
 291
 292 /* --------------------------------------------------------------------------------------------- */
 293 /**
 294  * Find the widget with the specified ID in the group and select it
 295  *
 296  * @param g WGroup object
 297  * @param id widget ID
 298  */
 299
 300 void
 301 group_select_widget_by_id (const WGroup * g, unsigned long id)
 302 {
 303     Widget *w;
 304
 305     w = dlg_find_by_id (DIALOG (g), id);
 306     if (w != NULL)
 307         widget_select (w);
 308 }
 309
 310 /* --------------------------------------------------------------------------------------------- */