lib/event/manage.c

   1 /*
   2    Handle any events in application.
   3    Manage events: add, delete, destroy, search
   4
   5    Copyright (C) 2011
   6    The Free Software Foundation, Inc.
   7
   8    Written by:
   9    Slava Zanko <slavazanko@gmail.com>, 2011.
  10
  11    This file is part of the Midnight Commander.
  12
  13    The Midnight Commander is free software: you can redistribute it
  14    and/or modify it under the terms of the GNU General Public License as
  15    published by the Free Software Foundation, either version 3 of the License,
  16    or (at your option) any later version.
  17
  18    The Midnight Commander is distributed in the hope that it will be useful,
  19    but WITHOUT ANY WARRANTY; without even the implied warranty of
  20    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21    GNU General Public License for more details.
  22
  23    You should have received a copy of the GNU General Public License
  24    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  25  */
  26
  27 #include <config.h>
  28
  29 #include "lib/global.h"
  30 #include "lib/event.h"
  31
  32 #include "internal.h"
  33
  34 /*** global variables ****************************************************************************/
  35
  36 /*** file scope macro definitions ****************************************************************/
  37
  38 /*** file scope type declarations ****************************************************************/
  39
  40 /*** file scope variables ************************************************************************/
  41
  42 /*** file scope functions ************************************************************************/
  43 /* --------------------------------------------------------------------------------------------- */
  44
  45 static void
  46 mc_event_group_destroy_value (gpointer data)
  47 {
  48     GPtrArray *callbacks;
  49
  50     callbacks = (GPtrArray *) data;
  51     g_ptr_array_foreach (callbacks, (GFunc) g_free, NULL);
  52     g_ptr_array_free (callbacks, TRUE);
  53 }
  54
  55 /* --------------------------------------------------------------------------------------------- */
  56
  57
  58 /* --------------------------------------------------------------------------------------------- */
  59 /*** public functions ****************************************************************************/
  60 /* --------------------------------------------------------------------------------------------- */
  61
  62 gboolean
  63 mc_event_add (const gchar * event_group_name, const gchar * event_name,
  64               mc_event_callback_func_t event_callback, gpointer event_init_data, GError ** mcerror)
  65 {
  66
  67     GTree *event_group;
  68     GPtrArray *callbacks;
  69     mc_event_callback_t *cb;
  70
  71     if (mc_event_grouplist == NULL || event_group_name == NULL || event_name == NULL
  72         || event_callback == NULL)
  73     {
  74         g_propagate_error (mcerror,
  75                            g_error_new (MC_ERROR, 1,
  76                                         _("Check input data! Some of parameters are NULL!")));
  77         return FALSE;
  78     }
  79
  80     event_group = mc_event_get_event_group_by_name (event_group_name, TRUE, mcerror);
  81     if (event_group == NULL)
  82         return FALSE;
  83
  84     callbacks = mc_event_get_event_by_name (event_group, event_name, TRUE, mcerror);
  85     if (callbacks == NULL)
  86         return FALSE;
  87
  88     cb = mc_event_is_callback_in_array (callbacks, event_callback, event_init_data);
  89     if (cb == NULL)
  90     {
  91         cb = g_new0 (mc_event_callback_t, 1);
  92         cb->callback = event_callback;
  93         g_ptr_array_add (callbacks, (gpointer) cb);
  94     }
  95     cb->init_data = event_init_data;
  96     return TRUE;
  97 }
  98
  99 /* --------------------------------------------------------------------------------------------- */
 100
 101 void
 102 mc_event_del (const gchar * event_group_name, const gchar * event_name,
 103               mc_event_callback_func_t event_callback, gpointer event_init_data)
 104 {
 105     GTree *event_group;
 106     GPtrArray *callbacks;
 107     mc_event_callback_t *cb;
 108
 109     if (mc_event_grouplist == NULL || event_group_name == NULL || event_name == NULL
 110         || event_callback == NULL)
 111         return;
 112
 113     event_group = mc_event_get_event_group_by_name (event_group_name, FALSE, NULL);
 114     if (event_group == NULL)
 115         return;
 116
 117     callbacks = mc_event_get_event_by_name (event_group, event_name, FALSE, NULL);
 118     if (callbacks == NULL)
 119         return;
 120
 121     cb = mc_event_is_callback_in_array (callbacks, event_callback, event_init_data);
 122
 123     if (cb == NULL)
 124         return;
 125
 126     g_ptr_array_remove (callbacks, (gpointer) cb);
 127     g_free ((gpointer) cb);
 128 }
 129
 130 /* --------------------------------------------------------------------------------------------- */
 131
 132 void
 133 mc_event_destroy (const gchar * event_group_name, const gchar * event_name)
 134 {
 135     GTree *event_group;
 136
 137     if (mc_event_grouplist == NULL || event_group_name == NULL || event_name == NULL)
 138         return;
 139
 140     event_group = mc_event_get_event_group_by_name (event_group_name, FALSE, NULL);
 141     g_tree_remove (event_group, (gconstpointer) event_name);
 142 }
 143
 144 /* --------------------------------------------------------------------------------------------- */
 145
 146 void
 147 mc_event_group_del (const gchar * event_group_name)
 148 {
 149
 150     if (mc_event_grouplist != NULL && event_group_name != NULL)
 151         g_tree_remove (mc_event_grouplist, (gconstpointer) event_group_name);
 152 }
 153
 154 /* --------------------------------------------------------------------------------------------- */
 155
 156 GTree *
 157 mc_event_get_event_group_by_name (const gchar * event_group_name, gboolean create_new,
 158                                   GError ** mcerror)
 159 {
 160     GTree *event_group;
 161
 162     event_group = (GTree *) g_tree_lookup (mc_event_grouplist, (gconstpointer) event_group_name);
 163     if (event_group == NULL && create_new)
 164     {
 165         event_group =
 166             g_tree_new_full ((GCompareDataFunc) g_ascii_strcasecmp,
 167                              NULL,
 168                              (GDestroyNotify) g_free,
 169                              (GDestroyNotify) mc_event_group_destroy_value);
 170         if (event_group == NULL)
 171         {
 172             g_propagate_error (mcerror,
 173                                g_error_new (MC_ERROR, 1,
 174                                             _("Unable to create group '%s' for events!"),
 175                                             event_group_name));
 176             return NULL;
 177         }
 178         g_tree_insert (mc_event_grouplist, g_strdup (event_group_name), (gpointer) event_group);
 179     }
 180     return event_group;
 181 }
 182
 183 /* --------------------------------------------------------------------------------------------- */
 184
 185 GPtrArray *
 186 mc_event_get_event_by_name (GTree * event_group, const gchar * event_name, gboolean create_new,
 187                             GError ** mcerror)
 188 {
 189     GPtrArray *callbacks;
 190
 191     callbacks = (GPtrArray *) g_tree_lookup (event_group, (gconstpointer) event_name);
 192     if (callbacks == NULL && create_new)
 193     {
 194         callbacks = g_ptr_array_new ();
 195         if (callbacks == NULL)
 196         {
 197             g_propagate_error (mcerror,
 198                                g_error_new (MC_ERROR, 1,
 199                                             _("Unable to create event '%s'!"), event_name));
 200             return NULL;
 201         }
 202         g_tree_insert (event_group, g_strdup (event_name), (gpointer) callbacks);
 203     }
 204     return callbacks;
 205 }
 206
 207 /* --------------------------------------------------------------------------------------------- */
 208
 209 mc_event_callback_t *
 210 mc_event_is_callback_in_array (GPtrArray * callbacks, mc_event_callback_func_t event_callback,
 211                                gpointer event_init_data)
 212 {
 213     guint array_index;
 214
 215     for (array_index = 0; array_index < callbacks->len; array_index++)
 216     {
 217         mc_event_callback_t *cb = g_ptr_array_index (callbacks, array_index);
 218         if (cb->callback == event_callback && cb->init_data == event_init_data)
 219             return cb;
 220     }
 221     return NULL;
 222 }
 223
 224 /* --------------------------------------------------------------------------------------------- */