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 #include <stdarg.h>
  31
  32 /**
  33  * \defgroup messages Logging
  34  * \ingroup os
  35  * \brief Message logs
  36  *
  37  * Functions for modules to emit log messages.
  38  *
  39  * @{
  40  * \file
  41  * Logging functions
  42  */
  43
  44 /** Message types */
  45 enum vlc_log_type
  46 {
  47     VLC_MSG_INFO=0, /**< Important information */
  48     VLC_MSG_ERR,    /**< Error */
  49     VLC_MSG_WARN,   /**< Warning */
  50     VLC_MSG_DBG,    /**< Debug */
  51 };
  52
  53 /**
  54  * Log message
  55  */
  56 typedef struct vlc_log_t
  57 {
  58     uintptr_t   i_object_id; /**< Emitter (temporarily) unique object ID or 0 */
  59     const char *psz_object_type; /**< Emitter object type name */
  60     const char *psz_module; /**< Emitter module (source code) */
  61     const char *psz_header; /**< Additional header (used by VLM media) */
  62     const char *file; /**< Source code file name or NULL */
  63     int line; /**< Source code file line number or -1 */
  64     const char *func; /**< Source code calling function name or NULL */
  65     unsigned long tid; /**< Emitter thread ID */
  66 } vlc_log_t;
  67
  68 VLC_API void vlc_Log(vlc_object_t *obj, int prio, const char *module,
  69                      const char *file, unsigned line, const char *func,
  70                      const char *format, ...) VLC_FORMAT(7, 8);
  71 VLC_API void vlc_vaLog(vlc_object_t *obj, int prio, const char *module,
  72                        const char *file, unsigned line, const char *func,
  73                        const char *format, va_list ap);
  74 #define msg_GenericVa(o, p, fmt, ap) \
  75     vlc_vaLog(VLC_OBJECT(o), p, vlc_module_name, __FILE__, __LINE__, \
  76               __func__, fmt, ap)
  77
  78 #define msg_Generic(o, p, ...) \
  79     vlc_Log(VLC_OBJECT(o), p, vlc_module_name, __FILE__, __LINE__, \
  80             __func__, __VA_ARGS__)
  81 #define msg_Info(p_this, ...) \
  82     msg_Generic(p_this, VLC_MSG_INFO, __VA_ARGS__)
  83 #define msg_Err(p_this, ...) \
  84     msg_Generic(p_this, VLC_MSG_ERR, __VA_ARGS__)
  85 #define msg_Warn(p_this, ...) \
  86     msg_Generic(p_this, VLC_MSG_WARN, __VA_ARGS__)
  87 #define msg_Dbg(p_this, ...) \
  88     msg_Generic(p_this, VLC_MSG_DBG, __VA_ARGS__)
  89
  90 extern const char vlc_module_name[];
  91
  92 VLC_API const char *vlc_strerror(int);
  93 VLC_API const char *vlc_strerror_c(int);
  94
  95 /**
  96  * Message logging callback signature.
  97  * \param data data pointer as provided to vlc_msg_SetCallback().
  98  * \param type message type (VLC_MSG_* values from enum vlc_log_type)
  99  * \param item meta information
 100  * \param fmt format string
 101  * \param args format string arguments
 102  */
 103 typedef void (*vlc_log_cb) (void *data, int type, const vlc_log_t *item,
 104                             const char *fmt, va_list args);
 105
 106 /**
 107  * @}
 108  */
 109 #endif