summaryrefslogtreecommitdiffstats
path: root/avahi-core/log.h
blob: 064e4185dc965515e6bd461e8d31f738b7037a88 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
#ifndef foologhfoo
#define foologhfoo

/* $Id$ */

/***
  This file is part of avahi.
 
  avahi is free software; you can redistribute it and/or modify it
  under the terms of the GNU Lesser General Public License as
  published by the Free Software Foundation; either version 2.1 of the
  License, or (at your option) any later version.
 
  avahi is distributed in the hope that it will be useful, but WITHOUT
  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
  Public License for more details.
 
  You should have received a copy of the GNU Lesser General Public
  License along with avahi; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  USA.
***/

#include <stdarg.h>
#include <glib.h>
#include <avahi-common/cdecl.h>

/** \file log.h Extensible logging subsystem */

AVAHI_C_DECL_BEGIN

#ifdef __GNUC__
#define AVAHI_GCC_PRINTF_ATTR(a,b) __attribute__ ((format (printf, a, b)))
#else
/** Macro for usage of GCC's printf compilation warnings */
#define AVAHI_GCC_PRINTF_ATTR(a,b)
#endif

#define AVAHI_GCC_PRINTF_ATTR12 AVAHI_GCC_PRINTF_ATTR(1,2)
#define AVAHI_GCC_PRINTF_ATTR23 AVAHI_GCC_PRINTF_ATTR(2,3)

/** Log level for avahi_log_xxx() */
typedef enum {
    AVAHI_LOG_ERROR  = 0,    /**< Error messages */
    AVAHI_LOG_WARN   = 1,    /**< Warning messages */
    AVAHI_LOG_NOTICE = 2,    /**< Notice messages */
    AVAHI_LOG_INFO   = 3,    /**< Info messages */
    AVAHI_LOG_DEBUG  = 4,    /**< Debug messages */
    AVAHI_LOG_LEVEL_MAX
} AvahiLogLevel;

/** Prototype for a user supplied log function */
typedef void (*AvahiLogFunction)(AvahiLogLevel level, const gchar *txt);

/** Set a user supplied log function, replacing the default which
 * prints to log messages unconditionally to STDERR. Pass NULL for
 * resetting to the default log function */
void avahi_set_log_function(AvahiLogFunction function);

/** Issue a log message using a va_list object */
void avahi_log_ap(AvahiLogLevel level, const gchar *format, va_list ap);

/** Issue a log message by passing a log level and a format string */
void avahi_log(AvahiLogLevel level, const gchar*format, ...) AVAHI_GCC_PRINTF_ATTR23;

/** Shortcut for avahi_log(AVAHI_LOG_ERROR, ...) */
void avahi_log_error(const gchar*format, ...) AVAHI_GCC_PRINTF_ATTR12;

/** Shortcut for avahi_log(AVAHI_LOG_WARN, ...) */
void avahi_log_warn(const gchar*format, ...) AVAHI_GCC_PRINTF_ATTR12;

/** Shortcut for avahi_log(AVAHI_LOG_NOTICE, ...) */
void avahi_log_notice(const gchar*format, ...) AVAHI_GCC_PRINTF_ATTR12;

/** Shortcut for avahi_log(AVAHI_LOG_INFO, ...) */
void avahi_log_info(const gchar*format, ...) AVAHI_GCC_PRINTF_ATTR12;

/** Shortcut for avahi_log(AVAHI_LOG_DEBUG, ...) */
void avahi_log_debug(const gchar*format, ...) AVAHI_GCC_PRINTF_ATTR12;

AVAHI_C_DECL_END

#endif