]> git.sesse.net Git - vlc/blob - src/interface/intf_msg.c
4b503c2f9976b76cb2e687369a6f17dacaf9edb7
[vlc] / src / interface / intf_msg.c
1 /*****************************************************************************
2  * intf_msg.c: 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) 1998, 1999, 2000 VideoLAN
7  *
8  * Authors:
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  * 
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
23  *****************************************************************************/
24
25 /*****************************************************************************
26  * Preamble
27  *****************************************************************************/
28 #include "defs.h"
29
30 #include <errno.h>                                                  /* errno */
31 #include <fcntl.h>                     /* O_CREAT, O_TRUNC, O_WRONLY, O_SYNC */
32 #include <stdio.h>                                               /* required */
33 #include <stdarg.h>                                       /* va_list for BSD */
34 #include <stdlib.h>                                              /* malloc() */
35 #include <string.h>                                            /* strerror() */
36 #include <unistd.h>                                      /* close(), write() */
37
38 #include "config.h"
39 #include "common.h"
40 #include "threads.h"
41 #include "mtime.h"
42 #include "plugins.h"
43 #include "intf_msg.h"
44 #include "interface.h"
45 #include "intf_console.h"
46
47 #include "main.h"
48
49 /*****************************************************************************
50  * intf_msg_item_t
51  *****************************************************************************
52  * Store a single message. Messages have a maximal size of INTF_MSG_MSGSIZE.
53  * If DEBUG is defined, messages have a date field and debug messages are
54  * printed with a date to allow more precise profiling.
55  *****************************************************************************/
56 typedef struct
57 {
58     int     i_type;                               /* message type, see below */
59     char *  psz_msg;                                   /* the message itself */
60
61 #ifdef DEBUG
62     /* Debugging informations - in DEBUG mode, debug messages have calling
63      * location informations printed */
64     mtime_t date;                                     /* date of the message */
65     char *  psz_file;               /* file in which the function was called */
66     char *  psz_function;     /* function from which the function was called */
67     int     i_line;                 /* line at which the function was called */
68 #endif
69 } intf_msg_item_t;
70
71 /* Message types */
72 #define INTF_MSG_STD    0                                /* standard message */
73 #define INTF_MSG_ERR    1                                   /* error message */
74 #define INTF_MSG_INTF   2                               /* interface message */
75 #define INTF_MSG_DBG    3                                   /* debug message */
76 #define INTF_MSG_WARN   4                                  /* warning message*/
77
78
79 /*****************************************************************************
80  * intf_msg_t
81  *****************************************************************************
82  * Store all data requiered by messages interfaces. It has a single reference
83  * int p_main.
84  *****************************************************************************/
85 typedef struct intf_msg_s
86 {
87 #ifdef INTF_MSG_QUEUE
88     /* Message queue */
89     vlc_mutex_t             lock;                      /* message queue lock */
90     int                     i_count;            /* number of messages stored */
91     intf_msg_item_t         msg[INTF_MSG_QSIZE];            /* message queue */
92 #endif
93
94 #ifdef DEBUG_LOG
95     /* Log file */
96     FILE *                  p_log_file;                          /* log file */
97 #endif
98
99 #if !defined(INTF_MSG_QUEUE) && !defined(DEBUG_LOG)
100     /* If neither messages queue, neither log file is used, then the structure
101      * is empty. However, empty structures are not allowed in C. Therefore, a
102      * dummy integer is used to fill it. */
103     int                     i_dummy;                        /* unused filler */
104 #endif
105 } intf_msg_t;
106
107 /*****************************************************************************
108  * Local prototypes
109  *****************************************************************************/
110
111 static void QueueMsg        ( intf_msg_t *p_msg, int i_type,
112                               char *psz_format, va_list ap );
113 static void PrintMsg        ( intf_msg_item_t *p_msg );
114 #ifdef DEBUG
115 static void QueueDbgMsg     ( intf_msg_t *p_msg, char *psz_file,
116                               char *psz_function, int i_line,
117                               char *psz_format, va_list ap );
118 #endif
119 #ifdef INTF_MSG_QUEUE
120 static void FlushLockedMsg  ( intf_msg_t *p_msg );
121 #endif
122
123
124 /*****************************************************************************
125  * intf_MsgCreate: initialize messages interface                         (ok ?)
126  *****************************************************************************
127  * This functions has to be called before any call to other intf_*Msg functions.
128  * It set up the locks and the message queue if it is used.
129  *****************************************************************************/
130 p_intf_msg_t intf_MsgCreate( void )
131 {
132     p_intf_msg_t p_msg;
133
134     /* Allocate structure */
135     p_msg = malloc( sizeof( intf_msg_t ) );
136     if( p_msg == NULL )
137     {
138         errno = ENOMEM;
139     }
140     else
141     {
142 #ifdef INTF_MSG_QUEUE
143     /* Message queue initialization */
144     vlc_mutex_init( &p_msg->lock );                        /* intialize lock */
145     p_msg->i_count = 0;                                    /* queue is empty */
146 #endif
147
148     
149 #ifdef DEBUG_LOG
150         /* Log file initialization - on failure, file pointer will be null,
151          * and no log will be issued, but this is not considered as an
152          * error */
153         p_msg->p_log_file = fopen( DEBUG_LOG, "w" );
154 #endif
155     }
156     return( p_msg );
157 }
158
159 /*****************************************************************************
160  * intf_MsgDestroy: free resources allocated by intf_InitMsg            (ok ?)
161  *****************************************************************************
162  * This functions prints all messages remaining in queue, then free all the
163  * resources allocated by intf_InitMsg.
164  * No other messages interface functions should be called after this one.
165  *****************************************************************************/
166 void intf_MsgDestroy( void )
167 {
168     intf_FlushMsg();                         /* print all remaining messages */
169
170 #ifdef DEBUG_LOG
171     /* Close log file if any */
172     if( p_main->p_msg->p_log_file != NULL )
173     {
174         fclose( p_main->p_msg->p_log_file );
175     }
176 #endif
177
178     /* Free structure */
179     free( p_main->p_msg );
180 }
181
182 /*****************************************************************************
183  * intf_Msg: print a message                                             (ok ?)
184  *****************************************************************************
185  * This function queue a message for later printing, or print it immediately
186  * if the queue isn't used.
187  *****************************************************************************/
188 void intf_Msg( char *psz_format, ... )
189 {
190     va_list ap;
191
192     va_start( ap, psz_format );
193     QueueMsg( p_main->p_msg, INTF_MSG_STD, psz_format, ap );
194     va_end( ap );
195 }
196
197 /*****************************************************************************
198  * intf_ErrMsg : print an error message                                  (ok ?)
199  *****************************************************************************
200  * This function is the same as intf_Msg, except that it prints its messages
201  * on stderr.
202  *****************************************************************************/
203 void intf_ErrMsg( char *psz_format, ... )
204 {
205     va_list ap;
206
207     va_start( ap, psz_format );
208     QueueMsg( p_main->p_msg, INTF_MSG_ERR, psz_format, ap );
209     va_end( ap );
210 }
211
212 /*****************************************************************************
213  * intf_WarnMsg : print a warning message
214  *****************************************************************************
215  * This function is the same as intf_Msg, except that it concerns warning
216  * messages for testing purpose.
217  *****************************************************************************/
218 void intf_WarnMsg( int i_level, char *psz_format, ... )
219 {
220     va_list ap;
221     
222     if( i_level >= p_main->p_intf->i_warning_level )
223     {
224         va_start( ap, psz_format );
225         QueueMsg( p_main->p_msg, INTF_MSG_WARN, psz_format, ap );
226         va_end( ap );
227     }
228 }
229
230
231 /*****************************************************************************
232  * intf_IntfMsg : print an interface message                             (ok ?)
233  *****************************************************************************
234  * In opposition to all other intf_*Msg function, this function does not print
235  * it's message on default terminal (stdout or stderr), but send it to
236  * interface (in fact to the X11 console). This means that the interface MUST
237  * be initialized and a X11 console openned before this function is used, and
238  * that once the console is closed, this call is vorbidden.
239  * Practically, only the interface thread itself should call this function, and
240  * flush all messages before intf_CloseX11Console() is called.
241  *****************************************************************************/
242 void intf_IntfMsg(char *psz_format, ...)
243 {
244     va_list ap;
245
246     va_start( ap, psz_format );
247     QueueMsg( p_main->p_msg, INTF_MSG_INTF, psz_format, ap );
248     va_end( ap );
249 }
250
251 /*****************************************************************************
252  * _intf_DbgMsg: print a debugging message                               (ok ?)
253  *****************************************************************************
254  * This function prints a debugging message. Compared to other intf_*Msg
255  * functions, it is only defined if DEBUG is defined and require a file name,
256  * a function name and a line number as additionnal debugging informations. It
257  * also prints a debugging header for each received line.
258  *****************************************************************************/
259 #ifdef DEBUG
260 void _intf_DbgMsg( char *psz_file, char *psz_function, int i_line,
261                    char *psz_format, ...)
262 {
263     va_list ap;
264
265     va_start( ap, psz_format );
266     QueueDbgMsg( p_main->p_msg, psz_file, psz_function, i_line,
267                  psz_format, ap );
268     va_end( ap );
269 }
270 #endif
271
272 /*****************************************************************************
273  * intf_MsgImm: print a message                                          (ok ?)
274  *****************************************************************************
275  * This function prints a message immediately. If the queue is used, all
276  * waiting messages are also printed.
277  *****************************************************************************/
278 void intf_MsgImm( char *psz_format, ... )
279 {
280     va_list ap;
281
282     va_start( ap, psz_format );
283     QueueMsg( p_main->p_msg, INTF_MSG_STD, psz_format, ap );
284     va_end( ap );
285     intf_FlushMsg();
286 }
287
288 /*****************************************************************************
289  * intf_ErrMsgImm: print an error message immediately                    (ok ?)
290  *****************************************************************************
291  * This function is the same as intf_MsgImm, except that it prints its message
292  * on stderr.
293  *****************************************************************************/
294 void intf_ErrMsgImm(char *psz_format, ...)
295 {
296     va_list ap;
297
298     va_start( ap, psz_format );
299     QueueMsg( p_main->p_msg, INTF_MSG_ERR, psz_format, ap );
300     va_end( ap );
301     intf_FlushMsg();
302 }
303
304 /*****************************************************************************
305  * intf_WarnMsgImm : print a warning message
306  *****************************************************************************
307  * This function is the same as intf_MsgImm, except that it concerns warning
308  * messages for testing purpose.
309  *****************************************************************************/
310 void intf_WarnMsgImm( int i_level, char *psz_format, ... )
311 {
312     va_list ap;
313
314     if( i_level >= p_main->p_intf->i_warning_level )
315     {
316         va_start( ap, psz_format );
317         QueueMsg( p_main->p_msg, INTF_MSG_WARN, psz_format, ap );
318         va_end( ap );
319     }
320     intf_FlushMsg();
321 }
322
323
324
325 /*****************************************************************************
326  * _intf_DbgMsgImm: print a debugging message immediately                (ok ?)
327  *****************************************************************************
328  * This function is the same as intf_DbgMsgImm, except that it prints its
329  * message immediately. It should only be called through the macro
330  * intf_DbgMsgImm().
331  *****************************************************************************/
332 #ifdef DEBUG
333 void _intf_DbgMsgImm( char *psz_file, char *psz_function, int i_line,
334                       char *psz_format, ...)
335 {
336     va_list ap;
337
338     va_start( ap, psz_format );
339     QueueDbgMsg( p_main->p_msg, psz_file, psz_function, i_line,
340                  psz_format, ap );
341     va_end( ap );
342     intf_FlushMsg();
343 }
344 #endif
345
346 /*****************************************************************************
347  * intf_FlushMsg                                                        (ok ?)
348  *****************************************************************************
349  * Print all messages remaining in queue: get lock and call FlushLockedMsg.
350  * This function does nothing if the message queue isn't used.
351  * This function is only implemented if message queue is used. If not, it is
352  * an empty macro.
353  *****************************************************************************/
354 #ifdef INTF_MSG_QUEUE
355 void intf_FlushMsg( void )
356 {
357     vlc_mutex_lock( &p_main->p_msg->lock );                      /* get lock */
358     FlushLockedMsg( p_main->p_msg );                       /* flush messages */
359     vlc_mutex_unlock( &p_main->p_msg->lock );              /* give lock back */
360 }
361 #endif
362
363 /* following functions are local */
364
365 /*****************************************************************************
366  * QueueMsg: add a message to a queue
367  *****************************************************************************
368  * This function provide basic functionnalities to other intf_*Msg functions.
369  * It add a message to a queue (after having printed all stored messages if it
370  * is full. If the message can't be converted to string in memory, it exit the
371  * program. If the queue is not used, it prints the message immediately.
372  *****************************************************************************/
373 static void QueueMsg( intf_msg_t *p_msg, int i_type, char *psz_format, va_list ap )
374 {
375     char *                  psz_str;             /* formatted message string */
376     intf_msg_item_t *       p_msg_item;                /* pointer to message */
377
378 #ifndef INTF_MSG_QUEUE /*................................... instant mode ...*/
379     intf_msg_item_t         msg_item;                             /* message */
380     p_msg_item =           &msg_item;
381 #endif /*....................................................................*/
382
383     /*
384      * Convert message to string
385      */
386 #if defined SYS_BEOS || defined SYS_SOLARIS
387     psz_str = (char*) malloc( strlen(psz_format) + INTF_MAX_MSG_SIZE );
388     vsprintf( psz_str, psz_format, ap );
389 #else
390     vasprintf( &psz_str, psz_format, ap );
391 #endif
392     if( psz_str == NULL )
393     {
394         fprintf(stderr, "warning: can't store following message (%s): ",
395                 strerror(errno) );
396         vfprintf(stderr, psz_format, ap );
397         exit( errno );
398     }
399
400 #ifdef INTF_MSG_QUEUE /*...................................... queue mode ...*/
401     vlc_mutex_lock( &p_msg->lock );                              /* get lock */
402     if( p_msg->i_count == INTF_MSG_QSIZE )          /* flush queue if needed */
403     {
404 #ifdef DEBUG               /* in debug mode, queue overflow causes a warning */
405         fprintf(stderr, "warning: message queue overflow\n" );
406 #endif
407         FlushLockedMsg( p_msg );
408     }
409     p_msg_item = p_msg->msg + p_msg->i_count++;            /* select message */
410 #endif /*.............................................. end of queue mode ...*/
411
412     /*
413      * Fill message information fields
414      */
415     p_msg_item->i_type =     i_type;
416     p_msg_item->psz_msg =    psz_str;
417 #ifdef DEBUG    
418     p_msg_item->date =         mdate();
419 #endif
420
421 #ifdef INTF_MSG_QUEUE /*......................................... queue mode */
422     vlc_mutex_unlock( &p_msg->lock );                      /* give lock back */
423 #else /*....................................................... instant mode */
424     PrintMsg( p_msg_item );                                 /* print message */
425     free( psz_str );                                    /* free message data */
426 #endif /*....................................................................*/
427 }
428
429 /*****************************************************************************
430  * QueueDbgMsg: add a message to a queue with debugging informations
431  *****************************************************************************
432  * This function is the same as QueueMsg, except that it is only defined when
433  * DEBUG is define, and require additionnal debugging informations.
434  *****************************************************************************/
435 #ifdef DEBUG
436 static void QueueDbgMsg(intf_msg_t *p_msg, char *psz_file, char *psz_function,
437                         int i_line, char *psz_format, va_list ap)
438 {
439     char *                  psz_str;             /* formatted message string */
440     intf_msg_item_t *       p_msg_item;                /* pointer to message */
441
442 #ifndef INTF_MSG_QUEUE /*................................... instant mode ...*/
443     intf_msg_item_t         msg_item;                             /* message */
444     p_msg_item =           &msg_item;
445 #endif /*....................................................................*/
446
447     /*
448      * Convert message to string
449      */
450 #if defined SYS_BEOS || defined SYS_SOLARIS
451     psz_str = (char*) malloc( INTF_MAX_MSG_SIZE );
452     vsprintf( psz_str, psz_format, ap );
453 #else
454     vasprintf( &psz_str, psz_format, ap );
455 #endif
456     if( psz_str == NULL )
457     {
458         fprintf(stderr, "warning: can't store following message (%s): ",
459                 strerror(errno) );
460         fprintf(stderr, INTF_MSG_DBG_FORMAT, psz_file, psz_function, i_line );
461         vfprintf(stderr, psz_format, ap );
462         exit( errno );
463     }
464
465 #ifdef INTF_MSG_QUEUE /*...................................... queue mode ...*/
466     vlc_mutex_lock( &p_msg->lock );                              /* get lock */
467     if( p_msg->i_count == INTF_MSG_QSIZE )          /* flush queue if needed */
468     {
469         fprintf(stderr, "warning: message queue overflow\n" );
470         FlushLockedMsg( p_msg );
471     }
472     p_msg_item = p_msg->msg + p_msg->i_count++;            /* select message */
473 #endif /*.............................................. end of queue mode ...*/
474
475     /*
476      * Fill message information fields
477      */
478     p_msg_item->i_type =       INTF_MSG_DBG;
479     p_msg_item->psz_msg =      psz_str;
480     p_msg_item->psz_file =     psz_file;
481     p_msg_item->psz_function = psz_function;
482     p_msg_item->i_line =       i_line;
483     p_msg_item->date =         mdate();
484
485 #ifdef INTF_MSG_QUEUE /*......................................... queue mode */
486     vlc_mutex_unlock( &p_msg->lock );                      /* give lock back */
487 #else /*....................................................... instant mode */
488     PrintMsg( p_msg_item );                                 /* print message */
489     free( psz_str );                                    /* free message data */
490 #endif /*....................................................................*/
491 }
492 #endif
493
494 /*****************************************************************************
495  * FlushLockedMsg                                                       (ok ?)
496  *****************************************************************************
497  * Print all messages remaining in queue. MESSAGE QUEUE MUST BE LOCKED, since
498  * this function does not check the lock. This function is only defined if
499  * INTF_MSG_QUEUE is defined.
500  *****************************************************************************/
501 #ifdef INTF_MSG_QUEUE
502 static void FlushLockedMsg ( intf_msg_t *p_msg )
503 {
504     int i_index;
505
506     for( i_index = 0; i_index < p_msg->i_count; i_index++ )
507     {
508         /* Print message and free message data */
509         PrintMsg( &p_msg->msg[i_index] );
510         free( p_msg->msg[i_index].psz_msg );
511     }
512
513     p_msg->i_count = 0;
514 }
515 #endif
516
517 /*****************************************************************************
518  * PrintMsg: print a message                                             (ok ?)
519  *****************************************************************************
520  * Print a single message. The message data is not freed. This function exists
521  * in two version. The DEBUG version prints a date with each message, and is
522  * able to log messages (if DEBUG_LOG is defined).
523  * The normal one just prints messages to the screen.
524  *****************************************************************************/
525 #ifdef DEBUG
526
527 static void PrintMsg( intf_msg_item_t *p_msg )
528 {
529     char    psz_date[MSTRTIME_MAX_SIZE];            /* formatted time buffer */
530     char *  psz_msg;                                       /* message buffer */
531
532     /* Format message - the message is formatted here because in case the log
533      * file is used, it avoids another format string parsing */
534     switch( p_msg->i_type )
535     {
536     case INTF_MSG_STD:                                   /* regular messages */
537     case INTF_MSG_ERR:
538         asprintf( &psz_msg, "%s", p_msg->psz_msg );
539         break;
540
541     case INTF_MSG_WARN:                                   /* Warning message */
542         mstrtime( psz_date, p_msg->date );
543         asprintf( &psz_msg, "(%s) %s",
544                   psz_date, p_msg->psz_msg );
545
546         break;
547         
548     case INTF_MSG_INTF:                                /* interface messages */
549         asprintf( &psz_msg, "%s", p_msg->psz_msg );
550         break;
551
552     case INTF_MSG_DBG:                                     /* debug messages */
553         mstrtime( psz_date, p_msg->date );
554         asprintf( &psz_msg, "(%s) " INTF_MSG_DBG_FORMAT "%s",
555                   psz_date, p_msg->psz_file, p_msg->psz_function, p_msg->i_line,
556                   p_msg->psz_msg );
557         break;
558     }
559
560     /* Check if formatting function succeeded */
561     if( psz_msg == NULL )
562     {
563         fprintf( stderr, "error: can not format message (%s): %s\n",
564                  strerror( errno ), p_msg->psz_msg );
565         return;
566     }
567
568     /*
569      * Print messages
570      */
571     switch( p_msg->i_type )
572     {
573     case INTF_MSG_STD:                                  /* standard messages */
574         fprintf( stdout, psz_msg );
575         break;
576     case INTF_MSG_ERR:                                     /* error messages */
577     case INTF_MSG_WARN:
578 #ifndef DEBUG_LOG_ONLY
579     case INTF_MSG_DBG:                                 /* debugging messages */
580 #endif
581         fprintf( stderr, psz_msg );
582         break;
583     case INTF_MSG_INTF:                                /* interface messages */
584         intf_ConsolePrint( p_main->p_intf->p_console, psz_msg );
585         break;
586     }
587
588 #ifdef DEBUG_LOG
589     /* Append all messages to log file */
590     if( p_main->p_msg->p_log_file != NULL )
591     {
592         fwrite( psz_msg, strlen( psz_msg ), 1, p_main->p_msg->p_log_file );
593     }
594 #endif
595
596     /* Free formatted message */
597     free( psz_msg );
598 }
599
600 #else
601
602 static void PrintMsg( intf_msg_item_t *p_msg )
603 {
604     /*
605      * Print messages on screen
606      */
607     switch( p_msg->i_type )
608     {
609     case INTF_MSG_STD:                                  /* standard messages */
610     case INTF_MSG_DBG:                                     /* debug messages */
611         fprintf( stdout, p_msg->psz_msg );
612         break;
613     case INTF_MSG_ERR:                                     /* error messages */
614     case INTF_MSG_WARN:
615         fprintf( stderr, p_msg->psz_msg );                /* warning message */
616         break;
617     case INTF_MSG_INTF:                                /* interface messages */
618         intf_ConsolePrint( p_main->p_intf->p_console, p_msg->psz_msg );
619         break;
620     }
621 }
622
623 #endif