80 lines
2.9 KiB
C
80 lines
2.9 KiB
C
/*****************************************************************************
|
|
* vlc_objects.h: vlc_object_t definition and manipulation methods
|
|
*****************************************************************************
|
|
* Copyright (C) 2002-2008 VLC authors and VideoLAN
|
|
* $Id: c6708750ee9cd68a9fce0246f019ad8aec80432b $
|
|
*
|
|
* Authors: Samuel Hocevar <sam@zoy.org>
|
|
*
|
|
* 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
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Lesser General Public License for more details.
|
|
*
|
|
* 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.
|
|
*****************************************************************************/
|
|
|
|
/**
|
|
* \file
|
|
* This file defines the vlc_object_t structure and object types.
|
|
*/
|
|
|
|
/**
|
|
* \defgroup vlc_object Objects
|
|
* @{
|
|
*/
|
|
|
|
/* Object flags */
|
|
#define OBJECT_FLAGS_QUIET 0x0002
|
|
#define OBJECT_FLAGS_NOINTERACT 0x0004
|
|
|
|
/*****************************************************************************
|
|
* The vlc_object_t type. Yes, it's that simple :-)
|
|
*****************************************************************************/
|
|
/** The main vlc_object_t structure */
|
|
struct vlc_object_t
|
|
{
|
|
VLC_COMMON_MEMBERS
|
|
};
|
|
|
|
/*****************************************************************************
|
|
* Prototypes
|
|
*****************************************************************************/
|
|
VLC_API void *vlc_object_create( vlc_object_t *, size_t ) VLC_MALLOC VLC_USED;
|
|
VLC_API vlc_object_t *vlc_object_find_name( vlc_object_t *, const char * ) VLC_USED VLC_DEPRECATED;
|
|
VLC_API void * vlc_object_hold( vlc_object_t * );
|
|
VLC_API void vlc_object_release( vlc_object_t * );
|
|
VLC_API vlc_list_t *vlc_list_children( vlc_object_t * ) VLC_USED;
|
|
VLC_API void vlc_list_release( vlc_list_t * );
|
|
VLC_API char *vlc_object_get_name( const vlc_object_t * ) VLC_USED;
|
|
#define vlc_object_get_name(o) vlc_object_get_name(VLC_OBJECT(o))
|
|
|
|
/**}@*/
|
|
|
|
#define vlc_object_create(a,b) vlc_object_create( VLC_OBJECT(a), b )
|
|
|
|
#define vlc_object_find_name(a,b) \
|
|
vlc_object_find_name( VLC_OBJECT(a),b)
|
|
|
|
#define vlc_object_hold(a) \
|
|
vlc_object_hold( VLC_OBJECT(a) )
|
|
|
|
#define vlc_object_release(a) \
|
|
vlc_object_release( VLC_OBJECT(a) )
|
|
|
|
#define vlc_list_children(a) \
|
|
vlc_list_children( VLC_OBJECT(a) )
|
|
|
|
/* Objects and threading */
|
|
VLC_API VLC_USED VLC_DEPRECATED bool vlc_object_alive (vlc_object_t *);
|
|
#define vlc_object_alive(a) vlc_object_alive( VLC_OBJECT(a) )
|
|
|
|
/** @} */
|