1 /*****************************************************************************
2  * vlc_objects.h: vlc_object_t definition and manipulation methods
3  *****************************************************************************
4  * Copyright (C) 2002-2008 VLC authors and VideoLAN
5  * $Id: 4a2814187a5cc68b0e65d6dce3dd4a0d9e8fbe59 $
6  *
7  * Authors: Samuel Hocevar <sam@zoy.org>
8  *
9  * This program is free software; you can redistribute it and/or modify it
10  * under the terms of the GNU Lesser General Public License as published by
11  * the Free Software Foundation; either version 2.1 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22  *****************************************************************************/
23 
24 /**
25  * \defgroup vlc_object VLC objects
26  * @{
27  * \file
28  * Common VLC object defintions
29  */
30 
31 /* Object flags */
32 #define OBJECT_FLAGS_QUIET       0x0002
33 #define OBJECT_FLAGS_NOINTERACT  0x0004
34 #define OBJECT_FLAGS_INSECURE    0x1000 /* VLC 3.0 only, will be removed */
35 
36 /*****************************************************************************
37  * The vlc_object_t type. Yes, it's that simple :-)
38  *****************************************************************************/
39 /** The main vlc_object_t structure */
40 struct vlc_object_t
41 {
42     VLC_COMMON_MEMBERS
43 };
44 
45 /*****************************************************************************
46  * Prototypes
47  *****************************************************************************/
48 VLC_API void *vlc_object_create( vlc_object_t *, size_t ) VLC_MALLOC VLC_USED;
49 VLC_API vlc_object_t *vlc_object_find_name( vlc_object_t *, const char * ) VLC_USED VLC_DEPRECATED;
50 VLC_API void * vlc_object_hold( vlc_object_t * );
51 VLC_API void vlc_object_release( vlc_object_t * );
52 VLC_API vlc_list_t *vlc_list_children( vlc_object_t * ) VLC_USED;
53 VLC_API void vlc_list_release( vlc_list_t * );
54 VLC_API char *vlc_object_get_name( const vlc_object_t * ) VLC_USED;
55 #define vlc_object_get_name(o) vlc_object_get_name(VLC_OBJECT(o))
56 
57 #define vlc_object_create(a,b) vlc_object_create( VLC_OBJECT(a), b )
58 
59 #define vlc_object_find_name(a,b) \
60     vlc_object_find_name( VLC_OBJECT(a),b)
61 
62 #define vlc_object_hold(a) \
63     vlc_object_hold( VLC_OBJECT(a) )
64 
65 #define vlc_object_release(a) \
66     vlc_object_release( VLC_OBJECT(a) )
67 
68 #define vlc_list_children(a) \
69     vlc_list_children( VLC_OBJECT(a) )
70 
71 VLC_API VLC_MALLOC void *vlc_obj_malloc(vlc_object_t *, size_t);
72 VLC_API VLC_MALLOC void *vlc_obj_calloc(vlc_object_t *, size_t, size_t);
73 VLC_API void vlc_obj_free(vlc_object_t *, void *);
74 
75 /** @} */
76