1 /*****************************************************************************
2 * 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 VideoLAN
7 * $Id: vlc_messages.h,v 1.4 2002/07/20 18:01:42 sam Exp $
9 * Authors: Vincent Seguin <seguin@via.ecp.fr>
10 * Samuel Hocevar <sam@zoy.org>
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
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 General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
25 *****************************************************************************/
29 /*****************************************************************************
31 *****************************************************************************
32 * Store a single message.
33 *****************************************************************************/
36 int i_type; /* message type, see below */
39 char * psz_msg; /* the message itself */
42 mtime_t date; /* date of the message */
43 char * psz_file; /* file in which the function was called */
44 char * psz_function; /* function from which the function was called */
45 int i_line; /* line at which the function was called */
50 #define VLC_MSG_INFO 0 /* standard messages */
51 #define VLC_MSG_ERR 1 /* error messages */
52 #define VLC_MSG_WARN 2 /* warning messages */
53 #define VLC_MSG_DBG 3 /* debug messages */
55 /*****************************************************************************
57 *****************************************************************************
58 * Store all data requiered by messages interfaces.
59 *****************************************************************************/
62 /* Message queue lock */
66 msg_item_t msg[VLC_MSG_QSIZE]; /* message queue */
72 msg_subscription_t **pp_sub;
75 /*****************************************************************************
77 *****************************************************************************
78 * Used by interface plugins which subscribe to the message bank.
79 *****************************************************************************/
80 struct msg_subscription_t
89 /*****************************************************************************
91 *****************************************************************************/
92 VLC_EXPORT( void, __msg_Generic, ( vlc_object_t *, int, const char *, const char *, ... ) );
93 VLC_EXPORT( void, __msg_Info, ( void *, const char *, ... ) );
94 VLC_EXPORT( void, __msg_Err, ( void *, const char *, ... ) );
95 VLC_EXPORT( void, __msg_Warn, ( void *, const char *, ... ) );
96 VLC_EXPORT( void, __msg_Dbg, ( void *, const char *, ... ) );
98 #ifdef HAVE_VARIADIC_MACROS
100 # define msg_Info( p_this, psz_format, args... ) \
101 __msg_Generic( CAST_TO_VLC_OBJECT(p_this), VLC_MSG_INFO, MODULE_STRING, \
102 psz_format, ## args )
104 # define msg_Err( p_this, psz_format, args... ) \
105 __msg_Generic( CAST_TO_VLC_OBJECT(p_this), VLC_MSG_ERR, MODULE_STRING, \
106 psz_format, ## args )
108 # define msg_Warn( p_this, psz_format, args... ) \
109 __msg_Generic( CAST_TO_VLC_OBJECT(p_this), VLC_MSG_WARN, MODULE_STRING, \
110 psz_format, ## args )
112 # define msg_Dbg( p_this, psz_format, args... ) \
113 __msg_Generic( CAST_TO_VLC_OBJECT(p_this), VLC_MSG_DBG, MODULE_STRING, \
114 psz_format, ## args )
116 #else /* HAVE_VARIADIC_MACROS */
118 # define msg_Info __msg_Info
119 # define msg_Err __msg_Err
120 # define msg_Warn __msg_Warn
121 # define msg_Dbg __msg_Dbg
123 #endif /* HAVE_VARIADIC_MACROS */
125 #define msg_Create(a) __msg_Create(CAST_TO_VLC_OBJECT(a))
126 #define msg_Flush(a) __msg_Flush(CAST_TO_VLC_OBJECT(a))
127 #define msg_Destroy(a) __msg_Destroy(CAST_TO_VLC_OBJECT(a))
128 void __msg_Create ( vlc_object_t * );
129 void __msg_Flush ( vlc_object_t * );
130 void __msg_Destroy ( vlc_object_t * );
132 #define msg_Subscribe(a) __msg_Subscribe(CAST_TO_VLC_OBJECT(a))
133 #define msg_Unsubscribe(a,b) __msg_Unsubscribe(CAST_TO_VLC_OBJECT(a),b)
134 VLC_EXPORT( msg_subscription_t*, __msg_Subscribe, ( vlc_object_t * ) );
135 VLC_EXPORT( void, __msg_Unsubscribe, ( vlc_object_t *, msg_subscription_t * ) );