source: roaraudio/libroar/debug.c @ 5889:d866fb1213d6

Last change on this file since 5889:d866fb1213d6 was 5823:f9f70dbaa376, checked in by phi, 11 years ago

updated copyright

File size: 6.4 KB
Line 
1//debug.c:
2
3/*
4 *      Copyright (C) Philipp 'ph3-der-loewe' Schafft - 2009-2013
5 *
6 *  This file is part of libroar a part of RoarAudio,
7 *  a cross-platform sound system for both, home and professional use.
8 *  See README for details.
9 *
10 *  This file is free software; you can redistribute it and/or modify
11 *  it under the terms of the GNU General Public License version 3
12 *  as published by the Free Software Foundation.
13 *
14 *  libroar is distributed in the hope that it will be useful,
15 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
16 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 *  GNU General Public License for more details.
18 *
19 *  You should have received a copy of the GNU General Public License
20 *  along with this software; see the file COPYING.  If not, write to
21 *  the Free Software Foundation, 51 Franklin Street, Fifth Floor,
22 *  Boston, MA 02110-1301, USA.
23 *
24 *  NOTE for everyone want's to change something and send patches:
25 *  read README and HACKING! There a addition information on
26 *  the license of this document you need to read before you send
27 *  any patches.
28 *
29 *  NOTE for uses of non-GPL (LGPL,...) software using libesd, libartsc
30 *  or libpulse*:
31 *  The libs libroaresd, libroararts and libroarpulse link this lib
32 *  and are therefore GPL. Because of this it may be illigal to use
33 *  them with any software that uses libesd, libartsc or libpulse*.
34 */
35
36#include "libroar.h"
37
38static int                     roar_debug_stderr_mode = ROAR_DEBUG_MODE_SYSIO;
39static int                     roar_debug_stderr_fh   = ROAR_STDERR;
40static struct roar_vio_calls * roar_debug_stderr_vio  = NULL;
41
42void roar_debug_warn_sysio_real(char * func, char * newfunc, char * info) {
43 struct roar_libroar_config * config = roar_libroar_get_config();
44
45 if ( !roar_libroar_iswarn(config) )
46  return;
47
48 if ( config->warnings.sysio == ROAR_WARNING_ALWAYS ) {
49  if ( newfunc == NULL ) {
50   ROAR_WARN("%s(*): This function is obsolete. %s", func, info == NULL ? "" : info);
51  } else {
52   ROAR_WARN("%s(*): This function is obsolete. Please use %s(...). %s", func, newfunc, info == NULL ? "" : info);
53  }
54 }
55}
56
57void roar_debug_warn_obsolete_real(char * func, char * newfunc, char * info) {
58 struct roar_libroar_config * config = roar_libroar_get_config();
59
60 if ( !roar_libroar_iswarn(config) )
61  return;
62
63 if ( config->warnings.obsolete == ROAR_WARNING_ALWAYS ) {
64  if ( newfunc == NULL ) {
65   ROAR_WARN("%s(*): This function is obsolete. %s", func, info == NULL ? "" : info);
66  } else {
67   ROAR_WARN("%s(*): This function is obsolete. Please use %s(...). %s", func, newfunc, info == NULL ? "" : info);
68  }
69 }
70}
71
72void roar_debug_bin_obsolete(const char * progname, const char * newprog, const char * info) {
73 if ( info == NULL )
74  info = "";
75
76 if ( newprog == NULL ) {
77  roar_debug_msg(ROAR_DEBUG_TYPE_ERROR, 0, progname, ROAR_DBG_PREFIX, "This program is obsolete and will be removed soon. %s", info);
78 } else {
79  roar_debug_msg(ROAR_DEBUG_TYPE_ERROR, 0, progname, ROAR_DBG_PREFIX, "This program is obsolete and will be removed soon. Please use %s. %s", newprog, info);
80 }
81}
82
83void   roar_debug_set_stderr_fh(int fh) {
84 roar_debug_stderr_fh = fh;
85}
86
87void   roar_debug_set_stderr_vio(struct roar_vio_calls * vio) {
88 roar_debug_stderr_vio = vio;
89}
90
91void   roar_debug_set_stderr_mode(int mode) {
92 roar_debug_stderr_mode = mode;
93}
94
95struct roar_vio_calls * roar_debug_get_stderr(void) {
96 static struct roar_vio_calls STDERR;
97
98 switch (roar_debug_stderr_mode) {
99  case ROAR_DEBUG_MODE_SYSIO:
100    if ( roar_debug_stderr_fh == -1 )
101     return NULL;
102
103    roar_vio_open_fh(&STDERR, roar_debug_stderr_fh);
104
105    return &STDERR;
106   break;
107  case ROAR_DEBUG_MODE_VIO:
108    return roar_debug_stderr_vio;
109   break;
110  default:
111    return NULL;
112   break;
113 }
114}
115
116// NOTE: This function MUST NOT alter RA's error values nor errno!
117void roar_debug_msg_simple(const char *format, ...) {
118 struct roar_vio_calls * vio;
119 va_list ap;
120 int ret;
121 char buf[8192];
122#ifdef ROAR_HAVE_SYSLOG
123 size_t len;
124#endif
125 int _ra_error  = roar_error;
126 int _sys_error = errno;
127
128 vio = roar_debug_get_stderr();
129
130 va_start(ap, format);
131 ret = vsnprintf(buf, sizeof(buf), format, ap);
132 va_end(ap);
133
134 buf[sizeof(buf)-1] = 0;
135
136 if ( vio != NULL ) {
137  _LIBROAR_IGNORE_RET(roar_vio_write(vio, buf, ret));
138  roar_vio_sync(vio);
139 } else {
140  switch (roar_debug_stderr_mode) {
141#ifdef ROAR_HAVE_SYSLOG
142   case ROAR_DEBUG_MODE_SYSLOG:
143     // strip \n if needed for syslog:
144     len = strlen(buf);
145     if ( buf[len-1] == '\n' )
146      buf[len-1] = 0;
147
148     syslog(LOG_ERR, "%s", buf); // bad to use some defaults
149    break;
150#endif
151   default:
152     // do nothing.
153    break;
154  }
155 }
156
157 roar_error = _ra_error;
158 errno      = _sys_error;
159}
160
161void roar_debug_msg(int type, unsigned long int line, const char * file, const char * prefix, const char * format, ...) {
162 struct roar_vio_calls * vio;
163 va_list ap;
164 char    buf[8192];
165 char  * bufp = buf;
166 char  * typename;
167 int     ret;
168#ifdef ROAR_HAVE_SYSLOG
169 int     priority;
170#endif
171 size_t  len;
172 struct roar_error_state error_state;
173
174 roar_err_store(&error_state);
175
176 switch (type) {
177  case ROAR_DEBUG_TYPE_ERROR:   typename = "Error";   break;
178  case ROAR_DEBUG_TYPE_WARNING: typename = "Warning"; break;
179  case ROAR_DEBUG_TYPE_INFO:    typename = "Info";    break;
180  case ROAR_DEBUG_TYPE_DEBUG:   typename = "Debug";   break;
181  default: typename = "Unknown Type"; break;
182 }
183
184 ret = snprintf(buf, sizeof(buf), "(%s: %s:%lu): %s: ", prefix, file, line, typename);
185
186 if ( ret > 0 && ret < (int)sizeof(buf) ) {
187  bufp += ret;
188 } else {
189  ret = 0;
190 }
191
192 len = ret;
193
194 va_start(ap, format);
195 ret = vsnprintf(bufp, sizeof(buf)-ret, format, ap);
196 va_end(ap);
197
198 buf[sizeof(buf)-1] = 0;
199
200 len += ret;
201
202 switch (roar_debug_stderr_mode) {
203  case ROAR_DEBUG_MODE_SYSIO:
204  case ROAR_DEBUG_MODE_VIO:
205    if ( (vio = roar_debug_get_stderr()) == NULL ) {
206      roar_err_restore(&error_state);
207     return;
208    }
209    _LIBROAR_IGNORE_RET(roar_vio_write(vio, buf, len));
210    _LIBROAR_IGNORE_RET(roar_vio_write(vio, "\n", 1));
211    roar_vio_sync(vio);
212   break;
213#ifdef ROAR_HAVE_SYSLOG
214  case ROAR_DEBUG_MODE_SYSLOG:
215    switch (type) {
216     case ROAR_DEBUG_TYPE_ERROR:   priority = LOG_ERR;     break;
217     case ROAR_DEBUG_TYPE_WARNING: priority = LOG_WARNING; break;
218     case ROAR_DEBUG_TYPE_INFO:    priority = LOG_INFO;    break;
219     case ROAR_DEBUG_TYPE_DEBUG:   priority = LOG_DEBUG;   break;
220     default: priority = LOG_ERR; break;
221    }
222    syslog(priority, "%s", buf);
223   break;
224#endif
225 }
226 roar_err_restore(&error_state);
227}
228//ll
Note: See TracBrowser for help on using the repository browser.