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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
|
#ifndef STATEMENT_H
#define STATEMENT_H
/*
*
* Copyright (c) 2006 The Apache Software Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
#include "qpid/Msg.h"
#include "qpid/CommonImportExport.h"
#include <boost/current_function.hpp>
namespace qpid {
namespace log {
/** Debugging severity levels
* - trace: High-volume debugging messages.
* - debug: Debugging messages.
* - info: Informational messages.
* - notice: Normal but significant condition.
* - warning: Warn of a possible problem.
* - error: A definite error has occured.
* - critical: System in danger of severe failure.
*/
enum Level { trace, debug, info, notice, warning, error, critical };
struct LevelTraits {
static const int COUNT=critical+1;
/** Get level from string name.
*@exception if name invalid.
*/
static Level level(const char* name);
/** Get level from string name.
*@exception if name invalid.
*/
static Level level(const std::string& name) {
return level(name.c_str());
}
/** String name of level */
static const char* name(Level);
};
/** POD struct representing a logging statement in source code. */
struct QPID_COMMON_CLASS_EXTERN Statement {
bool enabled;
const char* file;
int line;
const char* function;
Level level;
QPID_COMMON_EXTERN void log(const std::string& message);
struct Initializer {
QPID_COMMON_EXTERN Initializer(Statement& s);
Statement& statement;
};
};
///@internal static initializer for a Statement.
#define QPID_LOG_STATEMENT_INIT(level) \
{ 0, __FILE__, __LINE__, BOOST_CURRENT_FUNCTION, (::qpid::log::level) }
/**
* Like QPID_LOG but computes an additional boolean test expression
* to determine if the message should be logged. Evaluation of both
* the test and message expressions occurs only if the requested log level
* is enabled.
*@param LEVEL severity Level for message, should be one of:
* debug, info, notice, warning, error, critical. NB no qpid::log:: prefix.
*@param TEST message is logged only if expression TEST evaluates to true.
*@param MESSAGE any object with an @eostream operator<<, or a sequence
* like of ostreamable objects separated by @e<<.
*/
#define QPID_LOG_IF(LEVEL, TEST, MESSAGE) \
do { \
using ::qpid::log::Statement; \
static Statement stmt_= QPID_LOG_STATEMENT_INIT(LEVEL); \
static Statement::Initializer init_(stmt_); \
if (stmt_.enabled && (TEST)) \
stmt_.log(::qpid::Msg() << MESSAGE); \
} while(0)
/**
* FLAG must be a boolean variable. Assigns FLAG to true iff logging
* is enabled for LEVEL in the calling context. Use when extra
* support code is needed to generate log messages, to ensure that it
* is only run if the logging level is enabled.
* e.g.
* bool logWarning;
* QPID_LOG_TEST(LEVEL, logWarning);
* if (logWarning) { do stuff needed for warning log messages }
*/
#define QPID_LOG_TEST(LEVEL, FLAG) \
do { \
using ::qpid::log::Statement; \
static Statement stmt_= QPID_LOG_STATEMENT_INIT(LEVEL); \
static Statement::Initializer init_(stmt_); \
FLAG = stmt_.enabled; \
} while(0)
/**
* Macro for log statements. Example of use:
* @code
* QPID_LOG(debug, "There are " << foocount << " foos in the bar.");
* QPID_LOG(error, boost::format("Dohickey %s exploded") % dohicky.name());
* @endcode
*
* You can subscribe to log messages by level, by component, by filename
* or a combination @see Configuration.
*@param LEVEL severity Level for message, should be one of:
* debug, info, notice, warning, error, critical. NB no qpid::log:: prefix.
*@param MESSAGE any object with an @eostream operator<<, or a sequence
* like of ostreamable objects separated by @e<<.
*/
#define QPID_LOG(LEVEL, MESSAGE) QPID_LOG_IF(LEVEL, true, MESSAGE);
}} // namespace qpid::log
#endif /*!STATEMENT_H*/
|
