Add facilities to report and enrich error messages.

[vlc] / include / vlc_messages.h

diff --git a/include/vlc_messages.h b/include/vlc_messages.h
index 7b9e7d6227b3f9bb1b5a3912a07d66a5e3a72f36..a08b12efb18d01a6d7181052472e987ee75b919f 100644 (file)
--- a/include/vlc_messages.h
+++ b/include/vlc_messages.h
@@ -24,6 +24,13 @@
  * 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
+
+#ifndef _VLC_MESSAGES_H_
+#define _VLC_MESSAGES_H_
+
 #include <stdarg.h>
 
 int vlc_mutex_lock(  vlc_mutex_t * ) ;
@@ -37,9 +44,19 @@ int vlc_mutex_unlock(  vlc_mutex_t * ) ;
  * @{
  */
 
+/** Internal message stack context */
+typedef struct
+{
+    int i_code;
+    char * psz_message;
+} msg_context_t;
+
+VLC_EXPORT( void,  msg_StackSet, ( int, const char*, ... ) );
+VLC_EXPORT( void,  msg_StackAdd, ( const char*, ... ) );
+VLC_EXPORT( const char*, msg_StackMsg, ( void ) );
 
 /**
- * Store a single message.
+ * Store a single message sent to user.
  */
 typedef struct
 {
@@ -65,16 +82,7 @@ typedef struct
 
 #define MSG_QUEUE_NORMAL 0
 #define MSG_QUEUE_HTTPD_ACCESS 1
-
-/**
- * Store all data requiered by messages interfaces.
- */
-struct msg_bank_t
-{
-    vlc_mutex_t             lock;
-    int                     i_queues;
-    msg_queue_t           **pp_queues;
-};
+#define NB_QUEUES 2
 
 struct msg_queue_t
 {
@@ -99,6 +107,15 @@ struct msg_queue_t
 #endif
 };
 
+/**
+ * Store all data requiered by messages interfaces.
+ */
+struct msg_bank_t
+{
+    vlc_mutex_t             lock;
+    msg_queue_t             queues[NB_QUEUES];
+};
+
 /**
  * Used by interface plugins which subscribe to the message bank.
  */
@@ -196,6 +213,7 @@ void __msg_Destroy ( vlc_object_t * );
 VLC_EXPORT( msg_subscription_t*, __msg_Subscribe, ( vlc_object_t *, int ) );
 VLC_EXPORT( void, __msg_Unsubscribe, ( vlc_object_t *, msg_subscription_t * ) );
 
+const char *msg_GetObjectTypeName(int i_object_type );
 
 /**
  * @}
@@ -259,7 +277,9 @@ enum
     STATS_DISPLAYED_PICTURES,
     STATS_LOST_PICTURES,
 
-    STATS_TIMER_PLAYLIST_WALK,
+    STATS_TIMER_PLAYLIST_BUILD,
+    STATS_TIMER_ML_LOAD,
+    STATS_TIMER_ML_DUMP,
     STATS_TIMER_INTERACTION,
     STATS_TIMER_PREPARSE,
 
@@ -281,6 +301,7 @@ static inline int __stats_GetInteger( vlc_object_t *p_obj, counter_t *p_counter,
 {
     int i_ret;
     vlc_value_t val; val.i_int = 0;
+    if( !p_counter ) return VLC_EGENERIC;
     i_ret = __stats_Get( p_obj, p_counter, &val );
     *value = val.i_int;
     return i_ret;
@@ -292,6 +313,7 @@ static inline int __stats_GetFloat( vlc_object_t *p_obj, counter_t *p_counter,
 {
     int i_ret;
     vlc_value_t val; val.f_float = 0.0;
+    if( !p_counter ) return VLC_EGENERIC;
     i_ret = __stats_Get( p_obj, p_counter, &val );
     *value = val.f_float;
     return i_ret;
@@ -303,6 +325,7 @@ static inline int __stats_UpdateInteger( vlc_object_t *p_obj,counter_t *p_co,
     int i_ret;
     vlc_value_t val;
     vlc_value_t new_val; new_val.i_int = 0;
+    if( !p_co ) return VLC_EGENERIC;
     val.i_int = i;
     i_ret = __stats_Update( p_obj, p_co, val, &new_val );
     if( pi_new )
@@ -316,6 +339,7 @@ static inline int __stats_UpdateFloat( vlc_object_t *p_obj, counter_t *p_co,
     vlc_value_t val;
     int i_ret;
     vlc_value_t new_val;new_val.f_float = 0.0;
+    if( !p_co ) return VLC_EGENERIC;
     val.f_float = f;
     i_ret =  __stats_Update( p_obj, p_co, val, &new_val );
     if( pf_new )
@@ -402,3 +426,5 @@ VLC_EXPORT( void,__stats_TimerDump, (vlc_object_t*, unsigned int) );
 VLC_EXPORT( void,__stats_TimersDumpAll, (vlc_object_t*) );
 #define stats_TimersClean(a) __stats_TimersClean( VLC_OBJECT(a) )
 VLC_EXPORT( void, __stats_TimersClean, (vlc_object_t * ) );
+
+#endif