revert inclusion of options.h
[asterisk/asterisk.git] / include / asterisk / logger.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*!
20   \file logger.h
21   \brief Support for logging to various files, console and syslog
22         Configuration in file logger.conf
23 */
24
25 #ifndef _ASTERISK_LOGGER_H
26 #define _ASTERISK_LOGGER_H
27
28 #include "asterisk/options.h"   /* need option_debug */
29
30 #if defined(__cplusplus) || defined(c_plusplus)
31 extern "C" {
32 #endif
33
34 #define EVENTLOG "event_log"
35 #define QUEUELOG        "queue_log"
36
37 #define DEBUG_M(a) { \
38         a; \
39 }
40
41 #define VERBOSE_PREFIX_1 " "
42 #define VERBOSE_PREFIX_2 "  == "
43 #define VERBOSE_PREFIX_3 "    -- "
44 #define VERBOSE_PREFIX_4 "       > "
45
46 /*! Used for sending a log message */
47 /*!
48         \brief This is the standard logger function.  Probably the only way you will invoke it would be something like this:
49         ast_log(LOG_WHATEVER, "Problem with the %s Captain.  We should get some more.  Will %d be enough?\n", "flux capacitor", 10);
50         where WHATEVER is one of ERROR, DEBUG, EVENT, NOTICE, or WARNING depending
51         on which log you wish to output to. These are implemented as macros, that
52         will provide the function with the needed arguments.
53
54         \param level    Type of log event
55         \param file     Will be provided by the LOG_* macro
56         \param line     Will be provided by the LOG_* macro
57         \param function Will be provided by the LOG_* macro
58         \param fmt      This is what is important.  The format is the same as your favorite breed of printf.  You know how that works, right? :-)
59  */
60
61 void ast_log(int level, const char *file, int line, const char *function, const char *fmt, ...)
62         __attribute__ ((format (printf, 5, 6)));
63
64 void ast_backtrace(void);
65
66 void ast_queue_log(const char *queuename, const char *callid, const char *agent, const char *event, const char *fmt, ...)
67         __attribute__ ((format (printf, 5, 6)));
68
69 /*! Send a verbose message (based on verbose level)
70         \brief This works like ast_log, but prints verbose messages to the console depending on verbosity level set.
71         ast_verbose(VERBOSE_PREFIX_3 "Whatever %s is happening\n", "nothing");
72         This will print the message to the console if the verbose level is set to a level >= 3
73         Note the abscence of a comma after the VERBOSE_PREFIX_3.  This is important.
74         VERBOSE_PREFIX_1 through VERBOSE_PREFIX_3 are defined.
75  */
76 void ast_verbose(const char *fmt, ...)
77         __attribute__ ((format (printf, 1, 2)));
78
79 int ast_register_verbose(void (*verboser)(const char *string));
80 int ast_unregister_verbose(void (*verboser)(const char *string));
81
82 void ast_console_puts(const char *string);
83
84 void ast_console_puts_mutable(const char *string);
85 void ast_console_toggle_mute(int fd, int silent);
86
87 #define _A_ __FILE__, __LINE__, __PRETTY_FUNCTION__
88
89 #ifdef LOG_DEBUG
90 #undef LOG_DEBUG
91 #endif
92 #define __LOG_DEBUG    0
93 #define LOG_DEBUG      __LOG_DEBUG, _A_
94
95 #ifdef LOG_EVENT
96 #undef LOG_EVENT
97 #endif
98 #define __LOG_EVENT    1
99 #define LOG_EVENT      __LOG_EVENT, _A_
100
101 #ifdef LOG_NOTICE
102 #undef LOG_NOTICE
103 #endif
104 #define __LOG_NOTICE   2
105 #define LOG_NOTICE     __LOG_NOTICE, _A_
106
107 #ifdef LOG_WARNING
108 #undef LOG_WARNING
109 #endif
110 #define __LOG_WARNING  3
111 #define LOG_WARNING    __LOG_WARNING, _A_
112
113 #ifdef LOG_ERROR
114 #undef LOG_ERROR
115 #endif
116 #define __LOG_ERROR    4
117 #define LOG_ERROR      __LOG_ERROR, _A_
118
119 #ifdef LOG_VERBOSE
120 #undef LOG_VERBOSE
121 #endif
122 #define __LOG_VERBOSE  5
123 #define LOG_VERBOSE    __LOG_VERBOSE, _A_
124
125 #ifdef LOG_DTMF
126 #undef LOG_DTMF
127 #endif
128 #define __LOG_DTMF  6
129 #define LOG_DTMF    __LOG_DTMF, _A_
130
131 /*!
132  * \brief Get the debug level for a file
133  * \arg file the filename
134  * \return the debug level
135  */
136 unsigned int ast_debug_get_by_file(const char *file);
137
138 /*!
139  * \brief Get the debug level for a file
140  * \arg file the filename
141  * \return the debug level
142  */
143 unsigned int ast_verbose_get_by_file(const char *file);
144
145 /*!
146  * \brief Log a DEBUG message
147  * \param level The minimum value of option_debug for this message
148  *        to get logged
149  */
150 #define ast_debug(level, ...) do {       \
151         if (option_debug >= (level) || (ast_opt_dbg_file && ast_debug_get_by_file(__FILE__) >= (level)) ) \
152                 ast_log(LOG_DEBUG, __VA_ARGS__); \
153 } while (0)
154
155 #define ast_verb(level, ...) do { \
156         if (option_verbose >= (level) || (ast_opt_verb_file && ast_verbose_get_by_file(__FILE__) >= (level)) ) { \
157                 if (level >= 4) \
158                         ast_verbose(VERBOSE_PREFIX_4 __VA_ARGS__); \
159                 else if (level == 3) \
160                         ast_verbose(VERBOSE_PREFIX_3 __VA_ARGS__); \
161                 else if (level == 2) \
162                         ast_verbose(VERBOSE_PREFIX_2 __VA_ARGS__); \
163                 else if (level == 1) \
164                         ast_verbose(VERBOSE_PREFIX_1 __VA_ARGS__); \
165                 else \
166                         ast_verbose(__VA_ARGS__); \
167         } \
168 } while (0)
169
170 #if defined(__cplusplus) || defined(c_plusplus)
171 }
172 #endif
173
174 #endif /* _ASTERISK_LOGGER_H */