1 /*****************************************************************************
2 * vlc_objects.h: vlc_object_t definition and manipulation methods
3 *****************************************************************************
4 * Copyright (C) 2002-2008 VLC authors and VideoLAN
7 * Authors: Samuel Hocevar <sam@zoy.org>
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.
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.
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 *****************************************************************************/
25 * \defgroup vlc_object VLC objects
29 * Common VLC object defintions
33 * VLC object common members
35 * Common public properties for all VLC objects.
36 * Object also have private properties maintained by the core, see
37 * \ref vlc_object_internals_t
39 struct vlc_common_members
43 * A constant string identifying the type of the object (for logging)
45 const char *object_type
;
47 /** Log messages header
49 * Human-readable header for log messages. This is not thread-safe and
50 * only used by VLM and Lua interfaces.
58 * A boolean during module probing when the probe is "forced".
59 * See \ref module_need().
65 * Root VLC object of the objects tree that this object belongs in.
71 * The parent VLC object in the objects tree. For the root (the LibVLC
72 * instance) object, this is NULL.
78 * Type-safe vlc_object_t cast
80 * This macro attempts to cast a pointer to a compound type to a
81 * \ref vlc_object_t pointer in a type-safe manner.
82 * It checks if the compound type actually starts with an embedded
83 * \ref vlc_object_t structure.
85 #if !defined(__cplusplus)
86 # define VLC_OBJECT(x) \
88 struct vlc_common_members: (vlc_object_t *)(&(x)->obj), \
89 const struct vlc_common_members: (const vlc_object_t *)(&(x)->obj) \
92 # define VLC_OBJECT( x ) ((vlc_object_t *)&(x)->obj)
96 #define OBJECT_FLAGS_QUIET 0x0002
97 #define OBJECT_FLAGS_NOINTERACT 0x0004
99 /*****************************************************************************
100 * The vlc_object_t type. Yes, it's that simple :-)
101 *****************************************************************************/
102 /** The main vlc_object_t structure */
105 struct vlc_common_members obj
;
108 /* The root object */
111 struct vlc_common_members obj
;
114 /*****************************************************************************
116 *****************************************************************************/
117 VLC_API
void *vlc_object_create( vlc_object_t
*, size_t ) VLC_MALLOC VLC_USED
;
118 VLC_API vlc_object_t
*vlc_object_find_name( vlc_object_t
*, const char * ) VLC_USED VLC_DEPRECATED
;
119 VLC_API
void * vlc_object_hold( vlc_object_t
* );
120 VLC_API
void vlc_object_release( vlc_object_t
* );
121 VLC_API vlc_list_t
*vlc_list_children( vlc_object_t
* ) VLC_USED
;
122 VLC_API
void vlc_list_release( vlc_list_t
* );
123 VLC_API
char *vlc_object_get_name( const vlc_object_t
* ) VLC_USED
;
124 #define vlc_object_get_name(o) vlc_object_get_name(VLC_OBJECT(o))
126 #define vlc_object_create(a,b) vlc_object_create( VLC_OBJECT(a), b )
128 #define vlc_object_find_name(a,b) \
129 vlc_object_find_name( VLC_OBJECT(a),b)
131 #define vlc_object_hold(a) \
132 vlc_object_hold( VLC_OBJECT(a) )
134 #define vlc_object_release(a) \
135 vlc_object_release( VLC_OBJECT(a) )
137 #define vlc_list_children(a) \
138 vlc_list_children( VLC_OBJECT(a) )
140 VLC_API VLC_MALLOC
void *vlc_obj_malloc(vlc_object_t
*, size_t);
141 VLC_API VLC_MALLOC
void *vlc_obj_calloc(vlc_object_t
*, size_t, size_t);
142 VLC_API
void vlc_obj_free(vlc_object_t
*, void *);