]> git.sesse.net Git - vlc/blob - src/misc/events.c
Do not free which has not been malloc'd - fixes #1263
[vlc] / 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 }
93
94 /**
95  * Destroy the event manager
96  */
97 int vlc_event_manager_register_event_type(
98         vlc_event_manager_t * p_em,
99         vlc_event_type_t event_type )
100 {
101     vlc_event_listeners_group_t * listeners_group;
102     listeners_group = malloc(sizeof(vlc_event_listeners_group_t));
103
104     if( !listeners_group )
105         return VLC_ENOMEM;
106
107     listeners_group->event_type = event_type;
108     ARRAY_INIT( listeners_group->listeners );
109
110     ARRAY_APPEND( p_em->listeners_groups, listeners_group );
111
112     return VLC_SUCCESS;
113 }
114
115 /**
116  * Send an event to the listener attached to this p_em.
117  */
118 void vlc_event_send( vlc_event_manager_t * p_em,
119                      vlc_event_t * p_event )
120 {
121     vlc_event_listeners_group_t * listeners_group;
122     vlc_event_listener_t * listener;
123
124     /* Fill event with the sending object now */
125     p_event->p_obj = p_em->p_obj;
126
127     FOREACH_ARRAY( listeners_group, p_em->listeners_groups )
128         if( listeners_group->event_type == p_event->type )
129         {
130             /* We found the group, now send every one the event */
131             FOREACH_ARRAY( listener, listeners_group->listeners )
132                 listener->pf_callback( p_event, listener->p_user_data );
133             FOREACH_END()
134             break;
135         }
136     FOREACH_END()
137 }
138
139 /**
140  * Add a callback for an event.
141  */
142 int vlc_event_attach( vlc_event_manager_t * p_event_manager,
143                       vlc_event_type_t event_type,
144                       vlc_event_callback_t pf_callback,
145                       void *p_user_data )
146 {
147     vlc_event_listeners_group_t * listeners_group;
148     vlc_event_listener_t * listener;
149     listener = malloc(sizeof(vlc_event_listener_t));
150     if( !listener )
151         return VLC_ENOMEM;
152     
153     listener->p_user_data = p_user_data;
154     listener->pf_callback = pf_callback;
155     
156     FOREACH_ARRAY( listeners_group, p_event_manager->listeners_groups )
157         if( listeners_group->event_type == event_type )
158         {
159             ARRAY_APPEND( listeners_group->listeners, listener );
160             return VLC_SUCCESS;
161         }
162     FOREACH_END()
163     
164     free(listener);
165     return VLC_EGENERIC;
166 }
167
168 /**
169  * Remove a callback for an event.
170  */
171 int vlc_event_detach( vlc_event_manager_t *p_event_manager,
172                       vlc_event_type_t event_type,
173                       vlc_event_callback_t pf_callback,
174                       void *p_user_data )
175 {
176     vlc_event_listeners_group_t * listeners_group;
177     struct vlc_event_listener_t * listener;
178     FOREACH_ARRAY( listeners_group, p_event_manager->listeners_groups )
179         if( listeners_group->event_type == event_type )
180         {
181             FOREACH_ARRAY( listener, listeners_group->listeners )
182                 if( listener->pf_callback == pf_callback &&
183                     listener->p_user_data == p_user_data )
184                 {
185                     /* that's our listener */
186                     free( listener );
187                     ARRAY_REMOVE( listeners_group->listeners,
188                         fe_idx /* This comes from the macro (and that's why
189                                   I hate macro) */ );
190                     return VLC_SUCCESS;
191                 }
192             FOREACH_END()
193         }
194     FOREACH_END()
195
196     return VLC_EGENERIC;
197 }
198
199