vlc_objects.h 2.83 KB
Newer Older
1
/*****************************************************************************
2
 * vlc_objects.h: vlc_object_t definition and manipulation methods
3
 *****************************************************************************
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
4
 * Copyright (C) 2002-2008 VLC authors and VideoLAN
5
 * $Id$
6 7 8
 *
 * Authors: Samuel Hocevar <sam@zoy.org>
 *
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
9 10 11
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
12
 * (at your option) any later version.
13
 *
14 15
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
16 17
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
18
 *
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
19 20 21
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 23
 *****************************************************************************/

Clément Stenac's avatar
Clément Stenac committed
24
/**
25
 * \defgroup vlc_object VLC objects
Clément Stenac's avatar
Clément Stenac committed
26
 * @{
27 28
 * \file
 * Common VLC object defintions
Clément Stenac's avatar
Clément Stenac committed
29 30
 */

31 32 33 34
/* Object flags */
#define OBJECT_FLAGS_QUIET       0x0002
#define OBJECT_FLAGS_NOINTERACT  0x0004

Sam Hocevar's avatar
Sam Hocevar committed
35 36 37
/*****************************************************************************
 * The vlc_object_t type. Yes, it's that simple :-)
 *****************************************************************************/
Clément Stenac's avatar
Clément Stenac committed
38
/** The main vlc_object_t structure */
Sam Hocevar's avatar
Sam Hocevar committed
39 40 41 42 43
struct vlc_object_t
{
    VLC_COMMON_MEMBERS
};

44 45 46
/*****************************************************************************
 * Prototypes
 *****************************************************************************/
47
VLC_API void *vlc_object_create( vlc_object_t *, size_t ) VLC_MALLOC VLC_USED;
48
VLC_API vlc_object_t *vlc_object_find_name( vlc_object_t *, const char * ) VLC_USED VLC_DEPRECATED;
49 50
VLC_API void * vlc_object_hold( vlc_object_t * );
VLC_API void vlc_object_release( vlc_object_t * );
51
VLC_API vlc_list_t *vlc_list_children( vlc_object_t * ) VLC_USED;
52
VLC_API void vlc_list_release( vlc_list_t * );
53
VLC_API char *vlc_object_get_name( const vlc_object_t * ) VLC_USED;
54
#define vlc_object_get_name(o) vlc_object_get_name(VLC_OBJECT(o))
55

56
#define vlc_object_create(a,b) vlc_object_create( VLC_OBJECT(a), b )
57

58 59
#define vlc_object_find_name(a,b) \
    vlc_object_find_name( VLC_OBJECT(a),b)
60

61
#define vlc_object_hold(a) \
62
    vlc_object_hold( VLC_OBJECT(a) )
63 64

#define vlc_object_release(a) \
65
    vlc_object_release( VLC_OBJECT(a) )
66

67
#define vlc_list_children(a) \
68
    vlc_list_children( VLC_OBJECT(a) )
69

70 71 72 73
VLC_API VLC_MALLOC void *vlc_malloc(vlc_object_t *, size_t);
VLC_API VLC_MALLOC void *vlc_calloc(vlc_object_t *, size_t, size_t);
VLC_API void vlc_free(vlc_object_t *, void *);

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
74
/** @} */