A bit of vlc/libvlc cleanup:

[vlc] / include / vlc_objects.h

diff --git a/include/vlc_objects.h b/include/vlc_objects.h
index b3965902ffa7258fb1add2b1a43736adbf4519b6..36df664f8a5c9a596735a34a3dcee25ef626bda9 100644 (file)
--- a/include/vlc_objects.h
+++ b/include/vlc_objects.h
@@ -1,7 +1,7 @@
 /*****************************************************************************
- * vlc_objects.h: vlc_object_t definition.
+ * vlc_objects.h: vlc_object_t definition and manipulation methods
  *****************************************************************************
- * Copyright (C) 2002 VideoLAN
+ * Copyright (C) 2002-2006 the VideoLAN team
  * $Id$
  *
  * Authors: Samuel Hocevar <sam@zoy.org>
@@ -18,12 +18,16 @@
  *
  * 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.
  *****************************************************************************/
 
+#if !defined( __LIBVLC__ )
+  #error You are not libvlc or one of its plugins. You cannot include this file
+#endif
+
 /**
  * \file
- * This file defines the vlc_object_t structure and object types
+ * This file defines the vlc_object_t structure and object types.
  */
 
 /**
@@ -32,34 +36,39 @@
  */
 
 /* Object types */
-#define VLC_OBJECT_ROOT       (-1)
-#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)
-#define VLC_OBJECT_VOUT       (-9)
-#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_GENERIC  (-666)
+#define VLC_OBJECT_GLOBAL      (-1)
+#define VLC_OBJECT_LIBVLC      (-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)
+#define VLC_OBJECT_VOUT        (-9)
+#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_HTTPD_HOST  (-30)
+#define VLC_OBJECT_META_ENGINE (-31)
+
+#define VLC_OBJECT_GENERIC     (-666)
 
 /* Object search mode */
 #define FIND_PARENT         0x0001
@@ -68,6 +77,11 @@
 
 #define FIND_STRICT         0x0010
 
+/* Object flags */
+#define OBJECT_FLAGS_NODBG       0x0001
+#define OBJECT_FLAGS_QUIET       0x0002
+#define OBJECT_FLAGS_NOINTERACT  0x0004
+
 /*****************************************************************************
  * The vlc_object_t type. Yes, it's that simple :-)
  *****************************************************************************/
@@ -90,6 +104,7 @@ 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( libvlc_int_t *, vlc_current_object, ( int ) );
 
 /*}@*/
 
@@ -120,4 +135,3 @@ VLC_EXPORT( void, vlc_list_release, ( vlc_list_t * ) );
 
 #define vlc_list_find(a,b,c) \
     __vlc_list_find( VLC_OBJECT(a),b,c)
-