include/vlc_messages.h

   1 /*****************************************************************************
   2  * vlc_messages.h: messages interface
   3  * This library provides basic functions for threads to interact with user
   4  * interface, such as message output.
   5  *****************************************************************************
   6  * Copyright (C) 1999, 2000, 2001, 2002 VLC authors and VideoLAN
   7  * $Id$
   8  *
   9  * Authors: Vincent Seguin <seguin@via.ecp.fr>
  10  *          Samuel Hocevar <sam@zoy.org>
  11  *
  12  * This program is free software; you can redistribute it and/or modify it
  13  * under the terms of the GNU Lesser General Public License as published by
  14  * the Free Software Foundation; either version 2.1 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  20  * GNU Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * along with this program; if not, write to the Free Software Foundation,
  24  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  25  *****************************************************************************/
  26
  27 #ifndef VLC_MESSAGES_H_
  28 #define VLC_MESSAGES_H_
  29
  30 /**
  31  * \file
  32  * This file defines structures and functions to handle messages and statistics gathering
  33  */
  34
  35 #include <stdarg.h>
  36
  37 /**
  38  * \defgroup messages Messages
  39  * This library provides basic functions for threads to interact with user
  40  * interface, such as message output.
  41  *
  42  * @{
  43  */
  44
  45 /** Message types */
  46 enum msg_item_type
  47 {
  48     VLC_MSG_INFO=0, /**< Important information */
  49     VLC_MSG_ERR,    /**< Error */
  50     VLC_MSG_WARN,   /**< Warning */
  51     VLC_MSG_DBG,    /**< Debug */
  52 };
  53
  54 /**
  55  * Log message
  56  */
  57 typedef struct
  58 {
  59     uintptr_t   i_object_id; /**< Emitter (temporaly) unique object ID or 0 */
  60     const char *psz_object_type; /**< Emitter object type name */
  61     const char *psz_module; /**< Emitter module (source code) */
  62     const char *psz_header; /**< Additional header (used by VLM media) */
  63 } msg_item_t;
  64
  65 /**
  66  * Used by interface plugins which subscribe to the message bank.
  67  */
  68 typedef struct msg_subscription_t msg_subscription_t;
  69
  70 /*****************************************************************************
  71  * Prototypes
  72  *****************************************************************************/
  73 VLC_API void vlc_Log(vlc_object_t *, int,
  74                      const char *, const char *, ...) VLC_FORMAT( 4, 5 );
  75 VLC_API void vlc_vaLog(vlc_object_t *, int,
  76                        const char *, const char *, va_list);
  77 #define msg_GenericVa(a, b, c, d, e) vlc_vaLog(VLC_OBJECT(a), b, c, d, e)
  78
  79 #define msg_Info( p_this, ... ) \
  80     vlc_Log( VLC_OBJECT(p_this), VLC_MSG_INFO, MODULE_STRING, __VA_ARGS__ )
  81 #define msg_Err( p_this, ... ) \
  82     vlc_Log( VLC_OBJECT(p_this), VLC_MSG_ERR,  MODULE_STRING, __VA_ARGS__ )
  83 #define msg_Warn( p_this, ... ) \
  84     vlc_Log( VLC_OBJECT(p_this), VLC_MSG_WARN, MODULE_STRING, __VA_ARGS__ )
  85 #define msg_Dbg( p_this, ... ) \
  86     vlc_Log( VLC_OBJECT(p_this), VLC_MSG_DBG,  MODULE_STRING, __VA_ARGS__ )
  87
  88 /**
  89  * Message logging callback signature.
  90  * Accepts one private data pointer, the message, and an overrun counter.
  91  */
  92 typedef void (*msg_callback_t) (void *, int, const msg_item_t *,
  93                                 const char *, va_list);
  94
  95 VLC_API msg_subscription_t *vlc_Subscribe(msg_callback_t, void *) VLC_USED;
  96 VLC_API void vlc_Unsubscribe(msg_subscription_t *);
  97
  98 /**
  99  * @}
 100  */
 101 #endif