include/vlc_objects.h

   1 /*****************************************************************************
   2  * vlc_objects.h: vlc_object_t definition and manipulation methods
   3  *****************************************************************************
   4  * Copyright (C) 2002-2008 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Samuel Hocevar <sam@zoy.org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 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 General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 /**
  25  * \file
  26  * This file defines the vlc_object_t structure and object types.
  27  */
  28
  29 /**
  30  * \defgroup vlc_object Objects
  31  * @{
  32  */
  33
  34 /* Object flags */
  35 #define OBJECT_FLAGS_NODBG       0x0001
  36 #define OBJECT_FLAGS_QUIET       0x0002
  37 #define OBJECT_FLAGS_NOINTERACT  0x0004
  38
  39 /*****************************************************************************
  40  * The vlc_object_t type. Yes, it's that simple :-)
  41  *****************************************************************************/
  42 /** The main vlc_object_t structure */
  43 struct vlc_object_t
  44 {
  45     VLC_COMMON_MEMBERS
  46 };
  47
  48 /*****************************************************************************
  49  * Prototypes
  50  *****************************************************************************/
  51 VLC_API void *vlc_object_create( vlc_object_t *, size_t ) VLC_MALLOC VLC_USED;
  52 VLC_API vlc_object_t *vlc_object_find_name( vlc_object_t *, const char * ) VLC_USED VLC_DEPRECATED;
  53 VLC_API void * vlc_object_hold( vlc_object_t * );
  54 VLC_API void vlc_object_release( vlc_object_t * );
  55 VLC_API vlc_list_t *vlc_list_children( vlc_object_t * ) VLC_USED;
  56 VLC_API void vlc_list_release( vlc_list_t * );
  57 VLC_API char *vlc_object_get_name( const vlc_object_t * ) VLC_USED;
  58 #define vlc_object_get_name(o) vlc_object_get_name(VLC_OBJECT(o))
  59
  60 /**}@*/
  61
  62 #define vlc_object_create(a,b) vlc_object_create( VLC_OBJECT(a), b )
  63
  64 #define vlc_object_find_name(a,b) \
  65     vlc_object_find_name( VLC_OBJECT(a),b)
  66
  67 #define vlc_object_hold(a) \
  68     vlc_object_hold( VLC_OBJECT(a) )
  69
  70 #define vlc_object_release(a) \
  71     vlc_object_release( VLC_OBJECT(a) )
  72
  73 #define vlc_list_children(a) \
  74     vlc_list_children( VLC_OBJECT(a) )
  75
  76 /* Objects and threading */
  77 VLC_API void vlc_object_kill( vlc_object_t * ) VLC_DEPRECATED;
  78 #define vlc_object_kill(a) \
  79     vlc_object_kill( VLC_OBJECT(a) )
  80
  81 VLC_USED VLC_DEPRECATED
  82 static inline bool vlc_object_alive (const vlc_object_t *obj)
  83 {
  84     barrier ();
  85     return !obj->b_die;
  86 }
  87
  88 #define vlc_object_alive(a) vlc_object_alive( VLC_OBJECT(a) )
  89
  90 /** @} */