git.sesse.net Git - vlc/blob - include/vlc_objects.h

   1 /*****************************************************************************
   2  * vlc_objects.h: vlc_object_t definition.
   3  *****************************************************************************
   4  * Copyright (C) 2002 VideoLAN
   5  * $Id: vlc_objects.h,v 1.4 2002/06/07 14:59:40 sam Exp $
   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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  22  *****************************************************************************/
  23
  24 /* Object types */
  25 #define VLC_OBJECT_ROOT       (-1)
  26 #define VLC_OBJECT_MODULE     (-2)
  27 #define VLC_OBJECT_INTF       (-3)
  28 #define VLC_OBJECT_PLAYLIST   (-4)
  29 #define VLC_OBJECT_ITEM       (-5)
  30 #define VLC_OBJECT_INPUT      (-6)
  31 #define VLC_OBJECT_DECODER    (-7)
  32 #define VLC_OBJECT_VOUT       (-8)
  33 #define VLC_OBJECT_AOUT       (-9)
  34 #define VLC_OBJECT_PRIVATE  (-666)
  35
  36 /* Object search mode */
  37 #define FIND_PARENT         0x0001
  38 #define FIND_CHILD          0x0002
  39 #define FIND_ANYWHERE       0x0003
  40
  41 #define FIND_STRICT         0x0010
  42
  43 /*****************************************************************************
  44  * Prototypes
  45  *****************************************************************************/
  46 VLC_EXPORT( void *, __vlc_object_create, ( vlc_object_t *, int ) );
  47 VLC_EXPORT( void, __vlc_object_destroy, ( vlc_object_t * ) );
  48 VLC_EXPORT( void *, __vlc_object_find, ( vlc_object_t *, int, int ) );
  49 VLC_EXPORT( void, __vlc_object_yield, ( vlc_object_t * ) );
  50 VLC_EXPORT( void, __vlc_object_release, ( vlc_object_t * ) );
  51 VLC_EXPORT( void, __vlc_object_detach, ( vlc_object_t *, vlc_object_t * ) );
  52 VLC_EXPORT( void, __vlc_object_detach_all, ( vlc_object_t * ) );
  53 VLC_EXPORT( void, __vlc_object_attach, ( vlc_object_t *, vlc_object_t * ) );
  54 #if 0
  55 //VLC_EXPORT( void, __vlc_object_setchild, ( vlc_object_t *, vlc_object_t * ) );
  56 #endif
  57
  58 VLC_EXPORT( void, __vlc_dumpstructure, ( vlc_object_t * ) );
  59
  60 #define vlc_object_create(a,b) \
  61     __vlc_object_create( CAST_TO_VLC_OBJECT(a), b )
  62
  63 #define vlc_object_destroy(a) do { \
  64     __vlc_object_destroy( CAST_TO_VLC_OBJECT(a) ); \
  65     (a) = NULL; } while(0)
  66
  67 #define vlc_object_find(a,b,c) \
  68     __vlc_object_find( CAST_TO_VLC_OBJECT(a),b,c)
  69
  70 #define vlc_object_yield(a) \
  71     __vlc_object_yield( CAST_TO_VLC_OBJECT(a) )
  72
  73 #define vlc_object_release(a) \
  74     __vlc_object_release( CAST_TO_VLC_OBJECT(a) )
  75
  76 #define vlc_object_detach(a,b) \
  77     __vlc_object_detach( CAST_TO_VLC_OBJECT(a), CAST_TO_VLC_OBJECT(b) )
  78
  79 #define vlc_object_detach_all(a) \
  80     __vlc_object_detach_all( CAST_TO_VLC_OBJECT(a) )
  81
  82 #define vlc_object_attach(a,b) \
  83     __vlc_object_attach( CAST_TO_VLC_OBJECT(a), CAST_TO_VLC_OBJECT(b) )
  84
  85 #if 0
  86 #define vlc_object_setchild(a,b) \
  87     __vlc_object_setchild( CAST_TO_VLC_OBJECT(a), CAST_TO_VLC_OBJECT(b) )
  88 #endif
  89
  90 #define vlc_dumpstructure(a) \
  91     __vlc_dumpstructure( CAST_TO_VLC_OBJECT(a) )
  92