git.sesse.net Git - vlc/blob - 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 vlc_log_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 vlc_log_t
  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     const char *file; /**< Source code file name or NULL */
  64     int line; /**< Source code file line number or -1 */
  65     const char *func; /**< Source code calling function name or NULL */
  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, MODULE_STRING, __FILE__, __LINE__, __func__, \
  76               fmt, ap)
  77
  78 #define msg_Generic(o, p, ...) \
  79     vlc_Log(VLC_OBJECT(o), p, MODULE_STRING, __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 #ifndef MODULE_STRING
  91 # define MODULE_STRING __FILE__
  92 #endif
  93
  94 VLC_API const char *vlc_strerror(int);
  95 VLC_API const char *vlc_strerror_c(int);
  96
  97 /**
  98  * Message logging callback signature.
  99  * \param data data pointer as provided to vlc_msg_SetCallback().
 100  * \param type message type (VLC_MSG_* values from enum vlc_log_type)
 101  * \param item meta information
 102  * \param fmt format string
 103  * \param args format string arguments
 104  */
 105 typedef void (*vlc_log_cb) (void *data, int type, const vlc_log_t *item,
 106                             const char *fmt, va_list args);
 107
 108 /**
 109  * @}
 110  */
 111 #endif