annotate Orthanc/Core/Logging.h @ 161:4ac039ed55bd

Upgrade to Cornerstone 0.11.0
author Sebastien Jodogne <s.jodogne@gmail.com>
date Thu, 15 Jun 2017 17:43:34 +0200
parents 5dc54316d68b
children dd1ad819ca33
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
78
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
122
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 78
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
78
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
159
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
5 * Copyright (C) 2017 Osimis, Belgium
78
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 *
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * This program is free software: you can redistribute it and/or
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * modify it under the terms of the GNU General Public License as
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * published by the Free Software Foundation, either version 3 of the
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * License, or (at your option) any later version.
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 *
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * In addition, as a special exception, the copyright holders of this
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * program give permission to link the code of its release with the
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * OpenSSL project's "OpenSSL" library (or with modified versions of it
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * that use the same license as the "OpenSSL" library), and distribute
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 * the linked executables. You must obey the GNU General Public License
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * in all respects for all of the code used other than "OpenSSL". If you
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * modify file(s) with this exception, you may extend this exception to
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 * your version of the file(s), but you are not obligated to do so. If
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 * you do not wish to do so, delete this exception statement from your
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 * version. If you delete this exception statement from all source files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 * in the program, then also delete it here.
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 *
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 * This program is distributed in the hope that it will be useful, but
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 * WITHOUT ANY WARRANTY; without even the implied warranty of
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 * General Public License for more details.
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 *
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 * You should have received a copy of the GNU General Public License
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 * along with this program. If not, see <http://www.gnu.org/licenses/>.
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 **/
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 #pragma once
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 #include <iostream>
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37
149
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 146
diff changeset
38 #if !defined(ORTHANC_ENABLE_LOGGING)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 146
diff changeset
39 # error The macro ORTHANC_ENABLE_LOGGING must be defined
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 146
diff changeset
40 #endif
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 146
diff changeset
41
159
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
42 #if !defined(ORTHANC_ENABLE_LOGGING_PLUGIN)
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
43 # if ORTHANC_ENABLE_LOGGING == 1
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
44 # error The macro ORTHANC_ENABLE_LOGGING_PLUGIN must be defined
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
45 # else
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
46 # define ORTHANC_ENABLE_LOGGING_PLUGIN 0
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
47 # endif
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
48 #endif
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
49
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
50 #if ORTHANC_ENABLE_LOGGING_PLUGIN == 1
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
51 # include <orthanc/OrthancCPlugin.h>
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
52 #endif
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
53
78
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 namespace Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56 namespace Logging
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57 {
159
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
58 #if ORTHANC_ENABLE_LOGGING_PLUGIN == 1
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
59 void Initialize(OrthancPluginContext* context);
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
60 #else
78
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61 void Initialize();
159
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
62 #endif
78
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64 void Finalize();
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65
141
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 122
diff changeset
66 void Reset();
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 122
diff changeset
67
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 122
diff changeset
68 void Flush();
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 122
diff changeset
69
78
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
70 void EnableInfoLevel(bool enabled);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
71
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
72 void EnableTraceLevel(bool enabled);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
73
141
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 122
diff changeset
74 void SetTargetFile(const std::string& path);
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 122
diff changeset
75
78
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
76 void SetTargetFolder(const std::string& path);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
77
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
78 struct NullStream : public std::ostream
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
79 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
80 NullStream() :
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
81 std::ios(0),
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
82 std::ostream(0)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
83 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
84 }
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
85
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
86 std::ostream& operator<< (const std::string& message)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
87 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
88 return *this;
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
89 }
141
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 122
diff changeset
90
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 122
diff changeset
91 // This overload fixes build problems with Visual Studio 2015
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 122
diff changeset
92 std::ostream& operator<< (const char* message)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 122
diff changeset
93 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 122
diff changeset
94 return *this;
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 122
diff changeset
95 }
78
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
96 };
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
97 }
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
98 }
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
99
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
100
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
101 #if ORTHANC_ENABLE_LOGGING != 1
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
102
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
103 # define LOG(level) ::Orthanc::Logging::NullStream()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
104 # define VLOG(level) ::Orthanc::Logging::NullStream()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
105
159
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
106
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
107 #elif ORTHANC_ENABLE_LOGGING_PLUGIN == 1
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
108
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
109 # include <boost/noncopyable.hpp>
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
110 # define LOG(level) ::Orthanc::Logging::InternalLogger(#level, __FILE__, __LINE__)
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
111 # define VLOG(level) ::Orthanc::Logging::InternalLogger("TRACE", __FILE__, __LINE__)
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
112
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
113 namespace Orthanc
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
114 {
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
115 namespace Logging
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
116 {
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
117 class InternalLogger : public boost::noncopyable
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
118 {
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
119 private:
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
120 std::string level_;
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
121 std::string message_;
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
122
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
123 public:
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
124 InternalLogger(const char* level,
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
125 const char* file,
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
126 int line);
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
127
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
128 ~InternalLogger();
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
129
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
130 InternalLogger& operator<< (const std::string& message);
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
131
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
132 InternalLogger& operator<< (const char* message);
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
133
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
134 InternalLogger& operator<< (int message);
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
135 };
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
136 }
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
137 }
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
138
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
139
5dc54316d68b shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 149
diff changeset
140 #else /* ORTHANC_ENABLE_LOGGING_PLUGIN == 0 && ORTHANC_ENABLE_LOGGING == 1 */
78
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
141
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
142 # include <boost/thread/mutex.hpp>
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
143 # define LOG(level) ::Orthanc::Logging::InternalLogger(#level, __FILE__, __LINE__)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
144 # define VLOG(level) ::Orthanc::Logging::InternalLogger("TRACE", __FILE__, __LINE__)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
145
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
146 namespace Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
147 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
148 namespace Logging
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
149 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
150 class InternalLogger
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
151 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
152 private:
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
153 boost::mutex::scoped_lock lock_;
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
154 NullStream null_;
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
155 std::ostream* stream_;
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
156
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
157 public:
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
158 InternalLogger(const char* level,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
159 const char* file,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
160 int line);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
161
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
162 ~InternalLogger();
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
163
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
164 std::ostream& operator<< (const std::string& message)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
165 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
166 return (*stream_) << message;
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
167 }
146
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 141
diff changeset
168
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 141
diff changeset
169 // This overload fixes build problems with Visual Studio 2015
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 141
diff changeset
170 std::ostream& operator<< (const char* message)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 141
diff changeset
171 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 141
diff changeset
172 return (*stream_) << message;
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 141
diff changeset
173 }
78
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
174 };
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
175 }
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
176 }
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
177
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
178 #endif // ORTHANC_ENABLE_LOGGING