git.sesse.net Git - vlc/blob - include/intf_msg.h

   1 /*****************************************************************************
   2  * intf_msg.h: messages interface
   3  * This library provides basic functions for threads to interact with user
   4  * interface, such as message output. See config.h for output configuration.
   5  *****************************************************************************
   6  * Copyright (C) 1999, 2000 VideoLAN
   7  * $Id: intf_msg.h,v 1.13 2001/04/30 15:00:59 massiot Exp $
   8  *
   9  * Authors: Vincent Seguin <seguin@via.ecp.fr>
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  24  *****************************************************************************/
  25
  26 /*****************************************************************************
  27  * intf_DbgMsg macros and functions
  28  *****************************************************************************
  29  * The intf_DbgMsg* functions are defined as macro to be able to use the
  30  * compiler extensions and print the file, the function and the line number
  31  * from which they have been called. They call _intf_DbgMsg*() functions after
  32  * having added debugging informations.
  33  * Outside trace mode, intf_DbgMsg* functions do nothing.
  34  *****************************************************************************/
  35 #ifdef TRACE
  36
  37 /* TRACE mode */
  38 void    _intf_DbgMsg        ( char *psz_file, char *psz_function, int i_line,
  39                               char *psz_format, ... );
  40 void    _intf_DbgMsgImm     ( char *psz_file, char *psz_function, int i_line,
  41                               char *psz_format, ... );
  42
  43 #define intf_DbgMsg( format, args... ) \
  44     _intf_DbgMsg( __FILE__, __FUNCTION__, __LINE__, format, ## args )
  45 #define intf_DbgMsgImm( format, args... ) \
  46     _intf_DbgMsg( __FILE__, __FUNCTION__, __LINE__, format, ## args )
  47
  48 #else
  49
  50 /* Non-TRACE mode */
  51 #define intf_DbgMsg( format, args... )
  52 #define intf_DbgMsgImm( format, args...)
  53
  54 #endif
  55
  56 /*****************************************************************************
  57  * intf_FlushMsg macro and function
  58  *****************************************************************************
  59  * intf_FlushMsg is a function which flushs message queue and print all messages
  60  * remaining. It is only useful if INTF_MSG_QUEUE is defined. In this case, it
  61  * is really a function. In the other case, it is a macro doing nothing.
  62  *****************************************************************************/
  63 #ifdef INTF_MSG_QUEUE
  64
  65 /* Message queue mode */
  66 void    intf_FlushMsg       ( void );
  67
  68 #else
  69
  70 /* Direct mode */
  71 #define intf_FlushMsg()     ;
  72
  73 #endif
  74
  75 /*****************************************************************************
  76  * Prototypes
  77  *****************************************************************************/
  78 p_intf_msg_t intf_MsgCreate      ( void );
  79 void         intf_MsgDestroy     ( void );
  80
  81 void         intf_Msg            ( char *psz_format, ... );
  82 void         intf_ErrMsg         ( char *psz_format, ... );
  83 void         intf_WarnMsg        ( int i_level, char *psz_format, ... );
  84
  85 void         intf_MsgImm         ( char *psz_format, ... );
  86 void         intf_ErrMsgImm      ( char *psz_format, ... );
  87 void         intf_WarnMsgImm     ( int i_level, char *psz_format, ... );
  88 void         intf_WarnHexDump    ( int i_level, void *p_data, int i_size );
  89