FSF address change.

[vlc] / include / vlc_objects.h

diff --git a/include/vlc_objects.h b/include/vlc_objects.h
index ed0484b39523650abc0aceae913f03abd4915333..7e87b9e49d603d1040fe429251cb7ac690aaac7f 100644 (file)
--- a/include/vlc_objects.h
+++ b/include/vlc_objects.h
@@ -1,8 +1,8 @@
 /*****************************************************************************
- * vlc_objects.h: vlc_object_t definition.
+ * vlc_objects.h: vlc_object_t definition and manipulation methods
  *****************************************************************************
- * Copyright (C) 2002 VideoLAN
- * $Id: vlc_objects.h,v 1.11 2002/10/03 13:21:54 sam Exp $
+ * Copyright (C) 2002 the VideoLAN team
+ * $Id$
  *
  * Authors: Samuel Hocevar <sam@zoy.org>
  *
@@ -10,7 +10,7 @@
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 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
@@ -18,9 +18,19 @@
  *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
+ * 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 types */
 #define VLC_OBJECT_ROOT       (-1)
 #define VLC_OBJECT_VLC        (-2)
@@ -31,8 +41,27 @@
 #define VLC_OBJECT_INPUT      (-7)
 #define VLC_OBJECT_DECODER    (-8)
 #define VLC_OBJECT_VOUT       (-9)
-#define VLC_OBJECT_AOUT      (-10)
-#define VLC_OBJECT_SOUT      (-11)
+#define VLC_OBJECT_AOUT       (-10)
+#define VLC_OBJECT_SOUT       (-11)
+#define VLC_OBJECT_HTTPD      (-12)
+#define VLC_OBJECT_PACKETIZER (-13)
+#define VLC_OBJECT_ENCODER    (-14)
+#define VLC_OBJECT_DIALOGS    (-15)
+#define VLC_OBJECT_VLM        (-16)
+#define VLC_OBJECT_ANNOUNCE   (-17)
+#define VLC_OBJECT_DEMUX      (-18)
+#define VLC_OBJECT_ACCESS     (-19)
+#define VLC_OBJECT_STREAM     (-20)
+#define VLC_OBJECT_OPENGL     (-21)
+#define VLC_OBJECT_FILTER     (-22)
+#define VLC_OBJECT_VOD        (-23)
+#define VLC_OBJECT_SPU        (-24)
+#define VLC_OBJECT_TLS        (-25)
+#define VLC_OBJECT_SD         (-26)
+#define VLC_OBJECT_XML        (-27)
+#define VLC_OBJECT_OSDMENU    (-28)
+#define VLC_OBJECT_STATS      (-29)
+
 #define VLC_OBJECT_GENERIC  (-666)
 
 /* Object search mode */
@@ -42,6 +71,15 @@
 
 #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
  *****************************************************************************/
@@ -49,14 +87,14 @@ 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( vlc_list_t *, __vlc_list_find, ( vlc_object_t *, int, int ) );
 VLC_EXPORT( void, vlc_list_release, ( vlc_list_t * ) );
 
-VLC_EXPORT( void, __vlc_liststructure, ( vlc_object_t * ) );
-VLC_EXPORT( void, __vlc_dumpstructure, ( vlc_object_t * ) );
+/*}@*/
 
 #define vlc_object_create(a,b) \
     __vlc_object_create( VLC_OBJECT(a), b )
@@ -71,6 +109,9 @@ VLC_EXPORT( void, __vlc_dumpstructure, ( vlc_object_t * ) );
 #define vlc_object_attach(a,b) \
     __vlc_object_attach( VLC_OBJECT(a), VLC_OBJECT(b) )
 
+#define vlc_object_get(a,b) \
+    __vlc_object_get( VLC_OBJECT(a),b)
+
 #define vlc_object_find(a,b,c) \
     __vlc_object_find( VLC_OBJECT(a),b,c)
 
@@ -83,9 +124,3 @@ VLC_EXPORT( void, __vlc_dumpstructure, ( vlc_object_t * ) );
 #define vlc_list_find(a,b,c) \
     __vlc_list_find( VLC_OBJECT(a),b,c)
 
-#define vlc_liststructure(a) \
-    __vlc_liststructure( VLC_OBJECT(a) )
-
-#define vlc_dumpstructure(a) \
-    __vlc_dumpstructure( VLC_OBJECT(a) )
-