* vlc_objects.h: vlc_object_t definition.
*****************************************************************************
* Copyright (C) 2002 VideoLAN
- * $Id: vlc_objects.h,v 1.4 2002/06/07 14:59:40 sam Exp $
+ * $Id: vlc_objects.h,v 1.18 2003/09/18 17:54:02 zorglub Exp $
*
* Authors: Samuel Hocevar <sam@zoy.org>
*
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
*****************************************************************************/
+/**
+ * \file
+ * This file defines the vlc_object_t structure and object types
+ */
+
+/**
+ * \defgroup vlc_object Objects
+ * @{
+ */
+
/* Object types */
#define VLC_OBJECT_ROOT (-1)
-#define VLC_OBJECT_MODULE (-2)
-#define VLC_OBJECT_INTF (-3)
-#define VLC_OBJECT_PLAYLIST (-4)
-#define VLC_OBJECT_ITEM (-5)
-#define VLC_OBJECT_INPUT (-6)
-#define VLC_OBJECT_DECODER (-7)
-#define VLC_OBJECT_VOUT (-8)
-#define VLC_OBJECT_AOUT (-9)
-#define VLC_OBJECT_PRIVATE (-666)
+#define VLC_OBJECT_VLC (-2)
+#define VLC_OBJECT_MODULE (-3)
+#define VLC_OBJECT_INTF (-4)
+#define VLC_OBJECT_PLAYLIST (-5)
+#define VLC_OBJECT_ITEM (-6)
+#define VLC_OBJECT_INPUT (-7)
+#define VLC_OBJECT_DECODER (-8)
+/* tmp for backward compat */
+#define VLC_OBJECT_DECODER_FIFO (-999)
+#define VLC_OBJECT_VOUT (-9)
+#define VLC_OBJECT_AOUT (-10)
+#define VLC_OBJECT_SOUT (-11)
+#define VLC_OBJECT_HTTPD (-12)
+
+#define VLC_OBJECT_GENERIC (-666)
/* Object search mode */
#define FIND_PARENT 0x0001
#define FIND_STRICT 0x0010
+/*****************************************************************************
+ * 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_EXPORT( void *, __vlc_object_create, ( vlc_object_t *, int ) );
VLC_EXPORT( void, __vlc_object_destroy, ( vlc_object_t * ) );
+VLC_EXPORT( void, __vlc_object_attach, ( vlc_object_t *, vlc_object_t * ) );
+VLC_EXPORT( void, __vlc_object_detach, ( vlc_object_t * ) );
+VLC_EXPORT( void *, __vlc_object_get, ( vlc_object_t *, int ) );
VLC_EXPORT( void *, __vlc_object_find, ( vlc_object_t *, int, int ) );
VLC_EXPORT( void, __vlc_object_yield, ( vlc_object_t * ) );
VLC_EXPORT( void, __vlc_object_release, ( vlc_object_t * ) );
-VLC_EXPORT( void, __vlc_object_detach, ( vlc_object_t *, vlc_object_t * ) );
-VLC_EXPORT( void, __vlc_object_detach_all, ( vlc_object_t * ) );
-VLC_EXPORT( void, __vlc_object_attach, ( vlc_object_t *, vlc_object_t * ) );
-#if 0
-//VLC_EXPORT( void, __vlc_object_setchild, ( vlc_object_t *, vlc_object_t * ) );
-#endif
+VLC_EXPORT( vlc_list_t *, __vlc_list_find, ( vlc_object_t *, int, int ) );
+VLC_EXPORT( void, vlc_list_release, ( vlc_list_t * ) );
-VLC_EXPORT( void, __vlc_dumpstructure, ( vlc_object_t * ) );
+/*}@*/
#define vlc_object_create(a,b) \
- __vlc_object_create( CAST_TO_VLC_OBJECT(a), b )
+ __vlc_object_create( VLC_OBJECT(a), b )
#define vlc_object_destroy(a) do { \
- __vlc_object_destroy( CAST_TO_VLC_OBJECT(a) ); \
+ __vlc_object_destroy( VLC_OBJECT(a) ); \
(a) = NULL; } while(0)
-#define vlc_object_find(a,b,c) \
- __vlc_object_find( CAST_TO_VLC_OBJECT(a),b,c)
-
-#define vlc_object_yield(a) \
- __vlc_object_yield( CAST_TO_VLC_OBJECT(a) )
+#define vlc_object_detach(a) \
+ __vlc_object_detach( VLC_OBJECT(a) )
-#define vlc_object_release(a) \
- __vlc_object_release( CAST_TO_VLC_OBJECT(a) )
+#define vlc_object_attach(a,b) \
+ __vlc_object_attach( VLC_OBJECT(a), VLC_OBJECT(b) )
-#define vlc_object_detach(a,b) \
- __vlc_object_detach( CAST_TO_VLC_OBJECT(a), CAST_TO_VLC_OBJECT(b) )
+#define vlc_object_get(a,b) \
+ __vlc_object_get( VLC_OBJECT(a),b)
-#define vlc_object_detach_all(a) \
- __vlc_object_detach_all( CAST_TO_VLC_OBJECT(a) )
+#define vlc_object_find(a,b,c) \
+ __vlc_object_find( VLC_OBJECT(a),b,c)
-#define vlc_object_attach(a,b) \
- __vlc_object_attach( CAST_TO_VLC_OBJECT(a), CAST_TO_VLC_OBJECT(b) )
+#define vlc_object_yield(a) \
+ __vlc_object_yield( VLC_OBJECT(a) )
-#if 0
-#define vlc_object_setchild(a,b) \
- __vlc_object_setchild( CAST_TO_VLC_OBJECT(a), CAST_TO_VLC_OBJECT(b) )
-#endif
+#define vlc_object_release(a) \
+ __vlc_object_release( VLC_OBJECT(a) )
-#define vlc_dumpstructure(a) \
- __vlc_dumpstructure( CAST_TO_VLC_OBJECT(a) )
+#define vlc_list_find(a,b,c) \
+ __vlc_list_find( VLC_OBJECT(a),b,c)