git.sesse.net Git - vlc/blob - src/misc/events.c

   1 /*****************************************************************************
   2  * events.c: events interface
   3  * This library provides an interface to the send and receive events.
   4  * It is more lightweight than variable based callback.
   5  * Methode
   6  *****************************************************************************
   7  * Copyright (C) 1998-2005 the VideoLAN team
   8  * $Id$
   9  *
  10  * Authors: Pierre d'Herbemont <pdherbemont # videolan.org >
  11  *
  12  * This program is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation; either version 2 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program 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, write to the Free Software
  24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  25  *****************************************************************************/
  26
  27 /*****************************************************************************
  28  * Preamble
  29  *****************************************************************************/
  30
  31 #include <vlc/vlc.h>
  32
  33 #include <stdio.h>                                               /* required */
  34 #include <stdlib.h>                                              /* malloc() */
  35
  36 #include <assert.h>
  37
  38 #include <vlc_events.h>
  39 #include <vlc_arrays.h>
  40
  41 /*****************************************************************************
  42  * Documentation : Read vlc_events.h
  43  *****************************************************************************/
  44
  45 /*****************************************************************************
  46  *  Private types.
  47  *****************************************************************************/
  48
  49 typedef struct vlc_event_listener_t
  50 {
  51     void *               p_user_data;
  52     vlc_event_callback_t pf_callback;
  53 } vlc_event_listener_t;
  54
  55 typedef struct vlc_event_listeners_group_t
  56 {
  57     vlc_event_type_t    event_type;
  58     DECL_ARRAY(struct vlc_event_listener_t *) listeners;
  59 } vlc_event_listeners_group_t;
  60
  61 /*****************************************************************************
  62  *
  63  *****************************************************************************/
  64
  65 /**
  66  * Initialize event manager object
  67  * p_this is the object that contains the event manager. But not
  68  * necessarily a vlc_object_t (an input_item_t is not a vlc_object_t
  69  * for instance).
  70  */
  71 int vlc_event_manager_init( vlc_event_manager_t * p_em, void * p_obj )
  72 {
  73     p_em->p_obj = p_obj;
  74     ARRAY_INIT( p_em->listeners_groups );
  75     return VLC_SUCCESS;
  76 }
  77
  78 /**
  79  * Destroy the event manager
  80  */
  81 void vlc_event_manager_fini( vlc_event_manager_t * p_em )
  82 {
  83     struct vlc_event_listeners_group_t * listeners_group;
  84     struct vlc_event_listener_t * listener;
  85
  86     FOREACH_ARRAY( listeners_group, p_em->listeners_groups )
  87         FOREACH_ARRAY( listener, listeners_group->listeners )
  88             free( listener );
  89         FOREACH_END()
  90         free( listeners_group );
  91     FOREACH_END()
  92     free( p_em );
  93 }
  94
  95 /**
  96  * Destroy the event manager
  97  */
  98 int vlc_event_manager_register_event_type(
  99         vlc_event_manager_t * p_em,
 100         vlc_event_type_t event_type )
 101 {
 102     vlc_event_listeners_group_t * listeners_group;
 103     listeners_group = malloc(sizeof(vlc_event_listeners_group_t));
 104
 105     if( !listeners_group )
 106         return VLC_ENOMEM;
 107
 108     listeners_group->event_type = event_type;
 109     ARRAY_INIT( listeners_group->listeners );
 110
 111     ARRAY_APPEND( p_em->listeners_groups, listeners_group );
 112
 113     return VLC_SUCCESS;
 114 }
 115
 116 /**
 117  * Send an event to the listener attached to this p_em.
 118  */
 119 void vlc_event_send( vlc_event_manager_t * p_em,
 120                      vlc_event_t * p_event )
 121 {
 122     vlc_event_listeners_group_t * listeners_group;
 123     vlc_event_listener_t * listener;
 124
 125     /* Fill event with the sending object now */
 126     p_event->p_obj = p_em->p_obj;
 127
 128     FOREACH_ARRAY( listeners_group, p_em->listeners_groups )
 129         if( listeners_group->event_type == p_event->type )
 130         {
 131             /* We found the group, now send every one the event */
 132             FOREACH_ARRAY( listener, listeners_group->listeners )
 133                 listener->pf_callback( p_event, listener->p_user_data );
 134             FOREACH_END()
 135             break;
 136         }
 137     FOREACH_END()
 138 }
 139
 140 /**
 141  * Add a callback for an event.
 142  */
 143 int vlc_event_attach( vlc_event_manager_t * p_event_manager,
 144                       vlc_event_type_t event_type,
 145                       vlc_event_callback_t pf_callback,
 146                       void *p_user_data )
 147 {
 148     vlc_event_listeners_group_t * listeners_group;
 149     vlc_event_listener_t * listener;
 150     listener = malloc(sizeof(vlc_event_listener_t));
 151     if( !listener )
 152         return VLC_ENOMEM;
 153
 154     listener->p_user_data = p_user_data;
 155     listener->pf_callback = pf_callback;
 156
 157     FOREACH_ARRAY( listeners_group, p_event_manager->listeners_groups )
 158         if( listeners_group->event_type == event_type )
 159         {
 160             ARRAY_APPEND( listeners_group->listeners, listener );
 161             return VLC_SUCCESS;
 162         }
 163     FOREACH_END()
 164
 165     free(listener);
 166     return VLC_EGENERIC;
 167 }
 168
 169 /**
 170  * Remove a callback for an event.
 171  */
 172 int vlc_event_detach( vlc_event_manager_t *p_event_manager,
 173                       vlc_event_type_t event_type,
 174                       vlc_event_callback_t pf_callback,
 175                       void *p_user_data )
 176 {
 177     vlc_event_listeners_group_t * listeners_group;
 178     struct vlc_event_listener_t * listener;
 179     FOREACH_ARRAY( listeners_group, p_event_manager->listeners_groups )
 180         if( listeners_group->event_type == event_type )
 181         {
 182             FOREACH_ARRAY( listener, listeners_group->listeners )
 183                 if( listener->pf_callback == pf_callback &&
 184                     listener->p_user_data == p_user_data )
 185                 {
 186                     /* that's our listener */
 187                     free( listener );
 188                     ARRAY_REMOVE( listeners_group->listeners,
 189                         fe_idx /* This comes from the macro (and that's why
 190                                   I hate macro) */ );
 191                     return VLC_SUCCESS;
 192                 }
 193             FOREACH_END()
 194         }
 195     FOREACH_END()
 196
 197     return VLC_EGENERIC;
 198 }
 199
 200