git.sesse.net Git - vlc/blob - lib/error.c

   1 /*****************************************************************************
   2  * error.c: Error handling for libvlc
   3  *****************************************************************************
   4  * Copyright (C) 2009 Rémi Denis-Courmont
   5  *
   6  * This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU Lesser General Public License as published by
   8  * the Free Software Foundation; either version 2.1 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14  * GNU Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public License
  17  * along with this program; if not, write to the Free Software Foundation,
  18  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  19  *****************************************************************************/
  20
  21 #include "libvlc_internal.h"
  22
  23 #include <stdarg.h>
  24 #include <stdio.h>
  25 #include <assert.h>
  26 #include <vlc/libvlc.h>
  27
  28
  29 static const char oom[] = "Out of memory";
  30 /* TODO: use only one thread-specific key for whole libvlc */
  31 static vlc_threadvar_t context;
  32
  33 static vlc_mutex_t lock = VLC_STATIC_MUTEX;
  34 static uintptr_t refs = 0;
  35
  36 void libvlc_threads_init (void)
  37 {
  38     vlc_mutex_lock (&lock);
  39     if (refs++ == 0)
  40     {
  41         vlc_threadvar_create (&context, free);
  42         libvlc_log_init ();
  43     }
  44     vlc_mutex_unlock (&lock);
  45 }
  46
  47 void libvlc_threads_deinit (void)
  48 {
  49     vlc_mutex_lock (&lock);
  50     assert (refs > 0);
  51     if (--refs == 0)
  52     {
  53         libvlc_log_deinit ();
  54         vlc_threadvar_delete (&context);
  55     }
  56     vlc_mutex_unlock (&lock);
  57 }
  58
  59 static char *get_error (void)
  60 {
  61     return vlc_threadvar_get (context);
  62 }
  63
  64 static void free_error (void)
  65 {
  66     char *msg = get_error ();
  67     if (msg != oom)
  68         free (msg);
  69 }
  70
  71 /**
  72  * Gets a human-readable error message for the last LibVLC error in the calling
  73  * thread. The resulting string is valid until another error occurs (at least
  74  * until the next LibVLC call).
  75  *
  76  * @return NULL if there was no error, a nul-terminated string otherwise.
  77  */
  78 const char *libvlc_errmsg (void)
  79 {
  80     return get_error ();
  81 }
  82
  83 /**
  84  * Clears the LibVLC error status for the current thread. This is optional.
  85  * By default, the error status is automatically overridden when a new error
  86  * occurs, and destroyed when the thread exits.
  87  */
  88 void libvlc_clearerr (void)
  89 {
  90     free_error ();
  91     vlc_threadvar_set (context, NULL);
  92 }
  93
  94 /**
  95  * Sets the LibVLC error status and message for the current thread.
  96  * Any previous error is overridden.
  97  * @return a nul terminated string (always)
  98  */
  99 const char *libvlc_vprinterr (const char *fmt, va_list ap)
 100 {
 101     char *msg;
 102
 103     assert (fmt != NULL);
 104     if (vasprintf (&msg, fmt, ap) == -1)
 105         msg = (char *)oom;
 106
 107     free_error ();
 108     vlc_threadvar_set (context, msg);
 109     return msg;
 110 }
 111
 112 /**
 113  * Sets the LibVLC error status and message for the current thread.
 114  * Any previous error is overridden.
 115  * @return a nul terminated string (always)
 116  */
 117 const char *libvlc_printerr (const char *fmt, ...)
 118 {
 119     va_list ap;
 120     const char *msg;
 121
 122     va_start (ap, fmt);
 123     msg = libvlc_vprinterr (fmt, ap);
 124     va_end (ap);
 125     return msg;
 126 }
 127